1 const char cgi_rcs[] = "$Id: cgi.c,v 1.102 2008/02/23 16:33:43 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-2004, 2006-2007
15 * the SourceForge 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.102 2008/02/23 16:33:43 fabiankeil
42 * Let forward_url() use the standard parameter ordering
43 * and mark its second parameter immutable.
45 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
46 * Add SOCKS5 support for "Forwarding failure" CGI page.
48 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
49 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
52 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
53 * #1763173 from Stefan Huehner: declare some more functions static.
55 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
56 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
58 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
59 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
61 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
62 * Use sizeof() more often.
64 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
65 * Don't overlook map result for the forwarding-type.
67 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
68 * Use a transparent background for the PNG replacement pattern.
70 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
71 * - Save the reason for generating http_responses.
72 * - Fix --disable-toggle (again).
73 * - Use TBL birthday hack for 403 responses as well.
74 * - Uglify the @menu@ again to fix JavaScript
75 * errors on the "blocked" template.
76 * - Escape an ampersand in cgi_error_unknown().
78 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
79 * - Add HEAD support to finish_http_response.
80 * - Add error favicon to internal HTML error messages.
82 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
83 * Add new config option "templdir" to
84 * change the templates directory.
86 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
87 * Added "forwarding-failed" template support for error_response().
89 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
90 * Add favicon delivery functions.
92 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
93 * - Map variables that aren't guaranteed to be
94 * pure ASCII html_encoded.
95 * - Use CGI_PREFIX to generate URL for user manual
96 * CGI page to make sure CGI_SITE_2_PATH is included.
98 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
99 * - "Protect" against a rather lame JavaScript-based
100 * Privoxy detection "attack" and check the referrer
101 * before delivering the CGI style sheet.
102 * - Move referrer check for unsafe CGI pages into
103 * referrer_is_safe() and log the result.
104 * - Map @url@ in cgi-error-disabled page.
105 * It's required for the "go there anyway" link.
106 * - Mark *csp as immutable for grep_cgi_referrer().
108 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
109 * Fix strdup() error handling in cgi_error_unknown()
110 * and cgi_error_no_template(). Reported by Markus Elfring.
112 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
113 * Handle pcrs_execute() errors in template_fill() properly.
115 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
116 * Fixed gcc43 conversion warnings and replaced sprintf
117 * calls with snprintf to give OpenBSD's gcc one less reason
120 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
121 * Escape ampersand in Privoxy menu.
123 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
124 * Suppress the toggle link if remote toggling is disabled.
126 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
127 * Fix configure option --disable-toggle.
128 * Thanks to Peter Thoenen for reporting this.
130 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
131 * Don't lose the FORCE_PREFIX in case of
132 * connection problems. Fixes #612235.
134 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
135 * Make pthread mutex locking more generic. Instead of
136 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
137 * and use mutex locking unless there is an _r function
138 * available. Better safe than sorry.
140 * Fixes "./configure --disable-pthread" and should result
141 * in less threading-related problems on pthread-using platforms,
142 * but it still doesn't fix BR#1122404.
144 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
145 * Use CGI_PREFIX to check the referrer.
146 * The check for "http://config.privoxy.org/" fails
147 * if the user modified CGI_SITE_2_HOST.
149 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
150 * Adjusted headers for Privoxy's cgi responses:
151 * Don't set Last-Modified, Expires and Cache-Control
152 * headers for redirects; always set "Connection: close".
154 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
155 * Only predate the Last-Modified header for cgi responses
156 * that are delivered with status code 404 or 503.
158 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
159 * Mark cgi_send_user_manual as harmless,
160 * to fix the access denied problem Hal spotted.
161 * The manual has no secret content, therefore we
162 * don't have to care about "secure" referrers.
164 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
165 * Incorporate modified version of Roland Rosenfeld's patch to
166 * optionally access the user-manual via Privoxy. Closes patch 679075.
168 * Formatting changed to Privoxy style, added call to
169 * cgi_error_no_template if the requested file doesn't
170 * exist and modified check whether or not Privoxy itself
171 * should serve the manual. Should work cross-platform now.
173 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
174 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
176 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
177 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
178 * with what was really the latest development (the v_3_0_branch branch)
180 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
181 * Moved cgi_error_disabled() from cgiedit.c to
182 * cgi.c to re-enable build with --disable-editor.
183 * Fixes Bug #892744. Thanks to Matthew Fischer
186 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
187 * - Added new function cgi_redirect to handle creation of
188 * HTTP redirect messages formerly repeated in the code.
189 * - Send cgi_error_disabled instead of cgi_error_404 when
190 * referrer check fails
191 * - Dynamic content now gets Expires header field with date
194 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
195 * Bugfix: Transparent PNG was not transparent. Thanks to
196 * Dan Razzell of Starfish Systems for notice and new PNG.
198 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
199 * Security fix: dspatch_known_cgi no longer considers an empty
200 * referrer safe for critical CGIs, since malicious links could
201 * reside on https:// locations which browsers don't advertize as
202 * referrers. Closes bug #749916, thanks to Jeff Epler for the
203 * hint. Goodbye One-Click[tm] toggling :-(
205 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
208 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
209 * Killed a compiler warning on OSX
211 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
212 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
213 * (fixes bug #710056)
214 * - Show toggle info only if we have it
216 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
217 * Move declaration of struct tm dummy outside of a control block so it is
218 * accessible later on during snprintf in get_http_time.
220 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
221 * Cosmetic: Renamed cryptic variable
223 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
224 * 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.
226 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
227 * Disable access to critical CGIs via untrusted referrers.
228 * This prevents users from being tricked by malicious websites
229 * into making unintentional configuration changes:
231 * - Added flag to each cgi_dispatcher that allows or denies
233 * - Introduced proviorical function that greps for the
234 * referrer header before regular header parsing happens
235 * - Added safety check to dispatch_known_cgi. CGI is called
236 * if (cgi harmless || no referrer || we are referrer).
237 * Else a) toggle calls are modified not to change status and
238 * b) all other calls are denied.
240 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
241 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
243 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
244 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
246 * Revision 1.70 2002/05/19 11:33:20 jongfoster
247 * If a CGI error was not handled, and propogated back to
248 * dispatch_known_cgi(), then it was assumed to be "out of memory".
249 * This gave a very misleading error message.
251 * Now other errors will cause a simple message giving the error
252 * number and asking the user to report a bug.
255 * http://sourceforge.net/tracker/index.php?func=detail
256 * &aid=557905&group_id=11118&atid=111118
258 * Revision 1.69 2002/05/14 21:28:40 oes
259 * - Fixed add_help_link to link to the (now split) actions
260 * part of the config chapter
261 * - Renamed helplink export to actions-help-prefix
263 * Revision 1.68 2002/05/12 21:36:29 jongfoster
264 * Correcting function comments
266 * Revision 1.67 2002/04/30 12:02:07 oes
267 * Nit: updated a comment
269 * Revision 1.66 2002/04/26 18:32:57 jongfoster
270 * Fixing a memory leak on error
272 * Revision 1.65 2002/04/26 12:53:51 oes
273 * - New function add_help_link
274 * - default_exports now exports links to the user manual
275 * and a prefix for links into the config chapter
277 * Revision 1.64 2002/04/24 02:17:21 oes
278 * - Better descriptions for CGIs
279 * - Hide edit-actions, more shortcuts
280 * - Moved get_char_param, get_string_param and get_number_param here
283 * Revision 1.63 2002/04/15 19:06:43 jongfoster
286 * Revision 1.62 2002/04/10 19:59:46 jongfoster
287 * Fixes to #include in templates:
288 * - Didn't close main file if loading an included template fails.
289 * - I'm paranoid and want to disallow "#include /etc/passwd".
291 * Revision 1.61 2002/04/10 13:37:48 oes
292 * Made templates modular: template_load now recursive with max depth 1
294 * Revision 1.60 2002/04/08 20:50:25 swa
297 * Revision 1.59 2002/04/05 15:51:51 oes
298 * - added send-stylesheet CGI
299 * - bugfix: error-pages now get correct request protocol
301 * - kludged CGI descriptions and menu not to break JS syntax
303 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
304 * Fix Mac OSX compiler warnings
306 * Revision 1.57 2002/03/26 22:29:54 swa
307 * we have a new homepage!
309 * Revision 1.56 2002/03/24 17:50:46 jongfoster
310 * Fixing compile error if actions file editor disabled
312 * Revision 1.55 2002/03/24 16:55:06 oes
313 * Making GIF checkerboard transparent
315 * Revision 1.54 2002/03/24 16:18:15 jongfoster
318 * Revision 1.53 2002/03/24 16:06:00 oes
319 * Correct transparency for checkerboard PNG. Thanks, Magnus!
321 * Revision 1.52 2002/03/24 15:23:33 jongfoster
324 * Revision 1.51 2002/03/24 13:25:43 swa
325 * name change related issues
327 * Revision 1.50 2002/03/16 23:54:06 jongfoster
328 * Adding graceful termination feature, to help look for memory leaks.
329 * If you enable this (which, by design, has to be done by hand
330 * editing config.h) and then go to http://i.j.b/die, then the program
331 * will exit cleanly after the *next* request. It should free all the
332 * memory that was used.
334 * Revision 1.49 2002/03/13 00:27:04 jongfoster
337 * Revision 1.48 2002/03/08 17:47:07 jongfoster
340 * Revision 1.47 2002/03/08 16:41:33 oes
341 * Added GIF images again
343 * Revision 1.46 2002/03/07 03:48:38 oes
344 * - Changed built-in images from GIF to PNG
345 * (with regard to Unisys patent issue)
346 * - Added a 4x4 pattern PNG which is less intrusive
347 * than the logo but also clearly marks the deleted banners
349 * Revision 1.45 2002/03/06 22:54:35 jongfoster
350 * Automated function-comment nitpicking.
352 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
353 * - Better error reporting on OS/2
354 * - Fix double-slash comment (oops)
356 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
357 * - Re-enable OS/2 building after new parms were added
358 * - Fix false out of memory report when resolving CGI templates when no IP
359 * address is available of failed attempt (a la no such domain)
361 * Revision 1.42 2002/01/21 00:33:20 jongfoster
362 * Replacing strsav() with the safer string_append() or string_join().
363 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
364 * Adding missing html_encode() to error message generators.
365 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
367 * Revision 1.41 2002/01/17 20:56:22 jongfoster
368 * Replacing hard references to the URL of the config interface
369 * with #defines from project.h
371 * Revision 1.40 2002/01/09 14:26:46 oes
372 * Added support for thread-safe gmtime_r call.
374 * Revision 1.39 2001/11/16 00:48:13 jongfoster
375 * Fixing a compiler warning
377 * Revision 1.38 2001/11/13 00:31:21 jongfoster
378 * - Adding new CGIs for use by non-JavaScript browsers:
379 * edit-actions-url-form
380 * edit-actions-add-url-form
381 * edit-actions-remove-url-form
382 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
385 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
386 * Show enablement/disablement status in almost all templates.
387 * There is a little trickiness here: apparent recursive resolution of
388 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
389 * the actual enablement status. So a similar construct,
390 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
393 * Revision 1.36 2001/10/26 17:33:27 oes
396 * Revision 1.35 2001/10/23 21:48:19 jongfoster
397 * Cleaning up error handling in CGI functions - they now send back
398 * a HTML error page and should never cause a FATAL error. (Fixes one
399 * potential source of "denial of service" attacks).
401 * CGI actions file editor that works and is actually useful.
403 * Ability to toggle Junkbuster remotely using a CGI call.
405 * You can turn off both the above features in the main configuration
406 * file, e.g. if you are running a multi-user proxy.
408 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
409 * Only show "Local support" on templates conditionally:
410 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
411 * - if not, no Local support section appears
413 * Revision 1.33 2001/10/14 22:28:41 jongfoster
414 * Fixing stupid typo.
416 * Revision 1.32 2001/10/14 22:20:18 jongfoster
417 * - Changes to CGI dispatching method to match CGI names exactly,
418 * rather than doing a prefix match.
419 * - No longer need to count the length of the CGI handler names by hand.
420 * - Adding new handler for 404 error when disptching a CGI, if none of
421 * the handlers match.
422 * - Adding new handlers for CGI actionsfile editor.
424 * Revision 1.31 2001/10/10 10:56:39 oes
425 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
427 * Revision 1.30 2001/10/02 15:30:57 oes
428 * Introduced show-request cgi
430 * Revision 1.29 2001/09/20 15:47:44 steudten
432 * Fix BUG: Modify int size to size_t size in fill_template()
433 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
435 * Revision 1.28 2001/09/19 18:00:37 oes
436 * - Deletef time() FIXME (Can't fail under Linux either, if
437 * the argument is guaranteed to be in out address space,
440 * - Pointer notation cosmetics
441 * - Fixed a minor bug in template_fill(): Failiure of
442 * pcrs_execute() now secure.
444 * Revision 1.27 2001/09/16 17:08:54 jongfoster
445 * Moving simple CGI functions from cgi.c to new file cgisimple.c
447 * Revision 1.26 2001/09/16 15:47:37 jongfoster
448 * First version of CGI-based edit interface. This is very much a
449 * work-in-progress, and you can't actually use it to edit anything
450 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
451 * to have any effect.
453 * Revision 1.25 2001/09/16 15:02:35 jongfoster
454 * Adding i.j.b/robots.txt.
455 * Inlining add_stats() since it's only ever called from one place.
457 * Revision 1.24 2001/09/16 11:38:01 jongfoster
458 * Splitting fill_template() into 2 functions:
459 * template_load() loads the file
460 * template_fill() performs the PCRS regexps.
461 * This is because the CGI edit interface has a "table row"
462 * template which is used many times in the page - this
463 * change means it's only loaded from disk once.
465 * Revision 1.23 2001/09/16 11:16:05 jongfoster
466 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
468 * Revision 1.22 2001/09/16 11:00:10 jongfoster
469 * New function alloc_http_response, for symmetry with free_http_response
471 * Revision 1.21 2001/09/13 23:53:03 jongfoster
472 * Support for both static and dynamically generated CGI pages.
473 * Correctly setting Last-Modified: and Expires: HTTP headers.
475 * Revision 1.20 2001/09/13 23:40:36 jongfoster
476 * (Cosmetic only) Indentation correction
478 * Revision 1.19 2001/09/13 23:31:25 jongfoster
479 * Moving image data to cgi.c rather than cgi.h.
481 * Revision 1.18 2001/08/05 16:06:20 jongfoster
482 * Modifiying "struct map" so that there are now separate header and
483 * "map_entry" structures. This means that functions which modify a
484 * map no longer need to return a pointer to the modified map.
485 * Also, it no longer reverses the order of the entries (which may be
486 * important with some advanced template substitutions).
488 * Revision 1.17 2001/08/05 15:57:38 oes
489 * Adapted finish_http_response to new list_to_text
491 * Revision 1.16 2001/08/01 21:33:18 jongfoster
492 * Changes to fill_template() that reduce memory usage without having
493 * an impact on performance. I also renamed some variables so as not
494 * to clash with the C++ keywords "new" and "template".
496 * Revision 1.15 2001/08/01 21:19:22 jongfoster
497 * Moving file version information to a separate CGI page.
499 * Revision 1.14 2001/08/01 00:19:03 jongfoster
500 * New function: map_conditional() for an if-then-else syntax.
501 * Changing to use new version of show_defines()
503 * Revision 1.13 2001/07/30 22:08:36 jongfoster
504 * Tidying up #defines:
505 * - All feature #defines are now of the form FEATURE_xxx
506 * - Permanently turned off WIN_GUI_EDIT
507 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
509 * Revision 1.12 2001/07/29 18:47:05 jongfoster
510 * Adding missing #include "loadcfg.h"
512 * Revision 1.11 2001/07/18 17:24:37 oes
513 * Changed to conform to new pcrs interface
515 * Revision 1.10 2001/07/13 13:53:13 oes
516 * Removed all #ifdef PCRS and related code
518 * Revision 1.9 2001/06/29 21:45:41 oes
519 * Indentation, CRLF->LF, Tab-> Space
521 * Revision 1.8 2001/06/29 13:21:46 oes
522 * - Cosmetics: renamed and reordered functions, variables,
523 * texts, improved comments etc
525 * - Removed ij_untrusted_url() The relevant
526 * info is now part of the "untrusted" page,
527 * which is generated by filters.c:trust_url()
529 * - Generators of content now call finish_http_response()
530 * themselves, making jcc.c:chat() a little less
533 * - Removed obsolete "Pragma: no-cache" from our headers
535 * - http_responses now know their head length
537 * - fill_template now uses the new interface to pcrs, so that
538 * - long jobs (like whole files) no longer have to be assembled
539 * in a fixed size buffer
540 * - the new T (trivial) option is used, and the replacement may
541 * contain Perl syntax backrefs without confusing pcrs
543 * - Introduced default_exports() which generates a set of exports
544 * common to all CGIs and other content generators
546 * - Introduced convenience function map_block_killer()
548 * - Introduced convenience function make_menu()
550 * - Introduced CGI-like function error_response() which generates
551 * the "No such domain" and "Connect failed" messages using the
554 * - cgi_show_url_info:
555 * - adapted to new CGI features
556 * - form and answers now generated from same template
557 * - http:// prefix in URL now OK
560 * - adapted to new CGI features
561 * - no longer uses csp->init_proxy_args
564 * - moved menu generation to make_menu()
566 * - add_stats now writes single export map entries instead
569 * - Moved redirect_url() to filters.c
571 * - Fixed mem leak in free_http_response(), map_block_killer(),
573 * - Removed logentry from cancelled commit
575 * Revision 1.7 2001/06/09 10:51:58 jongfoster
576 * Changing "show URL info" handler to new style.
577 * Changing BUFSIZ ==> BUFFER_SIZE
579 * Revision 1.6 2001/06/07 23:05:19 jongfoster
580 * Removing code related to old forward and ACL files.
582 * Revision 1.5 2001/06/05 19:59:16 jongfoster
583 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
585 * Revision 1.4 2001/06/04 10:41:52 swa
586 * show version string of cgi.h and cgi.c
588 * Revision 1.3 2001/06/03 19:12:16 oes
589 * introduced new cgi handling
591 * No revisions before 1.3
593 **********************************************************************/
599 #include <sys/types.h>
613 #include "miscutil.h"
614 #include "cgisimple.h"
615 #include "jbsockets.h"
616 #ifdef FEATURE_CGI_EDIT_ACTIONS
618 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
620 /* loadcfg.h is for global_toggle_state only */
621 #ifdef FEATURE_PTHREAD
623 /* jcc.h is for mutex semaphore globals only */
624 #endif /* def FEATURE_PTHREAD */
625 const char cgi_h_rcs[] = CGI_H_VERSION;
628 * List of CGI functions: name, handler, description
629 * Note: Do NOT use single quotes in the description;
630 * this will break the dynamic "blocked" template!
632 static const struct cgi_dispatcher cgi_dispatchers[] = {
637 #ifdef FEATURE_GRACEFUL_TERMINATION
640 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
641 "this is a one click Denial Of Service attack!!!</em>",
646 #ifdef FEATURE_CGI_EDIT_ACTIONS
647 "View & change the current configuration",
649 "View the current configuration",
654 "View the source code version numbers",
658 "View the request headers.",
662 "Look up which actions apply to a URL and why",
664 #ifdef FEATURE_CGI_EDIT_ACTIONS
665 #ifdef FEATURE_TOGGLE
668 "Toggle Privoxy on or off",
670 #endif /* def FEATURE_TOGGLE */
671 { "edit-actions", /* Edit the actions list */
674 { "eaa", /* Shortcut for edit-actions-add-url-form */
675 cgi_edit_actions_add_url_form,
677 { "eau", /* Shortcut for edit-actions-url-form */
678 cgi_edit_actions_url_form,
680 { "ear", /* Shortcut for edit-actions-remove-url-form */
681 cgi_edit_actions_remove_url_form,
683 { "eal", /* Shortcut for edit-actions-list */
684 cgi_edit_actions_list,
686 { "eafu", /* Shortcut for edit-actions-for-url */
687 cgi_edit_actions_for_url,
689 { "eas", /* Shortcut for edit-actions-submit */
690 cgi_edit_actions_submit,
692 { "easa", /* Shortcut for edit-actions-section-add */
693 cgi_edit_actions_section_add,
695 { "easr", /* Shortcut for edit-actions-section-remove */
696 cgi_edit_actions_section_remove,
698 { "eass", /* Shortcut for edit-actions-section-swap */
699 cgi_edit_actions_section_swap,
701 { "edit-actions-for-url",
702 cgi_edit_actions_for_url,
703 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
704 { "edit-actions-list",
705 cgi_edit_actions_list,
706 NULL, TRUE /* Edit the actions list */ },
707 { "edit-actions-submit",
708 cgi_edit_actions_submit,
709 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
710 { "edit-actions-url",
711 cgi_edit_actions_url,
712 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
713 { "edit-actions-url-form",
714 cgi_edit_actions_url_form,
715 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
716 { "edit-actions-add-url",
717 cgi_edit_actions_add_url,
718 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
719 { "edit-actions-add-url-form",
720 cgi_edit_actions_add_url_form,
721 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
722 { "edit-actions-remove-url",
723 cgi_edit_actions_remove_url,
724 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
725 { "edit-actions-remove-url-form",
726 cgi_edit_actions_remove_url_form,
727 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
728 { "edit-actions-section-add",
729 cgi_edit_actions_section_add,
730 NULL, FALSE /* Remove a section from the actionsfile */ },
731 { "edit-actions-section-remove",
732 cgi_edit_actions_section_remove,
733 NULL, FALSE /* Remove a section from the actionsfile */ },
734 { "edit-actions-section-swap",
735 cgi_edit_actions_section_swap,
736 NULL, FALSE /* Swap two sections in the actionsfile */ },
737 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
738 { "error-favicon.ico",
739 cgi_send_error_favicon,
740 NULL, TRUE /* Sends the favicon image for error pages. */ },
742 cgi_send_default_favicon,
743 NULL, TRUE /* Sends the default favicon image. */ },
746 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
749 NULL, TRUE /* Send a built-in image */ },
752 NULL, FALSE /* Send templates/cgi-style.css */ },
754 cgi_transparent_image,
755 NULL, TRUE /* Send a transparent image (short name) */ },
757 cgi_send_user_manual,
758 NULL, TRUE /* Send user-manual */ },
759 { NULL, /* NULL Indicates end of list and default page */
761 NULL, TRUE /* Unknown CGI page */ }
766 * Built-in images for ad replacement
768 * Hint: You can encode your own images like this:
769 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
772 #ifdef FEATURE_NO_GIFS
775 * Checkerboard pattern, as a PNG.
777 const char image_pattern_data[] =
778 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
779 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
780 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
781 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
782 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
783 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
784 "\000\000\000\000\111\105\116\104\256\102\140\202";
787 * 1x1 transparant PNG.
789 const char image_blank_data[] =
790 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
791 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
792 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
793 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
794 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
795 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
796 "\000\000\000\000\111\105\116\104\256\102\140\202";
800 * Checkerboard pattern, as a GIF.
802 const char image_pattern_data[] =
803 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
804 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
805 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
806 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
810 * 1x1 transparant GIF.
812 const char image_blank_data[] =
813 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
814 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
815 "\000\001\000\000\002\002D\001\000;";
818 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
819 const size_t image_blank_length = sizeof(image_blank_data) - 1;
822 static struct http_response cgi_error_memory_response[1];
824 static struct http_response *dispatch_known_cgi(struct client_state * csp,
826 static struct map *parse_cgi_parameters(char *argstring);
829 /*********************************************************************
831 * Function : dispatch_cgi
833 * Description : Checks if a request URL has either the magical
834 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
835 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
836 * http://config.privoxy.org/). If so, it passes
837 * the (rest of the) path onto dispatch_known_cgi, which
838 * calls the relevant CGI handler function.
841 * 1 : csp = Current client state (buffers, headers, etc...)
843 * Returns : http_response if match, NULL if nonmatch or handler fail
845 *********************************************************************/
846 struct http_response *dispatch_cgi(struct client_state *csp)
848 const char *host = csp->http->host;
849 const char *path = csp->http->path;
852 * Should we intercept ?
855 /* Note: "example.com" and "example.com." are equivalent hostnames. */
857 /* Either the host matches CGI_SITE_1_HOST ..*/
858 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
859 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
860 && (path[0] == '/') )
862 /* ..then the path will all be for us. Remove leading '/' */
865 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
866 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
867 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
868 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
870 /* take everything following CGI_SITE_2_PATH */
871 path += strlen(CGI_SITE_2_PATH);
874 /* skip the forward slash after CGI_SITE_2_PATH */
877 else if (*path != '\0')
880 * weirdness: URL is /configXXX, where XXX is some string
881 * Do *NOT* intercept.
893 * This is a CGI call.
896 return dispatch_known_cgi(csp, path);
900 /*********************************************************************
902 * Function : grep_cgi_referrer
904 * Description : Ugly provisorical fix that greps the value of the
905 * referer HTTP header field out of a linked list of
906 * strings like found at csp->headers. Will disappear
909 * FIXME: csp->headers ought to be csp->http->headers
910 * FIXME: Parsing all client header lines should
911 * happen right after the request is received!
914 * 1 : csp = Current client state (buffers, headers, etc...)
916 * Returns : pointer to value (no copy!), or NULL if none found.
918 *********************************************************************/
919 static char *grep_cgi_referrer(const struct client_state *csp)
921 struct list_entry *p;
923 for (p = csp->headers->first; p != NULL; p = p->next)
925 if (p->str == NULL) continue;
926 if (strncmpic(p->str, "Referer: ", 9) == 0)
928 return ((p->str) + 9);
936 /*********************************************************************
938 * Function : referrer_is_safe
940 * Description : Decides whether we trust the Referer for
941 * CGI pages which are only meant to be reachable
942 * through Privoxy's web interface directly.
945 * 1 : csp = Current client state (buffers, headers, etc...)
947 * Returns : TRUE if the referrer is safe, or
948 * FALSE if the referrer is unsafe or not set.
950 *********************************************************************/
951 static int referrer_is_safe(const struct client_state *csp)
954 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
956 referrer = grep_cgi_referrer(csp);
958 if (NULL == referrer)
960 /* No referrer, no access */
961 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
964 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
965 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
967 /* Trustworthy referrer */
968 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
969 csp->http->url, referrer);
975 /* Untrustworthy referrer */
976 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
977 csp->http->url, referrer);
984 /*********************************************************************
986 * Function : dispatch_known_cgi
988 * Description : Processes a CGI once dispatch_cgi has determined that
989 * it matches one of the magic prefixes. Parses the path
990 * as a cgi name plus query string, prepares a map that
991 * maps CGI parameter names to their values, initializes
992 * the http_response struct, and calls the relevant CGI
996 * 1 : csp = Current client state (buffers, headers, etc...)
997 * 2 : path = Path of CGI, with the CGI prefix removed.
998 * Should not have a leading "/".
1000 * Returns : http_response, or NULL on handler failure or out of
1003 *********************************************************************/
1004 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1007 const struct cgi_dispatcher *d;
1008 struct map *param_list;
1009 struct http_response *rsp;
1010 char *query_args_start;
1014 if (NULL == (path_copy = strdup(path)))
1016 return cgi_error_memory();
1018 query_args_start = path_copy;
1019 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1023 if (*query_args_start == '/')
1025 *query_args_start++ = '\0';
1026 if ((param_list = new_map()))
1028 map(param_list, "file", 1, url_decode(query_args_start), 0);
1033 if (*query_args_start == '?')
1035 *query_args_start++ = '\0';
1037 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1040 return cgi_error_memory();
1046 * path_copy = CGI call name
1047 * param_list = CGI params, as map
1050 /* Get mem for response or fail*/
1051 if (NULL == (rsp = alloc_http_response()))
1054 free_map(param_list);
1055 return cgi_error_memory();
1059 * Find and start the right CGI function
1061 d = cgi_dispatchers;
1064 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1067 * If the called CGI is either harmless, or referred
1068 * from a trusted source, start it.
1070 if (d->harmless || referrer_is_safe(csp))
1072 err = (d->handler)(csp, rsp, param_list);
1077 * Else, modify toggle calls so that they only display
1078 * the status, and deny all other calls.
1080 if (0 == strcmp(path_copy, "toggle"))
1082 unmap(param_list, "set");
1083 err = (d->handler)(csp, rsp, param_list);
1087 err = cgi_error_disabled(csp, rsp);
1092 free_map(param_list);
1094 if (err == JB_ERR_CGI_PARAMS)
1096 err = cgi_error_bad_param(csp, rsp);
1098 if (err && (err != JB_ERR_MEMORY))
1100 /* Unexpected error! Shouldn't get here */
1101 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1102 err = cgi_error_unknown(csp, rsp, err);
1107 rsp->reason = RSP_REASON_CGI_CALL;
1108 return finish_http_response(csp, rsp);
1112 /* Error in handler, probably out-of-memory */
1113 free_http_response(rsp);
1114 return cgi_error_memory();
1122 /*********************************************************************
1124 * Function : parse_cgi_parameters
1126 * Description : Parse a URL-encoded argument string into name/value
1127 * pairs and store them in a struct map list.
1130 * 1 : argstring = string to be parsed. Will be trashed.
1132 * Returns : pointer to param list, or NULL if out of memory.
1134 *********************************************************************/
1135 static struct map *parse_cgi_parameters(char *argstring)
1138 char *vector[BUFFER_SIZE];
1140 struct map *cgi_params;
1142 if (NULL == (cgi_params = new_map()))
1148 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1149 * the fragment identifier along with the request, so we must
1150 * cut it off here, so it won't pollute the CGI params:
1152 if (NULL != (p = strchr(argstring, '#')))
1157 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1159 for (i = 0; i < pairs; i++)
1161 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1164 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1166 free_map(cgi_params);
1177 /*********************************************************************
1179 * Function : get_char_param
1181 * Description : Get a single-character parameter passed to a CGI
1185 * 1 : parameters = map of cgi parameters
1186 * 2 : param_name = The name of the parameter to read
1188 * Returns : Uppercase character on success, '\0' on error.
1190 *********************************************************************/
1191 char get_char_param(const struct map *parameters,
1192 const char *param_name)
1199 ch = *(lookup(parameters, param_name));
1200 if ((ch >= 'a') && (ch <= 'z'))
1202 ch = (char)(ch - 'a' + 'A');
1209 /*********************************************************************
1211 * Function : get_string_param
1213 * Description : Get a string paramater, to be used as an
1214 * ACTION_STRING or ACTION_MULTI paramater.
1215 * Validates the input to prevent stupid/malicious
1216 * users from corrupting their action file.
1219 * 1 : parameters = map of cgi parameters
1220 * 2 : param_name = The name of the parameter to read
1221 * 3 : pparam = destination for paramater. Allocated as
1222 * part of the map "parameters", so don't free it.
1223 * Set to NULL if not specified.
1225 * Returns : JB_ERR_OK on success, or if the paramater
1226 * was not specified.
1227 * JB_ERR_MEMORY on out-of-memory.
1228 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1230 *********************************************************************/
1231 jb_err get_string_param(const struct map *parameters,
1232 const char *param_name,
1233 const char **pparam)
1245 param = lookup(parameters, param_name);
1251 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1256 * Note that the length limit is arbitrary, it just seems
1257 * sensible to limit it to *something*. There's no
1258 * technical reason for any limit at all.
1260 return JB_ERR_CGI_PARAMS;
1263 /* Check every character to see if it's legal */
1265 while ((ch = *s++) != '\0')
1267 if ( ((unsigned char)ch < (unsigned char)' ')
1270 /* Probable hack attempt, or user accidentally used '}'. */
1271 return JB_ERR_CGI_PARAMS;
1282 /*********************************************************************
1284 * Function : get_number_param
1286 * Description : Get a non-negative integer from the parameters
1287 * passed to a CGI function.
1290 * 1 : csp = Current client state (buffers, headers, etc...)
1291 * 2 : parameters = map of cgi parameters
1292 * 3 : name = Name of CGI parameter to read
1293 * 4 : pvalue = destination for value.
1294 * Set to -1 on error.
1296 * Returns : JB_ERR_OK on success
1297 * JB_ERR_MEMORY on out-of-memory
1298 * JB_ERR_CGI_PARAMS if the parameter was not specified
1301 *********************************************************************/
1302 jb_err get_number_param(struct client_state *csp,
1303 const struct map *parameters,
1318 param = lookup(parameters, name);
1321 return JB_ERR_CGI_PARAMS;
1324 /* We don't use atoi because I want to check this carefully... */
1327 while ((ch = *param++) != '\0')
1329 if ((ch < '0') || (ch > '9'))
1331 return JB_ERR_CGI_PARAMS;
1334 ch = (char)(ch - '0');
1338 * <limits.h> defines UINT_MAX
1340 * (UINT_MAX - ch) / 10 is the largest number that
1341 * can be safely multiplied by 10 then have ch added.
1343 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1345 return JB_ERR_CGI_PARAMS;
1348 value = value * 10 + (unsigned)ch;
1359 /*********************************************************************
1361 * Function : error_response
1363 * Description : returns an http_response that explains the reason
1364 * why a request failed.
1367 * 1 : csp = Current client state (buffers, headers, etc...)
1368 * 2 : templatename = Which template should be used for the answer
1369 * 3 : sys_err = system error number
1371 * Returns : A http_response. If we run out of memory, this
1372 * will be cgi_error_memory().
1374 *********************************************************************/
1375 struct http_response *error_response(struct client_state *csp,
1376 const char *templatename,
1380 struct http_response *rsp;
1381 struct map *exports = default_exports(csp, NULL);
1384 if (exports == NULL)
1386 return cgi_error_memory();
1389 if (NULL == (rsp = alloc_http_response()))
1392 return cgi_error_memory();
1395 #ifdef FEATURE_FORCE_LOAD
1396 if (csp->flags & CSP_FLAG_FORCED)
1398 path = strdup(FORCE_PREFIX);
1401 #endif /* def FEATURE_FORCE_LOAD */
1405 err = string_append(&path, csp->http->path);
1407 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1408 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1409 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1410 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1411 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1414 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1417 /* Some failures, like "404 no such domain", don't have an IP address. */
1418 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1426 free_http_response(rsp);
1427 return cgi_error_memory();
1430 if (!strcmp(templatename, "no-such-domain"))
1432 rsp->status = strdup("404 No such domain");
1433 if (rsp->status == NULL)
1436 free_http_response(rsp);
1437 return cgi_error_memory();
1439 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1441 else if (!strcmp(templatename, "forwarding-failed"))
1443 const struct forward_spec *fwd = forward_url(csp, csp->http);
1444 char *socks_type = NULL;
1447 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1448 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1452 * XXX: While the template is called forwarding-failed,
1453 * it currently only handles socks forwarding failures.
1455 assert(fwd->type != SOCKS_NONE);
1458 * Map failure reason, forwarding type and forwarder.
1460 if (NULL == csp->error_message)
1463 * Either we forgot to record the failure reason,
1464 * or the memory allocation failed.
1466 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1467 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1469 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1472 * XXX: this is almost the same code as in cgi_show_url_info()
1473 * and thus should be factored out and shared.
1478 socks_type = "socks4-";
1481 socks_type = "socks4a-";
1484 socks_type = "socks5-";
1487 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1490 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1491 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1493 if (!err) rsp->status = strdup("503 Forwarding failure");
1494 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1497 free_http_response(rsp);
1498 return cgi_error_memory();
1500 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1502 else if (!strcmp(templatename, "connect-failed"))
1504 rsp->status = strdup("503 Connect failed");
1505 if (rsp->status == NULL)
1508 free_http_response(rsp);
1509 return cgi_error_memory();
1511 rsp->reason = RSP_REASON_CONNECT_FAILED;
1514 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1517 free_http_response(rsp);
1518 return cgi_error_memory();
1521 return finish_http_response(csp, rsp);
1525 /*********************************************************************
1527 * Function : cgi_error_disabled
1529 * Description : CGI function that is called to generate an error
1530 * response if the actions editor or toggle CGI are
1531 * accessed despite having being disabled at compile-
1532 * or run-time, or if the user followed an untrusted link
1533 * to access a unsafe CGI feature that is only reachable
1534 * through Privoxy directly.
1537 * 1 : csp = Current client state (buffers, headers, etc...)
1538 * 2 : rsp = http_response data structure for output
1540 * CGI Parameters : none
1542 * Returns : JB_ERR_OK on success
1543 * JB_ERR_MEMORY on out-of-memory error.
1545 *********************************************************************/
1546 jb_err cgi_error_disabled(struct client_state *csp,
1547 struct http_response *rsp)
1549 struct map *exports;
1554 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1556 return JB_ERR_MEMORY;
1558 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1560 /* Not important enough to do anything */
1561 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1564 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1568 /*********************************************************************
1570 * Function : cgi_init_error_messages
1572 * Description : Call at the start of the program to initialize
1573 * the error message used by cgi_error_memory().
1579 *********************************************************************/
1580 void cgi_init_error_messages(void)
1582 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1583 cgi_error_memory_response->head =
1584 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1585 "Content-Type: text/html\r\n"
1587 cgi_error_memory_response->body =
1590 " <title>500 Internal Privoxy Error</title>\r\n"
1591 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1594 "<h1>500 Internal Privoxy Error</h1>\r\n"
1595 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1596 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1600 cgi_error_memory_response->head_length =
1601 strlen(cgi_error_memory_response->head);
1602 cgi_error_memory_response->content_length =
1603 strlen(cgi_error_memory_response->body);
1604 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1608 /*********************************************************************
1610 * Function : cgi_error_memory
1612 * Description : Called if a CGI function runs out of memory.
1613 * Returns a statically-allocated error response.
1617 * Returns : http_response data structure for output. This is
1618 * statically allocated, for obvious reasons.
1620 *********************************************************************/
1621 struct http_response *cgi_error_memory(void)
1623 /* assert that it's been initialized. */
1624 assert(cgi_error_memory_response->head);
1626 return cgi_error_memory_response;
1630 /*********************************************************************
1632 * Function : cgi_error_no_template
1634 * Description : Almost-CGI function that is called if a template
1635 * cannot be loaded. Note this is not a true CGI,
1636 * it takes a template name rather than a map of
1640 * 1 : csp = Current client state (buffers, headers, etc...)
1641 * 2 : rsp = http_response data structure for output
1642 * 3 : template_name = Name of template that could not
1645 * Returns : JB_ERR_OK on success
1646 * JB_ERR_MEMORY on out-of-memory error.
1648 *********************************************************************/
1649 jb_err cgi_error_no_template(struct client_state *csp,
1650 struct http_response *rsp,
1651 const char *template_name)
1653 static const char status[] =
1654 "500 Internal Privoxy Error";
1655 static const char body_prefix[] =
1658 " <title>500 Internal Privoxy Error</title>\r\n"
1659 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1662 "<h1>500 Internal Privoxy Error</h1>\r\n"
1663 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1664 "<p><b>Could not load template file <code>";
1665 static const char body_suffix[] =
1666 "</code> or one of it's included components.</b></p>\r\n"
1667 "<p>Please contact your proxy administrator.</p>\r\n"
1668 "<p>If you are the proxy administrator, please put the required file(s)"
1669 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1670 "location of the <code><i>(confdir)</i></code> directory "
1671 "is specified in the main Privoxy <code>config</code> "
1672 "file. (It's typically the Privoxy install directory"
1674 ", or <code>/etc/privoxy/</code>"
1675 #endif /* ndef _WIN32 */
1679 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1683 assert(template_name);
1685 /* Reset rsp, if needed */
1689 rsp->content_length = 0;
1690 rsp->head_length = 0;
1693 rsp->body = malloc(body_size);
1694 if (rsp->body == NULL)
1696 return JB_ERR_MEMORY;
1698 strlcpy(rsp->body, body_prefix, body_size);
1699 strlcat(rsp->body, template_name, body_size);
1700 strlcat(rsp->body, body_suffix, body_size);
1702 rsp->status = strdup(status);
1703 if (rsp->status == NULL)
1705 return JB_ERR_MEMORY;
1712 /*********************************************************************
1714 * Function : cgi_error_unknown
1716 * Description : Almost-CGI function that is called if an unexpected
1717 * error occurs in the top-level CGI dispatcher.
1718 * In this context, "unexpected" means "anything other
1719 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1720 * expected to handle all other errors internally,
1721 * since they can give more relavent error messages
1724 * Note this is not a true CGI, it takes an error
1725 * code rather than a map of parameters.
1728 * 1 : csp = Current client state (buffers, headers, etc...)
1729 * 2 : rsp = http_response data structure for output
1730 * 3 : error_to_report = Error code to report.
1732 * Returns : JB_ERR_OK on success
1733 * JB_ERR_MEMORY on out-of-memory error.
1735 *********************************************************************/
1736 jb_err cgi_error_unknown(struct client_state *csp,
1737 struct http_response *rsp,
1738 jb_err error_to_report)
1740 static const char status[] =
1741 "500 Internal Privoxy Error";
1742 static const char body_prefix[] =
1745 " <title>500 Internal Privoxy Error</title>\r\n"
1746 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1749 "<h1>500 Internal Privoxy Error</h1>\r\n"
1750 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1751 "<p><b>Unexpected internal error: ";
1752 static const char body_suffix[] =
1755 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1756 "file a bug report</a>.</p>\r\n"
1761 * Due to sizeof(errnumbuf), body_size will be slightly
1762 * bigger than necessary but it doesn't really matter.
1764 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1768 /* Reset rsp, if needed */
1772 rsp->content_length = 0;
1773 rsp->head_length = 0;
1775 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1777 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1779 rsp->body = malloc(body_size);
1780 if (rsp->body == NULL)
1782 return JB_ERR_MEMORY;
1784 strlcpy(rsp->body, body_prefix, body_size);
1785 strlcat(rsp->body, errnumbuf, body_size);
1786 strlcat(rsp->body, body_suffix, body_size);
1788 rsp->status = strdup(status);
1789 if (rsp->status == NULL)
1791 return JB_ERR_MEMORY;
1798 /*********************************************************************
1800 * Function : cgi_error_bad_param
1802 * Description : CGI function that is called if the parameters
1803 * (query string) for a CGI were wrong.
1806 * 1 : csp = Current client state (buffers, headers, etc...)
1807 * 2 : rsp = http_response data structure for output
1809 * CGI Parameters : none
1811 * Returns : JB_ERR_OK on success
1812 * JB_ERR_MEMORY on out-of-memory error.
1814 *********************************************************************/
1815 jb_err cgi_error_bad_param(struct client_state *csp,
1816 struct http_response *rsp)
1818 struct map *exports;
1823 if (NULL == (exports = default_exports(csp, NULL)))
1825 return JB_ERR_MEMORY;
1828 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1832 /*********************************************************************
1834 * Function : cgi_redirect
1836 * Description : CGI support function to generate a HTTP redirect
1840 * 1 : rsp = http_response data structure for output
1841 * 2 : target = string with the target URL
1843 * CGI Parameters : None
1845 * Returns : JB_ERR_OK on success
1846 * JB_ERR_MEMORY on out-of-memory error.
1848 *********************************************************************/
1849 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1856 err = enlist_unique_header(rsp->headers, "Location", target);
1858 rsp->status = strdup("302 Local Redirect from Privoxy");
1859 if (rsp->status == NULL)
1861 return JB_ERR_MEMORY;
1868 /*********************************************************************
1870 * Function : add_help_link
1872 * Description : Produce a copy of the string given as item,
1873 * embedded in an HTML link to its corresponding
1874 * section (item name in uppercase) in the actions
1875 * chapter of the user manual, (whose URL is given in
1876 * the config and defaults to our web site).
1878 * FIXME: I currently only work for actions, and would
1879 * like to be generalized for other topics.
1882 * 1 : item = item (will NOT be free()d.)
1883 * It is assumed to be HTML-safe.
1884 * 2 : config = The current configuration.
1886 * Returns : String with item embedded in link, or NULL on
1889 *********************************************************************/
1890 char *add_help_link(const char *item,
1891 struct configuration_spec *config)
1895 if (!item) return NULL;
1897 result = strdup("<a href=\"");
1898 if (!strncmpic(config->usermanual, "file://", 7) ||
1899 !strncmpic(config->usermanual, "http", 4))
1901 string_append(&result, config->usermanual);
1905 string_append(&result, "http://");
1906 string_append(&result, CGI_SITE_2_HOST);
1907 string_append(&result, "/user-manual/");
1909 string_append(&result, ACTIONS_HELP_PREFIX);
1910 string_join (&result, string_toupper(item));
1911 string_append(&result, "\">");
1912 string_append(&result, item);
1913 string_append(&result, "</a> ");
1919 /*********************************************************************
1921 * Function : get_http_time
1923 * Description : Get the time in a format suitable for use in a
1924 * HTTP header - e.g.:
1925 * "Sun, 06 Nov 1994 08:49:37 GMT"
1927 * XXX: Should probably get a third parameter for
1931 * 1 : time_offset = Time returned will be current time
1932 * plus this number of seconds.
1933 * 2 : buf = Destination for result. Must be long enough
1934 * to hold 29 characters plus a trailing zero.
1938 *********************************************************************/
1939 void get_http_time(int time_offset, char *buf)
1941 static const char day_names[7][4] =
1942 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1943 static const char month_names[12][4] =
1944 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1945 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1948 time_t current_time;
1949 #if defined(HAVE_GMTIME_R)
1951 * Declare dummy up here (instead of inside get/set gmt block) so it
1952 * doesn't go out of scope before it's potentially used in snprintf later.
1953 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1954 * !defined HAVE_GMTIME_R.
1961 time(¤t_time); /* get current time */
1963 current_time += time_offset;
1965 /* get and save the gmt */
1968 t = gmtime_r(¤t_time, &dummy);
1969 #elif FEATURE_PTHREAD
1970 pthread_mutex_lock(&gmtime_mutex);
1971 t = gmtime(¤t_time);
1972 pthread_mutex_unlock(&gmtime_mutex);
1974 t = gmtime(¤t_time);
1978 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1980 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1981 day_names[t->tm_wday],
1983 month_names[t->tm_mon],
1993 /*********************************************************************
1995 * Function : finish_http_response
1997 * Description : Fill in the missing headers in an http response,
1998 * and flatten the headers to an http head.
1999 * For HEAD requests the body is freed once
2000 * the Content-Length header is set.
2003 * 1 : rsp = pointer to http_response to be processed
2005 * Returns : A http_response, usually the rsp parameter.
2006 * On error, free()s rsp and returns cgi_error_memory()
2008 *********************************************************************/
2009 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2011 char buf[BUFFER_SIZE];
2014 /* Special case - do NOT change this statically allocated response,
2015 * which is ready for output anyway.
2017 if (rsp == cgi_error_memory_response)
2023 * Fill in the HTTP Status, using HTTP/1.1
2024 * unless the client asked for HTTP/1.0.
2026 snprintf(buf, sizeof(buf), "%s %s",
2027 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2028 rsp->status ? rsp->status : "200 OK");
2029 err = enlist_first(rsp->headers, buf);
2032 * Set the Content-Length
2034 if (rsp->content_length == 0)
2036 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2040 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2041 err = enlist(rsp->headers, buf);
2044 if (0 == strcmpic(csp->http->gpc, "head"))
2047 * The client only asked for the head. Dispose
2048 * the body and log an offensive message.
2050 * While it may seem to be a bit inefficient to
2051 * prepare the body if it isn't needed, it's the
2052 * only way to get the Content-Length right for
2053 * dynamic pages. We could have disposed the body
2054 * earlier, but not without duplicating the
2055 * Content-Length setting code above.
2057 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2059 rsp->content_length = 0;
2062 if (strncmpic(rsp->status, "302", 3))
2065 * If it's not a redirect without any content,
2066 * set the Content-Type to text/html if it's
2067 * not already specified.
2069 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2073 * Fill in the rest of the default headers:
2075 * Date: set to current date/time.
2076 * Last-Modified: set to date/time the page was last changed.
2077 * Expires: set to date/time page next needs reloading.
2078 * Cache-Control: set to "no-cache" if applicable.
2080 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2085 * Set Expires to about 10 min into the future so it'll get reloaded
2086 * occasionally, e.g. if Privoxy gets upgraded.
2091 get_http_time(0, buf);
2092 err = enlist_unique_header(rsp->headers, "Date", buf);
2095 /* Some date in the past. */
2096 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2100 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2101 err = enlist_unique_header(rsp->headers, "Expires", buf);
2104 else if (!strncmpic(rsp->status, "302", 3))
2106 get_http_time(0, buf);
2107 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2112 * Setting "Cache-Control" to "no-cache" and "Expires" to
2113 * the current time doesn't exactly forbid caching, it just
2114 * requires the client to revalidate the cached copy.
2116 * If a temporary problem occurs and the user tries again after
2117 * getting Privoxy's error message, a compliant browser may set the
2118 * If-Modified-Since header with the content of the error page's
2119 * Last-Modified header. More often than not, the document on the server
2120 * is older than Privoxy's error message, the server would send status code
2121 * 304 and the browser would display the outdated error message again and again.
2123 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2124 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2125 * and can be safely used to "revalidate" without getting a status code 304.
2127 * There is no need to let the useless If-Modified-Since header reach the
2128 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2130 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2132 get_http_time(0, buf);
2133 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2134 if (!strncmpic(rsp->status, "403", 3)
2135 || !strncmpic(rsp->status, "404", 3)
2136 || !strncmpic(rsp->status, "503", 3))
2138 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2142 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2144 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2145 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2151 * HTTP/1.1 applications that do not support persistent connections MUST
2152 * include the "close" connection option in every message.
2154 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2159 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2161 free_http_response(rsp);
2162 return cgi_error_memory();
2164 rsp->head_length = strlen(rsp->head);
2171 /*********************************************************************
2173 * Function : alloc_http_response
2175 * Description : Allocates a new http_response structure.
2179 * Returns : pointer to a new http_response, or NULL.
2181 *********************************************************************/
2182 struct http_response *alloc_http_response(void)
2184 return (struct http_response *) zalloc(sizeof(struct http_response));
2189 /*********************************************************************
2191 * Function : free_http_response
2193 * Description : Free the memory occupied by an http_response
2194 * and its depandant structures.
2197 * 1 : rsp = pointer to http_response to be freed
2201 *********************************************************************/
2202 void free_http_response(struct http_response *rsp)
2205 * Must special case cgi_error_memory_response, which is never freed.
2207 if (rsp && (rsp != cgi_error_memory_response))
2212 destroy_list(rsp->headers);
2219 /*********************************************************************
2221 * Function : template_load
2223 * Description : CGI support function that loads a given HTML
2224 * template, ignoring comment lines and following
2225 * #include statements up to a depth of 1.
2228 * 1 : csp = Current client state (buffers, headers, etc...)
2229 * 2 : template_ptr = Destination for pointer to loaded
2231 * 3 : templatename = name of the HTML template to be used
2232 * 4 : recursive = Flag set if this function calls itself
2233 * following an #include statament
2235 * Returns : JB_ERR_OK on success
2236 * JB_ERR_MEMORY on out-of-memory error.
2237 * JB_ERR_FILE if the template file cannot be read
2239 *********************************************************************/
2240 jb_err template_load(struct client_state *csp, char **template_ptr,
2241 const char *templatename, int recursive)
2244 char *templates_dir_path;
2247 char *included_module;
2250 char buf[BUFFER_SIZE];
2253 assert(template_ptr);
2254 assert(templatename);
2256 *template_ptr = NULL;
2258 /* Validate template name. Paranoia. */
2259 for (p = templatename; *p != 0; p++)
2261 if ( ((*p < 'a') || (*p > 'z'))
2262 && ((*p < 'A') || (*p > 'Z'))
2263 && ((*p < '0') || (*p > '9'))
2267 /* Illegal character */
2273 * Generate full path using either templdir
2274 * or confdir/templates as base directory.
2276 if (NULL != csp->config->templdir)
2278 templates_dir_path = strdup(csp->config->templdir);
2282 templates_dir_path = make_path(csp->config->confdir, "templates");
2285 if (templates_dir_path == NULL)
2287 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2289 return JB_ERR_MEMORY;
2292 full_path = make_path(templates_dir_path, templatename);
2293 free(templates_dir_path);
2294 if (full_path == NULL)
2296 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2298 return JB_ERR_MEMORY;
2301 /* Allocate buffer */
2303 file_buffer = strdup("");
2304 if (file_buffer == NULL)
2306 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2308 return JB_ERR_MEMORY;
2311 /* Open template file */
2313 if (NULL == (fp = fopen(full_path, "r")))
2315 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2323 * Read the file, ignoring comments, and honoring #include
2324 * statements, unless we're already called recursively.
2326 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2327 * This is unlikely in practise.
2329 while (fgets(buf, BUFFER_SIZE, fp))
2331 if (!recursive && !strncmp(buf, "#include ", 9))
2333 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2340 if (string_join(&file_buffer, included_module))
2343 return JB_ERR_MEMORY;
2349 /* skip lines starting with '#' */
2355 if (string_append(&file_buffer, buf))
2358 return JB_ERR_MEMORY;
2363 *template_ptr = file_buffer;
2369 /*********************************************************************
2371 * Function : template_fill
2373 * Description : CGI support function that fills in a pre-loaded
2374 * HTML template by replacing @name@ with value using
2375 * pcrs, for each item in the output map.
2377 * Note that a leading '$' charachter in the export map's
2378 * values will be stripped and toggle on backreference
2382 * 1 : template_ptr = IN: Template to be filled out.
2384 * OUT: Filled out template.
2385 * Caller must free().
2386 * 2 : exports = map with fill in symbol -> name pairs
2388 * Returns : JB_ERR_OK on success (and for uncritical errors)
2389 * JB_ERR_MEMORY on out-of-memory error
2391 *********************************************************************/
2392 jb_err template_fill(char **template_ptr, const struct map *exports)
2394 struct map_entry *m;
2396 char buf[BUFFER_SIZE];
2397 char *tmp_out_buffer;
2403 assert(template_ptr);
2404 assert(*template_ptr);
2407 file_buffer = *template_ptr;
2408 size = strlen(file_buffer) + 1;
2411 * Assemble pcrs joblist from exports map
2413 for (m = exports->first; m != NULL; m = m->next)
2415 if (*m->name == '$')
2418 * First character of name is '$', so remove this flag
2419 * character and allow backreferences ($1 etc) in the
2420 * "replace with" text.
2422 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2428 * Treat the "replace with" text as a literal string -
2429 * no quoting needed, no backreferences allowed.
2430 * ("Trivial" ['T'] flag).
2434 /* Enclose name in @@ */
2435 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2439 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2441 /* Make and run job. */
2442 job = pcrs_compile(buf, m->value, flags, &error);
2445 if (error == PCRS_ERR_NOMEM)
2448 *template_ptr = NULL;
2449 return JB_ERR_MEMORY;
2453 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2454 /* Hope it wasn't important and silently ignore the invalid job */
2459 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2462 if (NULL == tmp_out_buffer)
2464 *template_ptr = NULL;
2465 return JB_ERR_MEMORY;
2471 * Substitution failed, keep the original buffer,
2472 * log the problem and ignore it.
2474 * The user might see some unresolved @CGI_VARIABLES@,
2475 * but returning a special CGI error page seems unreasonable
2476 * and could mask more important error messages.
2478 free(tmp_out_buffer);
2479 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2480 buf, m->value, flags, pcrs_strerror(error));
2484 /* Substitution succeeded, use modified buffer. */
2486 file_buffer = tmp_out_buffer;
2494 *template_ptr = file_buffer;
2499 /*********************************************************************
2501 * Function : template_fill_for_cgi
2503 * Description : CGI support function that loads a HTML template
2504 * and fills it in. Handles file-not-found errors
2505 * by sending a HTML error message. For convenience,
2506 * this function also frees the passed "exports" map.
2509 * 1 : csp = Client state
2510 * 2 : templatename = name of the HTML template to be used
2511 * 3 : exports = map with fill in symbol -> name pairs.
2512 * Will be freed by this function.
2513 * 4 : rsp = Response structure to fill in.
2515 * Returns : JB_ERR_OK on success
2516 * JB_ERR_MEMORY on out-of-memory error
2518 *********************************************************************/
2519 jb_err template_fill_for_cgi(struct client_state *csp,
2520 const char *templatename,
2521 struct map *exports,
2522 struct http_response *rsp)
2527 assert(templatename);
2531 err = template_load(csp, &rsp->body, templatename, 0);
2532 if (err == JB_ERR_FILE)
2535 return cgi_error_no_template(csp, rsp, templatename);
2540 return err; /* JB_ERR_MEMORY */
2542 err = template_fill(&rsp->body, exports);
2548 /*********************************************************************
2550 * Function : default_exports
2552 * Description : returns a struct map list that contains exports
2553 * which are common to all CGI functions.
2556 * 1 : csp = Current client state (buffers, headers, etc...)
2557 * 2 : caller = name of CGI who calls us and which should
2558 * be excluded from the generated menu. May be
2560 * Returns : NULL if no memory, else a new map. Caller frees.
2562 *********************************************************************/
2563 struct map *default_exports(const struct client_state *csp, const char *caller)
2567 struct map * exports;
2568 int local_help_exists = 0;
2569 char *ip_address = NULL;
2570 char *hostname = NULL;
2574 exports = new_map();
2575 if (exports == NULL)
2580 get_host_information(csp->cfd, &ip_address, &hostname);
2582 err = map(exports, "version", 1, html_encode(VERSION), 0);
2583 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2585 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2587 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2588 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2589 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2590 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2591 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2592 !strncmpic(csp->config->usermanual, "http", 4))
2594 /* Manual is located somewhere else, just link to it. */
2595 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2599 /* Manual is delivered by Privoxy. */
2600 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2602 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2603 #ifdef FEATURE_TOGGLE
2604 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2606 if (!err) err = map_block_killer(exports, "can-toggle");
2609 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2610 if (!err) err = map(exports, "my-port", 1, buf, 1);
2612 if(!strcmp(CODE_STATUS, "stable"))
2614 if (!err) err = map_block_killer(exports, "unstable");
2617 if (csp->config->admin_address != NULL)
2619 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2620 local_help_exists = 1;
2624 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2627 if (csp->config->proxy_info_url != NULL)
2629 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2630 local_help_exists = 1;
2634 if (!err) err = map_block_killer(exports, "have-proxy-info");
2637 if (local_help_exists == 0)
2639 if (!err) err = map_block_killer(exports, "have-help-info");
2652 /*********************************************************************
2654 * Function : map_block_killer
2656 * Description : Convenience function.
2657 * Adds a "killer" for the conditional HTML-template
2658 * block <name>, i.e. a substitution of the regex
2659 * "if-<name>-start.*if-<name>-end" to the given
2663 * 1 : exports = map to extend
2664 * 2 : name = name of conditional block
2666 * Returns : JB_ERR_OK on success
2667 * JB_ERR_MEMORY on out-of-memory error.
2669 *********************************************************************/
2670 jb_err map_block_killer(struct map *exports, const char *name)
2672 char buf[1000]; /* Will do, since the names are hardwired */
2676 assert(strlen(name) < 490);
2678 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2679 return map(exports, buf, 1, "", 1);
2683 /*********************************************************************
2685 * Function : map_block_keep
2687 * Description : Convenience function. Removes the markers used
2688 * by map-block-killer, to save a few bytes.
2689 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2692 * 1 : exports = map to extend
2693 * 2 : name = name of conditional block
2695 * Returns : JB_ERR_OK on success
2696 * JB_ERR_MEMORY on out-of-memory error.
2698 *********************************************************************/
2699 jb_err map_block_keep(struct map *exports, const char *name)
2702 char buf[500]; /* Will do, since the names are hardwired */
2706 assert(strlen(name) < 490);
2708 snprintf(buf, sizeof(buf), "if-%s-start", name);
2709 err = map(exports, buf, 1, "", 1);
2716 snprintf(buf, sizeof(buf), "if-%s-end", name);
2717 return map(exports, buf, 1, "", 1);
2721 /*********************************************************************
2723 * Function : map_conditional
2725 * Description : Convenience function.
2726 * Adds an "if-then-else" for the conditional HTML-template
2727 * block <name>, i.e. a substitution of the form:
2734 * The control structure and one of the alternatives
2738 * 1 : exports = map to extend
2739 * 2 : name = name of conditional block
2740 * 3 : choose_first = nonzero for first, zero for second.
2742 * Returns : JB_ERR_OK on success
2743 * JB_ERR_MEMORY on out-of-memory error.
2745 *********************************************************************/
2746 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2748 char buf[1000]; /* Will do, since the names are hardwired */
2753 assert(strlen(name) < 480);
2755 snprintf(buf, sizeof(buf), (choose_first
2756 ? "else-not-%s@.*@endif-%s"
2757 : "if-%s-then@.*@else-not-%s"),
2760 err = map(exports, buf, 1, "", 1);
2766 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2767 return map(exports, buf, 1, "", 1);
2771 /*********************************************************************
2773 * Function : make_menu
2775 * Description : Returns an HTML-formatted menu of the available
2776 * unhidden CGIs, excluding the one given in <self>
2777 * and the toggle CGI if toggling is disabled.
2780 * 1 : self = name of CGI to leave out, can be NULL for
2782 * 2 : feature_flags = feature bitmap from csp->config
2785 * Returns : menu string, or NULL on out-of-memory error.
2787 *********************************************************************/
2788 char *make_menu(const char *self, const unsigned feature_flags)
2790 const struct cgi_dispatcher *d;
2791 char *result = strdup("");
2795 self = "NO-SUCH-CGI!";
2798 /* List available unhidden CGI's and export as "other-cgis" */
2799 for (d = cgi_dispatchers; d->name; d++)
2802 #ifdef FEATURE_TOGGLE
2803 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2806 * Suppress the toggle link if remote toggling is disabled.
2810 #endif /* def FEATURE_TOGGLE */
2812 if (d->description && strcmp(d->name, self))
2814 char *html_encoded_prefix;
2817 * Line breaks would be great, but break
2818 * the "blocked" template's JavaScript.
2820 string_append(&result, "<li><a href=\"");
2821 html_encoded_prefix = html_encode(CGI_PREFIX);
2822 if (html_encoded_prefix == NULL)
2828 string_append(&result, html_encoded_prefix);
2829 free(html_encoded_prefix);
2831 string_append(&result, d->name);
2832 string_append(&result, "\">");
2833 string_append(&result, d->description);
2834 string_append(&result, "</a></li>");
2842 /*********************************************************************
2844 * Function : dump_map
2846 * Description : HTML-dump a map for debugging (as table)
2849 * 1 : the_map = map to dump
2851 * Returns : string with HTML
2853 *********************************************************************/
2854 char *dump_map(const struct map *the_map)
2856 struct map_entry *cur_entry;
2857 char *ret = strdup("");
2859 string_append(&ret, "<table>\n");
2861 for (cur_entry = the_map->first;
2862 (cur_entry != NULL) && (ret != NULL);
2863 cur_entry = cur_entry->next)
2865 string_append(&ret, "<tr><td><b>");
2866 string_join (&ret, html_encode(cur_entry->name));
2867 string_append(&ret, "</b></td><td>");
2868 string_join (&ret, html_encode(cur_entry->value));
2869 string_append(&ret, "</td></tr>\n");
2872 string_append(&ret, "</table>\n");