1 const char cgi_rcs[] = "$Id: cgi.c,v 1.111 2008/08/31 15:59:02 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.111 2008/08/31 15:59:02 fabiankeil
42 * There's no reason to let remote toggling support depend
43 * on FEATURE_CGI_EDIT_ACTIONS, so make sure it doesn't.
45 * Revision 1.110 2008/08/31 14:55:43 fabiankeil
46 * Add a @date@ symbol to include a date(1)-like time string
47 * in templates. Modified version of the patch Endre Szabo
48 * submitted in #2026468.
50 * Revision 1.109 2008/07/26 09:40:27 fabiankeil
51 * Remove the unconditional block in get_http_time().
52 * It's pointless now that it's no longer used to limit
53 * dummy's scope. While at it, remove obvious comments
54 * and a trailing space.
56 * Revision 1.108 2008/05/26 17:30:53 fabiankeil
57 * Provide an OpenSearch Description to access the
58 * show-url-info page through "search engine plugins".
60 * Revision 1.107 2008/05/26 16:23:19 fabiankeil
61 * - Fix spelling in template-not-found message.
62 * - Declare referrer_is_safe()'s alternative_prefix[] static.
64 * Revision 1.106 2008/05/21 15:24:38 fabiankeil
65 * Mark csp as immutable for a bunch of functions.
67 * Revision 1.105 2008/04/17 14:40:47 fabiankeil
68 * Provide get_http_time() with the buffer size so it doesn't
69 * have to blindly assume that the buffer is big enough.
71 * Revision 1.104 2008/03/26 18:07:06 fabiankeil
72 * Add hostname directive. Closes PR#1918189.
74 * Revision 1.103 2008/03/21 11:13:57 fabiankeil
75 * Only gather host information if it's actually needed.
76 * Also move the code out of accept_connection() so it's less likely
77 * to delay other incoming connections if the host is misconfigured.
79 * Revision 1.102 2008/02/23 16:33:43 fabiankeil
80 * Let forward_url() use the standard parameter ordering
81 * and mark its second parameter immutable.
83 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
84 * Add SOCKS5 support for "Forwarding failure" CGI page.
86 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
87 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
90 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
91 * #1763173 from Stefan Huehner: declare some more functions static.
93 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
94 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
96 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
97 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
99 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
100 * Use sizeof() more often.
102 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
103 * Don't overlook map result for the forwarding-type.
105 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
106 * Use a transparent background for the PNG replacement pattern.
108 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
109 * - Save the reason for generating http_responses.
110 * - Fix --disable-toggle (again).
111 * - Use TBL birthday hack for 403 responses as well.
112 * - Uglify the @menu@ again to fix JavaScript
113 * errors on the "blocked" template.
114 * - Escape an ampersand in cgi_error_unknown().
116 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
117 * - Add HEAD support to finish_http_response.
118 * - Add error favicon to internal HTML error messages.
120 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
121 * Add new config option "templdir" to
122 * change the templates directory.
124 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
125 * Added "forwarding-failed" template support for error_response().
127 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
128 * Add favicon delivery functions.
130 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
131 * - Map variables that aren't guaranteed to be
132 * pure ASCII html_encoded.
133 * - Use CGI_PREFIX to generate URL for user manual
134 * CGI page to make sure CGI_SITE_2_PATH is included.
136 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
137 * - "Protect" against a rather lame JavaScript-based
138 * Privoxy detection "attack" and check the referrer
139 * before delivering the CGI style sheet.
140 * - Move referrer check for unsafe CGI pages into
141 * referrer_is_safe() and log the result.
142 * - Map @url@ in cgi-error-disabled page.
143 * It's required for the "go there anyway" link.
144 * - Mark *csp as immutable for grep_cgi_referrer().
146 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
147 * Fix strdup() error handling in cgi_error_unknown()
148 * and cgi_error_no_template(). Reported by Markus Elfring.
150 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
151 * Handle pcrs_execute() errors in template_fill() properly.
153 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
154 * Fixed gcc43 conversion warnings and replaced sprintf
155 * calls with snprintf to give OpenBSD's gcc one less reason
158 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
159 * Escape ampersand in Privoxy menu.
161 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
162 * Suppress the toggle link if remote toggling is disabled.
164 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
165 * Fix configure option --disable-toggle.
166 * Thanks to Peter Thoenen for reporting this.
168 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
169 * Don't lose the FORCE_PREFIX in case of
170 * connection problems. Fixes #612235.
172 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
173 * Make pthread mutex locking more generic. Instead of
174 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
175 * and use mutex locking unless there is an _r function
176 * available. Better safe than sorry.
178 * Fixes "./configure --disable-pthread" and should result
179 * in less threading-related problems on pthread-using platforms,
180 * but it still doesn't fix BR#1122404.
182 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
183 * Use CGI_PREFIX to check the referrer.
184 * The check for "http://config.privoxy.org/" fails
185 * if the user modified CGI_SITE_2_HOST.
187 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
188 * Adjusted headers for Privoxy's cgi responses:
189 * Don't set Last-Modified, Expires and Cache-Control
190 * headers for redirects; always set "Connection: close".
192 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
193 * Only predate the Last-Modified header for cgi responses
194 * that are delivered with status code 404 or 503.
196 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
197 * Mark cgi_send_user_manual as harmless,
198 * to fix the access denied problem Hal spotted.
199 * The manual has no secret content, therefore we
200 * don't have to care about "secure" referrers.
202 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
203 * Incorporate modified version of Roland Rosenfeld's patch to
204 * optionally access the user-manual via Privoxy. Closes patch 679075.
206 * Formatting changed to Privoxy style, added call to
207 * cgi_error_no_template if the requested file doesn't
208 * exist and modified check whether or not Privoxy itself
209 * should serve the manual. Should work cross-platform now.
211 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
212 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
214 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
215 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
216 * with what was really the latest development (the v_3_0_branch branch)
218 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
219 * Moved cgi_error_disabled() from cgiedit.c to
220 * cgi.c to re-enable build with --disable-editor.
221 * Fixes Bug #892744. Thanks to Matthew Fischer
224 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
225 * - Added new function cgi_redirect to handle creation of
226 * HTTP redirect messages formerly repeated in the code.
227 * - Send cgi_error_disabled instead of cgi_error_404 when
228 * referrer check fails
229 * - Dynamic content now gets Expires header field with date
232 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
233 * Bugfix: Transparent PNG was not transparent. Thanks to
234 * Dan Razzell of Starfish Systems for notice and new PNG.
236 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
237 * Security fix: dspatch_known_cgi no longer considers an empty
238 * referrer safe for critical CGIs, since malicious links could
239 * reside on https:// locations which browsers don't advertize as
240 * referrers. Closes bug #749916, thanks to Jeff Epler for the
241 * hint. Goodbye One-Click[tm] toggling :-(
243 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
246 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
247 * Killed a compiler warning on OSX
249 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
250 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
251 * (fixes bug #710056)
252 * - Show toggle info only if we have it
254 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
255 * Move declaration of struct tm dummy outside of a control block so it is
256 * accessible later on during snprintf in get_http_time.
258 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
259 * Cosmetic: Renamed cryptic variable
261 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
262 * 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.
264 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
265 * Disable access to critical CGIs via untrusted referrers.
266 * This prevents users from being tricked by malicious websites
267 * into making unintentional configuration changes:
269 * - Added flag to each cgi_dispatcher that allows or denies
271 * - Introduced proviorical function that greps for the
272 * referrer header before regular header parsing happens
273 * - Added safety check to dispatch_known_cgi. CGI is called
274 * if (cgi harmless || no referrer || we are referrer).
275 * Else a) toggle calls are modified not to change status and
276 * b) all other calls are denied.
278 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
279 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
281 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
282 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
284 * Revision 1.70 2002/05/19 11:33:20 jongfoster
285 * If a CGI error was not handled, and propogated back to
286 * dispatch_known_cgi(), then it was assumed to be "out of memory".
287 * This gave a very misleading error message.
289 * Now other errors will cause a simple message giving the error
290 * number and asking the user to report a bug.
293 * http://sourceforge.net/tracker/index.php?func=detail
294 * &aid=557905&group_id=11118&atid=111118
296 * Revision 1.69 2002/05/14 21:28:40 oes
297 * - Fixed add_help_link to link to the (now split) actions
298 * part of the config chapter
299 * - Renamed helplink export to actions-help-prefix
301 * Revision 1.68 2002/05/12 21:36:29 jongfoster
302 * Correcting function comments
304 * Revision 1.67 2002/04/30 12:02:07 oes
305 * Nit: updated a comment
307 * Revision 1.66 2002/04/26 18:32:57 jongfoster
308 * Fixing a memory leak on error
310 * Revision 1.65 2002/04/26 12:53:51 oes
311 * - New function add_help_link
312 * - default_exports now exports links to the user manual
313 * and a prefix for links into the config chapter
315 * Revision 1.64 2002/04/24 02:17:21 oes
316 * - Better descriptions for CGIs
317 * - Hide edit-actions, more shortcuts
318 * - Moved get_char_param, get_string_param and get_number_param here
321 * Revision 1.63 2002/04/15 19:06:43 jongfoster
324 * Revision 1.62 2002/04/10 19:59:46 jongfoster
325 * Fixes to #include in templates:
326 * - Didn't close main file if loading an included template fails.
327 * - I'm paranoid and want to disallow "#include /etc/passwd".
329 * Revision 1.61 2002/04/10 13:37:48 oes
330 * Made templates modular: template_load now recursive with max depth 1
332 * Revision 1.60 2002/04/08 20:50:25 swa
335 * Revision 1.59 2002/04/05 15:51:51 oes
336 * - added send-stylesheet CGI
337 * - bugfix: error-pages now get correct request protocol
339 * - kludged CGI descriptions and menu not to break JS syntax
341 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
342 * Fix Mac OSX compiler warnings
344 * Revision 1.57 2002/03/26 22:29:54 swa
345 * we have a new homepage!
347 * Revision 1.56 2002/03/24 17:50:46 jongfoster
348 * Fixing compile error if actions file editor disabled
350 * Revision 1.55 2002/03/24 16:55:06 oes
351 * Making GIF checkerboard transparent
353 * Revision 1.54 2002/03/24 16:18:15 jongfoster
356 * Revision 1.53 2002/03/24 16:06:00 oes
357 * Correct transparency for checkerboard PNG. Thanks, Magnus!
359 * Revision 1.52 2002/03/24 15:23:33 jongfoster
362 * Revision 1.51 2002/03/24 13:25:43 swa
363 * name change related issues
365 * Revision 1.50 2002/03/16 23:54:06 jongfoster
366 * Adding graceful termination feature, to help look for memory leaks.
367 * If you enable this (which, by design, has to be done by hand
368 * editing config.h) and then go to http://i.j.b/die, then the program
369 * will exit cleanly after the *next* request. It should free all the
370 * memory that was used.
372 * Revision 1.49 2002/03/13 00:27:04 jongfoster
375 * Revision 1.48 2002/03/08 17:47:07 jongfoster
378 * Revision 1.47 2002/03/08 16:41:33 oes
379 * Added GIF images again
381 * Revision 1.46 2002/03/07 03:48:38 oes
382 * - Changed built-in images from GIF to PNG
383 * (with regard to Unisys patent issue)
384 * - Added a 4x4 pattern PNG which is less intrusive
385 * than the logo but also clearly marks the deleted banners
387 * Revision 1.45 2002/03/06 22:54:35 jongfoster
388 * Automated function-comment nitpicking.
390 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
391 * - Better error reporting on OS/2
392 * - Fix double-slash comment (oops)
394 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
395 * - Re-enable OS/2 building after new parms were added
396 * - Fix false out of memory report when resolving CGI templates when no IP
397 * address is available of failed attempt (a la no such domain)
399 * Revision 1.42 2002/01/21 00:33:20 jongfoster
400 * Replacing strsav() with the safer string_append() or string_join().
401 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
402 * Adding missing html_encode() to error message generators.
403 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
405 * Revision 1.41 2002/01/17 20:56:22 jongfoster
406 * Replacing hard references to the URL of the config interface
407 * with #defines from project.h
409 * Revision 1.40 2002/01/09 14:26:46 oes
410 * Added support for thread-safe gmtime_r call.
412 * Revision 1.39 2001/11/16 00:48:13 jongfoster
413 * Fixing a compiler warning
415 * Revision 1.38 2001/11/13 00:31:21 jongfoster
416 * - Adding new CGIs for use by non-JavaScript browsers:
417 * edit-actions-url-form
418 * edit-actions-add-url-form
419 * edit-actions-remove-url-form
420 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
423 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
424 * Show enablement/disablement status in almost all templates.
425 * There is a little trickiness here: apparent recursive resolution of
426 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
427 * the actual enablement status. So a similar construct,
428 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
431 * Revision 1.36 2001/10/26 17:33:27 oes
434 * Revision 1.35 2001/10/23 21:48:19 jongfoster
435 * Cleaning up error handling in CGI functions - they now send back
436 * a HTML error page and should never cause a FATAL error. (Fixes one
437 * potential source of "denial of service" attacks).
439 * CGI actions file editor that works and is actually useful.
441 * Ability to toggle Junkbuster remotely using a CGI call.
443 * You can turn off both the above features in the main configuration
444 * file, e.g. if you are running a multi-user proxy.
446 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
447 * Only show "Local support" on templates conditionally:
448 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
449 * - if not, no Local support section appears
451 * Revision 1.33 2001/10/14 22:28:41 jongfoster
452 * Fixing stupid typo.
454 * Revision 1.32 2001/10/14 22:20:18 jongfoster
455 * - Changes to CGI dispatching method to match CGI names exactly,
456 * rather than doing a prefix match.
457 * - No longer need to count the length of the CGI handler names by hand.
458 * - Adding new handler for 404 error when disptching a CGI, if none of
459 * the handlers match.
460 * - Adding new handlers for CGI actionsfile editor.
462 * Revision 1.31 2001/10/10 10:56:39 oes
463 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
465 * Revision 1.30 2001/10/02 15:30:57 oes
466 * Introduced show-request cgi
468 * Revision 1.29 2001/09/20 15:47:44 steudten
470 * Fix BUG: Modify int size to size_t size in fill_template()
471 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
473 * Revision 1.28 2001/09/19 18:00:37 oes
474 * - Deletef time() FIXME (Can't fail under Linux either, if
475 * the argument is guaranteed to be in out address space,
478 * - Pointer notation cosmetics
479 * - Fixed a minor bug in template_fill(): Failiure of
480 * pcrs_execute() now secure.
482 * Revision 1.27 2001/09/16 17:08:54 jongfoster
483 * Moving simple CGI functions from cgi.c to new file cgisimple.c
485 * Revision 1.26 2001/09/16 15:47:37 jongfoster
486 * First version of CGI-based edit interface. This is very much a
487 * work-in-progress, and you can't actually use it to edit anything
488 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
489 * to have any effect.
491 * Revision 1.25 2001/09/16 15:02:35 jongfoster
492 * Adding i.j.b/robots.txt.
493 * Inlining add_stats() since it's only ever called from one place.
495 * Revision 1.24 2001/09/16 11:38:01 jongfoster
496 * Splitting fill_template() into 2 functions:
497 * template_load() loads the file
498 * template_fill() performs the PCRS regexps.
499 * This is because the CGI edit interface has a "table row"
500 * template which is used many times in the page - this
501 * change means it's only loaded from disk once.
503 * Revision 1.23 2001/09/16 11:16:05 jongfoster
504 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
506 * Revision 1.22 2001/09/16 11:00:10 jongfoster
507 * New function alloc_http_response, for symmetry with free_http_response
509 * Revision 1.21 2001/09/13 23:53:03 jongfoster
510 * Support for both static and dynamically generated CGI pages.
511 * Correctly setting Last-Modified: and Expires: HTTP headers.
513 * Revision 1.20 2001/09/13 23:40:36 jongfoster
514 * (Cosmetic only) Indentation correction
516 * Revision 1.19 2001/09/13 23:31:25 jongfoster
517 * Moving image data to cgi.c rather than cgi.h.
519 * Revision 1.18 2001/08/05 16:06:20 jongfoster
520 * Modifiying "struct map" so that there are now separate header and
521 * "map_entry" structures. This means that functions which modify a
522 * map no longer need to return a pointer to the modified map.
523 * Also, it no longer reverses the order of the entries (which may be
524 * important with some advanced template substitutions).
526 * Revision 1.17 2001/08/05 15:57:38 oes
527 * Adapted finish_http_response to new list_to_text
529 * Revision 1.16 2001/08/01 21:33:18 jongfoster
530 * Changes to fill_template() that reduce memory usage without having
531 * an impact on performance. I also renamed some variables so as not
532 * to clash with the C++ keywords "new" and "template".
534 * Revision 1.15 2001/08/01 21:19:22 jongfoster
535 * Moving file version information to a separate CGI page.
537 * Revision 1.14 2001/08/01 00:19:03 jongfoster
538 * New function: map_conditional() for an if-then-else syntax.
539 * Changing to use new version of show_defines()
541 * Revision 1.13 2001/07/30 22:08:36 jongfoster
542 * Tidying up #defines:
543 * - All feature #defines are now of the form FEATURE_xxx
544 * - Permanently turned off WIN_GUI_EDIT
545 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
547 * Revision 1.12 2001/07/29 18:47:05 jongfoster
548 * Adding missing #include "loadcfg.h"
550 * Revision 1.11 2001/07/18 17:24:37 oes
551 * Changed to conform to new pcrs interface
553 * Revision 1.10 2001/07/13 13:53:13 oes
554 * Removed all #ifdef PCRS and related code
556 * Revision 1.9 2001/06/29 21:45:41 oes
557 * Indentation, CRLF->LF, Tab-> Space
559 * Revision 1.8 2001/06/29 13:21:46 oes
560 * - Cosmetics: renamed and reordered functions, variables,
561 * texts, improved comments etc
563 * - Removed ij_untrusted_url() The relevant
564 * info is now part of the "untrusted" page,
565 * which is generated by filters.c:trust_url()
567 * - Generators of content now call finish_http_response()
568 * themselves, making jcc.c:chat() a little less
571 * - Removed obsolete "Pragma: no-cache" from our headers
573 * - http_responses now know their head length
575 * - fill_template now uses the new interface to pcrs, so that
576 * - long jobs (like whole files) no longer have to be assembled
577 * in a fixed size buffer
578 * - the new T (trivial) option is used, and the replacement may
579 * contain Perl syntax backrefs without confusing pcrs
581 * - Introduced default_exports() which generates a set of exports
582 * common to all CGIs and other content generators
584 * - Introduced convenience function map_block_killer()
586 * - Introduced convenience function make_menu()
588 * - Introduced CGI-like function error_response() which generates
589 * the "No such domain" and "Connect failed" messages using the
592 * - cgi_show_url_info:
593 * - adapted to new CGI features
594 * - form and answers now generated from same template
595 * - http:// prefix in URL now OK
598 * - adapted to new CGI features
599 * - no longer uses csp->init_proxy_args
602 * - moved menu generation to make_menu()
604 * - add_stats now writes single export map entries instead
607 * - Moved redirect_url() to filters.c
609 * - Fixed mem leak in free_http_response(), map_block_killer(),
611 * - Removed logentry from cancelled commit
613 * Revision 1.7 2001/06/09 10:51:58 jongfoster
614 * Changing "show URL info" handler to new style.
615 * Changing BUFSIZ ==> BUFFER_SIZE
617 * Revision 1.6 2001/06/07 23:05:19 jongfoster
618 * Removing code related to old forward and ACL files.
620 * Revision 1.5 2001/06/05 19:59:16 jongfoster
621 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
623 * Revision 1.4 2001/06/04 10:41:52 swa
624 * show version string of cgi.h and cgi.c
626 * Revision 1.3 2001/06/03 19:12:16 oes
627 * introduced new cgi handling
629 * No revisions before 1.3
631 **********************************************************************/
637 #include <sys/types.h>
651 #include "miscutil.h"
652 #include "cgisimple.h"
653 #include "jbsockets.h"
654 #if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE)
656 #endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */
658 /* loadcfg.h is for global_toggle_state only */
659 #ifdef FEATURE_PTHREAD
661 /* jcc.h is for mutex semaphore globals only */
662 #endif /* def FEATURE_PTHREAD */
663 const char cgi_h_rcs[] = CGI_H_VERSION;
666 * List of CGI functions: name, handler, description
667 * Note: Do NOT use single quotes in the description;
668 * this will break the dynamic "blocked" template!
670 static const struct cgi_dispatcher cgi_dispatchers[] = {
675 #ifdef FEATURE_GRACEFUL_TERMINATION
678 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
679 "this is a one click Denial Of Service attack!!!</em>",
684 #ifdef FEATURE_CGI_EDIT_ACTIONS
685 "View & change the current configuration",
687 "View the current configuration",
692 "View the source code version numbers",
696 "View the request headers",
700 "Look up which actions apply to a URL and why",
702 #ifdef FEATURE_TOGGLE
705 "Toggle Privoxy on or off",
707 #endif /* def FEATURE_TOGGLE */
708 #ifdef FEATURE_CGI_EDIT_ACTIONS
709 { "edit-actions", /* Edit the actions list */
712 { "eaa", /* Shortcut for edit-actions-add-url-form */
713 cgi_edit_actions_add_url_form,
715 { "eau", /* Shortcut for edit-actions-url-form */
716 cgi_edit_actions_url_form,
718 { "ear", /* Shortcut for edit-actions-remove-url-form */
719 cgi_edit_actions_remove_url_form,
721 { "eal", /* Shortcut for edit-actions-list */
722 cgi_edit_actions_list,
724 { "eafu", /* Shortcut for edit-actions-for-url */
725 cgi_edit_actions_for_url,
727 { "eas", /* Shortcut for edit-actions-submit */
728 cgi_edit_actions_submit,
730 { "easa", /* Shortcut for edit-actions-section-add */
731 cgi_edit_actions_section_add,
733 { "easr", /* Shortcut for edit-actions-section-remove */
734 cgi_edit_actions_section_remove,
736 { "eass", /* Shortcut for edit-actions-section-swap */
737 cgi_edit_actions_section_swap,
739 { "edit-actions-for-url",
740 cgi_edit_actions_for_url,
741 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
742 { "edit-actions-list",
743 cgi_edit_actions_list,
744 NULL, TRUE /* Edit the actions list */ },
745 { "edit-actions-submit",
746 cgi_edit_actions_submit,
747 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
748 { "edit-actions-url",
749 cgi_edit_actions_url,
750 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
751 { "edit-actions-url-form",
752 cgi_edit_actions_url_form,
753 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
754 { "edit-actions-add-url",
755 cgi_edit_actions_add_url,
756 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
757 { "edit-actions-add-url-form",
758 cgi_edit_actions_add_url_form,
759 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
760 { "edit-actions-remove-url",
761 cgi_edit_actions_remove_url,
762 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
763 { "edit-actions-remove-url-form",
764 cgi_edit_actions_remove_url_form,
765 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
766 { "edit-actions-section-add",
767 cgi_edit_actions_section_add,
768 NULL, FALSE /* Remove a section from the actionsfile */ },
769 { "edit-actions-section-remove",
770 cgi_edit_actions_section_remove,
771 NULL, FALSE /* Remove a section from the actionsfile */ },
772 { "edit-actions-section-swap",
773 cgi_edit_actions_section_swap,
774 NULL, FALSE /* Swap two sections in the actionsfile */ },
775 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
776 { "error-favicon.ico",
777 cgi_send_error_favicon,
778 NULL, TRUE /* Sends the favicon image for error pages. */ },
780 cgi_send_default_favicon,
781 NULL, TRUE /* Sends the default favicon image. */ },
784 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
787 NULL, TRUE /* Send a built-in image */ },
790 NULL, FALSE /* Send templates/cgi-style.css */ },
792 cgi_transparent_image,
793 NULL, TRUE /* Send a transparent image (short name) */ },
794 { "url-info-osd.xml",
795 cgi_send_url_info_osd,
796 NULL, TRUE /* Send templates/url-info-osd.xml */ },
798 cgi_send_user_manual,
799 NULL, TRUE /* Send user-manual */ },
800 { NULL, /* NULL Indicates end of list and default page */
802 NULL, TRUE /* Unknown CGI page */ }
807 * Built-in images for ad replacement
809 * Hint: You can encode your own images like this:
810 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
813 #ifdef FEATURE_NO_GIFS
816 * Checkerboard pattern, as a PNG.
818 const char image_pattern_data[] =
819 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
820 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
821 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
822 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
823 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
824 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
825 "\000\000\000\000\111\105\116\104\256\102\140\202";
828 * 1x1 transparant PNG.
830 const char image_blank_data[] =
831 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
832 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
833 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
834 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
835 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
836 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
837 "\000\000\000\000\111\105\116\104\256\102\140\202";
841 * Checkerboard pattern, as a GIF.
843 const char image_pattern_data[] =
844 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
845 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
846 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
847 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
851 * 1x1 transparant GIF.
853 const char image_blank_data[] =
854 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
855 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
856 "\000\001\000\000\002\002D\001\000;";
859 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
860 const size_t image_blank_length = sizeof(image_blank_data) - 1;
863 static struct http_response cgi_error_memory_response[1];
865 static struct http_response *dispatch_known_cgi(struct client_state * csp,
867 static struct map *parse_cgi_parameters(char *argstring);
870 /*********************************************************************
872 * Function : dispatch_cgi
874 * Description : Checks if a request URL has either the magical
875 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
876 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
877 * http://config.privoxy.org/). If so, it passes
878 * the (rest of the) path onto dispatch_known_cgi, which
879 * calls the relevant CGI handler function.
882 * 1 : csp = Current client state (buffers, headers, etc...)
884 * Returns : http_response if match, NULL if nonmatch or handler fail
886 *********************************************************************/
887 struct http_response *dispatch_cgi(struct client_state *csp)
889 const char *host = csp->http->host;
890 const char *path = csp->http->path;
893 * Should we intercept ?
896 /* Note: "example.com" and "example.com." are equivalent hostnames. */
898 /* Either the host matches CGI_SITE_1_HOST ..*/
899 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
900 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
901 && (path[0] == '/') )
903 /* ..then the path will all be for us. Remove leading '/' */
906 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
907 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
908 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
909 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
911 /* take everything following CGI_SITE_2_PATH */
912 path += strlen(CGI_SITE_2_PATH);
915 /* skip the forward slash after CGI_SITE_2_PATH */
918 else if (*path != '\0')
921 * weirdness: URL is /configXXX, where XXX is some string
922 * Do *NOT* intercept.
934 * This is a CGI call.
937 return dispatch_known_cgi(csp, path);
941 /*********************************************************************
943 * Function : grep_cgi_referrer
945 * Description : Ugly provisorical fix that greps the value of the
946 * referer HTTP header field out of a linked list of
947 * strings like found at csp->headers. Will disappear
950 * FIXME: csp->headers ought to be csp->http->headers
951 * FIXME: Parsing all client header lines should
952 * happen right after the request is received!
955 * 1 : csp = Current client state (buffers, headers, etc...)
957 * Returns : pointer to value (no copy!), or NULL if none found.
959 *********************************************************************/
960 static char *grep_cgi_referrer(const struct client_state *csp)
962 struct list_entry *p;
964 for (p = csp->headers->first; p != NULL; p = p->next)
966 if (p->str == NULL) continue;
967 if (strncmpic(p->str, "Referer: ", 9) == 0)
969 return ((p->str) + 9);
977 /*********************************************************************
979 * Function : referrer_is_safe
981 * Description : Decides whether we trust the Referer for
982 * CGI pages which are only meant to be reachable
983 * through Privoxy's web interface directly.
986 * 1 : csp = Current client state (buffers, headers, etc...)
988 * Returns : TRUE if the referrer is safe, or
989 * FALSE if the referrer is unsafe or not set.
991 *********************************************************************/
992 static int referrer_is_safe(const struct client_state *csp)
995 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
997 referrer = grep_cgi_referrer(csp);
999 if (NULL == referrer)
1001 /* No referrer, no access */
1002 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
1005 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
1006 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
1008 /* Trustworthy referrer */
1009 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
1010 csp->http->url, referrer);
1016 /* Untrustworthy referrer */
1017 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
1018 csp->http->url, referrer);
1025 /*********************************************************************
1027 * Function : dispatch_known_cgi
1029 * Description : Processes a CGI once dispatch_cgi has determined that
1030 * it matches one of the magic prefixes. Parses the path
1031 * as a cgi name plus query string, prepares a map that
1032 * maps CGI parameter names to their values, initializes
1033 * the http_response struct, and calls the relevant CGI
1037 * 1 : csp = Current client state (buffers, headers, etc...)
1038 * 2 : path = Path of CGI, with the CGI prefix removed.
1039 * Should not have a leading "/".
1041 * Returns : http_response, or NULL on handler failure or out of
1044 *********************************************************************/
1045 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1048 const struct cgi_dispatcher *d;
1049 struct map *param_list;
1050 struct http_response *rsp;
1051 char *query_args_start;
1055 if (NULL == (path_copy = strdup(path)))
1057 return cgi_error_memory();
1059 query_args_start = path_copy;
1060 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1064 if (*query_args_start == '/')
1066 *query_args_start++ = '\0';
1067 if ((param_list = new_map()))
1069 map(param_list, "file", 1, url_decode(query_args_start), 0);
1074 if (*query_args_start == '?')
1076 *query_args_start++ = '\0';
1078 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1081 return cgi_error_memory();
1087 * path_copy = CGI call name
1088 * param_list = CGI params, as map
1091 /* Get mem for response or fail*/
1092 if (NULL == (rsp = alloc_http_response()))
1095 free_map(param_list);
1096 return cgi_error_memory();
1100 * Find and start the right CGI function
1102 d = cgi_dispatchers;
1105 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1108 * If the called CGI is either harmless, or referred
1109 * from a trusted source, start it.
1111 if (d->harmless || referrer_is_safe(csp))
1113 err = (d->handler)(csp, rsp, param_list);
1118 * Else, modify toggle calls so that they only display
1119 * the status, and deny all other calls.
1121 if (0 == strcmp(path_copy, "toggle"))
1123 unmap(param_list, "set");
1124 err = (d->handler)(csp, rsp, param_list);
1128 err = cgi_error_disabled(csp, rsp);
1133 free_map(param_list);
1135 if (err == JB_ERR_CGI_PARAMS)
1137 err = cgi_error_bad_param(csp, rsp);
1139 if (err && (err != JB_ERR_MEMORY))
1141 /* Unexpected error! Shouldn't get here */
1142 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1143 err = cgi_error_unknown(csp, rsp, err);
1148 rsp->reason = RSP_REASON_CGI_CALL;
1149 return finish_http_response(csp, rsp);
1153 /* Error in handler, probably out-of-memory */
1154 free_http_response(rsp);
1155 return cgi_error_memory();
1163 /*********************************************************************
1165 * Function : parse_cgi_parameters
1167 * Description : Parse a URL-encoded argument string into name/value
1168 * pairs and store them in a struct map list.
1171 * 1 : argstring = string to be parsed. Will be trashed.
1173 * Returns : pointer to param list, or NULL if out of memory.
1175 *********************************************************************/
1176 static struct map *parse_cgi_parameters(char *argstring)
1179 char *vector[BUFFER_SIZE];
1181 struct map *cgi_params;
1183 if (NULL == (cgi_params = new_map()))
1189 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1190 * the fragment identifier along with the request, so we must
1191 * cut it off here, so it won't pollute the CGI params:
1193 if (NULL != (p = strchr(argstring, '#')))
1198 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1200 for (i = 0; i < pairs; i++)
1202 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1205 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1207 free_map(cgi_params);
1218 /*********************************************************************
1220 * Function : get_char_param
1222 * Description : Get a single-character parameter passed to a CGI
1226 * 1 : parameters = map of cgi parameters
1227 * 2 : param_name = The name of the parameter to read
1229 * Returns : Uppercase character on success, '\0' on error.
1231 *********************************************************************/
1232 char get_char_param(const struct map *parameters,
1233 const char *param_name)
1240 ch = *(lookup(parameters, param_name));
1241 if ((ch >= 'a') && (ch <= 'z'))
1243 ch = (char)(ch - 'a' + 'A');
1250 /*********************************************************************
1252 * Function : get_string_param
1254 * Description : Get a string paramater, to be used as an
1255 * ACTION_STRING or ACTION_MULTI paramater.
1256 * Validates the input to prevent stupid/malicious
1257 * users from corrupting their action file.
1260 * 1 : parameters = map of cgi parameters
1261 * 2 : param_name = The name of the parameter to read
1262 * 3 : pparam = destination for paramater. Allocated as
1263 * part of the map "parameters", so don't free it.
1264 * Set to NULL if not specified.
1266 * Returns : JB_ERR_OK on success, or if the paramater
1267 * was not specified.
1268 * JB_ERR_MEMORY on out-of-memory.
1269 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1271 *********************************************************************/
1272 jb_err get_string_param(const struct map *parameters,
1273 const char *param_name,
1274 const char **pparam)
1286 param = lookup(parameters, param_name);
1292 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1297 * Note that the length limit is arbitrary, it just seems
1298 * sensible to limit it to *something*. There's no
1299 * technical reason for any limit at all.
1301 return JB_ERR_CGI_PARAMS;
1304 /* Check every character to see if it's legal */
1306 while ((ch = *s++) != '\0')
1308 if ( ((unsigned char)ch < (unsigned char)' ')
1311 /* Probable hack attempt, or user accidentally used '}'. */
1312 return JB_ERR_CGI_PARAMS;
1323 /*********************************************************************
1325 * Function : get_number_param
1327 * Description : Get a non-negative integer from the parameters
1328 * passed to a CGI function.
1331 * 1 : csp = Current client state (buffers, headers, etc...)
1332 * 2 : parameters = map of cgi parameters
1333 * 3 : name = Name of CGI parameter to read
1334 * 4 : pvalue = destination for value.
1335 * Set to -1 on error.
1337 * Returns : JB_ERR_OK on success
1338 * JB_ERR_MEMORY on out-of-memory
1339 * JB_ERR_CGI_PARAMS if the parameter was not specified
1342 *********************************************************************/
1343 jb_err get_number_param(struct client_state *csp,
1344 const struct map *parameters,
1359 param = lookup(parameters, name);
1362 return JB_ERR_CGI_PARAMS;
1365 /* We don't use atoi because I want to check this carefully... */
1368 while ((ch = *param++) != '\0')
1370 if ((ch < '0') || (ch > '9'))
1372 return JB_ERR_CGI_PARAMS;
1375 ch = (char)(ch - '0');
1379 * <limits.h> defines UINT_MAX
1381 * (UINT_MAX - ch) / 10 is the largest number that
1382 * can be safely multiplied by 10 then have ch added.
1384 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1386 return JB_ERR_CGI_PARAMS;
1389 value = value * 10 + (unsigned)ch;
1400 /*********************************************************************
1402 * Function : error_response
1404 * Description : returns an http_response that explains the reason
1405 * why a request failed.
1408 * 1 : csp = Current client state (buffers, headers, etc...)
1409 * 2 : templatename = Which template should be used for the answer
1410 * 3 : sys_err = system error number
1412 * Returns : A http_response. If we run out of memory, this
1413 * will be cgi_error_memory().
1415 *********************************************************************/
1416 struct http_response *error_response(struct client_state *csp,
1417 const char *templatename,
1421 struct http_response *rsp;
1422 struct map *exports = default_exports(csp, NULL);
1425 if (exports == NULL)
1427 return cgi_error_memory();
1430 if (NULL == (rsp = alloc_http_response()))
1433 return cgi_error_memory();
1436 #ifdef FEATURE_FORCE_LOAD
1437 if (csp->flags & CSP_FLAG_FORCED)
1439 path = strdup(FORCE_PREFIX);
1442 #endif /* def FEATURE_FORCE_LOAD */
1446 err = string_append(&path, csp->http->path);
1448 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1449 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1450 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1451 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1452 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1455 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1458 /* Some failures, like "404 no such domain", don't have an IP address. */
1459 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1467 free_http_response(rsp);
1468 return cgi_error_memory();
1471 if (!strcmp(templatename, "no-such-domain"))
1473 rsp->status = strdup("404 No such domain");
1474 if (rsp->status == NULL)
1477 free_http_response(rsp);
1478 return cgi_error_memory();
1480 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1482 else if (!strcmp(templatename, "forwarding-failed"))
1484 const struct forward_spec *fwd = forward_url(csp, csp->http);
1485 char *socks_type = NULL;
1488 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1489 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1493 * XXX: While the template is called forwarding-failed,
1494 * it currently only handles socks forwarding failures.
1496 assert(fwd->type != SOCKS_NONE);
1499 * Map failure reason, forwarding type and forwarder.
1501 if (NULL == csp->error_message)
1504 * Either we forgot to record the failure reason,
1505 * or the memory allocation failed.
1507 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1508 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1510 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1513 * XXX: this is almost the same code as in cgi_show_url_info()
1514 * and thus should be factored out and shared.
1519 socks_type = "socks4-";
1522 socks_type = "socks4a-";
1525 socks_type = "socks5-";
1528 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1531 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1532 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1534 if (!err) rsp->status = strdup("503 Forwarding failure");
1535 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1538 free_http_response(rsp);
1539 return cgi_error_memory();
1541 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1543 else if (!strcmp(templatename, "connect-failed"))
1545 rsp->status = strdup("503 Connect failed");
1546 if (rsp->status == NULL)
1549 free_http_response(rsp);
1550 return cgi_error_memory();
1552 rsp->reason = RSP_REASON_CONNECT_FAILED;
1555 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1558 free_http_response(rsp);
1559 return cgi_error_memory();
1562 return finish_http_response(csp, rsp);
1566 /*********************************************************************
1568 * Function : cgi_error_disabled
1570 * Description : CGI function that is called to generate an error
1571 * response if the actions editor or toggle CGI are
1572 * accessed despite having being disabled at compile-
1573 * or run-time, or if the user followed an untrusted link
1574 * to access a unsafe CGI feature that is only reachable
1575 * through Privoxy directly.
1578 * 1 : csp = Current client state (buffers, headers, etc...)
1579 * 2 : rsp = http_response data structure for output
1581 * CGI Parameters : none
1583 * Returns : JB_ERR_OK on success
1584 * JB_ERR_MEMORY on out-of-memory error.
1586 *********************************************************************/
1587 jb_err cgi_error_disabled(const struct client_state *csp,
1588 struct http_response *rsp)
1590 struct map *exports;
1595 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1597 return JB_ERR_MEMORY;
1599 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1601 /* Not important enough to do anything */
1602 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1605 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1609 /*********************************************************************
1611 * Function : cgi_init_error_messages
1613 * Description : Call at the start of the program to initialize
1614 * the error message used by cgi_error_memory().
1620 *********************************************************************/
1621 void cgi_init_error_messages(void)
1623 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1624 cgi_error_memory_response->head =
1625 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1626 "Content-Type: text/html\r\n"
1628 cgi_error_memory_response->body =
1631 " <title>500 Internal Privoxy Error</title>\r\n"
1632 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1635 "<h1>500 Internal Privoxy Error</h1>\r\n"
1636 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1637 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1641 cgi_error_memory_response->head_length =
1642 strlen(cgi_error_memory_response->head);
1643 cgi_error_memory_response->content_length =
1644 strlen(cgi_error_memory_response->body);
1645 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1649 /*********************************************************************
1651 * Function : cgi_error_memory
1653 * Description : Called if a CGI function runs out of memory.
1654 * Returns a statically-allocated error response.
1658 * Returns : http_response data structure for output. This is
1659 * statically allocated, for obvious reasons.
1661 *********************************************************************/
1662 struct http_response *cgi_error_memory(void)
1664 /* assert that it's been initialized. */
1665 assert(cgi_error_memory_response->head);
1667 return cgi_error_memory_response;
1671 /*********************************************************************
1673 * Function : cgi_error_no_template
1675 * Description : Almost-CGI function that is called if a template
1676 * cannot be loaded. Note this is not a true CGI,
1677 * it takes a template name rather than a map of
1681 * 1 : csp = Current client state (buffers, headers, etc...)
1682 * 2 : rsp = http_response data structure for output
1683 * 3 : template_name = Name of template that could not
1686 * Returns : JB_ERR_OK on success
1687 * JB_ERR_MEMORY on out-of-memory error.
1689 *********************************************************************/
1690 jb_err cgi_error_no_template(const struct client_state *csp,
1691 struct http_response *rsp,
1692 const char *template_name)
1694 static const char status[] =
1695 "500 Internal Privoxy Error";
1696 static const char body_prefix[] =
1699 " <title>500 Internal Privoxy Error</title>\r\n"
1700 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1703 "<h1>500 Internal Privoxy Error</h1>\r\n"
1704 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1705 "<p><b>Could not load template file <code>";
1706 static const char body_suffix[] =
1707 "</code> or one of its included components.</b></p>\r\n"
1708 "<p>Please contact your proxy administrator.</p>\r\n"
1709 "<p>If you are the proxy administrator, please put the required file(s)"
1710 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1711 "location of the <code><i>(confdir)</i></code> directory "
1712 "is specified in the main Privoxy <code>config</code> "
1713 "file. (It's typically the Privoxy install directory"
1715 ", or <code>/etc/privoxy/</code>"
1716 #endif /* ndef _WIN32 */
1720 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1724 assert(template_name);
1726 /* Reset rsp, if needed */
1730 rsp->content_length = 0;
1731 rsp->head_length = 0;
1734 rsp->body = malloc(body_size);
1735 if (rsp->body == NULL)
1737 return JB_ERR_MEMORY;
1739 strlcpy(rsp->body, body_prefix, body_size);
1740 strlcat(rsp->body, template_name, body_size);
1741 strlcat(rsp->body, body_suffix, body_size);
1743 rsp->status = strdup(status);
1744 if (rsp->status == NULL)
1746 return JB_ERR_MEMORY;
1753 /*********************************************************************
1755 * Function : cgi_error_unknown
1757 * Description : Almost-CGI function that is called if an unexpected
1758 * error occurs in the top-level CGI dispatcher.
1759 * In this context, "unexpected" means "anything other
1760 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1761 * expected to handle all other errors internally,
1762 * since they can give more relavent error messages
1765 * Note this is not a true CGI, it takes an error
1766 * code rather than a map of parameters.
1769 * 1 : csp = Current client state (buffers, headers, etc...)
1770 * 2 : rsp = http_response data structure for output
1771 * 3 : error_to_report = Error code to report.
1773 * Returns : JB_ERR_OK on success
1774 * JB_ERR_MEMORY on out-of-memory error.
1776 *********************************************************************/
1777 jb_err cgi_error_unknown(const struct client_state *csp,
1778 struct http_response *rsp,
1779 jb_err error_to_report)
1781 static const char status[] =
1782 "500 Internal Privoxy Error";
1783 static const char body_prefix[] =
1786 " <title>500 Internal Privoxy Error</title>\r\n"
1787 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1790 "<h1>500 Internal Privoxy Error</h1>\r\n"
1791 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1792 "<p><b>Unexpected internal error: ";
1793 static const char body_suffix[] =
1796 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1797 "file a bug report</a>.</p>\r\n"
1802 * Due to sizeof(errnumbuf), body_size will be slightly
1803 * bigger than necessary but it doesn't really matter.
1805 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1809 /* Reset rsp, if needed */
1813 rsp->content_length = 0;
1814 rsp->head_length = 0;
1816 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1818 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1820 rsp->body = malloc(body_size);
1821 if (rsp->body == NULL)
1823 return JB_ERR_MEMORY;
1825 strlcpy(rsp->body, body_prefix, body_size);
1826 strlcat(rsp->body, errnumbuf, body_size);
1827 strlcat(rsp->body, body_suffix, body_size);
1829 rsp->status = strdup(status);
1830 if (rsp->status == NULL)
1832 return JB_ERR_MEMORY;
1839 /*********************************************************************
1841 * Function : cgi_error_bad_param
1843 * Description : CGI function that is called if the parameters
1844 * (query string) for a CGI were wrong.
1847 * 1 : csp = Current client state (buffers, headers, etc...)
1848 * 2 : rsp = http_response data structure for output
1850 * CGI Parameters : none
1852 * Returns : JB_ERR_OK on success
1853 * JB_ERR_MEMORY on out-of-memory error.
1855 *********************************************************************/
1856 jb_err cgi_error_bad_param(const struct client_state *csp,
1857 struct http_response *rsp)
1859 struct map *exports;
1864 if (NULL == (exports = default_exports(csp, NULL)))
1866 return JB_ERR_MEMORY;
1869 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1873 /*********************************************************************
1875 * Function : cgi_redirect
1877 * Description : CGI support function to generate a HTTP redirect
1881 * 1 : rsp = http_response data structure for output
1882 * 2 : target = string with the target URL
1884 * CGI Parameters : None
1886 * Returns : JB_ERR_OK on success
1887 * JB_ERR_MEMORY on out-of-memory error.
1889 *********************************************************************/
1890 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1897 err = enlist_unique_header(rsp->headers, "Location", target);
1899 rsp->status = strdup("302 Local Redirect from Privoxy");
1900 if (rsp->status == NULL)
1902 return JB_ERR_MEMORY;
1909 /*********************************************************************
1911 * Function : add_help_link
1913 * Description : Produce a copy of the string given as item,
1914 * embedded in an HTML link to its corresponding
1915 * section (item name in uppercase) in the actions
1916 * chapter of the user manual, (whose URL is given in
1917 * the config and defaults to our web site).
1919 * FIXME: I currently only work for actions, and would
1920 * like to be generalized for other topics.
1923 * 1 : item = item (will NOT be free()d.)
1924 * It is assumed to be HTML-safe.
1925 * 2 : config = The current configuration.
1927 * Returns : String with item embedded in link, or NULL on
1930 *********************************************************************/
1931 char *add_help_link(const char *item,
1932 struct configuration_spec *config)
1936 if (!item) return NULL;
1938 result = strdup("<a href=\"");
1939 if (!strncmpic(config->usermanual, "file://", 7) ||
1940 !strncmpic(config->usermanual, "http", 4))
1942 string_append(&result, config->usermanual);
1946 string_append(&result, "http://");
1947 string_append(&result, CGI_SITE_2_HOST);
1948 string_append(&result, "/user-manual/");
1950 string_append(&result, ACTIONS_HELP_PREFIX);
1951 string_join (&result, string_toupper(item));
1952 string_append(&result, "\">");
1953 string_append(&result, item);
1954 string_append(&result, "</a> ");
1960 /*********************************************************************
1962 * Function : get_http_time
1964 * Description : Get the time in a format suitable for use in a
1965 * HTTP header - e.g.:
1966 * "Sun, 06 Nov 1994 08:49:37 GMT"
1969 * 1 : time_offset = Time returned will be current time
1970 * plus this number of seconds.
1971 * 2 : buf = Destination for result.
1972 * 3 : buffer_size = Size of the buffer above. Must be big
1973 * enough to hold 29 characters plus a
1978 *********************************************************************/
1979 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1981 static const char day_names[7][4] =
1982 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1983 static const char month_names[12][4] =
1984 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1985 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1988 time_t current_time;
1989 #if defined(HAVE_GMTIME_R)
1994 assert(buffer_size > 29);
1996 time(¤t_time);
1998 current_time += time_offset;
2000 /* get and save the gmt */
2002 t = gmtime_r(¤t_time, &dummy);
2003 #elif FEATURE_PTHREAD
2004 pthread_mutex_lock(&gmtime_mutex);
2005 t = gmtime(¤t_time);
2006 pthread_mutex_unlock(&gmtime_mutex);
2008 t = gmtime(¤t_time);
2011 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
2012 snprintf(buf, buffer_size,
2013 "%s, %02d %s %4d %02d:%02d:%02d GMT",
2014 day_names[t->tm_wday],
2016 month_names[t->tm_mon],
2025 /*********************************************************************
2027 * Function : get_locale_time
2029 * Description : Get the time in a date(1)-like format
2030 * according to the current locale - e.g.:
2031 * "Fri Aug 29 19:37:12 CEST 2008"
2033 * XXX: Should we allow the user to change the format?
2036 * 1 : buf = Destination for result.
2037 * 2 : buffer_size = Size of the buffer above. Must be big
2038 * enough to hold 29 characters plus a
2043 *********************************************************************/
2044 static void get_locale_time(char *buf, size_t buffer_size)
2047 time_t current_time;
2048 #if defined(HAVE_LOCALTIME_R)
2053 assert(buffer_size > 29);
2055 time(¤t_time);
2057 #if HAVE_LOCALTIME_R
2058 timeptr = localtime_r(¤t_time, &dummy);
2059 #elif FEATURE_PTHREAD
2060 pthread_mutex_lock(&localtime_mutex);
2061 timeptr = localtime(¤t_time);
2062 pthread_mutex_unlock(&localtime_mutex);
2064 timeptr = localtime(¤t_time);
2067 strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
2071 /*********************************************************************
2073 * Function : finish_http_response
2075 * Description : Fill in the missing headers in an http response,
2076 * and flatten the headers to an http head.
2077 * For HEAD requests the body is freed once
2078 * the Content-Length header is set.
2081 * 1 : rsp = pointer to http_response to be processed
2083 * Returns : A http_response, usually the rsp parameter.
2084 * On error, free()s rsp and returns cgi_error_memory()
2086 *********************************************************************/
2087 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2089 char buf[BUFFER_SIZE];
2092 /* Special case - do NOT change this statically allocated response,
2093 * which is ready for output anyway.
2095 if (rsp == cgi_error_memory_response)
2101 * Fill in the HTTP Status, using HTTP/1.1
2102 * unless the client asked for HTTP/1.0.
2104 snprintf(buf, sizeof(buf), "%s %s",
2105 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2106 rsp->status ? rsp->status : "200 OK");
2107 err = enlist_first(rsp->headers, buf);
2110 * Set the Content-Length
2112 if (rsp->content_length == 0)
2114 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2118 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2119 err = enlist(rsp->headers, buf);
2122 if (0 == strcmpic(csp->http->gpc, "head"))
2125 * The client only asked for the head. Dispose
2126 * the body and log an offensive message.
2128 * While it may seem to be a bit inefficient to
2129 * prepare the body if it isn't needed, it's the
2130 * only way to get the Content-Length right for
2131 * dynamic pages. We could have disposed the body
2132 * earlier, but not without duplicating the
2133 * Content-Length setting code above.
2135 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2137 rsp->content_length = 0;
2140 if (strncmpic(rsp->status, "302", 3))
2143 * If it's not a redirect without any content,
2144 * set the Content-Type to text/html if it's
2145 * not already specified.
2147 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2151 * Fill in the rest of the default headers:
2153 * Date: set to current date/time.
2154 * Last-Modified: set to date/time the page was last changed.
2155 * Expires: set to date/time page next needs reloading.
2156 * Cache-Control: set to "no-cache" if applicable.
2158 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2163 * Set Expires to about 10 min into the future so it'll get reloaded
2164 * occasionally, e.g. if Privoxy gets upgraded.
2169 get_http_time(0, buf, sizeof(buf));
2170 err = enlist_unique_header(rsp->headers, "Date", buf);
2173 /* Some date in the past. */
2174 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2178 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
2179 err = enlist_unique_header(rsp->headers, "Expires", buf);
2182 else if (!strncmpic(rsp->status, "302", 3))
2184 get_http_time(0, buf, sizeof(buf));
2185 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2190 * Setting "Cache-Control" to "no-cache" and "Expires" to
2191 * the current time doesn't exactly forbid caching, it just
2192 * requires the client to revalidate the cached copy.
2194 * If a temporary problem occurs and the user tries again after
2195 * getting Privoxy's error message, a compliant browser may set the
2196 * If-Modified-Since header with the content of the error page's
2197 * Last-Modified header. More often than not, the document on the server
2198 * is older than Privoxy's error message, the server would send status code
2199 * 304 and the browser would display the outdated error message again and again.
2201 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2202 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2203 * and can be safely used to "revalidate" without getting a status code 304.
2205 * There is no need to let the useless If-Modified-Since header reach the
2206 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2208 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2210 get_http_time(0, buf, sizeof(buf));
2211 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2212 if (!strncmpic(rsp->status, "403", 3)
2213 || !strncmpic(rsp->status, "404", 3)
2214 || !strncmpic(rsp->status, "503", 3))
2216 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2220 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2222 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2223 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2229 * HTTP/1.1 applications that do not support persistent connections MUST
2230 * include the "close" connection option in every message.
2232 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2237 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2239 free_http_response(rsp);
2240 return cgi_error_memory();
2242 rsp->head_length = strlen(rsp->head);
2249 /*********************************************************************
2251 * Function : alloc_http_response
2253 * Description : Allocates a new http_response structure.
2257 * Returns : pointer to a new http_response, or NULL.
2259 *********************************************************************/
2260 struct http_response *alloc_http_response(void)
2262 return (struct http_response *) zalloc(sizeof(struct http_response));
2267 /*********************************************************************
2269 * Function : free_http_response
2271 * Description : Free the memory occupied by an http_response
2272 * and its depandant structures.
2275 * 1 : rsp = pointer to http_response to be freed
2279 *********************************************************************/
2280 void free_http_response(struct http_response *rsp)
2283 * Must special case cgi_error_memory_response, which is never freed.
2285 if (rsp && (rsp != cgi_error_memory_response))
2290 destroy_list(rsp->headers);
2297 /*********************************************************************
2299 * Function : template_load
2301 * Description : CGI support function that loads a given HTML
2302 * template, ignoring comment lines and following
2303 * #include statements up to a depth of 1.
2306 * 1 : csp = Current client state (buffers, headers, etc...)
2307 * 2 : template_ptr = Destination for pointer to loaded
2309 * 3 : templatename = name of the HTML template to be used
2310 * 4 : recursive = Flag set if this function calls itself
2311 * following an #include statament
2313 * Returns : JB_ERR_OK on success
2314 * JB_ERR_MEMORY on out-of-memory error.
2315 * JB_ERR_FILE if the template file cannot be read
2317 *********************************************************************/
2318 jb_err template_load(const struct client_state *csp, char **template_ptr,
2319 const char *templatename, int recursive)
2322 char *templates_dir_path;
2325 char *included_module;
2328 char buf[BUFFER_SIZE];
2331 assert(template_ptr);
2332 assert(templatename);
2334 *template_ptr = NULL;
2336 /* Validate template name. Paranoia. */
2337 for (p = templatename; *p != 0; p++)
2339 if ( ((*p < 'a') || (*p > 'z'))
2340 && ((*p < 'A') || (*p > 'Z'))
2341 && ((*p < '0') || (*p > '9'))
2345 /* Illegal character */
2351 * Generate full path using either templdir
2352 * or confdir/templates as base directory.
2354 if (NULL != csp->config->templdir)
2356 templates_dir_path = strdup(csp->config->templdir);
2360 templates_dir_path = make_path(csp->config->confdir, "templates");
2363 if (templates_dir_path == NULL)
2365 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2367 return JB_ERR_MEMORY;
2370 full_path = make_path(templates_dir_path, templatename);
2371 free(templates_dir_path);
2372 if (full_path == NULL)
2374 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2376 return JB_ERR_MEMORY;
2379 /* Allocate buffer */
2381 file_buffer = strdup("");
2382 if (file_buffer == NULL)
2384 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2386 return JB_ERR_MEMORY;
2389 /* Open template file */
2391 if (NULL == (fp = fopen(full_path, "r")))
2393 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2401 * Read the file, ignoring comments, and honoring #include
2402 * statements, unless we're already called recursively.
2404 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2405 * This is unlikely in practise.
2407 while (fgets(buf, BUFFER_SIZE, fp))
2409 if (!recursive && !strncmp(buf, "#include ", 9))
2411 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2418 if (string_join(&file_buffer, included_module))
2421 return JB_ERR_MEMORY;
2427 /* skip lines starting with '#' */
2433 if (string_append(&file_buffer, buf))
2436 return JB_ERR_MEMORY;
2441 *template_ptr = file_buffer;
2447 /*********************************************************************
2449 * Function : template_fill
2451 * Description : CGI support function that fills in a pre-loaded
2452 * HTML template by replacing @name@ with value using
2453 * pcrs, for each item in the output map.
2455 * Note that a leading '$' charachter in the export map's
2456 * values will be stripped and toggle on backreference
2460 * 1 : template_ptr = IN: Template to be filled out.
2462 * OUT: Filled out template.
2463 * Caller must free().
2464 * 2 : exports = map with fill in symbol -> name pairs
2466 * Returns : JB_ERR_OK on success (and for uncritical errors)
2467 * JB_ERR_MEMORY on out-of-memory error
2469 *********************************************************************/
2470 jb_err template_fill(char **template_ptr, const struct map *exports)
2472 struct map_entry *m;
2474 char buf[BUFFER_SIZE];
2475 char *tmp_out_buffer;
2481 assert(template_ptr);
2482 assert(*template_ptr);
2485 file_buffer = *template_ptr;
2486 size = strlen(file_buffer) + 1;
2489 * Assemble pcrs joblist from exports map
2491 for (m = exports->first; m != NULL; m = m->next)
2493 if (*m->name == '$')
2496 * First character of name is '$', so remove this flag
2497 * character and allow backreferences ($1 etc) in the
2498 * "replace with" text.
2500 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2506 * Treat the "replace with" text as a literal string -
2507 * no quoting needed, no backreferences allowed.
2508 * ("Trivial" ['T'] flag).
2512 /* Enclose name in @@ */
2513 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2517 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2519 /* Make and run job. */
2520 job = pcrs_compile(buf, m->value, flags, &error);
2523 if (error == PCRS_ERR_NOMEM)
2526 *template_ptr = NULL;
2527 return JB_ERR_MEMORY;
2531 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2532 /* Hope it wasn't important and silently ignore the invalid job */
2537 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2540 if (NULL == tmp_out_buffer)
2542 *template_ptr = NULL;
2543 return JB_ERR_MEMORY;
2549 * Substitution failed, keep the original buffer,
2550 * log the problem and ignore it.
2552 * The user might see some unresolved @CGI_VARIABLES@,
2553 * but returning a special CGI error page seems unreasonable
2554 * and could mask more important error messages.
2556 free(tmp_out_buffer);
2557 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2558 buf, m->value, flags, pcrs_strerror(error));
2562 /* Substitution succeeded, use modified buffer. */
2564 file_buffer = tmp_out_buffer;
2572 *template_ptr = file_buffer;
2577 /*********************************************************************
2579 * Function : template_fill_for_cgi
2581 * Description : CGI support function that loads a HTML template
2582 * and fills it in. Handles file-not-found errors
2583 * by sending a HTML error message. For convenience,
2584 * this function also frees the passed "exports" map.
2587 * 1 : csp = Client state
2588 * 2 : templatename = name of the HTML template to be used
2589 * 3 : exports = map with fill in symbol -> name pairs.
2590 * Will be freed by this function.
2591 * 4 : rsp = Response structure to fill in.
2593 * Returns : JB_ERR_OK on success
2594 * JB_ERR_MEMORY on out-of-memory error
2596 *********************************************************************/
2597 jb_err template_fill_for_cgi(const struct client_state *csp,
2598 const char *templatename,
2599 struct map *exports,
2600 struct http_response *rsp)
2605 assert(templatename);
2609 err = template_load(csp, &rsp->body, templatename, 0);
2610 if (err == JB_ERR_FILE)
2613 return cgi_error_no_template(csp, rsp, templatename);
2618 return err; /* JB_ERR_MEMORY */
2620 err = template_fill(&rsp->body, exports);
2626 /*********************************************************************
2628 * Function : default_exports
2630 * Description : returns a struct map list that contains exports
2631 * which are common to all CGI functions.
2634 * 1 : csp = Current client state (buffers, headers, etc...)
2635 * 2 : caller = name of CGI who calls us and which should
2636 * be excluded from the generated menu. May be
2638 * Returns : NULL if no memory, else a new map. Caller frees.
2640 *********************************************************************/
2641 struct map *default_exports(const struct client_state *csp, const char *caller)
2645 struct map * exports;
2646 int local_help_exists = 0;
2647 char *ip_address = NULL;
2648 char *hostname = NULL;
2652 exports = new_map();
2653 if (exports == NULL)
2658 if (csp->config->hostname)
2660 get_host_information(csp->cfd, &ip_address, NULL);
2661 hostname = strdup(csp->config->hostname);
2665 get_host_information(csp->cfd, &ip_address, &hostname);
2668 err = map(exports, "version", 1, html_encode(VERSION), 0);
2669 get_locale_time(buf, sizeof(buf));
2670 if (!err) err = map(exports, "time", 1, html_encode(buf), 0);
2671 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2673 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2675 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2676 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2677 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2678 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2679 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2680 !strncmpic(csp->config->usermanual, "http", 4))
2682 /* Manual is located somewhere else, just link to it. */
2683 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2687 /* Manual is delivered by Privoxy. */
2688 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2690 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2691 #ifdef FEATURE_TOGGLE
2692 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2694 if (!err) err = map_block_killer(exports, "can-toggle");
2697 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2698 if (!err) err = map(exports, "my-port", 1, buf, 1);
2700 if(!strcmp(CODE_STATUS, "stable"))
2702 if (!err) err = map_block_killer(exports, "unstable");
2705 if (csp->config->admin_address != NULL)
2707 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2708 local_help_exists = 1;
2712 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2715 if (csp->config->proxy_info_url != NULL)
2717 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2718 local_help_exists = 1;
2722 if (!err) err = map_block_killer(exports, "have-proxy-info");
2725 if (local_help_exists == 0)
2727 if (!err) err = map_block_killer(exports, "have-help-info");
2740 /*********************************************************************
2742 * Function : map_block_killer
2744 * Description : Convenience function.
2745 * Adds a "killer" for the conditional HTML-template
2746 * block <name>, i.e. a substitution of the regex
2747 * "if-<name>-start.*if-<name>-end" to the given
2751 * 1 : exports = map to extend
2752 * 2 : name = name of conditional block
2754 * Returns : JB_ERR_OK on success
2755 * JB_ERR_MEMORY on out-of-memory error.
2757 *********************************************************************/
2758 jb_err map_block_killer(struct map *exports, const char *name)
2760 char buf[1000]; /* Will do, since the names are hardwired */
2764 assert(strlen(name) < 490);
2766 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2767 return map(exports, buf, 1, "", 1);
2771 /*********************************************************************
2773 * Function : map_block_keep
2775 * Description : Convenience function. Removes the markers used
2776 * by map-block-killer, to save a few bytes.
2777 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2780 * 1 : exports = map to extend
2781 * 2 : name = name of conditional block
2783 * Returns : JB_ERR_OK on success
2784 * JB_ERR_MEMORY on out-of-memory error.
2786 *********************************************************************/
2787 jb_err map_block_keep(struct map *exports, const char *name)
2790 char buf[500]; /* Will do, since the names are hardwired */
2794 assert(strlen(name) < 490);
2796 snprintf(buf, sizeof(buf), "if-%s-start", name);
2797 err = map(exports, buf, 1, "", 1);
2804 snprintf(buf, sizeof(buf), "if-%s-end", name);
2805 return map(exports, buf, 1, "", 1);
2809 /*********************************************************************
2811 * Function : map_conditional
2813 * Description : Convenience function.
2814 * Adds an "if-then-else" for the conditional HTML-template
2815 * block <name>, i.e. a substitution of the form:
2822 * The control structure and one of the alternatives
2826 * 1 : exports = map to extend
2827 * 2 : name = name of conditional block
2828 * 3 : choose_first = nonzero for first, zero for second.
2830 * Returns : JB_ERR_OK on success
2831 * JB_ERR_MEMORY on out-of-memory error.
2833 *********************************************************************/
2834 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2836 char buf[1000]; /* Will do, since the names are hardwired */
2841 assert(strlen(name) < 480);
2843 snprintf(buf, sizeof(buf), (choose_first
2844 ? "else-not-%s@.*@endif-%s"
2845 : "if-%s-then@.*@else-not-%s"),
2848 err = map(exports, buf, 1, "", 1);
2854 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2855 return map(exports, buf, 1, "", 1);
2859 /*********************************************************************
2861 * Function : make_menu
2863 * Description : Returns an HTML-formatted menu of the available
2864 * unhidden CGIs, excluding the one given in <self>
2865 * and the toggle CGI if toggling is disabled.
2868 * 1 : self = name of CGI to leave out, can be NULL for
2870 * 2 : feature_flags = feature bitmap from csp->config
2873 * Returns : menu string, or NULL on out-of-memory error.
2875 *********************************************************************/
2876 char *make_menu(const char *self, const unsigned feature_flags)
2878 const struct cgi_dispatcher *d;
2879 char *result = strdup("");
2883 self = "NO-SUCH-CGI!";
2886 /* List available unhidden CGI's and export as "other-cgis" */
2887 for (d = cgi_dispatchers; d->name; d++)
2890 #ifdef FEATURE_TOGGLE
2891 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2894 * Suppress the toggle link if remote toggling is disabled.
2898 #endif /* def FEATURE_TOGGLE */
2900 if (d->description && strcmp(d->name, self))
2902 char *html_encoded_prefix;
2905 * Line breaks would be great, but break
2906 * the "blocked" template's JavaScript.
2908 string_append(&result, "<li><a href=\"");
2909 html_encoded_prefix = html_encode(CGI_PREFIX);
2910 if (html_encoded_prefix == NULL)
2916 string_append(&result, html_encoded_prefix);
2917 free(html_encoded_prefix);
2919 string_append(&result, d->name);
2920 string_append(&result, "\">");
2921 string_append(&result, d->description);
2922 string_append(&result, "</a></li>");
2930 /*********************************************************************
2932 * Function : dump_map
2934 * Description : HTML-dump a map for debugging (as table)
2937 * 1 : the_map = map to dump
2939 * Returns : string with HTML
2941 *********************************************************************/
2942 char *dump_map(const struct map *the_map)
2944 struct map_entry *cur_entry;
2945 char *ret = strdup("");
2947 string_append(&ret, "<table>\n");
2949 for (cur_entry = the_map->first;
2950 (cur_entry != NULL) && (ret != NULL);
2951 cur_entry = cur_entry->next)
2953 string_append(&ret, "<tr><td><b>");
2954 string_join (&ret, html_encode(cur_entry->name));
2955 string_append(&ret, "</b></td><td>");
2956 string_join (&ret, html_encode(cur_entry->value));
2957 string_append(&ret, "</td></tr>\n");
2960 string_append(&ret, "</table>\n");