1 #ifndef HEADER_CURL_MIME_H 2 #define HEADER_CURL_MIME_H 3 /*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al. 11 * 12 * This software is licensed as described in the file COPYING, which 13 * you should have received as part of this distribution. The terms 14 * are also available at https://curl.haxx.se/docs/copyright.html. 15 * 16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 17 * copies of the Software, and permit persons to whom the Software is 18 * furnished to do so, under the terms of the COPYING file. 19 * 20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 21 * KIND, either express or implied. 22 * 23 ***************************************************************************/ 24 25 #define MIME_RAND_BOUNDARY_CHARS 16 /* Nb. of random boundary chars. */ 26 #define MAX_ENCODED_LINE_LENGTH 76 /* Maximum encoded line length. */ 27 #define ENCODING_BUFFER_SIZE 256 /* Encoding temp buffers size. */ 28 29 /* Part flags. */ 30 #define MIME_USERHEADERS_OWNER (1 << 0) 31 #define MIME_BODY_ONLY (1 << 1) 32 33 /* Part source kinds. */ 34 enum mimekind { 35 MIMEKIND_NONE = 0, /* Part not set. */ 36 MIMEKIND_DATA, /* Allocated mime data. */ 37 MIMEKIND_FILE, /* Data from file. */ 38 MIMEKIND_CALLBACK, /* Data from `read' callback. */ 39 MIMEKIND_MULTIPART, /* Data is a mime subpart. */ 40 MIMEKIND_LAST 41 }; 42 43 /* Readback state tokens. */ 44 enum mimestate { 45 MIMESTATE_BEGIN, /* Readback has not yet started. */ 46 MIMESTATE_CURLHEADERS, /* In curl-generated headers. */ 47 MIMESTATE_USERHEADERS, /* In caller's supplied headers. */ 48 MIMESTATE_EOH, /* End of headers. */ 49 MIMESTATE_BODY, /* Placeholder. */ 50 MIMESTATE_BOUNDARY1, /* In boundary prefix. */ 51 MIMESTATE_BOUNDARY2, /* In boundary. */ 52 MIMESTATE_CONTENT, /* In content. */ 53 MIMESTATE_END, /* End of part reached. */ 54 MIMESTATE_LAST 55 }; 56 57 /* Mime headers strategies. */ 58 enum mimestrategy { 59 MIMESTRATEGY_MAIL, /* Mime mail. */ 60 MIMESTRATEGY_FORM, /* HTTP post form. */ 61 MIMESTRATEGY_LAST 62 }; 63 64 /* Content transfer encoder. */ 65 typedef struct { 66 const char * name; /* Encoding name. */ 67 size_t (*encodefunc)(char *buffer, size_t size, bool ateof, 68 curl_mimepart *part); /* Encoded read. */ 69 curl_off_t (*sizefunc)(curl_mimepart *part); /* Encoded size. */ 70 } mime_encoder; 71 72 /* Content transfer encoder state. */ 73 typedef struct { 74 size_t pos; /* Position on output line. */ 75 size_t bufbeg; /* Next data index in input buffer. */ 76 size_t bufend; /* First unused byte index in input buffer. */ 77 char buf[ENCODING_BUFFER_SIZE]; /* Input buffer. */ 78 } mime_encoder_state; 79 80 /* Mime readback state. */ 81 typedef struct { 82 enum mimestate state; /* Current state token. */ 83 void *ptr; /* State-dependent pointer. */ 84 size_t offset; /* State-dependent offset. */ 85 } mime_state; 86 87 /* A mime multipart. */ 88 struct curl_mime_s { 89 struct Curl_easy *easy; /* The associated easy handle. */ 90 curl_mimepart *parent; /* Parent part. */ 91 curl_mimepart *firstpart; /* First part. */ 92 curl_mimepart *lastpart; /* Last part. */ 93 char *boundary; /* The part boundary. */ 94 mime_state state; /* Current readback state. */ 95 }; 96 97 /* A mime part. */ 98 struct curl_mimepart_s { 99 struct Curl_easy *easy; /* The associated easy handle. */ 100 curl_mime *parent; /* Parent mime structure. */ 101 curl_mimepart *nextpart; /* Forward linked list. */ 102 enum mimekind kind; /* The part kind. */ 103 char *data; /* Memory data or file name. */ 104 curl_read_callback readfunc; /* Read function. */ 105 curl_seek_callback seekfunc; /* Seek function. */ 106 curl_free_callback freefunc; /* Argument free function. */ 107 void *arg; /* Argument to callback functions. */ 108 FILE *fp; /* File pointer. */ 109 struct curl_slist *curlheaders; /* Part headers. */ 110 struct curl_slist *userheaders; /* Part headers. */ 111 char *mimetype; /* Part mime type. */ 112 char *filename; /* Remote file name. */ 113 char *name; /* Data name. */ 114 curl_off_t datasize; /* Expected data size. */ 115 unsigned int flags; /* Flags. */ 116 mime_state state; /* Current readback state. */ 117 const mime_encoder *encoder; /* Content data encoder. */ 118 mime_encoder_state encstate; /* Data encoder state. */ 119 }; 120 121 122 /* Prototypes. */ 123 void Curl_mime_initpart(curl_mimepart *part, struct Curl_easy *easy); 124 void Curl_mime_cleanpart(curl_mimepart *part); 125 CURLcode Curl_mime_duppart(curl_mimepart *dst, const curl_mimepart *src); 126 CURLcode Curl_mime_set_subparts(curl_mimepart *part, 127 curl_mime *subparts, int take_ownership); 128 CURLcode Curl_mime_prepare_headers(curl_mimepart *part, 129 const char *contenttype, 130 const char *disposition, 131 enum mimestrategy strategy); 132 curl_off_t Curl_mime_size(curl_mimepart *part); 133 size_t Curl_mime_read(char *buffer, size_t size, size_t nitems, 134 void *instream); 135 CURLcode Curl_mime_rewind(curl_mimepart *part); 136 CURLcode Curl_mime_add_header(struct curl_slist **slp, const char *fmt, ...); 137 138 #endif /* HEADER_CURL_MIME_H */ 139