1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2010, Daniel Stenberg, <daniel@haxx.se>, et al.
10 * This software is licensed as described in the file COPYING, which
11 * you should have received as part of this distribution. The terms
12 * are also available at http://curl.haxx.se/docs/copyright.html.
14 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 * copies of the Software, and permit persons to whom the Software is
16 * furnished to do so, under the terms of the COPYING file.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ***************************************************************************/
24 Debug the form generator stand-alone by compiling this source file with:
26 gcc -DHAVE_CONFIG_H -I../ -g -D_FORM_DEBUG -DCURLDEBUG -o formdata \
27 -I../include formdata.c strequal.c memdebug.c mprintf.c strerror.c
29 (depending on circumstances you may need further externals added)
31 run the 'formdata' executable the output should end with:
32 All Tests seem to have worked ...
33 and the following parts should be there:
35 Content-Disposition: form-data; name="simple_COPYCONTENTS"
36 value for simple COPYCONTENTS
38 Content-Disposition: form-data; name="COPYCONTENTS_+_CONTENTTYPE"
39 Content-Type: image/gif
40 value for COPYCONTENTS + CONTENTTYPE
42 Content-Disposition: form-data; name="PRNAME_+_NAMELENGTH_+_COPYNAME_+_CONTENTSLENGTH"
43 vlue for PTRNAME + NAMELENGTH + COPYNAME + CONTENTSLENGTH
44 (or you might see P^@RNAME and v^@lue at the start)
46 Content-Disposition: form-data; name="simple_PTRCONTENTS"
47 value for simple PTRCONTENTS
49 Content-Disposition: form-data; name="PTRCONTENTS_+_CONTENTSLENGTH"
50 vlue for PTRCONTENTS + CONTENTSLENGTH
51 (or you might see v^@lue at the start)
53 Content-Disposition: form-data; name="PTRCONTENTS_+_CONTENTSLENGTH_+_CONTENTTYPE"
54 Content-Type: application/octet-stream
55 vlue for PTRCONTENTS + CONTENTSLENGTH + CONTENTTYPE
56 (or you might see v^@lue at the start)
58 Content-Disposition: form-data; name="FILE1_+_CONTENTTYPE"; filename="formdata.h"
59 Content-Type: text/html
62 Content-Disposition: form-data; name="FILE1_+_FILE2"
63 Content-Type: multipart/mixed, boundary=curlz1s0dkticx49MV1KGcYP5cvfSsz
65 Content-Disposition: attachment; filename="formdata.h"
66 Content-Type: application/octet-stream
68 Content-Disposition: attachment; filename="Makefile.b32"
69 Content-Type: application/octet-stream
72 Content-Disposition: form-data; name="FILE1_+_FILE2_+_FILE3"
73 Content-Type: multipart/mixed, boundary=curlirkYPmPwu6FrJ1vJ1u1BmtIufh1
75 Content-Disposition: attachment; filename="formdata.h"
76 Content-Type: application/octet-stream
78 Content-Disposition: attachment; filename="Makefile.b32"
79 Content-Type: application/octet-stream
81 Content-Disposition: attachment; filename="formdata.h"
82 Content-Type: application/octet-stream
86 Content-Disposition: form-data; name="ARRAY: FILE1_+_FILE2_+_FILE3"
87 Content-Type: multipart/mixed, boundary=curlirkYPmPwu6FrJ1vJ1u1BmtIufh1
89 Content-Disposition: attachment; filename="formdata.h"
90 Content-Type: application/octet-stream
92 Content-Disposition: attachment; filename="Makefile.b32"
93 Content-Type: application/octet-stream
95 Content-Disposition: attachment; filename="formdata.h"
96 Content-Type: application/octet-stream
99 Content-Disposition: form-data; name="FILECONTENT"
105 #include <curl/curl.h>
107 /* Length of the random boundary string. */
108 #define BOUNDARY_LENGTH 40
110 #if !defined(CURL_DISABLE_HTTP) || defined(USE_SSLEAY)
117 #if defined(HAVE_LIBGEN_H) && defined(HAVE_BASENAME)
120 #include "urldata.h" /* for struct SessionHandle */
121 #include "easyif.h" /* for Curl_convert_... prototypes */
122 #include "formdata.h"
123 #include "curl_rand.h"
124 #include "strequal.h"
125 #include "curl_memory.h"
127 #define _MPRINTF_REPLACE /* use our functions only */
128 #include <curl/mprintf.h>
130 /* The last #include file should be: */
131 #include "memdebug.h"
133 #endif /* !defined(CURL_DISABLE_HTTP) || defined(USE_SSLEAY) */
135 #ifndef CURL_DISABLE_HTTP
137 #ifndef HAVE_BASENAME
138 static char *Curl_basename(char *path);
139 #define basename(x) Curl_basename((x))
142 static size_t readfromfile(struct Form *form, char *buffer, size_t size);
144 /* What kind of Content-Type to use on un-specified files with unrecognized
146 #define HTTPPOST_CONTENTTYPE_DEFAULT "application/octet-stream"
148 #define FORM_FILE_SEPARATOR ','
149 #define FORM_TYPE_SEPARATOR ';'
151 /***************************************************************************
155 * Adds a HttpPost structure to the list, if parent_post is given becomes
156 * a subpost of parent_post instead of a direct list element.
158 * Returns newly allocated HttpPost on success and NULL if malloc failed.
160 ***************************************************************************/
161 static struct curl_httppost *
162 AddHttpPost(char *name, size_t namelength,
163 char *value, size_t contentslength,
164 char *buffer, size_t bufferlength,
167 struct curl_slist* contentHeader,
168 char *showfilename, char *userp,
169 struct curl_httppost *parent_post,
170 struct curl_httppost **httppost,
171 struct curl_httppost **last_post)
173 struct curl_httppost *post;
174 post = calloc(1, sizeof(struct curl_httppost));
177 post->namelength = (long)(name?(namelength?namelength:strlen(name)):0);
178 post->contents = value;
179 post->contentslength = (long)contentslength;
180 post->buffer = buffer;
181 post->bufferlength = (long)bufferlength;
182 post->contenttype = contenttype;
183 post->contentheader = contentHeader;
184 post->showfilename = showfilename;
192 /* now, point our 'more' to the original 'more' */
193 post->more = parent_post->more;
195 /* then move the original 'more' to point to ourselves */
196 parent_post->more = post;
199 /* make the previous point to this */
201 (*last_post)->next = post;
210 /***************************************************************************
214 * Adds a FormInfo structure to the list presented by parent_form_info.
216 * Returns newly allocated FormInfo on success and NULL if malloc failed/
217 * parent_form_info is NULL.
219 ***************************************************************************/
220 static FormInfo * AddFormInfo(char *value,
222 FormInfo *parent_form_info)
225 form_info = calloc(1, sizeof(struct FormInfo));
228 form_info->value = value;
230 form_info->contenttype = contenttype;
231 form_info->flags = HTTPPOST_FILENAME;
236 if(parent_form_info) {
237 /* now, point our 'more' to the original 'more' */
238 form_info->more = parent_form_info->more;
240 /* then move the original 'more' to point to ourselves */
241 parent_form_info->more = form_info;
249 /***************************************************************************
251 * ContentTypeForFilename()
253 * Provides content type for filename if one of the known types (else
254 * (either the prevtype or the default is returned).
256 * Returns some valid contenttype for filename.
258 ***************************************************************************/
259 static const char * ContentTypeForFilename (const char *filename,
260 const char *prevtype)
262 const char *contenttype = NULL;
265 * No type was specified, we scan through a few well-known
266 * extensions and pick the first we match!
272 static const struct ContentType ctts[]={
273 {".gif", "image/gif"},
274 {".jpg", "image/jpeg"},
275 {".jpeg", "image/jpeg"},
276 {".txt", "text/plain"},
277 {".html", "text/html"},
278 {".xml", "application/xml"}
282 /* default to the previously set/used! */
283 contenttype = prevtype;
285 contenttype = HTTPPOST_CONTENTTYPE_DEFAULT;
287 if(filename) { /* in case a NULL was passed in */
288 for(i=0; i<sizeof(ctts)/sizeof(ctts[0]); i++) {
289 if(strlen(filename) >= strlen(ctts[i].extension)) {
290 if(strequal(filename +
291 strlen(filename) - strlen(ctts[i].extension),
292 ctts[i].extension)) {
293 contenttype = ctts[i].type;
299 /* we have a contenttype by now */
303 /***************************************************************************
307 * Copies the 'source' data to a newly allocated buffer buffer (that is
308 * returned). Uses buffer_length if not null, else uses strlen to determine
309 * the length of the buffer to be copied
311 * Returns the new pointer or NULL on failure.
313 ***************************************************************************/
314 static char *memdup(const char *src, size_t buffer_length)
321 length = buffer_length;
323 length = strlen(src);
327 /* no length and a NULL src pointer! */
330 buffer = malloc(length+add);
332 return NULL; /* fail */
334 memcpy(buffer, src, length);
336 /* if length unknown do null termination */
338 buffer[length] = '\0';
343 /***************************************************************************
347 * Stores a formpost parameter and builds the appropriate linked list.
349 * Has two principal functionalities: using files and byte arrays as
350 * post parts. Byte arrays are either copied or just the pointer is stored
351 * (as the user requests) while for files only the filename and not the
354 * While you may have only one byte array for each name, multiple filenames
355 * are allowed (and because of this feature CURLFORM_END is needed after
356 * using CURLFORM_FILE).
360 * Simple name/value pair with copied contents:
361 * curl_formadd (&post, &last, CURLFORM_COPYNAME, "name",
362 * CURLFORM_COPYCONTENTS, "value", CURLFORM_END);
364 * name/value pair where only the content pointer is remembered:
365 * curl_formadd (&post, &last, CURLFORM_COPYNAME, "name",
366 * CURLFORM_PTRCONTENTS, ptr, CURLFORM_CONTENTSLENGTH, 10, CURLFORM_END);
367 * (if CURLFORM_CONTENTSLENGTH is missing strlen () is used)
369 * storing a filename (CONTENTTYPE is optional!):
370 * curl_formadd (&post, &last, CURLFORM_COPYNAME, "name",
371 * CURLFORM_FILE, "filename1", CURLFORM_CONTENTTYPE, "plain/text",
374 * storing multiple filenames:
375 * curl_formadd (&post, &last, CURLFORM_COPYNAME, "name",
376 * CURLFORM_FILE, "filename1", CURLFORM_FILE, "filename2", CURLFORM_END);
379 * CURL_FORMADD_OK on success
380 * CURL_FORMADD_MEMORY if the FormInfo allocation fails
381 * CURL_FORMADD_OPTION_TWICE if one option is given twice for one Form
382 * CURL_FORMADD_NULL if a null pointer was given for a char
383 * CURL_FORMADD_MEMORY if the allocation of a FormInfo struct failed
384 * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used
385 * CURL_FORMADD_INCOMPLETE if the some FormInfo is not complete (or an error)
386 * CURL_FORMADD_MEMORY if a HttpPost struct cannot be allocated
387 * CURL_FORMADD_MEMORY if some allocation for string copying failed.
388 * CURL_FORMADD_ILLEGAL_ARRAY if an illegal option is used in an array
390 ***************************************************************************/
393 CURLFORMcode FormAdd(struct curl_httppost **httppost,
394 struct curl_httppost **last_post,
397 FormInfo *first_form, *current_form, *form = NULL;
398 CURLFORMcode return_value = CURL_FORMADD_OK;
399 const char *prevtype = NULL;
400 struct curl_httppost *post = NULL;
401 CURLformoption option;
402 struct curl_forms *forms = NULL;
403 char *array_value=NULL; /* value read from an array */
405 /* This is a state variable, that if TRUE means that we're parsing an
406 array that we got passed to us. If FALSE we're parsing the input
407 va_list arguments. */
408 bool array_state = FALSE;
411 * We need to allocate the first struct to fill in.
413 first_form = calloc(1, sizeof(struct FormInfo));
415 return CURL_FORMADD_MEMORY;
417 current_form = first_form;
420 * Loop through all the options set. Break if we have an error to report.
422 while(return_value == CURL_FORMADD_OK) {
424 /* first see if we have more parts of the array param */
425 if( array_state && forms ) {
426 /* get the upcoming option from the given array */
427 option = forms->option;
428 array_value = (char *)forms->value;
430 forms++; /* advance this to next entry */
431 if(CURLFORM_END == option) {
432 /* end of array state */
438 /* This is not array-state, get next option */
439 option = va_arg(params, CURLformoption);
440 if(CURLFORM_END == option)
447 /* we don't support an array from within an array */
448 return_value = CURL_FORMADD_ILLEGAL_ARRAY;
450 forms = va_arg(params, struct curl_forms *);
454 return_value = CURL_FORMADD_NULL;
459 * Set the Name property.
461 case CURLFORM_PTRNAME:
462 #ifdef CURL_DOES_CONVERSIONS
463 /* treat CURLFORM_PTR like CURLFORM_COPYNAME so we'll
464 have safe memory for the eventual conversion */
466 current_form->flags |= HTTPPOST_PTRNAME; /* fall through */
468 case CURLFORM_COPYNAME:
469 if(current_form->name)
470 return_value = CURL_FORMADD_OPTION_TWICE;
472 char *name = array_state?
473 array_value:va_arg(params, char *);
475 current_form->name = name; /* store for the moment */
477 return_value = CURL_FORMADD_NULL;
480 case CURLFORM_NAMELENGTH:
481 if(current_form->namelength)
482 return_value = CURL_FORMADD_OPTION_TWICE;
484 current_form->namelength =
485 array_state?(size_t)array_value:(size_t)va_arg(params, long);
489 * Set the contents property.
491 case CURLFORM_PTRCONTENTS:
492 current_form->flags |= HTTPPOST_PTRCONTENTS; /* fall through */
493 case CURLFORM_COPYCONTENTS:
494 if(current_form->value)
495 return_value = CURL_FORMADD_OPTION_TWICE;
498 array_state?array_value:va_arg(params, char *);
500 current_form->value = value; /* store for the moment */
502 return_value = CURL_FORMADD_NULL;
505 case CURLFORM_CONTENTSLENGTH:
506 if(current_form->contentslength)
507 return_value = CURL_FORMADD_OPTION_TWICE;
509 current_form->contentslength =
510 array_state?(size_t)array_value:(size_t)va_arg(params, long);
513 /* Get contents from a given file name */
514 case CURLFORM_FILECONTENT:
515 if(current_form->flags != 0)
516 return_value = CURL_FORMADD_OPTION_TWICE;
518 const char *filename = array_state?
519 array_value:va_arg(params, char *);
521 current_form->value = strdup(filename);
522 if(!current_form->value)
523 return_value = CURL_FORMADD_MEMORY;
525 current_form->flags |= HTTPPOST_READFILE;
526 current_form->value_alloc = TRUE;
530 return_value = CURL_FORMADD_NULL;
534 /* We upload a file */
537 const char *filename = array_state?array_value:
538 va_arg(params, char *);
540 if(current_form->value) {
541 if(current_form->flags & HTTPPOST_FILENAME) {
543 if((current_form = AddFormInfo(strdup(filename),
544 NULL, current_form)) == NULL)
545 return_value = CURL_FORMADD_MEMORY;
548 return_value = CURL_FORMADD_NULL;
551 return_value = CURL_FORMADD_OPTION_TWICE;
555 current_form->value = strdup(filename);
556 if(!current_form->value)
557 return_value = CURL_FORMADD_MEMORY;
559 current_form->flags |= HTTPPOST_FILENAME;
560 current_form->value_alloc = TRUE;
564 return_value = CURL_FORMADD_NULL;
569 case CURLFORM_BUFFER:
571 const char *filename = array_state?array_value:
572 va_arg(params, char *);
574 if(current_form->value) {
575 if(current_form->flags & HTTPPOST_BUFFER) {
577 if((current_form = AddFormInfo(strdup(filename),
578 NULL, current_form)) == NULL)
579 return_value = CURL_FORMADD_MEMORY;
582 return_value = CURL_FORMADD_NULL;
585 return_value = CURL_FORMADD_OPTION_TWICE;
589 current_form->value = strdup(filename);
590 if(!current_form->value)
591 return_value = CURL_FORMADD_MEMORY;
594 return_value = CURL_FORMADD_NULL;
595 current_form->flags |= HTTPPOST_BUFFER;
600 case CURLFORM_BUFFERPTR:
601 current_form->flags |= HTTPPOST_PTRBUFFER;
602 if(current_form->buffer)
603 return_value = CURL_FORMADD_OPTION_TWICE;
606 array_state?array_value:va_arg(params, char *);
608 current_form->buffer = buffer; /* store for the moment */
610 return_value = CURL_FORMADD_NULL;
614 case CURLFORM_BUFFERLENGTH:
615 if(current_form->bufferlength)
616 return_value = CURL_FORMADD_OPTION_TWICE;
618 current_form->bufferlength =
619 array_state?(size_t)array_value:(size_t)va_arg(params, long);
622 case CURLFORM_STREAM:
623 current_form->flags |= HTTPPOST_CALLBACK;
624 if(current_form->userp)
625 return_value = CURL_FORMADD_OPTION_TWICE;
628 array_state?array_value:va_arg(params, char *);
630 current_form->userp = userp;
631 current_form->value = userp; /* this isn't strictly true but we
632 derive a value from this later on
633 and we need this non-NULL to be
634 accepted as a fine form part */
637 return_value = CURL_FORMADD_NULL;
641 case CURLFORM_CONTENTTYPE:
643 const char *contenttype =
644 array_state?array_value:va_arg(params, char *);
645 if(current_form->contenttype) {
646 if(current_form->flags & HTTPPOST_FILENAME) {
648 if((current_form = AddFormInfo(NULL,
650 current_form)) == NULL)
651 return_value = CURL_FORMADD_MEMORY;
654 return_value = CURL_FORMADD_NULL;
657 return_value = CURL_FORMADD_OPTION_TWICE;
661 current_form->contenttype = strdup(contenttype);
662 if(!current_form->contenttype)
663 return_value = CURL_FORMADD_MEMORY;
665 current_form->contenttype_alloc = TRUE;
668 return_value = CURL_FORMADD_NULL;
672 case CURLFORM_CONTENTHEADER:
674 /* this "cast increases required alignment of target type" but
675 we consider it OK anyway */
676 struct curl_slist* list = array_state?
677 (struct curl_slist*)array_value:
678 va_arg(params, struct curl_slist*);
680 if( current_form->contentheader )
681 return_value = CURL_FORMADD_OPTION_TWICE;
683 current_form->contentheader = list;
687 case CURLFORM_FILENAME:
689 const char *filename = array_state?array_value:
690 va_arg(params, char *);
691 if( current_form->showfilename )
692 return_value = CURL_FORMADD_OPTION_TWICE;
694 current_form->showfilename = strdup(filename);
695 if(!current_form->showfilename)
696 return_value = CURL_FORMADD_MEMORY;
698 current_form->showfilename_alloc = TRUE;
703 return_value = CURL_FORMADD_UNKNOWN_OPTION;
707 if(CURL_FORMADD_OK == return_value) {
708 /* go through the list, check for completeness and if everything is
709 * alright add the HttpPost item otherwise set return_value accordingly */
712 for(form = first_form;
715 if( ((!form->name || !form->value) && !post) ||
716 ( (form->contentslength) &&
717 (form->flags & HTTPPOST_FILENAME) ) ||
718 ( (form->flags & HTTPPOST_FILENAME) &&
719 (form->flags & HTTPPOST_PTRCONTENTS) ) ||
722 (form->flags & HTTPPOST_BUFFER) &&
723 (form->flags & HTTPPOST_PTRBUFFER) ) ||
725 ( (form->flags & HTTPPOST_READFILE) &&
726 (form->flags & HTTPPOST_PTRCONTENTS) )
728 return_value = CURL_FORMADD_INCOMPLETE;
732 if( ((form->flags & HTTPPOST_FILENAME) ||
733 (form->flags & HTTPPOST_BUFFER)) &&
734 !form->contenttype ) {
735 /* our contenttype is missing */
737 = strdup(ContentTypeForFilename(form->value, prevtype));
738 if(!form->contenttype) {
739 return_value = CURL_FORMADD_MEMORY;
742 form->contenttype_alloc = TRUE;
744 if( !(form->flags & HTTPPOST_PTRNAME) &&
745 (form == first_form) ) {
746 /* Note that there's small risk that form->name is NULL here if the
747 app passed in a bad combo, so we better check for that first. */
749 /* copy name (without strdup; possibly contains null characters) */
750 form->name = memdup(form->name, form->namelength);
752 return_value = CURL_FORMADD_MEMORY;
755 form->name_alloc = TRUE;
757 if( !(form->flags & (HTTPPOST_FILENAME | HTTPPOST_READFILE |
758 HTTPPOST_PTRCONTENTS | HTTPPOST_PTRBUFFER |
759 HTTPPOST_CALLBACK)) ) {
760 /* copy value (without strdup; possibly contains null characters) */
761 form->value = memdup(form->value, form->contentslength);
763 return_value = CURL_FORMADD_MEMORY;
766 form->value_alloc = TRUE;
768 post = AddHttpPost(form->name, form->namelength,
769 form->value, form->contentslength,
770 form->buffer, form->bufferlength,
771 form->contenttype, form->flags,
772 form->contentheader, form->showfilename,
778 return_value = CURL_FORMADD_MEMORY;
782 if(form->contenttype)
783 prevtype = form->contenttype;
789 /* we return on error, free possibly allocated fields */
795 if(form->value_alloc)
797 if(form->contenttype_alloc)
798 free(form->contenttype);
799 if(form->showfilename_alloc)
800 free(form->showfilename);
804 /* always delete the allocated memory before returning */
806 while(form != NULL) {
807 FormInfo *delete_form;
818 * curl_formadd() is a public API to add a section to the multipart formpost.
821 CURLFORMcode curl_formadd(struct curl_httppost **httppost,
822 struct curl_httppost **last_post,
827 va_start(arg, last_post);
828 result = FormAdd(httppost, last_post, arg);
834 * AddFormData() adds a chunk of data to the FormData linked list.
836 * size is incremented by the chunk length, unless it is NULL
838 static CURLcode AddFormData(struct FormData **formp,
844 struct FormData *newform = malloc(sizeof(struct FormData));
846 return CURLE_OUT_OF_MEMORY;
847 newform->next = NULL;
849 if(type <= FORM_CONTENT) {
850 /* we make it easier for plain strings: */
852 length = strlen((char *)line);
854 newform->line = malloc(length+1);
857 return CURLE_OUT_OF_MEMORY;
859 memcpy(newform->line, line, length);
860 newform->length = length;
861 newform->line[length]=0; /* zero terminate for easier debugging */
864 /* For callbacks and files we don't have any actual data so we just keep a
865 pointer to whatever this points to */
866 newform->line = (char *)line;
868 newform->type = type;
871 (*formp)->next = newform;
878 if(type != FORM_FILE)
879 /* for static content as well as callback data we add the size given
883 /* Since this is a file to be uploaded here, add the size of the actual
885 if(!strequal("-", newform->line)) {
887 if(!stat(newform->line, &file)) {
888 *size += file.st_size;
897 * AddFormDataf() adds printf()-style formatted data to the formdata chain.
900 static CURLcode AddFormDataf(struct FormData **formp,
902 const char *fmt, ...)
907 vsnprintf(s, sizeof(s), fmt, ap);
910 return AddFormData(formp, FORM_DATA, s, 0, size);
914 * Curl_formclean() is used from http.c, this cleans a built FormData linked
917 void Curl_formclean(struct FormData **form_ptr)
919 struct FormData *next, *form;
926 next=form->next; /* the following form line */
927 if(form->type <= FORM_CONTENT)
928 free(form->line); /* free the line */
929 free(form); /* free the struct */
931 } while((form = next) != NULL); /* continue */
936 #ifdef CURL_DOES_CONVERSIONS
938 * Curl_formcovert() is used from http.c, this converts any
939 form items that need to be sent in the network encoding.
940 Returns CURLE_OK on success.
942 CURLcode Curl_formconvert(struct SessionHandle *data, struct FormData *form)
944 struct FormData *next;
951 return CURLE_BAD_FUNCTION_ARGUMENT;
954 next=form->next; /* the following form line */
955 if(form->type == FORM_DATA) {
956 rc = Curl_convert_to_network(data, form->line, form->length);
957 /* Curl_convert_to_network calls failf if unsuccessful */
961 } while((form = next) != NULL); /* continue */
964 #endif /* CURL_DOES_CONVERSIONS */
968 * Serialize a curl_httppost struct.
969 * Returns 0 on success.
971 int curl_formget(struct curl_httppost *form, void *arg,
972 curl_formget_callback append)
976 struct FormData *data, *ptr;
978 rc = Curl_getFormData(&data, form, NULL, &size);
982 for (ptr = data; ptr; ptr = ptr->next) {
983 if(ptr->type == FORM_FILE) {
988 Curl_FormInit(&temp, ptr);
991 nread = readfromfile(&temp, buffer, sizeof(buffer));
992 if((nread == (size_t) -1) || (nread != append(arg, buffer, nread))) {
996 Curl_formclean(&data);
999 } while(nread == sizeof(buffer));
1002 if(ptr->length != append(arg, ptr->line, ptr->length)) {
1003 Curl_formclean(&data);
1008 Curl_formclean(&data);
1013 * curl_formfree() is an external function to free up a whole form post
1016 void curl_formfree(struct curl_httppost *form)
1018 struct curl_httppost *next;
1021 /* no form to free, just get out of this */
1025 next=form->next; /* the following form line */
1027 /* recurse to sub-contents */
1029 curl_formfree(form->more);
1031 if( !(form->flags & HTTPPOST_PTRNAME) && form->name)
1032 free(form->name); /* free the name */
1033 if( !(form->flags & (HTTPPOST_PTRCONTENTS|HTTPPOST_CALLBACK)) &&
1035 free(form->contents); /* free the contents */
1036 if(form->contenttype)
1037 free(form->contenttype); /* free the content type */
1038 if(form->showfilename)
1039 free(form->showfilename); /* free the faked file name */
1040 free(form); /* free the struct */
1042 } while((form = next) != NULL); /* continue */
1045 #ifndef HAVE_BASENAME
1047 (Quote from The Open Group Base Specifications Issue 6 IEEE Std 1003.1, 2004
1050 The basename() function shall take the pathname pointed to by path and
1051 return a pointer to the final component of the pathname, deleting any
1052 trailing '/' characters.
1054 If the string pointed to by path consists entirely of the '/' character,
1055 basename() shall return a pointer to the string "/". If the string pointed
1056 to by path is exactly "//", it is implementation-defined whether '/' or "//"
1059 If path is a null pointer or points to an empty string, basename() shall
1060 return a pointer to the string ".".
1062 The basename() function may modify the string pointed to by path, and may
1063 return a pointer to static storage that may then be overwritten by a
1064 subsequent call to basename().
1066 The basename() function need not be reentrant. A function that is not
1067 required to be reentrant is not required to be thread-safe.
1070 static char *Curl_basename(char *path)
1072 /* Ignore all the details above for now and make a quick and simple
1073 implementaion here */
1077 s1=strrchr(path, '/');
1078 s2=strrchr(path, '\\');
1081 path = (s1 > s2? s1 : s2)+1;
1092 static char *strippath(const char *fullfile)
1096 filename = strdup(fullfile); /* duplicate since basename() may ruin the
1097 buffer it works on */
1100 base = strdup(basename(filename));
1102 free(filename); /* free temporary buffer */
1104 return base; /* returns an allocated string or NULL ! */
1108 * Curl_getFormData() converts a linked list of "meta data" into a complete
1109 * (possibly huge) multipart formdata. The input list is in 'post', while the
1110 * output resulting linked lists gets stored in '*finalform'. *sizep will get
1111 * the total size of the whole POST.
1112 * A multipart/form_data content-type is built, unless a custom content-type
1113 * is passed in 'custom_content_type'.
1116 CURLcode Curl_getFormData(struct FormData **finalform,
1117 struct curl_httppost *post,
1118 const char *custom_content_type,
1121 struct FormData *form = NULL;
1122 struct FormData *firstform;
1123 struct curl_httppost *file;
1124 CURLcode result = CURLE_OK;
1126 curl_off_t size=0; /* support potentially ENORMOUS formposts */
1128 char *fileboundary=NULL;
1129 struct curl_slist* curList;
1131 *finalform=NULL; /* default form is empty */
1134 return result; /* no input => no output! */
1136 boundary = Curl_FormBoundary();
1138 return CURLE_OUT_OF_MEMORY;
1140 /* Make the first line of the output */
1141 result = AddFormDataf(&form, NULL,
1142 "%s; boundary=%s\r\n",
1143 custom_content_type?custom_content_type:
1144 "Content-Type: multipart/form-data",
1151 /* we DO NOT include that line in the total size of the POST, since it'll be
1152 part of the header! */
1159 result = AddFormDataf(&form, &size, "\r\n");
1165 result = AddFormDataf(&form, &size, "--%s\r\n", boundary);
1169 /* Maybe later this should be disabled when a custom_content_type is
1170 passed, since Content-Disposition is not meaningful for all multipart
1173 result = AddFormDataf(&form, &size,
1174 "Content-Disposition: form-data; name=\"");
1178 result = AddFormData(&form, FORM_DATA, post->name, post->namelength,
1183 result = AddFormDataf(&form, &size, "\"");
1188 /* If used, this is a link to more file names, we must then do
1189 the magic to include several files with the same field name */
1191 fileboundary = Curl_FormBoundary();
1193 result = AddFormDataf(&form, &size,
1194 "\r\nContent-Type: multipart/mixed,"
1205 /* If 'showfilename' is set, that is a faked name passed on to us
1206 to use to in the formpost. If that is not set, the actually used
1207 local file name should be added. */
1210 /* if multiple-file */
1211 char *filebasename= NULL;
1212 if(!file->showfilename) {
1213 filebasename = strippath(file->contents);
1215 Curl_formclean(&firstform);
1217 return CURLE_OUT_OF_MEMORY;
1221 result = AddFormDataf(&form, &size,
1222 "\r\n--%s\r\nContent-Disposition: "
1223 "attachment; filename=\"%s\"",
1225 (file->showfilename?file->showfilename:
1232 else if(post->flags & (HTTPPOST_FILENAME|HTTPPOST_BUFFER|
1233 HTTPPOST_CALLBACK)) {
1234 /* it should be noted that for the HTTPPOST_FILENAME and
1235 HTTPPOST_CALLBACK cases the ->showfilename struct member is always
1236 assigned at this point */
1238 (!post->showfilename)?strippath(post->contents):NULL;
1240 result = AddFormDataf(&form, &size,
1241 "; filename=\"%s\"",
1242 (post->showfilename?post->showfilename:
1251 if(file->contenttype) {
1252 /* we have a specified type */
1253 result = AddFormDataf(&form, &size,
1254 "\r\nContent-Type: %s",
1260 curList = file->contentheader;
1262 /* Process the additional headers specified for this form */
1263 result = AddFormDataf( &form, &size, "\r\n%s", curList->data );
1266 curList = curList->next;
1269 Curl_formclean(&firstform);
1275 /* The header Content-Transfer-Encoding: seems to confuse some receivers
1276 * (like the built-in PHP engine). While I can't see any reason why it
1277 * should, I can just as well skip this to the benefit of the users who
1278 * are using such confused receivers.
1281 if(file->contenttype &&
1282 !checkprefix("text/", file->contenttype)) {
1283 /* this is not a text content, mention our binary encoding */
1284 result = AddFormDataf(&form, &size,
1285 "\r\nContent-Transfer-Encoding: binary");
1291 result = AddFormDataf(&form, &size, "\r\n\r\n");
1295 if((post->flags & HTTPPOST_FILENAME) ||
1296 (post->flags & HTTPPOST_READFILE)) {
1297 /* we should include the contents from the specified file */
1300 fileread = strequal("-", file->contents)?
1301 stdin:fopen(file->contents, "rb"); /* binary read for win32 */
1304 * VMS: This only allows for stream files on VMS. Stream files are
1305 * OK, as are FIXED & VAR files WITHOUT implied CC For implied CC,
1306 * every record needs to have a \n appended & 1 added to SIZE
1310 if(fileread != stdin) {
1311 /* close the file again */
1313 /* add the file name only - for later reading from this */
1314 result = AddFormData(&form, FORM_FILE, file->contents, 0, &size);
1317 /* When uploading from stdin, we can't know the size of the file,
1318 * thus must read the full file as before. We *could* use chunked
1319 * transfer-encoding, but that only works for HTTP 1.1 and we
1320 * can't be sure we work with such a server.
1324 while((nread = fread(buffer, 1, sizeof(buffer), fileread)) != 0) {
1325 result = AddFormData(&form, FORM_CONTENT, buffer, nread, &size);
1332 Curl_formclean(&firstform);
1341 "\n==> Curl_getFormData couldn't open/read \"%s\"\n",
1344 Curl_formclean(&firstform);
1347 return CURLE_READ_ERROR;
1351 else if(post->flags & HTTPPOST_BUFFER) {
1352 /* include contents of buffer */
1353 result = AddFormData(&form, FORM_CONTENT, post->buffer,
1354 post->bufferlength, &size);
1358 else if(post->flags & HTTPPOST_CALLBACK) {
1359 /* the contents should be read with the callback and the size
1360 is set with the contentslength */
1361 result = AddFormData(&form, FORM_CALLBACK, post->userp,
1362 post->contentslength, &size);
1367 /* include the contents we got */
1368 result = AddFormData(&form, FORM_CONTENT, post->contents,
1369 post->contentslength, &size);
1373 } while((file = file->more) != NULL); /* for each specified file for this field */
1375 Curl_formclean(&firstform);
1381 /* this was a multiple-file inclusion, make a termination file
1383 result = AddFormDataf(&form, &size,
1391 } while((post = post->next) != NULL); /* for each field */
1393 Curl_formclean(&firstform);
1398 /* end-boundary for everything */
1399 result = AddFormDataf(&form, &size,
1403 Curl_formclean(&firstform);
1412 *finalform=firstform;
1418 * Curl_FormInit() inits the struct 'form' points to with the 'formdata'
1419 * and resets the 'sent' counter.
1421 int Curl_FormInit(struct Form *form, struct FormData *formdata )
1424 return 1; /* error */
1426 form->data = formdata;
1429 form->fread_func = ZERO_NULL;
1434 static size_t readfromfile(struct Form *form, char *buffer,
1438 bool callback = (bool)(form->data->type == FORM_CALLBACK);
1441 nread = form->fread_func(buffer, 1, size, form->data->line);
1444 /* this file hasn't yet been opened */
1445 form->fp = fopen(form->data->line, "rb"); /* b is for binary */
1447 return (size_t)-1; /* failure */
1449 nread = fread(buffer, 1, size, form->fp);
1451 if(!nread || nread > size) {
1452 /* this is the last chunk from the file, move on */
1457 form->data = form->data->next;
1464 * Curl_FormReader() is the fread() emulation function that will be used to
1465 * deliver the formdata to the transfer loop and then sent away to the peer.
1467 size_t Curl_FormReader(char *buffer,
1476 form=(struct Form *)mydata;
1478 wantedsize = size * nitems;
1481 return 0; /* nothing, error, empty */
1483 if((form->data->type == FORM_FILE) ||
1484 (form->data->type == FORM_CALLBACK)) {
1485 gotsize = readfromfile(form, buffer, wantedsize);
1488 /* If positive or -1, return. If zero, continue! */
1493 if( (form->data->length - form->sent ) > wantedsize - gotsize) {
1495 memcpy(buffer + gotsize , form->data->line + form->sent,
1496 wantedsize - gotsize);
1498 form->sent += wantedsize-gotsize;
1503 memcpy(buffer+gotsize,
1504 form->data->line + form->sent,
1505 (form->data->length - form->sent) );
1506 gotsize += form->data->length - form->sent;
1510 form->data = form->data->next; /* advance */
1512 } while(form->data && (form->data->type < FORM_CALLBACK));
1513 /* If we got an empty line and we have more data, we proceed to the next
1514 line immediately to avoid returning zero before we've reached the end. */
1520 * Curl_formpostheader() returns the first line of the formpost, the
1521 * request-header part (which is not part of the request-body like the rest of
1524 char *Curl_formpostheader(void *formp, size_t *len)
1527 struct Form *form=(struct Form *)formp;
1530 return 0; /* nothing, ERROR! */
1532 header = form->data->line;
1533 *len = form->data->length;
1535 form->data = form->data->next; /* advance */
1542 int FormAddTest(const char * errormsg,
1543 struct curl_httppost **httppost,
1544 struct curl_httppost **last_post,
1549 va_start(arg, last_post);
1550 if((result = FormAdd(httppost, last_post, arg)))
1551 fprintf (stderr, "ERROR doing FormAdd ret: %d action: %s\n", result,
1558 int main(int argc, argv_item_t argv[])
1560 char name1[] = "simple_COPYCONTENTS";
1561 char name2[] = "COPYCONTENTS_+_CONTENTTYPE";
1562 char name3[] = "PTRNAME_+_NAMELENGTH_+_COPYNAME_+_CONTENTSLENGTH";
1563 char name4[] = "simple_PTRCONTENTS";
1564 char name5[] = "PTRCONTENTS_+_CONTENTSLENGTH";
1565 char name6[] = "PTRCONTENTS_+_CONTENTSLENGTH_+_CONTENTTYPE";
1566 char name7[] = "FILE1_+_CONTENTTYPE";
1567 char name8[] = "FILE1_+_FILE2";
1568 char name9[] = "FILE1_+_FILE2_+_FILE3";
1569 char name10[] = "ARRAY: FILE1_+_FILE2_+_FILE3";
1570 char name11[] = "FILECONTENT";
1571 char value1[] = "value for simple COPYCONTENTS";
1572 char value2[] = "value for COPYCONTENTS + CONTENTTYPE";
1573 char value3[] = "value for PTRNAME + NAMELENGTH + COPYNAME + CONTENTSLENGTH";
1574 char value4[] = "value for simple PTRCONTENTS";
1575 char value5[] = "value for PTRCONTENTS + CONTENTSLENGTH";
1576 char value6[] = "value for PTRCONTENTS + CONTENTSLENGTH + CONTENTTYPE";
1577 char value7[] = "formdata.h";
1578 char value8[] = "Makefile.b32";
1579 char type2[] = "image/gif";
1580 char type6[] = "text/plain";
1581 char type7[] = "text/html";
1582 int name3length = strlen(name3);
1583 int value3length = strlen(value3);
1584 int value5length = strlen(value5);
1585 int value6length = strlen(value6);
1591 struct curl_httppost *httppost=NULL;
1592 struct curl_httppost *last_post=NULL;
1593 struct curl_forms forms[4];
1595 struct FormData *form;
1596 struct Form formread;
1601 Curl_srand(); /* Because we do not call curl_global_init() here. */
1603 if(FormAddTest("simple COPYCONTENTS test", &httppost, &last_post,
1604 CURLFORM_COPYNAME, name1, CURLFORM_COPYCONTENTS, value1,
1607 if(FormAddTest("COPYCONTENTS + CONTENTTYPE test", &httppost, &last_post,
1608 CURLFORM_COPYNAME, name2, CURLFORM_COPYCONTENTS, value2,
1609 CURLFORM_CONTENTTYPE, type2, CURLFORM_END))
1611 /* make null character at start to check that contentslength works
1615 if(FormAddTest("PTRNAME + NAMELENGTH + COPYNAME + CONTENTSLENGTH test",
1616 &httppost, &last_post,
1617 CURLFORM_PTRNAME, name3, CURLFORM_COPYCONTENTS, value3,
1618 CURLFORM_CONTENTSLENGTH, value3length,
1619 CURLFORM_NAMELENGTH, name3length, CURLFORM_END))
1621 if(FormAddTest("simple PTRCONTENTS test", &httppost, &last_post,
1622 CURLFORM_COPYNAME, name4, CURLFORM_PTRCONTENTS, value4,
1625 /* make null character at start to check that contentslength works
1628 if(FormAddTest("PTRCONTENTS + CONTENTSLENGTH test", &httppost, &last_post,
1629 CURLFORM_COPYNAME, name5, CURLFORM_PTRCONTENTS, value5,
1630 CURLFORM_CONTENTSLENGTH, value5length, CURLFORM_END))
1632 /* make null character at start to check that contentslength works
1635 if(FormAddTest("PTRCONTENTS + CONTENTSLENGTH + CONTENTTYPE test",
1636 &httppost, &last_post,
1637 CURLFORM_COPYNAME, name6, CURLFORM_PTRCONTENTS, value6,
1638 CURLFORM_CONTENTSLENGTH, value6length,
1639 CURLFORM_CONTENTTYPE, type6, CURLFORM_END))
1641 if(FormAddTest("FILE + CONTENTTYPE test", &httppost, &last_post,
1642 CURLFORM_COPYNAME, name7, CURLFORM_FILE, value7,
1643 CURLFORM_CONTENTTYPE, type7, CURLFORM_END))
1645 if(FormAddTest("FILE1 + FILE2 test", &httppost, &last_post,
1646 CURLFORM_COPYNAME, name8, CURLFORM_FILE, value7,
1647 CURLFORM_FILE, value8, CURLFORM_END))
1649 if(FormAddTest("FILE1 + FILE2 + FILE3 test", &httppost, &last_post,
1650 CURLFORM_COPYNAME, name9, CURLFORM_FILE, value7,
1651 CURLFORM_FILE, value8, CURLFORM_FILE, value7, CURLFORM_END))
1653 forms[0].option = CURLFORM_FILE;
1654 forms[0].value = value7;
1655 forms[1].option = CURLFORM_FILE;
1656 forms[1].value = value8;
1657 forms[2].option = CURLFORM_FILE;
1658 forms[2].value = value7;
1659 forms[3].option = CURLFORM_END;
1660 if(FormAddTest("FILE1 + FILE2 + FILE3 ARRAY test", &httppost, &last_post,
1661 CURLFORM_COPYNAME, name10, CURLFORM_ARRAY, forms,
1664 if(FormAddTest("FILECONTENT test", &httppost, &last_post,
1665 CURLFORM_COPYNAME, name11, CURLFORM_FILECONTENT, value7,
1669 rc = Curl_getFormData(&form, httppost, NULL, &size);
1670 if(rc != CURLE_OK) {
1671 if(rc != CURLE_READ_ERROR) {
1672 const char *errortext = curl_easy_strerror(rc);
1673 fprintf(stdout, "\n==> Curl_getFormData error: %s\n", errortext);
1678 Curl_FormInit(&formread, form);
1681 nread = Curl_FormReader(buffer, 1, sizeof(buffer),
1686 fwrite(buffer, nread, 1, stdout);
1689 fprintf(stdout, "size: ");
1690 fprintf(stdout, "%" FORMAT_OFF_T, size);
1691 fprintf(stdout, "\n");
1693 fprintf(stdout, "\n==> %d Test(s) failed!\n", errors);
1695 fprintf(stdout, "\nAll Tests seem to have worked (please check output)\n");
1700 #endif /* _FORM_DEBUG */
1702 #else /* CURL_DISABLE_HTTP */
1703 CURLFORMcode curl_formadd(struct curl_httppost **httppost,
1704 struct curl_httppost **last_post,
1709 return CURL_FORMADD_DISABLED;
1712 int curl_formget(struct curl_httppost *form, void *arg,
1713 curl_formget_callback append)
1718 return CURL_FORMADD_DISABLED;
1721 void curl_formfree(struct curl_httppost *form)
1724 /* does nothing HTTP is disabled */
1727 #endif /* CURL_DISABLE_HTTP */
1729 #if !defined(CURL_DISABLE_HTTP) || defined(USE_SSLEAY)
1732 * Curl_FormBoundary() creates a suitable boundary string and returns an
1733 * allocated one. This is also used by SSL-code so it must be present even
1734 * if HTTP is disabled!
1736 char *Curl_FormBoundary(void)
1741 static const char table16[]="0123456789abcdef";
1743 retstring = malloc(BOUNDARY_LENGTH+1);
1746 return NULL; /* failed */
1748 strcpy(retstring, "----------------------------");
1750 for(i=strlen(retstring); i<BOUNDARY_LENGTH; i++)
1751 retstring[i] = table16[Curl_rand()%16];
1753 /* 28 dashes and 12 hexadecimal digits makes 12^16 (184884258895036416)
1755 retstring[BOUNDARY_LENGTH]=0; /* zero terminate */
1760 #endif /* !defined(CURL_DISABLE_HTTP) || defined(USE_SSLEAY) */