1 const char cgi_rcs[] = "$Id: cgi.c,v 1.78 2006/09/21 19:22:07 fabiankeil 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.78 2006/09/21 19:22:07 fabiankeil
42 * Use CGI_PREFIX to check the referrer.
43 * The check for "http://config.privoxy.org/" fails
44 * if the user modified CGI_SITE_2_HOST.
46 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
47 * Adjusted headers for Privoxy's cgi responses:
48 * Don't set Last-Modified, Expires and Cache-Control
49 * headers for redirects; always set "Connection: close".
51 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
52 * Only predate the Last-Modified header for cgi responses
53 * that are delivered with status code 404 or 503.
55 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
56 * Mark cgi_send_user_manual as harmless,
57 * to fix the access denied problem Hal spotted.
58 * The manual has no secret content, therefore we
59 * don't have to care about "secure" referrers.
61 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
62 * Incorporate modified version of Roland Rosenfeld's patch to
63 * optionally access the user-manual via Privoxy. Closes patch 679075.
65 * Formatting changed to Privoxy style, added call to
66 * cgi_error_no_template if the requested file doesn't
67 * exist and modified check whether or not Privoxy itself
68 * should serve the manual. Should work cross-platform now.
70 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
71 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
73 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
74 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
75 * with what was really the latest development (the v_3_0_branch branch)
77 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
78 * Moved cgi_error_disabled() from cgiedit.c to
79 * cgi.c to re-enable build with --disable-editor.
80 * Fixes Bug #892744. Thanks to Matthew Fischer
83 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
84 * - Added new function cgi_redirect to handle creation of
85 * HTTP redirect messages formerly repeated in the code.
86 * - Send cgi_error_disabled instead of cgi_error_404 when
87 * referrer check fails
88 * - Dynamic content now gets Expires header field with date
91 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
92 * Bugfix: Transparent PNG was not transparent. Thanks to
93 * Dan Razzell of Starfish Systems for notice and new PNG.
95 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
96 * Security fix: dspatch_known_cgi no longer considers an empty
97 * referrer safe for critical CGIs, since malicious links could
98 * reside on https:// locations which browsers don't advertize as
99 * referrers. Closes bug #749916, thanks to Jeff Epler for the
100 * hint. Goodbye One-Click[tm] toggling :-(
102 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
105 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
106 * Killed a compiler warning on OSX
108 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
109 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
110 * (fixes bug #710056)
111 * - Show toggle info only if we have it
113 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
114 * Move declaration of struct tm dummy outside of a control block so it is
115 * accessible later on during snprintf in get_http_time.
117 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
118 * Cosmetic: Renamed cryptic variable
120 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
121 * 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.
123 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
124 * Disable access to critical CGIs via untrusted referrers.
125 * This prevents users from being tricked by malicious websites
126 * into making unintentional configuration changes:
128 * - Added flag to each cgi_dispatcher that allows or denies
130 * - Introduced proviorical function that greps for the
131 * referrer header before regular header parsing happens
132 * - Added safety check to dispatch_known_cgi. CGI is called
133 * if (cgi harmless || no referrer || we are referrer).
134 * Else a) toggle calls are modified not to change status and
135 * b) all other calls are denied.
137 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
138 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
140 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
141 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
143 * Revision 1.70 2002/05/19 11:33:20 jongfoster
144 * If a CGI error was not handled, and propogated back to
145 * dispatch_known_cgi(), then it was assumed to be "out of memory".
146 * This gave a very misleading error message.
148 * Now other errors will cause a simple message giving the error
149 * number and asking the user to report a bug.
152 * http://sourceforge.net/tracker/index.php?func=detail
153 * &aid=557905&group_id=11118&atid=111118
155 * Revision 1.69 2002/05/14 21:28:40 oes
156 * - Fixed add_help_link to link to the (now split) actions
157 * part of the config chapter
158 * - Renamed helplink export to actions-help-prefix
160 * Revision 1.68 2002/05/12 21:36:29 jongfoster
161 * Correcting function comments
163 * Revision 1.67 2002/04/30 12:02:07 oes
164 * Nit: updated a comment
166 * Revision 1.66 2002/04/26 18:32:57 jongfoster
167 * Fixing a memory leak on error
169 * Revision 1.65 2002/04/26 12:53:51 oes
170 * - New function add_help_link
171 * - default_exports now exports links to the user manual
172 * and a prefix for links into the config chapter
174 * Revision 1.64 2002/04/24 02:17:21 oes
175 * - Better descriptions for CGIs
176 * - Hide edit-actions, more shortcuts
177 * - Moved get_char_param, get_string_param and get_number_param here
180 * Revision 1.63 2002/04/15 19:06:43 jongfoster
183 * Revision 1.62 2002/04/10 19:59:46 jongfoster
184 * Fixes to #include in templates:
185 * - Didn't close main file if loading an included template fails.
186 * - I'm paranoid and want to disallow "#include /etc/passwd".
188 * Revision 1.61 2002/04/10 13:37:48 oes
189 * Made templates modular: template_load now recursive with max depth 1
191 * Revision 1.60 2002/04/08 20:50:25 swa
194 * Revision 1.59 2002/04/05 15:51:51 oes
195 * - added send-stylesheet CGI
196 * - bugfix: error-pages now get correct request protocol
198 * - kludged CGI descriptions and menu not to break JS syntax
200 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
201 * Fix Mac OSX compiler warnings
203 * Revision 1.57 2002/03/26 22:29:54 swa
204 * we have a new homepage!
206 * Revision 1.56 2002/03/24 17:50:46 jongfoster
207 * Fixing compile error if actions file editor disabled
209 * Revision 1.55 2002/03/24 16:55:06 oes
210 * Making GIF checkerboard transparent
212 * Revision 1.54 2002/03/24 16:18:15 jongfoster
215 * Revision 1.53 2002/03/24 16:06:00 oes
216 * Correct transparency for checkerboard PNG. Thanks, Magnus!
218 * Revision 1.52 2002/03/24 15:23:33 jongfoster
221 * Revision 1.51 2002/03/24 13:25:43 swa
222 * name change related issues
224 * Revision 1.50 2002/03/16 23:54:06 jongfoster
225 * Adding graceful termination feature, to help look for memory leaks.
226 * If you enable this (which, by design, has to be done by hand
227 * editing config.h) and then go to http://i.j.b/die, then the program
228 * will exit cleanly after the *next* request. It should free all the
229 * memory that was used.
231 * Revision 1.49 2002/03/13 00:27:04 jongfoster
234 * Revision 1.48 2002/03/08 17:47:07 jongfoster
237 * Revision 1.47 2002/03/08 16:41:33 oes
238 * Added GIF images again
240 * Revision 1.46 2002/03/07 03:48:38 oes
241 * - Changed built-in images from GIF to PNG
242 * (with regard to Unisys patent issue)
243 * - Added a 4x4 pattern PNG which is less intrusive
244 * than the logo but also clearly marks the deleted banners
246 * Revision 1.45 2002/03/06 22:54:35 jongfoster
247 * Automated function-comment nitpicking.
249 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
250 * - Better error reporting on OS/2
251 * - Fix double-slash comment (oops)
253 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
254 * - Re-enable OS/2 building after new parms were added
255 * - Fix false out of memory report when resolving CGI templates when no IP
256 * address is available of failed attempt (a la no such domain)
258 * Revision 1.42 2002/01/21 00:33:20 jongfoster
259 * Replacing strsav() with the safer string_append() or string_join().
260 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
261 * Adding missing html_encode() to error message generators.
262 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
264 * Revision 1.41 2002/01/17 20:56:22 jongfoster
265 * Replacing hard references to the URL of the config interface
266 * with #defines from project.h
268 * Revision 1.40 2002/01/09 14:26:46 oes
269 * Added support for thread-safe gmtime_r call.
271 * Revision 1.39 2001/11/16 00:48:13 jongfoster
272 * Fixing a compiler warning
274 * Revision 1.38 2001/11/13 00:31:21 jongfoster
275 * - Adding new CGIs for use by non-JavaScript browsers:
276 * edit-actions-url-form
277 * edit-actions-add-url-form
278 * edit-actions-remove-url-form
279 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
282 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
283 * Show enablement/disablement status in almost all templates.
284 * There is a little trickiness here: apparent recursive resolution of
285 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
286 * the actual enablement status. So a similar construct,
287 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
290 * Revision 1.36 2001/10/26 17:33:27 oes
293 * Revision 1.35 2001/10/23 21:48:19 jongfoster
294 * Cleaning up error handling in CGI functions - they now send back
295 * a HTML error page and should never cause a FATAL error. (Fixes one
296 * potential source of "denial of service" attacks).
298 * CGI actions file editor that works and is actually useful.
300 * Ability to toggle Junkbuster remotely using a CGI call.
302 * You can turn off both the above features in the main configuration
303 * file, e.g. if you are running a multi-user proxy.
305 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
306 * Only show "Local support" on templates conditionally:
307 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
308 * - if not, no Local support section appears
310 * Revision 1.33 2001/10/14 22:28:41 jongfoster
311 * Fixing stupid typo.
313 * Revision 1.32 2001/10/14 22:20:18 jongfoster
314 * - Changes to CGI dispatching method to match CGI names exactly,
315 * rather than doing a prefix match.
316 * - No longer need to count the length of the CGI handler names by hand.
317 * - Adding new handler for 404 error when disptching a CGI, if none of
318 * the handlers match.
319 * - Adding new handlers for CGI actionsfile editor.
321 * Revision 1.31 2001/10/10 10:56:39 oes
322 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
324 * Revision 1.30 2001/10/02 15:30:57 oes
325 * Introduced show-request cgi
327 * Revision 1.29 2001/09/20 15:47:44 steudten
329 * Fix BUG: Modify int size to size_t size in fill_template()
330 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
332 * Revision 1.28 2001/09/19 18:00:37 oes
333 * - Deletef time() FIXME (Can't fail under Linux either, if
334 * the argument is guaranteed to be in out address space,
337 * - Pointer notation cosmetics
338 * - Fixed a minor bug in template_fill(): Failiure of
339 * pcrs_execute() now secure.
341 * Revision 1.27 2001/09/16 17:08:54 jongfoster
342 * Moving simple CGI functions from cgi.c to new file cgisimple.c
344 * Revision 1.26 2001/09/16 15:47:37 jongfoster
345 * First version of CGI-based edit interface. This is very much a
346 * work-in-progress, and you can't actually use it to edit anything
347 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
348 * to have any effect.
350 * Revision 1.25 2001/09/16 15:02:35 jongfoster
351 * Adding i.j.b/robots.txt.
352 * Inlining add_stats() since it's only ever called from one place.
354 * Revision 1.24 2001/09/16 11:38:01 jongfoster
355 * Splitting fill_template() into 2 functions:
356 * template_load() loads the file
357 * template_fill() performs the PCRS regexps.
358 * This is because the CGI edit interface has a "table row"
359 * template which is used many times in the page - this
360 * change means it's only loaded from disk once.
362 * Revision 1.23 2001/09/16 11:16:05 jongfoster
363 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
365 * Revision 1.22 2001/09/16 11:00:10 jongfoster
366 * New function alloc_http_response, for symmetry with free_http_response
368 * Revision 1.21 2001/09/13 23:53:03 jongfoster
369 * Support for both static and dynamically generated CGI pages.
370 * Correctly setting Last-Modified: and Expires: HTTP headers.
372 * Revision 1.20 2001/09/13 23:40:36 jongfoster
373 * (Cosmetic only) Indentation correction
375 * Revision 1.19 2001/09/13 23:31:25 jongfoster
376 * Moving image data to cgi.c rather than cgi.h.
378 * Revision 1.18 2001/08/05 16:06:20 jongfoster
379 * Modifiying "struct map" so that there are now separate header and
380 * "map_entry" structures. This means that functions which modify a
381 * map no longer need to return a pointer to the modified map.
382 * Also, it no longer reverses the order of the entries (which may be
383 * important with some advanced template substitutions).
385 * Revision 1.17 2001/08/05 15:57:38 oes
386 * Adapted finish_http_response to new list_to_text
388 * Revision 1.16 2001/08/01 21:33:18 jongfoster
389 * Changes to fill_template() that reduce memory usage without having
390 * an impact on performance. I also renamed some variables so as not
391 * to clash with the C++ keywords "new" and "template".
393 * Revision 1.15 2001/08/01 21:19:22 jongfoster
394 * Moving file version information to a separate CGI page.
396 * Revision 1.14 2001/08/01 00:19:03 jongfoster
397 * New function: map_conditional() for an if-then-else syntax.
398 * Changing to use new version of show_defines()
400 * Revision 1.13 2001/07/30 22:08:36 jongfoster
401 * Tidying up #defines:
402 * - All feature #defines are now of the form FEATURE_xxx
403 * - Permanently turned off WIN_GUI_EDIT
404 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
406 * Revision 1.12 2001/07/29 18:47:05 jongfoster
407 * Adding missing #include "loadcfg.h"
409 * Revision 1.11 2001/07/18 17:24:37 oes
410 * Changed to conform to new pcrs interface
412 * Revision 1.10 2001/07/13 13:53:13 oes
413 * Removed all #ifdef PCRS and related code
415 * Revision 1.9 2001/06/29 21:45:41 oes
416 * Indentation, CRLF->LF, Tab-> Space
418 * Revision 1.8 2001/06/29 13:21:46 oes
419 * - Cosmetics: renamed and reordered functions, variables,
420 * texts, improved comments etc
422 * - Removed ij_untrusted_url() The relevant
423 * info is now part of the "untrusted" page,
424 * which is generated by filters.c:trust_url()
426 * - Generators of content now call finish_http_response()
427 * themselves, making jcc.c:chat() a little less
430 * - Removed obsolete "Pragma: no-cache" from our headers
432 * - http_responses now know their head length
434 * - fill_template now uses the new interface to pcrs, so that
435 * - long jobs (like whole files) no longer have to be assembled
436 * in a fixed size buffer
437 * - the new T (trivial) option is used, and the replacement may
438 * contain Perl syntax backrefs without confusing pcrs
440 * - Introduced default_exports() which generates a set of exports
441 * common to all CGIs and other content generators
443 * - Introduced convenience function map_block_killer()
445 * - Introduced convenience function make_menu()
447 * - Introduced CGI-like function error_response() which generates
448 * the "No such domain" and "Connect failed" messages using the
451 * - cgi_show_url_info:
452 * - adapted to new CGI features
453 * - form and answers now generated from same template
454 * - http:// prefix in URL now OK
457 * - adapted to new CGI features
458 * - no longer uses csp->init_proxy_args
461 * - moved menu generation to make_menu()
463 * - add_stats now writes single export map entries instead
466 * - Moved redirect_url() to filters.c
468 * - Fixed mem leak in free_http_response(), map_block_killer(),
470 * - Removed logentry from cancelled commit
472 * Revision 1.7 2001/06/09 10:51:58 jongfoster
473 * Changing "show URL info" handler to new style.
474 * Changing BUFSIZ ==> BUFFER_SIZE
476 * Revision 1.6 2001/06/07 23:05:19 jongfoster
477 * Removing code related to old forward and ACL files.
479 * Revision 1.5 2001/06/05 19:59:16 jongfoster
480 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
482 * Revision 1.4 2001/06/04 10:41:52 swa
483 * show version string of cgi.h and cgi.c
485 * Revision 1.3 2001/06/03 19:12:16 oes
486 * introduced new cgi handling
488 * No revisions before 1.3
490 **********************************************************************/
496 #include <sys/types.h>
504 #define snprintf _snprintf
505 #endif /* def _WIN32 */
513 #include "miscutil.h"
514 #include "cgisimple.h"
515 #ifdef FEATURE_CGI_EDIT_ACTIONS
517 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
519 /* loadcfg.h is for global_toggle_state only */
520 #ifdef FEATURE_PTHREAD
522 /* jcc.h is for mutex semaphore globals only */
523 #endif /* def FEATURE_PTHREAD */
524 const char cgi_h_rcs[] = CGI_H_VERSION;
527 * List of CGI functions: name, handler, description
528 * Note: Do NOT use single quotes in the description;
529 * this will break the dynamic "blocked" template!
531 static const struct cgi_dispatcher cgi_dispatchers[] = {
536 #ifdef FEATURE_GRACEFUL_TERMINATION
539 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
540 "this is a one click Denial Of Service attack!!!</em>",
545 #ifdef FEATURE_CGI_EDIT_ACTIONS
546 "View & change the current configuration",
548 "View the current configuration",
553 "View the source code version numbers",
557 "View the request headers.",
561 "Look up which actions apply to a URL and why",
563 #ifdef FEATURE_CGI_EDIT_ACTIONS
566 "Toggle Privoxy on or off",
568 { "edit-actions", /* Edit the actions list */
571 { "eaa", /* Shortcut for edit-actions-add-url-form */
572 cgi_edit_actions_add_url_form,
574 { "eau", /* Shortcut for edit-actions-url-form */
575 cgi_edit_actions_url_form,
577 { "ear", /* Shortcut for edit-actions-remove-url-form */
578 cgi_edit_actions_remove_url_form,
580 { "eal", /* Shortcut for edit-actions-list */
581 cgi_edit_actions_list,
583 { "eafu", /* Shortcut for edit-actions-for-url */
584 cgi_edit_actions_for_url,
586 { "eas", /* Shortcut for edit-actions-submit */
587 cgi_edit_actions_submit,
589 { "easa", /* Shortcut for edit-actions-section-add */
590 cgi_edit_actions_section_add,
592 { "easr", /* Shortcut for edit-actions-section-remove */
593 cgi_edit_actions_section_remove,
595 { "eass", /* Shortcut for edit-actions-section-swap */
596 cgi_edit_actions_section_swap,
598 { "edit-actions-for-url",
599 cgi_edit_actions_for_url,
600 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
601 { "edit-actions-list",
602 cgi_edit_actions_list,
603 NULL, TRUE /* Edit the actions list */ },
604 { "edit-actions-submit",
605 cgi_edit_actions_submit,
606 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
607 { "edit-actions-url",
608 cgi_edit_actions_url,
609 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
610 { "edit-actions-url-form",
611 cgi_edit_actions_url_form,
612 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
613 { "edit-actions-add-url",
614 cgi_edit_actions_add_url,
615 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
616 { "edit-actions-add-url-form",
617 cgi_edit_actions_add_url_form,
618 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
619 { "edit-actions-remove-url",
620 cgi_edit_actions_remove_url,
621 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
622 { "edit-actions-remove-url-form",
623 cgi_edit_actions_remove_url_form,
624 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
625 { "edit-actions-section-add",
626 cgi_edit_actions_section_add,
627 NULL, FALSE /* Remove a section from the actionsfile */ },
628 { "edit-actions-section-remove",
629 cgi_edit_actions_section_remove,
630 NULL, FALSE /* Remove a section from the actionsfile */ },
631 { "edit-actions-section-swap",
632 cgi_edit_actions_section_swap,
633 NULL, FALSE /* Swap two sections in the actionsfile */ },
634 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
637 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
640 NULL, TRUE /* Send a built-in image */ },
643 NULL, TRUE /* Send templates/cgi-style.css */ },
645 cgi_transparent_image,
646 NULL, TRUE /* Send a transparent image (short name) */ },
648 cgi_send_user_manual,
649 NULL, TRUE /* Send user-manual */ },
650 { NULL, /* NULL Indicates end of list and default page */
652 NULL, TRUE /* Unknown CGI page */ }
657 * Built-in images for ad replacement
659 * Hint: You can encode your own images like this:
660 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
663 #ifdef FEATURE_NO_GIFS
666 * Checkerboard pattern, as a PNG.
668 const char image_pattern_data[] =
669 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
670 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
671 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
672 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
673 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
674 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
675 "\000\000\000\111\105\116\104\256\102\140\202";
678 * 1x1 transparant PNG.
680 const char image_blank_data[] =
681 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
682 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
683 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
684 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
685 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
686 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
687 "\000\000\000\000\111\105\116\104\256\102\140\202";
691 * Checkerboard pattern, as a GIF.
693 const char image_pattern_data[] =
694 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
695 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
696 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
697 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
701 * 1x1 transparant GIF.
703 const char image_blank_data[] =
704 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
705 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
706 "\000\001\000\000\002\002D\001\000;";
709 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
710 const size_t image_blank_length = sizeof(image_blank_data) - 1;
713 static struct http_response cgi_error_memory_response[1];
715 static struct http_response *dispatch_known_cgi(struct client_state * csp,
717 static struct map *parse_cgi_parameters(char *argstring);
720 /*********************************************************************
722 * Function : dispatch_cgi
724 * Description : Checks if a request URL has either the magical
725 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
726 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
727 * http://config.privoxy.org/). If so, it passes
728 * the (rest of the) path onto dispatch_known_cgi, which
729 * calls the relevant CGI handler function.
732 * 1 : csp = Current client state (buffers, headers, etc...)
734 * Returns : http_response if match, NULL if nonmatch or handler fail
736 *********************************************************************/
737 struct http_response *dispatch_cgi(struct client_state *csp)
739 const char *host = csp->http->host;
740 const char *path = csp->http->path;
743 * Should we intercept ?
746 /* Note: "example.com" and "example.com." are equivalent hostnames. */
748 /* Either the host matches CGI_SITE_1_HOST ..*/
749 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
750 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
751 && (path[0] == '/') )
753 /* ..then the path will all be for us. Remove leading '/' */
756 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
757 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
758 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
759 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
761 /* take everything following CGI_SITE_2_PATH */
762 path += strlen(CGI_SITE_2_PATH);
765 /* skip the forward slash after CGI_SITE_2_PATH */
768 else if (*path != '\0')
771 * weirdness: URL is /configXXX, where XXX is some string
772 * Do *NOT* intercept.
784 * This is a CGI call.
787 return dispatch_known_cgi(csp, path);
791 /*********************************************************************
793 * Function : grep_cgi_referrer
795 * Description : Ugly provisorical fix that greps the value of the
796 * referer HTTP header field out of a linked list of
797 * strings like found at csp->headers. Will disappear
800 * FIXME: csp->headers ought to be csp->http->headers
801 * FIXME: Parsing all client header lines should
802 * happen right after the request is received!
805 * 1 : csp = Current client state (buffers, headers, etc...)
807 * Returns : pointer to value (no copy!), or NULL if none found.
809 *********************************************************************/
810 char *grep_cgi_referrer(struct client_state *csp)
812 struct list_entry *p;
814 for (p = csp->headers->first; p != NULL; p = p->next)
816 if (p->str == NULL) continue;
817 if (strncmpic(p->str, "Referer: ", 9) == 0)
819 return ((p->str) + 9);
827 /*********************************************************************
829 * Function : dispatch_known_cgi
831 * Description : Processes a CGI once dispatch_cgi has determined that
832 * it matches one of the magic prefixes. Parses the path
833 * as a cgi name plus query string, prepares a map that
834 * maps CGI parameter names to their values, initializes
835 * the http_response struct, and calls the relevant CGI
839 * 1 : csp = Current client state (buffers, headers, etc...)
840 * 2 : path = Path of CGI, with the CGI prefix removed.
841 * Should not have a leading "/".
843 * Returns : http_response, or NULL on handler failure or out of
846 *********************************************************************/
847 static struct http_response *dispatch_known_cgi(struct client_state * csp,
850 const struct cgi_dispatcher *d;
851 struct map *param_list;
852 struct http_response *rsp;
853 char *query_args_start;
858 if (NULL == (path_copy = strdup(path)))
860 return cgi_error_memory();
862 query_args_start = path_copy;
863 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
867 if (*query_args_start == '/')
869 *query_args_start++ = '\0';
870 if ((param_list = new_map()))
872 map(param_list, "file", 1, url_decode(query_args_start), 0);
877 if (*query_args_start == '?')
879 *query_args_start++ = '\0';
881 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
884 return cgi_error_memory();
890 * path_copy = CGI call name
891 * param_list = CGI params, as map
894 /* Get mem for response or fail*/
895 if (NULL == (rsp = alloc_http_response()))
898 free_map(param_list);
899 return cgi_error_memory();
902 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
903 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
904 csp->ip_addr_str, csp->http->cmd);
907 * Find and start the right CGI function
912 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
915 * If the called CGI is either harmless, or referred
916 * from a trusted source, start it.
919 || ((NULL != (referrer = grep_cgi_referrer(csp)))
920 && (0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)))
923 err = (d->handler)(csp, rsp, param_list);
928 * Else, modify toggle calls so that they only display
929 * the status, and deny all other calls.
931 if (0 == strcmp(path_copy, "toggle"))
933 unmap(param_list, "set");
934 err = (d->handler)(csp, rsp, param_list);
938 err = cgi_error_disabled(csp, rsp);
943 free_map(param_list);
945 if (err == JB_ERR_CGI_PARAMS)
947 err = cgi_error_bad_param(csp, rsp);
949 if (err && (err != JB_ERR_MEMORY))
951 /* Unexpected error! Shouldn't get here */
952 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
953 err = cgi_error_unknown(csp, rsp, err);
958 return finish_http_response(rsp);
962 /* Error in handler, probably out-of-memory */
963 free_http_response(rsp);
964 return cgi_error_memory();
972 /*********************************************************************
974 * Function : parse_cgi_parameters
976 * Description : Parse a URL-encoded argument string into name/value
977 * pairs and store them in a struct map list.
980 * 1 : argstring = string to be parsed. Will be trashed.
982 * Returns : pointer to param list, or NULL if out of memory.
984 *********************************************************************/
985 static struct map *parse_cgi_parameters(char *argstring)
988 char *vector[BUFFER_SIZE];
990 struct map *cgi_params;
992 if (NULL == (cgi_params = new_map()))
998 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
999 * the fragment identifier along with the request, so we must
1000 * cut it off here, so it won't pollute the CGI params:
1002 if (NULL != (p = strchr(argstring, '#')))
1007 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1009 for (i = 0; i < pairs; i++)
1011 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1014 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1016 free_map(cgi_params);
1027 /*********************************************************************
1029 * Function : get_char_param
1031 * Description : Get a single-character parameter passed to a CGI
1035 * 1 : parameters = map of cgi parameters
1036 * 2 : param_name = The name of the parameter to read
1038 * Returns : Uppercase character on success, '\0' on error.
1040 *********************************************************************/
1041 char get_char_param(const struct map *parameters,
1042 const char *param_name)
1049 ch = *(lookup(parameters, param_name));
1050 if ((ch >= 'a') && (ch <= 'z'))
1052 ch = ch - 'a' + 'A';
1059 /*********************************************************************
1061 * Function : get_string_param
1063 * Description : Get a string paramater, to be used as an
1064 * ACTION_STRING or ACTION_MULTI paramater.
1065 * Validates the input to prevent stupid/malicious
1066 * users from corrupting their action file.
1069 * 1 : parameters = map of cgi parameters
1070 * 2 : param_name = The name of the parameter to read
1071 * 3 : pparam = destination for paramater. Allocated as
1072 * part of the map "parameters", so don't free it.
1073 * Set to NULL if not specified.
1075 * Returns : JB_ERR_OK on success, or if the paramater
1076 * was not specified.
1077 * JB_ERR_MEMORY on out-of-memory.
1078 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1080 *********************************************************************/
1081 jb_err get_string_param(const struct map *parameters,
1082 const char *param_name,
1083 const char **pparam)
1095 param = lookup(parameters, param_name);
1101 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1106 * Note that the length limit is arbitrary, it just seems
1107 * sensible to limit it to *something*. There's no
1108 * technical reason for any limit at all.
1110 return JB_ERR_CGI_PARAMS;
1113 /* Check every character to see if it's legal */
1115 while ((ch = *s++) != '\0')
1117 if ( ((unsigned char)ch < (unsigned char)' ')
1120 /* Probable hack attempt, or user accidentally used '}'. */
1121 return JB_ERR_CGI_PARAMS;
1132 /*********************************************************************
1134 * Function : get_number_param
1136 * Description : Get a non-negative integer from the parameters
1137 * passed to a CGI function.
1140 * 1 : csp = Current client state (buffers, headers, etc...)
1141 * 2 : parameters = map of cgi parameters
1142 * 3 : name = Name of CGI parameter to read
1143 * 4 : pvalue = destination for value.
1144 * Set to -1 on error.
1146 * Returns : JB_ERR_OK on success
1147 * JB_ERR_MEMORY on out-of-memory
1148 * JB_ERR_CGI_PARAMS if the parameter was not specified
1151 *********************************************************************/
1152 jb_err get_number_param(struct client_state *csp,
1153 const struct map *parameters,
1168 param = lookup(parameters, name);
1171 return JB_ERR_CGI_PARAMS;
1174 /* We don't use atoi because I want to check this carefully... */
1177 while ((ch = *param++) != '\0')
1179 if ((ch < '0') || (ch > '9'))
1181 return JB_ERR_CGI_PARAMS;
1188 * <limits.h> defines UINT_MAX
1190 * (UINT_MAX - ch) / 10 is the largest number that
1191 * can be safely multiplied by 10 then have ch added.
1193 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1195 return JB_ERR_CGI_PARAMS;
1198 value = value * 10 + ch;
1209 /*********************************************************************
1211 * Function : error_response
1213 * Description : returns an http_response that explains the reason
1214 * why a request failed.
1217 * 1 : csp = Current client state (buffers, headers, etc...)
1218 * 2 : templatename = Which template should be used for the answer
1219 * 3 : sys_err = system error number
1221 * Returns : A http_response. If we run out of memory, this
1222 * will be cgi_error_memory().
1224 *********************************************************************/
1225 struct http_response *error_response(struct client_state *csp,
1226 const char *templatename,
1230 struct http_response *rsp;
1231 struct map * exports = default_exports(csp, NULL);
1232 if (exports == NULL)
1234 return cgi_error_memory();
1237 if (NULL == (rsp = alloc_http_response()))
1240 return cgi_error_memory();
1243 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1244 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1245 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1246 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1247 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1250 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1253 /* Some failures, like "404 no such domain", don't have an IP address. */
1254 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1262 free_http_response(rsp);
1263 return cgi_error_memory();
1266 if (!strcmp(templatename, "no-such-domain"))
1268 rsp->status = strdup("404 No such domain");
1269 if (rsp->status == NULL)
1272 free_http_response(rsp);
1273 return cgi_error_memory();
1276 else if (!strcmp(templatename, "connect-failed"))
1278 rsp->status = strdup("503 Connect failed");
1279 if (rsp->status == NULL)
1282 free_http_response(rsp);
1283 return cgi_error_memory();
1287 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1290 free_http_response(rsp);
1291 return cgi_error_memory();
1294 return finish_http_response(rsp);
1298 /*********************************************************************
1300 * Function : cgi_error_disabled
1302 * Description : CGI function that is called to generate an error
1303 * response if the actions editor or toggle CGI are
1304 * accessed despite having being disabled at compile-
1308 * 1 : csp = Current client state (buffers, headers, etc...)
1309 * 2 : rsp = http_response data structure for output
1311 * CGI Parameters : none
1313 * Returns : JB_ERR_OK on success
1314 * JB_ERR_MEMORY on out-of-memory error.
1316 *********************************************************************/
1317 jb_err cgi_error_disabled(struct client_state *csp,
1318 struct http_response *rsp)
1320 struct map *exports;
1325 if (NULL == (exports = default_exports(csp, NULL)))
1327 return JB_ERR_MEMORY;
1330 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1334 /*********************************************************************
1336 * Function : cgi_init_error_messages
1338 * Description : Call at the start of the program to initialize
1339 * the error message used by cgi_error_memory().
1345 *********************************************************************/
1346 void cgi_init_error_messages(void)
1348 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1349 cgi_error_memory_response->head =
1350 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1351 "Content-Type: text/html\r\n"
1353 cgi_error_memory_response->body =
1355 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1357 "<h1>500 Internal Privoxy Error</h1>\r\n"
1358 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1359 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1363 cgi_error_memory_response->head_length =
1364 strlen(cgi_error_memory_response->head);
1365 cgi_error_memory_response->content_length =
1366 strlen(cgi_error_memory_response->body);
1370 /*********************************************************************
1372 * Function : cgi_error_memory
1374 * Description : Called if a CGI function runs out of memory.
1375 * Returns a statically-allocated error response.
1379 * Returns : http_response data structure for output. This is
1380 * statically allocated, for obvious reasons.
1382 *********************************************************************/
1383 struct http_response *cgi_error_memory(void)
1385 /* assert that it's been initialized. */
1386 assert(cgi_error_memory_response->head);
1388 return cgi_error_memory_response;
1392 /*********************************************************************
1394 * Function : cgi_error_no_template
1396 * Description : Almost-CGI function that is called if a template
1397 * cannot be loaded. Note this is not a true CGI,
1398 * it takes a template name rather than a map of
1402 * 1 : csp = Current client state (buffers, headers, etc...)
1403 * 2 : rsp = http_response data structure for output
1404 * 3 : template_name = Name of template that could not
1407 * Returns : JB_ERR_OK on success
1408 * JB_ERR_MEMORY on out-of-memory error.
1410 *********************************************************************/
1411 jb_err cgi_error_no_template(struct client_state *csp,
1412 struct http_response *rsp,
1413 const char *template_name)
1415 static const char status[] =
1416 "500 Internal Privoxy Error";
1417 static const char body_prefix[] =
1419 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1421 "<h1>500 Internal Privoxy Error</h1>\r\n"
1422 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1423 "<p><b>Could not load template file <code>";
1424 static const char body_suffix[] =
1425 "</code> or one of it's included components.</b></p>\r\n"
1426 "<p>Please contact your proxy administrator.</p>\r\n"
1427 "<p>If you are the proxy administrator, please put the required file(s)"
1428 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1429 "location of the <code><i>(confdir)</i></code> directory "
1430 "is specified in the main Privoxy <code>config</code> "
1431 "file. (It's typically the Privoxy install directory"
1433 ", or <code>/etc/privoxy/</code>"
1434 #endif /* ndef _WIN32 */
1441 assert(template_name);
1443 /* Reset rsp, if needed */
1447 rsp->content_length = 0;
1448 rsp->head_length = 0;
1451 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1452 if (rsp->body == NULL)
1454 return JB_ERR_MEMORY;
1456 strcpy(rsp->body, body_prefix);
1457 strcat(rsp->body, template_name);
1458 strcat(rsp->body, body_suffix);
1460 rsp->status = strdup(status);
1461 if (rsp->body == NULL)
1463 return JB_ERR_MEMORY;
1470 /*********************************************************************
1472 * Function : cgi_error_unknown
1474 * Description : Almost-CGI function that is called if an unexpected
1475 * error occurs in the top-level CGI dispatcher.
1476 * In this context, "unexpected" means "anything other
1477 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1478 * expected to handle all other errors internally,
1479 * since they can give more relavent error messages
1482 * Note this is not a true CGI, it takes an error
1483 * code rather than a map of parameters.
1486 * 1 : csp = Current client state (buffers, headers, etc...)
1487 * 2 : rsp = http_response data structure for output
1488 * 3 : error_to_report = Error code to report.
1490 * Returns : JB_ERR_OK on success
1491 * JB_ERR_MEMORY on out-of-memory error.
1493 *********************************************************************/
1494 jb_err cgi_error_unknown(struct client_state *csp,
1495 struct http_response *rsp,
1496 jb_err error_to_report)
1498 static const char status[] =
1499 "500 Internal Privoxy Error";
1500 static const char body_prefix[] =
1502 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1504 "<h1>500 Internal Privoxy Error</h1>\r\n"
1505 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1506 "<p><b>Unexpected internal error: ";
1507 static const char body_suffix[] =
1510 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1511 "file a bug report</a>.</p>\r\n"
1518 /* Reset rsp, if needed */
1522 rsp->content_length = 0;
1523 rsp->head_length = 0;
1526 sprintf(errnumbuf, "%d", error_to_report);
1528 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1529 if (rsp->body == NULL)
1531 return JB_ERR_MEMORY;
1533 strcpy(rsp->body, body_prefix);
1534 strcat(rsp->body, errnumbuf);
1535 strcat(rsp->body, body_suffix);
1537 rsp->status = strdup(status);
1538 if (rsp->body == NULL)
1540 return JB_ERR_MEMORY;
1547 /*********************************************************************
1549 * Function : cgi_error_bad_param
1551 * Description : CGI function that is called if the parameters
1552 * (query string) for a CGI were wrong.
1555 * 1 : csp = Current client state (buffers, headers, etc...)
1556 * 2 : rsp = http_response data structure for output
1558 * CGI Parameters : none
1560 * Returns : JB_ERR_OK on success
1561 * JB_ERR_MEMORY on out-of-memory error.
1563 *********************************************************************/
1564 jb_err cgi_error_bad_param(struct client_state *csp,
1565 struct http_response *rsp)
1567 struct map *exports;
1572 if (NULL == (exports = default_exports(csp, NULL)))
1574 return JB_ERR_MEMORY;
1577 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1581 /*********************************************************************
1583 * Function : cgi_redirect
1585 * Description : CGI support function to generate a HTTP redirect
1589 * 1 : rsp = http_response data structure for output
1590 * 2 : target = string with the target URL
1592 * CGI Parameters : None
1594 * Returns : JB_ERR_OK on success
1595 * JB_ERR_MEMORY on out-of-memory error.
1597 *********************************************************************/
1598 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1605 err = enlist_unique_header(rsp->headers, "Location", target);
1607 rsp->status = strdup("302 Local Redirect from Privoxy");
1608 if (rsp->status == NULL)
1610 return JB_ERR_MEMORY;
1617 /*********************************************************************
1619 * Function : add_help_link
1621 * Description : Produce a copy of the string given as item,
1622 * embedded in an HTML link to its corresponding
1623 * section (item name in uppercase) in the actions
1624 * chapter of the user manual, (whose URL is given in
1625 * the config and defaults to our web site).
1627 * FIXME: I currently only work for actions, and would
1628 * like to be generalized for other topics.
1631 * 1 : item = item (will NOT be free()d.)
1632 * It is assumed to be HTML-safe.
1633 * 2 : config = The current configuration.
1635 * Returns : String with item embedded in link, or NULL on
1638 *********************************************************************/
1639 char *add_help_link(const char *item,
1640 struct configuration_spec *config)
1644 if (!item) return NULL;
1646 result = strdup("<a href=\"");
1647 if (!strncmpic(config->usermanual, "file://", 7) ||
1648 !strncmpic(config->usermanual, "http", 4))
1650 string_append(&result, config->usermanual);
1654 string_append(&result, "http://");
1655 string_append(&result, CGI_SITE_2_HOST);
1656 string_append(&result, "/user-manual/");
1658 string_append(&result, ACTIONS_HELP_PREFIX);
1659 string_join (&result, string_toupper(item));
1660 string_append(&result, "\">");
1661 string_append(&result, item);
1662 string_append(&result, "</a> ");
1668 /*********************************************************************
1670 * Function : get_http_time
1672 * Description : Get the time in a format suitable for use in a
1673 * HTTP header - e.g.:
1674 * "Sun, 06 Nov 1994 08:49:37 GMT"
1677 * 1 : time_offset = Time returned will be current time
1678 * plus this number of seconds.
1679 * 2 : buf = Destination for result. Must be long enough
1680 * to hold 29 characters plus a trailing zero.
1684 *********************************************************************/
1685 void get_http_time(int time_offset, char *buf)
1687 static const char day_names[7][4] =
1688 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1689 static const char month_names[12][4] =
1690 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1691 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1694 time_t current_time;
1695 #if defined(HAVE_GMTIME_R)
1697 * Declare dummy up here (instead of inside get/set gmt block) so it
1698 * doesn't go out of scope before it's potentially used in snprintf later.
1699 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1700 * !defined HAVE_GMTIME_R.
1707 time(¤t_time); /* get current time */
1709 current_time += time_offset;
1711 /* get and save the gmt */
1714 t = gmtime_r(¤t_time, &dummy);
1715 #elif FEATURE_PTHREAD
1716 pthread_mutex_lock(&gmtime_mutex);
1717 t = gmtime(¤t_time);
1718 pthread_mutex_unlock(&gmtime_mutex);
1720 t = gmtime(¤t_time);
1724 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1726 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1727 day_names[t->tm_wday],
1729 month_names[t->tm_mon],
1739 /*********************************************************************
1741 * Function : finish_http_response
1743 * Description : Fill in the missing headers in an http response,
1744 * and flatten the headers to an http head.
1747 * 1 : rsp = pointer to http_response to be processed
1749 * Returns : A http_response, usually the rsp parameter.
1750 * On error, free()s rsp and returns cgi_error_memory()
1752 *********************************************************************/
1753 struct http_response *finish_http_response(struct http_response *rsp)
1755 char buf[BUFFER_SIZE];
1758 /* Special case - do NOT change this statically allocated response,
1759 * which is ready for output anyway.
1761 if (rsp == cgi_error_memory_response)
1767 * Fill in the HTTP Status
1769 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1770 err = enlist_first(rsp->headers, buf);
1773 * Set the Content-Length
1775 if (rsp->content_length == 0)
1777 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1781 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1782 err = enlist(rsp->headers, buf);
1785 if (strncmpic(rsp->status, "302", 3))
1788 * If it's not a redirect without any content,
1789 * set the Content-Type to text/html if it's
1790 * not already specified.
1792 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1796 * Fill in the rest of the default headers:
1798 * Date: set to current date/time.
1799 * Last-Modified: set to date/time the page was last changed.
1800 * Expires: set to date/time page next needs reloading.
1801 * Cache-Control: set to "no-cache" if applicable.
1803 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1808 * Set Expires to about 10 min into the future so it'll get reloaded
1809 * occasionally, e.g. if Privoxy gets upgraded.
1814 get_http_time(0, buf);
1815 err = enlist_unique_header(rsp->headers, "Date", buf);
1818 /* Some date in the past. */
1819 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1823 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1824 err = enlist_unique_header(rsp->headers, "Expires", buf);
1827 else if (!strncmpic(rsp->status, "302", 3))
1829 get_http_time(0, buf);
1830 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1835 * Setting "Cache-Control" to "no-cache" and "Expires" to
1836 * the current time doesn't exactly forbid caching, it just
1837 * requires the client to revalidate the cached copy.
1839 * If a temporary problem occurs and the user tries again after
1840 * getting Privoxy's error message, a compliant browser may set the
1841 * If-Modified-Since header with the content of the error page's
1842 * Last-Modified header. More often than not, the document on the server
1843 * is older than Privoxy's error message, the server would send status code
1844 * 304 and the browser would display the outdated error message again and again.
1846 * For documents delivered with status code 404 or 503 we set "Last-Modified"
1847 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
1848 * and can be safely used to "revalidate" without getting a status code 304.
1850 * There is no need to let the useless If-Modified-Since header reach the
1851 * server, it is therefore stripped by client_if_modified_since in parsers.c.
1853 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1855 get_http_time(0, buf);
1856 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1857 if (!strncmpic(rsp->status, "404", 3) || !strncmpic(rsp->status, "503", 3))
1859 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
1863 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1865 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
1866 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
1872 * HTTP/1.1 applications that do not support persistent connections MUST
1873 * include the "close" connection option in every message.
1875 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
1880 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1882 free_http_response(rsp);
1883 return cgi_error_memory();
1885 rsp->head_length = strlen(rsp->head);
1892 /*********************************************************************
1894 * Function : alloc_http_response
1896 * Description : Allocates a new http_response structure.
1900 * Returns : pointer to a new http_response, or NULL.
1902 *********************************************************************/
1903 struct http_response *alloc_http_response(void)
1905 return (struct http_response *) zalloc(sizeof(struct http_response));
1910 /*********************************************************************
1912 * Function : free_http_response
1914 * Description : Free the memory occupied by an http_response
1915 * and its depandant structures.
1918 * 1 : rsp = pointer to http_response to be freed
1922 *********************************************************************/
1923 void free_http_response(struct http_response *rsp)
1926 * Must special case cgi_error_memory_response, which is never freed.
1928 if (rsp && (rsp != cgi_error_memory_response))
1933 destroy_list(rsp->headers);
1940 /*********************************************************************
1942 * Function : template_load
1944 * Description : CGI support function that loads a given HTML
1945 * template from the confdir, ignoring comment
1946 * lines and following #include statements up to
1950 * 1 : csp = Current client state (buffers, headers, etc...)
1951 * 2 : template_ptr = Destination for pointer to loaded
1953 * 3 : templatename = name of the HTML template to be used
1954 * 4 : recursive = Flag set if this function calls itself
1955 * following an #include statament
1957 * Returns : JB_ERR_OK on success
1958 * JB_ERR_MEMORY on out-of-memory error.
1959 * JB_ERR_FILE if the template file cannot be read
1961 *********************************************************************/
1962 jb_err template_load(struct client_state *csp, char **template_ptr,
1963 const char *templatename, int recursive)
1966 char *templates_dir_path;
1969 char *included_module;
1972 char buf[BUFFER_SIZE];
1975 assert(template_ptr);
1976 assert(templatename);
1978 *template_ptr = NULL;
1980 /* Validate template name. Paranoia. */
1981 for (p = templatename; *p != 0; p++)
1983 if ( ((*p < 'a') || (*p > 'z'))
1984 && ((*p < 'A') || (*p > 'Z'))
1985 && ((*p < '0') || (*p > '9'))
1989 /* Illegal character */
1994 /* Generate full path */
1996 templates_dir_path = make_path(csp->config->confdir, "templates");
1997 if (templates_dir_path == NULL)
1999 return JB_ERR_MEMORY;
2002 full_path = make_path(templates_dir_path, templatename);
2003 free(templates_dir_path);
2004 if (full_path == NULL)
2006 return JB_ERR_MEMORY;
2009 /* Allocate buffer */
2011 file_buffer = strdup("");
2012 if (file_buffer == NULL)
2015 return JB_ERR_MEMORY;
2018 /* Open template file */
2020 if (NULL == (fp = fopen(full_path, "r")))
2022 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2030 * Read the file, ignoring comments, and honoring #include
2031 * statements, unless we're already called recursively.
2033 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2034 * This is unlikely in practise.
2036 while (fgets(buf, BUFFER_SIZE, fp))
2038 if (!recursive && !strncmp(buf, "#include ", 9))
2040 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2047 if (string_join(&file_buffer, included_module))
2050 return JB_ERR_MEMORY;
2056 /* skip lines starting with '#' */
2062 if (string_append(&file_buffer, buf))
2065 return JB_ERR_MEMORY;
2070 *template_ptr = file_buffer;
2076 /*********************************************************************
2078 * Function : template_fill
2080 * Description : CGI support function that fills in a pre-loaded
2081 * HTML template by replacing @name@ with value using
2082 * pcrs, for each item in the output map.
2084 * Note that a leading '$' charachter in the export map's
2085 * values will be stripped and toggle on backreference
2089 * 1 : template_ptr = IN: Template to be filled out.
2091 * OUT: Filled out template.
2092 * Caller must free().
2093 * 2 : exports = map with fill in symbol -> name pairs
2095 * Returns : JB_ERR_OK on success
2096 * JB_ERR_MEMORY on out-of-memory error
2098 *********************************************************************/
2099 jb_err template_fill(char **template_ptr, const struct map *exports)
2101 struct map_entry *m;
2103 char buf[BUFFER_SIZE];
2104 char *tmp_out_buffer;
2110 assert(template_ptr);
2111 assert(*template_ptr);
2114 file_buffer = *template_ptr;
2115 size = strlen(file_buffer) + 1;
2118 * Assemble pcrs joblist from exports map
2120 for (m = exports->first; m != NULL; m = m->next)
2122 if (*m->name == '$')
2125 * First character of name is '$', so remove this flag
2126 * character and allow backreferences ($1 etc) in the
2127 * "replace with" text.
2129 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2135 * Treat the "replace with" text as a literal string -
2136 * no quoting needed, no backreferences allowed.
2137 * ("Trivial" ['T'] flag).
2141 /* Enclose name in @@ */
2142 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2146 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2148 /* Make and run job. */
2149 job = pcrs_compile(buf, m->value, flags, &error);
2152 if (error == PCRS_ERR_NOMEM)
2155 *template_ptr = NULL;
2156 return JB_ERR_MEMORY;
2160 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2161 /* Hope it wasn't important and silently ignore the invalid job */
2166 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2169 if (NULL == tmp_out_buffer)
2171 *template_ptr = NULL;
2172 return JB_ERR_MEMORY;
2174 file_buffer = tmp_out_buffer;
2181 *template_ptr = file_buffer;
2186 /*********************************************************************
2188 * Function : template_fill_for_cgi
2190 * Description : CGI support function that loads a HTML template
2191 * and fills it in. Handles file-not-found errors
2192 * by sending a HTML error message. For convenience,
2193 * this function also frees the passed "exports" map.
2196 * 1 : csp = Client state
2197 * 2 : templatename = name of the HTML template to be used
2198 * 3 : exports = map with fill in symbol -> name pairs.
2199 * Will be freed by this function.
2200 * 4 : rsp = Response structure to fill in.
2202 * Returns : JB_ERR_OK on success
2203 * JB_ERR_MEMORY on out-of-memory error
2205 *********************************************************************/
2206 jb_err template_fill_for_cgi(struct client_state *csp,
2207 const char *templatename,
2208 struct map *exports,
2209 struct http_response *rsp)
2214 assert(templatename);
2218 err = template_load(csp, &rsp->body, templatename, 0);
2219 if (err == JB_ERR_FILE)
2222 return cgi_error_no_template(csp, rsp, templatename);
2227 return err; /* JB_ERR_MEMORY */
2229 err = template_fill(&rsp->body, exports);
2235 /*********************************************************************
2237 * Function : default_exports
2239 * Description : returns a struct map list that contains exports
2240 * which are common to all CGI functions.
2243 * 1 : csp = Current client state (buffers, headers, etc...)
2244 * 2 : caller = name of CGI who calls us and which should
2245 * be excluded from the generated menu. May be
2247 * Returns : NULL if no memory, else a new map. Caller frees.
2249 *********************************************************************/
2250 struct map *default_exports(const struct client_state *csp, const char *caller)
2254 struct map * exports;
2255 int local_help_exists = 0;
2259 exports = new_map();
2260 if (exports == NULL)
2265 err = map(exports, "version", 1, html_encode(VERSION), 0);
2266 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2267 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2268 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2269 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2270 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
2271 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2272 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2273 !strncmpic(csp->config->usermanual, "http", 4))
2275 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2279 if (!err) err = map(exports, "user-manual", 1, "http://"CGI_SITE_2_HOST"/user-manual/" ,1);
2281 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2282 #ifdef FEATURE_TOGGLE
2283 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2285 if (!err) err = map_block_killer(exports, "can-toggle");
2288 snprintf(buf, 20, "%d", csp->config->hport);
2289 if (!err) err = map(exports, "my-port", 1, buf, 1);
2291 if(!strcmp(CODE_STATUS, "stable"))
2293 if (!err) err = map_block_killer(exports, "unstable");
2296 if (csp->config->admin_address != NULL)
2298 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2299 local_help_exists = 1;
2303 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2306 if (csp->config->proxy_info_url != NULL)
2308 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2309 local_help_exists = 1;
2313 if (!err) err = map_block_killer(exports, "have-proxy-info");
2316 if (local_help_exists == 0)
2318 if (!err) err = map_block_killer(exports, "have-help-info");
2331 /*********************************************************************
2333 * Function : map_block_killer
2335 * Description : Convenience function.
2336 * Adds a "killer" for the conditional HTML-template
2337 * block <name>, i.e. a substitution of the regex
2338 * "if-<name>-start.*if-<name>-end" to the given
2342 * 1 : exports = map to extend
2343 * 2 : name = name of conditional block
2345 * Returns : JB_ERR_OK on success
2346 * JB_ERR_MEMORY on out-of-memory error.
2348 *********************************************************************/
2349 jb_err map_block_killer(struct map *exports, const char *name)
2351 char buf[1000]; /* Will do, since the names are hardwired */
2355 assert(strlen(name) < 490);
2357 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2358 return map(exports, buf, 1, "", 1);
2362 /*********************************************************************
2364 * Function : map_block_keep
2366 * Description : Convenience function. Removes the markers used
2367 * by map-block-killer, to save a few bytes.
2368 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2371 * 1 : exports = map to extend
2372 * 2 : name = name of conditional block
2374 * Returns : JB_ERR_OK on success
2375 * JB_ERR_MEMORY on out-of-memory error.
2377 *********************************************************************/
2378 jb_err map_block_keep(struct map *exports, const char *name)
2381 char buf[500]; /* Will do, since the names are hardwired */
2385 assert(strlen(name) < 490);
2387 snprintf(buf, 500, "if-%s-start", name);
2388 err = map(exports, buf, 1, "", 1);
2395 snprintf(buf, 500, "if-%s-end", name);
2396 return map(exports, buf, 1, "", 1);
2400 /*********************************************************************
2402 * Function : map_conditional
2404 * Description : Convenience function.
2405 * Adds an "if-then-else" for the conditional HTML-template
2406 * block <name>, i.e. a substitution of the form:
2413 * The control structure and one of the alternatives
2417 * 1 : exports = map to extend
2418 * 2 : name = name of conditional block
2419 * 3 : choose_first = nonzero for first, zero for second.
2421 * Returns : JB_ERR_OK on success
2422 * JB_ERR_MEMORY on out-of-memory error.
2424 *********************************************************************/
2425 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2427 char buf[1000]; /* Will do, since the names are hardwired */
2432 assert(strlen(name) < 480);
2434 snprintf(buf, 1000, (choose_first
2435 ? "else-not-%s@.*@endif-%s"
2436 : "if-%s-then@.*@else-not-%s"),
2439 err = map(exports, buf, 1, "", 1);
2445 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2446 return map(exports, buf, 1, "", 1);
2450 /*********************************************************************
2452 * Function : make_menu
2454 * Description : Returns an HTML-formatted menu of the available
2455 * unhidden CGIs, excluding the one given in <self>
2457 * Parameters : self = name of CGI to leave out, can be NULL for
2460 * Returns : menu string, or NULL on out-of-memory error.
2462 *********************************************************************/
2463 char *make_menu(const char *self)
2465 const struct cgi_dispatcher *d;
2466 char *result = strdup("");
2470 self = "NO-SUCH-CGI!";
2473 /* List available unhidden CGI's and export as "other-cgis" */
2474 for (d = cgi_dispatchers; d->name; d++)
2476 if (d->description && strcmp(d->name, self))
2478 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2479 string_append(&result, d->name);
2480 string_append(&result, "\">");
2481 string_append(&result, d->description);
2482 string_append(&result, "</a></li>");
2490 /*********************************************************************
2492 * Function : dump_map
2494 * Description : HTML-dump a map for debugging (as table)
2497 * 1 : the_map = map to dump
2499 * Returns : string with HTML
2501 *********************************************************************/
2502 char *dump_map(const struct map *the_map)
2504 struct map_entry *cur_entry;
2505 char *ret = strdup("");
2507 string_append(&ret, "<table>\n");
2509 for (cur_entry = the_map->first;
2510 (cur_entry != NULL) && (ret != NULL);
2511 cur_entry = cur_entry->next)
2513 string_append(&ret, "<tr><td><b>");
2514 string_join (&ret, html_encode(cur_entry->name));
2515 string_append(&ret, "</b></td><td>");
2516 string_join (&ret, html_encode(cur_entry->value));
2517 string_append(&ret, "</td></tr>\n");
2520 string_append(&ret, "</table>\n");