1 const char cgi_rcs[] = "$Id: cgi.c,v 1.60 2002/04/08 20:50:25 swa Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
6 * Purpose : Declares functions to intercept request, generate
7 * html or gif answers, and to compose HTTP resonses.
8 * This only contains the framework functions, the
9 * actual handler functions are declared elsewhere.
11 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001 the SourceForge
15 * Privoxy team. http://www.privoxy.org/
17 * Based on the Internet Junkbuster originally written
18 * by and Copyright (C) 1997 Anonymous Coders and
19 * Junkbusters Corporation. http://www.junkbusters.com
21 * This program is free software; you can redistribute it
22 * and/or modify it under the terms of the GNU General
23 * Public License as published by the Free Software
24 * Foundation; either version 2 of the License, or (at
25 * your option) any later version.
27 * This program is distributed in the hope that it will
28 * be useful, but WITHOUT ANY WARRANTY; without even the
29 * implied warranty of MERCHANTABILITY or FITNESS FOR A
30 * PARTICULAR PURPOSE. See the GNU General Public
31 * License for more details.
33 * The GNU General Public License should be included with
34 * this file. If not, you can view it at
35 * http://www.gnu.org/copyleft/gpl.html
36 * or write to the Free Software Foundation, Inc., 59
37 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
41 * Revision 1.60 2002/04/08 20:50:25 swa
44 * Revision 1.59 2002/04/05 15:51:51 oes
45 * - added send-stylesheet CGI
46 * - bugfix: error-pages now get correct request protocol
48 * - kludged CGI descriptions and menu not to break JS syntax
50 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
51 * Fix Mac OSX compiler warnings
53 * Revision 1.57 2002/03/26 22:29:54 swa
54 * we have a new homepage!
56 * Revision 1.56 2002/03/24 17:50:46 jongfoster
57 * Fixing compile error if actions file editor disabled
59 * Revision 1.55 2002/03/24 16:55:06 oes
60 * Making GIF checkerboard transparent
62 * Revision 1.54 2002/03/24 16:18:15 jongfoster
65 * Revision 1.53 2002/03/24 16:06:00 oes
66 * Correct transparency for checkerboard PNG. Thanks, Magnus!
68 * Revision 1.52 2002/03/24 15:23:33 jongfoster
71 * Revision 1.51 2002/03/24 13:25:43 swa
72 * name change related issues
74 * Revision 1.50 2002/03/16 23:54:06 jongfoster
75 * Adding graceful termination feature, to help look for memory leaks.
76 * If you enable this (which, by design, has to be done by hand
77 * editing config.h) and then go to http://i.j.b/die, then the program
78 * will exit cleanly after the *next* request. It should free all the
79 * memory that was used.
81 * Revision 1.49 2002/03/13 00:27:04 jongfoster
84 * Revision 1.48 2002/03/08 17:47:07 jongfoster
87 * Revision 1.47 2002/03/08 16:41:33 oes
88 * Added GIF images again
90 * Revision 1.46 2002/03/07 03:48:38 oes
91 * - Changed built-in images from GIF to PNG
92 * (with regard to Unisys patent issue)
93 * - Added a 4x4 pattern PNG which is less intrusive
94 * than the logo but also clearly marks the deleted banners
96 * Revision 1.45 2002/03/06 22:54:35 jongfoster
97 * Automated function-comment nitpicking.
99 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
100 * - Better error reporting on OS/2
101 * - Fix double-slash comment (oops)
103 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
104 * - Re-enable OS/2 building after new parms were added
105 * - Fix false out of memory report when resolving CGI templates when no IP
106 * address is available of failed attempt (a la no such domain)
108 * Revision 1.42 2002/01/21 00:33:20 jongfoster
109 * Replacing strsav() with the safer string_append() or string_join().
110 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
111 * Adding missing html_encode() to error message generators.
112 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
114 * Revision 1.41 2002/01/17 20:56:22 jongfoster
115 * Replacing hard references to the URL of the config interface
116 * with #defines from project.h
118 * Revision 1.40 2002/01/09 14:26:46 oes
119 * Added support for thread-safe gmtime_r call.
121 * Revision 1.39 2001/11/16 00:48:13 jongfoster
122 * Fixing a compiler warning
124 * Revision 1.38 2001/11/13 00:31:21 jongfoster
125 * - Adding new CGIs for use by non-JavaScript browsers:
126 * edit-actions-url-form
127 * edit-actions-add-url-form
128 * edit-actions-remove-url-form
129 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
132 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
133 * Show enablement/disablement status in almost all templates.
134 * There is a little trickiness here: apparent recursive resolution of
135 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
136 * the actual enablement status. So a similar construct,
137 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
140 * Revision 1.36 2001/10/26 17:33:27 oes
143 * Revision 1.35 2001/10/23 21:48:19 jongfoster
144 * Cleaning up error handling in CGI functions - they now send back
145 * a HTML error page and should never cause a FATAL error. (Fixes one
146 * potential source of "denial of service" attacks).
148 * CGI actions file editor that works and is actually useful.
150 * Ability to toggle Junkbuster remotely using a CGI call.
152 * You can turn off both the above features in the main configuration
153 * file, e.g. if you are running a multi-user proxy.
155 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
156 * Only show "Local support" on templates conditionally:
157 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
158 * - if not, no Local support section appears
160 * Revision 1.33 2001/10/14 22:28:41 jongfoster
161 * Fixing stupid typo.
163 * Revision 1.32 2001/10/14 22:20:18 jongfoster
164 * - Changes to CGI dispatching method to match CGI names exactly,
165 * rather than doing a prefix match.
166 * - No longer need to count the length of the CGI handler names by hand.
167 * - Adding new handler for 404 error when disptching a CGI, if none of
168 * the handlers match.
169 * - Adding new handlers for CGI actionsfile editor.
171 * Revision 1.31 2001/10/10 10:56:39 oes
172 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
174 * Revision 1.30 2001/10/02 15:30:57 oes
175 * Introduced show-request cgi
177 * Revision 1.29 2001/09/20 15:47:44 steudten
179 * Fix BUG: Modify int size to size_t size in fill_template()
180 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
182 * Revision 1.28 2001/09/19 18:00:37 oes
183 * - Deletef time() FIXME (Can't fail under Linux either, if
184 * the argument is guaranteed to be in out address space,
187 * - Pointer notation cosmetics
188 * - Fixed a minor bug in template_fill(): Failiure of
189 * pcrs_execute() now secure.
191 * Revision 1.27 2001/09/16 17:08:54 jongfoster
192 * Moving simple CGI functions from cgi.c to new file cgisimple.c
194 * Revision 1.26 2001/09/16 15:47:37 jongfoster
195 * First version of CGI-based edit interface. This is very much a
196 * work-in-progress, and you can't actually use it to edit anything
197 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
198 * to have any effect.
200 * Revision 1.25 2001/09/16 15:02:35 jongfoster
201 * Adding i.j.b/robots.txt.
202 * Inlining add_stats() since it's only ever called from one place.
204 * Revision 1.24 2001/09/16 11:38:01 jongfoster
205 * Splitting fill_template() into 2 functions:
206 * template_load() loads the file
207 * template_fill() performs the PCRS regexps.
208 * This is because the CGI edit interface has a "table row"
209 * template which is used many times in the page - this
210 * change means it's only loaded from disk once.
212 * Revision 1.23 2001/09/16 11:16:05 jongfoster
213 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
215 * Revision 1.22 2001/09/16 11:00:10 jongfoster
216 * New function alloc_http_response, for symmetry with free_http_response
218 * Revision 1.21 2001/09/13 23:53:03 jongfoster
219 * Support for both static and dynamically generated CGI pages.
220 * Correctly setting Last-Modified: and Expires: HTTP headers.
222 * Revision 1.20 2001/09/13 23:40:36 jongfoster
223 * (Cosmetic only) Indentation correction
225 * Revision 1.19 2001/09/13 23:31:25 jongfoster
226 * Moving image data to cgi.c rather than cgi.h.
228 * Revision 1.18 2001/08/05 16:06:20 jongfoster
229 * Modifiying "struct map" so that there are now separate header and
230 * "map_entry" structures. This means that functions which modify a
231 * map no longer need to return a pointer to the modified map.
232 * Also, it no longer reverses the order of the entries (which may be
233 * important with some advanced template substitutions).
235 * Revision 1.17 2001/08/05 15:57:38 oes
236 * Adapted finish_http_response to new list_to_text
238 * Revision 1.16 2001/08/01 21:33:18 jongfoster
239 * Changes to fill_template() that reduce memory usage without having
240 * an impact on performance. I also renamed some variables so as not
241 * to clash with the C++ keywords "new" and "template".
243 * Revision 1.15 2001/08/01 21:19:22 jongfoster
244 * Moving file version information to a separate CGI page.
246 * Revision 1.14 2001/08/01 00:19:03 jongfoster
247 * New function: map_conditional() for an if-then-else syntax.
248 * Changing to use new version of show_defines()
250 * Revision 1.13 2001/07/30 22:08:36 jongfoster
251 * Tidying up #defines:
252 * - All feature #defines are now of the form FEATURE_xxx
253 * - Permanently turned off WIN_GUI_EDIT
254 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
256 * Revision 1.12 2001/07/29 18:47:05 jongfoster
257 * Adding missing #include "loadcfg.h"
259 * Revision 1.11 2001/07/18 17:24:37 oes
260 * Changed to conform to new pcrs interface
262 * Revision 1.10 2001/07/13 13:53:13 oes
263 * Removed all #ifdef PCRS and related code
265 * Revision 1.9 2001/06/29 21:45:41 oes
266 * Indentation, CRLF->LF, Tab-> Space
268 * Revision 1.8 2001/06/29 13:21:46 oes
269 * - Cosmetics: renamed and reordered functions, variables,
270 * texts, improved comments etc
272 * - Removed ij_untrusted_url() The relevant
273 * info is now part of the "untrusted" page,
274 * which is generated by filters.c:trust_url()
276 * - Generators of content now call finish_http_response()
277 * themselves, making jcc.c:chat() a little less
280 * - Removed obsolete "Pragma: no-cache" from our headers
282 * - http_responses now know their head length
284 * - fill_template now uses the new interface to pcrs, so that
285 * - long jobs (like whole files) no longer have to be assembled
286 * in a fixed size buffer
287 * - the new T (trivial) option is used, and the replacement may
288 * contain Perl syntax backrefs without confusing pcrs
290 * - Introduced default_exports() which generates a set of exports
291 * common to all CGIs and other content generators
293 * - Introduced convenience function map_block_killer()
295 * - Introduced convenience function make_menu()
297 * - Introduced CGI-like function error_response() which generates
298 * the "No such domain" and "Connect failed" messages using the
301 * - cgi_show_url_info:
302 * - adapted to new CGI features
303 * - form and answers now generated from same template
304 * - http:// prefix in URL now OK
307 * - adapted to new CGI features
308 * - no longer uses csp->init_proxy_args
311 * - moved menu generation to make_menu()
313 * - add_stats now writes single export map entries instead
316 * - Moved redirect_url() to filters.c
318 * - Fixed mem leak in free_http_response(), map_block_killer(),
320 * - Removed logentry from cancelled commit
322 * Revision 1.7 2001/06/09 10:51:58 jongfoster
323 * Changing "show URL info" handler to new style.
324 * Changing BUFSIZ ==> BUFFER_SIZE
326 * Revision 1.6 2001/06/07 23:05:19 jongfoster
327 * Removing code related to old forward and ACL files.
329 * Revision 1.5 2001/06/05 19:59:16 jongfoster
330 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
332 * Revision 1.4 2001/06/04 10:41:52 swa
333 * show version string of cgi.h and cgi.c
335 * Revision 1.3 2001/06/03 19:12:16 oes
336 * introduced new cgi handling
338 * No revisions before 1.3
340 **********************************************************************/
346 #include <sys/types.h>
353 #define snprintf _snprintf
354 #endif /* def _WIN32 */
362 #include "miscutil.h"
363 #include "cgisimple.h"
364 #ifdef FEATURE_CGI_EDIT_ACTIONS
366 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
368 /* loadcfg.h is for g_bToggleIJB only */
370 const char cgi_h_rcs[] = CGI_H_VERSION;
373 * List of CGI functions: name, handler, description
374 * Note: Do NOT use single quotes in the description;
375 * this will break the dynamic "blocked" template!
377 static const struct cgi_dispatcher cgi_dispatchers[] = {
380 "Privoxy main page" },
381 #ifdef FEATURE_GRACEFUL_TERMINATION
384 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
385 "this is a one click Denial Of Service attack!!!</em>" },
389 "Show information about the current configuration" },
392 "Show the source code version numbers" },
395 "Show the request headers." },
398 "Show which actions apply to a URL and why" },
399 #ifdef FEATURE_CGI_EDIT_ACTIONS
402 "Toggle Privoxy on or off" },
405 "Edit the actions list" },
408 { "eaa", /* Shortcut for edit-actions-add-url-form */
409 cgi_edit_actions_add_url_form,
411 { "eau", /* Shortcut for edit-actions-url-form */
412 cgi_edit_actions_url_form,
414 { "ear", /* Shortcut for edit-actions-remove-url-form */
415 cgi_edit_actions_remove_url_form,
417 { "eas", /* Shortcut for edit-actions-for-url */
418 cgi_edit_actions_for_url,
420 { "easa", /* Shortcut for edit-actions-section-add */
421 cgi_edit_actions_section_add,
423 { "easr", /* Shortcut for edit-actions-section-remove */
424 cgi_edit_actions_section_remove,
426 { "eass", /* Shortcut for edit-actions-section-swap */
427 cgi_edit_actions_section_swap,
429 { "edit-actions-for-url",
430 cgi_edit_actions_for_url,
431 NULL /* Edit the actions for (a) specified URL(s) */ },
432 { "edit-actions-list",
433 cgi_edit_actions_list,
434 NULL /* Edit the actions list */ },
435 { "edit-actions-submit",
436 cgi_edit_actions_submit,
437 NULL /* Change the actions for (a) specified URL(s) */ },
438 { "edit-actions-url",
439 cgi_edit_actions_url,
440 NULL /* Change a URL pattern in the actionsfile */ },
441 { "edit-actions-url-form",
442 cgi_edit_actions_url_form,
443 NULL /* Form to change a URL pattern in the actionsfile */ },
444 { "edit-actions-add-url",
445 cgi_edit_actions_add_url,
446 NULL /* Add a URL pattern to the actionsfile */ },
447 { "edit-actions-add-url-form",
448 cgi_edit_actions_add_url_form,
449 NULL /* Form to add a URL pattern to the actionsfile */ },
450 { "edit-actions-remove-url",
451 cgi_edit_actions_remove_url,
452 NULL /* Remove a URL pattern from the actionsfile */ },
453 { "edit-actions-remove-url-form",
454 cgi_edit_actions_remove_url_form,
455 NULL /* Form to remove a URL pattern from the actionsfile */ },
456 { "edit-actions-section-add",
457 cgi_edit_actions_section_add,
458 NULL /* Remove a section from the actionsfile */ },
459 { "edit-actions-section-remove",
460 cgi_edit_actions_section_remove,
461 NULL /* Remove a section from the actionsfile */ },
462 { "edit-actions-section-swap",
463 cgi_edit_actions_section_swap,
464 NULL /* Swap two sections in the actionsfile */ },
465 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
468 NULL /* Sends a robots.txt file to tell robots to go away. */ },
471 NULL /* Send a built-in image */ },
474 NULL /* Send templates/cgi-style.css */ },
476 cgi_transparent_image,
477 NULL /* Send a transparent image (short name) */ },
478 { NULL, /* NULL Indicates end of list and default page */
480 NULL /* Unknown CGI page */ }
485 * Bulit-in images for ad replacement
487 * Hint: You can encode your own images like this:
488 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
491 #ifdef FEATURE_NO_GIFS
494 * Checkerboard pattern, as a PNG.
496 const char image_pattern_data[] =
497 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
498 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
499 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
500 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
501 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
502 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
503 "\000\000\000\111\105\116\104\256\102\140\202";
506 * 1x1 transparant PNG.
508 const char image_blank_data[] =
509 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
510 "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236"
511 "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070"
512 "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022"
513 "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115"
514 "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101"
515 "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006"
516 "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110"
517 "\000\000\000\000\111\105\116\104\256\102\140\202";
521 * Checkerboard pattern, as a GIF.
523 const char image_pattern_data[] =
524 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
525 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
526 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
527 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
531 * 1x1 transparant GIF.
533 const char image_blank_data[] =
534 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
535 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
536 "\000\001\000\000\002\002D\001\000;";
539 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
540 const size_t image_blank_length = sizeof(image_blank_data) - 1;
543 static struct http_response cgi_error_memory_response[1];
545 static struct http_response *dispatch_known_cgi(struct client_state * csp,
547 static struct map *parse_cgi_parameters(char *argstring);
550 /*********************************************************************
552 * Function : dispatch_cgi
554 * Description : Checks if a request URL has either the magical
555 * hostname CGI_SITE_1_HOST (usully http://i.j.b/) or
556 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
557 * http://ijbswa.sourceforge.net/config). If so, it passes
558 * the (rest of the) path onto dispatch_known_cgi, which
559 * calls the relevant CGI handler function.
562 * 1 : csp = Current client state (buffers, headers, etc...)
564 * Returns : http_response if match, NULL if nonmatch or handler fail
566 *********************************************************************/
567 struct http_response *dispatch_cgi(struct client_state *csp)
569 const char *host = csp->http->host;
570 const char *path = csp->http->path;
573 * Should we intercept ?
576 /* Note: "example.com" and "example.com." are equivalent hostnames. */
578 /* Either the host matches CGI_SITE_1_HOST ..*/
579 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
580 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
581 && (path[0] == '/') )
583 /* ..then the path will all be for us. Remove leading '/' */
586 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
587 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
588 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
589 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
591 /* take everything following CGI_SITE_2_PATH */
592 path += strlen(CGI_SITE_2_PATH);
595 /* skip the forward slash after CGI_SITE_2_PATH */
598 else if (*path != '\0')
601 * wierdness: URL is /configXXX, where XXX is some string
602 * Do *NOT* intercept.
614 * This is a CGI call.
617 return dispatch_known_cgi(csp, path);
621 /*********************************************************************
623 * Function : dispatch_known_cgi
625 * Description : Processes a CGI once dispatch_cgi has determined that
626 * it matches one of the magic prefixes. Parses the path
627 * as a cgi name plus query string, prepares a map that
628 * maps CGI parameter names to their values, initializes
629 * the http_response struct, and calls the relevant CGI
633 * 1 : csp = Current client state (buffers, headers, etc...)
634 * 2 : path = Path of CGI, with the CGI prefix removed.
635 * Should not have a leading "/".
637 * Returns : http_response, or NULL on handler failure or out of
640 *********************************************************************/
641 static struct http_response *dispatch_known_cgi(struct client_state * csp,
644 const struct cgi_dispatcher *d;
645 struct map *param_list;
646 struct http_response *rsp;
647 char *query_args_start;
651 if (NULL == (path_copy = strdup(path)))
653 return cgi_error_memory();
656 query_args_start = path_copy;
657 while (*query_args_start && *query_args_start != '?')
661 if (*query_args_start == '?')
663 *query_args_start++ = '\0';
666 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
669 return cgi_error_memory();
675 * path_copy = CGI call name
676 * param_list = CGI params, as map
679 /* Get mem for response or fail*/
680 if (NULL == (rsp = alloc_http_response()))
683 free_map(param_list);
684 return cgi_error_memory();
687 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
688 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
689 csp->ip_addr_str, csp->http->cmd);
691 /* Find and start the right CGI function*/
695 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
697 err = (d->handler)(csp, rsp, param_list);
699 free_map(param_list);
700 if (err == JB_ERR_CGI_PARAMS)
702 err = cgi_error_bad_param(csp, rsp);
707 return finish_http_response(rsp);
711 /* Error in handler, probably out-of-memory */
712 free_http_response(rsp);
713 return cgi_error_memory();
721 /*********************************************************************
723 * Function : parse_cgi_parameters
725 * Description : Parse a URL-encoded argument string into name/value
726 * pairs and store them in a struct map list.
729 * 1 : string = string to be parsed. Will be trashed.
731 * Returns : pointer to param list, or NULL if out of memory.
733 *********************************************************************/
734 static struct map *parse_cgi_parameters(char *argstring)
737 char *vector[BUFFER_SIZE];
739 struct map *cgi_params;
741 if (NULL == (cgi_params = new_map()))
746 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
748 for (i = 0; i < pairs; i++)
750 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
753 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
755 free_map(cgi_params);
766 /*********************************************************************
768 * Function : error_response
770 * Description : returns an http_response that explains the reason
771 * why a request failed.
774 * 1 : csp = Current client state (buffers, headers, etc...)
775 * 2 : templatename = Which template should be used for the answer
776 * 3 : sys_err = system error number
778 * Returns : A http_response. If we run out of memory, this
779 * will be cgi_error_memory().
781 *********************************************************************/
782 struct http_response *error_response(struct client_state *csp,
783 const char *templatename,
787 struct http_response *rsp;
788 struct map * exports = default_exports(csp, NULL);
791 return cgi_error_memory();
794 if (NULL == (rsp = alloc_http_response()))
797 return cgi_error_memory();
800 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
801 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
802 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
803 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
804 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
807 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
810 /* Some failures, like "404 no such domain", don't have an IP address. */
811 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
819 free_http_response(rsp);
820 return cgi_error_memory();
823 if (!strcmp(templatename, "no-such-domain"))
825 rsp->status = strdup("404 No such domain");
826 if (rsp->status == NULL)
829 free_http_response(rsp);
830 return cgi_error_memory();
833 else if (!strcmp(templatename, "connect-failed"))
835 rsp->status = strdup("503 Connect failed");
836 if (rsp->status == NULL)
839 free_http_response(rsp);
840 return cgi_error_memory();
844 err = template_fill_for_cgi(csp, templatename, exports, rsp);
847 free_http_response(rsp);
848 return cgi_error_memory();
851 return finish_http_response(rsp);
855 /*********************************************************************
857 * Function : cgi_init_error_messages
859 * Description : Call at the start of the program to initialize
860 * the error message used by cgi_error_memory().
866 *********************************************************************/
867 void cgi_init_error_messages(void)
869 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
870 cgi_error_memory_response->head =
871 "HTTP/1.0 500 Internal Privoxy Error\r\n"
872 "Content-Type: text/html\r\n"
874 cgi_error_memory_response->body =
876 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
878 "<h1>500 Internal Privoxy Error</h1>\r\n"
879 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
880 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
884 cgi_error_memory_response->head_length =
885 strlen(cgi_error_memory_response->head);
886 cgi_error_memory_response->content_length =
887 strlen(cgi_error_memory_response->body);
891 /*********************************************************************
893 * Function : cgi_error_memory
895 * Description : Called if a CGI function runs out of memory.
896 * Returns a statically-allocated error response.
899 * 1 : csp = Current client state (buffers, headers, etc...)
900 * 2 : rsp = http_response data structure for output
901 * 3 : template_name = Name of template that could not
904 * Returns : JB_ERR_OK on success
905 * JB_ERR_MEMORY on out-of-memory error.
907 *********************************************************************/
908 struct http_response *cgi_error_memory(void)
910 /* assert that it's been initialized. */
911 assert(cgi_error_memory_response->head);
913 return cgi_error_memory_response;
917 /*********************************************************************
919 * Function : cgi_error_no_template
921 * Description : Almost-CGI function that is called if a templae
922 * cannot be loaded. Note this is not a true CGI,
923 * it takes a template name rather than a map of
927 * 1 : csp = Current client state (buffers, headers, etc...)
928 * 2 : rsp = http_response data structure for output
929 * 3 : template_name = Name of template that could not
932 * Returns : JB_ERR_OK on success
933 * JB_ERR_MEMORY on out-of-memory error.
935 *********************************************************************/
936 jb_err cgi_error_no_template(struct client_state *csp,
937 struct http_response *rsp,
938 const char *template_name)
940 static const char status[] =
941 "500 Internal Privoxy Error";
942 static const char body_prefix[] =
944 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
946 "<h1>500 Internal Privoxy Error</h1>\r\n"
947 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
948 "<p><b>Could not load template file <code>";
949 static const char body_suffix[] =
950 "</code> or one of it's included components.</b></p>\r\n"
951 "<p>Please contact your proxy administrator.</p>\r\n"
952 "<p>If you are the proxy administrator, please put the required file(s)"
953 "in the <code><i>(confdir)</i>/templates</code> directory. The "
954 "location of the <code><i>(confdir)</i></code> directory "
955 "is specified in the main Privoxy <code>config</code> "
956 "file. (It's typically the Privoxy install directory"
958 ", or <code>/etc/privoxy/</code>"
959 #endif /* ndef _WIN32 */
966 assert(template_name);
968 /* Reset rsp, if needed */
972 rsp->content_length = 0;
973 rsp->head_length = 0;
976 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
977 if (rsp->body == NULL)
979 return JB_ERR_MEMORY;
981 strcpy(rsp->body, body_prefix);
982 strcat(rsp->body, template_name);
983 strcat(rsp->body, body_suffix);
985 rsp->status = strdup(status);
986 if (rsp->body == NULL)
988 return JB_ERR_MEMORY;
995 /*********************************************************************
997 * Function : cgi_error_bad_param
999 * Description : CGI function that is called if the parameters
1000 * (query string) for a CGI were wrong.
1003 * 1 : csp = Current client state (buffers, headers, etc...)
1004 * 2 : rsp = http_response data structure for output
1006 * CGI Parameters : none
1008 * Returns : JB_ERR_OK on success
1009 * JB_ERR_MEMORY on out-of-memory error.
1011 *********************************************************************/
1012 jb_err cgi_error_bad_param(struct client_state *csp,
1013 struct http_response *rsp)
1015 struct map *exports;
1020 if (NULL == (exports = default_exports(csp, NULL)))
1022 return JB_ERR_MEMORY;
1025 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1029 /*********************************************************************
1031 * Function : get_http_time
1033 * Description : Get the time in a format suitable for use in a
1034 * HTTP header - e.g.:
1035 * "Sun, 06 Nov 1994 08:49:37 GMT"
1038 * 1 : time_offset = Time returned will be current time
1039 * plus this number of seconds.
1040 * 2 : buf = Destination for result. Must be long enough
1041 * to hold 29 characters plus a trailing zero.
1045 *********************************************************************/
1046 void get_http_time(int time_offset, char *buf)
1048 static const char day_names[7][4] =
1049 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1050 static const char month_names[12][4] =
1051 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1052 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1055 time_t current_time;
1059 time(¤t_time); /* get current time */
1061 current_time += time_offset;
1063 /* get and save the gmt */
1065 #ifdef HAVE_GMTIME_R
1067 t = gmtime_r(¤t_time, &dummy);
1069 t = gmtime(¤t_time);
1073 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1075 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1076 day_names[t->tm_wday],
1078 month_names[t->tm_mon],
1088 /*********************************************************************
1090 * Function : finish_http_response
1092 * Description : Fill in the missing headers in an http response,
1093 * and flatten the headers to an http head.
1096 * 1 : rsp = pointer to http_response to be processed
1098 * Returns : A http_response, usually the rsp parameter.
1099 * On error, free()s rsp and returns cgi_error_memory()
1101 *********************************************************************/
1102 struct http_response *finish_http_response(struct http_response *rsp)
1104 char buf[BUFFER_SIZE];
1107 /* Special case - do NOT change this statically allocated response,
1108 * which is ready for output anyway.
1110 if (rsp == cgi_error_memory_response)
1116 * Fill in the HTTP Status
1118 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1119 err = enlist_first(rsp->headers, buf);
1122 * Set the Content-Length
1124 if (rsp->content_length == 0)
1126 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1130 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1131 err = enlist(rsp->headers, buf);
1135 * Fill in the default headers:
1137 * Content-Type: default to text/html if not already specified.
1138 * Date: set to current date/time.
1139 * Last-Modified: set to date/time the page was last changed.
1140 * Expires: set to date/time page next needs reloading.
1141 * Cache-Control: set to "no-cache" if applicable.
1143 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1145 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1150 * Set Expires to about 10 min into the future so it'll get reloaded
1151 * occasionally, e.g. if Privoxy gets upgraded.
1156 get_http_time(0, buf);
1157 err = enlist_unique_header(rsp->headers, "Date", buf);
1160 /* Some date in the past. */
1161 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1165 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1166 err = enlist_unique_header(rsp->headers, "Expires", buf);
1172 * Compliant browsers should not cache this due to the "Cache-Control"
1173 * setting. However, to be certain, we also set both "Last-Modified"
1174 * and "Expires" to the current time.
1176 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1178 get_http_time(0, buf);
1179 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1180 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1181 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1188 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1190 free_http_response(rsp);
1191 return cgi_error_memory();
1193 rsp->head_length = strlen(rsp->head);
1200 /*********************************************************************
1202 * Function : alloc_http_response
1204 * Description : Allocates a new http_response structure.
1208 * Returns : pointer to a new http_response, or NULL.
1210 *********************************************************************/
1211 struct http_response *alloc_http_response(void)
1213 return (struct http_response *) zalloc(sizeof(struct http_response));
1218 /*********************************************************************
1220 * Function : free_http_response
1222 * Description : Free the memory occupied by an http_response
1223 * and its depandant structures.
1226 * 1 : rsp = pointer to http_response to be freed
1230 *********************************************************************/
1231 void free_http_response(struct http_response *rsp)
1234 * Must special case cgi_error_memory_response, which is never freed.
1236 if (rsp && (rsp != cgi_error_memory_response))
1241 destroy_list(rsp->headers);
1248 /*********************************************************************
1250 * Function : template_load
1252 * Description : CGI support function that loads a given HTML
1253 * template from the confdir, ignoring comment
1254 * lines and following #include statements up to
1258 * 1 : csp = Current client state (buffers, headers, etc...)
1259 * 2 : template_ptr = Destination for pointer to loaded
1261 * 3 : template = name of the HTML template to be used
1262 * 4 : recursive = Flag set if this function calls itself
1263 * following an #include statament
1265 * Returns : JB_ERR_OK on success
1266 * JB_ERR_MEMORY on out-of-memory error.
1267 * JB_ERR_FILE if the template file cannot be read
1269 *********************************************************************/
1270 jb_err template_load(struct client_state *csp, char **template_ptr,
1271 const char *templatename, int recursive)
1274 char *templates_dir_path;
1277 char *included_module;
1279 char buf[BUFFER_SIZE];
1282 assert(template_ptr);
1283 assert(templatename);
1285 *template_ptr = NULL;
1288 * Open template file or fail
1291 templates_dir_path = make_path(csp->config->confdir, "templates");
1292 if (templates_dir_path == NULL)
1294 return JB_ERR_MEMORY;
1297 full_path = make_path(templates_dir_path, templatename);
1298 free(templates_dir_path);
1299 if (full_path == NULL)
1301 return JB_ERR_MEMORY;
1304 file_buffer = strdup("");
1305 if (file_buffer == NULL)
1308 return JB_ERR_MEMORY;
1311 if (NULL == (fp = fopen(full_path, "r")))
1313 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1321 * Read the file, ignoring comments, and honring #include
1322 * statements, unless we're already called recursively.
1324 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1325 * This is unlikely in practise.
1327 while (fgets(buf, BUFFER_SIZE, fp))
1329 if (!recursive && !strncmp(buf, "#include ", 9))
1331 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1337 if (string_append(&file_buffer, included_module))
1340 free(included_module);
1341 return JB_ERR_MEMORY;
1344 free(included_module);
1348 /* skip lines starting with '#' */
1354 if (string_append(&file_buffer, buf))
1357 return JB_ERR_MEMORY;
1362 *template_ptr = file_buffer;
1368 /*********************************************************************
1370 * Function : template_fill
1372 * Description : CGI support function that fills in a pre-loaded
1373 * HTML template by replacing @name@ with value using
1374 * pcrs, for each item in the output map.
1376 * Note that a leading '$' charachter in the export map's
1377 * values will be stripped and toggle on backreference
1381 * 1 : template_ptr = IN: Template to be filled out.
1383 * OUT: Filled out template.
1384 * Caller must free().
1385 * 2 : exports = map with fill in symbol -> name pairs
1387 * Returns : JB_ERR_OK on success
1388 * JB_ERR_MEMORY on out-of-memory error
1390 *********************************************************************/
1391 jb_err template_fill(char **template_ptr, const struct map *exports)
1393 struct map_entry *m;
1395 char buf[BUFFER_SIZE];
1396 char *tmp_out_buffer;
1402 assert(template_ptr);
1403 assert(*template_ptr);
1406 file_buffer = *template_ptr;
1407 size = strlen(file_buffer) + 1;
1410 * Assemble pcrs joblist from exports map
1412 for (m = exports->first; m != NULL; m = m->next)
1414 if (*m->name == '$')
1417 * First character of name is '$', so remove this flag
1418 * character and allow backreferences ($1 etc) in the
1419 * "replace with" text.
1421 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1427 * Treat the "replace with" text as a literal string -
1428 * no quoting needed, no backreferences allowed.
1429 * ("Trivial" ['T'] flag).
1433 /* Enclose name in @@ */
1434 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1438 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
1440 /* Make and run job. */
1441 job = pcrs_compile(buf, m->value, flags, &error);
1444 if (error == PCRS_ERR_NOMEM)
1447 *template_ptr = NULL;
1448 return JB_ERR_MEMORY;
1452 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
1453 /* Hope it wasn't important and silently ignore the invalid job */
1458 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
1461 if (NULL == tmp_out_buffer)
1463 *template_ptr = NULL;
1464 return JB_ERR_MEMORY;
1466 file_buffer = tmp_out_buffer;
1473 *template_ptr = file_buffer;
1478 /*********************************************************************
1480 * Function : template_fill_for_cgi
1482 * Description : CGI support function that loads a HTML template
1483 * and fills it in. Handles file-not-found errors
1484 * by sending a HTML error message. For convenience,
1485 * this function also frees the passed "exports" map.
1488 * 1 : csp = Client state
1489 * 2 : templatename = name of the HTML template to be used
1490 * 3 : exports = map with fill in symbol -> name pairs.
1491 * Will be freed by this function.
1493 * Returns : JB_ERR_OK on success
1494 * JB_ERR_MEMORY on out-of-memory error
1496 *********************************************************************/
1497 jb_err template_fill_for_cgi(struct client_state *csp,
1498 const char *templatename,
1499 struct map *exports,
1500 struct http_response *rsp)
1505 assert(templatename);
1509 err = template_load(csp, &rsp->body, templatename, 0);
1510 if (err == JB_ERR_FILE)
1513 return cgi_error_no_template(csp, rsp, templatename);
1518 return err; /* JB_ERR_MEMORY */
1520 err = template_fill(&rsp->body, exports);
1526 /*********************************************************************
1528 * Function : default_exports
1530 * Description : returns a struct map list that contains exports
1531 * which are common to all CGI functions.
1534 * 1 : csp = Current client state (buffers, headers, etc...)
1535 * 2 : caller = name of CGI who calls us and which should
1536 * be excluded from the generated menu. May be
1538 * Returns : NULL if no memory, else a new map. Caller frees.
1540 *********************************************************************/
1541 struct map *default_exports(const struct client_state *csp, const char *caller)
1545 struct map * exports;
1546 int local_help_exists = 0;
1550 exports = new_map();
1551 if (exports == NULL)
1556 err = map(exports, "version", 1, html_encode(VERSION), 0);
1557 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
1558 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
1559 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
1560 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
1561 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
1562 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
1563 if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB);
1565 snprintf(buf, 20, "%d", csp->config->hport);
1566 if (!err) err = map(exports, "my-port", 1, buf, 1);
1568 if(!strcmp(CODE_STATUS, "stable"))
1570 if (!err) err = map_block_killer(exports, "unstable");
1573 if (csp->config->admin_address != NULL)
1575 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
1576 local_help_exists = 1;
1580 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
1583 if (csp->config->proxy_info_url != NULL)
1585 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
1586 local_help_exists = 1;
1590 if (!err) err = map_block_killer(exports, "have-proxy-info");
1593 if (local_help_exists == 0)
1595 if (!err) err = map_block_killer(exports, "have-help-info");
1608 /*********************************************************************
1610 * Function : map_block_killer
1612 * Description : Convenience function.
1613 * Adds a "killer" for the conditional HTML-template
1614 * block <name>, i.e. a substitution of the regex
1615 * "if-<name>-start.*if-<name>-end" to the given
1619 * 1 : exports = map to extend
1620 * 2 : name = name of conditional block
1622 * Returns : JB_ERR_OK on success
1623 * JB_ERR_MEMORY on out-of-memory error.
1625 *********************************************************************/
1626 jb_err map_block_killer(struct map *exports, const char *name)
1628 char buf[1000]; /* Will do, since the names are hardwired */
1632 assert(strlen(name) < 490);
1634 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
1635 return map(exports, buf, 1, "", 1);
1639 /*********************************************************************
1641 * Function : map_block_keep
1643 * Description : Convenience function. Removes the markers used
1644 * by map-block-killer, to save a few bytes.
1645 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
1648 * 1 : exports = map to extend
1649 * 2 : name = name of conditional block
1651 * Returns : JB_ERR_OK on success
1652 * JB_ERR_MEMORY on out-of-memory error.
1654 *********************************************************************/
1655 jb_err map_block_keep(struct map *exports, const char *name)
1658 char buf[500]; /* Will do, since the names are hardwired */
1662 assert(strlen(name) < 490);
1664 snprintf(buf, 500, "if-%s-start", name);
1665 err = map(exports, buf, 1, "", 1);
1672 snprintf(buf, 500, "if-%s-end", name);
1673 return map(exports, buf, 1, "", 1);
1677 /*********************************************************************
1679 * Function : map_conditional
1681 * Description : Convenience function.
1682 * Adds an "if-then-else" for the conditional HTML-template
1683 * block <name>, i.e. a substitution of the form:
1690 * The control structure and one of the alternatives
1694 * 1 : exports = map to extend
1695 * 2 : name = name of conditional block
1696 * 3 : choose_first = nonzero for first, zero for second.
1698 * Returns : JB_ERR_OK on success
1699 * JB_ERR_MEMORY on out-of-memory error.
1701 *********************************************************************/
1702 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
1704 char buf[1000]; /* Will do, since the names are hardwired */
1709 assert(strlen(name) < 480);
1711 snprintf(buf, 1000, (choose_first
1712 ? "else-not-%s@.*@endif-%s"
1713 : "if-%s-then@.*@else-not-%s"),
1716 err = map(exports, buf, 1, "", 1);
1722 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
1723 return map(exports, buf, 1, "", 1);
1727 /*********************************************************************
1729 * Function : make_menu
1731 * Description : Returns an HTML-formatted menu of the available
1732 * unhidden CGIs, excluding the one given in <self>.
1734 * Parameters : self = name of CGI to leave out, can be NULL
1736 * Returns : menu string, or NULL on out-of-memory error.
1738 *********************************************************************/
1739 char *make_menu(const char *self)
1741 const struct cgi_dispatcher *d;
1742 char *result = strdup("");
1746 self = "NO-SUCH-CGI!";
1749 /* List available unhidden CGI's and export as "other-cgis" */
1750 for (d = cgi_dispatchers; d->name; d++)
1752 if (d->description && strcmp(d->name, self))
1754 string_append(&result, "<li><a href=\"" CGI_PREFIX);
1755 string_append(&result, d->name);
1756 string_append(&result, "\">");
1757 string_append(&result, d->description);
1758 string_append(&result, "</a></li>");
1766 /*********************************************************************
1768 * Function : dump_map
1770 * Description : HTML-dump a map for debugging
1773 * 1 : the_map = map to dump
1775 * Returns : string with HTML
1777 *********************************************************************/
1778 char *dump_map(const struct map *the_map)
1780 struct map_entry *cur_entry;
1781 char *ret = strdup("");
1783 string_append(&ret, "<table>\n");
1785 for (cur_entry = the_map->first;
1786 (cur_entry != NULL) && (ret != NULL);
1787 cur_entry = cur_entry->next)
1789 string_append(&ret, "<tr><td><b>");
1790 string_join (&ret, html_encode(cur_entry->name));
1791 string_append(&ret, "</b></td><td>");
1792 string_join (&ret, html_encode(cur_entry->value));
1793 string_append(&ret, "</td></tr>\n");
1796 string_append(&ret, "</table>\n");