#include <mime.h>
Inheritance diagram for PMIMEInfo:
Public Member Functions | |
| PMIMEInfo (istream &strm) | |
| PMIMEInfo (PInternetProtocol &socket) | |
| virtual void | PrintOn (ostream &strm) const |
| Output the contents of the MIME dictionary to the stream. | |
| virtual void | ReadFrom (istream &strm) |
| Input the contents of the MIME dictionary from the stream. | |
| PBoolean | SetAt (const char *key, const PString value) |
| Add a new value to the MIME info. | |
| PBoolean | SetAt (const PString &key, const PString value) |
| Add a new value to the MIME info. | |
| PBoolean | SetAt (const PCaselessString &key, const PString value) |
| Add a new value to the MIME info. | |
| PBoolean | SetAt (const PString &(*key)(), const PString value) |
| Add a new value to the MIME info. | |
| PBoolean | Contains (const char *key) const |
| Determine if the specified key is present in the MIME information set. | |
| PBoolean | Contains (const PString &key) const |
| Determine if the specified key is present in the MIME information set. | |
| PBoolean | Contains (const PCaselessString &key) const |
| Determine if the specified key is present in the MIME information set. | |
| PBoolean | Contains (const PString &(*key)()) const |
| Determine if the specified key is present in the MIME information set. | |
| PBoolean | Read (PInternetProtocol &socket) |
| Read MIME information from the socket. | |
| PBoolean | Write (PInternetProtocol &socket) const |
| Write MIME information to the socket. | |
| bool | AddMIME (const PString &line) |
| Add a MIME field given a "name: value" format string. | |
| bool | AddMIME (const PString &fieldName, const PString &fieldValue) |
| bool | AddMIME (const PMIMEInfo &mime) |
| PString | GetString (const PString &key, const PString &dflt=PString::Empty()) const |
| Get a string for the particular MIME info field with checking for existance. | |
| PString | GetString (const PString &(*key)(), const PString &dflt=PString::Empty()) const |
| long | GetInteger (const PString &key, long dflt=0) const |
| Get an integer value for the particular MIME info field with checking for existance. | |
| long | GetInteger (const PString &(*key)(), long dflt=0) const |
| void | SetInteger (const PCaselessString &key, long value) |
| Set an integer value for the particular MIME info field. | |
| void | SetInteger (const PString &(*key)(), long value) |
| bool | GetComplex (const PString &key, PStringToString &info) const |
| Get a complex MIME field. | |
| bool | GetComplex (const PString &(*key)(), PStringToString &info) const |
| bool | DecodeMultiPartList (PMultiPartList &parts, const PString &body, const PString &key) const |
| Decode parts from a multipart body using the field value. | |
| bool | DecodeMultiPartList (PMultiPartList &parts, const PString &body, const PString &(*key)()=ContentTypeTag) const |
| Decode parts from a multipart body using the field value. | |
| virtual ostream & | PrintContents (ostream &strm) const |
| Output the contents without the trailing CRLF. | |
Static Public Member Functions | |
| static bool | ParseComplex (const PString &str, PStringToString &info) |
| Parse the string as a complex field, see GetComplex(). | |
| static const PString & | ContentTypeTag () |
| static const PString & | ContentDispositionTag () |
| static const PString & | ContentTransferEncodingTag () |
| static const PString & | ContentDescriptionTag () |
| static const PString & | ContentIdTag () |
| static void | SetAssociation (const PStringToString &allTypes, PBoolean merge=true) |
| Set an association between a file type and a MIME content type. | |
| static void | SetAssociation (const PString &fileType, const PString &contentType) |
| static PString | GetContentType (const PString &fileType) |
| Look up the file type to MIME content type association dictionary and return the MIME content type string. | |
| PMIMEInfo::PMIMEInfo | ( | istream & | strm | ) |
| strm | Stream to read the objects contents from. |
| PMIMEInfo::PMIMEInfo | ( | PInternetProtocol & | socket | ) |
| socket | Application socket to read MIME info. |
| bool PMIMEInfo::AddMIME | ( | const PMIMEInfo & | mime | ) |
| fieldName | MIME field name |
| fieldValue | MIME field value |
| bool PMIMEInfo::AddMIME | ( | const PString & | line | ) |
Add a MIME field given a "name: value" format string.
Note that if the field name was already in the MIME dictionary then this will append the new value after a '\n' character to the previous value.
Determine if the specified key is present in the MIME information set.
| key | Key into MIME dictionary to get info. |
| PBoolean PMIMEInfo::Contains | ( | const PCaselessString & | key | ) | const [inline] |
Determine if the specified key is present in the MIME information set.
| key | Key into MIME dictionary to get info. |
Determine if the specified key is present in the MIME information set.
| key | Key into MIME dictionary to get info. |
| PBoolean PMIMEInfo::Contains | ( | const char * | key | ) | const [inline] |
Determine if the specified key is present in the MIME information set.
| key | Key into MIME dictionary to get info. |
| static const PString& PMIMEInfo::ContentDescriptionTag | ( | ) | [static] |
| static const PString& PMIMEInfo::ContentDispositionTag | ( | ) | [static] |
| static const PString& PMIMEInfo::ContentIdTag | ( | ) | [static] |
| static const PString& PMIMEInfo::ContentTransferEncodingTag | ( | ) | [static] |
| static const PString& PMIMEInfo::ContentTypeTag | ( | ) | [static] |
| bool PMIMEInfo::DecodeMultiPartList | ( | PMultiPartList & | parts, | |
| const PString & | body, | |||
| const PString &(*)() | key = ContentTypeTag | |||
| ) | const [inline] |
Decode parts from a multipart body using the field value.
| parts | Extracted parts. |
| body | Body to decode |
| key | MIME key for multipart info |
| bool PMIMEInfo::DecodeMultiPartList | ( | PMultiPartList & | parts, | |
| const PString & | body, | |||
| const PString & | key | |||
| ) | const |
Decode parts from a multipart body using the field value.
| parts | Extracted parts. |
| body | Body to decode |
| key | MIME key for multipart info |
| bool PMIMEInfo::GetComplex | ( | const PString &(*)() | key, | |
| PStringToString & | info | |||
| ) | const [inline] |
| key | Key into MIME dictionary to get info. |
| info | Dictionary of information from field |
| bool PMIMEInfo::GetComplex | ( | const PString & | key, | |
| PStringToString & | info | |||
| ) | const [inline] |
Get a complex MIME field.
This will parse a complex MIME field of the general form:
key: base-value;tag1=token;tag2="string";tag3 key: <base-value>;tag1=token;tag2="string";tag3
The base-value will be placed in the dictionary where the key is the empty string. If the base-value is quoted with '<', '>' brackets then the brackets are removed. Note that the string "<>" can be used to have an empty base-value but a field starting with a ';' is illegal and this function will return false.
Each tag will be the key for it's entry in the dictionary, if that tag has no '=' sign then it will have an empty string as its value. If the tag value is quoted using '"', then the RFC822 rules are applied and the quotes and '\' charcters removed.
IF there are multiple "key" entries in the MIME, or there is an entry of the form:
key: <base-value>;tag=token, <base-value1>, <base-value2>;tag=token
then the first entry wil be as described above. All subsequent entries are includedin the dictionary with the key names having the string "n:" prepended, e.g. "1:" would be "base-value1", "2:tag" would be the tag value on the third entry.
Returns true if the field exists and base-value is non-empty or quoted.
| key | Key into MIME dictionary to get info. |
| info | Dictionary of information from field |
Look up the file type to MIME content type association dictionary and return the MIME content type string.
If the file type is not found in the dictionary then the string "application/octet-stream" is returned.
| fileType | File type (extension) to look up. |
| long PMIMEInfo::GetInteger | ( | const PString &(*)() | key, | |
| long | dflt = 0 | |||
| ) | const [inline] |
| key | Key into MIME dictionary to get info. |
| dflt | Default value of field if not in MIME info. |
| long PMIMEInfo::GetInteger | ( | const PString & | key, | |
| long | dflt = 0 | |||
| ) | const |
Get an integer value for the particular MIME info field with checking for existance.
The dflt parameter is substituted if the field does not exist in the MIME information read in.
| key | Key into MIME dictionary to get info. |
| dflt | Default value of field if not in MIME info. |
| PString PMIMEInfo::GetString | ( | const PString &(*)() | key, | |
| const PString & | dflt = PString::Empty() | |||
| ) | const [inline] |
| key | Key into MIME dictionary to get info. |
| dflt | Default value of field if not in MIME info. |
Get a string for the particular MIME info field with checking for existance.
The dflt parameter is substituted if the field does not exist in the MIME information read in.
| key | Key into MIME dictionary to get info. |
| dflt | Default value of field if not in MIME info. |
| static bool PMIMEInfo::ParseComplex | ( | const PString & | str, | |
| PStringToString & | info | |||
| ) | [static] |
Parse the string as a complex field, see GetComplex().
| str | String value from MIME field. |
| info | Dictionary of information from field |
| virtual ostream& PMIMEInfo::PrintContents | ( | ostream & | strm | ) | const [virtual] |
Output the contents without the trailing CRLF.
| virtual void PMIMEInfo::PrintOn | ( | ostream & | strm | ) | const [virtual] |
Output the contents of the MIME dictionary to the stream.
This is primarily used by the standard operator<< function.
| strm | Stream to print the object into. |
Reimplemented from PAbstractDictionary.
| PBoolean PMIMEInfo::Read | ( | PInternetProtocol & | socket | ) |
Read MIME information from the socket.
| socket | Application socket to read MIME info. |
| virtual void PMIMEInfo::ReadFrom | ( | istream & | strm | ) | [virtual] |
Input the contents of the MIME dictionary from the stream.
This is primarily used by the standard operator>> function.
| strm | Stream to read the objects contents from. |
Reimplemented from PStringToString.
| static void PMIMEInfo::SetAssociation | ( | const PString & | fileType, | |
| const PString & | contentType | |||
| ) | [inline, static] |
| fileType | File type (extension) to match. |
| contentType | MIME content type string. |
| static void PMIMEInfo::SetAssociation | ( | const PStringToString & | allTypes, | |
| PBoolean | merge = true | |||
| ) | [static] |
Set an association between a file type and a MIME content type.
The content type is then sent for any file in the directory sub-tree that has the same extension.
Note that if the merge parameter if true then the dictionary is merged into the current association list and is not a simple replacement.
The default values placed in this dictionary are:
".txt", "text/plain"
".text", "text/plain"
".html", "text/html"
".htm", "text/html"
".aif", "audio/aiff"
".aiff", "audio/aiff"
".au", "audio/basic"
".snd", "audio/basic"
".wav", "audio/wav"
".gif", "image/gif"
".xbm", "image/x-bitmap"
".tif", "image/tiff"
".tiff", "image/tiff"
".jpg", "image/jpeg"
".jpe", "image/jpeg"
".jpeg", "image/jpeg"
".avi", "video/avi"
".mpg", "video/mpeg"
".mpeg", "video/mpeg"
".qt", "video/quicktime"
".mov", "video/quicktime"
The default content type will be "application/octet-stream".
| allTypes | MIME content type associations. |
| merge | Flag for merging associations. |
Add a new value to the MIME info.
If the value is already in the dictionary then this overrides the previous value.
| PBoolean PMIMEInfo::SetAt | ( | const PCaselessString & | key, | |
| const PString | value | |||
| ) | [inline] |
Add a new value to the MIME info.
If the value is already in the dictionary then this overrides the previous value.
Add a new value to the MIME info.
If the value is already in the dictionary then this overrides the previous value.
Add a new value to the MIME info.
If the value is already in the dictionary then this overrides the previous value.
| void PMIMEInfo::SetInteger | ( | const PString &(*)() | key, | |
| long | value | |||
| ) | [inline] |
| key | Key into MIME dictionary to get info. |
| value | New value of field. |
| void PMIMEInfo::SetInteger | ( | const PCaselessString & | key, | |
| long | value | |||
| ) |
Set an integer value for the particular MIME info field.
| key | Key into MIME dictionary to get info. |
| value | New value of field. |
| PBoolean PMIMEInfo::Write | ( | PInternetProtocol & | socket | ) | const |
Write MIME information to the socket.
| socket | Application socket to write MIME info. |
1.4.7