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): ______________________________________.
 */

#ifndef PTLIB_PMIME_H
#define PTLIB_PMIME_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptclib/cypher.h>


class PMultiPartList;
class PInternetProtocol;


// PMIMEInfo

class PMIMEInfo : public PStringOptions
{
  public:
    PMIMEInfo() { }

    PMIMEInfo(
      istream &strm   
    );
    PMIMEInfo(
      PInternetProtocol & socket   
    );
    PMIMEInfo(
      const PStringToString & dict
    );
    PMIMEInfo(
      const PString & str
    );


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

    virtual void ReadFrom(
      istream &strm   
    );


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

    PBoolean Write(
      PInternetProtocol & socket   
    ) const;

    PString AsString() const;

    bool AddMIME(
      const PString & line
    );
    bool AddMIME(
      const PString & fieldName, 
      const PString & fieldValue 
    ) { return InternalAddMIME(fieldName, fieldValue); }
    bool AddMIME(
      const PMIMEInfo & mime
    );

    virtual bool InternalAddMIME(
      const PString & fieldName, 
      const PString & fieldValue 
    );

    bool GetComplex(
      const char * key,    
      PStringToString & info  
    ) const { return ParseComplex(GetString(key), info); }
    bool GetComplex(
      const PString & key,    
      PStringToString & info  
    ) const { return ParseComplex(GetString(key), info); }
    bool GetComplex(
      const PCaselessString & key,  
      PStringToString & info        
    ) const { return ParseComplex(GetString(key), info); }
    bool GetComplex(
      const PCaselessString & (*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 PCaselessString & key       
    ) const;

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

    void AddMultiPartList(
      PMultiPartList & parts,
      const PCaselessString & (*key)() = ContentTypeTag 
    );

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

    static const PCaselessString & TextPlain();
    static const PCaselessString & TextHTML();
    static const PCaselessString & ApplicationJSON();


    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:
    PMultiPartInfo() { }
    PMultiPartInfo(
      const PString & data,
      const PString & contentType,
      const PString & disposition = PString::Empty()
    );
    PMultiPartInfo(
      const PBYTEArray & data,
      const PString & contentType,
      const PString & disposition = PString::Empty()
    );

    virtual void PrintOn(ostream & strm) const;

    void SetMIME();

    PCaselessString m_contentType;
    PCaselessString m_charset;     // UTF-8, UTF-16, UCS-2
    PCaselessString m_encoding;    // "base64", "7bit", "binary", or "8bit"
    PCaselessString m_disposition;
    PMIMEInfo       m_mime;
    PString         m_textBody;
    PBYTEArray      m_binaryBody;
};


class PMultiPartList : public PList<PMultiPartInfo>
{
    PCLASSINFO(PMultiPartList, PList<PMultiPartInfo>);
  public:
    PMultiPartList();
    PMultiPartList(
      const PString & data,
      const PString & contentType = PMIMEInfo::TextPlain(),
      const PString & disposition = PString::Empty()
    );

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

    PString AsString() const;
    virtual void PrintOn(ostream & strm) const;

    template <typename T> void Set(
      const T & data,
      const PString & contentType,
      const PString & disposition = PString::Empty()
    ) {
      RemoveAll();
      Append(new PMultiPartInfo(data, contentType, disposition)); 
    }

    template <typename T> void AddPart(
      const T & data,
      const PString & contentType,
      const PString & disposition = PString::Empty()
    ) { Append(new PMultiPartInfo(data, contentType, disposition)); }

    void SetBoundary(const PString & boundary) { m_boundary = boundary; }

    const PString & GetBoundary() const { return m_boundary; }

  protected:
    PString m_boundary;
};


#endif // PTLIB_PMIME_H


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