Mime.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  Mime.qm Copyright (C) 2012 - 2024 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum required Qore version
 
 
// assume local var scope, do not use "$" for vars, members, and method calls
 
 
namespace Mime {
 
    public hashdecl MessageInfo {
        hash hdr;
        data body;
        list<hash<MessageInfo>> part();
    };
 
    public hashdecl MessagePartInfo {
        data data;
        hash hdr;
    };
 
    public hashdecl FormDataMessageInfo {
        string name;
        *string filename;
        hash hdr;
        data body;
    };
 
    const MimeTypeUnknown = MimeTypeOctetStream;
 
    const MimeTypeOctetStream = "application/octet-stream";
 
    const MimeTypeText = "text/plain";
 
    const MimeTypeHtml = "text/html";
 
    const MimeTypeCsv = "text/csv";
 
    const MimeTypeJpeg = "image/jpeg";
 
    const MimeTypePng = "image/png";
 
    const MimeTypeSoapXml = "application/soap+xml";
 
    const MimeTypeYaml = "text/x-yaml";
 
    const MimeTypeXml = "text/xml";
 
    const MimeTypeXmlApp = "application/xml";
 
    const MimeTypeJson = "application/json";
 
    const MimeTypeJsonRpc = MimeTypeJson;
 
    const MimeTypeXmlRpc = MimeTypeXml;
 
    const MimeTypeYamlRpc = "application/x-yaml";
 
    const MimeTypeJavascript = "application/javascript";
 
    const MimeTypeCss = "text/css";
 
    const MimeTypeFormUrlEncoded = "application/x-www-form-urlencoded";
 
    const MimeTypeMultipartFormData = "multipart/form-data";
 
    const MimeTypeMultipartRelated = "multipart/related";
 
    const MimeTypeMultipartMixed = "multipart/mixed";
 
    const MimeTypeSvg = "image/svg+xml";
 
    const MimeTypeQore = "text/x-qore";
 
    const MimeTypeJavaSource = "text/x-java-source";
 
    const MimeTypeJava = "application/java";
 
    const MimeTypeJar = "application/java-archive";
 
    const MimeTypePython = "text/x-python-source";
 
    const MimeTypePythonCode = "application/x-python-code";
 
    const MimeTypePhp = "application/x-httpd-php";
 
    const MimeTypeSse = "text/event-stream";
 
 
    const MimeTypes = ...;
 
 
 
    const UrlEncodedChars = ...;
 
 
    const ContentTransEnc7Bit = "7bit";
 
    const ContentTransEnc8Bit = "8bit";
 
    const ContentTransEncBinary = "binary";
 
    const ContentTransEncBase64 = "base64";
 
    const ContentTransEncQuotedPrintable = "quoted-printable";
 
 
    const MimeBase64LineLen = 76;
 
 
    const MimeQuotedPrintableLineLen = 76;
 
 
     string mime_encode_base64(data str, int len = MimeBase64LineLen);
 
 
 
     string mime_encode_quoted_printable(string str, bool hdr = False, *string encoding);
 
 
 
     data mime_encode_transfer_data(data mime_data, string enc);
 
 
 
     string mime_encode_header_word_b(string str);
 
 
 
     string mime_encode_header_word_q(string str);
 
 
 
     binary mime_decode_base64(data str);
 
 
 
     string mime_decode_base64_to_string(data str, *string encoding);
 
 
 
     string mime_decode_quoted_printable(string str, *string encoding, *bool is_body);
 
 
 
     data mime_decode_transfer_data(data mime_data, string enc, *string ct, *bool is_body);
 
 
 
     string mime_decode_header(string hdr);
 
 
 
     bool is_mime_text(string mime);
 
 
 
     bool is_filename_text(string path);
 
 
     string get_mime_type_from_ext(string path, string def_type = MimeTypeUnknown);
 
 
 
     string mime_get_urlencoded_string(auto val);
 
 
 
     string mime_get_form_urlencoded_string(hash<auto> h);
 
 
 
     string mime_decode_urlencoded_string(string str);
 
 
 
     hash<auto> mime_parse_form_urlencoded_string(string str);
 
 
    const MPT_FORM_DATA   = "form-data";
 
    const MPT_MIXED       = "mixed";
 
    const MPT_MESSAGE     = "message";
 
    const MPT_DIGEST      = "digest";
 
    const MPT_ALTERNATIVE = "alternative";
 
    const MPT_RELATED     = "related";
 
    const MPT_SIGNED      = "signed";
 
    const MPT_ENCRYPTED   = "encrypted";
 
    const MPT_BYTERANGES  = "byteranges";
 
    class MultiPartMessage {
 
public:
        const MP_DEFAULT_MSG = "This is a MIME multipart message";
 
protected:
            string mptype;
 
