mime.h

Go to the documentation of this file.

/*
 * mime.h
 *
 * Multipurpose Internet Mail Extensions support classes.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-2002 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 24177 $
 * $Author: rjongbloed $
 * $Date: 2010-04-05 06:52:04 -0500 (Mon, 05 Apr 2010) $
 */

#ifndef PTLIB_PMIME_H
#define PTLIB_PMIME_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptclib/inetprot.h>
#include <ptclib/cypher.h>


class PMultiPartList;


// PMIMEInfo

#ifdef DOC_PLUS_PLUS
class PMIMEInfo : public PStringToString {
#endif
PDECLARE_STRING_DICTIONARY(PMIMEInfo, PCaselessString);
  public:
    PMIMEInfo(
      istream &strm   
    );
    PMIMEInfo(
      PInternetProtocol & socket   
    );
    // Construct a MIME information dictionary from the specified source.


  // Overrides from class PObject
    virtual void PrintOn(
      ostream &strm   
    ) const;

    virtual void ReadFrom(
      istream &strm   
    );


  // Overrides from class PStringToString
    PBoolean SetAt(
      const char * key,
      const PString value
    ) { return AbstractSetAt(PCaselessString(key), PNEW PString(value)); }

    PBoolean SetAt(
      const PString & key,
      const PString value
    ) { return AbstractSetAt(PCaselessString(key), PNEW PString(value)); }

    PBoolean SetAt(
      const PCaselessString & key,
      const PString value
    ) { return AbstractSetAt(key, PNEW PString(value)); }

    PBoolean SetAt(
      const PString & (*key)(),
      const PString value
    ) { return AbstractSetAt(PCaselessString(key()), PNEW PString(value)); }

    PBoolean Contains(
      const char * key       
    ) const { return GetAt(PCaselessString(key)) != NULL; }

    PBoolean Contains(
      const PString & key       
    ) const { return GetAt(PCaselessString(key)) != NULL; }

    PBoolean Contains(
      const PCaselessString & key       
    ) const { return GetAt(key) != NULL; }

    PBoolean Contains(
      const PString & (*key)()       
    ) const { return GetAt(PCaselessString(key())) != NULL; }

  // New functions for class.
    PBoolean Read(
      PInternetProtocol & socket   
    );

    PBoolean Write(
      PInternetProtocol & socket   
    ) const;

    bool AddMIME(
      const PString & line
    );
    bool AddMIME(
      const PString & fieldName, 
      const PString & fieldValue 
    );
    bool AddMIME(
      const PMIMEInfo & mime
    );

    PString GetString(
      const PString & key,       
      const PString & dflt = PString::Empty() 
    ) const;
    PString GetString(
      const PString & (*key)(),               
      const PString & dflt = PString::Empty() 
    ) const { return GetString(key(), dflt); }

    long GetInteger(
      const PString & key,    
      long dflt = 0           
    ) const;
    long GetInteger(
      const PString & (*key)(), 
      long dflt = 0             
    ) const { return GetInteger(key(), dflt); }

    void SetInteger(
      const PCaselessString & key,  
      long value                    
    );
    void SetInteger(
      const PString & (*key)(), 
      long value                    
    ) { SetInteger(PCaselessString(key()), value); }

    bool GetComplex(
      const PString & key,    
      PStringToString & info  
    ) const { return ParseComplex(GetString(key), info); }
    bool GetComplex(
      const PString & (*key)(), 
      PStringToString & info    
    ) const { return ParseComplex(GetString(key), info); }

    static bool ParseComplex(
      const PString & str,      
      PStringToString & info    
    );

    bool DecodeMultiPartList(
      PMultiPartList & parts,   
      const PString & body,     
      const PString & key       
    ) const;

    static const PString & ContentTypeTag();
    static const PString & ContentDispositionTag();
    static const PString & ContentTransferEncodingTag();
    static const PString & ContentDescriptionTag();
    static const PString & ContentIdTag();

    bool DecodeMultiPartList(
      PMultiPartList & parts,   
      const PString & body,     
      const PString & (*key)() = ContentTypeTag 
    ) const { return DecodeMultiPartList(parts, body, key()); }

    static void SetAssociation(
      const PStringToString & allTypes,  
      PBoolean merge = true                  
    );
    static void SetAssociation(
      const PString & fileType,         
      const PString & contentType       
    ) { GetContentTypes().SetAt(fileType, contentType); }

    static PString GetContentType(
      const PString & fileType   
    );

    virtual ostream & PrintContents(
      ostream & strm
    ) const;

  private:
    static PStringToString & GetContentTypes();
};


// PMultiPartInfo

class PMultiPartInfo : public PObject
{
    PCLASSINFO(PMultiPartInfo, PObject);
  public:
    PMIMEInfo  m_mime;
    PString    m_textBody;
    PBYTEArray m_binaryBody;
};

class PMultiPartList : public PList<PMultiPartInfo>
{
    PCLASSINFO(PMultiPartList, PList<PMultiPartInfo>);
  public:
    PMultiPartList() { }

    bool Decode(
      const PString & body,               
      const PStringToString & contentInfo 
    );
};


#endif // PTLIB_PMIME_H


// End Of File ///////////////////////////////////////////////////////////////

---