1 const char cgi_rcs[] = "$Id: cgi.c,v 1.112 2008/08/31 16:08:12 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.112 2008/08/31 16:08:12 fabiankeil
42 * "View the request headers" isn't more equal than the other
43 * menu items and thus doesn't need a trailing dot either.
45 * Revision 1.111 2008/08/31 15:59:02 fabiankeil
46 * There's no reason to let remote toggling support depend
47 * on FEATURE_CGI_EDIT_ACTIONS, so make sure it doesn't.
49 * Revision 1.110 2008/08/31 14:55:43 fabiankeil
50 * Add a @date@ symbol to include a date(1)-like time string
51 * in templates. Modified version of the patch Endre Szabo
52 * submitted in #2026468.
54 * Revision 1.109 2008/07/26 09:40:27 fabiankeil
55 * Remove the unconditional block in get_http_time().
56 * It's pointless now that it's no longer used to limit
57 * dummy's scope. While at it, remove obvious comments
58 * and a trailing space.
60 * Revision 1.108 2008/05/26 17:30:53 fabiankeil
61 * Provide an OpenSearch Description to access the
62 * show-url-info page through "search engine plugins".
64 * Revision 1.107 2008/05/26 16:23:19 fabiankeil
65 * - Fix spelling in template-not-found message.
66 * - Declare referrer_is_safe()'s alternative_prefix[] static.
68 * Revision 1.106 2008/05/21 15:24:38 fabiankeil
69 * Mark csp as immutable for a bunch of functions.
71 * Revision 1.105 2008/04/17 14:40:47 fabiankeil
72 * Provide get_http_time() with the buffer size so it doesn't
73 * have to blindly assume that the buffer is big enough.
75 * Revision 1.104 2008/03/26 18:07:06 fabiankeil
76 * Add hostname directive. Closes PR#1918189.
78 * Revision 1.103 2008/03/21 11:13:57 fabiankeil
79 * Only gather host information if it's actually needed.
80 * Also move the code out of accept_connection() so it's less likely
81 * to delay other incoming connections if the host is misconfigured.
83 * Revision 1.102 2008/02/23 16:33:43 fabiankeil
84 * Let forward_url() use the standard parameter ordering
85 * and mark its second parameter immutable.
87 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
88 * Add SOCKS5 support for "Forwarding failure" CGI page.
90 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
91 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
94 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
95 * #1763173 from Stefan Huehner: declare some more functions static.
97 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
98 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
100 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
101 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
103 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
104 * Use sizeof() more often.
106 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
107 * Don't overlook map result for the forwarding-type.
109 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
110 * Use a transparent background for the PNG replacement pattern.
112 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
113 * - Save the reason for generating http_responses.
114 * - Fix --disable-toggle (again).
115 * - Use TBL birthday hack for 403 responses as well.
116 * - Uglify the @menu@ again to fix JavaScript
117 * errors on the "blocked" template.
118 * - Escape an ampersand in cgi_error_unknown().
120 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
121 * - Add HEAD support to finish_http_response.
122 * - Add error favicon to internal HTML error messages.
124 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
125 * Add new config option "templdir" to
126 * change the templates directory.
128 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
129 * Added "forwarding-failed" template support for error_response().
131 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
132 * Add favicon delivery functions.
134 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
135 * - Map variables that aren't guaranteed to be
136 * pure ASCII html_encoded.
137 * - Use CGI_PREFIX to generate URL for user manual
138 * CGI page to make sure CGI_SITE_2_PATH is included.
140 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
141 * - "Protect" against a rather lame JavaScript-based
142 * Privoxy detection "attack" and check the referrer
143 * before delivering the CGI style sheet.
144 * - Move referrer check for unsafe CGI pages into
145 * referrer_is_safe() and log the result.
146 * - Map @url@ in cgi-error-disabled page.
147 * It's required for the "go there anyway" link.
148 * - Mark *csp as immutable for grep_cgi_referrer().
150 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
151 * Fix strdup() error handling in cgi_error_unknown()
152 * and cgi_error_no_template(). Reported by Markus Elfring.
154 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
155 * Handle pcrs_execute() errors in template_fill() properly.
157 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
158 * Fixed gcc43 conversion warnings and replaced sprintf
159 * calls with snprintf to give OpenBSD's gcc one less reason
162 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
163 * Escape ampersand in Privoxy menu.
165 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
166 * Suppress the toggle link if remote toggling is disabled.
168 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
169 * Fix configure option --disable-toggle.
170 * Thanks to Peter Thoenen for reporting this.
172 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
173 * Don't lose the FORCE_PREFIX in case of
174 * connection problems. Fixes #612235.
176 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
177 * Make pthread mutex locking more generic. Instead of
178 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
179 * and use mutex locking unless there is an _r function
180 * available. Better safe than sorry.
182 * Fixes "./configure --disable-pthread" and should result
183 * in less threading-related problems on pthread-using platforms,
184 * but it still doesn't fix BR#1122404.
186 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
187 * Use CGI_PREFIX to check the referrer.
188 * The check for "http://config.privoxy.org/" fails
189 * if the user modified CGI_SITE_2_HOST.
191 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
192 * Adjusted headers for Privoxy's cgi responses:
193 * Don't set Last-Modified, Expires and Cache-Control
194 * headers for redirects; always set "Connection: close".
196 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
197 * Only predate the Last-Modified header for cgi responses
198 * that are delivered with status code 404 or 503.
200 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
201 * Mark cgi_send_user_manual as harmless,
202 * to fix the access denied problem Hal spotted.
203 * The manual has no secret content, therefore we
204 * don't have to care about "secure" referrers.
206 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
207 * Incorporate modified version of Roland Rosenfeld's patch to
208 * optionally access the user-manual via Privoxy. Closes patch 679075.
210 * Formatting changed to Privoxy style, added call to
211 * cgi_error_no_template if the requested file doesn't
212 * exist and modified check whether or not Privoxy itself
213 * should serve the manual. Should work cross-platform now.
215 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
216 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
218 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
219 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
220 * with what was really the latest development (the v_3_0_branch branch)
222 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
223 * Moved cgi_error_disabled() from cgiedit.c to
224 * cgi.c to re-enable build with --disable-editor.
225 * Fixes Bug #892744. Thanks to Matthew Fischer
228 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
229 * - Added new function cgi_redirect to handle creation of
230 * HTTP redirect messages formerly repeated in the code.
231 * - Send cgi_error_disabled instead of cgi_error_404 when
232 * referrer check fails
233 * - Dynamic content now gets Expires header field with date
236 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
237 * Bugfix: Transparent PNG was not transparent. Thanks to
238 * Dan Razzell of Starfish Systems for notice and new PNG.
240 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
241 * Security fix: dspatch_known_cgi no longer considers an empty
242 * referrer safe for critical CGIs, since malicious links could
243 * reside on https:// locations which browsers don't advertize as
244 * referrers. Closes bug #749916, thanks to Jeff Epler for the
245 * hint. Goodbye One-Click[tm] toggling :-(
247 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
250 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
251 * Killed a compiler warning on OSX
253 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
254 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
255 * (fixes bug #710056)
256 * - Show toggle info only if we have it
258 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
259 * Move declaration of struct tm dummy outside of a control block so it is
260 * accessible later on during snprintf in get_http_time.
262 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
263 * Cosmetic: Renamed cryptic variable
265 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
266 * 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.
268 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
269 * Disable access to critical CGIs via untrusted referrers.
270 * This prevents users from being tricked by malicious websites
271 * into making unintentional configuration changes:
273 * - Added flag to each cgi_dispatcher that allows or denies
275 * - Introduced proviorical function that greps for the
276 * referrer header before regular header parsing happens
277 * - Added safety check to dispatch_known_cgi. CGI is called
278 * if (cgi harmless || no referrer || we are referrer).
279 * Else a) toggle calls are modified not to change status and
280 * b) all other calls are denied.
282 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
283 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
285 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
286 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
288 * Revision 1.70 2002/05/19 11:33:20 jongfoster
289 * If a CGI error was not handled, and propogated back to
290 * dispatch_known_cgi(), then it was assumed to be "out of memory".
291 * This gave a very misleading error message.
293 * Now other errors will cause a simple message giving the error
294 * number and asking the user to report a bug.
297 * http://sourceforge.net/tracker/index.php?func=detail
298 * &aid=557905&group_id=11118&atid=111118
300 * Revision 1.69 2002/05/14 21:28:40 oes
301 * - Fixed add_help_link to link to the (now split) actions
302 * part of the config chapter
303 * - Renamed helplink export to actions-help-prefix
305 * Revision 1.68 2002/05/12 21:36:29 jongfoster
306 * Correcting function comments
308 * Revision 1.67 2002/04/30 12:02:07 oes
309 * Nit: updated a comment
311 * Revision 1.66 2002/04/26 18:32:57 jongfoster
312 * Fixing a memory leak on error
314 * Revision 1.65 2002/04/26 12:53:51 oes
315 * - New function add_help_link
316 * - default_exports now exports links to the user manual
317 * and a prefix for links into the config chapter
319 * Revision 1.64 2002/04/24 02:17:21 oes
320 * - Better descriptions for CGIs
321 * - Hide edit-actions, more shortcuts
322 * - Moved get_char_param, get_string_param and get_number_param here
325 * Revision 1.63 2002/04/15 19:06:43 jongfoster
328 * Revision 1.62 2002/04/10 19:59:46 jongfoster
329 * Fixes to #include in templates:
330 * - Didn't close main file if loading an included template fails.
331 * - I'm paranoid and want to disallow "#include /etc/passwd".
333 * Revision 1.61 2002/04/10 13:37:48 oes
334 * Made templates modular: template_load now recursive with max depth 1
336 * Revision 1.60 2002/04/08 20:50:25 swa
339 * Revision 1.59 2002/04/05 15:51:51 oes
340 * - added send-stylesheet CGI
341 * - bugfix: error-pages now get correct request protocol
343 * - kludged CGI descriptions and menu not to break JS syntax
345 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
346 * Fix Mac OSX compiler warnings
348 * Revision 1.57 2002/03/26 22:29:54 swa
349 * we have a new homepage!
351 * Revision 1.56 2002/03/24 17:50:46 jongfoster
352 * Fixing compile error if actions file editor disabled
354 * Revision 1.55 2002/03/24 16:55:06 oes
355 * Making GIF checkerboard transparent
357 * Revision 1.54 2002/03/24 16:18:15 jongfoster
360 * Revision 1.53 2002/03/24 16:06:00 oes
361 * Correct transparency for checkerboard PNG. Thanks, Magnus!
363 * Revision 1.52 2002/03/24 15:23:33 jongfoster
366 * Revision 1.51 2002/03/24 13:25:43 swa
367 * name change related issues
369 * Revision 1.50 2002/03/16 23:54:06 jongfoster
370 * Adding graceful termination feature, to help look for memory leaks.
371 * If you enable this (which, by design, has to be done by hand
372 * editing config.h) and then go to http://i.j.b/die, then the program
373 * will exit cleanly after the *next* request. It should free all the
374 * memory that was used.
376 * Revision 1.49 2002/03/13 00:27:04 jongfoster
379 * Revision 1.48 2002/03/08 17:47:07 jongfoster
382 * Revision 1.47 2002/03/08 16:41:33 oes
383 * Added GIF images again
385 * Revision 1.46 2002/03/07 03:48:38 oes
386 * - Changed built-in images from GIF to PNG
387 * (with regard to Unisys patent issue)
388 * - Added a 4x4 pattern PNG which is less intrusive
389 * than the logo but also clearly marks the deleted banners
391 * Revision 1.45 2002/03/06 22:54:35 jongfoster
392 * Automated function-comment nitpicking.
394 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
395 * - Better error reporting on OS/2
396 * - Fix double-slash comment (oops)
398 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
399 * - Re-enable OS/2 building after new parms were added
400 * - Fix false out of memory report when resolving CGI templates when no IP
401 * address is available of failed attempt (a la no such domain)
403 * Revision 1.42 2002/01/21 00:33:20 jongfoster
404 * Replacing strsav() with the safer string_append() or string_join().
405 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
406 * Adding missing html_encode() to error message generators.
407 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
409 * Revision 1.41 2002/01/17 20:56:22 jongfoster
410 * Replacing hard references to the URL of the config interface
411 * with #defines from project.h
413 * Revision 1.40 2002/01/09 14:26:46 oes
414 * Added support for thread-safe gmtime_r call.
416 * Revision 1.39 2001/11/16 00:48:13 jongfoster
417 * Fixing a compiler warning
419 * Revision 1.38 2001/11/13 00:31:21 jongfoster
420 * - Adding new CGIs for use by non-JavaScript browsers:
421 * edit-actions-url-form
422 * edit-actions-add-url-form
423 * edit-actions-remove-url-form
424 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
427 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
428 * Show enablement/disablement status in almost all templates.
429 * There is a little trickiness here: apparent recursive resolution of
430 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
431 * the actual enablement status. So a similar construct,
432 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
435 * Revision 1.36 2001/10/26 17:33:27 oes
438 * Revision 1.35 2001/10/23 21:48:19 jongfoster
439 * Cleaning up error handling in CGI functions - they now send back
440 * a HTML error page and should never cause a FATAL error. (Fixes one
441 * potential source of "denial of service" attacks).
443 * CGI actions file editor that works and is actually useful.
445 * Ability to toggle Junkbuster remotely using a CGI call.
447 * You can turn off both the above features in the main configuration
448 * file, e.g. if you are running a multi-user proxy.
450 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
451 * Only show "Local support" on templates conditionally:
452 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
453 * - if not, no Local support section appears
455 * Revision 1.33 2001/10/14 22:28:41 jongfoster
456 * Fixing stupid typo.
458 * Revision 1.32 2001/10/14 22:20:18 jongfoster
459 * - Changes to CGI dispatching method to match CGI names exactly,
460 * rather than doing a prefix match.
461 * - No longer need to count the length of the CGI handler names by hand.
462 * - Adding new handler for 404 error when disptching a CGI, if none of
463 * the handlers match.
464 * - Adding new handlers for CGI actionsfile editor.
466 * Revision 1.31 2001/10/10 10:56:39 oes
467 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
469 * Revision 1.30 2001/10/02 15:30:57 oes
470 * Introduced show-request cgi
472 * Revision 1.29 2001/09/20 15:47:44 steudten
474 * Fix BUG: Modify int size to size_t size in fill_template()
475 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
477 * Revision 1.28 2001/09/19 18:00:37 oes
478 * - Deletef time() FIXME (Can't fail under Linux either, if
479 * the argument is guaranteed to be in out address space,
482 * - Pointer notation cosmetics
483 * - Fixed a minor bug in template_fill(): Failiure of
484 * pcrs_execute() now secure.
486 * Revision 1.27 2001/09/16 17:08:54 jongfoster
487 * Moving simple CGI functions from cgi.c to new file cgisimple.c
489 * Revision 1.26 2001/09/16 15:47:37 jongfoster
490 * First version of CGI-based edit interface. This is very much a
491 * work-in-progress, and you can't actually use it to edit anything
492 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
493 * to have any effect.
495 * Revision 1.25 2001/09/16 15:02:35 jongfoster
496 * Adding i.j.b/robots.txt.
497 * Inlining add_stats() since it's only ever called from one place.
499 * Revision 1.24 2001/09/16 11:38:01 jongfoster
500 * Splitting fill_template() into 2 functions:
501 * template_load() loads the file
502 * template_fill() performs the PCRS regexps.
503 * This is because the CGI edit interface has a "table row"
504 * template which is used many times in the page - this
505 * change means it's only loaded from disk once.
507 * Revision 1.23 2001/09/16 11:16:05 jongfoster
508 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
510 * Revision 1.22 2001/09/16 11:00:10 jongfoster
511 * New function alloc_http_response, for symmetry with free_http_response
513 * Revision 1.21 2001/09/13 23:53:03 jongfoster
514 * Support for both static and dynamically generated CGI pages.
515 * Correctly setting Last-Modified: and Expires: HTTP headers.
517 * Revision 1.20 2001/09/13 23:40:36 jongfoster
518 * (Cosmetic only) Indentation correction
520 * Revision 1.19 2001/09/13 23:31:25 jongfoster
521 * Moving image data to cgi.c rather than cgi.h.
523 * Revision 1.18 2001/08/05 16:06:20 jongfoster
524 * Modifiying "struct map" so that there are now separate header and
525 * "map_entry" structures. This means that functions which modify a
526 * map no longer need to return a pointer to the modified map.
527 * Also, it no longer reverses the order of the entries (which may be
528 * important with some advanced template substitutions).
530 * Revision 1.17 2001/08/05 15:57:38 oes
531 * Adapted finish_http_response to new list_to_text
533 * Revision 1.16 2001/08/01 21:33:18 jongfoster
534 * Changes to fill_template() that reduce memory usage without having
535 * an impact on performance. I also renamed some variables so as not
536 * to clash with the C++ keywords "new" and "template".
538 * Revision 1.15 2001/08/01 21:19:22 jongfoster
539 * Moving file version information to a separate CGI page.
541 * Revision 1.14 2001/08/01 00:19:03 jongfoster
542 * New function: map_conditional() for an if-then-else syntax.
543 * Changing to use new version of show_defines()
545 * Revision 1.13 2001/07/30 22:08:36 jongfoster
546 * Tidying up #defines:
547 * - All feature #defines are now of the form FEATURE_xxx
548 * - Permanently turned off WIN_GUI_EDIT
549 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
551 * Revision 1.12 2001/07/29 18:47:05 jongfoster
552 * Adding missing #include "loadcfg.h"
554 * Revision 1.11 2001/07/18 17:24:37 oes
555 * Changed to conform to new pcrs interface
557 * Revision 1.10 2001/07/13 13:53:13 oes
558 * Removed all #ifdef PCRS and related code
560 * Revision 1.9 2001/06/29 21:45:41 oes
561 * Indentation, CRLF->LF, Tab-> Space
563 * Revision 1.8 2001/06/29 13:21:46 oes
564 * - Cosmetics: renamed and reordered functions, variables,
565 * texts, improved comments etc
567 * - Removed ij_untrusted_url() The relevant
568 * info is now part of the "untrusted" page,
569 * which is generated by filters.c:trust_url()
571 * - Generators of content now call finish_http_response()
572 * themselves, making jcc.c:chat() a little less
575 * - Removed obsolete "Pragma: no-cache" from our headers
577 * - http_responses now know their head length
579 * - fill_template now uses the new interface to pcrs, so that
580 * - long jobs (like whole files) no longer have to be assembled
581 * in a fixed size buffer
582 * - the new T (trivial) option is used, and the replacement may
583 * contain Perl syntax backrefs without confusing pcrs
585 * - Introduced default_exports() which generates a set of exports
586 * common to all CGIs and other content generators
588 * - Introduced convenience function map_block_killer()
590 * - Introduced convenience function make_menu()
592 * - Introduced CGI-like function error_response() which generates
593 * the "No such domain" and "Connect failed" messages using the
596 * - cgi_show_url_info:
597 * - adapted to new CGI features
598 * - form and answers now generated from same template
599 * - http:// prefix in URL now OK
602 * - adapted to new CGI features
603 * - no longer uses csp->init_proxy_args
606 * - moved menu generation to make_menu()
608 * - add_stats now writes single export map entries instead
611 * - Moved redirect_url() to filters.c
613 * - Fixed mem leak in free_http_response(), map_block_killer(),
615 * - Removed logentry from cancelled commit
617 * Revision 1.7 2001/06/09 10:51:58 jongfoster
618 * Changing "show URL info" handler to new style.
619 * Changing BUFSIZ ==> BUFFER_SIZE
621 * Revision 1.6 2001/06/07 23:05:19 jongfoster
622 * Removing code related to old forward and ACL files.
624 * Revision 1.5 2001/06/05 19:59:16 jongfoster
625 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
627 * Revision 1.4 2001/06/04 10:41:52 swa
628 * show version string of cgi.h and cgi.c
630 * Revision 1.3 2001/06/03 19:12:16 oes
631 * introduced new cgi handling
633 * No revisions before 1.3
635 **********************************************************************/
641 #include <sys/types.h>
655 #include "miscutil.h"
656 #include "cgisimple.h"
657 #include "jbsockets.h"
658 #if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE)
660 #endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */
662 /* loadcfg.h is for global_toggle_state only */
663 #ifdef FEATURE_PTHREAD
665 /* jcc.h is for mutex semaphore globals only */
666 #endif /* def FEATURE_PTHREAD */
667 const char cgi_h_rcs[] = CGI_H_VERSION;
670 * List of CGI functions: name, handler, description
671 * Note: Do NOT use single quotes in the description;
672 * this will break the dynamic "blocked" template!
674 static const struct cgi_dispatcher cgi_dispatchers[] = {
679 #ifdef FEATURE_GRACEFUL_TERMINATION
682 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
683 "this is a one click Denial Of Service attack!!!</em>",
688 #ifdef FEATURE_CGI_EDIT_ACTIONS
689 "View & change the current configuration",
691 "View the current configuration",
696 "View the source code version numbers",
700 "View the request headers",
704 "Look up which actions apply to a URL and why",
706 #ifdef FEATURE_TOGGLE
709 "Toggle Privoxy on or off",
711 #endif /* def FEATURE_TOGGLE */
712 #ifdef FEATURE_CGI_EDIT_ACTIONS
713 { "edit-actions", /* Edit the actions list */
716 { "eaa", /* Shortcut for edit-actions-add-url-form */
717 cgi_edit_actions_add_url_form,
719 { "eau", /* Shortcut for edit-actions-url-form */
720 cgi_edit_actions_url_form,
722 { "ear", /* Shortcut for edit-actions-remove-url-form */
723 cgi_edit_actions_remove_url_form,
725 { "eal", /* Shortcut for edit-actions-list */
726 cgi_edit_actions_list,
728 { "eafu", /* Shortcut for edit-actions-for-url */
729 cgi_edit_actions_for_url,
731 { "eas", /* Shortcut for edit-actions-submit */
732 cgi_edit_actions_submit,
734 { "easa", /* Shortcut for edit-actions-section-add */
735 cgi_edit_actions_section_add,
737 { "easr", /* Shortcut for edit-actions-section-remove */
738 cgi_edit_actions_section_remove,
740 { "eass", /* Shortcut for edit-actions-section-swap */
741 cgi_edit_actions_section_swap,
743 { "edit-actions-for-url",
744 cgi_edit_actions_for_url,
745 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
746 { "edit-actions-list",
747 cgi_edit_actions_list,
748 NULL, TRUE /* Edit the actions list */ },
749 { "edit-actions-submit",
750 cgi_edit_actions_submit,
751 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
752 { "edit-actions-url",
753 cgi_edit_actions_url,
754 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
755 { "edit-actions-url-form",
756 cgi_edit_actions_url_form,
757 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
758 { "edit-actions-add-url",
759 cgi_edit_actions_add_url,
760 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
761 { "edit-actions-add-url-form",
762 cgi_edit_actions_add_url_form,
763 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
764 { "edit-actions-remove-url",
765 cgi_edit_actions_remove_url,
766 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
767 { "edit-actions-remove-url-form",
768 cgi_edit_actions_remove_url_form,
769 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
770 { "edit-actions-section-add",
771 cgi_edit_actions_section_add,
772 NULL, FALSE /* Remove a section from the actionsfile */ },
773 { "edit-actions-section-remove",
774 cgi_edit_actions_section_remove,
775 NULL, FALSE /* Remove a section from the actionsfile */ },
776 { "edit-actions-section-swap",
777 cgi_edit_actions_section_swap,
778 NULL, FALSE /* Swap two sections in the actionsfile */ },
779 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
780 { "error-favicon.ico",
781 cgi_send_error_favicon,
782 NULL, TRUE /* Sends the favicon image for error pages. */ },
784 cgi_send_default_favicon,
785 NULL, TRUE /* Sends the default favicon image. */ },
788 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
791 NULL, TRUE /* Send a built-in image */ },
794 NULL, FALSE /* Send templates/cgi-style.css */ },
796 cgi_transparent_image,
797 NULL, TRUE /* Send a transparent image (short name) */ },
798 { "url-info-osd.xml",
799 cgi_send_url_info_osd,
800 NULL, TRUE /* Send templates/url-info-osd.xml */ },
802 cgi_send_user_manual,
803 NULL, TRUE /* Send user-manual */ },
804 { NULL, /* NULL Indicates end of list and default page */
806 NULL, TRUE /* Unknown CGI page */ }
811 * Built-in images for ad replacement
813 * Hint: You can encode your own images like this:
814 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
817 #ifdef FEATURE_NO_GIFS
820 * Checkerboard pattern, as a PNG.
822 const char image_pattern_data[] =
823 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
824 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
825 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
826 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
827 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
828 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
829 "\000\000\000\000\111\105\116\104\256\102\140\202";
832 * 1x1 transparant PNG.
834 const char image_blank_data[] =
835 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
836 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
837 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
838 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
839 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
840 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
841 "\000\000\000\000\111\105\116\104\256\102\140\202";
845 * Checkerboard pattern, as a GIF.
847 const char image_pattern_data[] =
848 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
849 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
850 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
851 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
855 * 1x1 transparant GIF.
857 const char image_blank_data[] =
858 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
859 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
860 "\000\001\000\000\002\002D\001\000;";
863 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
864 const size_t image_blank_length = sizeof(image_blank_data) - 1;
867 static struct http_response cgi_error_memory_response[1];
869 static struct http_response *dispatch_known_cgi(struct client_state * csp,
871 static struct map *parse_cgi_parameters(char *argstring);
874 /*********************************************************************
876 * Function : dispatch_cgi
878 * Description : Checks if a request URL has either the magical
879 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
880 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
881 * http://config.privoxy.org/). If so, it passes
882 * the (rest of the) path onto dispatch_known_cgi, which
883 * calls the relevant CGI handler function.
886 * 1 : csp = Current client state (buffers, headers, etc...)
888 * Returns : http_response if match, NULL if nonmatch or handler fail
890 *********************************************************************/
891 struct http_response *dispatch_cgi(struct client_state *csp)
893 const char *host = csp->http->host;
894 const char *path = csp->http->path;
897 * Should we intercept ?
900 /* Note: "example.com" and "example.com." are equivalent hostnames. */
902 /* Either the host matches CGI_SITE_1_HOST ..*/
903 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
904 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
905 && (path[0] == '/') )
907 /* ..then the path will all be for us. Remove leading '/' */
910 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
911 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
912 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
913 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
915 /* take everything following CGI_SITE_2_PATH */
916 path += strlen(CGI_SITE_2_PATH);
919 /* skip the forward slash after CGI_SITE_2_PATH */
922 else if (*path != '\0')
925 * weirdness: URL is /configXXX, where XXX is some string
926 * Do *NOT* intercept.
938 * This is a CGI call.
941 return dispatch_known_cgi(csp, path);
945 /*********************************************************************
947 * Function : grep_cgi_referrer
949 * Description : Ugly provisorical fix that greps the value of the
950 * referer HTTP header field out of a linked list of
951 * strings like found at csp->headers. Will disappear
954 * FIXME: csp->headers ought to be csp->http->headers
955 * FIXME: Parsing all client header lines should
956 * happen right after the request is received!
959 * 1 : csp = Current client state (buffers, headers, etc...)
961 * Returns : pointer to value (no copy!), or NULL if none found.
963 *********************************************************************/
964 static char *grep_cgi_referrer(const struct client_state *csp)
966 struct list_entry *p;
968 for (p = csp->headers->first; p != NULL; p = p->next)
970 if (p->str == NULL) continue;
971 if (strncmpic(p->str, "Referer: ", 9) == 0)
973 return ((p->str) + 9);
981 /*********************************************************************
983 * Function : referrer_is_safe
985 * Description : Decides whether we trust the Referer for
986 * CGI pages which are only meant to be reachable
987 * through Privoxy's web interface directly.
990 * 1 : csp = Current client state (buffers, headers, etc...)
992 * Returns : TRUE if the referrer is safe, or
993 * FALSE if the referrer is unsafe or not set.
995 *********************************************************************/
996 static int referrer_is_safe(const struct client_state *csp)
999 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
1001 referrer = grep_cgi_referrer(csp);
1003 if (NULL == referrer)
1005 /* No referrer, no access */
1006 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
1009 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
1010 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
1012 /* Trustworthy referrer */
1013 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
1014 csp->http->url, referrer);
1020 /* Untrustworthy referrer */
1021 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
1022 csp->http->url, referrer);
1029 /*********************************************************************
1031 * Function : dispatch_known_cgi
1033 * Description : Processes a CGI once dispatch_cgi has determined that
1034 * it matches one of the magic prefixes. Parses the path
1035 * as a cgi name plus query string, prepares a map that
1036 * maps CGI parameter names to their values, initializes
1037 * the http_response struct, and calls the relevant CGI
1041 * 1 : csp = Current client state (buffers, headers, etc...)
1042 * 2 : path = Path of CGI, with the CGI prefix removed.
1043 * Should not have a leading "/".
1045 * Returns : http_response, or NULL on handler failure or out of
1048 *********************************************************************/
1049 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1052 const struct cgi_dispatcher *d;
1053 struct map *param_list;
1054 struct http_response *rsp;
1055 char *query_args_start;
1059 if (NULL == (path_copy = strdup(path)))
1061 return cgi_error_memory();
1063 query_args_start = path_copy;
1064 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1068 if (*query_args_start == '/')
1070 *query_args_start++ = '\0';
1071 if ((param_list = new_map()))
1073 map(param_list, "file", 1, url_decode(query_args_start), 0);
1078 if (*query_args_start == '?')
1080 *query_args_start++ = '\0';
1082 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1085 return cgi_error_memory();
1091 * path_copy = CGI call name
1092 * param_list = CGI params, as map
1095 /* Get mem for response or fail*/
1096 if (NULL == (rsp = alloc_http_response()))
1099 free_map(param_list);
1100 return cgi_error_memory();
1104 * Find and start the right CGI function
1106 d = cgi_dispatchers;
1109 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1112 * If the called CGI is either harmless, or referred
1113 * from a trusted source, start it.
1115 if (d->harmless || referrer_is_safe(csp))
1117 err = (d->handler)(csp, rsp, param_list);
1122 * Else, modify toggle calls so that they only display
1123 * the status, and deny all other calls.
1125 if (0 == strcmp(path_copy, "toggle"))
1127 unmap(param_list, "set");
1128 err = (d->handler)(csp, rsp, param_list);
1132 err = cgi_error_disabled(csp, rsp);
1137 free_map(param_list);
1139 if (err == JB_ERR_CGI_PARAMS)
1141 err = cgi_error_bad_param(csp, rsp);
1143 if (err && (err != JB_ERR_MEMORY))
1145 /* Unexpected error! Shouldn't get here */
1146 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1147 err = cgi_error_unknown(csp, rsp, err);
1152 rsp->reason = RSP_REASON_CGI_CALL;
1153 return finish_http_response(csp, rsp);
1157 /* Error in handler, probably out-of-memory */
1158 free_http_response(rsp);
1159 return cgi_error_memory();
1167 /*********************************************************************
1169 * Function : parse_cgi_parameters
1171 * Description : Parse a URL-encoded argument string into name/value
1172 * pairs and store them in a struct map list.
1175 * 1 : argstring = string to be parsed. Will be trashed.
1177 * Returns : pointer to param list, or NULL if out of memory.
1179 *********************************************************************/
1180 static struct map *parse_cgi_parameters(char *argstring)
1183 char *vector[BUFFER_SIZE];
1185 struct map *cgi_params;
1187 if (NULL == (cgi_params = new_map()))
1193 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1194 * the fragment identifier along with the request, so we must
1195 * cut it off here, so it won't pollute the CGI params:
1197 if (NULL != (p = strchr(argstring, '#')))
1202 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1204 for (i = 0; i < pairs; i++)
1206 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1209 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1211 free_map(cgi_params);
1222 /*********************************************************************
1224 * Function : get_char_param
1226 * Description : Get a single-character parameter passed to a CGI
1230 * 1 : parameters = map of cgi parameters
1231 * 2 : param_name = The name of the parameter to read
1233 * Returns : Uppercase character on success, '\0' on error.
1235 *********************************************************************/
1236 char get_char_param(const struct map *parameters,
1237 const char *param_name)
1244 ch = *(lookup(parameters, param_name));
1245 if ((ch >= 'a') && (ch <= 'z'))
1247 ch = (char)(ch - 'a' + 'A');
1254 /*********************************************************************
1256 * Function : get_string_param
1258 * Description : Get a string paramater, to be used as an
1259 * ACTION_STRING or ACTION_MULTI paramater.
1260 * Validates the input to prevent stupid/malicious
1261 * users from corrupting their action file.
1264 * 1 : parameters = map of cgi parameters
1265 * 2 : param_name = The name of the parameter to read
1266 * 3 : pparam = destination for paramater. Allocated as
1267 * part of the map "parameters", so don't free it.
1268 * Set to NULL if not specified.
1270 * Returns : JB_ERR_OK on success, or if the paramater
1271 * was not specified.
1272 * JB_ERR_MEMORY on out-of-memory.
1273 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1275 *********************************************************************/
1276 jb_err get_string_param(const struct map *parameters,
1277 const char *param_name,
1278 const char **pparam)
1290 param = lookup(parameters, param_name);
1296 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1301 * Note that the length limit is arbitrary, it just seems
1302 * sensible to limit it to *something*. There's no
1303 * technical reason for any limit at all.
1305 return JB_ERR_CGI_PARAMS;
1308 /* Check every character to see if it's legal */
1310 while ((ch = *s++) != '\0')
1312 if ( ((unsigned char)ch < (unsigned char)' ')
1315 /* Probable hack attempt, or user accidentally used '}'. */
1316 return JB_ERR_CGI_PARAMS;
1327 /*********************************************************************
1329 * Function : get_number_param
1331 * Description : Get a non-negative integer from the parameters
1332 * passed to a CGI function.
1335 * 1 : csp = Current client state (buffers, headers, etc...)
1336 * 2 : parameters = map of cgi parameters
1337 * 3 : name = Name of CGI parameter to read
1338 * 4 : pvalue = destination for value.
1339 * Set to -1 on error.
1341 * Returns : JB_ERR_OK on success
1342 * JB_ERR_MEMORY on out-of-memory
1343 * JB_ERR_CGI_PARAMS if the parameter was not specified
1346 *********************************************************************/
1347 jb_err get_number_param(struct client_state *csp,
1348 const struct map *parameters,
1363 param = lookup(parameters, name);
1366 return JB_ERR_CGI_PARAMS;
1369 /* We don't use atoi because I want to check this carefully... */
1372 while ((ch = *param++) != '\0')
1374 if ((ch < '0') || (ch > '9'))
1376 return JB_ERR_CGI_PARAMS;
1379 ch = (char)(ch - '0');
1383 * <limits.h> defines UINT_MAX
1385 * (UINT_MAX - ch) / 10 is the largest number that
1386 * can be safely multiplied by 10 then have ch added.
1388 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1390 return JB_ERR_CGI_PARAMS;
1393 value = value * 10 + (unsigned)ch;
1404 /*********************************************************************
1406 * Function : error_response
1408 * Description : returns an http_response that explains the reason
1409 * why a request failed.
1412 * 1 : csp = Current client state (buffers, headers, etc...)
1413 * 2 : templatename = Which template should be used for the answer
1414 * 3 : sys_err = system error number
1416 * Returns : A http_response. If we run out of memory, this
1417 * will be cgi_error_memory().
1419 *********************************************************************/
1420 struct http_response *error_response(struct client_state *csp,
1421 const char *templatename,
1425 struct http_response *rsp;
1426 struct map *exports = default_exports(csp, NULL);
1429 if (exports == NULL)
1431 return cgi_error_memory();
1434 if (NULL == (rsp = alloc_http_response()))
1437 return cgi_error_memory();
1440 #ifdef FEATURE_FORCE_LOAD
1441 if (csp->flags & CSP_FLAG_FORCED)
1443 path = strdup(FORCE_PREFIX);
1446 #endif /* def FEATURE_FORCE_LOAD */
1450 err = string_append(&path, csp->http->path);
1452 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1453 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1454 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1455 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1456 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1459 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1462 /* Some failures, like "404 no such domain", don't have an IP address. */
1463 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1471 free_http_response(rsp);
1472 return cgi_error_memory();
1475 if (!strcmp(templatename, "no-such-domain"))
1477 rsp->status = strdup("404 No such domain");
1478 if (rsp->status == NULL)
1481 free_http_response(rsp);
1482 return cgi_error_memory();
1484 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1486 else if (!strcmp(templatename, "forwarding-failed"))
1488 const struct forward_spec *fwd = forward_url(csp, csp->http);
1489 char *socks_type = NULL;
1492 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1493 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1497 * XXX: While the template is called forwarding-failed,
1498 * it currently only handles socks forwarding failures.
1500 assert(fwd->type != SOCKS_NONE);
1503 * Map failure reason, forwarding type and forwarder.
1505 if (NULL == csp->error_message)
1508 * Either we forgot to record the failure reason,
1509 * or the memory allocation failed.
1511 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1512 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1514 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1517 * XXX: this is almost the same code as in cgi_show_url_info()
1518 * and thus should be factored out and shared.
1523 socks_type = "socks4-";
1526 socks_type = "socks4a-";
1529 socks_type = "socks5-";
1532 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1535 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1536 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1538 if (!err) rsp->status = strdup("503 Forwarding failure");
1539 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1542 free_http_response(rsp);
1543 return cgi_error_memory();
1545 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1547 else if (!strcmp(templatename, "connect-failed"))
1549 rsp->status = strdup("503 Connect failed");
1550 if (rsp->status == NULL)
1553 free_http_response(rsp);
1554 return cgi_error_memory();
1556 rsp->reason = RSP_REASON_CONNECT_FAILED;
1559 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1562 free_http_response(rsp);
1563 return cgi_error_memory();
1566 return finish_http_response(csp, rsp);
1570 /*********************************************************************
1572 * Function : cgi_error_disabled
1574 * Description : CGI function that is called to generate an error
1575 * response if the actions editor or toggle CGI are
1576 * accessed despite having being disabled at compile-
1577 * or run-time, or if the user followed an untrusted link
1578 * to access a unsafe CGI feature that is only reachable
1579 * through Privoxy directly.
1582 * 1 : csp = Current client state (buffers, headers, etc...)
1583 * 2 : rsp = http_response data structure for output
1585 * CGI Parameters : none
1587 * Returns : JB_ERR_OK on success
1588 * JB_ERR_MEMORY on out-of-memory error.
1590 *********************************************************************/
1591 jb_err cgi_error_disabled(const struct client_state *csp,
1592 struct http_response *rsp)
1594 struct map *exports;
1599 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1601 return JB_ERR_MEMORY;
1603 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1605 /* Not important enough to do anything */
1606 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1609 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1613 /*********************************************************************
1615 * Function : cgi_init_error_messages
1617 * Description : Call at the start of the program to initialize
1618 * the error message used by cgi_error_memory().
1624 *********************************************************************/
1625 void cgi_init_error_messages(void)
1627 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1628 cgi_error_memory_response->head =
1629 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1630 "Content-Type: text/html\r\n"
1632 cgi_error_memory_response->body =
1635 " <title>500 Internal Privoxy Error</title>\r\n"
1636 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1639 "<h1>500 Internal Privoxy Error</h1>\r\n"
1640 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1641 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1645 cgi_error_memory_response->head_length =
1646 strlen(cgi_error_memory_response->head);
1647 cgi_error_memory_response->content_length =
1648 strlen(cgi_error_memory_response->body);
1649 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1653 /*********************************************************************
1655 * Function : cgi_error_memory
1657 * Description : Called if a CGI function runs out of memory.
1658 * Returns a statically-allocated error response.
1662 * Returns : http_response data structure for output. This is
1663 * statically allocated, for obvious reasons.
1665 *********************************************************************/
1666 struct http_response *cgi_error_memory(void)
1668 /* assert that it's been initialized. */
1669 assert(cgi_error_memory_response->head);
1671 return cgi_error_memory_response;
1675 /*********************************************************************
1677 * Function : cgi_error_no_template
1679 * Description : Almost-CGI function that is called if a template
1680 * cannot be loaded. Note this is not a true CGI,
1681 * it takes a template name rather than a map of
1685 * 1 : csp = Current client state (buffers, headers, etc...)
1686 * 2 : rsp = http_response data structure for output
1687 * 3 : template_name = Name of template that could not
1690 * Returns : JB_ERR_OK on success
1691 * JB_ERR_MEMORY on out-of-memory error.
1693 *********************************************************************/
1694 jb_err cgi_error_no_template(const struct client_state *csp,
1695 struct http_response *rsp,
1696 const char *template_name)
1698 static const char status[] =
1699 "500 Internal Privoxy Error";
1700 static const char body_prefix[] =
1703 " <title>500 Internal Privoxy Error</title>\r\n"
1704 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1707 "<h1>500 Internal Privoxy Error</h1>\r\n"
1708 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1709 "<p><b>Could not load template file <code>";
1710 static const char body_suffix[] =
1711 "</code> or one of its included components.</b></p>\r\n"
1712 "<p>Please contact your proxy administrator.</p>\r\n"
1713 "<p>If you are the proxy administrator, please put the required file(s)"
1714 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1715 "location of the <code><i>(confdir)</i></code> directory "
1716 "is specified in the main Privoxy <code>config</code> "
1717 "file. (It's typically the Privoxy install directory"
1719 ", or <code>/etc/privoxy/</code>"
1720 #endif /* ndef _WIN32 */
1724 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1728 assert(template_name);
1730 /* Reset rsp, if needed */
1734 rsp->content_length = 0;
1735 rsp->head_length = 0;
1738 rsp->body = malloc(body_size);
1739 if (rsp->body == NULL)
1741 return JB_ERR_MEMORY;
1743 strlcpy(rsp->body, body_prefix, body_size);
1744 strlcat(rsp->body, template_name, body_size);
1745 strlcat(rsp->body, body_suffix, body_size);
1747 rsp->status = strdup(status);
1748 if (rsp->status == NULL)
1750 return JB_ERR_MEMORY;
1757 /*********************************************************************
1759 * Function : cgi_error_unknown
1761 * Description : Almost-CGI function that is called if an unexpected
1762 * error occurs in the top-level CGI dispatcher.
1763 * In this context, "unexpected" means "anything other
1764 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1765 * expected to handle all other errors internally,
1766 * since they can give more relavent error messages
1769 * Note this is not a true CGI, it takes an error
1770 * code rather than a map of parameters.
1773 * 1 : csp = Current client state (buffers, headers, etc...)
1774 * 2 : rsp = http_response data structure for output
1775 * 3 : error_to_report = Error code to report.
1777 * Returns : JB_ERR_OK on success
1778 * JB_ERR_MEMORY on out-of-memory error.
1780 *********************************************************************/
1781 jb_err cgi_error_unknown(const struct client_state *csp,
1782 struct http_response *rsp,
1783 jb_err error_to_report)
1785 static const char status[] =
1786 "500 Internal Privoxy Error";
1787 static const char body_prefix[] =
1790 " <title>500 Internal Privoxy Error</title>\r\n"
1791 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1794 "<h1>500 Internal Privoxy Error</h1>\r\n"
1795 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1796 "<p><b>Unexpected internal error: ";
1797 static const char body_suffix[] =
1800 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1801 "file a bug report</a>.</p>\r\n"
1806 * Due to sizeof(errnumbuf), body_size will be slightly
1807 * bigger than necessary but it doesn't really matter.
1809 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1813 /* Reset rsp, if needed */
1817 rsp->content_length = 0;
1818 rsp->head_length = 0;
1820 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1822 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1824 rsp->body = malloc(body_size);
1825 if (rsp->body == NULL)
1827 return JB_ERR_MEMORY;
1829 strlcpy(rsp->body, body_prefix, body_size);
1830 strlcat(rsp->body, errnumbuf, body_size);
1831 strlcat(rsp->body, body_suffix, body_size);
1833 rsp->status = strdup(status);
1834 if (rsp->status == NULL)
1836 return JB_ERR_MEMORY;
1843 /*********************************************************************
1845 * Function : cgi_error_bad_param
1847 * Description : CGI function that is called if the parameters
1848 * (query string) for a CGI were wrong.
1851 * 1 : csp = Current client state (buffers, headers, etc...)
1852 * 2 : rsp = http_response data structure for output
1854 * CGI Parameters : none
1856 * Returns : JB_ERR_OK on success
1857 * JB_ERR_MEMORY on out-of-memory error.
1859 *********************************************************************/
1860 jb_err cgi_error_bad_param(const struct client_state *csp,
1861 struct http_response *rsp)
1863 struct map *exports;
1868 if (NULL == (exports = default_exports(csp, NULL)))
1870 return JB_ERR_MEMORY;
1873 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1877 /*********************************************************************
1879 * Function : cgi_redirect
1881 * Description : CGI support function to generate a HTTP redirect
1885 * 1 : rsp = http_response data structure for output
1886 * 2 : target = string with the target URL
1888 * CGI Parameters : None
1890 * Returns : JB_ERR_OK on success
1891 * JB_ERR_MEMORY on out-of-memory error.
1893 *********************************************************************/
1894 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1901 err = enlist_unique_header(rsp->headers, "Location", target);
1903 rsp->status = strdup("302 Local Redirect from Privoxy");
1904 if (rsp->status == NULL)
1906 return JB_ERR_MEMORY;
1913 /*********************************************************************
1915 * Function : add_help_link
1917 * Description : Produce a copy of the string given as item,
1918 * embedded in an HTML link to its corresponding
1919 * section (item name in uppercase) in the actions
1920 * chapter of the user manual, (whose URL is given in
1921 * the config and defaults to our web site).
1923 * FIXME: I currently only work for actions, and would
1924 * like to be generalized for other topics.
1927 * 1 : item = item (will NOT be free()d.)
1928 * It is assumed to be HTML-safe.
1929 * 2 : config = The current configuration.
1931 * Returns : String with item embedded in link, or NULL on
1934 *********************************************************************/
1935 char *add_help_link(const char *item,
1936 struct configuration_spec *config)
1940 if (!item) return NULL;
1942 result = strdup("<a href=\"");
1943 if (!strncmpic(config->usermanual, "file://", 7) ||
1944 !strncmpic(config->usermanual, "http", 4))
1946 string_append(&result, config->usermanual);
1950 string_append(&result, "http://");
1951 string_append(&result, CGI_SITE_2_HOST);
1952 string_append(&result, "/user-manual/");
1954 string_append(&result, ACTIONS_HELP_PREFIX);
1955 string_join (&result, string_toupper(item));
1956 string_append(&result, "\">");
1957 string_append(&result, item);
1958 string_append(&result, "</a> ");
1964 /*********************************************************************
1966 * Function : get_http_time
1968 * Description : Get the time in a format suitable for use in a
1969 * HTTP header - e.g.:
1970 * "Sun, 06 Nov 1994 08:49:37 GMT"
1973 * 1 : time_offset = Time returned will be current time
1974 * plus this number of seconds.
1975 * 2 : buf = Destination for result.
1976 * 3 : buffer_size = Size of the buffer above. Must be big
1977 * enough to hold 29 characters plus a
1982 *********************************************************************/
1983 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1985 static const char day_names[7][4] =
1986 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1987 static const char month_names[12][4] =
1988 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1989 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1992 time_t current_time;
1993 #if defined(HAVE_GMTIME_R)
1998 assert(buffer_size > 29);
2000 time(¤t_time);
2002 current_time += time_offset;
2004 /* get and save the gmt */
2006 t = gmtime_r(¤t_time, &dummy);
2007 #elif FEATURE_PTHREAD
2008 privoxy_mutex_lock(&gmtime_mutex);
2009 t = gmtime(¤t_time);
2010 privoxy_mutex_unlock(&gmtime_mutex);
2012 t = gmtime(¤t_time);
2015 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
2016 snprintf(buf, buffer_size,
2017 "%s, %02d %s %4d %02d:%02d:%02d GMT",
2018 day_names[t->tm_wday],
2020 month_names[t->tm_mon],
2029 /*********************************************************************
2031 * Function : get_locale_time
2033 * Description : Get the time in a date(1)-like format
2034 * according to the current locale - e.g.:
2035 * "Fri Aug 29 19:37:12 CEST 2008"
2037 * XXX: Should we allow the user to change the format?
2040 * 1 : buf = Destination for result.
2041 * 2 : buffer_size = Size of the buffer above. Must be big
2042 * enough to hold 29 characters plus a
2047 *********************************************************************/
2048 static void get_locale_time(char *buf, size_t buffer_size)
2051 time_t current_time;
2052 #if defined(HAVE_LOCALTIME_R)
2057 assert(buffer_size > 29);
2059 time(¤t_time);
2061 #if HAVE_LOCALTIME_R
2062 timeptr = localtime_r(¤t_time, &dummy);
2063 #elif FEATURE_PTHREAD
2064 privoxy_mutex_lock(&localtime_mutex);
2065 timeptr = localtime(¤t_time);
2066 privoxy_mutex_unlock(&localtime_mutex);
2068 timeptr = localtime(¤t_time);
2071 strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
2075 /*********************************************************************
2077 * Function : finish_http_response
2079 * Description : Fill in the missing headers in an http response,
2080 * and flatten the headers to an http head.
2081 * For HEAD requests the body is freed once
2082 * the Content-Length header is set.
2085 * 1 : rsp = pointer to http_response to be processed
2087 * Returns : A http_response, usually the rsp parameter.
2088 * On error, free()s rsp and returns cgi_error_memory()
2090 *********************************************************************/
2091 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2093 char buf[BUFFER_SIZE];
2096 /* Special case - do NOT change this statically allocated response,
2097 * which is ready for output anyway.
2099 if (rsp == cgi_error_memory_response)
2105 * Fill in the HTTP Status, using HTTP/1.1
2106 * unless the client asked for HTTP/1.0.
2108 snprintf(buf, sizeof(buf), "%s %s",
2109 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2110 rsp->status ? rsp->status : "200 OK");
2111 err = enlist_first(rsp->headers, buf);
2114 * Set the Content-Length
2116 if (rsp->content_length == 0)
2118 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2122 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2123 err = enlist(rsp->headers, buf);
2126 if (0 == strcmpic(csp->http->gpc, "head"))
2129 * The client only asked for the head. Dispose
2130 * the body and log an offensive message.
2132 * While it may seem to be a bit inefficient to
2133 * prepare the body if it isn't needed, it's the
2134 * only way to get the Content-Length right for
2135 * dynamic pages. We could have disposed the body
2136 * earlier, but not without duplicating the
2137 * Content-Length setting code above.
2139 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2141 rsp->content_length = 0;
2144 if (strncmpic(rsp->status, "302", 3))
2147 * If it's not a redirect without any content,
2148 * set the Content-Type to text/html if it's
2149 * not already specified.
2151 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2155 * Fill in the rest of the default headers:
2157 * Date: set to current date/time.
2158 * Last-Modified: set to date/time the page was last changed.
2159 * Expires: set to date/time page next needs reloading.
2160 * Cache-Control: set to "no-cache" if applicable.
2162 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2167 * Set Expires to about 10 min into the future so it'll get reloaded
2168 * occasionally, e.g. if Privoxy gets upgraded.
2173 get_http_time(0, buf, sizeof(buf));
2174 err = enlist_unique_header(rsp->headers, "Date", buf);
2177 /* Some date in the past. */
2178 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2182 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
2183 err = enlist_unique_header(rsp->headers, "Expires", buf);
2186 else if (!strncmpic(rsp->status, "302", 3))
2188 get_http_time(0, buf, sizeof(buf));
2189 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2194 * Setting "Cache-Control" to "no-cache" and "Expires" to
2195 * the current time doesn't exactly forbid caching, it just
2196 * requires the client to revalidate the cached copy.
2198 * If a temporary problem occurs and the user tries again after
2199 * getting Privoxy's error message, a compliant browser may set the
2200 * If-Modified-Since header with the content of the error page's
2201 * Last-Modified header. More often than not, the document on the server
2202 * is older than Privoxy's error message, the server would send status code
2203 * 304 and the browser would display the outdated error message again and again.
2205 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2206 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2207 * and can be safely used to "revalidate" without getting a status code 304.
2209 * There is no need to let the useless If-Modified-Since header reach the
2210 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2212 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2214 get_http_time(0, buf, sizeof(buf));
2215 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2216 if (!strncmpic(rsp->status, "403", 3)
2217 || !strncmpic(rsp->status, "404", 3)
2218 || !strncmpic(rsp->status, "503", 3))
2220 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2224 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2226 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2227 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2233 * HTTP/1.1 applications that do not support persistent connections MUST
2234 * include the "close" connection option in every message.
2236 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2241 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2243 free_http_response(rsp);
2244 return cgi_error_memory();
2246 rsp->head_length = strlen(rsp->head);
2253 /*********************************************************************
2255 * Function : alloc_http_response
2257 * Description : Allocates a new http_response structure.
2261 * Returns : pointer to a new http_response, or NULL.
2263 *********************************************************************/
2264 struct http_response *alloc_http_response(void)
2266 return (struct http_response *) zalloc(sizeof(struct http_response));
2271 /*********************************************************************
2273 * Function : free_http_response
2275 * Description : Free the memory occupied by an http_response
2276 * and its depandant structures.
2279 * 1 : rsp = pointer to http_response to be freed
2283 *********************************************************************/
2284 void free_http_response(struct http_response *rsp)
2287 * Must special case cgi_error_memory_response, which is never freed.
2289 if (rsp && (rsp != cgi_error_memory_response))
2294 destroy_list(rsp->headers);
2301 /*********************************************************************
2303 * Function : template_load
2305 * Description : CGI support function that loads a given HTML
2306 * template, ignoring comment lines and following
2307 * #include statements up to a depth of 1.
2310 * 1 : csp = Current client state (buffers, headers, etc...)
2311 * 2 : template_ptr = Destination for pointer to loaded
2313 * 3 : templatename = name of the HTML template to be used
2314 * 4 : recursive = Flag set if this function calls itself
2315 * following an #include statament
2317 * Returns : JB_ERR_OK on success
2318 * JB_ERR_MEMORY on out-of-memory error.
2319 * JB_ERR_FILE if the template file cannot be read
2321 *********************************************************************/
2322 jb_err template_load(const struct client_state *csp, char **template_ptr,
2323 const char *templatename, int recursive)
2326 char *templates_dir_path;
2329 char *included_module;
2332 char buf[BUFFER_SIZE];
2335 assert(template_ptr);
2336 assert(templatename);
2338 *template_ptr = NULL;
2340 /* Validate template name. Paranoia. */
2341 for (p = templatename; *p != 0; p++)
2343 if ( ((*p < 'a') || (*p > 'z'))
2344 && ((*p < 'A') || (*p > 'Z'))
2345 && ((*p < '0') || (*p > '9'))
2349 /* Illegal character */
2355 * Generate full path using either templdir
2356 * or confdir/templates as base directory.
2358 if (NULL != csp->config->templdir)
2360 templates_dir_path = strdup(csp->config->templdir);
2364 templates_dir_path = make_path(csp->config->confdir, "templates");
2367 if (templates_dir_path == NULL)
2369 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2371 return JB_ERR_MEMORY;
2374 full_path = make_path(templates_dir_path, templatename);
2375 free(templates_dir_path);
2376 if (full_path == NULL)
2378 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2380 return JB_ERR_MEMORY;
2383 /* Allocate buffer */
2385 file_buffer = strdup("");
2386 if (file_buffer == NULL)
2388 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2390 return JB_ERR_MEMORY;
2393 /* Open template file */
2395 if (NULL == (fp = fopen(full_path, "r")))
2397 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2405 * Read the file, ignoring comments, and honoring #include
2406 * statements, unless we're already called recursively.
2408 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2409 * This is unlikely in practise.
2411 while (fgets(buf, BUFFER_SIZE, fp))
2413 if (!recursive && !strncmp(buf, "#include ", 9))
2415 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2422 if (string_join(&file_buffer, included_module))
2425 return JB_ERR_MEMORY;
2431 /* skip lines starting with '#' */
2437 if (string_append(&file_buffer, buf))
2440 return JB_ERR_MEMORY;
2445 *template_ptr = file_buffer;
2451 /*********************************************************************
2453 * Function : template_fill
2455 * Description : CGI support function that fills in a pre-loaded
2456 * HTML template by replacing @name@ with value using
2457 * pcrs, for each item in the output map.
2459 * Note that a leading '$' charachter in the export map's
2460 * values will be stripped and toggle on backreference
2464 * 1 : template_ptr = IN: Template to be filled out.
2466 * OUT: Filled out template.
2467 * Caller must free().
2468 * 2 : exports = map with fill in symbol -> name pairs
2470 * Returns : JB_ERR_OK on success (and for uncritical errors)
2471 * JB_ERR_MEMORY on out-of-memory error
2473 *********************************************************************/
2474 jb_err template_fill(char **template_ptr, const struct map *exports)
2476 struct map_entry *m;
2478 char buf[BUFFER_SIZE];
2479 char *tmp_out_buffer;
2485 assert(template_ptr);
2486 assert(*template_ptr);
2489 file_buffer = *template_ptr;
2490 size = strlen(file_buffer) + 1;
2493 * Assemble pcrs joblist from exports map
2495 for (m = exports->first; m != NULL; m = m->next)
2497 if (*m->name == '$')
2500 * First character of name is '$', so remove this flag
2501 * character and allow backreferences ($1 etc) in the
2502 * "replace with" text.
2504 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2510 * Treat the "replace with" text as a literal string -
2511 * no quoting needed, no backreferences allowed.
2512 * ("Trivial" ['T'] flag).
2516 /* Enclose name in @@ */
2517 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2521 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2523 /* Make and run job. */
2524 job = pcrs_compile(buf, m->value, flags, &error);
2527 if (error == PCRS_ERR_NOMEM)
2530 *template_ptr = NULL;
2531 return JB_ERR_MEMORY;
2535 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2536 /* Hope it wasn't important and silently ignore the invalid job */
2541 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2544 if (NULL == tmp_out_buffer)
2546 *template_ptr = NULL;
2547 return JB_ERR_MEMORY;
2553 * Substitution failed, keep the original buffer,
2554 * log the problem and ignore it.
2556 * The user might see some unresolved @CGI_VARIABLES@,
2557 * but returning a special CGI error page seems unreasonable
2558 * and could mask more important error messages.
2560 free(tmp_out_buffer);
2561 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2562 buf, m->value, flags, pcrs_strerror(error));
2566 /* Substitution succeeded, use modified buffer. */
2568 file_buffer = tmp_out_buffer;
2576 *template_ptr = file_buffer;
2581 /*********************************************************************
2583 * Function : template_fill_for_cgi
2585 * Description : CGI support function that loads a HTML template
2586 * and fills it in. Handles file-not-found errors
2587 * by sending a HTML error message. For convenience,
2588 * this function also frees the passed "exports" map.
2591 * 1 : csp = Client state
2592 * 2 : templatename = name of the HTML template to be used
2593 * 3 : exports = map with fill in symbol -> name pairs.
2594 * Will be freed by this function.
2595 * 4 : rsp = Response structure to fill in.
2597 * Returns : JB_ERR_OK on success
2598 * JB_ERR_MEMORY on out-of-memory error
2600 *********************************************************************/
2601 jb_err template_fill_for_cgi(const struct client_state *csp,
2602 const char *templatename,
2603 struct map *exports,
2604 struct http_response *rsp)
2609 assert(templatename);
2613 err = template_load(csp, &rsp->body, templatename, 0);
2614 if (err == JB_ERR_FILE)
2617 return cgi_error_no_template(csp, rsp, templatename);
2622 return err; /* JB_ERR_MEMORY */
2624 err = template_fill(&rsp->body, exports);
2630 /*********************************************************************
2632 * Function : default_exports
2634 * Description : returns a struct map list that contains exports
2635 * which are common to all CGI functions.
2638 * 1 : csp = Current client state (buffers, headers, etc...)
2639 * 2 : caller = name of CGI who calls us and which should
2640 * be excluded from the generated menu. May be
2642 * Returns : NULL if no memory, else a new map. Caller frees.
2644 *********************************************************************/
2645 struct map *default_exports(const struct client_state *csp, const char *caller)
2649 struct map * exports;
2650 int local_help_exists = 0;
2651 char *ip_address = NULL;
2652 char *hostname = NULL;
2656 exports = new_map();
2657 if (exports == NULL)
2662 if (csp->config->hostname)
2664 get_host_information(csp->cfd, &ip_address, NULL);
2665 hostname = strdup(csp->config->hostname);
2669 get_host_information(csp->cfd, &ip_address, &hostname);
2672 err = map(exports, "version", 1, html_encode(VERSION), 0);
2673 get_locale_time(buf, sizeof(buf));
2674 if (!err) err = map(exports, "time", 1, html_encode(buf), 0);
2675 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2677 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2679 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2680 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2681 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2682 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2683 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2684 !strncmpic(csp->config->usermanual, "http", 4))
2686 /* Manual is located somewhere else, just link to it. */
2687 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2691 /* Manual is delivered by Privoxy. */
2692 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2694 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2695 #ifdef FEATURE_TOGGLE
2696 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2698 if (!err) err = map_block_killer(exports, "can-toggle");
2701 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2702 if (!err) err = map(exports, "my-port", 1, buf, 1);
2704 if(!strcmp(CODE_STATUS, "stable"))
2706 if (!err) err = map_block_killer(exports, "unstable");
2709 if (csp->config->admin_address != NULL)
2711 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2712 local_help_exists = 1;
2716 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2719 if (csp->config->proxy_info_url != NULL)
2721 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2722 local_help_exists = 1;
2726 if (!err) err = map_block_killer(exports, "have-proxy-info");
2729 if (local_help_exists == 0)
2731 if (!err) err = map_block_killer(exports, "have-help-info");
2744 /*********************************************************************
2746 * Function : map_block_killer
2748 * Description : Convenience function.
2749 * Adds a "killer" for the conditional HTML-template
2750 * block <name>, i.e. a substitution of the regex
2751 * "if-<name>-start.*if-<name>-end" to the given
2755 * 1 : exports = map to extend
2756 * 2 : name = name of conditional block
2758 * Returns : JB_ERR_OK on success
2759 * JB_ERR_MEMORY on out-of-memory error.
2761 *********************************************************************/
2762 jb_err map_block_killer(struct map *exports, const char *name)
2764 char buf[1000]; /* Will do, since the names are hardwired */
2768 assert(strlen(name) < 490);
2770 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2771 return map(exports, buf, 1, "", 1);
2775 /*********************************************************************
2777 * Function : map_block_keep
2779 * Description : Convenience function. Removes the markers used
2780 * by map-block-killer, to save a few bytes.
2781 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2784 * 1 : exports = map to extend
2785 * 2 : name = name of conditional block
2787 * Returns : JB_ERR_OK on success
2788 * JB_ERR_MEMORY on out-of-memory error.
2790 *********************************************************************/
2791 jb_err map_block_keep(struct map *exports, const char *name)
2794 char buf[500]; /* Will do, since the names are hardwired */
2798 assert(strlen(name) < 490);
2800 snprintf(buf, sizeof(buf), "if-%s-start", name);
2801 err = map(exports, buf, 1, "", 1);
2808 snprintf(buf, sizeof(buf), "if-%s-end", name);
2809 return map(exports, buf, 1, "", 1);
2813 /*********************************************************************
2815 * Function : map_conditional
2817 * Description : Convenience function.
2818 * Adds an "if-then-else" for the conditional HTML-template
2819 * block <name>, i.e. a substitution of the form:
2826 * The control structure and one of the alternatives
2830 * 1 : exports = map to extend
2831 * 2 : name = name of conditional block
2832 * 3 : choose_first = nonzero for first, zero for second.
2834 * Returns : JB_ERR_OK on success
2835 * JB_ERR_MEMORY on out-of-memory error.
2837 *********************************************************************/
2838 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2840 char buf[1000]; /* Will do, since the names are hardwired */
2845 assert(strlen(name) < 480);
2847 snprintf(buf, sizeof(buf), (choose_first
2848 ? "else-not-%s@.*@endif-%s"
2849 : "if-%s-then@.*@else-not-%s"),
2852 err = map(exports, buf, 1, "", 1);
2858 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2859 return map(exports, buf, 1, "", 1);
2863 /*********************************************************************
2865 * Function : make_menu
2867 * Description : Returns an HTML-formatted menu of the available
2868 * unhidden CGIs, excluding the one given in <self>
2869 * and the toggle CGI if toggling is disabled.
2872 * 1 : self = name of CGI to leave out, can be NULL for
2874 * 2 : feature_flags = feature bitmap from csp->config
2877 * Returns : menu string, or NULL on out-of-memory error.
2879 *********************************************************************/
2880 char *make_menu(const char *self, const unsigned feature_flags)
2882 const struct cgi_dispatcher *d;
2883 char *result = strdup("");
2887 self = "NO-SUCH-CGI!";
2890 /* List available unhidden CGI's and export as "other-cgis" */
2891 for (d = cgi_dispatchers; d->name; d++)
2894 #ifdef FEATURE_TOGGLE
2895 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2898 * Suppress the toggle link if remote toggling is disabled.
2902 #endif /* def FEATURE_TOGGLE */
2904 if (d->description && strcmp(d->name, self))
2906 char *html_encoded_prefix;
2909 * Line breaks would be great, but break
2910 * the "blocked" template's JavaScript.
2912 string_append(&result, "<li><a href=\"");
2913 html_encoded_prefix = html_encode(CGI_PREFIX);
2914 if (html_encoded_prefix == NULL)
2920 string_append(&result, html_encoded_prefix);
2921 free(html_encoded_prefix);
2923 string_append(&result, d->name);
2924 string_append(&result, "\">");
2925 string_append(&result, d->description);
2926 string_append(&result, "</a></li>");
2934 /*********************************************************************
2936 * Function : dump_map
2938 * Description : HTML-dump a map for debugging (as table)
2941 * 1 : the_map = map to dump
2943 * Returns : string with HTML
2945 *********************************************************************/
2946 char *dump_map(const struct map *the_map)
2948 struct map_entry *cur_entry;
2949 char *ret = strdup("");
2951 string_append(&ret, "<table>\n");
2953 for (cur_entry = the_map->first;
2954 (cur_entry != NULL) && (ret != NULL);
2955 cur_entry = cur_entry->next)
2957 string_append(&ret, "<tr><td><b>");
2958 string_join (&ret, html_encode(cur_entry->name));
2959 string_append(&ret, "</b></td><td>");
2960 string_join (&ret, html_encode(cur_entry->value));
2961 string_append(&ret, "</td></tr>\n");
2964 string_append(&ret, "</table>\n");