1 const char cgi_rcs[] = "$Id: cgi.c,v 1.72 2006/07/18 14:48:45 david__schmidt 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.72 2006/07/18 14:48:45 david__schmidt
42 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
43 * with what was really the latest development (the v_3_0_branch branch)
45 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
46 * Moved cgi_error_disabled() from cgiedit.c to
47 * cgi.c to re-enable build with --disable-editor.
48 * Fixes Bug #892744. Thanks to Matthew Fischer
51 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
52 * - Added new function cgi_redirect to handle creation of
53 * HTTP redirect messages formerly repeated in the code.
54 * - Send cgi_error_disabled instead of cgi_error_404 when
55 * referrer check fails
56 * - Dynamic content now gets Expires header field with date
59 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
60 * Bugfix: Transparent PNG was not transparent. Thanks to
61 * Dan Razzell of Starfish Systems for notice and new PNG.
63 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
64 * Security fix: dspatch_known_cgi no longer considers an empty
65 * referrer safe for critical CGIs, since malicious links could
66 * reside on https:// locations which browsers don't advertize as
67 * referrers. Closes bug #749916, thanks to Jeff Epler for the
68 * hint. Goodbye One-Click[tm] toggling :-(
70 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
73 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
74 * Killed a compiler warning on OSX
76 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
77 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
79 * - Show toggle info only if we have it
81 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
82 * Move declaration of struct tm dummy outside of a control block so it is
83 * accessible later on during snprintf in get_http_time.
85 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
86 * Cosmetic: Renamed cryptic variable
88 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
89 * Wrapping all *_r functions (the non-_r versions of them) with mutex semaphores for OSX. Hopefully this will take care of all of those pesky crash reports.
91 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
92 * Disable access to critical CGIs via untrusted referrers.
93 * This prevents users from being tricked by malicious websites
94 * into making unintentional configuration changes:
96 * - Added flag to each cgi_dispatcher that allows or denies
98 * - Introduced proviorical function that greps for the
99 * referrer header before regular header parsing happens
100 * - Added safety check to dispatch_known_cgi. CGI is called
101 * if (cgi harmless || no referrer || we are referrer).
102 * Else a) toggle calls are modified not to change status and
103 * b) all other calls are denied.
105 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
106 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
108 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
109 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
111 * Revision 1.70 2002/05/19 11:33:20 jongfoster
112 * If a CGI error was not handled, and propogated back to
113 * dispatch_known_cgi(), then it was assumed to be "out of memory".
114 * This gave a very misleading error message.
116 * Now other errors will cause a simple message giving the error
117 * number and asking the user to report a bug.
120 * http://sourceforge.net/tracker/index.php?func=detail
121 * &aid=557905&group_id=11118&atid=111118
123 * Revision 1.69 2002/05/14 21:28:40 oes
124 * - Fixed add_help_link to link to the (now split) actions
125 * part of the config chapter
126 * - Renamed helplink export to actions-help-prefix
128 * Revision 1.68 2002/05/12 21:36:29 jongfoster
129 * Correcting function comments
131 * Revision 1.67 2002/04/30 12:02:07 oes
132 * Nit: updated a comment
134 * Revision 1.66 2002/04/26 18:32:57 jongfoster
135 * Fixing a memory leak on error
137 * Revision 1.65 2002/04/26 12:53:51 oes
138 * - New function add_help_link
139 * - default_exports now exports links to the user manual
140 * and a prefix for links into the config chapter
142 * Revision 1.64 2002/04/24 02:17:21 oes
143 * - Better descriptions for CGIs
144 * - Hide edit-actions, more shortcuts
145 * - Moved get_char_param, get_string_param and get_number_param here
148 * Revision 1.63 2002/04/15 19:06:43 jongfoster
151 * Revision 1.62 2002/04/10 19:59:46 jongfoster
152 * Fixes to #include in templates:
153 * - Didn't close main file if loading an included template fails.
154 * - I'm paranoid and want to disallow "#include /etc/passwd".
156 * Revision 1.61 2002/04/10 13:37:48 oes
157 * Made templates modular: template_load now recursive with max depth 1
159 * Revision 1.60 2002/04/08 20:50:25 swa
162 * Revision 1.59 2002/04/05 15:51:51 oes
163 * - added send-stylesheet CGI
164 * - bugfix: error-pages now get correct request protocol
166 * - kludged CGI descriptions and menu not to break JS syntax
168 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
169 * Fix Mac OSX compiler warnings
171 * Revision 1.57 2002/03/26 22:29:54 swa
172 * we have a new homepage!
174 * Revision 1.56 2002/03/24 17:50:46 jongfoster
175 * Fixing compile error if actions file editor disabled
177 * Revision 1.55 2002/03/24 16:55:06 oes
178 * Making GIF checkerboard transparent
180 * Revision 1.54 2002/03/24 16:18:15 jongfoster
183 * Revision 1.53 2002/03/24 16:06:00 oes
184 * Correct transparency for checkerboard PNG. Thanks, Magnus!
186 * Revision 1.52 2002/03/24 15:23:33 jongfoster
189 * Revision 1.51 2002/03/24 13:25:43 swa
190 * name change related issues
192 * Revision 1.50 2002/03/16 23:54:06 jongfoster
193 * Adding graceful termination feature, to help look for memory leaks.
194 * If you enable this (which, by design, has to be done by hand
195 * editing config.h) and then go to http://i.j.b/die, then the program
196 * will exit cleanly after the *next* request. It should free all the
197 * memory that was used.
199 * Revision 1.49 2002/03/13 00:27:04 jongfoster
202 * Revision 1.48 2002/03/08 17:47:07 jongfoster
205 * Revision 1.47 2002/03/08 16:41:33 oes
206 * Added GIF images again
208 * Revision 1.46 2002/03/07 03:48:38 oes
209 * - Changed built-in images from GIF to PNG
210 * (with regard to Unisys patent issue)
211 * - Added a 4x4 pattern PNG which is less intrusive
212 * than the logo but also clearly marks the deleted banners
214 * Revision 1.45 2002/03/06 22:54:35 jongfoster
215 * Automated function-comment nitpicking.
217 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
218 * - Better error reporting on OS/2
219 * - Fix double-slash comment (oops)
221 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
222 * - Re-enable OS/2 building after new parms were added
223 * - Fix false out of memory report when resolving CGI templates when no IP
224 * address is available of failed attempt (a la no such domain)
226 * Revision 1.42 2002/01/21 00:33:20 jongfoster
227 * Replacing strsav() with the safer string_append() or string_join().
228 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
229 * Adding missing html_encode() to error message generators.
230 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
232 * Revision 1.41 2002/01/17 20:56:22 jongfoster
233 * Replacing hard references to the URL of the config interface
234 * with #defines from project.h
236 * Revision 1.40 2002/01/09 14:26:46 oes
237 * Added support for thread-safe gmtime_r call.
239 * Revision 1.39 2001/11/16 00:48:13 jongfoster
240 * Fixing a compiler warning
242 * Revision 1.38 2001/11/13 00:31:21 jongfoster
243 * - Adding new CGIs for use by non-JavaScript browsers:
244 * edit-actions-url-form
245 * edit-actions-add-url-form
246 * edit-actions-remove-url-form
247 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
250 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
251 * Show enablement/disablement status in almost all templates.
252 * There is a little trickiness here: apparent recursive resolution of
253 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
254 * the actual enablement status. So a similar construct,
255 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
258 * Revision 1.36 2001/10/26 17:33:27 oes
261 * Revision 1.35 2001/10/23 21:48:19 jongfoster
262 * Cleaning up error handling in CGI functions - they now send back
263 * a HTML error page and should never cause a FATAL error. (Fixes one
264 * potential source of "denial of service" attacks).
266 * CGI actions file editor that works and is actually useful.
268 * Ability to toggle Junkbuster remotely using a CGI call.
270 * You can turn off both the above features in the main configuration
271 * file, e.g. if you are running a multi-user proxy.
273 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
274 * Only show "Local support" on templates conditionally:
275 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
276 * - if not, no Local support section appears
278 * Revision 1.33 2001/10/14 22:28:41 jongfoster
279 * Fixing stupid typo.
281 * Revision 1.32 2001/10/14 22:20:18 jongfoster
282 * - Changes to CGI dispatching method to match CGI names exactly,
283 * rather than doing a prefix match.
284 * - No longer need to count the length of the CGI handler names by hand.
285 * - Adding new handler for 404 error when disptching a CGI, if none of
286 * the handlers match.
287 * - Adding new handlers for CGI actionsfile editor.
289 * Revision 1.31 2001/10/10 10:56:39 oes
290 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
292 * Revision 1.30 2001/10/02 15:30:57 oes
293 * Introduced show-request cgi
295 * Revision 1.29 2001/09/20 15:47:44 steudten
297 * Fix BUG: Modify int size to size_t size in fill_template()
298 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
300 * Revision 1.28 2001/09/19 18:00:37 oes
301 * - Deletef time() FIXME (Can't fail under Linux either, if
302 * the argument is guaranteed to be in out address space,
305 * - Pointer notation cosmetics
306 * - Fixed a minor bug in template_fill(): Failiure of
307 * pcrs_execute() now secure.
309 * Revision 1.27 2001/09/16 17:08:54 jongfoster
310 * Moving simple CGI functions from cgi.c to new file cgisimple.c
312 * Revision 1.26 2001/09/16 15:47:37 jongfoster
313 * First version of CGI-based edit interface. This is very much a
314 * work-in-progress, and you can't actually use it to edit anything
315 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
316 * to have any effect.
318 * Revision 1.25 2001/09/16 15:02:35 jongfoster
319 * Adding i.j.b/robots.txt.
320 * Inlining add_stats() since it's only ever called from one place.
322 * Revision 1.24 2001/09/16 11:38:01 jongfoster
323 * Splitting fill_template() into 2 functions:
324 * template_load() loads the file
325 * template_fill() performs the PCRS regexps.
326 * This is because the CGI edit interface has a "table row"
327 * template which is used many times in the page - this
328 * change means it's only loaded from disk once.
330 * Revision 1.23 2001/09/16 11:16:05 jongfoster
331 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
333 * Revision 1.22 2001/09/16 11:00:10 jongfoster
334 * New function alloc_http_response, for symmetry with free_http_response
336 * Revision 1.21 2001/09/13 23:53:03 jongfoster
337 * Support for both static and dynamically generated CGI pages.
338 * Correctly setting Last-Modified: and Expires: HTTP headers.
340 * Revision 1.20 2001/09/13 23:40:36 jongfoster
341 * (Cosmetic only) Indentation correction
343 * Revision 1.19 2001/09/13 23:31:25 jongfoster
344 * Moving image data to cgi.c rather than cgi.h.
346 * Revision 1.18 2001/08/05 16:06:20 jongfoster
347 * Modifiying "struct map" so that there are now separate header and
348 * "map_entry" structures. This means that functions which modify a
349 * map no longer need to return a pointer to the modified map.
350 * Also, it no longer reverses the order of the entries (which may be
351 * important with some advanced template substitutions).
353 * Revision 1.17 2001/08/05 15:57:38 oes
354 * Adapted finish_http_response to new list_to_text
356 * Revision 1.16 2001/08/01 21:33:18 jongfoster
357 * Changes to fill_template() that reduce memory usage without having
358 * an impact on performance. I also renamed some variables so as not
359 * to clash with the C++ keywords "new" and "template".
361 * Revision 1.15 2001/08/01 21:19:22 jongfoster
362 * Moving file version information to a separate CGI page.
364 * Revision 1.14 2001/08/01 00:19:03 jongfoster
365 * New function: map_conditional() for an if-then-else syntax.
366 * Changing to use new version of show_defines()
368 * Revision 1.13 2001/07/30 22:08:36 jongfoster
369 * Tidying up #defines:
370 * - All feature #defines are now of the form FEATURE_xxx
371 * - Permanently turned off WIN_GUI_EDIT
372 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
374 * Revision 1.12 2001/07/29 18:47:05 jongfoster
375 * Adding missing #include "loadcfg.h"
377 * Revision 1.11 2001/07/18 17:24:37 oes
378 * Changed to conform to new pcrs interface
380 * Revision 1.10 2001/07/13 13:53:13 oes
381 * Removed all #ifdef PCRS and related code
383 * Revision 1.9 2001/06/29 21:45:41 oes
384 * Indentation, CRLF->LF, Tab-> Space
386 * Revision 1.8 2001/06/29 13:21:46 oes
387 * - Cosmetics: renamed and reordered functions, variables,
388 * texts, improved comments etc
390 * - Removed ij_untrusted_url() The relevant
391 * info is now part of the "untrusted" page,
392 * which is generated by filters.c:trust_url()
394 * - Generators of content now call finish_http_response()
395 * themselves, making jcc.c:chat() a little less
398 * - Removed obsolete "Pragma: no-cache" from our headers
400 * - http_responses now know their head length
402 * - fill_template now uses the new interface to pcrs, so that
403 * - long jobs (like whole files) no longer have to be assembled
404 * in a fixed size buffer
405 * - the new T (trivial) option is used, and the replacement may
406 * contain Perl syntax backrefs without confusing pcrs
408 * - Introduced default_exports() which generates a set of exports
409 * common to all CGIs and other content generators
411 * - Introduced convenience function map_block_killer()
413 * - Introduced convenience function make_menu()
415 * - Introduced CGI-like function error_response() which generates
416 * the "No such domain" and "Connect failed" messages using the
419 * - cgi_show_url_info:
420 * - adapted to new CGI features
421 * - form and answers now generated from same template
422 * - http:// prefix in URL now OK
425 * - adapted to new CGI features
426 * - no longer uses csp->init_proxy_args
429 * - moved menu generation to make_menu()
431 * - add_stats now writes single export map entries instead
434 * - Moved redirect_url() to filters.c
436 * - Fixed mem leak in free_http_response(), map_block_killer(),
438 * - Removed logentry from cancelled commit
440 * Revision 1.7 2001/06/09 10:51:58 jongfoster
441 * Changing "show URL info" handler to new style.
442 * Changing BUFSIZ ==> BUFFER_SIZE
444 * Revision 1.6 2001/06/07 23:05:19 jongfoster
445 * Removing code related to old forward and ACL files.
447 * Revision 1.5 2001/06/05 19:59:16 jongfoster
448 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
450 * Revision 1.4 2001/06/04 10:41:52 swa
451 * show version string of cgi.h and cgi.c
453 * Revision 1.3 2001/06/03 19:12:16 oes
454 * introduced new cgi handling
456 * No revisions before 1.3
458 **********************************************************************/
464 #include <sys/types.h>
472 #define snprintf _snprintf
473 #endif /* def _WIN32 */
481 #include "miscutil.h"
482 #include "cgisimple.h"
483 #ifdef FEATURE_CGI_EDIT_ACTIONS
485 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
487 /* loadcfg.h is for global_toggle_state only */
488 #ifdef FEATURE_PTHREAD
491 /* jcc.h is for mutex semaphore globals only */
492 #endif /* def FEATURE_PTHREAD */
493 const char cgi_h_rcs[] = CGI_H_VERSION;
496 * List of CGI functions: name, handler, description
497 * Note: Do NOT use single quotes in the description;
498 * this will break the dynamic "blocked" template!
500 static const struct cgi_dispatcher cgi_dispatchers[] = {
505 #ifdef FEATURE_GRACEFUL_TERMINATION
508 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
509 "this is a one click Denial Of Service attack!!!</em>",
514 #ifdef FEATURE_CGI_EDIT_ACTIONS
515 "View & change the current configuration",
517 "View the current configuration",
522 "View the source code version numbers",
526 "View the request headers.",
530 "Look up which actions apply to a URL and why",
532 #ifdef FEATURE_CGI_EDIT_ACTIONS
535 "Toggle Privoxy on or off",
537 { "edit-actions", /* Edit the actions list */
540 { "eaa", /* Shortcut for edit-actions-add-url-form */
541 cgi_edit_actions_add_url_form,
543 { "eau", /* Shortcut for edit-actions-url-form */
544 cgi_edit_actions_url_form,
546 { "ear", /* Shortcut for edit-actions-remove-url-form */
547 cgi_edit_actions_remove_url_form,
549 { "eal", /* Shortcut for edit-actions-list */
550 cgi_edit_actions_list,
552 { "eafu", /* Shortcut for edit-actions-for-url */
553 cgi_edit_actions_for_url,
555 { "eas", /* Shortcut for edit-actions-submit */
556 cgi_edit_actions_submit,
558 { "easa", /* Shortcut for edit-actions-section-add */
559 cgi_edit_actions_section_add,
561 { "easr", /* Shortcut for edit-actions-section-remove */
562 cgi_edit_actions_section_remove,
564 { "eass", /* Shortcut for edit-actions-section-swap */
565 cgi_edit_actions_section_swap,
567 { "edit-actions-for-url",
568 cgi_edit_actions_for_url,
569 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
570 { "edit-actions-list",
571 cgi_edit_actions_list,
572 NULL, TRUE /* Edit the actions list */ },
573 { "edit-actions-submit",
574 cgi_edit_actions_submit,
575 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
576 { "edit-actions-url",
577 cgi_edit_actions_url,
578 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
579 { "edit-actions-url-form",
580 cgi_edit_actions_url_form,
581 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
582 { "edit-actions-add-url",
583 cgi_edit_actions_add_url,
584 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
585 { "edit-actions-add-url-form",
586 cgi_edit_actions_add_url_form,
587 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
588 { "edit-actions-remove-url",
589 cgi_edit_actions_remove_url,
590 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
591 { "edit-actions-remove-url-form",
592 cgi_edit_actions_remove_url_form,
593 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
594 { "edit-actions-section-add",
595 cgi_edit_actions_section_add,
596 NULL, FALSE /* Remove a section from the actionsfile */ },
597 { "edit-actions-section-remove",
598 cgi_edit_actions_section_remove,
599 NULL, FALSE /* Remove a section from the actionsfile */ },
600 { "edit-actions-section-swap",
601 cgi_edit_actions_section_swap,
602 NULL, FALSE /* Swap two sections in the actionsfile */ },
603 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
606 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
609 NULL, TRUE /* Send a built-in image */ },
612 NULL, TRUE /* Send templates/cgi-style.css */ },
614 cgi_transparent_image,
615 NULL, TRUE /* Send a transparent image (short name) */ },
616 { NULL, /* NULL Indicates end of list and default page */
618 NULL, TRUE /* Unknown CGI page */ }
623 * Built-in images for ad replacement
625 * Hint: You can encode your own images like this:
626 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
629 #ifdef FEATURE_NO_GIFS
632 * Checkerboard pattern, as a PNG.
634 const char image_pattern_data[] =
635 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
636 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
637 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
638 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
639 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
640 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
641 "\000\000\000\111\105\116\104\256\102\140\202";
644 * 1x1 transparant PNG.
646 const char image_blank_data[] =
647 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
648 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
649 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
650 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
651 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
652 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
653 "\000\000\000\000\111\105\116\104\256\102\140\202";
657 * Checkerboard pattern, as a GIF.
659 const char image_pattern_data[] =
660 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
661 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
662 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
663 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
667 * 1x1 transparant GIF.
669 const char image_blank_data[] =
670 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
671 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
672 "\000\001\000\000\002\002D\001\000;";
675 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
676 const size_t image_blank_length = sizeof(image_blank_data) - 1;
679 static struct http_response cgi_error_memory_response[1];
681 static struct http_response *dispatch_known_cgi(struct client_state * csp,
683 static struct map *parse_cgi_parameters(char *argstring);
686 /*********************************************************************
688 * Function : dispatch_cgi
690 * Description : Checks if a request URL has either the magical
691 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
692 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
693 * http://config.privoxy.org/). If so, it passes
694 * the (rest of the) path onto dispatch_known_cgi, which
695 * calls the relevant CGI handler function.
698 * 1 : csp = Current client state (buffers, headers, etc...)
700 * Returns : http_response if match, NULL if nonmatch or handler fail
702 *********************************************************************/
703 struct http_response *dispatch_cgi(struct client_state *csp)
705 const char *host = csp->http->host;
706 const char *path = csp->http->path;
709 * Should we intercept ?
712 /* Note: "example.com" and "example.com." are equivalent hostnames. */
714 /* Either the host matches CGI_SITE_1_HOST ..*/
715 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
716 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
717 && (path[0] == '/') )
719 /* ..then the path will all be for us. Remove leading '/' */
722 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
723 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
724 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
725 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
727 /* take everything following CGI_SITE_2_PATH */
728 path += strlen(CGI_SITE_2_PATH);
731 /* skip the forward slash after CGI_SITE_2_PATH */
734 else if (*path != '\0')
737 * weirdness: URL is /configXXX, where XXX is some string
738 * Do *NOT* intercept.
750 * This is a CGI call.
753 return dispatch_known_cgi(csp, path);
757 /*********************************************************************
759 * Function : grep_cgi_referrer
761 * Description : Ugly provisorical fix that greps the value of the
762 * referer HTTP header field out of a linked list of
763 * strings like found at csp->headers. Will disappear
766 * FIXME: csp->headers ought to be csp->http->headers
767 * FIXME: Parsing all client header lines should
768 * happen right after the request is received!
771 * 1 : csp = Current client state (buffers, headers, etc...)
773 * Returns : pointer to value (no copy!), or NULL if none found.
775 *********************************************************************/
776 char *grep_cgi_referrer(struct client_state *csp)
778 struct list_entry *p;
780 for (p = csp->headers->first; p != NULL; p = p->next)
782 if (p->str == NULL) continue;
783 if (strncmpic(p->str, "Referer: ", 9) == 0)
785 return ((p->str) + 9);
793 /*********************************************************************
795 * Function : dispatch_known_cgi
797 * Description : Processes a CGI once dispatch_cgi has determined that
798 * it matches one of the magic prefixes. Parses the path
799 * as a cgi name plus query string, prepares a map that
800 * maps CGI parameter names to their values, initializes
801 * the http_response struct, and calls the relevant CGI
805 * 1 : csp = Current client state (buffers, headers, etc...)
806 * 2 : path = Path of CGI, with the CGI prefix removed.
807 * Should not have a leading "/".
809 * Returns : http_response, or NULL on handler failure or out of
812 *********************************************************************/
813 static struct http_response *dispatch_known_cgi(struct client_state * csp,
816 const struct cgi_dispatcher *d;
817 struct map *param_list;
818 struct http_response *rsp;
819 char *query_args_start;
824 if (NULL == (path_copy = strdup(path)))
826 return cgi_error_memory();
829 query_args_start = path_copy;
830 while (*query_args_start && *query_args_start != '?')
834 if (*query_args_start == '?')
836 *query_args_start++ = '\0';
839 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
842 return cgi_error_memory();
847 * path_copy = CGI call name
848 * param_list = CGI params, as map
851 /* Get mem for response or fail*/
852 if (NULL == (rsp = alloc_http_response()))
855 free_map(param_list);
856 return cgi_error_memory();
859 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
860 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
861 csp->ip_addr_str, csp->http->cmd);
864 * Find and start the right CGI function
869 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
872 * If the called CGI is either harmless, or referred
873 * from a trusted source, start it.
876 || ((NULL != (referrer = grep_cgi_referrer(csp)))
877 && (0 == strncmp(referrer, "http://config.privoxy.org/", 26)))
880 err = (d->handler)(csp, rsp, param_list);
885 * Else, modify toggle calls so that they only display
886 * the status, and deny all other calls.
888 if (0 == strcmp(path_copy, "toggle"))
890 unmap(param_list, "set");
891 err = (d->handler)(csp, rsp, param_list);
895 err = cgi_error_disabled(csp, rsp);
900 free_map(param_list);
902 if (err == JB_ERR_CGI_PARAMS)
904 err = cgi_error_bad_param(csp, rsp);
906 if (err && (err != JB_ERR_MEMORY))
908 /* Unexpected error! Shouldn't get here */
909 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
910 err = cgi_error_unknown(csp, rsp, err);
915 return finish_http_response(rsp);
919 /* Error in handler, probably out-of-memory */
920 free_http_response(rsp);
921 return cgi_error_memory();
929 /*********************************************************************
931 * Function : parse_cgi_parameters
933 * Description : Parse a URL-encoded argument string into name/value
934 * pairs and store them in a struct map list.
937 * 1 : argstring = string to be parsed. Will be trashed.
939 * Returns : pointer to param list, or NULL if out of memory.
941 *********************************************************************/
942 static struct map *parse_cgi_parameters(char *argstring)
945 char *vector[BUFFER_SIZE];
947 struct map *cgi_params;
949 if (NULL == (cgi_params = new_map()))
955 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
956 * the fragment identifier along with the request, so we must
957 * cut it off here, so it won't pollute the CGI params:
959 if (NULL != (p = strchr(argstring, '#')))
964 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
966 for (i = 0; i < pairs; i++)
968 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
971 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
973 free_map(cgi_params);
984 /*********************************************************************
986 * Function : get_char_param
988 * Description : Get a single-character parameter passed to a CGI
992 * 1 : parameters = map of cgi parameters
993 * 2 : param_name = The name of the parameter to read
995 * Returns : Uppercase character on success, '\0' on error.
997 *********************************************************************/
998 char get_char_param(const struct map *parameters,
999 const char *param_name)
1006 ch = *(lookup(parameters, param_name));
1007 if ((ch >= 'a') && (ch <= 'z'))
1009 ch = ch - 'a' + 'A';
1016 /*********************************************************************
1018 * Function : get_string_param
1020 * Description : Get a string paramater, to be used as an
1021 * ACTION_STRING or ACTION_MULTI paramater.
1022 * Validates the input to prevent stupid/malicious
1023 * users from corrupting their action file.
1026 * 1 : parameters = map of cgi parameters
1027 * 2 : param_name = The name of the parameter to read
1028 * 3 : pparam = destination for paramater. Allocated as
1029 * part of the map "parameters", so don't free it.
1030 * Set to NULL if not specified.
1032 * Returns : JB_ERR_OK on success, or if the paramater
1033 * was not specified.
1034 * JB_ERR_MEMORY on out-of-memory.
1035 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1037 *********************************************************************/
1038 jb_err get_string_param(const struct map *parameters,
1039 const char *param_name,
1040 const char **pparam)
1052 param = lookup(parameters, param_name);
1058 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1063 * Note that the length limit is arbitrary, it just seems
1064 * sensible to limit it to *something*. There's no
1065 * technical reason for any limit at all.
1067 return JB_ERR_CGI_PARAMS;
1070 /* Check every character to see if it's legal */
1072 while ((ch = *s++) != '\0')
1074 if ( ((unsigned char)ch < (unsigned char)' ')
1077 /* Probable hack attempt, or user accidentally used '}'. */
1078 return JB_ERR_CGI_PARAMS;
1089 /*********************************************************************
1091 * Function : get_number_param
1093 * Description : Get a non-negative integer from the parameters
1094 * passed to a CGI function.
1097 * 1 : csp = Current client state (buffers, headers, etc...)
1098 * 2 : parameters = map of cgi parameters
1099 * 3 : name = Name of CGI parameter to read
1100 * 4 : pvalue = destination for value.
1101 * Set to -1 on error.
1103 * Returns : JB_ERR_OK on success
1104 * JB_ERR_MEMORY on out-of-memory
1105 * JB_ERR_CGI_PARAMS if the parameter was not specified
1108 *********************************************************************/
1109 jb_err get_number_param(struct client_state *csp,
1110 const struct map *parameters,
1125 param = lookup(parameters, name);
1128 return JB_ERR_CGI_PARAMS;
1131 /* We don't use atoi because I want to check this carefully... */
1134 while ((ch = *param++) != '\0')
1136 if ((ch < '0') || (ch > '9'))
1138 return JB_ERR_CGI_PARAMS;
1145 * <limits.h> defines UINT_MAX
1147 * (UINT_MAX - ch) / 10 is the largest number that
1148 * can be safely multiplied by 10 then have ch added.
1150 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1152 return JB_ERR_CGI_PARAMS;
1155 value = value * 10 + ch;
1166 /*********************************************************************
1168 * Function : error_response
1170 * Description : returns an http_response that explains the reason
1171 * why a request failed.
1174 * 1 : csp = Current client state (buffers, headers, etc...)
1175 * 2 : templatename = Which template should be used for the answer
1176 * 3 : sys_err = system error number
1178 * Returns : A http_response. If we run out of memory, this
1179 * will be cgi_error_memory().
1181 *********************************************************************/
1182 struct http_response *error_response(struct client_state *csp,
1183 const char *templatename,
1187 struct http_response *rsp;
1188 struct map * exports = default_exports(csp, NULL);
1189 if (exports == NULL)
1191 return cgi_error_memory();
1194 if (NULL == (rsp = alloc_http_response()))
1197 return cgi_error_memory();
1200 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1201 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1202 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1203 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1204 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1207 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1210 /* Some failures, like "404 no such domain", don't have an IP address. */
1211 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1219 free_http_response(rsp);
1220 return cgi_error_memory();
1223 if (!strcmp(templatename, "no-such-domain"))
1225 rsp->status = strdup("404 No such domain");
1226 if (rsp->status == NULL)
1229 free_http_response(rsp);
1230 return cgi_error_memory();
1233 else if (!strcmp(templatename, "connect-failed"))
1235 rsp->status = strdup("503 Connect failed");
1236 if (rsp->status == NULL)
1239 free_http_response(rsp);
1240 return cgi_error_memory();
1244 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1247 free_http_response(rsp);
1248 return cgi_error_memory();
1251 return finish_http_response(rsp);
1255 /*********************************************************************
1257 * Function : cgi_error_disabled
1259 * Description : CGI function that is called to generate an error
1260 * response if the actions editor or toggle CGI are
1261 * accessed despite having being disabled at compile-
1265 * 1 : csp = Current client state (buffers, headers, etc...)
1266 * 2 : rsp = http_response data structure for output
1268 * CGI Parameters : none
1270 * Returns : JB_ERR_OK on success
1271 * JB_ERR_MEMORY on out-of-memory error.
1273 *********************************************************************/
1274 jb_err cgi_error_disabled(struct client_state *csp,
1275 struct http_response *rsp)
1277 struct map *exports;
1282 if (NULL == (exports = default_exports(csp, NULL)))
1284 return JB_ERR_MEMORY;
1287 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1291 /*********************************************************************
1293 * Function : cgi_init_error_messages
1295 * Description : Call at the start of the program to initialize
1296 * the error message used by cgi_error_memory().
1302 *********************************************************************/
1303 void cgi_init_error_messages(void)
1305 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1306 cgi_error_memory_response->head =
1307 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1308 "Content-Type: text/html\r\n"
1310 cgi_error_memory_response->body =
1312 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1314 "<h1>500 Internal Privoxy Error</h1>\r\n"
1315 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1316 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1320 cgi_error_memory_response->head_length =
1321 strlen(cgi_error_memory_response->head);
1322 cgi_error_memory_response->content_length =
1323 strlen(cgi_error_memory_response->body);
1327 /*********************************************************************
1329 * Function : cgi_error_memory
1331 * Description : Called if a CGI function runs out of memory.
1332 * Returns a statically-allocated error response.
1336 * Returns : http_response data structure for output. This is
1337 * statically allocated, for obvious reasons.
1339 *********************************************************************/
1340 struct http_response *cgi_error_memory(void)
1342 /* assert that it's been initialized. */
1343 assert(cgi_error_memory_response->head);
1345 return cgi_error_memory_response;
1349 /*********************************************************************
1351 * Function : cgi_error_no_template
1353 * Description : Almost-CGI function that is called if a template
1354 * cannot be loaded. Note this is not a true CGI,
1355 * it takes a template name rather than a map of
1359 * 1 : csp = Current client state (buffers, headers, etc...)
1360 * 2 : rsp = http_response data structure for output
1361 * 3 : template_name = Name of template that could not
1364 * Returns : JB_ERR_OK on success
1365 * JB_ERR_MEMORY on out-of-memory error.
1367 *********************************************************************/
1368 jb_err cgi_error_no_template(struct client_state *csp,
1369 struct http_response *rsp,
1370 const char *template_name)
1372 static const char status[] =
1373 "500 Internal Privoxy Error";
1374 static const char body_prefix[] =
1376 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1378 "<h1>500 Internal Privoxy Error</h1>\r\n"
1379 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1380 "<p><b>Could not load template file <code>";
1381 static const char body_suffix[] =
1382 "</code> or one of it's included components.</b></p>\r\n"
1383 "<p>Please contact your proxy administrator.</p>\r\n"
1384 "<p>If you are the proxy administrator, please put the required file(s)"
1385 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1386 "location of the <code><i>(confdir)</i></code> directory "
1387 "is specified in the main Privoxy <code>config</code> "
1388 "file. (It's typically the Privoxy install directory"
1390 ", or <code>/etc/privoxy/</code>"
1391 #endif /* ndef _WIN32 */
1398 assert(template_name);
1400 /* Reset rsp, if needed */
1404 rsp->content_length = 0;
1405 rsp->head_length = 0;
1408 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1409 if (rsp->body == NULL)
1411 return JB_ERR_MEMORY;
1413 strcpy(rsp->body, body_prefix);
1414 strcat(rsp->body, template_name);
1415 strcat(rsp->body, body_suffix);
1417 rsp->status = strdup(status);
1418 if (rsp->body == NULL)
1420 return JB_ERR_MEMORY;
1427 /*********************************************************************
1429 * Function : cgi_error_unknown
1431 * Description : Almost-CGI function that is called if an unexpected
1432 * error occurs in the top-level CGI dispatcher.
1433 * In this context, "unexpected" means "anything other
1434 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1435 * expected to handle all other errors internally,
1436 * since they can give more relavent error messages
1439 * Note this is not a true CGI, it takes an error
1440 * code rather than a map of parameters.
1443 * 1 : csp = Current client state (buffers, headers, etc...)
1444 * 2 : rsp = http_response data structure for output
1445 * 3 : error_to_report = Error code to report.
1447 * Returns : JB_ERR_OK on success
1448 * JB_ERR_MEMORY on out-of-memory error.
1450 *********************************************************************/
1451 jb_err cgi_error_unknown(struct client_state *csp,
1452 struct http_response *rsp,
1453 jb_err error_to_report)
1455 static const char status[] =
1456 "500 Internal Privoxy Error";
1457 static const char body_prefix[] =
1459 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1461 "<h1>500 Internal Privoxy Error</h1>\r\n"
1462 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1463 "<p><b>Unexpected internal error: ";
1464 static const char body_suffix[] =
1467 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1468 "file a bug report</a>.</p>\r\n"
1475 /* Reset rsp, if needed */
1479 rsp->content_length = 0;
1480 rsp->head_length = 0;
1483 sprintf(errnumbuf, "%d", error_to_report);
1485 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1486 if (rsp->body == NULL)
1488 return JB_ERR_MEMORY;
1490 strcpy(rsp->body, body_prefix);
1491 strcat(rsp->body, errnumbuf);
1492 strcat(rsp->body, body_suffix);
1494 rsp->status = strdup(status);
1495 if (rsp->body == NULL)
1497 return JB_ERR_MEMORY;
1504 /*********************************************************************
1506 * Function : cgi_error_bad_param
1508 * Description : CGI function that is called if the parameters
1509 * (query string) for a CGI were wrong.
1512 * 1 : csp = Current client state (buffers, headers, etc...)
1513 * 2 : rsp = http_response data structure for output
1515 * CGI Parameters : none
1517 * Returns : JB_ERR_OK on success
1518 * JB_ERR_MEMORY on out-of-memory error.
1520 *********************************************************************/
1521 jb_err cgi_error_bad_param(struct client_state *csp,
1522 struct http_response *rsp)
1524 struct map *exports;
1529 if (NULL == (exports = default_exports(csp, NULL)))
1531 return JB_ERR_MEMORY;
1534 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1538 /*********************************************************************
1540 * Function : cgi_redirect
1542 * Description : CGI support function to generate a HTTP redirect
1546 * 1 : rsp = http_response data structure for output
1547 * 2 : target = string with the target URL
1549 * CGI Parameters : None
1551 * Returns : JB_ERR_OK on success
1552 * JB_ERR_MEMORY on out-of-memory error.
1554 *********************************************************************/
1555 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1562 err = enlist_unique_header(rsp->headers, "Location", target);
1564 rsp->status = strdup("302 Local Redirect from Privoxy");
1565 if (rsp->status == NULL)
1567 return JB_ERR_MEMORY;
1574 /*********************************************************************
1576 * Function : add_help_link
1578 * Description : Produce a copy of the string given as item,
1579 * embedded in an HTML link to its corresponding
1580 * section (item name in uppercase) in the actions
1581 * chapter of the user manual, (whose URL is given in
1582 * the config and defaults to our web site).
1584 * FIXME: I currently only work for actions, and would
1585 * like to be generalized for other topics.
1588 * 1 : item = item (will NOT be free()d.)
1589 * It is assumed to be HTML-safe.
1590 * 2 : config = The current configuration.
1592 * Returns : String with item embedded in link, or NULL on
1595 *********************************************************************/
1596 char *add_help_link(const char *item,
1597 struct configuration_spec *config)
1601 if (!item) return NULL;
1603 result = strdup("<a href=\"");
1604 string_append(&result, config->usermanual);
1605 string_append(&result, ACTIONS_HELP_PREFIX);
1606 string_join (&result, string_toupper(item));
1607 string_append(&result, "\">");
1608 string_append(&result, item);
1609 string_append(&result, "</a> ");
1615 /*********************************************************************
1617 * Function : get_http_time
1619 * Description : Get the time in a format suitable for use in a
1620 * HTTP header - e.g.:
1621 * "Sun, 06 Nov 1994 08:49:37 GMT"
1624 * 1 : time_offset = Time returned will be current time
1625 * plus this number of seconds.
1626 * 2 : buf = Destination for result. Must be long enough
1627 * to hold 29 characters plus a trailing zero.
1631 *********************************************************************/
1632 void get_http_time(int time_offset, char *buf)
1634 static const char day_names[7][4] =
1635 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1636 static const char month_names[12][4] =
1637 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1638 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1641 time_t current_time;
1642 #if defined(HAVE_GMTIME_R) && !defined(OSX_DARWIN)
1644 * Declare dummy up here (instead of inside get/set gmt block) so it
1645 * doesn't go out of scope before it's potentially used in snprintf later.
1646 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1647 * !defined HAVE_GMTIME_R.
1654 time(¤t_time); /* get current time */
1656 current_time += time_offset;
1658 /* get and save the gmt */
1661 pthread_mutex_lock(&gmtime_mutex);
1662 t = gmtime(¤t_time);
1663 pthread_mutex_unlock(&gmtime_mutex);
1665 t = gmtime_r(¤t_time, &dummy);
1667 t = gmtime(¤t_time);
1671 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1673 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1674 day_names[t->tm_wday],
1676 month_names[t->tm_mon],
1686 /*********************************************************************
1688 * Function : finish_http_response
1690 * Description : Fill in the missing headers in an http response,
1691 * and flatten the headers to an http head.
1694 * 1 : rsp = pointer to http_response to be processed
1696 * Returns : A http_response, usually the rsp parameter.
1697 * On error, free()s rsp and returns cgi_error_memory()
1699 *********************************************************************/
1700 struct http_response *finish_http_response(struct http_response *rsp)
1702 char buf[BUFFER_SIZE];
1705 /* Special case - do NOT change this statically allocated response,
1706 * which is ready for output anyway.
1708 if (rsp == cgi_error_memory_response)
1714 * Fill in the HTTP Status
1716 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1717 err = enlist_first(rsp->headers, buf);
1720 * Set the Content-Length
1722 if (rsp->content_length == 0)
1724 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1728 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1729 err = enlist(rsp->headers, buf);
1733 * Fill in the default headers:
1735 * Content-Type: default to text/html if not already specified.
1736 * Date: set to current date/time.
1737 * Last-Modified: set to date/time the page was last changed.
1738 * Expires: set to date/time page next needs reloading.
1739 * Cache-Control: set to "no-cache" if applicable.
1741 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1743 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1748 * Set Expires to about 10 min into the future so it'll get reloaded
1749 * occasionally, e.g. if Privoxy gets upgraded.
1754 get_http_time(0, buf);
1755 err = enlist_unique_header(rsp->headers, "Date", buf);
1758 /* Some date in the past. */
1759 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1763 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1764 err = enlist_unique_header(rsp->headers, "Expires", buf);
1770 * Setting "Cache-Control" to "no-cache" and "Expires" to
1771 * the current time doesn't exactly forbid caching, it just
1772 * requires the client to revalidate the cached copy.
1774 * If a temporary problem occurres and the user tries again after
1775 * getting Privoxy's error message, a compliant browser may set the
1776 * If-Modified-Since header with the content of the error page's
1777 * Last-Modified header. More often than not, the document on the server
1778 * is older than Privoxy's error message, the server would send status code
1779 * 304 and the browser would display the outdated error message again and again.
1781 * As a last resort we set "Last-Modified" to Tim Berners-Lee's birthday,
1782 * which predates the age of any page on the web and can be safely used to
1783 * "revalidate" without getting a status code 304.
1785 * There is no need to let the useless If-Modified-Since header reach the
1786 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1788 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1790 get_http_time(0, buf);
1791 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1792 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1793 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1794 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1801 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1803 free_http_response(rsp);
1804 return cgi_error_memory();
1806 rsp->head_length = strlen(rsp->head);
1813 /*********************************************************************
1815 * Function : alloc_http_response
1817 * Description : Allocates a new http_response structure.
1821 * Returns : pointer to a new http_response, or NULL.
1823 *********************************************************************/
1824 struct http_response *alloc_http_response(void)
1826 return (struct http_response *) zalloc(sizeof(struct http_response));
1831 /*********************************************************************
1833 * Function : free_http_response
1835 * Description : Free the memory occupied by an http_response
1836 * and its depandant structures.
1839 * 1 : rsp = pointer to http_response to be freed
1843 *********************************************************************/
1844 void free_http_response(struct http_response *rsp)
1847 * Must special case cgi_error_memory_response, which is never freed.
1849 if (rsp && (rsp != cgi_error_memory_response))
1854 destroy_list(rsp->headers);
1861 /*********************************************************************
1863 * Function : template_load
1865 * Description : CGI support function that loads a given HTML
1866 * template from the confdir, ignoring comment
1867 * lines and following #include statements up to
1871 * 1 : csp = Current client state (buffers, headers, etc...)
1872 * 2 : template_ptr = Destination for pointer to loaded
1874 * 3 : templatename = name of the HTML template to be used
1875 * 4 : recursive = Flag set if this function calls itself
1876 * following an #include statament
1878 * Returns : JB_ERR_OK on success
1879 * JB_ERR_MEMORY on out-of-memory error.
1880 * JB_ERR_FILE if the template file cannot be read
1882 *********************************************************************/
1883 jb_err template_load(struct client_state *csp, char **template_ptr,
1884 const char *templatename, int recursive)
1887 char *templates_dir_path;
1890 char *included_module;
1893 char buf[BUFFER_SIZE];
1896 assert(template_ptr);
1897 assert(templatename);
1899 *template_ptr = NULL;
1901 /* Validate template name. Paranoia. */
1902 for (p = templatename; *p != 0; p++)
1904 if ( ((*p < 'a') || (*p > 'z'))
1905 && ((*p < 'A') || (*p > 'Z'))
1906 && ((*p < '0') || (*p > '9'))
1910 /* Illegal character */
1915 /* Generate full path */
1917 templates_dir_path = make_path(csp->config->confdir, "templates");
1918 if (templates_dir_path == NULL)
1920 return JB_ERR_MEMORY;
1923 full_path = make_path(templates_dir_path, templatename);
1924 free(templates_dir_path);
1925 if (full_path == NULL)
1927 return JB_ERR_MEMORY;
1930 /* Allocate buffer */
1932 file_buffer = strdup("");
1933 if (file_buffer == NULL)
1936 return JB_ERR_MEMORY;
1939 /* Open template file */
1941 if (NULL == (fp = fopen(full_path, "r")))
1943 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1951 * Read the file, ignoring comments, and honoring #include
1952 * statements, unless we're already called recursively.
1954 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1955 * This is unlikely in practise.
1957 while (fgets(buf, BUFFER_SIZE, fp))
1959 if (!recursive && !strncmp(buf, "#include ", 9))
1961 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1968 if (string_join(&file_buffer, included_module))
1971 return JB_ERR_MEMORY;
1977 /* skip lines starting with '#' */
1983 if (string_append(&file_buffer, buf))
1986 return JB_ERR_MEMORY;
1991 *template_ptr = file_buffer;
1997 /*********************************************************************
1999 * Function : template_fill
2001 * Description : CGI support function that fills in a pre-loaded
2002 * HTML template by replacing @name@ with value using
2003 * pcrs, for each item in the output map.
2005 * Note that a leading '$' charachter in the export map's
2006 * values will be stripped and toggle on backreference
2010 * 1 : template_ptr = IN: Template to be filled out.
2012 * OUT: Filled out template.
2013 * Caller must free().
2014 * 2 : exports = map with fill in symbol -> name pairs
2016 * Returns : JB_ERR_OK on success
2017 * JB_ERR_MEMORY on out-of-memory error
2019 *********************************************************************/
2020 jb_err template_fill(char **template_ptr, const struct map *exports)
2022 struct map_entry *m;
2024 char buf[BUFFER_SIZE];
2025 char *tmp_out_buffer;
2031 assert(template_ptr);
2032 assert(*template_ptr);
2035 file_buffer = *template_ptr;
2036 size = strlen(file_buffer) + 1;
2039 * Assemble pcrs joblist from exports map
2041 for (m = exports->first; m != NULL; m = m->next)
2043 if (*m->name == '$')
2046 * First character of name is '$', so remove this flag
2047 * character and allow backreferences ($1 etc) in the
2048 * "replace with" text.
2050 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2056 * Treat the "replace with" text as a literal string -
2057 * no quoting needed, no backreferences allowed.
2058 * ("Trivial" ['T'] flag).
2062 /* Enclose name in @@ */
2063 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2067 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2069 /* Make and run job. */
2070 job = pcrs_compile(buf, m->value, flags, &error);
2073 if (error == PCRS_ERR_NOMEM)
2076 *template_ptr = NULL;
2077 return JB_ERR_MEMORY;
2081 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2082 /* Hope it wasn't important and silently ignore the invalid job */
2087 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2090 if (NULL == tmp_out_buffer)
2092 *template_ptr = NULL;
2093 return JB_ERR_MEMORY;
2095 file_buffer = tmp_out_buffer;
2102 *template_ptr = file_buffer;
2107 /*********************************************************************
2109 * Function : template_fill_for_cgi
2111 * Description : CGI support function that loads a HTML template
2112 * and fills it in. Handles file-not-found errors
2113 * by sending a HTML error message. For convenience,
2114 * this function also frees the passed "exports" map.
2117 * 1 : csp = Client state
2118 * 2 : templatename = name of the HTML template to be used
2119 * 3 : exports = map with fill in symbol -> name pairs.
2120 * Will be freed by this function.
2121 * 4 : rsp = Response structure to fill in.
2123 * Returns : JB_ERR_OK on success
2124 * JB_ERR_MEMORY on out-of-memory error
2126 *********************************************************************/
2127 jb_err template_fill_for_cgi(struct client_state *csp,
2128 const char *templatename,
2129 struct map *exports,
2130 struct http_response *rsp)
2135 assert(templatename);
2139 err = template_load(csp, &rsp->body, templatename, 0);
2140 if (err == JB_ERR_FILE)
2143 return cgi_error_no_template(csp, rsp, templatename);
2148 return err; /* JB_ERR_MEMORY */
2150 err = template_fill(&rsp->body, exports);
2156 /*********************************************************************
2158 * Function : default_exports
2160 * Description : returns a struct map list that contains exports
2161 * which are common to all CGI functions.
2164 * 1 : csp = Current client state (buffers, headers, etc...)
2165 * 2 : caller = name of CGI who calls us and which should
2166 * be excluded from the generated menu. May be
2168 * Returns : NULL if no memory, else a new map. Caller frees.
2170 *********************************************************************/
2171 struct map *default_exports(const struct client_state *csp, const char *caller)
2175 struct map * exports;
2176 int local_help_exists = 0;
2180 exports = new_map();
2181 if (exports == NULL)
2186 err = map(exports, "version", 1, html_encode(VERSION), 0);
2187 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2188 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2189 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2190 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2191 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
2192 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2193 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2194 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2195 #ifdef FEATURE_TOGGLE
2196 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2198 if (!err) err = map_block_killer(exports, "can-toggle");
2201 snprintf(buf, 20, "%d", csp->config->hport);
2202 if (!err) err = map(exports, "my-port", 1, buf, 1);
2204 if(!strcmp(CODE_STATUS, "stable"))
2206 if (!err) err = map_block_killer(exports, "unstable");
2209 if (csp->config->admin_address != NULL)
2211 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2212 local_help_exists = 1;
2216 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2219 if (csp->config->proxy_info_url != NULL)
2221 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2222 local_help_exists = 1;
2226 if (!err) err = map_block_killer(exports, "have-proxy-info");
2229 if (local_help_exists == 0)
2231 if (!err) err = map_block_killer(exports, "have-help-info");
2244 /*********************************************************************
2246 * Function : map_block_killer
2248 * Description : Convenience function.
2249 * Adds a "killer" for the conditional HTML-template
2250 * block <name>, i.e. a substitution of the regex
2251 * "if-<name>-start.*if-<name>-end" to the given
2255 * 1 : exports = map to extend
2256 * 2 : name = name of conditional block
2258 * Returns : JB_ERR_OK on success
2259 * JB_ERR_MEMORY on out-of-memory error.
2261 *********************************************************************/
2262 jb_err map_block_killer(struct map *exports, const char *name)
2264 char buf[1000]; /* Will do, since the names are hardwired */
2268 assert(strlen(name) < 490);
2270 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2271 return map(exports, buf, 1, "", 1);
2275 /*********************************************************************
2277 * Function : map_block_keep
2279 * Description : Convenience function. Removes the markers used
2280 * by map-block-killer, to save a few bytes.
2281 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2284 * 1 : exports = map to extend
2285 * 2 : name = name of conditional block
2287 * Returns : JB_ERR_OK on success
2288 * JB_ERR_MEMORY on out-of-memory error.
2290 *********************************************************************/
2291 jb_err map_block_keep(struct map *exports, const char *name)
2294 char buf[500]; /* Will do, since the names are hardwired */
2298 assert(strlen(name) < 490);
2300 snprintf(buf, 500, "if-%s-start", name);
2301 err = map(exports, buf, 1, "", 1);
2308 snprintf(buf, 500, "if-%s-end", name);
2309 return map(exports, buf, 1, "", 1);
2313 /*********************************************************************
2315 * Function : map_conditional
2317 * Description : Convenience function.
2318 * Adds an "if-then-else" for the conditional HTML-template
2319 * block <name>, i.e. a substitution of the form:
2326 * The control structure and one of the alternatives
2330 * 1 : exports = map to extend
2331 * 2 : name = name of conditional block
2332 * 3 : choose_first = nonzero for first, zero for second.
2334 * Returns : JB_ERR_OK on success
2335 * JB_ERR_MEMORY on out-of-memory error.
2337 *********************************************************************/
2338 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2340 char buf[1000]; /* Will do, since the names are hardwired */
2345 assert(strlen(name) < 480);
2347 snprintf(buf, 1000, (choose_first
2348 ? "else-not-%s@.*@endif-%s"
2349 : "if-%s-then@.*@else-not-%s"),
2352 err = map(exports, buf, 1, "", 1);
2358 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2359 return map(exports, buf, 1, "", 1);
2363 /*********************************************************************
2365 * Function : make_menu
2367 * Description : Returns an HTML-formatted menu of the available
2368 * unhidden CGIs, excluding the one given in <self>
2370 * Parameters : self = name of CGI to leave out, can be NULL for
2373 * Returns : menu string, or NULL on out-of-memory error.
2375 *********************************************************************/
2376 char *make_menu(const char *self)
2378 const struct cgi_dispatcher *d;
2379 char *result = strdup("");
2383 self = "NO-SUCH-CGI!";
2386 /* List available unhidden CGI's and export as "other-cgis" */
2387 for (d = cgi_dispatchers; d->name; d++)
2389 if (d->description && strcmp(d->name, self))
2391 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2392 string_append(&result, d->name);
2393 string_append(&result, "\">");
2394 string_append(&result, d->description);
2395 string_append(&result, "</a></li>");
2403 /*********************************************************************
2405 * Function : dump_map
2407 * Description : HTML-dump a map for debugging (as table)
2410 * 1 : the_map = map to dump
2412 * Returns : string with HTML
2414 *********************************************************************/
2415 char *dump_map(const struct map *the_map)
2417 struct map_entry *cur_entry;
2418 char *ret = strdup("");
2420 string_append(&ret, "<table>\n");
2422 for (cur_entry = the_map->first;
2423 (cur_entry != NULL) && (ret != NULL);
2424 cur_entry = cur_entry->next)
2426 string_append(&ret, "<tr><td><b>");
2427 string_join (&ret, html_encode(cur_entry->name));
2428 string_append(&ret, "</b></td><td>");
2429 string_join (&ret, html_encode(cur_entry->value));
2430 string_append(&ret, "</td></tr>\n");
2433 string_append(&ret, "</table>\n");