            string boundary;
 
            string ct;
 
            list<hash<MessagePartInfo>> l();
 
            hash hdr;
 
            const ASCII_CR = 13;
            const ASCII_LF = 10;
 
public:
 
 
        constructor(string mptype, string boundary = MultiPartMessage::getBoundary());
 
 
        binary serialize();
 
 
 
        binary serializeBody();
 
 
 
        int size();
 
 
 
        string getBoundary();
 
 
 
          static binary serializeHeaders(hash hdr);
 
          static string getBoundary();
 
 
          static string getRandomString(int len);
 
 
          static hash<MessageInfo> parseBody(string boundary, data body, bool decode = True);
 
 
        abstract hash<MessageInfo> getMsgAndHeaders();
 
        // don't reimplement this method; fix/enhance it in the module
protected:
        final  hash<MessageInfo> getMsgAndHeadersIntern(*string content_type, bool conlen = True);
public:
 
 
        // don't reimplement this method; fix/enhance it in the module
protected:
         splicePartIntern(data mime_data, hash<auto> hdr);
public:
 
 
        // don't reimplement this method; fix/enhance it in the module
protected:
         addPartIntern(data mime_data, hash<auto> hdr);
public:
 
 
protected:
          static hash<MessagePartInfo> getPart(data mime_data, hash<auto> hdr);
public:
 
    };
 
class MultiPartRelatedMessage : public MultiPartMessage {
 
public:
protected:
            // the starting part ID
            string startid;
 
public:
 
 
        constructor(string boundary = MultiPartMessage::getBoundary()) ;
 
 
 
        splicePart(data mime_data, string id, string content_type, *hash<auto> hdr);
 
 
 
        addPart(data mime_data, string id, string content_type, *hash hdr);
 
 
 
        hash<MessageInfo> getMsgAndHeaders();
 
    };
 
class MultiPartMixedMessage : public MultiPartMessage {
 
public:
 
        constructor(string boundary = MultiPartMessage::getBoundary()) ;
 
 
 
        splicePart(data mime_data, string content_type = MimeTypeText, string disp = 'inline', *hash<auto> hdr);
 
 
 
        addPart(data mime_data, string content_type = MimeTypeText, string disp = 'inline', *hash<auto> hdr);
 
 
 
        spliceEncodePart(data mime_data, string enc, string content_type = MimeTypeText, string disp = 'inline', *hash<auto> hdr);
 
 
 
         addEncodePart(data mime_data, string enc, string content_type = MimeTypeText, string disp = 'inline', *hash<auto> hdr);
 
 
 
        hash<MessageInfo> getMsgAndHeaders();
 
    };
 
class MultiPartAlternativeMessage : public MultiPartMessage {
 
public:
 
        constructor(string boundary = MultiPartMessage::getBoundary()) ;
 
 
 
        splicePart(data mime_data, string content_type = MimeTypeText, string disp = 'inline', *hash<auto> hdr);
 
 
 
        addPart(data mime_data, string content_type = MimeTypeText, string disp = 'inline', *hash<auto> hdr);
 
 
 
        spliceEncodePart(data mime_data, string enc, string content_type = MimeTypeText, string disp = 'inline', *hash<auto> hdr);
 
 
 
        addEncodePart(data mime_data, string enc, string content_type = MimeTypeText, string disp = 'inline', *hash<auto> hdr);
 
 
 
        hash<MessageInfo> getMsgAndHeaders();
 
    };
 
 
class MultiPartFormDataMessage : public MultiPartMessage {
 
public:
protected:
            hash parts;
 
public:
 
 
        constructor(string boundary = MultiPartMessage::getBoundary()) ;
 
 
 
        splicePart(data mime_data, string name, *hash hdr);
 
 
 
        splicePart(data mime_data, string name, string filename, string content_type, *hash hdr);
 
 
 
        splicePart(hash<FormDataMessageInfo> h);
 
 
 
        addPart(data mime_data, string name, *hash hdr);
 
 
 
        addPart(data mime_data, string name, string filename, string content_type, *hash hdr);
 
 
 
        addPart(hash<FormDataMessageInfo> h);
 
 
 
        hash<MessageInfo> getMsgAndHeaders();
 
 
 
          static hash<string, hash<FormDataMessageInfo>> parseMessage(string content, string body);
 
 
          static MultiPartFormDataMessage makeMessage(hash<string, hash<FormDataMessageInfo>> parts);
 
 
          static binary makeMessageBody(hash<string, hash<FormDataMessageInfo>> parts);
 
protected:
         checkPartName(string name);
public:
 
 
protected:
         hash getPartHeader(string name, *string filename, *string content_type, *hash<auto> hdr);
public:
 
    };
};