1 const char cgi_rcs[] = "$Id: cgi.c,v 1.101 2008/02/03 15:45:06 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.101 2008/02/03 15:45:06 fabiankeil
42 * Add SOCKS5 support for "Forwarding failure" CGI page.
44 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
45 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
48 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
49 * #1763173 from Stefan Huehner: declare some more functions static.
51 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
52 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
54 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
55 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
57 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
58 * Use sizeof() more often.
60 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
61 * Don't overlook map result for the forwarding-type.
63 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
64 * Use a transparent background for the PNG replacement pattern.
66 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
67 * - Save the reason for generating http_responses.
68 * - Fix --disable-toggle (again).
69 * - Use TBL birthday hack for 403 responses as well.
70 * - Uglify the @menu@ again to fix JavaScript
71 * errors on the "blocked" template.
72 * - Escape an ampersand in cgi_error_unknown().
74 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
75 * - Add HEAD support to finish_http_response.
76 * - Add error favicon to internal HTML error messages.
78 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
79 * Add new config option "templdir" to
80 * change the templates directory.
82 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
83 * Added "forwarding-failed" template support for error_response().
85 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
86 * Add favicon delivery functions.
88 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
89 * - Map variables that aren't guaranteed to be
90 * pure ASCII html_encoded.
91 * - Use CGI_PREFIX to generate URL for user manual
92 * CGI page to make sure CGI_SITE_2_PATH is included.
94 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
95 * - "Protect" against a rather lame JavaScript-based
96 * Privoxy detection "attack" and check the referrer
97 * before delivering the CGI style sheet.
98 * - Move referrer check for unsafe CGI pages into
99 * referrer_is_safe() and log the result.
100 * - Map @url@ in cgi-error-disabled page.
101 * It's required for the "go there anyway" link.
102 * - Mark *csp as immutable for grep_cgi_referrer().
104 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
105 * Fix strdup() error handling in cgi_error_unknown()
106 * and cgi_error_no_template(). Reported by Markus Elfring.
108 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
109 * Handle pcrs_execute() errors in template_fill() properly.
111 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
112 * Fixed gcc43 conversion warnings and replaced sprintf
113 * calls with snprintf to give OpenBSD's gcc one less reason
116 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
117 * Escape ampersand in Privoxy menu.
119 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
120 * Suppress the toggle link if remote toggling is disabled.
122 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
123 * Fix configure option --disable-toggle.
124 * Thanks to Peter Thoenen for reporting this.
126 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
127 * Don't lose the FORCE_PREFIX in case of
128 * connection problems. Fixes #612235.
130 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
131 * Make pthread mutex locking more generic. Instead of
132 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
133 * and use mutex locking unless there is an _r function
134 * available. Better safe than sorry.
136 * Fixes "./configure --disable-pthread" and should result
137 * in less threading-related problems on pthread-using platforms,
138 * but it still doesn't fix BR#1122404.
140 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
141 * Use CGI_PREFIX to check the referrer.
142 * The check for "http://config.privoxy.org/" fails
143 * if the user modified CGI_SITE_2_HOST.
145 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
146 * Adjusted headers for Privoxy's cgi responses:
147 * Don't set Last-Modified, Expires and Cache-Control
148 * headers for redirects; always set "Connection: close".
150 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
151 * Only predate the Last-Modified header for cgi responses
152 * that are delivered with status code 404 or 503.
154 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
155 * Mark cgi_send_user_manual as harmless,
156 * to fix the access denied problem Hal spotted.
157 * The manual has no secret content, therefore we
158 * don't have to care about "secure" referrers.
160 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
161 * Incorporate modified version of Roland Rosenfeld's patch to
162 * optionally access the user-manual via Privoxy. Closes patch 679075.
164 * Formatting changed to Privoxy style, added call to
165 * cgi_error_no_template if the requested file doesn't
166 * exist and modified check whether or not Privoxy itself
167 * should serve the manual. Should work cross-platform now.
169 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
170 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
172 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
173 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
174 * with what was really the latest development (the v_3_0_branch branch)
176 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
177 * Moved cgi_error_disabled() from cgiedit.c to
178 * cgi.c to re-enable build with --disable-editor.
179 * Fixes Bug #892744. Thanks to Matthew Fischer
182 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
183 * - Added new function cgi_redirect to handle creation of
184 * HTTP redirect messages formerly repeated in the code.
185 * - Send cgi_error_disabled instead of cgi_error_404 when
186 * referrer check fails
187 * - Dynamic content now gets Expires header field with date
190 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
191 * Bugfix: Transparent PNG was not transparent. Thanks to
192 * Dan Razzell of Starfish Systems for notice and new PNG.
194 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
195 * Security fix: dspatch_known_cgi no longer considers an empty
196 * referrer safe for critical CGIs, since malicious links could
197 * reside on https:// locations which browsers don't advertize as
198 * referrers. Closes bug #749916, thanks to Jeff Epler for the
199 * hint. Goodbye One-Click[tm] toggling :-(
201 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
204 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
205 * Killed a compiler warning on OSX
207 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
208 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
209 * (fixes bug #710056)
210 * - Show toggle info only if we have it
212 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
213 * Move declaration of struct tm dummy outside of a control block so it is
214 * accessible later on during snprintf in get_http_time.
216 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
217 * Cosmetic: Renamed cryptic variable
219 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
220 * 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.
222 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
223 * Disable access to critical CGIs via untrusted referrers.
224 * This prevents users from being tricked by malicious websites
225 * into making unintentional configuration changes:
227 * - Added flag to each cgi_dispatcher that allows or denies
229 * - Introduced proviorical function that greps for the
230 * referrer header before regular header parsing happens
231 * - Added safety check to dispatch_known_cgi. CGI is called
232 * if (cgi harmless || no referrer || we are referrer).
233 * Else a) toggle calls are modified not to change status and
234 * b) all other calls are denied.
236 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
237 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
239 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
240 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
242 * Revision 1.70 2002/05/19 11:33:20 jongfoster
243 * If a CGI error was not handled, and propogated back to
244 * dispatch_known_cgi(), then it was assumed to be "out of memory".
245 * This gave a very misleading error message.
247 * Now other errors will cause a simple message giving the error
248 * number and asking the user to report a bug.
251 * http://sourceforge.net/tracker/index.php?func=detail
252 * &aid=557905&group_id=11118&atid=111118
254 * Revision 1.69 2002/05/14 21:28:40 oes
255 * - Fixed add_help_link to link to the (now split) actions
256 * part of the config chapter
257 * - Renamed helplink export to actions-help-prefix
259 * Revision 1.68 2002/05/12 21:36:29 jongfoster
260 * Correcting function comments
262 * Revision 1.67 2002/04/30 12:02:07 oes
263 * Nit: updated a comment
265 * Revision 1.66 2002/04/26 18:32:57 jongfoster
266 * Fixing a memory leak on error
268 * Revision 1.65 2002/04/26 12:53:51 oes
269 * - New function add_help_link
270 * - default_exports now exports links to the user manual
271 * and a prefix for links into the config chapter
273 * Revision 1.64 2002/04/24 02:17:21 oes
274 * - Better descriptions for CGIs
275 * - Hide edit-actions, more shortcuts
276 * - Moved get_char_param, get_string_param and get_number_param here
279 * Revision 1.63 2002/04/15 19:06:43 jongfoster
282 * Revision 1.62 2002/04/10 19:59:46 jongfoster
283 * Fixes to #include in templates:
284 * - Didn't close main file if loading an included template fails.
285 * - I'm paranoid and want to disallow "#include /etc/passwd".
287 * Revision 1.61 2002/04/10 13:37:48 oes
288 * Made templates modular: template_load now recursive with max depth 1
290 * Revision 1.60 2002/04/08 20:50:25 swa
293 * Revision 1.59 2002/04/05 15:51:51 oes
294 * - added send-stylesheet CGI
295 * - bugfix: error-pages now get correct request protocol
297 * - kludged CGI descriptions and menu not to break JS syntax
299 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
300 * Fix Mac OSX compiler warnings
302 * Revision 1.57 2002/03/26 22:29:54 swa
303 * we have a new homepage!
305 * Revision 1.56 2002/03/24 17:50:46 jongfoster
306 * Fixing compile error if actions file editor disabled
308 * Revision 1.55 2002/03/24 16:55:06 oes
309 * Making GIF checkerboard transparent
311 * Revision 1.54 2002/03/24 16:18:15 jongfoster
314 * Revision 1.53 2002/03/24 16:06:00 oes
315 * Correct transparency for checkerboard PNG. Thanks, Magnus!
317 * Revision 1.52 2002/03/24 15:23:33 jongfoster
320 * Revision 1.51 2002/03/24 13:25:43 swa
321 * name change related issues
323 * Revision 1.50 2002/03/16 23:54:06 jongfoster
324 * Adding graceful termination feature, to help look for memory leaks.
325 * If you enable this (which, by design, has to be done by hand
326 * editing config.h) and then go to http://i.j.b/die, then the program
327 * will exit cleanly after the *next* request. It should free all the
328 * memory that was used.
330 * Revision 1.49 2002/03/13 00:27:04 jongfoster
333 * Revision 1.48 2002/03/08 17:47:07 jongfoster
336 * Revision 1.47 2002/03/08 16:41:33 oes
337 * Added GIF images again
339 * Revision 1.46 2002/03/07 03:48:38 oes
340 * - Changed built-in images from GIF to PNG
341 * (with regard to Unisys patent issue)
342 * - Added a 4x4 pattern PNG which is less intrusive
343 * than the logo but also clearly marks the deleted banners
345 * Revision 1.45 2002/03/06 22:54:35 jongfoster
346 * Automated function-comment nitpicking.
348 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
349 * - Better error reporting on OS/2
350 * - Fix double-slash comment (oops)
352 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
353 * - Re-enable OS/2 building after new parms were added
354 * - Fix false out of memory report when resolving CGI templates when no IP
355 * address is available of failed attempt (a la no such domain)
357 * Revision 1.42 2002/01/21 00:33:20 jongfoster
358 * Replacing strsav() with the safer string_append() or string_join().
359 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
360 * Adding missing html_encode() to error message generators.
361 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
363 * Revision 1.41 2002/01/17 20:56:22 jongfoster
364 * Replacing hard references to the URL of the config interface
365 * with #defines from project.h
367 * Revision 1.40 2002/01/09 14:26:46 oes
368 * Added support for thread-safe gmtime_r call.
370 * Revision 1.39 2001/11/16 00:48:13 jongfoster
371 * Fixing a compiler warning
373 * Revision 1.38 2001/11/13 00:31:21 jongfoster
374 * - Adding new CGIs for use by non-JavaScript browsers:
375 * edit-actions-url-form
376 * edit-actions-add-url-form
377 * edit-actions-remove-url-form
378 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
381 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
382 * Show enablement/disablement status in almost all templates.
383 * There is a little trickiness here: apparent recursive resolution of
384 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
385 * the actual enablement status. So a similar construct,
386 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
389 * Revision 1.36 2001/10/26 17:33:27 oes
392 * Revision 1.35 2001/10/23 21:48:19 jongfoster
393 * Cleaning up error handling in CGI functions - they now send back
394 * a HTML error page and should never cause a FATAL error. (Fixes one
395 * potential source of "denial of service" attacks).
397 * CGI actions file editor that works and is actually useful.
399 * Ability to toggle Junkbuster remotely using a CGI call.
401 * You can turn off both the above features in the main configuration
402 * file, e.g. if you are running a multi-user proxy.
404 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
405 * Only show "Local support" on templates conditionally:
406 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
407 * - if not, no Local support section appears
409 * Revision 1.33 2001/10/14 22:28:41 jongfoster
410 * Fixing stupid typo.
412 * Revision 1.32 2001/10/14 22:20:18 jongfoster
413 * - Changes to CGI dispatching method to match CGI names exactly,
414 * rather than doing a prefix match.
415 * - No longer need to count the length of the CGI handler names by hand.
416 * - Adding new handler for 404 error when disptching a CGI, if none of
417 * the handlers match.
418 * - Adding new handlers for CGI actionsfile editor.
420 * Revision 1.31 2001/10/10 10:56:39 oes
421 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
423 * Revision 1.30 2001/10/02 15:30:57 oes
424 * Introduced show-request cgi
426 * Revision 1.29 2001/09/20 15:47:44 steudten
428 * Fix BUG: Modify int size to size_t size in fill_template()
429 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
431 * Revision 1.28 2001/09/19 18:00:37 oes
432 * - Deletef time() FIXME (Can't fail under Linux either, if
433 * the argument is guaranteed to be in out address space,
436 * - Pointer notation cosmetics
437 * - Fixed a minor bug in template_fill(): Failiure of
438 * pcrs_execute() now secure.
440 * Revision 1.27 2001/09/16 17:08:54 jongfoster
441 * Moving simple CGI functions from cgi.c to new file cgisimple.c
443 * Revision 1.26 2001/09/16 15:47:37 jongfoster
444 * First version of CGI-based edit interface. This is very much a
445 * work-in-progress, and you can't actually use it to edit anything
446 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
447 * to have any effect.
449 * Revision 1.25 2001/09/16 15:02:35 jongfoster
450 * Adding i.j.b/robots.txt.
451 * Inlining add_stats() since it's only ever called from one place.
453 * Revision 1.24 2001/09/16 11:38:01 jongfoster
454 * Splitting fill_template() into 2 functions:
455 * template_load() loads the file
456 * template_fill() performs the PCRS regexps.
457 * This is because the CGI edit interface has a "table row"
458 * template which is used many times in the page - this
459 * change means it's only loaded from disk once.
461 * Revision 1.23 2001/09/16 11:16:05 jongfoster
462 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
464 * Revision 1.22 2001/09/16 11:00:10 jongfoster
465 * New function alloc_http_response, for symmetry with free_http_response
467 * Revision 1.21 2001/09/13 23:53:03 jongfoster
468 * Support for both static and dynamically generated CGI pages.
469 * Correctly setting Last-Modified: and Expires: HTTP headers.
471 * Revision 1.20 2001/09/13 23:40:36 jongfoster
472 * (Cosmetic only) Indentation correction
474 * Revision 1.19 2001/09/13 23:31:25 jongfoster
475 * Moving image data to cgi.c rather than cgi.h.
477 * Revision 1.18 2001/08/05 16:06:20 jongfoster
478 * Modifiying "struct map" so that there are now separate header and
479 * "map_entry" structures. This means that functions which modify a
480 * map no longer need to return a pointer to the modified map.
481 * Also, it no longer reverses the order of the entries (which may be
482 * important with some advanced template substitutions).
484 * Revision 1.17 2001/08/05 15:57:38 oes
485 * Adapted finish_http_response to new list_to_text
487 * Revision 1.16 2001/08/01 21:33:18 jongfoster
488 * Changes to fill_template() that reduce memory usage without having
489 * an impact on performance. I also renamed some variables so as not
490 * to clash with the C++ keywords "new" and "template".
492 * Revision 1.15 2001/08/01 21:19:22 jongfoster
493 * Moving file version information to a separate CGI page.
495 * Revision 1.14 2001/08/01 00:19:03 jongfoster
496 * New function: map_conditional() for an if-then-else syntax.
497 * Changing to use new version of show_defines()
499 * Revision 1.13 2001/07/30 22:08:36 jongfoster
500 * Tidying up #defines:
501 * - All feature #defines are now of the form FEATURE_xxx
502 * - Permanently turned off WIN_GUI_EDIT
503 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
505 * Revision 1.12 2001/07/29 18:47:05 jongfoster
506 * Adding missing #include "loadcfg.h"
508 * Revision 1.11 2001/07/18 17:24:37 oes
509 * Changed to conform to new pcrs interface
511 * Revision 1.10 2001/07/13 13:53:13 oes
512 * Removed all #ifdef PCRS and related code
514 * Revision 1.9 2001/06/29 21:45:41 oes
515 * Indentation, CRLF->LF, Tab-> Space
517 * Revision 1.8 2001/06/29 13:21:46 oes
518 * - Cosmetics: renamed and reordered functions, variables,
519 * texts, improved comments etc
521 * - Removed ij_untrusted_url() The relevant
522 * info is now part of the "untrusted" page,
523 * which is generated by filters.c:trust_url()
525 * - Generators of content now call finish_http_response()
526 * themselves, making jcc.c:chat() a little less
529 * - Removed obsolete "Pragma: no-cache" from our headers
531 * - http_responses now know their head length
533 * - fill_template now uses the new interface to pcrs, so that
534 * - long jobs (like whole files) no longer have to be assembled
535 * in a fixed size buffer
536 * - the new T (trivial) option is used, and the replacement may
537 * contain Perl syntax backrefs without confusing pcrs
539 * - Introduced default_exports() which generates a set of exports
540 * common to all CGIs and other content generators
542 * - Introduced convenience function map_block_killer()
544 * - Introduced convenience function make_menu()
546 * - Introduced CGI-like function error_response() which generates
547 * the "No such domain" and "Connect failed" messages using the
550 * - cgi_show_url_info:
551 * - adapted to new CGI features
552 * - form and answers now generated from same template
553 * - http:// prefix in URL now OK
556 * - adapted to new CGI features
557 * - no longer uses csp->init_proxy_args
560 * - moved menu generation to make_menu()
562 * - add_stats now writes single export map entries instead
565 * - Moved redirect_url() to filters.c
567 * - Fixed mem leak in free_http_response(), map_block_killer(),
569 * - Removed logentry from cancelled commit
571 * Revision 1.7 2001/06/09 10:51:58 jongfoster
572 * Changing "show URL info" handler to new style.
573 * Changing BUFSIZ ==> BUFFER_SIZE
575 * Revision 1.6 2001/06/07 23:05:19 jongfoster
576 * Removing code related to old forward and ACL files.
578 * Revision 1.5 2001/06/05 19:59:16 jongfoster
579 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
581 * Revision 1.4 2001/06/04 10:41:52 swa
582 * show version string of cgi.h and cgi.c
584 * Revision 1.3 2001/06/03 19:12:16 oes
585 * introduced new cgi handling
587 * No revisions before 1.3
589 **********************************************************************/
595 #include <sys/types.h>
609 #include "miscutil.h"
610 #include "cgisimple.h"
611 #ifdef FEATURE_CGI_EDIT_ACTIONS
613 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
615 /* loadcfg.h is for global_toggle_state only */
616 #ifdef FEATURE_PTHREAD
618 /* jcc.h is for mutex semaphore globals only */
619 #endif /* def FEATURE_PTHREAD */
620 const char cgi_h_rcs[] = CGI_H_VERSION;
623 * List of CGI functions: name, handler, description
624 * Note: Do NOT use single quotes in the description;
625 * this will break the dynamic "blocked" template!
627 static const struct cgi_dispatcher cgi_dispatchers[] = {
632 #ifdef FEATURE_GRACEFUL_TERMINATION
635 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
636 "this is a one click Denial Of Service attack!!!</em>",
641 #ifdef FEATURE_CGI_EDIT_ACTIONS
642 "View & change the current configuration",
644 "View the current configuration",
649 "View the source code version numbers",
653 "View the request headers.",
657 "Look up which actions apply to a URL and why",
659 #ifdef FEATURE_CGI_EDIT_ACTIONS
660 #ifdef FEATURE_TOGGLE
663 "Toggle Privoxy on or off",
665 #endif /* def FEATURE_TOGGLE */
666 { "edit-actions", /* Edit the actions list */
669 { "eaa", /* Shortcut for edit-actions-add-url-form */
670 cgi_edit_actions_add_url_form,
672 { "eau", /* Shortcut for edit-actions-url-form */
673 cgi_edit_actions_url_form,
675 { "ear", /* Shortcut for edit-actions-remove-url-form */
676 cgi_edit_actions_remove_url_form,
678 { "eal", /* Shortcut for edit-actions-list */
679 cgi_edit_actions_list,
681 { "eafu", /* Shortcut for edit-actions-for-url */
682 cgi_edit_actions_for_url,
684 { "eas", /* Shortcut for edit-actions-submit */
685 cgi_edit_actions_submit,
687 { "easa", /* Shortcut for edit-actions-section-add */
688 cgi_edit_actions_section_add,
690 { "easr", /* Shortcut for edit-actions-section-remove */
691 cgi_edit_actions_section_remove,
693 { "eass", /* Shortcut for edit-actions-section-swap */
694 cgi_edit_actions_section_swap,
696 { "edit-actions-for-url",
697 cgi_edit_actions_for_url,
698 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
699 { "edit-actions-list",
700 cgi_edit_actions_list,
701 NULL, TRUE /* Edit the actions list */ },
702 { "edit-actions-submit",
703 cgi_edit_actions_submit,
704 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
705 { "edit-actions-url",
706 cgi_edit_actions_url,
707 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
708 { "edit-actions-url-form",
709 cgi_edit_actions_url_form,
710 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
711 { "edit-actions-add-url",
712 cgi_edit_actions_add_url,
713 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
714 { "edit-actions-add-url-form",
715 cgi_edit_actions_add_url_form,
716 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
717 { "edit-actions-remove-url",
718 cgi_edit_actions_remove_url,
719 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
720 { "edit-actions-remove-url-form",
721 cgi_edit_actions_remove_url_form,
722 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
723 { "edit-actions-section-add",
724 cgi_edit_actions_section_add,
725 NULL, FALSE /* Remove a section from the actionsfile */ },
726 { "edit-actions-section-remove",
727 cgi_edit_actions_section_remove,
728 NULL, FALSE /* Remove a section from the actionsfile */ },
729 { "edit-actions-section-swap",
730 cgi_edit_actions_section_swap,
731 NULL, FALSE /* Swap two sections in the actionsfile */ },
732 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
733 { "error-favicon.ico",
734 cgi_send_error_favicon,
735 NULL, TRUE /* Sends the favicon image for error pages. */ },
737 cgi_send_default_favicon,
738 NULL, TRUE /* Sends the default favicon image. */ },
741 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
744 NULL, TRUE /* Send a built-in image */ },
747 NULL, FALSE /* Send templates/cgi-style.css */ },
749 cgi_transparent_image,
750 NULL, TRUE /* Send a transparent image (short name) */ },
752 cgi_send_user_manual,
753 NULL, TRUE /* Send user-manual */ },
754 { NULL, /* NULL Indicates end of list and default page */
756 NULL, TRUE /* Unknown CGI page */ }
761 * Built-in images for ad replacement
763 * Hint: You can encode your own images like this:
764 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
767 #ifdef FEATURE_NO_GIFS
770 * Checkerboard pattern, as a PNG.
772 const char image_pattern_data[] =
773 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
774 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
775 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
776 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
777 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
778 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
779 "\000\000\000\000\111\105\116\104\256\102\140\202";
782 * 1x1 transparant PNG.
784 const char image_blank_data[] =
785 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
786 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
787 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
788 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
789 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
790 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
791 "\000\000\000\000\111\105\116\104\256\102\140\202";
795 * Checkerboard pattern, as a GIF.
797 const char image_pattern_data[] =
798 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
799 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
800 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
801 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
805 * 1x1 transparant GIF.
807 const char image_blank_data[] =
808 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
809 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
810 "\000\001\000\000\002\002D\001\000;";
813 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
814 const size_t image_blank_length = sizeof(image_blank_data) - 1;
817 static struct http_response cgi_error_memory_response[1];
819 static struct http_response *dispatch_known_cgi(struct client_state * csp,
821 static struct map *parse_cgi_parameters(char *argstring);
824 /*********************************************************************
826 * Function : dispatch_cgi
828 * Description : Checks if a request URL has either the magical
829 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
830 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
831 * http://config.privoxy.org/). If so, it passes
832 * the (rest of the) path onto dispatch_known_cgi, which
833 * calls the relevant CGI handler function.
836 * 1 : csp = Current client state (buffers, headers, etc...)
838 * Returns : http_response if match, NULL if nonmatch or handler fail
840 *********************************************************************/
841 struct http_response *dispatch_cgi(struct client_state *csp)
843 const char *host = csp->http->host;
844 const char *path = csp->http->path;
847 * Should we intercept ?
850 /* Note: "example.com" and "example.com." are equivalent hostnames. */
852 /* Either the host matches CGI_SITE_1_HOST ..*/
853 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
854 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
855 && (path[0] == '/') )
857 /* ..then the path will all be for us. Remove leading '/' */
860 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
861 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
862 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
863 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
865 /* take everything following CGI_SITE_2_PATH */
866 path += strlen(CGI_SITE_2_PATH);
869 /* skip the forward slash after CGI_SITE_2_PATH */
872 else if (*path != '\0')
875 * weirdness: URL is /configXXX, where XXX is some string
876 * Do *NOT* intercept.
888 * This is a CGI call.
891 return dispatch_known_cgi(csp, path);
895 /*********************************************************************
897 * Function : grep_cgi_referrer
899 * Description : Ugly provisorical fix that greps the value of the
900 * referer HTTP header field out of a linked list of
901 * strings like found at csp->headers. Will disappear
904 * FIXME: csp->headers ought to be csp->http->headers
905 * FIXME: Parsing all client header lines should
906 * happen right after the request is received!
909 * 1 : csp = Current client state (buffers, headers, etc...)
911 * Returns : pointer to value (no copy!), or NULL if none found.
913 *********************************************************************/
914 static char *grep_cgi_referrer(const struct client_state *csp)
916 struct list_entry *p;
918 for (p = csp->headers->first; p != NULL; p = p->next)
920 if (p->str == NULL) continue;
921 if (strncmpic(p->str, "Referer: ", 9) == 0)
923 return ((p->str) + 9);
931 /*********************************************************************
933 * Function : referrer_is_safe
935 * Description : Decides whether we trust the Referer for
936 * CGI pages which are only meant to be reachable
937 * through Privoxy's web interface directly.
940 * 1 : csp = Current client state (buffers, headers, etc...)
942 * Returns : TRUE if the referrer is safe, or
943 * FALSE if the referrer is unsafe or not set.
945 *********************************************************************/
946 static int referrer_is_safe(const struct client_state *csp)
949 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
951 referrer = grep_cgi_referrer(csp);
953 if (NULL == referrer)
955 /* No referrer, no access */
956 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
959 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
960 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
962 /* Trustworthy referrer */
963 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
964 csp->http->url, referrer);
970 /* Untrustworthy referrer */
971 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
972 csp->http->url, referrer);
979 /*********************************************************************
981 * Function : dispatch_known_cgi
983 * Description : Processes a CGI once dispatch_cgi has determined that
984 * it matches one of the magic prefixes. Parses the path
985 * as a cgi name plus query string, prepares a map that
986 * maps CGI parameter names to their values, initializes
987 * the http_response struct, and calls the relevant CGI
991 * 1 : csp = Current client state (buffers, headers, etc...)
992 * 2 : path = Path of CGI, with the CGI prefix removed.
993 * Should not have a leading "/".
995 * Returns : http_response, or NULL on handler failure or out of
998 *********************************************************************/
999 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1002 const struct cgi_dispatcher *d;
1003 struct map *param_list;
1004 struct http_response *rsp;
1005 char *query_args_start;
1009 if (NULL == (path_copy = strdup(path)))
1011 return cgi_error_memory();
1013 query_args_start = path_copy;
1014 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1018 if (*query_args_start == '/')
1020 *query_args_start++ = '\0';
1021 if ((param_list = new_map()))
1023 map(param_list, "file", 1, url_decode(query_args_start), 0);
1028 if (*query_args_start == '?')
1030 *query_args_start++ = '\0';
1032 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1035 return cgi_error_memory();
1041 * path_copy = CGI call name
1042 * param_list = CGI params, as map
1045 /* Get mem for response or fail*/
1046 if (NULL == (rsp = alloc_http_response()))
1049 free_map(param_list);
1050 return cgi_error_memory();
1054 * Find and start the right CGI function
1056 d = cgi_dispatchers;
1059 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1062 * If the called CGI is either harmless, or referred
1063 * from a trusted source, start it.
1065 if (d->harmless || referrer_is_safe(csp))
1067 err = (d->handler)(csp, rsp, param_list);
1072 * Else, modify toggle calls so that they only display
1073 * the status, and deny all other calls.
1075 if (0 == strcmp(path_copy, "toggle"))
1077 unmap(param_list, "set");
1078 err = (d->handler)(csp, rsp, param_list);
1082 err = cgi_error_disabled(csp, rsp);
1087 free_map(param_list);
1089 if (err == JB_ERR_CGI_PARAMS)
1091 err = cgi_error_bad_param(csp, rsp);
1093 if (err && (err != JB_ERR_MEMORY))
1095 /* Unexpected error! Shouldn't get here */
1096 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1097 err = cgi_error_unknown(csp, rsp, err);
1102 rsp->reason = RSP_REASON_CGI_CALL;
1103 return finish_http_response(csp, rsp);
1107 /* Error in handler, probably out-of-memory */
1108 free_http_response(rsp);
1109 return cgi_error_memory();
1117 /*********************************************************************
1119 * Function : parse_cgi_parameters
1121 * Description : Parse a URL-encoded argument string into name/value
1122 * pairs and store them in a struct map list.
1125 * 1 : argstring = string to be parsed. Will be trashed.
1127 * Returns : pointer to param list, or NULL if out of memory.
1129 *********************************************************************/
1130 static struct map *parse_cgi_parameters(char *argstring)
1133 char *vector[BUFFER_SIZE];
1135 struct map *cgi_params;
1137 if (NULL == (cgi_params = new_map()))
1143 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1144 * the fragment identifier along with the request, so we must
1145 * cut it off here, so it won't pollute the CGI params:
1147 if (NULL != (p = strchr(argstring, '#')))
1152 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1154 for (i = 0; i < pairs; i++)
1156 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1159 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1161 free_map(cgi_params);
1172 /*********************************************************************
1174 * Function : get_char_param
1176 * Description : Get a single-character parameter passed to a CGI
1180 * 1 : parameters = map of cgi parameters
1181 * 2 : param_name = The name of the parameter to read
1183 * Returns : Uppercase character on success, '\0' on error.
1185 *********************************************************************/
1186 char get_char_param(const struct map *parameters,
1187 const char *param_name)
1194 ch = *(lookup(parameters, param_name));
1195 if ((ch >= 'a') && (ch <= 'z'))
1197 ch = (char)(ch - 'a' + 'A');
1204 /*********************************************************************
1206 * Function : get_string_param
1208 * Description : Get a string paramater, to be used as an
1209 * ACTION_STRING or ACTION_MULTI paramater.
1210 * Validates the input to prevent stupid/malicious
1211 * users from corrupting their action file.
1214 * 1 : parameters = map of cgi parameters
1215 * 2 : param_name = The name of the parameter to read
1216 * 3 : pparam = destination for paramater. Allocated as
1217 * part of the map "parameters", so don't free it.
1218 * Set to NULL if not specified.
1220 * Returns : JB_ERR_OK on success, or if the paramater
1221 * was not specified.
1222 * JB_ERR_MEMORY on out-of-memory.
1223 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1225 *********************************************************************/
1226 jb_err get_string_param(const struct map *parameters,
1227 const char *param_name,
1228 const char **pparam)
1240 param = lookup(parameters, param_name);
1246 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1251 * Note that the length limit is arbitrary, it just seems
1252 * sensible to limit it to *something*. There's no
1253 * technical reason for any limit at all.
1255 return JB_ERR_CGI_PARAMS;
1258 /* Check every character to see if it's legal */
1260 while ((ch = *s++) != '\0')
1262 if ( ((unsigned char)ch < (unsigned char)' ')
1265 /* Probable hack attempt, or user accidentally used '}'. */
1266 return JB_ERR_CGI_PARAMS;
1277 /*********************************************************************
1279 * Function : get_number_param
1281 * Description : Get a non-negative integer from the parameters
1282 * passed to a CGI function.
1285 * 1 : csp = Current client state (buffers, headers, etc...)
1286 * 2 : parameters = map of cgi parameters
1287 * 3 : name = Name of CGI parameter to read
1288 * 4 : pvalue = destination for value.
1289 * Set to -1 on error.
1291 * Returns : JB_ERR_OK on success
1292 * JB_ERR_MEMORY on out-of-memory
1293 * JB_ERR_CGI_PARAMS if the parameter was not specified
1296 *********************************************************************/
1297 jb_err get_number_param(struct client_state *csp,
1298 const struct map *parameters,
1313 param = lookup(parameters, name);
1316 return JB_ERR_CGI_PARAMS;
1319 /* We don't use atoi because I want to check this carefully... */
1322 while ((ch = *param++) != '\0')
1324 if ((ch < '0') || (ch > '9'))
1326 return JB_ERR_CGI_PARAMS;
1329 ch = (char)(ch - '0');
1333 * <limits.h> defines UINT_MAX
1335 * (UINT_MAX - ch) / 10 is the largest number that
1336 * can be safely multiplied by 10 then have ch added.
1338 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1340 return JB_ERR_CGI_PARAMS;
1343 value = value * 10 + (unsigned)ch;
1354 /*********************************************************************
1356 * Function : error_response
1358 * Description : returns an http_response that explains the reason
1359 * why a request failed.
1362 * 1 : csp = Current client state (buffers, headers, etc...)
1363 * 2 : templatename = Which template should be used for the answer
1364 * 3 : sys_err = system error number
1366 * Returns : A http_response. If we run out of memory, this
1367 * will be cgi_error_memory().
1369 *********************************************************************/
1370 struct http_response *error_response(struct client_state *csp,
1371 const char *templatename,
1375 struct http_response *rsp;
1376 struct map *exports = default_exports(csp, NULL);
1379 if (exports == NULL)
1381 return cgi_error_memory();
1384 if (NULL == (rsp = alloc_http_response()))
1387 return cgi_error_memory();
1390 #ifdef FEATURE_FORCE_LOAD
1391 if (csp->flags & CSP_FLAG_FORCED)
1393 path = strdup(FORCE_PREFIX);
1396 #endif /* def FEATURE_FORCE_LOAD */
1400 err = string_append(&path, csp->http->path);
1402 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1403 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1404 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1405 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1406 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1409 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1412 /* Some failures, like "404 no such domain", don't have an IP address. */
1413 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1421 free_http_response(rsp);
1422 return cgi_error_memory();
1425 if (!strcmp(templatename, "no-such-domain"))
1427 rsp->status = strdup("404 No such domain");
1428 if (rsp->status == NULL)
1431 free_http_response(rsp);
1432 return cgi_error_memory();
1434 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1436 else if (!strcmp(templatename, "forwarding-failed"))
1438 const struct forward_spec *fwd = forward_url(csp, csp->http);
1439 char *socks_type = NULL;
1442 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1443 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1447 * XXX: While the template is called forwarding-failed,
1448 * it currently only handles socks forwarding failures.
1450 assert(fwd->type != SOCKS_NONE);
1453 * Map failure reason, forwarding type and forwarder.
1455 if (NULL == csp->error_message)
1458 * Either we forgot to record the failure reason,
1459 * or the memory allocation failed.
1461 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1462 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1464 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1467 * XXX: this is almost the same code as in cgi_show_url_info()
1468 * and thus should be factored out and shared.
1473 socks_type = "socks4-";
1476 socks_type = "socks4a-";
1479 socks_type = "socks5-";
1482 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1485 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1486 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1488 if (!err) rsp->status = strdup("503 Forwarding failure");
1489 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1492 free_http_response(rsp);
1493 return cgi_error_memory();
1495 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1497 else if (!strcmp(templatename, "connect-failed"))
1499 rsp->status = strdup("503 Connect failed");
1500 if (rsp->status == NULL)
1503 free_http_response(rsp);
1504 return cgi_error_memory();
1506 rsp->reason = RSP_REASON_CONNECT_FAILED;
1509 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1512 free_http_response(rsp);
1513 return cgi_error_memory();
1516 return finish_http_response(csp, rsp);
1520 /*********************************************************************
1522 * Function : cgi_error_disabled
1524 * Description : CGI function that is called to generate an error
1525 * response if the actions editor or toggle CGI are
1526 * accessed despite having being disabled at compile-
1527 * or run-time, or if the user followed an untrusted link
1528 * to access a unsafe CGI feature that is only reachable
1529 * through Privoxy directly.
1532 * 1 : csp = Current client state (buffers, headers, etc...)
1533 * 2 : rsp = http_response data structure for output
1535 * CGI Parameters : none
1537 * Returns : JB_ERR_OK on success
1538 * JB_ERR_MEMORY on out-of-memory error.
1540 *********************************************************************/
1541 jb_err cgi_error_disabled(struct client_state *csp,
1542 struct http_response *rsp)
1544 struct map *exports;
1549 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1551 return JB_ERR_MEMORY;
1553 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1555 /* Not important enough to do anything */
1556 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1559 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1563 /*********************************************************************
1565 * Function : cgi_init_error_messages
1567 * Description : Call at the start of the program to initialize
1568 * the error message used by cgi_error_memory().
1574 *********************************************************************/
1575 void cgi_init_error_messages(void)
1577 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1578 cgi_error_memory_response->head =
1579 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1580 "Content-Type: text/html\r\n"
1582 cgi_error_memory_response->body =
1585 " <title>500 Internal Privoxy Error</title>\r\n"
1586 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1589 "<h1>500 Internal Privoxy Error</h1>\r\n"
1590 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1591 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1595 cgi_error_memory_response->head_length =
1596 strlen(cgi_error_memory_response->head);
1597 cgi_error_memory_response->content_length =
1598 strlen(cgi_error_memory_response->body);
1599 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1603 /*********************************************************************
1605 * Function : cgi_error_memory
1607 * Description : Called if a CGI function runs out of memory.
1608 * Returns a statically-allocated error response.
1612 * Returns : http_response data structure for output. This is
1613 * statically allocated, for obvious reasons.
1615 *********************************************************************/
1616 struct http_response *cgi_error_memory(void)
1618 /* assert that it's been initialized. */
1619 assert(cgi_error_memory_response->head);
1621 return cgi_error_memory_response;
1625 /*********************************************************************
1627 * Function : cgi_error_no_template
1629 * Description : Almost-CGI function that is called if a template
1630 * cannot be loaded. Note this is not a true CGI,
1631 * it takes a template name rather than a map of
1635 * 1 : csp = Current client state (buffers, headers, etc...)
1636 * 2 : rsp = http_response data structure for output
1637 * 3 : template_name = Name of template that could not
1640 * Returns : JB_ERR_OK on success
1641 * JB_ERR_MEMORY on out-of-memory error.
1643 *********************************************************************/
1644 jb_err cgi_error_no_template(struct client_state *csp,
1645 struct http_response *rsp,
1646 const char *template_name)
1648 static const char status[] =
1649 "500 Internal Privoxy Error";
1650 static const char body_prefix[] =
1653 " <title>500 Internal Privoxy Error</title>\r\n"
1654 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1657 "<h1>500 Internal Privoxy Error</h1>\r\n"
1658 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1659 "<p><b>Could not load template file <code>";
1660 static const char body_suffix[] =
1661 "</code> or one of it's included components.</b></p>\r\n"
1662 "<p>Please contact your proxy administrator.</p>\r\n"
1663 "<p>If you are the proxy administrator, please put the required file(s)"
1664 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1665 "location of the <code><i>(confdir)</i></code> directory "
1666 "is specified in the main Privoxy <code>config</code> "
1667 "file. (It's typically the Privoxy install directory"
1669 ", or <code>/etc/privoxy/</code>"
1670 #endif /* ndef _WIN32 */
1674 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1678 assert(template_name);
1680 /* Reset rsp, if needed */
1684 rsp->content_length = 0;
1685 rsp->head_length = 0;
1688 rsp->body = malloc(body_size);
1689 if (rsp->body == NULL)
1691 return JB_ERR_MEMORY;
1693 strlcpy(rsp->body, body_prefix, body_size);
1694 strlcat(rsp->body, template_name, body_size);
1695 strlcat(rsp->body, body_suffix, body_size);
1697 rsp->status = strdup(status);
1698 if (rsp->status == NULL)
1700 return JB_ERR_MEMORY;
1707 /*********************************************************************
1709 * Function : cgi_error_unknown
1711 * Description : Almost-CGI function that is called if an unexpected
1712 * error occurs in the top-level CGI dispatcher.
1713 * In this context, "unexpected" means "anything other
1714 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1715 * expected to handle all other errors internally,
1716 * since they can give more relavent error messages
1719 * Note this is not a true CGI, it takes an error
1720 * code rather than a map of parameters.
1723 * 1 : csp = Current client state (buffers, headers, etc...)
1724 * 2 : rsp = http_response data structure for output
1725 * 3 : error_to_report = Error code to report.
1727 * Returns : JB_ERR_OK on success
1728 * JB_ERR_MEMORY on out-of-memory error.
1730 *********************************************************************/
1731 jb_err cgi_error_unknown(struct client_state *csp,
1732 struct http_response *rsp,
1733 jb_err error_to_report)
1735 static const char status[] =
1736 "500 Internal Privoxy Error";
1737 static const char body_prefix[] =
1740 " <title>500 Internal Privoxy Error</title>\r\n"
1741 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1744 "<h1>500 Internal Privoxy Error</h1>\r\n"
1745 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1746 "<p><b>Unexpected internal error: ";
1747 static const char body_suffix[] =
1750 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1751 "file a bug report</a>.</p>\r\n"
1756 * Due to sizeof(errnumbuf), body_size will be slightly
1757 * bigger than necessary but it doesn't really matter.
1759 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1763 /* Reset rsp, if needed */
1767 rsp->content_length = 0;
1768 rsp->head_length = 0;
1770 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1772 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1774 rsp->body = malloc(body_size);
1775 if (rsp->body == NULL)
1777 return JB_ERR_MEMORY;
1779 strlcpy(rsp->body, body_prefix, body_size);
1780 strlcat(rsp->body, errnumbuf, body_size);
1781 strlcat(rsp->body, body_suffix, body_size);
1783 rsp->status = strdup(status);
1784 if (rsp->status == NULL)
1786 return JB_ERR_MEMORY;
1793 /*********************************************************************
1795 * Function : cgi_error_bad_param
1797 * Description : CGI function that is called if the parameters
1798 * (query string) for a CGI were wrong.
1801 * 1 : csp = Current client state (buffers, headers, etc...)
1802 * 2 : rsp = http_response data structure for output
1804 * CGI Parameters : none
1806 * Returns : JB_ERR_OK on success
1807 * JB_ERR_MEMORY on out-of-memory error.
1809 *********************************************************************/
1810 jb_err cgi_error_bad_param(struct client_state *csp,
1811 struct http_response *rsp)
1813 struct map *exports;
1818 if (NULL == (exports = default_exports(csp, NULL)))
1820 return JB_ERR_MEMORY;
1823 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1827 /*********************************************************************
1829 * Function : cgi_redirect
1831 * Description : CGI support function to generate a HTTP redirect
1835 * 1 : rsp = http_response data structure for output
1836 * 2 : target = string with the target URL
1838 * CGI Parameters : None
1840 * Returns : JB_ERR_OK on success
1841 * JB_ERR_MEMORY on out-of-memory error.
1843 *********************************************************************/
1844 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1851 err = enlist_unique_header(rsp->headers, "Location", target);
1853 rsp->status = strdup("302 Local Redirect from Privoxy");
1854 if (rsp->status == NULL)
1856 return JB_ERR_MEMORY;
1863 /*********************************************************************
1865 * Function : add_help_link
1867 * Description : Produce a copy of the string given as item,
1868 * embedded in an HTML link to its corresponding
1869 * section (item name in uppercase) in the actions
1870 * chapter of the user manual, (whose URL is given in
1871 * the config and defaults to our web site).
1873 * FIXME: I currently only work for actions, and would
1874 * like to be generalized for other topics.
1877 * 1 : item = item (will NOT be free()d.)
1878 * It is assumed to be HTML-safe.
1879 * 2 : config = The current configuration.
1881 * Returns : String with item embedded in link, or NULL on
1884 *********************************************************************/
1885 char *add_help_link(const char *item,
1886 struct configuration_spec *config)
1890 if (!item) return NULL;
1892 result = strdup("<a href=\"");
1893 if (!strncmpic(config->usermanual, "file://", 7) ||
1894 !strncmpic(config->usermanual, "http", 4))
1896 string_append(&result, config->usermanual);
1900 string_append(&result, "http://");
1901 string_append(&result, CGI_SITE_2_HOST);
1902 string_append(&result, "/user-manual/");
1904 string_append(&result, ACTIONS_HELP_PREFIX);
1905 string_join (&result, string_toupper(item));
1906 string_append(&result, "\">");
1907 string_append(&result, item);
1908 string_append(&result, "</a> ");
1914 /*********************************************************************
1916 * Function : get_http_time
1918 * Description : Get the time in a format suitable for use in a
1919 * HTTP header - e.g.:
1920 * "Sun, 06 Nov 1994 08:49:37 GMT"
1922 * XXX: Should probably get a third parameter for
1926 * 1 : time_offset = Time returned will be current time
1927 * plus this number of seconds.
1928 * 2 : buf = Destination for result. Must be long enough
1929 * to hold 29 characters plus a trailing zero.
1933 *********************************************************************/
1934 void get_http_time(int time_offset, char *buf)
1936 static const char day_names[7][4] =
1937 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1938 static const char month_names[12][4] =
1939 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1940 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1943 time_t current_time;
1944 #if defined(HAVE_GMTIME_R)
1946 * Declare dummy up here (instead of inside get/set gmt block) so it
1947 * doesn't go out of scope before it's potentially used in snprintf later.
1948 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1949 * !defined HAVE_GMTIME_R.
1956 time(¤t_time); /* get current time */
1958 current_time += time_offset;
1960 /* get and save the gmt */
1963 t = gmtime_r(¤t_time, &dummy);
1964 #elif FEATURE_PTHREAD
1965 pthread_mutex_lock(&gmtime_mutex);
1966 t = gmtime(¤t_time);
1967 pthread_mutex_unlock(&gmtime_mutex);
1969 t = gmtime(¤t_time);
1973 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1975 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1976 day_names[t->tm_wday],
1978 month_names[t->tm_mon],
1988 /*********************************************************************
1990 * Function : finish_http_response
1992 * Description : Fill in the missing headers in an http response,
1993 * and flatten the headers to an http head.
1994 * For HEAD requests the body is freed once
1995 * the Content-Length header is set.
1998 * 1 : rsp = pointer to http_response to be processed
2000 * Returns : A http_response, usually the rsp parameter.
2001 * On error, free()s rsp and returns cgi_error_memory()
2003 *********************************************************************/
2004 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2006 char buf[BUFFER_SIZE];
2009 /* Special case - do NOT change this statically allocated response,
2010 * which is ready for output anyway.
2012 if (rsp == cgi_error_memory_response)
2018 * Fill in the HTTP Status, using HTTP/1.1
2019 * unless the client asked for HTTP/1.0.
2021 snprintf(buf, sizeof(buf), "%s %s",
2022 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2023 rsp->status ? rsp->status : "200 OK");
2024 err = enlist_first(rsp->headers, buf);
2027 * Set the Content-Length
2029 if (rsp->content_length == 0)
2031 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2035 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2036 err = enlist(rsp->headers, buf);
2039 if (0 == strcmpic(csp->http->gpc, "head"))
2042 * The client only asked for the head. Dispose
2043 * the body and log an offensive message.
2045 * While it may seem to be a bit inefficient to
2046 * prepare the body if it isn't needed, it's the
2047 * only way to get the Content-Length right for
2048 * dynamic pages. We could have disposed the body
2049 * earlier, but not without duplicating the
2050 * Content-Length setting code above.
2052 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2054 rsp->content_length = 0;
2057 if (strncmpic(rsp->status, "302", 3))
2060 * If it's not a redirect without any content,
2061 * set the Content-Type to text/html if it's
2062 * not already specified.
2064 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2068 * Fill in the rest of the default headers:
2070 * Date: set to current date/time.
2071 * Last-Modified: set to date/time the page was last changed.
2072 * Expires: set to date/time page next needs reloading.
2073 * Cache-Control: set to "no-cache" if applicable.
2075 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2080 * Set Expires to about 10 min into the future so it'll get reloaded
2081 * occasionally, e.g. if Privoxy gets upgraded.
2086 get_http_time(0, buf);
2087 err = enlist_unique_header(rsp->headers, "Date", buf);
2090 /* Some date in the past. */
2091 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2095 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
2096 err = enlist_unique_header(rsp->headers, "Expires", buf);
2099 else if (!strncmpic(rsp->status, "302", 3))
2101 get_http_time(0, buf);
2102 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2107 * Setting "Cache-Control" to "no-cache" and "Expires" to
2108 * the current time doesn't exactly forbid caching, it just
2109 * requires the client to revalidate the cached copy.
2111 * If a temporary problem occurs and the user tries again after
2112 * getting Privoxy's error message, a compliant browser may set the
2113 * If-Modified-Since header with the content of the error page's
2114 * Last-Modified header. More often than not, the document on the server
2115 * is older than Privoxy's error message, the server would send status code
2116 * 304 and the browser would display the outdated error message again and again.
2118 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2119 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2120 * and can be safely used to "revalidate" without getting a status code 304.
2122 * There is no need to let the useless If-Modified-Since header reach the
2123 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2125 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2127 get_http_time(0, buf);
2128 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2129 if (!strncmpic(rsp->status, "403", 3)
2130 || !strncmpic(rsp->status, "404", 3)
2131 || !strncmpic(rsp->status, "503", 3))
2133 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2137 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2139 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2140 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2146 * HTTP/1.1 applications that do not support persistent connections MUST
2147 * include the "close" connection option in every message.
2149 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2154 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2156 free_http_response(rsp);
2157 return cgi_error_memory();
2159 rsp->head_length = strlen(rsp->head);
2166 /*********************************************************************
2168 * Function : alloc_http_response
2170 * Description : Allocates a new http_response structure.
2174 * Returns : pointer to a new http_response, or NULL.
2176 *********************************************************************/
2177 struct http_response *alloc_http_response(void)
2179 return (struct http_response *) zalloc(sizeof(struct http_response));
2184 /*********************************************************************
2186 * Function : free_http_response
2188 * Description : Free the memory occupied by an http_response
2189 * and its depandant structures.
2192 * 1 : rsp = pointer to http_response to be freed
2196 *********************************************************************/
2197 void free_http_response(struct http_response *rsp)
2200 * Must special case cgi_error_memory_response, which is never freed.
2202 if (rsp && (rsp != cgi_error_memory_response))
2207 destroy_list(rsp->headers);
2214 /*********************************************************************
2216 * Function : template_load
2218 * Description : CGI support function that loads a given HTML
2219 * template, ignoring comment lines and following
2220 * #include statements up to a depth of 1.
2223 * 1 : csp = Current client state (buffers, headers, etc...)
2224 * 2 : template_ptr = Destination for pointer to loaded
2226 * 3 : templatename = name of the HTML template to be used
2227 * 4 : recursive = Flag set if this function calls itself
2228 * following an #include statament
2230 * Returns : JB_ERR_OK on success
2231 * JB_ERR_MEMORY on out-of-memory error.
2232 * JB_ERR_FILE if the template file cannot be read
2234 *********************************************************************/
2235 jb_err template_load(struct client_state *csp, char **template_ptr,
2236 const char *templatename, int recursive)
2239 char *templates_dir_path;
2242 char *included_module;
2245 char buf[BUFFER_SIZE];
2248 assert(template_ptr);
2249 assert(templatename);
2251 *template_ptr = NULL;
2253 /* Validate template name. Paranoia. */
2254 for (p = templatename; *p != 0; p++)
2256 if ( ((*p < 'a') || (*p > 'z'))
2257 && ((*p < 'A') || (*p > 'Z'))
2258 && ((*p < '0') || (*p > '9'))
2262 /* Illegal character */
2268 * Generate full path using either templdir
2269 * or confdir/templates as base directory.
2271 if (NULL != csp->config->templdir)
2273 templates_dir_path = strdup(csp->config->templdir);
2277 templates_dir_path = make_path(csp->config->confdir, "templates");
2280 if (templates_dir_path == NULL)
2282 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2284 return JB_ERR_MEMORY;
2287 full_path = make_path(templates_dir_path, templatename);
2288 free(templates_dir_path);
2289 if (full_path == NULL)
2291 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2293 return JB_ERR_MEMORY;
2296 /* Allocate buffer */
2298 file_buffer = strdup("");
2299 if (file_buffer == NULL)
2301 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2303 return JB_ERR_MEMORY;
2306 /* Open template file */
2308 if (NULL == (fp = fopen(full_path, "r")))
2310 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2318 * Read the file, ignoring comments, and honoring #include
2319 * statements, unless we're already called recursively.
2321 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2322 * This is unlikely in practise.
2324 while (fgets(buf, BUFFER_SIZE, fp))
2326 if (!recursive && !strncmp(buf, "#include ", 9))
2328 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2335 if (string_join(&file_buffer, included_module))
2338 return JB_ERR_MEMORY;
2344 /* skip lines starting with '#' */
2350 if (string_append(&file_buffer, buf))
2353 return JB_ERR_MEMORY;
2358 *template_ptr = file_buffer;
2364 /*********************************************************************
2366 * Function : template_fill
2368 * Description : CGI support function that fills in a pre-loaded
2369 * HTML template by replacing @name@ with value using
2370 * pcrs, for each item in the output map.
2372 * Note that a leading '$' charachter in the export map's
2373 * values will be stripped and toggle on backreference
2377 * 1 : template_ptr = IN: Template to be filled out.
2379 * OUT: Filled out template.
2380 * Caller must free().
2381 * 2 : exports = map with fill in symbol -> name pairs
2383 * Returns : JB_ERR_OK on success (and for uncritical errors)
2384 * JB_ERR_MEMORY on out-of-memory error
2386 *********************************************************************/
2387 jb_err template_fill(char **template_ptr, const struct map *exports)
2389 struct map_entry *m;
2391 char buf[BUFFER_SIZE];
2392 char *tmp_out_buffer;
2398 assert(template_ptr);
2399 assert(*template_ptr);
2402 file_buffer = *template_ptr;
2403 size = strlen(file_buffer) + 1;
2406 * Assemble pcrs joblist from exports map
2408 for (m = exports->first; m != NULL; m = m->next)
2410 if (*m->name == '$')
2413 * First character of name is '$', so remove this flag
2414 * character and allow backreferences ($1 etc) in the
2415 * "replace with" text.
2417 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2423 * Treat the "replace with" text as a literal string -
2424 * no quoting needed, no backreferences allowed.
2425 * ("Trivial" ['T'] flag).
2429 /* Enclose name in @@ */
2430 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2434 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2436 /* Make and run job. */
2437 job = pcrs_compile(buf, m->value, flags, &error);
2440 if (error == PCRS_ERR_NOMEM)
2443 *template_ptr = NULL;
2444 return JB_ERR_MEMORY;
2448 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2449 /* Hope it wasn't important and silently ignore the invalid job */
2454 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2457 if (NULL == tmp_out_buffer)
2459 *template_ptr = NULL;
2460 return JB_ERR_MEMORY;
2466 * Substitution failed, keep the original buffer,
2467 * log the problem and ignore it.
2469 * The user might see some unresolved @CGI_VARIABLES@,
2470 * but returning a special CGI error page seems unreasonable
2471 * and could mask more important error messages.
2473 free(tmp_out_buffer);
2474 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2475 buf, m->value, flags, pcrs_strerror(error));
2479 /* Substitution succeeded, use modified buffer. */
2481 file_buffer = tmp_out_buffer;
2489 *template_ptr = file_buffer;
2494 /*********************************************************************
2496 * Function : template_fill_for_cgi
2498 * Description : CGI support function that loads a HTML template
2499 * and fills it in. Handles file-not-found errors
2500 * by sending a HTML error message. For convenience,
2501 * this function also frees the passed "exports" map.
2504 * 1 : csp = Client state
2505 * 2 : templatename = name of the HTML template to be used
2506 * 3 : exports = map with fill in symbol -> name pairs.
2507 * Will be freed by this function.
2508 * 4 : rsp = Response structure to fill in.
2510 * Returns : JB_ERR_OK on success
2511 * JB_ERR_MEMORY on out-of-memory error
2513 *********************************************************************/
2514 jb_err template_fill_for_cgi(struct client_state *csp,
2515 const char *templatename,
2516 struct map *exports,
2517 struct http_response *rsp)
2522 assert(templatename);
2526 err = template_load(csp, &rsp->body, templatename, 0);
2527 if (err == JB_ERR_FILE)
2530 return cgi_error_no_template(csp, rsp, templatename);
2535 return err; /* JB_ERR_MEMORY */
2537 err = template_fill(&rsp->body, exports);
2543 /*********************************************************************
2545 * Function : default_exports
2547 * Description : returns a struct map list that contains exports
2548 * which are common to all CGI functions.
2551 * 1 : csp = Current client state (buffers, headers, etc...)
2552 * 2 : caller = name of CGI who calls us and which should
2553 * be excluded from the generated menu. May be
2555 * Returns : NULL if no memory, else a new map. Caller frees.
2557 *********************************************************************/
2558 struct map *default_exports(const struct client_state *csp, const char *caller)
2562 struct map * exports;
2563 int local_help_exists = 0;
2567 exports = new_map();
2568 if (exports == NULL)
2573 err = map(exports, "version", 1, html_encode(VERSION), 0);
2574 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2575 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2576 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2577 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2578 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2579 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2580 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2581 !strncmpic(csp->config->usermanual, "http", 4))
2583 /* Manual is located somewhere else, just link to it. */
2584 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2588 /* Manual is delivered by Privoxy. */
2589 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2591 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2592 #ifdef FEATURE_TOGGLE
2593 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2595 if (!err) err = map_block_killer(exports, "can-toggle");
2598 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2599 if (!err) err = map(exports, "my-port", 1, buf, 1);
2601 if(!strcmp(CODE_STATUS, "stable"))
2603 if (!err) err = map_block_killer(exports, "unstable");
2606 if (csp->config->admin_address != NULL)
2608 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2609 local_help_exists = 1;
2613 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2616 if (csp->config->proxy_info_url != NULL)
2618 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2619 local_help_exists = 1;
2623 if (!err) err = map_block_killer(exports, "have-proxy-info");
2626 if (local_help_exists == 0)
2628 if (!err) err = map_block_killer(exports, "have-help-info");
2641 /*********************************************************************
2643 * Function : map_block_killer
2645 * Description : Convenience function.
2646 * Adds a "killer" for the conditional HTML-template
2647 * block <name>, i.e. a substitution of the regex
2648 * "if-<name>-start.*if-<name>-end" to the given
2652 * 1 : exports = map to extend
2653 * 2 : name = name of conditional block
2655 * Returns : JB_ERR_OK on success
2656 * JB_ERR_MEMORY on out-of-memory error.
2658 *********************************************************************/
2659 jb_err map_block_killer(struct map *exports, const char *name)
2661 char buf[1000]; /* Will do, since the names are hardwired */
2665 assert(strlen(name) < 490);
2667 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2668 return map(exports, buf, 1, "", 1);
2672 /*********************************************************************
2674 * Function : map_block_keep
2676 * Description : Convenience function. Removes the markers used
2677 * by map-block-killer, to save a few bytes.
2678 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2681 * 1 : exports = map to extend
2682 * 2 : name = name of conditional block
2684 * Returns : JB_ERR_OK on success
2685 * JB_ERR_MEMORY on out-of-memory error.
2687 *********************************************************************/
2688 jb_err map_block_keep(struct map *exports, const char *name)
2691 char buf[500]; /* Will do, since the names are hardwired */
2695 assert(strlen(name) < 490);
2697 snprintf(buf, sizeof(buf), "if-%s-start", name);
2698 err = map(exports, buf, 1, "", 1);
2705 snprintf(buf, sizeof(buf), "if-%s-end", name);
2706 return map(exports, buf, 1, "", 1);
2710 /*********************************************************************
2712 * Function : map_conditional
2714 * Description : Convenience function.
2715 * Adds an "if-then-else" for the conditional HTML-template
2716 * block <name>, i.e. a substitution of the form:
2723 * The control structure and one of the alternatives
2727 * 1 : exports = map to extend
2728 * 2 : name = name of conditional block
2729 * 3 : choose_first = nonzero for first, zero for second.
2731 * Returns : JB_ERR_OK on success
2732 * JB_ERR_MEMORY on out-of-memory error.
2734 *********************************************************************/
2735 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2737 char buf[1000]; /* Will do, since the names are hardwired */
2742 assert(strlen(name) < 480);
2744 snprintf(buf, sizeof(buf), (choose_first
2745 ? "else-not-%s@.*@endif-%s"
2746 : "if-%s-then@.*@else-not-%s"),
2749 err = map(exports, buf, 1, "", 1);
2755 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2756 return map(exports, buf, 1, "", 1);
2760 /*********************************************************************
2762 * Function : make_menu
2764 * Description : Returns an HTML-formatted menu of the available
2765 * unhidden CGIs, excluding the one given in <self>
2766 * and the toggle CGI if toggling is disabled.
2769 * 1 : self = name of CGI to leave out, can be NULL for
2771 * 2 : feature_flags = feature bitmap from csp->config
2774 * Returns : menu string, or NULL on out-of-memory error.
2776 *********************************************************************/
2777 char *make_menu(const char *self, const unsigned feature_flags)
2779 const struct cgi_dispatcher *d;
2780 char *result = strdup("");
2784 self = "NO-SUCH-CGI!";
2787 /* List available unhidden CGI's and export as "other-cgis" */
2788 for (d = cgi_dispatchers; d->name; d++)
2791 #ifdef FEATURE_TOGGLE
2792 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2795 * Suppress the toggle link if remote toggling is disabled.
2799 #endif /* def FEATURE_TOGGLE */
2801 if (d->description && strcmp(d->name, self))
2803 char *html_encoded_prefix;
2806 * Line breaks would be great, but break
2807 * the "blocked" template's JavaScript.
2809 string_append(&result, "<li><a href=\"");
2810 html_encoded_prefix = html_encode(CGI_PREFIX);
2811 if (html_encoded_prefix == NULL)
2817 string_append(&result, html_encoded_prefix);
2818 free(html_encoded_prefix);
2820 string_append(&result, d->name);
2821 string_append(&result, "\">");
2822 string_append(&result, d->description);
2823 string_append(&result, "</a></li>");
2831 /*********************************************************************
2833 * Function : dump_map
2835 * Description : HTML-dump a map for debugging (as table)
2838 * 1 : the_map = map to dump
2840 * Returns : string with HTML
2842 *********************************************************************/
2843 char *dump_map(const struct map *the_map)
2845 struct map_entry *cur_entry;
2846 char *ret = strdup("");
2848 string_append(&ret, "<table>\n");
2850 for (cur_entry = the_map->first;
2851 (cur_entry != NULL) && (ret != NULL);
2852 cur_entry = cur_entry->next)
2854 string_append(&ret, "<tr><td><b>");
2855 string_join (&ret, html_encode(cur_entry->name));
2856 string_append(&ret, "</b></td><td>");
2857 string_join (&ret, html_encode(cur_entry->value));
2858 string_append(&ret, "</td></tr>\n");
2861 string_append(&ret, "</table>\n");