1 const char cgi_rcs[] = "$Id: cgi.c,v 1.110 2008/08/31 14:55: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-2008
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.110 2008/08/31 14:55:43 fabiankeil
42 * Add a @date@ symbol to include a date(1)-like time string
43 * in templates. Modified version of the patch Endre Szabo
44 * submitted in #2026468.
46 * Revision 1.109 2008/07/26 09:40:27 fabiankeil
47 * Remove the unconditional block in get_http_time().
48 * It's pointless now that it's no longer used to limit
49 * dummy's scope. While at it, remove obvious comments
50 * and a trailing space.
52 * Revision 1.108 2008/05/26 17:30:53 fabiankeil
53 * Provide an OpenSearch Description to access the
54 * show-url-info page through "search engine plugins".
56 * Revision 1.107 2008/05/26 16:23:19 fabiankeil
57 * - Fix spelling in template-not-found message.
58 * - Declare referrer_is_safe()'s alternative_prefix[] static.
60 * Revision 1.106 2008/05/21 15:24:38 fabiankeil
61 * Mark csp as immutable for a bunch of functions.
63 * Revision 1.105 2008/04/17 14:40:47 fabiankeil
64 * Provide get_http_time() with the buffer size so it doesn't
65 * have to blindly assume that the buffer is big enough.
67 * Revision 1.104 2008/03/26 18:07:06 fabiankeil
68 * Add hostname directive. Closes PR#1918189.
70 * Revision 1.103 2008/03/21 11:13:57 fabiankeil
71 * Only gather host information if it's actually needed.
72 * Also move the code out of accept_connection() so it's less likely
73 * to delay other incoming connections if the host is misconfigured.
75 * Revision 1.102 2008/02/23 16:33:43 fabiankeil
76 * Let forward_url() use the standard parameter ordering
77 * and mark its second parameter immutable.
79 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
80 * Add SOCKS5 support for "Forwarding failure" CGI page.
82 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
83 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
86 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
87 * #1763173 from Stefan Huehner: declare some more functions static.
89 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
90 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
92 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
93 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
95 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
96 * Use sizeof() more often.
98 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
99 * Don't overlook map result for the forwarding-type.
101 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
102 * Use a transparent background for the PNG replacement pattern.
104 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
105 * - Save the reason for generating http_responses.
106 * - Fix --disable-toggle (again).
107 * - Use TBL birthday hack for 403 responses as well.
108 * - Uglify the @menu@ again to fix JavaScript
109 * errors on the "blocked" template.
110 * - Escape an ampersand in cgi_error_unknown().
112 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
113 * - Add HEAD support to finish_http_response.
114 * - Add error favicon to internal HTML error messages.
116 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
117 * Add new config option "templdir" to
118 * change the templates directory.
120 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
121 * Added "forwarding-failed" template support for error_response().
123 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
124 * Add favicon delivery functions.
126 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
127 * - Map variables that aren't guaranteed to be
128 * pure ASCII html_encoded.
129 * - Use CGI_PREFIX to generate URL for user manual
130 * CGI page to make sure CGI_SITE_2_PATH is included.
132 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
133 * - "Protect" against a rather lame JavaScript-based
134 * Privoxy detection "attack" and check the referrer
135 * before delivering the CGI style sheet.
136 * - Move referrer check for unsafe CGI pages into
137 * referrer_is_safe() and log the result.
138 * - Map @url@ in cgi-error-disabled page.
139 * It's required for the "go there anyway" link.
140 * - Mark *csp as immutable for grep_cgi_referrer().
142 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
143 * Fix strdup() error handling in cgi_error_unknown()
144 * and cgi_error_no_template(). Reported by Markus Elfring.
146 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
147 * Handle pcrs_execute() errors in template_fill() properly.
149 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
150 * Fixed gcc43 conversion warnings and replaced sprintf
151 * calls with snprintf to give OpenBSD's gcc one less reason
154 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
155 * Escape ampersand in Privoxy menu.
157 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
158 * Suppress the toggle link if remote toggling is disabled.
160 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
161 * Fix configure option --disable-toggle.
162 * Thanks to Peter Thoenen for reporting this.
164 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
165 * Don't lose the FORCE_PREFIX in case of
166 * connection problems. Fixes #612235.
168 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
169 * Make pthread mutex locking more generic. Instead of
170 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
171 * and use mutex locking unless there is an _r function
172 * available. Better safe than sorry.
174 * Fixes "./configure --disable-pthread" and should result
175 * in less threading-related problems on pthread-using platforms,
176 * but it still doesn't fix BR#1122404.
178 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
179 * Use CGI_PREFIX to check the referrer.
180 * The check for "http://config.privoxy.org/" fails
181 * if the user modified CGI_SITE_2_HOST.
183 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
184 * Adjusted headers for Privoxy's cgi responses:
185 * Don't set Last-Modified, Expires and Cache-Control
186 * headers for redirects; always set "Connection: close".
188 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
189 * Only predate the Last-Modified header for cgi responses
190 * that are delivered with status code 404 or 503.
192 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
193 * Mark cgi_send_user_manual as harmless,
194 * to fix the access denied problem Hal spotted.
195 * The manual has no secret content, therefore we
196 * don't have to care about "secure" referrers.
198 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
199 * Incorporate modified version of Roland Rosenfeld's patch to
200 * optionally access the user-manual via Privoxy. Closes patch 679075.
202 * Formatting changed to Privoxy style, added call to
203 * cgi_error_no_template if the requested file doesn't
204 * exist and modified check whether or not Privoxy itself
205 * should serve the manual. Should work cross-platform now.
207 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
208 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
210 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
211 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
212 * with what was really the latest development (the v_3_0_branch branch)
214 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
215 * Moved cgi_error_disabled() from cgiedit.c to
216 * cgi.c to re-enable build with --disable-editor.
217 * Fixes Bug #892744. Thanks to Matthew Fischer
220 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
221 * - Added new function cgi_redirect to handle creation of
222 * HTTP redirect messages formerly repeated in the code.
223 * - Send cgi_error_disabled instead of cgi_error_404 when
224 * referrer check fails
225 * - Dynamic content now gets Expires header field with date
228 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
229 * Bugfix: Transparent PNG was not transparent. Thanks to
230 * Dan Razzell of Starfish Systems for notice and new PNG.
232 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
233 * Security fix: dspatch_known_cgi no longer considers an empty
234 * referrer safe for critical CGIs, since malicious links could
235 * reside on https:// locations which browsers don't advertize as
236 * referrers. Closes bug #749916, thanks to Jeff Epler for the
237 * hint. Goodbye One-Click[tm] toggling :-(
239 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
242 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
243 * Killed a compiler warning on OSX
245 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
246 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
247 * (fixes bug #710056)
248 * - Show toggle info only if we have it
250 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
251 * Move declaration of struct tm dummy outside of a control block so it is
252 * accessible later on during snprintf in get_http_time.
254 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
255 * Cosmetic: Renamed cryptic variable
257 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
258 * 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.
260 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
261 * Disable access to critical CGIs via untrusted referrers.
262 * This prevents users from being tricked by malicious websites
263 * into making unintentional configuration changes:
265 * - Added flag to each cgi_dispatcher that allows or denies
267 * - Introduced proviorical function that greps for the
268 * referrer header before regular header parsing happens
269 * - Added safety check to dispatch_known_cgi. CGI is called
270 * if (cgi harmless || no referrer || we are referrer).
271 * Else a) toggle calls are modified not to change status and
272 * b) all other calls are denied.
274 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
275 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
277 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
278 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
280 * Revision 1.70 2002/05/19 11:33:20 jongfoster
281 * If a CGI error was not handled, and propogated back to
282 * dispatch_known_cgi(), then it was assumed to be "out of memory".
283 * This gave a very misleading error message.
285 * Now other errors will cause a simple message giving the error
286 * number and asking the user to report a bug.
289 * http://sourceforge.net/tracker/index.php?func=detail
290 * &aid=557905&group_id=11118&atid=111118
292 * Revision 1.69 2002/05/14 21:28:40 oes
293 * - Fixed add_help_link to link to the (now split) actions
294 * part of the config chapter
295 * - Renamed helplink export to actions-help-prefix
297 * Revision 1.68 2002/05/12 21:36:29 jongfoster
298 * Correcting function comments
300 * Revision 1.67 2002/04/30 12:02:07 oes
301 * Nit: updated a comment
303 * Revision 1.66 2002/04/26 18:32:57 jongfoster
304 * Fixing a memory leak on error
306 * Revision 1.65 2002/04/26 12:53:51 oes
307 * - New function add_help_link
308 * - default_exports now exports links to the user manual
309 * and a prefix for links into the config chapter
311 * Revision 1.64 2002/04/24 02:17:21 oes
312 * - Better descriptions for CGIs
313 * - Hide edit-actions, more shortcuts
314 * - Moved get_char_param, get_string_param and get_number_param here
317 * Revision 1.63 2002/04/15 19:06:43 jongfoster
320 * Revision 1.62 2002/04/10 19:59:46 jongfoster
321 * Fixes to #include in templates:
322 * - Didn't close main file if loading an included template fails.
323 * - I'm paranoid and want to disallow "#include /etc/passwd".
325 * Revision 1.61 2002/04/10 13:37:48 oes
326 * Made templates modular: template_load now recursive with max depth 1
328 * Revision 1.60 2002/04/08 20:50:25 swa
331 * Revision 1.59 2002/04/05 15:51:51 oes
332 * - added send-stylesheet CGI
333 * - bugfix: error-pages now get correct request protocol
335 * - kludged CGI descriptions and menu not to break JS syntax
337 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
338 * Fix Mac OSX compiler warnings
340 * Revision 1.57 2002/03/26 22:29:54 swa
341 * we have a new homepage!
343 * Revision 1.56 2002/03/24 17:50:46 jongfoster
344 * Fixing compile error if actions file editor disabled
346 * Revision 1.55 2002/03/24 16:55:06 oes
347 * Making GIF checkerboard transparent
349 * Revision 1.54 2002/03/24 16:18:15 jongfoster
352 * Revision 1.53 2002/03/24 16:06:00 oes
353 * Correct transparency for checkerboard PNG. Thanks, Magnus!
355 * Revision 1.52 2002/03/24 15:23:33 jongfoster
358 * Revision 1.51 2002/03/24 13:25:43 swa
359 * name change related issues
361 * Revision 1.50 2002/03/16 23:54:06 jongfoster
362 * Adding graceful termination feature, to help look for memory leaks.
363 * If you enable this (which, by design, has to be done by hand
364 * editing config.h) and then go to http://i.j.b/die, then the program
365 * will exit cleanly after the *next* request. It should free all the
366 * memory that was used.
368 * Revision 1.49 2002/03/13 00:27:04 jongfoster
371 * Revision 1.48 2002/03/08 17:47:07 jongfoster
374 * Revision 1.47 2002/03/08 16:41:33 oes
375 * Added GIF images again
377 * Revision 1.46 2002/03/07 03:48:38 oes
378 * - Changed built-in images from GIF to PNG
379 * (with regard to Unisys patent issue)
380 * - Added a 4x4 pattern PNG which is less intrusive
381 * than the logo but also clearly marks the deleted banners
383 * Revision 1.45 2002/03/06 22:54:35 jongfoster
384 * Automated function-comment nitpicking.
386 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
387 * - Better error reporting on OS/2
388 * - Fix double-slash comment (oops)
390 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
391 * - Re-enable OS/2 building after new parms were added
392 * - Fix false out of memory report when resolving CGI templates when no IP
393 * address is available of failed attempt (a la no such domain)
395 * Revision 1.42 2002/01/21 00:33:20 jongfoster
396 * Replacing strsav() with the safer string_append() or string_join().
397 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
398 * Adding missing html_encode() to error message generators.
399 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
401 * Revision 1.41 2002/01/17 20:56:22 jongfoster
402 * Replacing hard references to the URL of the config interface
403 * with #defines from project.h
405 * Revision 1.40 2002/01/09 14:26:46 oes
406 * Added support for thread-safe gmtime_r call.
408 * Revision 1.39 2001/11/16 00:48:13 jongfoster
409 * Fixing a compiler warning
411 * Revision 1.38 2001/11/13 00:31:21 jongfoster
412 * - Adding new CGIs for use by non-JavaScript browsers:
413 * edit-actions-url-form
414 * edit-actions-add-url-form
415 * edit-actions-remove-url-form
416 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
419 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
420 * Show enablement/disablement status in almost all templates.
421 * There is a little trickiness here: apparent recursive resolution of
422 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
423 * the actual enablement status. So a similar construct,
424 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
427 * Revision 1.36 2001/10/26 17:33:27 oes
430 * Revision 1.35 2001/10/23 21:48:19 jongfoster
431 * Cleaning up error handling in CGI functions - they now send back
432 * a HTML error page and should never cause a FATAL error. (Fixes one
433 * potential source of "denial of service" attacks).
435 * CGI actions file editor that works and is actually useful.
437 * Ability to toggle Junkbuster remotely using a CGI call.
439 * You can turn off both the above features in the main configuration
440 * file, e.g. if you are running a multi-user proxy.
442 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
443 * Only show "Local support" on templates conditionally:
444 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
445 * - if not, no Local support section appears
447 * Revision 1.33 2001/10/14 22:28:41 jongfoster
448 * Fixing stupid typo.
450 * Revision 1.32 2001/10/14 22:20:18 jongfoster
451 * - Changes to CGI dispatching method to match CGI names exactly,
452 * rather than doing a prefix match.
453 * - No longer need to count the length of the CGI handler names by hand.
454 * - Adding new handler for 404 error when disptching a CGI, if none of
455 * the handlers match.
456 * - Adding new handlers for CGI actionsfile editor.
458 * Revision 1.31 2001/10/10 10:56:39 oes
459 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
461 * Revision 1.30 2001/10/02 15:30:57 oes
462 * Introduced show-request cgi
464 * Revision 1.29 2001/09/20 15:47:44 steudten
466 * Fix BUG: Modify int size to size_t size in fill_template()
467 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
469 * Revision 1.28 2001/09/19 18:00:37 oes
470 * - Deletef time() FIXME (Can't fail under Linux either, if
471 * the argument is guaranteed to be in out address space,
474 * - Pointer notation cosmetics
475 * - Fixed a minor bug in template_fill(): Failiure of
476 * pcrs_execute() now secure.
478 * Revision 1.27 2001/09/16 17:08:54 jongfoster
479 * Moving simple CGI functions from cgi.c to new file cgisimple.c
481 * Revision 1.26 2001/09/16 15:47:37 jongfoster
482 * First version of CGI-based edit interface. This is very much a
483 * work-in-progress, and you can't actually use it to edit anything
484 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
485 * to have any effect.
487 * Revision 1.25 2001/09/16 15:02:35 jongfoster
488 * Adding i.j.b/robots.txt.
489 * Inlining add_stats() since it's only ever called from one place.
491 * Revision 1.24 2001/09/16 11:38:01 jongfoster
492 * Splitting fill_template() into 2 functions:
493 * template_load() loads the file
494 * template_fill() performs the PCRS regexps.
495 * This is because the CGI edit interface has a "table row"
496 * template which is used many times in the page - this
497 * change means it's only loaded from disk once.
499 * Revision 1.23 2001/09/16 11:16:05 jongfoster
500 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
502 * Revision 1.22 2001/09/16 11:00:10 jongfoster
503 * New function alloc_http_response, for symmetry with free_http_response
505 * Revision 1.21 2001/09/13 23:53:03 jongfoster
506 * Support for both static and dynamically generated CGI pages.
507 * Correctly setting Last-Modified: and Expires: HTTP headers.
509 * Revision 1.20 2001/09/13 23:40:36 jongfoster
510 * (Cosmetic only) Indentation correction
512 * Revision 1.19 2001/09/13 23:31:25 jongfoster
513 * Moving image data to cgi.c rather than cgi.h.
515 * Revision 1.18 2001/08/05 16:06:20 jongfoster
516 * Modifiying "struct map" so that there are now separate header and
517 * "map_entry" structures. This means that functions which modify a
518 * map no longer need to return a pointer to the modified map.
519 * Also, it no longer reverses the order of the entries (which may be
520 * important with some advanced template substitutions).
522 * Revision 1.17 2001/08/05 15:57:38 oes
523 * Adapted finish_http_response to new list_to_text
525 * Revision 1.16 2001/08/01 21:33:18 jongfoster
526 * Changes to fill_template() that reduce memory usage without having
527 * an impact on performance. I also renamed some variables so as not
528 * to clash with the C++ keywords "new" and "template".
530 * Revision 1.15 2001/08/01 21:19:22 jongfoster
531 * Moving file version information to a separate CGI page.
533 * Revision 1.14 2001/08/01 00:19:03 jongfoster
534 * New function: map_conditional() for an if-then-else syntax.
535 * Changing to use new version of show_defines()
537 * Revision 1.13 2001/07/30 22:08:36 jongfoster
538 * Tidying up #defines:
539 * - All feature #defines are now of the form FEATURE_xxx
540 * - Permanently turned off WIN_GUI_EDIT
541 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
543 * Revision 1.12 2001/07/29 18:47:05 jongfoster
544 * Adding missing #include "loadcfg.h"
546 * Revision 1.11 2001/07/18 17:24:37 oes
547 * Changed to conform to new pcrs interface
549 * Revision 1.10 2001/07/13 13:53:13 oes
550 * Removed all #ifdef PCRS and related code
552 * Revision 1.9 2001/06/29 21:45:41 oes
553 * Indentation, CRLF->LF, Tab-> Space
555 * Revision 1.8 2001/06/29 13:21:46 oes
556 * - Cosmetics: renamed and reordered functions, variables,
557 * texts, improved comments etc
559 * - Removed ij_untrusted_url() The relevant
560 * info is now part of the "untrusted" page,
561 * which is generated by filters.c:trust_url()
563 * - Generators of content now call finish_http_response()
564 * themselves, making jcc.c:chat() a little less
567 * - Removed obsolete "Pragma: no-cache" from our headers
569 * - http_responses now know their head length
571 * - fill_template now uses the new interface to pcrs, so that
572 * - long jobs (like whole files) no longer have to be assembled
573 * in a fixed size buffer
574 * - the new T (trivial) option is used, and the replacement may
575 * contain Perl syntax backrefs without confusing pcrs
577 * - Introduced default_exports() which generates a set of exports
578 * common to all CGIs and other content generators
580 * - Introduced convenience function map_block_killer()
582 * - Introduced convenience function make_menu()
584 * - Introduced CGI-like function error_response() which generates
585 * the "No such domain" and "Connect failed" messages using the
588 * - cgi_show_url_info:
589 * - adapted to new CGI features
590 * - form and answers now generated from same template
591 * - http:// prefix in URL now OK
594 * - adapted to new CGI features
595 * - no longer uses csp->init_proxy_args
598 * - moved menu generation to make_menu()
600 * - add_stats now writes single export map entries instead
603 * - Moved redirect_url() to filters.c
605 * - Fixed mem leak in free_http_response(), map_block_killer(),
607 * - Removed logentry from cancelled commit
609 * Revision 1.7 2001/06/09 10:51:58 jongfoster
610 * Changing "show URL info" handler to new style.
611 * Changing BUFSIZ ==> BUFFER_SIZE
613 * Revision 1.6 2001/06/07 23:05:19 jongfoster
614 * Removing code related to old forward and ACL files.
616 * Revision 1.5 2001/06/05 19:59:16 jongfoster
617 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
619 * Revision 1.4 2001/06/04 10:41:52 swa
620 * show version string of cgi.h and cgi.c
622 * Revision 1.3 2001/06/03 19:12:16 oes
623 * introduced new cgi handling
625 * No revisions before 1.3
627 **********************************************************************/
633 #include <sys/types.h>
647 #include "miscutil.h"
648 #include "cgisimple.h"
649 #include "jbsockets.h"
650 #if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE)
652 #endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */
654 /* loadcfg.h is for global_toggle_state only */
655 #ifdef FEATURE_PTHREAD
657 /* jcc.h is for mutex semaphore globals only */
658 #endif /* def FEATURE_PTHREAD */
659 const char cgi_h_rcs[] = CGI_H_VERSION;
662 * List of CGI functions: name, handler, description
663 * Note: Do NOT use single quotes in the description;
664 * this will break the dynamic "blocked" template!
666 static const struct cgi_dispatcher cgi_dispatchers[] = {
671 #ifdef FEATURE_GRACEFUL_TERMINATION
674 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
675 "this is a one click Denial Of Service attack!!!</em>",
680 #ifdef FEATURE_CGI_EDIT_ACTIONS
681 "View & change the current configuration",
683 "View the current configuration",
688 "View the source code version numbers",
692 "View the request headers.",
696 "Look up which actions apply to a URL and why",
698 #ifdef FEATURE_TOGGLE
701 "Toggle Privoxy on or off",
703 #endif /* def FEATURE_TOGGLE */
704 #ifdef FEATURE_CGI_EDIT_ACTIONS
705 { "edit-actions", /* Edit the actions list */
708 { "eaa", /* Shortcut for edit-actions-add-url-form */
709 cgi_edit_actions_add_url_form,
711 { "eau", /* Shortcut for edit-actions-url-form */
712 cgi_edit_actions_url_form,
714 { "ear", /* Shortcut for edit-actions-remove-url-form */
715 cgi_edit_actions_remove_url_form,
717 { "eal", /* Shortcut for edit-actions-list */
718 cgi_edit_actions_list,
720 { "eafu", /* Shortcut for edit-actions-for-url */
721 cgi_edit_actions_for_url,
723 { "eas", /* Shortcut for edit-actions-submit */
724 cgi_edit_actions_submit,
726 { "easa", /* Shortcut for edit-actions-section-add */
727 cgi_edit_actions_section_add,
729 { "easr", /* Shortcut for edit-actions-section-remove */
730 cgi_edit_actions_section_remove,
732 { "eass", /* Shortcut for edit-actions-section-swap */
733 cgi_edit_actions_section_swap,
735 { "edit-actions-for-url",
736 cgi_edit_actions_for_url,
737 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
738 { "edit-actions-list",
739 cgi_edit_actions_list,
740 NULL, TRUE /* Edit the actions list */ },
741 { "edit-actions-submit",
742 cgi_edit_actions_submit,
743 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
744 { "edit-actions-url",
745 cgi_edit_actions_url,
746 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
747 { "edit-actions-url-form",
748 cgi_edit_actions_url_form,
749 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
750 { "edit-actions-add-url",
751 cgi_edit_actions_add_url,
752 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
753 { "edit-actions-add-url-form",
754 cgi_edit_actions_add_url_form,
755 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
756 { "edit-actions-remove-url",
757 cgi_edit_actions_remove_url,
758 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
759 { "edit-actions-remove-url-form",
760 cgi_edit_actions_remove_url_form,
761 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
762 { "edit-actions-section-add",
763 cgi_edit_actions_section_add,
764 NULL, FALSE /* Remove a section from the actionsfile */ },
765 { "edit-actions-section-remove",
766 cgi_edit_actions_section_remove,
767 NULL, FALSE /* Remove a section from the actionsfile */ },
768 { "edit-actions-section-swap",
769 cgi_edit_actions_section_swap,
770 NULL, FALSE /* Swap two sections in the actionsfile */ },
771 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
772 { "error-favicon.ico",
773 cgi_send_error_favicon,
774 NULL, TRUE /* Sends the favicon image for error pages. */ },
776 cgi_send_default_favicon,
777 NULL, TRUE /* Sends the default favicon image. */ },
780 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
783 NULL, TRUE /* Send a built-in image */ },
786 NULL, FALSE /* Send templates/cgi-style.css */ },
788 cgi_transparent_image,
789 NULL, TRUE /* Send a transparent image (short name) */ },
790 { "url-info-osd.xml",
791 cgi_send_url_info_osd,
792 NULL, TRUE /* Send templates/url-info-osd.xml */ },
794 cgi_send_user_manual,
795 NULL, TRUE /* Send user-manual */ },
796 { NULL, /* NULL Indicates end of list and default page */
798 NULL, TRUE /* Unknown CGI page */ }
803 * Built-in images for ad replacement
805 * Hint: You can encode your own images like this:
806 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
809 #ifdef FEATURE_NO_GIFS
812 * Checkerboard pattern, as a PNG.
814 const char image_pattern_data[] =
815 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
816 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
817 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
818 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
819 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
820 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
821 "\000\000\000\000\111\105\116\104\256\102\140\202";
824 * 1x1 transparant PNG.
826 const char image_blank_data[] =
827 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
828 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
829 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
830 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
831 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
832 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
833 "\000\000\000\000\111\105\116\104\256\102\140\202";
837 * Checkerboard pattern, as a GIF.
839 const char image_pattern_data[] =
840 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
841 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
842 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
843 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
847 * 1x1 transparant GIF.
849 const char image_blank_data[] =
850 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
851 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
852 "\000\001\000\000\002\002D\001\000;";
855 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
856 const size_t image_blank_length = sizeof(image_blank_data) - 1;
859 static struct http_response cgi_error_memory_response[1];
861 static struct http_response *dispatch_known_cgi(struct client_state * csp,
863 static struct map *parse_cgi_parameters(char *argstring);
866 /*********************************************************************
868 * Function : dispatch_cgi
870 * Description : Checks if a request URL has either the magical
871 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
872 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
873 * http://config.privoxy.org/). If so, it passes
874 * the (rest of the) path onto dispatch_known_cgi, which
875 * calls the relevant CGI handler function.
878 * 1 : csp = Current client state (buffers, headers, etc...)
880 * Returns : http_response if match, NULL if nonmatch or handler fail
882 *********************************************************************/
883 struct http_response *dispatch_cgi(struct client_state *csp)
885 const char *host = csp->http->host;
886 const char *path = csp->http->path;
889 * Should we intercept ?
892 /* Note: "example.com" and "example.com." are equivalent hostnames. */
894 /* Either the host matches CGI_SITE_1_HOST ..*/
895 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
896 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
897 && (path[0] == '/') )
899 /* ..then the path will all be for us. Remove leading '/' */
902 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
903 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
904 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
905 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
907 /* take everything following CGI_SITE_2_PATH */
908 path += strlen(CGI_SITE_2_PATH);
911 /* skip the forward slash after CGI_SITE_2_PATH */
914 else if (*path != '\0')
917 * weirdness: URL is /configXXX, where XXX is some string
918 * Do *NOT* intercept.
930 * This is a CGI call.
933 return dispatch_known_cgi(csp, path);
937 /*********************************************************************
939 * Function : grep_cgi_referrer
941 * Description : Ugly provisorical fix that greps the value of the
942 * referer HTTP header field out of a linked list of
943 * strings like found at csp->headers. Will disappear
946 * FIXME: csp->headers ought to be csp->http->headers
947 * FIXME: Parsing all client header lines should
948 * happen right after the request is received!
951 * 1 : csp = Current client state (buffers, headers, etc...)
953 * Returns : pointer to value (no copy!), or NULL if none found.
955 *********************************************************************/
956 static char *grep_cgi_referrer(const struct client_state *csp)
958 struct list_entry *p;
960 for (p = csp->headers->first; p != NULL; p = p->next)
962 if (p->str == NULL) continue;
963 if (strncmpic(p->str, "Referer: ", 9) == 0)
965 return ((p->str) + 9);
973 /*********************************************************************
975 * Function : referrer_is_safe
977 * Description : Decides whether we trust the Referer for
978 * CGI pages which are only meant to be reachable
979 * through Privoxy's web interface directly.
982 * 1 : csp = Current client state (buffers, headers, etc...)
984 * Returns : TRUE if the referrer is safe, or
985 * FALSE if the referrer is unsafe or not set.
987 *********************************************************************/
988 static int referrer_is_safe(const struct client_state *csp)
991 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
993 referrer = grep_cgi_referrer(csp);
995 if (NULL == referrer)
997 /* No referrer, no access */
998 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
1001 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
1002 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
1004 /* Trustworthy referrer */
1005 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
1006 csp->http->url, referrer);
1012 /* Untrustworthy referrer */
1013 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
1014 csp->http->url, referrer);
1021 /*********************************************************************
1023 * Function : dispatch_known_cgi
1025 * Description : Processes a CGI once dispatch_cgi has determined that
1026 * it matches one of the magic prefixes. Parses the path
1027 * as a cgi name plus query string, prepares a map that
1028 * maps CGI parameter names to their values, initializes
1029 * the http_response struct, and calls the relevant CGI
1033 * 1 : csp = Current client state (buffers, headers, etc...)
1034 * 2 : path = Path of CGI, with the CGI prefix removed.
1035 * Should not have a leading "/".
1037 * Returns : http_response, or NULL on handler failure or out of
1040 *********************************************************************/
1041 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1044 const struct cgi_dispatcher *d;
1045 struct map *param_list;
1046 struct http_response *rsp;
1047 char *query_args_start;
1051 if (NULL == (path_copy = strdup(path)))
1053 return cgi_error_memory();
1055 query_args_start = path_copy;
1056 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1060 if (*query_args_start == '/')
1062 *query_args_start++ = '\0';
1063 if ((param_list = new_map()))
1065 map(param_list, "file", 1, url_decode(query_args_start), 0);
1070 if (*query_args_start == '?')
1072 *query_args_start++ = '\0';
1074 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1077 return cgi_error_memory();
1083 * path_copy = CGI call name
1084 * param_list = CGI params, as map
1087 /* Get mem for response or fail*/
1088 if (NULL == (rsp = alloc_http_response()))
1091 free_map(param_list);
1092 return cgi_error_memory();
1096 * Find and start the right CGI function
1098 d = cgi_dispatchers;
1101 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1104 * If the called CGI is either harmless, or referred
1105 * from a trusted source, start it.
1107 if (d->harmless || referrer_is_safe(csp))
1109 err = (d->handler)(csp, rsp, param_list);
1114 * Else, modify toggle calls so that they only display
1115 * the status, and deny all other calls.
1117 if (0 == strcmp(path_copy, "toggle"))
1119 unmap(param_list, "set");
1120 err = (d->handler)(csp, rsp, param_list);
1124 err = cgi_error_disabled(csp, rsp);
1129 free_map(param_list);
1131 if (err == JB_ERR_CGI_PARAMS)
1133 err = cgi_error_bad_param(csp, rsp);
1135 if (err && (err != JB_ERR_MEMORY))
1137 /* Unexpected error! Shouldn't get here */
1138 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1139 err = cgi_error_unknown(csp, rsp, err);
1144 rsp->reason = RSP_REASON_CGI_CALL;
1145 return finish_http_response(csp, rsp);
1149 /* Error in handler, probably out-of-memory */
1150 free_http_response(rsp);
1151 return cgi_error_memory();
1159 /*********************************************************************
1161 * Function : parse_cgi_parameters
1163 * Description : Parse a URL-encoded argument string into name/value
1164 * pairs and store them in a struct map list.
1167 * 1 : argstring = string to be parsed. Will be trashed.
1169 * Returns : pointer to param list, or NULL if out of memory.
1171 *********************************************************************/
1172 static struct map *parse_cgi_parameters(char *argstring)
1175 char *vector[BUFFER_SIZE];
1177 struct map *cgi_params;
1179 if (NULL == (cgi_params = new_map()))
1185 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1186 * the fragment identifier along with the request, so we must
1187 * cut it off here, so it won't pollute the CGI params:
1189 if (NULL != (p = strchr(argstring, '#')))
1194 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1196 for (i = 0; i < pairs; i++)
1198 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1201 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1203 free_map(cgi_params);
1214 /*********************************************************************
1216 * Function : get_char_param
1218 * Description : Get a single-character parameter passed to a CGI
1222 * 1 : parameters = map of cgi parameters
1223 * 2 : param_name = The name of the parameter to read
1225 * Returns : Uppercase character on success, '\0' on error.
1227 *********************************************************************/
1228 char get_char_param(const struct map *parameters,
1229 const char *param_name)
1236 ch = *(lookup(parameters, param_name));
1237 if ((ch >= 'a') && (ch <= 'z'))
1239 ch = (char)(ch - 'a' + 'A');
1246 /*********************************************************************
1248 * Function : get_string_param
1250 * Description : Get a string paramater, to be used as an
1251 * ACTION_STRING or ACTION_MULTI paramater.
1252 * Validates the input to prevent stupid/malicious
1253 * users from corrupting their action file.
1256 * 1 : parameters = map of cgi parameters
1257 * 2 : param_name = The name of the parameter to read
1258 * 3 : pparam = destination for paramater. Allocated as
1259 * part of the map "parameters", so don't free it.
1260 * Set to NULL if not specified.
1262 * Returns : JB_ERR_OK on success, or if the paramater
1263 * was not specified.
1264 * JB_ERR_MEMORY on out-of-memory.
1265 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1267 *********************************************************************/
1268 jb_err get_string_param(const struct map *parameters,
1269 const char *param_name,
1270 const char **pparam)
1282 param = lookup(parameters, param_name);
1288 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1293 * Note that the length limit is arbitrary, it just seems
1294 * sensible to limit it to *something*. There's no
1295 * technical reason for any limit at all.
1297 return JB_ERR_CGI_PARAMS;
1300 /* Check every character to see if it's legal */
1302 while ((ch = *s++) != '\0')
1304 if ( ((unsigned char)ch < (unsigned char)' ')
1307 /* Probable hack attempt, or user accidentally used '}'. */
1308 return JB_ERR_CGI_PARAMS;
1319 /*********************************************************************
1321 * Function : get_number_param
1323 * Description : Get a non-negative integer from the parameters
1324 * passed to a CGI function.
1327 * 1 : csp = Current client state (buffers, headers, etc...)
1328 * 2 : parameters = map of cgi parameters
1329 * 3 : name = Name of CGI parameter to read
1330 * 4 : pvalue = destination for value.
1331 * Set to -1 on error.
1333 * Returns : JB_ERR_OK on success
1334 * JB_ERR_MEMORY on out-of-memory
1335 * JB_ERR_CGI_PARAMS if the parameter was not specified
1338 *********************************************************************/
1339 jb_err get_number_param(struct client_state *csp,
1340 const struct map *parameters,
1355 param = lookup(parameters, name);
1358 return JB_ERR_CGI_PARAMS;
1361 /* We don't use atoi because I want to check this carefully... */
1364 while ((ch = *param++) != '\0')
1366 if ((ch < '0') || (ch > '9'))
1368 return JB_ERR_CGI_PARAMS;
1371 ch = (char)(ch - '0');
1375 * <limits.h> defines UINT_MAX
1377 * (UINT_MAX - ch) / 10 is the largest number that
1378 * can be safely multiplied by 10 then have ch added.
1380 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1382 return JB_ERR_CGI_PARAMS;
1385 value = value * 10 + (unsigned)ch;
1396 /*********************************************************************
1398 * Function : error_response
1400 * Description : returns an http_response that explains the reason
1401 * why a request failed.
1404 * 1 : csp = Current client state (buffers, headers, etc...)
1405 * 2 : templatename = Which template should be used for the answer
1406 * 3 : sys_err = system error number
1408 * Returns : A http_response. If we run out of memory, this
1409 * will be cgi_error_memory().
1411 *********************************************************************/
1412 struct http_response *error_response(struct client_state *csp,
1413 const char *templatename,
1417 struct http_response *rsp;
1418 struct map *exports = default_exports(csp, NULL);
1421 if (exports == NULL)
1423 return cgi_error_memory();
1426 if (NULL == (rsp = alloc_http_response()))
1429 return cgi_error_memory();
1432 #ifdef FEATURE_FORCE_LOAD
1433 if (csp->flags & CSP_FLAG_FORCED)
1435 path = strdup(FORCE_PREFIX);
1438 #endif /* def FEATURE_FORCE_LOAD */
1442 err = string_append(&path, csp->http->path);
1444 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1445 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1446 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1447 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1448 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1451 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1454 /* Some failures, like "404 no such domain", don't have an IP address. */
1455 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1463 free_http_response(rsp);
1464 return cgi_error_memory();
1467 if (!strcmp(templatename, "no-such-domain"))
1469 rsp->status = strdup("404 No such domain");
1470 if (rsp->status == NULL)
1473 free_http_response(rsp);
1474 return cgi_error_memory();
1476 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1478 else if (!strcmp(templatename, "forwarding-failed"))
1480 const struct forward_spec *fwd = forward_url(csp, csp->http);
1481 char *socks_type = NULL;
1484 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1485 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1489 * XXX: While the template is called forwarding-failed,
1490 * it currently only handles socks forwarding failures.
1492 assert(fwd->type != SOCKS_NONE);
1495 * Map failure reason, forwarding type and forwarder.
1497 if (NULL == csp->error_message)
1500 * Either we forgot to record the failure reason,
1501 * or the memory allocation failed.
1503 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1504 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1506 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1509 * XXX: this is almost the same code as in cgi_show_url_info()
1510 * and thus should be factored out and shared.
1515 socks_type = "socks4-";
1518 socks_type = "socks4a-";
1521 socks_type = "socks5-";
1524 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1527 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1528 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1530 if (!err) rsp->status = strdup("503 Forwarding failure");
1531 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1534 free_http_response(rsp);
1535 return cgi_error_memory();
1537 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1539 else if (!strcmp(templatename, "connect-failed"))
1541 rsp->status = strdup("503 Connect failed");
1542 if (rsp->status == NULL)
1545 free_http_response(rsp);
1546 return cgi_error_memory();
1548 rsp->reason = RSP_REASON_CONNECT_FAILED;
1551 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1554 free_http_response(rsp);
1555 return cgi_error_memory();
1558 return finish_http_response(csp, rsp);
1562 /*********************************************************************
1564 * Function : cgi_error_disabled
1566 * Description : CGI function that is called to generate an error
1567 * response if the actions editor or toggle CGI are
1568 * accessed despite having being disabled at compile-
1569 * or run-time, or if the user followed an untrusted link
1570 * to access a unsafe CGI feature that is only reachable
1571 * through Privoxy directly.
1574 * 1 : csp = Current client state (buffers, headers, etc...)
1575 * 2 : rsp = http_response data structure for output
1577 * CGI Parameters : none
1579 * Returns : JB_ERR_OK on success
1580 * JB_ERR_MEMORY on out-of-memory error.
1582 *********************************************************************/
1583 jb_err cgi_error_disabled(const struct client_state *csp,
1584 struct http_response *rsp)
1586 struct map *exports;
1591 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1593 return JB_ERR_MEMORY;
1595 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1597 /* Not important enough to do anything */
1598 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1601 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1605 /*********************************************************************
1607 * Function : cgi_init_error_messages
1609 * Description : Call at the start of the program to initialize
1610 * the error message used by cgi_error_memory().
1616 *********************************************************************/
1617 void cgi_init_error_messages(void)
1619 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1620 cgi_error_memory_response->head =
1621 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1622 "Content-Type: text/html\r\n"
1624 cgi_error_memory_response->body =
1627 " <title>500 Internal Privoxy Error</title>\r\n"
1628 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1631 "<h1>500 Internal Privoxy Error</h1>\r\n"
1632 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1633 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1637 cgi_error_memory_response->head_length =
1638 strlen(cgi_error_memory_response->head);
1639 cgi_error_memory_response->content_length =
1640 strlen(cgi_error_memory_response->body);
1641 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1645 /*********************************************************************
1647 * Function : cgi_error_memory
1649 * Description : Called if a CGI function runs out of memory.
1650 * Returns a statically-allocated error response.
1654 * Returns : http_response data structure for output. This is
1655 * statically allocated, for obvious reasons.
1657 *********************************************************************/
1658 struct http_response *cgi_error_memory(void)
1660 /* assert that it's been initialized. */
1661 assert(cgi_error_memory_response->head);
1663 return cgi_error_memory_response;
1667 /*********************************************************************
1669 * Function : cgi_error_no_template
1671 * Description : Almost-CGI function that is called if a template
1672 * cannot be loaded. Note this is not a true CGI,
1673 * it takes a template name rather than a map of
1677 * 1 : csp = Current client state (buffers, headers, etc...)
1678 * 2 : rsp = http_response data structure for output
1679 * 3 : template_name = Name of template that could not
1682 * Returns : JB_ERR_OK on success
1683 * JB_ERR_MEMORY on out-of-memory error.
1685 *********************************************************************/
1686 jb_err cgi_error_no_template(const struct client_state *csp,
1687 struct http_response *rsp,
1688 const char *template_name)
1690 static const char status[] =
1691 "500 Internal Privoxy Error";
1692 static const char body_prefix[] =
1695 " <title>500 Internal Privoxy Error</title>\r\n"
1696 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1699 "<h1>500 Internal Privoxy Error</h1>\r\n"
1700 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1701 "<p><b>Could not load template file <code>";
1702 static const char body_suffix[] =
1703 "</code> or one of its included components.</b></p>\r\n"
1704 "<p>Please contact your proxy administrator.</p>\r\n"
1705 "<p>If you are the proxy administrator, please put the required file(s)"
1706 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1707 "location of the <code><i>(confdir)</i></code> directory "
1708 "is specified in the main Privoxy <code>config</code> "
1709 "file. (It's typically the Privoxy install directory"
1711 ", or <code>/etc/privoxy/</code>"
1712 #endif /* ndef _WIN32 */
1716 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1720 assert(template_name);
1722 /* Reset rsp, if needed */
1726 rsp->content_length = 0;
1727 rsp->head_length = 0;
1730 rsp->body = malloc(body_size);
1731 if (rsp->body == NULL)
1733 return JB_ERR_MEMORY;
1735 strlcpy(rsp->body, body_prefix, body_size);
1736 strlcat(rsp->body, template_name, body_size);
1737 strlcat(rsp->body, body_suffix, body_size);
1739 rsp->status = strdup(status);
1740 if (rsp->status == NULL)
1742 return JB_ERR_MEMORY;
1749 /*********************************************************************
1751 * Function : cgi_error_unknown
1753 * Description : Almost-CGI function that is called if an unexpected
1754 * error occurs in the top-level CGI dispatcher.
1755 * In this context, "unexpected" means "anything other
1756 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1757 * expected to handle all other errors internally,
1758 * since they can give more relavent error messages
1761 * Note this is not a true CGI, it takes an error
1762 * code rather than a map of parameters.
1765 * 1 : csp = Current client state (buffers, headers, etc...)
1766 * 2 : rsp = http_response data structure for output
1767 * 3 : error_to_report = Error code to report.
1769 * Returns : JB_ERR_OK on success
1770 * JB_ERR_MEMORY on out-of-memory error.
1772 *********************************************************************/
1773 jb_err cgi_error_unknown(const struct client_state *csp,
1774 struct http_response *rsp,
1775 jb_err error_to_report)
1777 static const char status[] =
1778 "500 Internal Privoxy Error";
1779 static const char body_prefix[] =
1782 " <title>500 Internal Privoxy Error</title>\r\n"
1783 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1786 "<h1>500 Internal Privoxy Error</h1>\r\n"
1787 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1788 "<p><b>Unexpected internal error: ";
1789 static const char body_suffix[] =
1792 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1793 "file a bug report</a>.</p>\r\n"
1798 * Due to sizeof(errnumbuf), body_size will be slightly
1799 * bigger than necessary but it doesn't really matter.
1801 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1805 /* Reset rsp, if needed */
1809 rsp->content_length = 0;
1810 rsp->head_length = 0;
1812 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1814 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1816 rsp->body = malloc(body_size);
1817 if (rsp->body == NULL)
1819 return JB_ERR_MEMORY;
1821 strlcpy(rsp->body, body_prefix, body_size);
1822 strlcat(rsp->body, errnumbuf, body_size);
1823 strlcat(rsp->body, body_suffix, body_size);
1825 rsp->status = strdup(status);
1826 if (rsp->status == NULL)
1828 return JB_ERR_MEMORY;
1835 /*********************************************************************
1837 * Function : cgi_error_bad_param
1839 * Description : CGI function that is called if the parameters
1840 * (query string) for a CGI were wrong.
1843 * 1 : csp = Current client state (buffers, headers, etc...)
1844 * 2 : rsp = http_response data structure for output
1846 * CGI Parameters : none
1848 * Returns : JB_ERR_OK on success
1849 * JB_ERR_MEMORY on out-of-memory error.
1851 *********************************************************************/
1852 jb_err cgi_error_bad_param(const struct client_state *csp,
1853 struct http_response *rsp)
1855 struct map *exports;
1860 if (NULL == (exports = default_exports(csp, NULL)))
1862 return JB_ERR_MEMORY;
1865 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1869 /*********************************************************************
1871 * Function : cgi_redirect
1873 * Description : CGI support function to generate a HTTP redirect
1877 * 1 : rsp = http_response data structure for output
1878 * 2 : target = string with the target URL
1880 * CGI Parameters : None
1882 * Returns : JB_ERR_OK on success
1883 * JB_ERR_MEMORY on out-of-memory error.
1885 *********************************************************************/
1886 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1893 err = enlist_unique_header(rsp->headers, "Location", target);
1895 rsp->status = strdup("302 Local Redirect from Privoxy");
1896 if (rsp->status == NULL)
1898 return JB_ERR_MEMORY;
1905 /*********************************************************************
1907 * Function : add_help_link
1909 * Description : Produce a copy of the string given as item,
1910 * embedded in an HTML link to its corresponding
1911 * section (item name in uppercase) in the actions
1912 * chapter of the user manual, (whose URL is given in
1913 * the config and defaults to our web site).
1915 * FIXME: I currently only work for actions, and would
1916 * like to be generalized for other topics.
1919 * 1 : item = item (will NOT be free()d.)
1920 * It is assumed to be HTML-safe.
1921 * 2 : config = The current configuration.
1923 * Returns : String with item embedded in link, or NULL on
1926 *********************************************************************/
1927 char *add_help_link(const char *item,
1928 struct configuration_spec *config)
1932 if (!item) return NULL;
1934 result = strdup("<a href=\"");
1935 if (!strncmpic(config->usermanual, "file://", 7) ||
1936 !strncmpic(config->usermanual, "http", 4))
1938 string_append(&result, config->usermanual);
1942 string_append(&result, "http://");
1943 string_append(&result, CGI_SITE_2_HOST);
1944 string_append(&result, "/user-manual/");
1946 string_append(&result, ACTIONS_HELP_PREFIX);
1947 string_join (&result, string_toupper(item));
1948 string_append(&result, "\">");
1949 string_append(&result, item);
1950 string_append(&result, "</a> ");
1956 /*********************************************************************
1958 * Function : get_http_time
1960 * Description : Get the time in a format suitable for use in a
1961 * HTTP header - e.g.:
1962 * "Sun, 06 Nov 1994 08:49:37 GMT"
1965 * 1 : time_offset = Time returned will be current time
1966 * plus this number of seconds.
1967 * 2 : buf = Destination for result.
1968 * 3 : buffer_size = Size of the buffer above. Must be big
1969 * enough to hold 29 characters plus a
1974 *********************************************************************/
1975 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1977 static const char day_names[7][4] =
1978 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1979 static const char month_names[12][4] =
1980 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1981 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1984 time_t current_time;
1985 #if defined(HAVE_GMTIME_R)
1990 assert(buffer_size > 29);
1992 time(¤t_time);
1994 current_time += time_offset;
1996 /* get and save the gmt */
1998 t = gmtime_r(¤t_time, &dummy);
1999 #elif FEATURE_PTHREAD
2000 pthread_mutex_lock(&gmtime_mutex);
2001 t = gmtime(¤t_time);
2002 pthread_mutex_unlock(&gmtime_mutex);
2004 t = gmtime(¤t_time);
2007 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
2008 snprintf(buf, buffer_size,
2009 "%s, %02d %s %4d %02d:%02d:%02d GMT",
2010 day_names[t->tm_wday],
2012 month_names[t->tm_mon],
2021 /*********************************************************************
2023 * Function : get_locale_time
2025 * Description : Get the time in a date(1)-like format
2026 * according to the current locale - e.g.:
2027 * "Fri Aug 29 19:37:12 CEST 2008"
2029 * XXX: Should we allow the user to change the format?
2032 * 1 : buf = Destination for result.
2033 * 2 : buffer_size = Size of the buffer above. Must be big
2034 * enough to hold 29 characters plus a
2039 *********************************************************************/
2040 static void get_locale_time(char *buf, size_t buffer_size)
2043 time_t current_time;
2044 #if defined(HAVE_LOCALTIME_R)
2049 assert(buffer_size > 29);
2051 time(¤t_time);
2053 #if HAVE_LOCALTIME_R
2054 timeptr = localtime_r(¤t_time, &dummy);
2055 #elif FEATURE_PTHREAD
2056 pthread_mutex_lock(&localtime_mutex);
2057 timeptr = localtime(¤t_time);
2058 pthread_mutex_unlock(&localtime_mutex);
2060 timeptr = localtime(¤t_time);
2063 strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
2067 /*********************************************************************
2069 * Function : finish_http_response
2071 * Description : Fill in the missing headers in an http response,
2072 * and flatten the headers to an http head.
2073 * For HEAD requests the body is freed once
2074 * the Content-Length header is set.
2077 * 1 : rsp = pointer to http_response to be processed
2079 * Returns : A http_response, usually the rsp parameter.
2080 * On error, free()s rsp and returns cgi_error_memory()
2082 *********************************************************************/
2083 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2085 char buf[BUFFER_SIZE];
2088 /* Special case - do NOT change this statically allocated response,
2089 * which is ready for output anyway.
2091 if (rsp == cgi_error_memory_response)
2097 * Fill in the HTTP Status, using HTTP/1.1
2098 * unless the client asked for HTTP/1.0.
2100 snprintf(buf, sizeof(buf), "%s %s",
2101 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2102 rsp->status ? rsp->status : "200 OK");
2103 err = enlist_first(rsp->headers, buf);
2106 * Set the Content-Length
2108 if (rsp->content_length == 0)
2110 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2114 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2115 err = enlist(rsp->headers, buf);
2118 if (0 == strcmpic(csp->http->gpc, "head"))
2121 * The client only asked for the head. Dispose
2122 * the body and log an offensive message.
2124 * While it may seem to be a bit inefficient to
2125 * prepare the body if it isn't needed, it's the
2126 * only way to get the Content-Length right for
2127 * dynamic pages. We could have disposed the body
2128 * earlier, but not without duplicating the
2129 * Content-Length setting code above.
2131 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2133 rsp->content_length = 0;
2136 if (strncmpic(rsp->status, "302", 3))
2139 * If it's not a redirect without any content,
2140 * set the Content-Type to text/html if it's
2141 * not already specified.
2143 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2147 * Fill in the rest of the default headers:
2149 * Date: set to current date/time.
2150 * Last-Modified: set to date/time the page was last changed.
2151 * Expires: set to date/time page next needs reloading.
2152 * Cache-Control: set to "no-cache" if applicable.
2154 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2159 * Set Expires to about 10 min into the future so it'll get reloaded
2160 * occasionally, e.g. if Privoxy gets upgraded.
2165 get_http_time(0, buf, sizeof(buf));
2166 err = enlist_unique_header(rsp->headers, "Date", buf);
2169 /* Some date in the past. */
2170 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2174 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
2175 err = enlist_unique_header(rsp->headers, "Expires", buf);
2178 else if (!strncmpic(rsp->status, "302", 3))
2180 get_http_time(0, buf, sizeof(buf));
2181 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2186 * Setting "Cache-Control" to "no-cache" and "Expires" to
2187 * the current time doesn't exactly forbid caching, it just
2188 * requires the client to revalidate the cached copy.
2190 * If a temporary problem occurs and the user tries again after
2191 * getting Privoxy's error message, a compliant browser may set the
2192 * If-Modified-Since header with the content of the error page's
2193 * Last-Modified header. More often than not, the document on the server
2194 * is older than Privoxy's error message, the server would send status code
2195 * 304 and the browser would display the outdated error message again and again.
2197 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2198 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2199 * and can be safely used to "revalidate" without getting a status code 304.
2201 * There is no need to let the useless If-Modified-Since header reach the
2202 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2204 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2206 get_http_time(0, buf, sizeof(buf));
2207 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2208 if (!strncmpic(rsp->status, "403", 3)
2209 || !strncmpic(rsp->status, "404", 3)
2210 || !strncmpic(rsp->status, "503", 3))
2212 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2216 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2218 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2219 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2225 * HTTP/1.1 applications that do not support persistent connections MUST
2226 * include the "close" connection option in every message.
2228 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2233 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2235 free_http_response(rsp);
2236 return cgi_error_memory();
2238 rsp->head_length = strlen(rsp->head);
2245 /*********************************************************************
2247 * Function : alloc_http_response
2249 * Description : Allocates a new http_response structure.
2253 * Returns : pointer to a new http_response, or NULL.
2255 *********************************************************************/
2256 struct http_response *alloc_http_response(void)
2258 return (struct http_response *) zalloc(sizeof(struct http_response));
2263 /*********************************************************************
2265 * Function : free_http_response
2267 * Description : Free the memory occupied by an http_response
2268 * and its depandant structures.
2271 * 1 : rsp = pointer to http_response to be freed
2275 *********************************************************************/
2276 void free_http_response(struct http_response *rsp)
2279 * Must special case cgi_error_memory_response, which is never freed.
2281 if (rsp && (rsp != cgi_error_memory_response))
2286 destroy_list(rsp->headers);
2293 /*********************************************************************
2295 * Function : template_load
2297 * Description : CGI support function that loads a given HTML
2298 * template, ignoring comment lines and following
2299 * #include statements up to a depth of 1.
2302 * 1 : csp = Current client state (buffers, headers, etc...)
2303 * 2 : template_ptr = Destination for pointer to loaded
2305 * 3 : templatename = name of the HTML template to be used
2306 * 4 : recursive = Flag set if this function calls itself
2307 * following an #include statament
2309 * Returns : JB_ERR_OK on success
2310 * JB_ERR_MEMORY on out-of-memory error.
2311 * JB_ERR_FILE if the template file cannot be read
2313 *********************************************************************/
2314 jb_err template_load(const struct client_state *csp, char **template_ptr,
2315 const char *templatename, int recursive)
2318 char *templates_dir_path;
2321 char *included_module;
2324 char buf[BUFFER_SIZE];
2327 assert(template_ptr);
2328 assert(templatename);
2330 *template_ptr = NULL;
2332 /* Validate template name. Paranoia. */
2333 for (p = templatename; *p != 0; p++)
2335 if ( ((*p < 'a') || (*p > 'z'))
2336 && ((*p < 'A') || (*p > 'Z'))
2337 && ((*p < '0') || (*p > '9'))
2341 /* Illegal character */
2347 * Generate full path using either templdir
2348 * or confdir/templates as base directory.
2350 if (NULL != csp->config->templdir)
2352 templates_dir_path = strdup(csp->config->templdir);
2356 templates_dir_path = make_path(csp->config->confdir, "templates");
2359 if (templates_dir_path == NULL)
2361 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2363 return JB_ERR_MEMORY;
2366 full_path = make_path(templates_dir_path, templatename);
2367 free(templates_dir_path);
2368 if (full_path == NULL)
2370 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2372 return JB_ERR_MEMORY;
2375 /* Allocate buffer */
2377 file_buffer = strdup("");
2378 if (file_buffer == NULL)
2380 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2382 return JB_ERR_MEMORY;
2385 /* Open template file */
2387 if (NULL == (fp = fopen(full_path, "r")))
2389 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2397 * Read the file, ignoring comments, and honoring #include
2398 * statements, unless we're already called recursively.
2400 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2401 * This is unlikely in practise.
2403 while (fgets(buf, BUFFER_SIZE, fp))
2405 if (!recursive && !strncmp(buf, "#include ", 9))
2407 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2414 if (string_join(&file_buffer, included_module))
2417 return JB_ERR_MEMORY;
2423 /* skip lines starting with '#' */
2429 if (string_append(&file_buffer, buf))
2432 return JB_ERR_MEMORY;
2437 *template_ptr = file_buffer;
2443 /*********************************************************************
2445 * Function : template_fill
2447 * Description : CGI support function that fills in a pre-loaded
2448 * HTML template by replacing @name@ with value using
2449 * pcrs, for each item in the output map.
2451 * Note that a leading '$' charachter in the export map's
2452 * values will be stripped and toggle on backreference
2456 * 1 : template_ptr = IN: Template to be filled out.
2458 * OUT: Filled out template.
2459 * Caller must free().
2460 * 2 : exports = map with fill in symbol -> name pairs
2462 * Returns : JB_ERR_OK on success (and for uncritical errors)
2463 * JB_ERR_MEMORY on out-of-memory error
2465 *********************************************************************/
2466 jb_err template_fill(char **template_ptr, const struct map *exports)
2468 struct map_entry *m;
2470 char buf[BUFFER_SIZE];
2471 char *tmp_out_buffer;
2477 assert(template_ptr);
2478 assert(*template_ptr);
2481 file_buffer = *template_ptr;
2482 size = strlen(file_buffer) + 1;
2485 * Assemble pcrs joblist from exports map
2487 for (m = exports->first; m != NULL; m = m->next)
2489 if (*m->name == '$')
2492 * First character of name is '$', so remove this flag
2493 * character and allow backreferences ($1 etc) in the
2494 * "replace with" text.
2496 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2502 * Treat the "replace with" text as a literal string -
2503 * no quoting needed, no backreferences allowed.
2504 * ("Trivial" ['T'] flag).
2508 /* Enclose name in @@ */
2509 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2513 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2515 /* Make and run job. */
2516 job = pcrs_compile(buf, m->value, flags, &error);
2519 if (error == PCRS_ERR_NOMEM)
2522 *template_ptr = NULL;
2523 return JB_ERR_MEMORY;
2527 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2528 /* Hope it wasn't important and silently ignore the invalid job */
2533 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2536 if (NULL == tmp_out_buffer)
2538 *template_ptr = NULL;
2539 return JB_ERR_MEMORY;
2545 * Substitution failed, keep the original buffer,
2546 * log the problem and ignore it.
2548 * The user might see some unresolved @CGI_VARIABLES@,
2549 * but returning a special CGI error page seems unreasonable
2550 * and could mask more important error messages.
2552 free(tmp_out_buffer);
2553 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2554 buf, m->value, flags, pcrs_strerror(error));
2558 /* Substitution succeeded, use modified buffer. */
2560 file_buffer = tmp_out_buffer;
2568 *template_ptr = file_buffer;
2573 /*********************************************************************
2575 * Function : template_fill_for_cgi
2577 * Description : CGI support function that loads a HTML template
2578 * and fills it in. Handles file-not-found errors
2579 * by sending a HTML error message. For convenience,
2580 * this function also frees the passed "exports" map.
2583 * 1 : csp = Client state
2584 * 2 : templatename = name of the HTML template to be used
2585 * 3 : exports = map with fill in symbol -> name pairs.
2586 * Will be freed by this function.
2587 * 4 : rsp = Response structure to fill in.
2589 * Returns : JB_ERR_OK on success
2590 * JB_ERR_MEMORY on out-of-memory error
2592 *********************************************************************/
2593 jb_err template_fill_for_cgi(const struct client_state *csp,
2594 const char *templatename,
2595 struct map *exports,
2596 struct http_response *rsp)
2601 assert(templatename);
2605 err = template_load(csp, &rsp->body, templatename, 0);
2606 if (err == JB_ERR_FILE)
2609 return cgi_error_no_template(csp, rsp, templatename);
2614 return err; /* JB_ERR_MEMORY */
2616 err = template_fill(&rsp->body, exports);
2622 /*********************************************************************
2624 * Function : default_exports
2626 * Description : returns a struct map list that contains exports
2627 * which are common to all CGI functions.
2630 * 1 : csp = Current client state (buffers, headers, etc...)
2631 * 2 : caller = name of CGI who calls us and which should
2632 * be excluded from the generated menu. May be
2634 * Returns : NULL if no memory, else a new map. Caller frees.
2636 *********************************************************************/
2637 struct map *default_exports(const struct client_state *csp, const char *caller)
2641 struct map * exports;
2642 int local_help_exists = 0;
2643 char *ip_address = NULL;
2644 char *hostname = NULL;
2648 exports = new_map();
2649 if (exports == NULL)
2654 if (csp->config->hostname)
2656 get_host_information(csp->cfd, &ip_address, NULL);
2657 hostname = strdup(csp->config->hostname);
2661 get_host_information(csp->cfd, &ip_address, &hostname);
2664 err = map(exports, "version", 1, html_encode(VERSION), 0);
2665 get_locale_time(buf, sizeof(buf));
2666 if (!err) err = map(exports, "time", 1, html_encode(buf), 0);
2667 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2669 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2671 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2672 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2673 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2674 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2675 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2676 !strncmpic(csp->config->usermanual, "http", 4))
2678 /* Manual is located somewhere else, just link to it. */
2679 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2683 /* Manual is delivered by Privoxy. */
2684 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2686 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2687 #ifdef FEATURE_TOGGLE
2688 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2690 if (!err) err = map_block_killer(exports, "can-toggle");
2693 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2694 if (!err) err = map(exports, "my-port", 1, buf, 1);
2696 if(!strcmp(CODE_STATUS, "stable"))
2698 if (!err) err = map_block_killer(exports, "unstable");
2701 if (csp->config->admin_address != NULL)
2703 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2704 local_help_exists = 1;
2708 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2711 if (csp->config->proxy_info_url != NULL)
2713 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2714 local_help_exists = 1;
2718 if (!err) err = map_block_killer(exports, "have-proxy-info");
2721 if (local_help_exists == 0)
2723 if (!err) err = map_block_killer(exports, "have-help-info");
2736 /*********************************************************************
2738 * Function : map_block_killer
2740 * Description : Convenience function.
2741 * Adds a "killer" for the conditional HTML-template
2742 * block <name>, i.e. a substitution of the regex
2743 * "if-<name>-start.*if-<name>-end" to the given
2747 * 1 : exports = map to extend
2748 * 2 : name = name of conditional block
2750 * Returns : JB_ERR_OK on success
2751 * JB_ERR_MEMORY on out-of-memory error.
2753 *********************************************************************/
2754 jb_err map_block_killer(struct map *exports, const char *name)
2756 char buf[1000]; /* Will do, since the names are hardwired */
2760 assert(strlen(name) < 490);
2762 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2763 return map(exports, buf, 1, "", 1);
2767 /*********************************************************************
2769 * Function : map_block_keep
2771 * Description : Convenience function. Removes the markers used
2772 * by map-block-killer, to save a few bytes.
2773 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2776 * 1 : exports = map to extend
2777 * 2 : name = name of conditional block
2779 * Returns : JB_ERR_OK on success
2780 * JB_ERR_MEMORY on out-of-memory error.
2782 *********************************************************************/
2783 jb_err map_block_keep(struct map *exports, const char *name)
2786 char buf[500]; /* Will do, since the names are hardwired */
2790 assert(strlen(name) < 490);
2792 snprintf(buf, sizeof(buf), "if-%s-start", name);
2793 err = map(exports, buf, 1, "", 1);
2800 snprintf(buf, sizeof(buf), "if-%s-end", name);
2801 return map(exports, buf, 1, "", 1);
2805 /*********************************************************************
2807 * Function : map_conditional
2809 * Description : Convenience function.
2810 * Adds an "if-then-else" for the conditional HTML-template
2811 * block <name>, i.e. a substitution of the form:
2818 * The control structure and one of the alternatives
2822 * 1 : exports = map to extend
2823 * 2 : name = name of conditional block
2824 * 3 : choose_first = nonzero for first, zero for second.
2826 * Returns : JB_ERR_OK on success
2827 * JB_ERR_MEMORY on out-of-memory error.
2829 *********************************************************************/
2830 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2832 char buf[1000]; /* Will do, since the names are hardwired */
2837 assert(strlen(name) < 480);
2839 snprintf(buf, sizeof(buf), (choose_first
2840 ? "else-not-%s@.*@endif-%s"
2841 : "if-%s-then@.*@else-not-%s"),
2844 err = map(exports, buf, 1, "", 1);
2850 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2851 return map(exports, buf, 1, "", 1);
2855 /*********************************************************************
2857 * Function : make_menu
2859 * Description : Returns an HTML-formatted menu of the available
2860 * unhidden CGIs, excluding the one given in <self>
2861 * and the toggle CGI if toggling is disabled.
2864 * 1 : self = name of CGI to leave out, can be NULL for
2866 * 2 : feature_flags = feature bitmap from csp->config
2869 * Returns : menu string, or NULL on out-of-memory error.
2871 *********************************************************************/
2872 char *make_menu(const char *self, const unsigned feature_flags)
2874 const struct cgi_dispatcher *d;
2875 char *result = strdup("");
2879 self = "NO-SUCH-CGI!";
2882 /* List available unhidden CGI's and export as "other-cgis" */
2883 for (d = cgi_dispatchers; d->name; d++)
2886 #ifdef FEATURE_TOGGLE
2887 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2890 * Suppress the toggle link if remote toggling is disabled.
2894 #endif /* def FEATURE_TOGGLE */
2896 if (d->description && strcmp(d->name, self))
2898 char *html_encoded_prefix;
2901 * Line breaks would be great, but break
2902 * the "blocked" template's JavaScript.
2904 string_append(&result, "<li><a href=\"");
2905 html_encoded_prefix = html_encode(CGI_PREFIX);
2906 if (html_encoded_prefix == NULL)
2912 string_append(&result, html_encoded_prefix);
2913 free(html_encoded_prefix);
2915 string_append(&result, d->name);
2916 string_append(&result, "\">");
2917 string_append(&result, d->description);
2918 string_append(&result, "</a></li>");
2926 /*********************************************************************
2928 * Function : dump_map
2930 * Description : HTML-dump a map for debugging (as table)
2933 * 1 : the_map = map to dump
2935 * Returns : string with HTML
2937 *********************************************************************/
2938 char *dump_map(const struct map *the_map)
2940 struct map_entry *cur_entry;
2941 char *ret = strdup("");
2943 string_append(&ret, "<table>\n");
2945 for (cur_entry = the_map->first;
2946 (cur_entry != NULL) && (ret != NULL);
2947 cur_entry = cur_entry->next)
2949 string_append(&ret, "<tr><td><b>");
2950 string_join (&ret, html_encode(cur_entry->name));
2951 string_append(&ret, "</b></td><td>");
2952 string_join (&ret, html_encode(cur_entry->value));
2953 string_append(&ret, "</td></tr>\n");
2956 string_append(&ret, "</table>\n");