]>
git.ipfire.org Git - thirdparty/cups.git/blob - cgi-bin/var.c
2 * "$Id: var.c 7460 2008-04-16 02:19:54Z mike $"
4 * CGI form variable and array functions.
6 * Copyright 2007-2008 by Apple Inc.
7 * Copyright 1997-2005 by Easy Software Products.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
17 * cgiCheckVariables() - Check for the presence of "required" variables.
18 * cgiGetArray() - Get an element from a form array...
19 * cgiGetFile() - Get the file (if any) that was submitted in the form.
20 * cgiGetSize() - Get the size of a form array value.
21 * cgiGetVariable() - Get a CGI variable from the database...
22 * cgiInitialize() - Initialize the CGI variable "database"...
23 * cgiIsPOST() - Determine whether this page was POSTed.
24 * cgiSetArray() - Set array element N to the specified string.
25 * cgiSetSize() - Set the array size.
26 * cgiSetVariable() - Set a CGI variable in the database...
27 * cgi_add_variable() - Add a form variable.
28 * cgi_compare_variables() - Compare two variables.
29 * cgi_find_variable() - Find a variable...
30 * cgi_initialize_get() - Initialize form variables using the GET method.
31 * cgi_initialize_multipart() - Initialize variables and file using the POST method.
32 * cgi_initialize_post() - Initialize variables using the POST method.
33 * cgi_initialize_string() - Initialize form variables from a string.
34 * cgi_passwd() - Catch authentication requests and notify the server.
35 * cgi_sort_variables() - Sort all form variables for faster lookup.
36 * cgi_unlink_file() - Remove the uploaded form.
40 #include "cgi-private.h"
45 * Data structure to hold all the CGI form variables and arrays...
48 typedef struct /**** Form variable structure ****/
50 const char *name
; /* Name of variable */
51 int nvalues
, /* Number of values */
52 avalues
; /* Number of values allocated */
53 const char **values
; /* Value(s) of variable */
61 static int form_count
= 0, /* Form variable count */
62 form_alloc
= 0; /* Number of variables allocated */
63 static _cgi_var_t
*form_vars
= NULL
;
65 static cgi_file_t
*form_file
= NULL
;
73 static void cgi_add_variable(const char *name
, int element
,
75 static int cgi_compare_variables(const _cgi_var_t
*v1
,
76 const _cgi_var_t
*v2
);
77 static _cgi_var_t
*cgi_find_variable(const char *name
);
78 static int cgi_initialize_get(void);
79 static int cgi_initialize_multipart(const char *boundary
);
80 static int cgi_initialize_post(void);
81 static int cgi_initialize_string(const char *data
);
82 static const char *cgi_passwd(const char *prompt
);
83 static void cgi_sort_variables(void);
84 static void cgi_unlink_file(void);
88 * 'cgiCheckVariables()' - Check for the presence of "required" variables.
90 * Names may be separated by spaces and/or commas.
93 int /* O - 1 if all variables present, 0 otherwise */
94 cgiCheckVariables(const char *names
) /* I - Variables to look for */
96 char name
[255], /* Current variable name */
97 *s
; /* Pointer in string */
98 const char *val
; /* Value of variable */
99 int element
; /* Array element number */
105 while (*names
!= '\0')
107 while (*names
== ' ' || *names
== ',')
110 for (s
= name
; *names
!= '\0' && *names
!= ' ' && *names
!= ','; s
++, names
++)
117 if ((s
= strrchr(name
, '-')) != NULL
)
120 element
= atoi(s
+ 1) - 1;
121 val
= cgiGetArray(name
, element
);
124 val
= cgiGetVariable(name
);
130 return (0); /* Can't be blank, either! */
138 * 'cgiGetArray()' - Get an element from a form array...
141 const char * /* O - Element value or NULL */
142 cgiGetArray(const char *name
, /* I - Name of array variable */
143 int element
) /* I - Element number (0 to N) */
145 _cgi_var_t
*var
; /* Pointer to variable */
148 if ((var
= cgi_find_variable(name
)) == NULL
)
151 if (var
->nvalues
== 1)
152 return (var
->values
[0]);
154 if (element
< 0 || element
>= var
->nvalues
)
157 return (var
->values
[element
]);
162 * 'cgiGetFile()' - Get the file (if any) that was submitted in the form.
165 const cgi_file_t
* /* O - Attached file or NULL */
173 * 'cgiGetSize()' - Get the size of a form array value.
176 int /* O - Number of elements */
177 cgiGetSize(const char *name
) /* I - Name of variable */
179 _cgi_var_t
*var
; /* Pointer to variable */
182 if ((var
= cgi_find_variable(name
)) == NULL
)
185 return (var
->nvalues
);
190 * 'cgiGetVariable()' - Get a CGI variable from the database...
192 * Returns NULL if the variable doesn't exist. If the variable is an
193 * array of values, returns the last element...
196 const char * /* O - Value of variable */
197 cgiGetVariable(const char *name
) /* I - Name of variable */
199 const _cgi_var_t
*var
; /* Returned variable */
202 var
= cgi_find_variable(name
);
206 DEBUG_printf(("cgiGetVariable(\"%s\") is returning NULL...\n", name
));
208 DEBUG_printf(("cgiGetVariable(\"%s\") is returning \"%s\"...\n", name
,
209 var
->values
[var
->nvalues
- 1]));
212 return ((var
== NULL
) ? NULL
: var
->values
[var
->nvalues
- 1]);
217 * 'cgiInitialize()' - Initialize the CGI variable "database"...
220 int /* O - Non-zero if there was form data */
223 const char *method
; /* Form posting method */
224 const char *content_type
; /* Content-Type of post data */
228 * Setup a password callback for authentication...
231 cupsSetPasswordCB(cgi_passwd
);
234 * Set the locale so that times, etc. are formatted properly...
237 setlocale(LC_ALL
, "");
241 * Disable output buffering to find bugs...
244 setbuf(stdout
, NULL
);
248 * Get the request method (GET or POST)...
251 method
= getenv("REQUEST_METHOD");
252 content_type
= getenv("CONTENT_TYPE");
257 * Grab form data from the corresponding location...
260 if (!strcasecmp(method
, "GET"))
261 return (cgi_initialize_get());
262 else if (!strcasecmp(method
, "POST") && content_type
)
264 const char *boundary
= strstr(content_type
, "boundary=");
269 if (content_type
&& !strncmp(content_type
, "multipart/form-data; ", 21))
270 return (cgi_initialize_multipart(boundary
));
272 return (cgi_initialize_post());
280 * 'cgiIsPOST()' - Determine whether this page was POSTed.
283 int /* O - 1 if POST, 0 if GET */
286 const char *method
; /* REQUEST_METHOD environment variable */
289 if ((method
= getenv("REQUEST_METHOD")) == NULL
)
292 return (!strcmp(method
, "POST"));
297 * 'cgiSetArray()' - Set array element N to the specified string.
299 * If the variable array is smaller than (element + 1), the intervening
300 * elements are set to NULL.
304 cgiSetArray(const char *name
, /* I - Name of variable */
305 int element
, /* I - Element number (0 to N) */
306 const char *value
) /* I - Value of variable */
308 int i
; /* Looping var */
309 _cgi_var_t
*var
; /* Returned variable */
312 if (name
== NULL
|| value
== NULL
|| element
< 0 || element
> 100000)
315 if ((var
= cgi_find_variable(name
)) == NULL
)
317 cgi_add_variable(name
, element
, value
);
318 cgi_sort_variables();
322 if (element
>= var
->avalues
)
324 const char **temp
; /* Temporary pointer */
326 temp
= (const char **)realloc((void *)(var
->values
),
327 sizeof(char *) * (element
+ 16));
331 var
->avalues
= element
+ 16;
335 if (element
>= var
->nvalues
)
337 for (i
= var
->nvalues
; i
< element
; i
++)
338 var
->values
[i
] = NULL
;
340 var
->nvalues
= element
+ 1;
342 else if (var
->values
[element
])
343 free((char *)var
->values
[element
]);
345 var
->values
[element
] = strdup(value
);
351 * 'cgiSetSize()' - Set the array size.
355 cgiSetSize(const char *name
, /* I - Name of variable */
356 int size
) /* I - Number of elements (0 to N) */
358 int i
; /* Looping var */
359 _cgi_var_t
*var
; /* Returned variable */
362 if (name
== NULL
|| size
< 0 || size
> 100000)
365 if ((var
= cgi_find_variable(name
)) == NULL
)
368 if (size
>= var
->avalues
)
370 const char **temp
; /* Temporary pointer */
372 temp
= (const char **)realloc((void *)(var
->values
),
373 sizeof(char *) * (size
+ 16));
377 var
->avalues
= size
+ 16;
381 if (size
> var
->nvalues
)
383 for (i
= var
->nvalues
; i
< size
; i
++)
384 var
->values
[i
] = NULL
;
386 else if (size
< var
->nvalues
)
388 for (i
= size
; i
< var
->nvalues
; i
++)
390 free((void *)(var
->values
[i
]));
398 * 'cgiSetVariable()' - Set a CGI variable in the database...
400 * If the variable is an array, this truncates the array to a single element.
404 cgiSetVariable(const char *name
, /* I - Name of variable */
405 const char *value
) /* I - Value of variable */
407 int i
; /* Looping var */
408 _cgi_var_t
*var
; /* Returned variable */
411 if (name
== NULL
|| value
== NULL
)
414 if ((var
= cgi_find_variable(name
)) == NULL
)
416 cgi_add_variable(name
, 0, value
);
417 cgi_sort_variables();
421 for (i
= 0; i
< var
->nvalues
; i
++)
423 free((char *)var
->values
[i
]);
425 var
->values
[0] = strdup(value
);
432 * 'cgi_add_variable()' - Add a form variable.
436 cgi_add_variable(const char *name
, /* I - Variable name */
437 int element
, /* I - Array element number */
438 const char *value
) /* I - Variable value */
440 _cgi_var_t
*var
; /* New variable */
443 if (name
== NULL
|| value
== NULL
|| element
< 0 || element
> 100000)
446 DEBUG_printf(("cgi_add_variable: Adding variable \'%s\' with value "
447 "\'%s\'...\n", name
, value
));
449 if (form_count
>= form_alloc
)
451 _cgi_var_t
*temp_vars
; /* Temporary form pointer */
455 temp_vars
= malloc(sizeof(_cgi_var_t
) * 16);
457 temp_vars
= realloc(form_vars
, (form_alloc
+ 16) * sizeof(_cgi_var_t
));
462 form_vars
= temp_vars
;
466 var
= form_vars
+ form_count
;
468 if ((var
->values
= calloc(element
+ 1, sizeof(char *))) == NULL
)
471 var
->name
= strdup(name
);
472 var
->nvalues
= element
+ 1;
473 var
->avalues
= element
+ 1;
474 var
->values
[element
] = strdup(value
);
481 * 'cgi_compare_variables()' - Compare two variables.
484 static int /* O - Result of comparison */
485 cgi_compare_variables(
486 const _cgi_var_t
*v1
, /* I - First variable */
487 const _cgi_var_t
*v2
) /* I - Second variable */
489 return (strcasecmp(v1
->name
, v2
->name
));
494 * 'cgi_find_variable()' - Find a variable...
497 static _cgi_var_t
* /* O - Variable pointer or NULL */
498 cgi_find_variable(const char *name
) /* I - Name of variable */
500 _cgi_var_t key
; /* Search key */
503 if (form_count
< 1 || name
== NULL
)
508 return ((_cgi_var_t
*)bsearch(&key
, form_vars
, form_count
, sizeof(_cgi_var_t
),
509 (int (*)(const void *, const void *))cgi_compare_variables
));
514 * 'cgi_initialize_get()' - Initialize form variables using the GET method.
517 static int /* O - 1 if form data read */
518 cgi_initialize_get(void)
520 char *data
; /* Pointer to form data string */
523 DEBUG_puts("cgi_initialize_get: Initializing variables using GET method...");
526 * Check to see if there is anything for us to read...
529 data
= getenv("QUERY_STRING");
530 if (data
== NULL
|| strlen(data
) == 0)
534 * Parse it out and return...
537 return (cgi_initialize_string(data
));
542 * 'cgi_initialize_multipart()' - Initialize variables and file using the POST method.
544 * TODO: Update to support files > 2GB.
547 static int /* O - 1 if form data was read */
548 cgi_initialize_multipart(
549 const char *boundary
) /* I - Boundary string */
551 char line
[10240], /* MIME header line */
552 name
[1024], /* Form variable name */
553 filename
[1024], /* Form filename */
554 mimetype
[1024], /* MIME media type */
555 bstring
[256], /* Boundary string to look for */
556 *ptr
, /* Pointer into name/filename */
557 *end
; /* End of buffer */
558 int ch
, /* Character from file */
559 fd
, /* Temporary file descriptor */
560 blen
; /* Length of boundary string */
563 DEBUG_printf(("cgi_initialize_multipart(boundary=\"%s\")\n", boundary
));
566 * Read multipart form data until we run out...
573 snprintf(bstring
, sizeof(bstring
), "\r\n--%s", boundary
);
574 blen
= strlen(bstring
);
576 while (fgets(line
, sizeof(line
), stdin
))
578 if (!strcmp(line
, "\r\n"))
581 * End of headers, grab value...
587 * Read an embedded file...
593 * Remove previous file...
600 * Allocate memory for the new file...
603 if ((form_file
= calloc(1, sizeof(cgi_file_t
))) == NULL
)
606 form_file
->name
= strdup(name
);
607 form_file
->filename
= strdup(filename
);
608 form_file
->mimetype
= strdup(mimetype
);
610 fd
= cupsTempFd(form_file
->tempfile
, sizeof(form_file
->tempfile
));
615 atexit(cgi_unlink_file
);
618 * Copy file data to the temp file...
623 while ((ch
= getchar()) != EOF
)
627 if ((ptr
- line
) >= blen
&& !memcmp(ptr
- blen
, bstring
, blen
))
633 if ((ptr
- line
- blen
) >= 8192)
636 * Write out the first 8k of the buffer...
639 write(fd
, line
, 8192);
640 memmove(line
, line
+ 8192, ptr
- line
- 8192);
646 * Write the rest of the data and close the temp file...
650 write(fd
, line
, ptr
- line
);
657 * Just get a form variable; the current code only handles
658 * form values up to 10k in size...
662 end
= line
+ sizeof(line
) - 1;
664 while ((ch
= getchar()) != EOF
)
669 if ((ptr
- line
) >= blen
&& !memcmp(ptr
- blen
, bstring
, blen
))
679 * Set the form variable...
682 if ((ptr
= strrchr(name
, '-')) != NULL
&& isdigit(ptr
[1] & 255))
685 * Set a specific index in the array...
690 cgiSetArray(name
, atoi(ptr
) - 1, line
);
692 else if (cgiGetVariable(name
))
695 * Add another element in the array...
698 cgiSetArray(name
, cgiGetSize(name
), line
);
703 * Just set the line...
706 cgiSetVariable(name
, line
);
711 * Read the rest of the current line...
714 fgets(line
, sizeof(line
), stdin
);
717 * Clear the state vars...
724 else if (!strncasecmp(line
, "Content-Disposition:", 20))
726 if ((ptr
= strstr(line
+ 20, " name=\"")) != NULL
)
728 strlcpy(name
, ptr
+ 7, sizeof(name
));
730 if ((ptr
= strchr(name
, '\"')) != NULL
)
734 if ((ptr
= strstr(line
+ 20, " filename=\"")) != NULL
)
736 strlcpy(filename
, ptr
+ 11, sizeof(filename
));
738 if ((ptr
= strchr(filename
, '\"')) != NULL
)
742 else if (!strncasecmp(line
, "Content-Type:", 13))
744 for (ptr
= line
+ 13; isspace(*ptr
& 255); ptr
++);
746 strlcpy(mimetype
, ptr
, sizeof(mimetype
));
748 for (ptr
= mimetype
+ strlen(mimetype
) - 1;
749 ptr
> mimetype
&& isspace(*ptr
& 255);
755 * Return 1 for "form data found"...
763 * 'cgi_initialize_post()' - Initialize variables using the POST method.
766 static int /* O - 1 if form data was read */
767 cgi_initialize_post(void)
769 char *content_length
, /* Length of input data (string) */
770 *data
; /* Pointer to form data string */
771 int length
, /* Length of input data */
772 nbytes
, /* Number of bytes read this read() */
773 tbytes
, /* Total number of bytes read */
774 status
; /* Return status */
777 DEBUG_puts("cgi_initialize_post: Initializing variables using POST method...");
780 * Check to see if there is anything for us to read...
783 content_length
= getenv("CONTENT_LENGTH");
784 if (content_length
== NULL
|| atoi(content_length
) <= 0)
788 * Get the length of the input stream and allocate a buffer for it...
791 length
= atoi(content_length
);
792 data
= malloc(length
+ 1);
798 * Read the data into the buffer...
801 for (tbytes
= 0; tbytes
< length
; tbytes
+= nbytes
)
802 if ((nbytes
= read(0, data
+ tbytes
, length
- tbytes
)) < 0)
819 status
= cgi_initialize_string(data
);
822 * Free the data and return...
832 * 'cgi_initialize_string()' - Initialize form variables from a string.
835 static int /* O - 1 if form data was processed */
836 cgi_initialize_string(const char *data
) /* I - Form data string */
838 int done
; /* True if we're done reading a form variable */
839 char *s
, /* Pointer to current form string */
840 ch
, /* Temporary character */
841 name
[255], /* Name of form variable */
842 value
[65536]; /* Variable value... */
853 * Loop until we've read all the form data...
856 while (*data
!= '\0')
859 * Get the variable name...
862 for (s
= name
; *data
!= '\0'; data
++)
865 else if (*data
>= ' ' && s
< (name
+ sizeof(name
) - 1))
875 * Read the variable value...
878 for (s
= value
, done
= 0; !done
&& *data
!= '\0'; data
++)
881 case '&' : /* End of data... */
885 case '+' : /* Escaped space character */
886 if (s
< (value
+ sizeof(value
) - 1))
890 case '%' : /* Escaped control character */
892 * Read the hex code...
895 if (s
< (value
+ sizeof(value
) - 1))
913 default : /* Other characters come straight through */
914 if (*data
>= ' ' && s
< (value
+ sizeof(value
) - 1))
919 *s
= '\0'; /* nul terminate the string */
922 * Remove trailing whitespace...
928 while (s
>= value
&& isspace(*s
& 255))
932 * Add the string to the variable "database"...
935 if ((s
= strrchr(name
, '-')) != NULL
&& isdigit(s
[1] & 255))
939 cgiSetArray(name
, atoi(s
) - 1, value
);
941 else if (cgiGetVariable(name
) != NULL
)
942 cgiSetArray(name
, cgiGetSize(name
), value
);
944 cgiSetVariable(name
, value
);
952 * 'cgi_passwd()' - Catch authentication requests and notify the server.
954 * This function sends a Status header and exits, forcing authentication
958 static const char * /* O - NULL (no return) */
959 cgi_passwd(const char *prompt
) /* I - Prompt (not used) */
963 fprintf(stderr
, "DEBUG: cgi_passwd(prompt=\"%s\") called!\n",
964 prompt
? prompt
: "(null)");
967 * Send a 401 (unauthorized) status to the server, so it can notify
968 * the client that authentication is required.
971 puts("Status: 401\n");
975 * This code is never executed, but is present to satisfy the compiler.
983 * 'cgi_sort_variables()' - Sort all form variables for faster lookup.
987 cgi_sort_variables(void)
993 DEBUG_puts("cgi_sort_variables: Sorting variables...");
999 qsort(form_vars
, form_count
, sizeof(_cgi_var_t
),
1000 (int (*)(const void *, const void *))cgi_compare_variables
);
1003 DEBUG_puts("cgi_sort_variables: Sorted variable list is:");
1004 for (i
= 0; i
< form_count
; i
++)
1005 DEBUG_printf(("cgi_sort_variables: %d: %s (%d) = \"%s\" ...\n", i
,
1006 form_vars
[i
].name
, form_vars
[i
].nvalues
,
1007 form_vars
[i
].values
[0]));
1013 * 'cgi_unlink_file()' - Remove the uploaded form.
1017 cgi_unlink_file(void)
1022 * Remove the temporary file...
1025 unlink(form_file
->tempfile
);
1028 * Free memory used...
1031 free(form_file
->name
);
1032 free(form_file
->filename
);
1033 free(form_file
->mimetype
);
1042 * End of "$Id: var.c 7460 2008-04-16 02:19:54Z mike $".