1 const char cgi_rcs[] = "$Id: cgi.c,v 1.106 2008/05/21 15:24:38 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
6 * Purpose : Declares functions to intercept request, generate
7 * html or gif answers, and to compose HTTP resonses.
8 * This only contains the framework functions, the
9 * actual handler functions are declared elsewhere.
11 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001-2004, 2006-2007
15 * the SourceForge Privoxy team. http://www.privoxy.org/
17 * Based on the Internet Junkbuster originally written
18 * by and Copyright (C) 1997 Anonymous Coders and
19 * Junkbusters Corporation. http://www.junkbusters.com
21 * This program is free software; you can redistribute it
22 * and/or modify it under the terms of the GNU General
23 * Public License as published by the Free Software
24 * Foundation; either version 2 of the License, or (at
25 * your option) any later version.
27 * This program is distributed in the hope that it will
28 * be useful, but WITHOUT ANY WARRANTY; without even the
29 * implied warranty of MERCHANTABILITY or FITNESS FOR A
30 * PARTICULAR PURPOSE. See the GNU General Public
31 * License for more details.
33 * The GNU General Public License should be included with
34 * this file. If not, you can view it at
35 * http://www.gnu.org/copyleft/gpl.html
36 * or write to the Free Software Foundation, Inc., 59
37 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
41 * Revision 1.106 2008/05/21 15:24:38 fabiankeil
42 * Mark csp as immutable for a bunch of functions.
44 * Revision 1.105 2008/04/17 14:40:47 fabiankeil
45 * Provide get_http_time() with the buffer size so it doesn't
46 * have to blindly assume that the buffer is big enough.
48 * Revision 1.104 2008/03/26 18:07:06 fabiankeil
49 * Add hostname directive. Closes PR#1918189.
51 * Revision 1.103 2008/03/21 11:13:57 fabiankeil
52 * Only gather host information if it's actually needed.
53 * Also move the code out of accept_connection() so it's less likely
54 * to delay other incoming connections if the host is misconfigured.
56 * Revision 1.102 2008/02/23 16:33:43 fabiankeil
57 * Let forward_url() use the standard parameter ordering
58 * and mark its second parameter immutable.
60 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
61 * Add SOCKS5 support for "Forwarding failure" CGI page.
63 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
64 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
67 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
68 * #1763173 from Stefan Huehner: declare some more functions static.
70 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
71 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
73 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
74 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
76 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
77 * Use sizeof() more often.
79 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
80 * Don't overlook map result for the forwarding-type.
82 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
83 * Use a transparent background for the PNG replacement pattern.
85 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
86 * - Save the reason for generating http_responses.
87 * - Fix --disable-toggle (again).
88 * - Use TBL birthday hack for 403 responses as well.
89 * - Uglify the @menu@ again to fix JavaScript
90 * errors on the "blocked" template.
91 * - Escape an ampersand in cgi_error_unknown().
93 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
94 * - Add HEAD support to finish_http_response.
95 * - Add error favicon to internal HTML error messages.
97 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
98 * Add new config option "templdir" to
99 * change the templates directory.
101 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
102 * Added "forwarding-failed" template support for error_response().
104 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
105 * Add favicon delivery functions.
107 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
108 * - Map variables that aren't guaranteed to be
109 * pure ASCII html_encoded.
110 * - Use CGI_PREFIX to generate URL for user manual
111 * CGI page to make sure CGI_SITE_2_PATH is included.
113 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
114 * - "Protect" against a rather lame JavaScript-based
115 * Privoxy detection "attack" and check the referrer
116 * before delivering the CGI style sheet.
117 * - Move referrer check for unsafe CGI pages into
118 * referrer_is_safe() and log the result.
119 * - Map @url@ in cgi-error-disabled page.
120 * It's required for the "go there anyway" link.
121 * - Mark *csp as immutable for grep_cgi_referrer().
123 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
124 * Fix strdup() error handling in cgi_error_unknown()
125 * and cgi_error_no_template(). Reported by Markus Elfring.
127 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
128 * Handle pcrs_execute() errors in template_fill() properly.
130 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
131 * Fixed gcc43 conversion warnings and replaced sprintf
132 * calls with snprintf to give OpenBSD's gcc one less reason
135 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
136 * Escape ampersand in Privoxy menu.
138 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
139 * Suppress the toggle link if remote toggling is disabled.
141 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
142 * Fix configure option --disable-toggle.
143 * Thanks to Peter Thoenen for reporting this.
145 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
146 * Don't lose the FORCE_PREFIX in case of
147 * connection problems. Fixes #612235.
149 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
150 * Make pthread mutex locking more generic. Instead of
151 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
152 * and use mutex locking unless there is an _r function
153 * available. Better safe than sorry.
155 * Fixes "./configure --disable-pthread" and should result
156 * in less threading-related problems on pthread-using platforms,
157 * but it still doesn't fix BR#1122404.
159 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
160 * Use CGI_PREFIX to check the referrer.
161 * The check for "http://config.privoxy.org/" fails
162 * if the user modified CGI_SITE_2_HOST.
164 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
165 * Adjusted headers for Privoxy's cgi responses:
166 * Don't set Last-Modified, Expires and Cache-Control
167 * headers for redirects; always set "Connection: close".
169 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
170 * Only predate the Last-Modified header for cgi responses
171 * that are delivered with status code 404 or 503.
173 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
174 * Mark cgi_send_user_manual as harmless,
175 * to fix the access denied problem Hal spotted.
176 * The manual has no secret content, therefore we
177 * don't have to care about "secure" referrers.
179 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
180 * Incorporate modified version of Roland Rosenfeld's patch to
181 * optionally access the user-manual via Privoxy. Closes patch 679075.
183 * Formatting changed to Privoxy style, added call to
184 * cgi_error_no_template if the requested file doesn't
185 * exist and modified check whether or not Privoxy itself
186 * should serve the manual. Should work cross-platform now.
188 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
189 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
191 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
192 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
193 * with what was really the latest development (the v_3_0_branch branch)
195 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
196 * Moved cgi_error_disabled() from cgiedit.c to
197 * cgi.c to re-enable build with --disable-editor.
198 * Fixes Bug #892744. Thanks to Matthew Fischer
201 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
202 * - Added new function cgi_redirect to handle creation of
203 * HTTP redirect messages formerly repeated in the code.
204 * - Send cgi_error_disabled instead of cgi_error_404 when
205 * referrer check fails
206 * - Dynamic content now gets Expires header field with date
209 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
210 * Bugfix: Transparent PNG was not transparent. Thanks to
211 * Dan Razzell of Starfish Systems for notice and new PNG.
213 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
214 * Security fix: dspatch_known_cgi no longer considers an empty
215 * referrer safe for critical CGIs, since malicious links could
216 * reside on https:// locations which browsers don't advertize as
217 * referrers. Closes bug #749916, thanks to Jeff Epler for the
218 * hint. Goodbye One-Click[tm] toggling :-(
220 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
223 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
224 * Killed a compiler warning on OSX
226 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
227 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
228 * (fixes bug #710056)
229 * - Show toggle info only if we have it
231 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
232 * Move declaration of struct tm dummy outside of a control block so it is
233 * accessible later on during snprintf in get_http_time.
235 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
236 * Cosmetic: Renamed cryptic variable
238 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
239 * 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.
241 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
242 * Disable access to critical CGIs via untrusted referrers.
243 * This prevents users from being tricked by malicious websites
244 * into making unintentional configuration changes:
246 * - Added flag to each cgi_dispatcher that allows or denies
248 * - Introduced proviorical function that greps for the
249 * referrer header before regular header parsing happens
250 * - Added safety check to dispatch_known_cgi. CGI is called
251 * if (cgi harmless || no referrer || we are referrer).
252 * Else a) toggle calls are modified not to change status and
253 * b) all other calls are denied.
255 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
256 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
258 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
259 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
261 * Revision 1.70 2002/05/19 11:33:20 jongfoster
262 * If a CGI error was not handled, and propogated back to
263 * dispatch_known_cgi(), then it was assumed to be "out of memory".
264 * This gave a very misleading error message.
266 * Now other errors will cause a simple message giving the error
267 * number and asking the user to report a bug.
270 * http://sourceforge.net/tracker/index.php?func=detail
271 * &aid=557905&group_id=11118&atid=111118
273 * Revision 1.69 2002/05/14 21:28:40 oes
274 * - Fixed add_help_link to link to the (now split) actions
275 * part of the config chapter
276 * - Renamed helplink export to actions-help-prefix
278 * Revision 1.68 2002/05/12 21:36:29 jongfoster
279 * Correcting function comments
281 * Revision 1.67 2002/04/30 12:02:07 oes
282 * Nit: updated a comment
284 * Revision 1.66 2002/04/26 18:32:57 jongfoster
285 * Fixing a memory leak on error
287 * Revision 1.65 2002/04/26 12:53:51 oes
288 * - New function add_help_link
289 * - default_exports now exports links to the user manual
290 * and a prefix for links into the config chapter
292 * Revision 1.64 2002/04/24 02:17:21 oes
293 * - Better descriptions for CGIs
294 * - Hide edit-actions, more shortcuts
295 * - Moved get_char_param, get_string_param and get_number_param here
298 * Revision 1.63 2002/04/15 19:06:43 jongfoster
301 * Revision 1.62 2002/04/10 19:59:46 jongfoster
302 * Fixes to #include in templates:
303 * - Didn't close main file if loading an included template fails.
304 * - I'm paranoid and want to disallow "#include /etc/passwd".
306 * Revision 1.61 2002/04/10 13:37:48 oes
307 * Made templates modular: template_load now recursive with max depth 1
309 * Revision 1.60 2002/04/08 20:50:25 swa
312 * Revision 1.59 2002/04/05 15:51:51 oes
313 * - added send-stylesheet CGI
314 * - bugfix: error-pages now get correct request protocol
316 * - kludged CGI descriptions and menu not to break JS syntax
318 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
319 * Fix Mac OSX compiler warnings
321 * Revision 1.57 2002/03/26 22:29:54 swa
322 * we have a new homepage!
324 * Revision 1.56 2002/03/24 17:50:46 jongfoster
325 * Fixing compile error if actions file editor disabled
327 * Revision 1.55 2002/03/24 16:55:06 oes
328 * Making GIF checkerboard transparent
330 * Revision 1.54 2002/03/24 16:18:15 jongfoster
333 * Revision 1.53 2002/03/24 16:06:00 oes
334 * Correct transparency for checkerboard PNG. Thanks, Magnus!
336 * Revision 1.52 2002/03/24 15:23:33 jongfoster
339 * Revision 1.51 2002/03/24 13:25:43 swa
340 * name change related issues
342 * Revision 1.50 2002/03/16 23:54:06 jongfoster
343 * Adding graceful termination feature, to help look for memory leaks.
344 * If you enable this (which, by design, has to be done by hand
345 * editing config.h) and then go to http://i.j.b/die, then the program
346 * will exit cleanly after the *next* request. It should free all the
347 * memory that was used.
349 * Revision 1.49 2002/03/13 00:27:04 jongfoster
352 * Revision 1.48 2002/03/08 17:47:07 jongfoster
355 * Revision 1.47 2002/03/08 16:41:33 oes
356 * Added GIF images again
358 * Revision 1.46 2002/03/07 03:48:38 oes
359 * - Changed built-in images from GIF to PNG
360 * (with regard to Unisys patent issue)
361 * - Added a 4x4 pattern PNG which is less intrusive
362 * than the logo but also clearly marks the deleted banners
364 * Revision 1.45 2002/03/06 22:54:35 jongfoster
365 * Automated function-comment nitpicking.
367 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
368 * - Better error reporting on OS/2
369 * - Fix double-slash comment (oops)
371 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
372 * - Re-enable OS/2 building after new parms were added
373 * - Fix false out of memory report when resolving CGI templates when no IP
374 * address is available of failed attempt (a la no such domain)
376 * Revision 1.42 2002/01/21 00:33:20 jongfoster
377 * Replacing strsav() with the safer string_append() or string_join().
378 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
379 * Adding missing html_encode() to error message generators.
380 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
382 * Revision 1.41 2002/01/17 20:56:22 jongfoster
383 * Replacing hard references to the URL of the config interface
384 * with #defines from project.h
386 * Revision 1.40 2002/01/09 14:26:46 oes
387 * Added support for thread-safe gmtime_r call.
389 * Revision 1.39 2001/11/16 00:48:13 jongfoster
390 * Fixing a compiler warning
392 * Revision 1.38 2001/11/13 00:31:21 jongfoster
393 * - Adding new CGIs for use by non-JavaScript browsers:
394 * edit-actions-url-form
395 * edit-actions-add-url-form
396 * edit-actions-remove-url-form
397 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
400 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
401 * Show enablement/disablement status in almost all templates.
402 * There is a little trickiness here: apparent recursive resolution of
403 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
404 * the actual enablement status. So a similar construct,
405 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
408 * Revision 1.36 2001/10/26 17:33:27 oes
411 * Revision 1.35 2001/10/23 21:48:19 jongfoster
412 * Cleaning up error handling in CGI functions - they now send back
413 * a HTML error page and should never cause a FATAL error. (Fixes one
414 * potential source of "denial of service" attacks).
416 * CGI actions file editor that works and is actually useful.
418 * Ability to toggle Junkbuster remotely using a CGI call.
420 * You can turn off both the above features in the main configuration
421 * file, e.g. if you are running a multi-user proxy.
423 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
424 * Only show "Local support" on templates conditionally:
425 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
426 * - if not, no Local support section appears
428 * Revision 1.33 2001/10/14 22:28:41 jongfoster
429 * Fixing stupid typo.
431 * Revision 1.32 2001/10/14 22:20:18 jongfoster
432 * - Changes to CGI dispatching method to match CGI names exactly,
433 * rather than doing a prefix match.
434 * - No longer need to count the length of the CGI handler names by hand.
435 * - Adding new handler for 404 error when disptching a CGI, if none of
436 * the handlers match.
437 * - Adding new handlers for CGI actionsfile editor.
439 * Revision 1.31 2001/10/10 10:56:39 oes
440 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
442 * Revision 1.30 2001/10/02 15:30:57 oes
443 * Introduced show-request cgi
445 * Revision 1.29 2001/09/20 15:47:44 steudten
447 * Fix BUG: Modify int size to size_t size in fill_template()
448 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
450 * Revision 1.28 2001/09/19 18:00:37 oes
451 * - Deletef time() FIXME (Can't fail under Linux either, if
452 * the argument is guaranteed to be in out address space,
455 * - Pointer notation cosmetics
456 * - Fixed a minor bug in template_fill(): Failiure of
457 * pcrs_execute() now secure.
459 * Revision 1.27 2001/09/16 17:08:54 jongfoster
460 * Moving simple CGI functions from cgi.c to new file cgisimple.c
462 * Revision 1.26 2001/09/16 15:47:37 jongfoster
463 * First version of CGI-based edit interface. This is very much a
464 * work-in-progress, and you can't actually use it to edit anything
465 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
466 * to have any effect.
468 * Revision 1.25 2001/09/16 15:02:35 jongfoster
469 * Adding i.j.b/robots.txt.
470 * Inlining add_stats() since it's only ever called from one place.
472 * Revision 1.24 2001/09/16 11:38:01 jongfoster
473 * Splitting fill_template() into 2 functions:
474 * template_load() loads the file
475 * template_fill() performs the PCRS regexps.
476 * This is because the CGI edit interface has a "table row"
477 * template which is used many times in the page - this
478 * change means it's only loaded from disk once.
480 * Revision 1.23 2001/09/16 11:16:05 jongfoster
481 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
483 * Revision 1.22 2001/09/16 11:00:10 jongfoster
484 * New function alloc_http_response, for symmetry with free_http_response
486 * Revision 1.21 2001/09/13 23:53:03 jongfoster
487 * Support for both static and dynamically generated CGI pages.
488 * Correctly setting Last-Modified: and Expires: HTTP headers.
490 * Revision 1.20 2001/09/13 23:40:36 jongfoster
491 * (Cosmetic only) Indentation correction
493 * Revision 1.19 2001/09/13 23:31:25 jongfoster
494 * Moving image data to cgi.c rather than cgi.h.
496 * Revision 1.18 2001/08/05 16:06:20 jongfoster
497 * Modifiying "struct map" so that there are now separate header and
498 * "map_entry" structures. This means that functions which modify a
499 * map no longer need to return a pointer to the modified map.
500 * Also, it no longer reverses the order of the entries (which may be
501 * important with some advanced template substitutions).
503 * Revision 1.17 2001/08/05 15:57:38 oes
504 * Adapted finish_http_response to new list_to_text
506 * Revision 1.16 2001/08/01 21:33:18 jongfoster
507 * Changes to fill_template() that reduce memory usage without having
508 * an impact on performance. I also renamed some variables so as not
509 * to clash with the C++ keywords "new" and "template".
511 * Revision 1.15 2001/08/01 21:19:22 jongfoster
512 * Moving file version information to a separate CGI page.
514 * Revision 1.14 2001/08/01 00:19:03 jongfoster
515 * New function: map_conditional() for an if-then-else syntax.
516 * Changing to use new version of show_defines()
518 * Revision 1.13 2001/07/30 22:08:36 jongfoster
519 * Tidying up #defines:
520 * - All feature #defines are now of the form FEATURE_xxx
521 * - Permanently turned off WIN_GUI_EDIT
522 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
524 * Revision 1.12 2001/07/29 18:47:05 jongfoster
525 * Adding missing #include "loadcfg.h"
527 * Revision 1.11 2001/07/18 17:24:37 oes
528 * Changed to conform to new pcrs interface
530 * Revision 1.10 2001/07/13 13:53:13 oes
531 * Removed all #ifdef PCRS and related code
533 * Revision 1.9 2001/06/29 21:45:41 oes
534 * Indentation, CRLF->LF, Tab-> Space
536 * Revision 1.8 2001/06/29 13:21:46 oes
537 * - Cosmetics: renamed and reordered functions, variables,
538 * texts, improved comments etc
540 * - Removed ij_untrusted_url() The relevant
541 * info is now part of the "untrusted" page,
542 * which is generated by filters.c:trust_url()
544 * - Generators of content now call finish_http_response()
545 * themselves, making jcc.c:chat() a little less
548 * - Removed obsolete "Pragma: no-cache" from our headers
550 * - http_responses now know their head length
552 * - fill_template now uses the new interface to pcrs, so that
553 * - long jobs (like whole files) no longer have to be assembled
554 * in a fixed size buffer
555 * - the new T (trivial) option is used, and the replacement may
556 * contain Perl syntax backrefs without confusing pcrs
558 * - Introduced default_exports() which generates a set of exports
559 * common to all CGIs and other content generators
561 * - Introduced convenience function map_block_killer()
563 * - Introduced convenience function make_menu()
565 * - Introduced CGI-like function error_response() which generates
566 * the "No such domain" and "Connect failed" messages using the
569 * - cgi_show_url_info:
570 * - adapted to new CGI features
571 * - form and answers now generated from same template
572 * - http:// prefix in URL now OK
575 * - adapted to new CGI features
576 * - no longer uses csp->init_proxy_args
579 * - moved menu generation to make_menu()
581 * - add_stats now writes single export map entries instead
584 * - Moved redirect_url() to filters.c
586 * - Fixed mem leak in free_http_response(), map_block_killer(),
588 * - Removed logentry from cancelled commit
590 * Revision 1.7 2001/06/09 10:51:58 jongfoster
591 * Changing "show URL info" handler to new style.
592 * Changing BUFSIZ ==> BUFFER_SIZE
594 * Revision 1.6 2001/06/07 23:05:19 jongfoster
595 * Removing code related to old forward and ACL files.
597 * Revision 1.5 2001/06/05 19:59:16 jongfoster
598 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
600 * Revision 1.4 2001/06/04 10:41:52 swa
601 * show version string of cgi.h and cgi.c
603 * Revision 1.3 2001/06/03 19:12:16 oes
604 * introduced new cgi handling
606 * No revisions before 1.3
608 **********************************************************************/
614 #include <sys/types.h>
628 #include "miscutil.h"
629 #include "cgisimple.h"
630 #include "jbsockets.h"
631 #ifdef FEATURE_CGI_EDIT_ACTIONS
633 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
635 /* loadcfg.h is for global_toggle_state only */
636 #ifdef FEATURE_PTHREAD
638 /* jcc.h is for mutex semaphore globals only */
639 #endif /* def FEATURE_PTHREAD */
640 const char cgi_h_rcs[] = CGI_H_VERSION;
643 * List of CGI functions: name, handler, description
644 * Note: Do NOT use single quotes in the description;
645 * this will break the dynamic "blocked" template!
647 static const struct cgi_dispatcher cgi_dispatchers[] = {
652 #ifdef FEATURE_GRACEFUL_TERMINATION
655 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
656 "this is a one click Denial Of Service attack!!!</em>",
661 #ifdef FEATURE_CGI_EDIT_ACTIONS
662 "View & change the current configuration",
664 "View the current configuration",
669 "View the source code version numbers",
673 "View the request headers.",
677 "Look up which actions apply to a URL and why",
679 #ifdef FEATURE_CGI_EDIT_ACTIONS
680 #ifdef FEATURE_TOGGLE
683 "Toggle Privoxy on or off",
685 #endif /* def FEATURE_TOGGLE */
686 { "edit-actions", /* Edit the actions list */
689 { "eaa", /* Shortcut for edit-actions-add-url-form */
690 cgi_edit_actions_add_url_form,
692 { "eau", /* Shortcut for edit-actions-url-form */
693 cgi_edit_actions_url_form,
695 { "ear", /* Shortcut for edit-actions-remove-url-form */
696 cgi_edit_actions_remove_url_form,
698 { "eal", /* Shortcut for edit-actions-list */
699 cgi_edit_actions_list,
701 { "eafu", /* Shortcut for edit-actions-for-url */
702 cgi_edit_actions_for_url,
704 { "eas", /* Shortcut for edit-actions-submit */
705 cgi_edit_actions_submit,
707 { "easa", /* Shortcut for edit-actions-section-add */
708 cgi_edit_actions_section_add,
710 { "easr", /* Shortcut for edit-actions-section-remove */
711 cgi_edit_actions_section_remove,
713 { "eass", /* Shortcut for edit-actions-section-swap */
714 cgi_edit_actions_section_swap,
716 { "edit-actions-for-url",
717 cgi_edit_actions_for_url,
718 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
719 { "edit-actions-list",
720 cgi_edit_actions_list,
721 NULL, TRUE /* Edit the actions list */ },
722 { "edit-actions-submit",
723 cgi_edit_actions_submit,
724 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
725 { "edit-actions-url",
726 cgi_edit_actions_url,
727 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
728 { "edit-actions-url-form",
729 cgi_edit_actions_url_form,
730 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
731 { "edit-actions-add-url",
732 cgi_edit_actions_add_url,
733 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
734 { "edit-actions-add-url-form",
735 cgi_edit_actions_add_url_form,
736 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
737 { "edit-actions-remove-url",
738 cgi_edit_actions_remove_url,
739 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
740 { "edit-actions-remove-url-form",
741 cgi_edit_actions_remove_url_form,
742 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
743 { "edit-actions-section-add",
744 cgi_edit_actions_section_add,
745 NULL, FALSE /* Remove a section from the actionsfile */ },
746 { "edit-actions-section-remove",
747 cgi_edit_actions_section_remove,
748 NULL, FALSE /* Remove a section from the actionsfile */ },
749 { "edit-actions-section-swap",
750 cgi_edit_actions_section_swap,
751 NULL, FALSE /* Swap two sections in the actionsfile */ },
752 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
753 { "error-favicon.ico",
754 cgi_send_error_favicon,
755 NULL, TRUE /* Sends the favicon image for error pages. */ },
757 cgi_send_default_favicon,
758 NULL, TRUE /* Sends the default favicon image. */ },
761 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
764 NULL, TRUE /* Send a built-in image */ },
767 NULL, FALSE /* Send templates/cgi-style.css */ },
769 cgi_transparent_image,
770 NULL, TRUE /* Send a transparent image (short name) */ },
772 cgi_send_user_manual,
773 NULL, TRUE /* Send user-manual */ },
774 { NULL, /* NULL Indicates end of list and default page */
776 NULL, TRUE /* Unknown CGI page */ }
781 * Built-in images for ad replacement
783 * Hint: You can encode your own images like this:
784 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
787 #ifdef FEATURE_NO_GIFS
790 * Checkerboard pattern, as a PNG.
792 const char image_pattern_data[] =
793 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
794 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
795 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
796 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
797 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
798 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
799 "\000\000\000\000\111\105\116\104\256\102\140\202";
802 * 1x1 transparant PNG.
804 const char image_blank_data[] =
805 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
806 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
807 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
808 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
809 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
810 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
811 "\000\000\000\000\111\105\116\104\256\102\140\202";
815 * Checkerboard pattern, as a GIF.
817 const char image_pattern_data[] =
818 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
819 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
820 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
821 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
825 * 1x1 transparant GIF.
827 const char image_blank_data[] =
828 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
829 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
830 "\000\001\000\000\002\002D\001\000;";
833 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
834 const size_t image_blank_length = sizeof(image_blank_data) - 1;
837 static struct http_response cgi_error_memory_response[1];
839 static struct http_response *dispatch_known_cgi(struct client_state * csp,
841 static struct map *parse_cgi_parameters(char *argstring);
844 /*********************************************************************
846 * Function : dispatch_cgi
848 * Description : Checks if a request URL has either the magical
849 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
850 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
851 * http://config.privoxy.org/). If so, it passes
852 * the (rest of the) path onto dispatch_known_cgi, which
853 * calls the relevant CGI handler function.
856 * 1 : csp = Current client state (buffers, headers, etc...)
858 * Returns : http_response if match, NULL if nonmatch or handler fail
860 *********************************************************************/
861 struct http_response *dispatch_cgi(struct client_state *csp)
863 const char *host = csp->http->host;
864 const char *path = csp->http->path;
867 * Should we intercept ?
870 /* Note: "example.com" and "example.com." are equivalent hostnames. */
872 /* Either the host matches CGI_SITE_1_HOST ..*/
873 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
874 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
875 && (path[0] == '/') )
877 /* ..then the path will all be for us. Remove leading '/' */
880 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
881 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
882 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
883 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
885 /* take everything following CGI_SITE_2_PATH */
886 path += strlen(CGI_SITE_2_PATH);
889 /* skip the forward slash after CGI_SITE_2_PATH */
892 else if (*path != '\0')
895 * weirdness: URL is /configXXX, where XXX is some string
896 * Do *NOT* intercept.
908 * This is a CGI call.
911 return dispatch_known_cgi(csp, path);
915 /*********************************************************************
917 * Function : grep_cgi_referrer
919 * Description : Ugly provisorical fix that greps the value of the
920 * referer HTTP header field out of a linked list of
921 * strings like found at csp->headers. Will disappear
924 * FIXME: csp->headers ought to be csp->http->headers
925 * FIXME: Parsing all client header lines should
926 * happen right after the request is received!
929 * 1 : csp = Current client state (buffers, headers, etc...)
931 * Returns : pointer to value (no copy!), or NULL if none found.
933 *********************************************************************/
934 static char *grep_cgi_referrer(const struct client_state *csp)
936 struct list_entry *p;
938 for (p = csp->headers->first; p != NULL; p = p->next)
940 if (p->str == NULL) continue;
941 if (strncmpic(p->str, "Referer: ", 9) == 0)
943 return ((p->str) + 9);
951 /*********************************************************************
953 * Function : referrer_is_safe
955 * Description : Decides whether we trust the Referer for
956 * CGI pages which are only meant to be reachable
957 * through Privoxy's web interface directly.
960 * 1 : csp = Current client state (buffers, headers, etc...)
962 * Returns : TRUE if the referrer is safe, or
963 * FALSE if the referrer is unsafe or not set.
965 *********************************************************************/
966 static int referrer_is_safe(const struct client_state *csp)
969 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
971 referrer = grep_cgi_referrer(csp);
973 if (NULL == referrer)
975 /* No referrer, no access */
976 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
979 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
980 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
982 /* Trustworthy referrer */
983 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
984 csp->http->url, referrer);
990 /* Untrustworthy referrer */
991 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
992 csp->http->url, referrer);
999 /*********************************************************************
1001 * Function : dispatch_known_cgi
1003 * Description : Processes a CGI once dispatch_cgi has determined that
1004 * it matches one of the magic prefixes. Parses the path
1005 * as a cgi name plus query string, prepares a map that
1006 * maps CGI parameter names to their values, initializes
1007 * the http_response struct, and calls the relevant CGI
1011 * 1 : csp = Current client state (buffers, headers, etc...)
1012 * 2 : path = Path of CGI, with the CGI prefix removed.
1013 * Should not have a leading "/".
1015 * Returns : http_response, or NULL on handler failure or out of
1018 *********************************************************************/
1019 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1022 const struct cgi_dispatcher *d;
1023 struct map *param_list;
1024 struct http_response *rsp;
1025 char *query_args_start;
1029 if (NULL == (path_copy = strdup(path)))
1031 return cgi_error_memory();
1033 query_args_start = path_copy;
1034 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1038 if (*query_args_start == '/')
1040 *query_args_start++ = '\0';
1041 if ((param_list = new_map()))
1043 map(param_list, "file", 1, url_decode(query_args_start), 0);
1048 if (*query_args_start == '?')
1050 *query_args_start++ = '\0';
1052 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1055 return cgi_error_memory();
1061 * path_copy = CGI call name
1062 * param_list = CGI params, as map
1065 /* Get mem for response or fail*/
1066 if (NULL == (rsp = alloc_http_response()))
1069 free_map(param_list);
1070 return cgi_error_memory();
1074 * Find and start the right CGI function
1076 d = cgi_dispatchers;
1079 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1082 * If the called CGI is either harmless, or referred
1083 * from a trusted source, start it.
1085 if (d->harmless || referrer_is_safe(csp))
1087 err = (d->handler)(csp, rsp, param_list);
1092 * Else, modify toggle calls so that they only display
1093 * the status, and deny all other calls.
1095 if (0 == strcmp(path_copy, "toggle"))
1097 unmap(param_list, "set");
1098 err = (d->handler)(csp, rsp, param_list);
1102 err = cgi_error_disabled(csp, rsp);
1107 free_map(param_list);
1109 if (err == JB_ERR_CGI_PARAMS)
1111 err = cgi_error_bad_param(csp, rsp);
1113 if (err && (err != JB_ERR_MEMORY))
1115 /* Unexpected error! Shouldn't get here */
1116 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1117 err = cgi_error_unknown(csp, rsp, err);
1122 rsp->reason = RSP_REASON_CGI_CALL;
1123 return finish_http_response(csp, rsp);
1127 /* Error in handler, probably out-of-memory */
1128 free_http_response(rsp);
1129 return cgi_error_memory();
1137 /*********************************************************************
1139 * Function : parse_cgi_parameters
1141 * Description : Parse a URL-encoded argument string into name/value
1142 * pairs and store them in a struct map list.
1145 * 1 : argstring = string to be parsed. Will be trashed.
1147 * Returns : pointer to param list, or NULL if out of memory.
1149 *********************************************************************/
1150 static struct map *parse_cgi_parameters(char *argstring)
1153 char *vector[BUFFER_SIZE];
1155 struct map *cgi_params;
1157 if (NULL == (cgi_params = new_map()))
1163 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1164 * the fragment identifier along with the request, so we must
1165 * cut it off here, so it won't pollute the CGI params:
1167 if (NULL != (p = strchr(argstring, '#')))
1172 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1174 for (i = 0; i < pairs; i++)
1176 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1179 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1181 free_map(cgi_params);
1192 /*********************************************************************
1194 * Function : get_char_param
1196 * Description : Get a single-character parameter passed to a CGI
1200 * 1 : parameters = map of cgi parameters
1201 * 2 : param_name = The name of the parameter to read
1203 * Returns : Uppercase character on success, '\0' on error.
1205 *********************************************************************/
1206 char get_char_param(const struct map *parameters,
1207 const char *param_name)
1214 ch = *(lookup(parameters, param_name));
1215 if ((ch >= 'a') && (ch <= 'z'))
1217 ch = (char)(ch - 'a' + 'A');
1224 /*********************************************************************
1226 * Function : get_string_param
1228 * Description : Get a string paramater, to be used as an
1229 * ACTION_STRING or ACTION_MULTI paramater.
1230 * Validates the input to prevent stupid/malicious
1231 * users from corrupting their action file.
1234 * 1 : parameters = map of cgi parameters
1235 * 2 : param_name = The name of the parameter to read
1236 * 3 : pparam = destination for paramater. Allocated as
1237 * part of the map "parameters", so don't free it.
1238 * Set to NULL if not specified.
1240 * Returns : JB_ERR_OK on success, or if the paramater
1241 * was not specified.
1242 * JB_ERR_MEMORY on out-of-memory.
1243 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1245 *********************************************************************/
1246 jb_err get_string_param(const struct map *parameters,
1247 const char *param_name,
1248 const char **pparam)
1260 param = lookup(parameters, param_name);
1266 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1271 * Note that the length limit is arbitrary, it just seems
1272 * sensible to limit it to *something*. There's no
1273 * technical reason for any limit at all.
1275 return JB_ERR_CGI_PARAMS;
1278 /* Check every character to see if it's legal */
1280 while ((ch = *s++) != '\0')
1282 if ( ((unsigned char)ch < (unsigned char)' ')
1285 /* Probable hack attempt, or user accidentally used '}'. */
1286 return JB_ERR_CGI_PARAMS;
1297 /*********************************************************************
1299 * Function : get_number_param
1301 * Description : Get a non-negative integer from the parameters
1302 * passed to a CGI function.
1305 * 1 : csp = Current client state (buffers, headers, etc...)
1306 * 2 : parameters = map of cgi parameters
1307 * 3 : name = Name of CGI parameter to read
1308 * 4 : pvalue = destination for value.
1309 * Set to -1 on error.
1311 * Returns : JB_ERR_OK on success
1312 * JB_ERR_MEMORY on out-of-memory
1313 * JB_ERR_CGI_PARAMS if the parameter was not specified
1316 *********************************************************************/
1317 jb_err get_number_param(struct client_state *csp,
1318 const struct map *parameters,
1333 param = lookup(parameters, name);
1336 return JB_ERR_CGI_PARAMS;
1339 /* We don't use atoi because I want to check this carefully... */
1342 while ((ch = *param++) != '\0')
1344 if ((ch < '0') || (ch > '9'))
1346 return JB_ERR_CGI_PARAMS;
1349 ch = (char)(ch - '0');
1353 * <limits.h> defines UINT_MAX
1355 * (UINT_MAX - ch) / 10 is the largest number that
1356 * can be safely multiplied by 10 then have ch added.
1358 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1360 return JB_ERR_CGI_PARAMS;
1363 value = value * 10 + (unsigned)ch;
1374 /*********************************************************************
1376 * Function : error_response
1378 * Description : returns an http_response that explains the reason
1379 * why a request failed.
1382 * 1 : csp = Current client state (buffers, headers, etc...)
1383 * 2 : templatename = Which template should be used for the answer
1384 * 3 : sys_err = system error number
1386 * Returns : A http_response. If we run out of memory, this
1387 * will be cgi_error_memory().
1389 *********************************************************************/
1390 struct http_response *error_response(struct client_state *csp,
1391 const char *templatename,
1395 struct http_response *rsp;
1396 struct map *exports = default_exports(csp, NULL);
1399 if (exports == NULL)
1401 return cgi_error_memory();
1404 if (NULL == (rsp = alloc_http_response()))
1407 return cgi_error_memory();
1410 #ifdef FEATURE_FORCE_LOAD
1411 if (csp->flags & CSP_FLAG_FORCED)
1413 path = strdup(FORCE_PREFIX);
1416 #endif /* def FEATURE_FORCE_LOAD */
1420 err = string_append(&path, csp->http->path);
1422 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1423 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1424 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1425 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1426 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1429 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1432 /* Some failures, like "404 no such domain", don't have an IP address. */
1433 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1441 free_http_response(rsp);
1442 return cgi_error_memory();
1445 if (!strcmp(templatename, "no-such-domain"))
1447 rsp->status = strdup("404 No such domain");
1448 if (rsp->status == NULL)
1451 free_http_response(rsp);
1452 return cgi_error_memory();
1454 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1456 else if (!strcmp(templatename, "forwarding-failed"))
1458 const struct forward_spec *fwd = forward_url(csp, csp->http);
1459 char *socks_type = NULL;
1462 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1463 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1467 * XXX: While the template is called forwarding-failed,
1468 * it currently only handles socks forwarding failures.
1470 assert(fwd->type != SOCKS_NONE);
1473 * Map failure reason, forwarding type and forwarder.
1475 if (NULL == csp->error_message)
1478 * Either we forgot to record the failure reason,
1479 * or the memory allocation failed.
1481 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1482 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1484 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1487 * XXX: this is almost the same code as in cgi_show_url_info()
1488 * and thus should be factored out and shared.
1493 socks_type = "socks4-";
1496 socks_type = "socks4a-";
1499 socks_type = "socks5-";
1502 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1505 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1506 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1508 if (!err) rsp->status = strdup("503 Forwarding failure");
1509 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1512 free_http_response(rsp);
1513 return cgi_error_memory();
1515 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1517 else if (!strcmp(templatename, "connect-failed"))
1519 rsp->status = strdup("503 Connect failed");
1520 if (rsp->status == NULL)
1523 free_http_response(rsp);
1524 return cgi_error_memory();
1526 rsp->reason = RSP_REASON_CONNECT_FAILED;
1529 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1532 free_http_response(rsp);
1533 return cgi_error_memory();
1536 return finish_http_response(csp, rsp);
1540 /*********************************************************************
1542 * Function : cgi_error_disabled
1544 * Description : CGI function that is called to generate an error
1545 * response if the actions editor or toggle CGI are
1546 * accessed despite having being disabled at compile-
1547 * or run-time, or if the user followed an untrusted link
1548 * to access a unsafe CGI feature that is only reachable
1549 * through Privoxy directly.
1552 * 1 : csp = Current client state (buffers, headers, etc...)
1553 * 2 : rsp = http_response data structure for output
1555 * CGI Parameters : none
1557 * Returns : JB_ERR_OK on success
1558 * JB_ERR_MEMORY on out-of-memory error.
1560 *********************************************************************/
1561 jb_err cgi_error_disabled(const struct client_state *csp,
1562 struct http_response *rsp)
1564 struct map *exports;
1569 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1571 return JB_ERR_MEMORY;
1573 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1575 /* Not important enough to do anything */
1576 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1579 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1583 /*********************************************************************
1585 * Function : cgi_init_error_messages
1587 * Description : Call at the start of the program to initialize
1588 * the error message used by cgi_error_memory().
1594 *********************************************************************/
1595 void cgi_init_error_messages(void)
1597 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1598 cgi_error_memory_response->head =
1599 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1600 "Content-Type: text/html\r\n"
1602 cgi_error_memory_response->body =
1605 " <title>500 Internal Privoxy Error</title>\r\n"
1606 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1609 "<h1>500 Internal Privoxy Error</h1>\r\n"
1610 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1611 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1615 cgi_error_memory_response->head_length =
1616 strlen(cgi_error_memory_response->head);
1617 cgi_error_memory_response->content_length =
1618 strlen(cgi_error_memory_response->body);
1619 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1623 /*********************************************************************
1625 * Function : cgi_error_memory
1627 * Description : Called if a CGI function runs out of memory.
1628 * Returns a statically-allocated error response.
1632 * Returns : http_response data structure for output. This is
1633 * statically allocated, for obvious reasons.
1635 *********************************************************************/
1636 struct http_response *cgi_error_memory(void)
1638 /* assert that it's been initialized. */
1639 assert(cgi_error_memory_response->head);
1641 return cgi_error_memory_response;
1645 /*********************************************************************
1647 * Function : cgi_error_no_template
1649 * Description : Almost-CGI function that is called if a template
1650 * cannot be loaded. Note this is not a true CGI,
1651 * it takes a template name rather than a map of
1655 * 1 : csp = Current client state (buffers, headers, etc...)
1656 * 2 : rsp = http_response data structure for output
1657 * 3 : template_name = Name of template that could not
1660 * Returns : JB_ERR_OK on success
1661 * JB_ERR_MEMORY on out-of-memory error.
1663 *********************************************************************/
1664 jb_err cgi_error_no_template(const struct client_state *csp,
1665 struct http_response *rsp,
1666 const char *template_name)
1668 static const char status[] =
1669 "500 Internal Privoxy Error";
1670 static const char body_prefix[] =
1673 " <title>500 Internal Privoxy Error</title>\r\n"
1674 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1677 "<h1>500 Internal Privoxy Error</h1>\r\n"
1678 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1679 "<p><b>Could not load template file <code>";
1680 static const char body_suffix[] =
1681 "</code> or one of its included components.</b></p>\r\n"
1682 "<p>Please contact your proxy administrator.</p>\r\n"
1683 "<p>If you are the proxy administrator, please put the required file(s)"
1684 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1685 "location of the <code><i>(confdir)</i></code> directory "
1686 "is specified in the main Privoxy <code>config</code> "
1687 "file. (It's typically the Privoxy install directory"
1689 ", or <code>/etc/privoxy/</code>"
1690 #endif /* ndef _WIN32 */
1694 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1698 assert(template_name);
1700 /* Reset rsp, if needed */
1704 rsp->content_length = 0;
1705 rsp->head_length = 0;
1708 rsp->body = malloc(body_size);
1709 if (rsp->body == NULL)
1711 return JB_ERR_MEMORY;
1713 strlcpy(rsp->body, body_prefix, body_size);
1714 strlcat(rsp->body, template_name, body_size);
1715 strlcat(rsp->body, body_suffix, body_size);
1717 rsp->status = strdup(status);
1718 if (rsp->status == NULL)
1720 return JB_ERR_MEMORY;
1727 /*********************************************************************
1729 * Function : cgi_error_unknown
1731 * Description : Almost-CGI function that is called if an unexpected
1732 * error occurs in the top-level CGI dispatcher.
1733 * In this context, "unexpected" means "anything other
1734 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1735 * expected to handle all other errors internally,
1736 * since they can give more relavent error messages
1739 * Note this is not a true CGI, it takes an error
1740 * code rather than a map of parameters.
1743 * 1 : csp = Current client state (buffers, headers, etc...)
1744 * 2 : rsp = http_response data structure for output
1745 * 3 : error_to_report = Error code to report.
1747 * Returns : JB_ERR_OK on success
1748 * JB_ERR_MEMORY on out-of-memory error.
1750 *********************************************************************/
1751 jb_err cgi_error_unknown(const struct client_state *csp,
1752 struct http_response *rsp,
1753 jb_err error_to_report)
1755 static const char status[] =
1756 "500 Internal Privoxy Error";
1757 static const char body_prefix[] =
1760 " <title>500 Internal Privoxy Error</title>\r\n"
1761 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1764 "<h1>500 Internal Privoxy Error</h1>\r\n"
1765 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1766 "<p><b>Unexpected internal error: ";
1767 static const char body_suffix[] =
1770 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1771 "file a bug report</a>.</p>\r\n"
1776 * Due to sizeof(errnumbuf), body_size will be slightly
1777 * bigger than necessary but it doesn't really matter.
1779 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1783 /* Reset rsp, if needed */
1787 rsp->content_length = 0;
1788 rsp->head_length = 0;
1790 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1792 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1794 rsp->body = malloc(body_size);
1795 if (rsp->body == NULL)
1797 return JB_ERR_MEMORY;
1799 strlcpy(rsp->body, body_prefix, body_size);
1800 strlcat(rsp->body, errnumbuf, body_size);
1801 strlcat(rsp->body, body_suffix, body_size);
1803 rsp->status = strdup(status);
1804 if (rsp->status == NULL)
1806 return JB_ERR_MEMORY;
1813 /*********************************************************************
1815 * Function : cgi_error_bad_param
1817 * Description : CGI function that is called if the parameters
1818 * (query string) for a CGI were wrong.
1821 * 1 : csp = Current client state (buffers, headers, etc...)
1822 * 2 : rsp = http_response data structure for output
1824 * CGI Parameters : none
1826 * Returns : JB_ERR_OK on success
1827 * JB_ERR_MEMORY on out-of-memory error.
1829 *********************************************************************/
1830 jb_err cgi_error_bad_param(const struct client_state *csp,
1831 struct http_response *rsp)
1833 struct map *exports;
1838 if (NULL == (exports = default_exports(csp, NULL)))
1840 return JB_ERR_MEMORY;
1843 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1847 /*********************************************************************
1849 * Function : cgi_redirect
1851 * Description : CGI support function to generate a HTTP redirect
1855 * 1 : rsp = http_response data structure for output
1856 * 2 : target = string with the target URL
1858 * CGI Parameters : None
1860 * Returns : JB_ERR_OK on success
1861 * JB_ERR_MEMORY on out-of-memory error.
1863 *********************************************************************/
1864 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1871 err = enlist_unique_header(rsp->headers, "Location", target);
1873 rsp->status = strdup("302 Local Redirect from Privoxy");
1874 if (rsp->status == NULL)
1876 return JB_ERR_MEMORY;
1883 /*********************************************************************
1885 * Function : add_help_link
1887 * Description : Produce a copy of the string given as item,
1888 * embedded in an HTML link to its corresponding
1889 * section (item name in uppercase) in the actions
1890 * chapter of the user manual, (whose URL is given in
1891 * the config and defaults to our web site).
1893 * FIXME: I currently only work for actions, and would
1894 * like to be generalized for other topics.
1897 * 1 : item = item (will NOT be free()d.)
1898 * It is assumed to be HTML-safe.
1899 * 2 : config = The current configuration.
1901 * Returns : String with item embedded in link, or NULL on
1904 *********************************************************************/
1905 char *add_help_link(const char *item,
1906 struct configuration_spec *config)
1910 if (!item) return NULL;
1912 result = strdup("<a href=\"");
1913 if (!strncmpic(config->usermanual, "file://", 7) ||
1914 !strncmpic(config->usermanual, "http", 4))
1916 string_append(&result, config->usermanual);
1920 string_append(&result, "http://");
1921 string_append(&result, CGI_SITE_2_HOST);
1922 string_append(&result, "/user-manual/");
1924 string_append(&result, ACTIONS_HELP_PREFIX);
1925 string_join (&result, string_toupper(item));
1926 string_append(&result, "\">");
1927 string_append(&result, item);
1928 string_append(&result, "</a> ");
1934 /*********************************************************************
1936 * Function : get_http_time
1938 * Description : Get the time in a format suitable for use in a
1939 * HTTP header - e.g.:
1940 * "Sun, 06 Nov 1994 08:49:37 GMT"
1943 * 1 : time_offset = Time returned will be current time
1944 * plus this number of seconds.
1945 * 2 : buf = Destination for result.
1946 * 3 : buffer_size = Size of the buffer above. Must be big
1947 * enough to hold 29 characters plus a
1952 *********************************************************************/
1953 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1955 static const char day_names[7][4] =
1956 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1957 static const char month_names[12][4] =
1958 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1959 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1962 time_t current_time;
1963 #if defined(HAVE_GMTIME_R)
1965 * Declare dummy up here (instead of inside get/set gmt block) so it
1966 * doesn't go out of scope before it's potentially used in snprintf later.
1967 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1968 * !defined HAVE_GMTIME_R.
1974 assert(buffer_size > 29);
1976 time(¤t_time); /* get current time */
1978 current_time += time_offset;
1980 /* get and save the gmt */
1983 t = gmtime_r(¤t_time, &dummy);
1984 #elif FEATURE_PTHREAD
1985 pthread_mutex_lock(&gmtime_mutex);
1986 t = gmtime(¤t_time);
1987 pthread_mutex_unlock(&gmtime_mutex);
1989 t = gmtime(¤t_time);
1993 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1994 snprintf(buf, buffer_size,
1995 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1996 day_names[t->tm_wday],
1998 month_names[t->tm_mon],
2008 /*********************************************************************
2010 * Function : finish_http_response
2012 * Description : Fill in the missing headers in an http response,
2013 * and flatten the headers to an http head.
2014 * For HEAD requests the body is freed once
2015 * the Content-Length header is set.
2018 * 1 : rsp = pointer to http_response to be processed
2020 * Returns : A http_response, usually the rsp parameter.
2021 * On error, free()s rsp and returns cgi_error_memory()
2023 *********************************************************************/
2024 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2026 char buf[BUFFER_SIZE];
2029 /* Special case - do NOT change this statically allocated response,
2030 * which is ready for output anyway.
2032 if (rsp == cgi_error_memory_response)
2038 * Fill in the HTTP Status, using HTTP/1.1
2039 * unless the client asked for HTTP/1.0.
2041 snprintf(buf, sizeof(buf), "%s %s",
2042 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2043 rsp->status ? rsp->status : "200 OK");
2044 err = enlist_first(rsp->headers, buf);
2047 * Set the Content-Length
2049 if (rsp->content_length == 0)
2051 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2055 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2056 err = enlist(rsp->headers, buf);
2059 if (0 == strcmpic(csp->http->gpc, "head"))
2062 * The client only asked for the head. Dispose
2063 * the body and log an offensive message.
2065 * While it may seem to be a bit inefficient to
2066 * prepare the body if it isn't needed, it's the
2067 * only way to get the Content-Length right for
2068 * dynamic pages. We could have disposed the body
2069 * earlier, but not without duplicating the
2070 * Content-Length setting code above.
2072 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2074 rsp->content_length = 0;
2077 if (strncmpic(rsp->status, "302", 3))
2080 * If it's not a redirect without any content,
2081 * set the Content-Type to text/html if it's
2082 * not already specified.
2084 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2088 * Fill in the rest of the default headers:
2090 * Date: set to current date/time.
2091 * Last-Modified: set to date/time the page was last changed.
2092 * Expires: set to date/time page next needs reloading.
2093 * Cache-Control: set to "no-cache" if applicable.
2095 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2100 * Set Expires to about 10 min into the future so it'll get reloaded
2101 * occasionally, e.g. if Privoxy gets upgraded.
2106 get_http_time(0, buf, sizeof(buf));
2107 err = enlist_unique_header(rsp->headers, "Date", buf);
2110 /* Some date in the past. */
2111 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2115 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
2116 err = enlist_unique_header(rsp->headers, "Expires", buf);
2119 else if (!strncmpic(rsp->status, "302", 3))
2121 get_http_time(0, buf, sizeof(buf));
2122 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2127 * Setting "Cache-Control" to "no-cache" and "Expires" to
2128 * the current time doesn't exactly forbid caching, it just
2129 * requires the client to revalidate the cached copy.
2131 * If a temporary problem occurs and the user tries again after
2132 * getting Privoxy's error message, a compliant browser may set the
2133 * If-Modified-Since header with the content of the error page's
2134 * Last-Modified header. More often than not, the document on the server
2135 * is older than Privoxy's error message, the server would send status code
2136 * 304 and the browser would display the outdated error message again and again.
2138 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2139 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2140 * and can be safely used to "revalidate" without getting a status code 304.
2142 * There is no need to let the useless If-Modified-Since header reach the
2143 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2145 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2147 get_http_time(0, buf, sizeof(buf));
2148 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2149 if (!strncmpic(rsp->status, "403", 3)
2150 || !strncmpic(rsp->status, "404", 3)
2151 || !strncmpic(rsp->status, "503", 3))
2153 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2157 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2159 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2160 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2166 * HTTP/1.1 applications that do not support persistent connections MUST
2167 * include the "close" connection option in every message.
2169 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2174 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2176 free_http_response(rsp);
2177 return cgi_error_memory();
2179 rsp->head_length = strlen(rsp->head);
2186 /*********************************************************************
2188 * Function : alloc_http_response
2190 * Description : Allocates a new http_response structure.
2194 * Returns : pointer to a new http_response, or NULL.
2196 *********************************************************************/
2197 struct http_response *alloc_http_response(void)
2199 return (struct http_response *) zalloc(sizeof(struct http_response));
2204 /*********************************************************************
2206 * Function : free_http_response
2208 * Description : Free the memory occupied by an http_response
2209 * and its depandant structures.
2212 * 1 : rsp = pointer to http_response to be freed
2216 *********************************************************************/
2217 void free_http_response(struct http_response *rsp)
2220 * Must special case cgi_error_memory_response, which is never freed.
2222 if (rsp && (rsp != cgi_error_memory_response))
2227 destroy_list(rsp->headers);
2234 /*********************************************************************
2236 * Function : template_load
2238 * Description : CGI support function that loads a given HTML
2239 * template, ignoring comment lines and following
2240 * #include statements up to a depth of 1.
2243 * 1 : csp = Current client state (buffers, headers, etc...)
2244 * 2 : template_ptr = Destination for pointer to loaded
2246 * 3 : templatename = name of the HTML template to be used
2247 * 4 : recursive = Flag set if this function calls itself
2248 * following an #include statament
2250 * Returns : JB_ERR_OK on success
2251 * JB_ERR_MEMORY on out-of-memory error.
2252 * JB_ERR_FILE if the template file cannot be read
2254 *********************************************************************/
2255 jb_err template_load(const struct client_state *csp, char **template_ptr,
2256 const char *templatename, int recursive)
2259 char *templates_dir_path;
2262 char *included_module;
2265 char buf[BUFFER_SIZE];
2268 assert(template_ptr);
2269 assert(templatename);
2271 *template_ptr = NULL;
2273 /* Validate template name. Paranoia. */
2274 for (p = templatename; *p != 0; p++)
2276 if ( ((*p < 'a') || (*p > 'z'))
2277 && ((*p < 'A') || (*p > 'Z'))
2278 && ((*p < '0') || (*p > '9'))
2282 /* Illegal character */
2288 * Generate full path using either templdir
2289 * or confdir/templates as base directory.
2291 if (NULL != csp->config->templdir)
2293 templates_dir_path = strdup(csp->config->templdir);
2297 templates_dir_path = make_path(csp->config->confdir, "templates");
2300 if (templates_dir_path == NULL)
2302 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2304 return JB_ERR_MEMORY;
2307 full_path = make_path(templates_dir_path, templatename);
2308 free(templates_dir_path);
2309 if (full_path == NULL)
2311 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2313 return JB_ERR_MEMORY;
2316 /* Allocate buffer */
2318 file_buffer = strdup("");
2319 if (file_buffer == NULL)
2321 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2323 return JB_ERR_MEMORY;
2326 /* Open template file */
2328 if (NULL == (fp = fopen(full_path, "r")))
2330 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2338 * Read the file, ignoring comments, and honoring #include
2339 * statements, unless we're already called recursively.
2341 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2342 * This is unlikely in practise.
2344 while (fgets(buf, BUFFER_SIZE, fp))
2346 if (!recursive && !strncmp(buf, "#include ", 9))
2348 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2355 if (string_join(&file_buffer, included_module))
2358 return JB_ERR_MEMORY;
2364 /* skip lines starting with '#' */
2370 if (string_append(&file_buffer, buf))
2373 return JB_ERR_MEMORY;
2378 *template_ptr = file_buffer;
2384 /*********************************************************************
2386 * Function : template_fill
2388 * Description : CGI support function that fills in a pre-loaded
2389 * HTML template by replacing @name@ with value using
2390 * pcrs, for each item in the output map.
2392 * Note that a leading '$' charachter in the export map's
2393 * values will be stripped and toggle on backreference
2397 * 1 : template_ptr = IN: Template to be filled out.
2399 * OUT: Filled out template.
2400 * Caller must free().
2401 * 2 : exports = map with fill in symbol -> name pairs
2403 * Returns : JB_ERR_OK on success (and for uncritical errors)
2404 * JB_ERR_MEMORY on out-of-memory error
2406 *********************************************************************/
2407 jb_err template_fill(char **template_ptr, const struct map *exports)
2409 struct map_entry *m;
2411 char buf[BUFFER_SIZE];
2412 char *tmp_out_buffer;
2418 assert(template_ptr);
2419 assert(*template_ptr);
2422 file_buffer = *template_ptr;
2423 size = strlen(file_buffer) + 1;
2426 * Assemble pcrs joblist from exports map
2428 for (m = exports->first; m != NULL; m = m->next)
2430 if (*m->name == '$')
2433 * First character of name is '$', so remove this flag
2434 * character and allow backreferences ($1 etc) in the
2435 * "replace with" text.
2437 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2443 * Treat the "replace with" text as a literal string -
2444 * no quoting needed, no backreferences allowed.
2445 * ("Trivial" ['T'] flag).
2449 /* Enclose name in @@ */
2450 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2454 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2456 /* Make and run job. */
2457 job = pcrs_compile(buf, m->value, flags, &error);
2460 if (error == PCRS_ERR_NOMEM)
2463 *template_ptr = NULL;
2464 return JB_ERR_MEMORY;
2468 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2469 /* Hope it wasn't important and silently ignore the invalid job */
2474 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2477 if (NULL == tmp_out_buffer)
2479 *template_ptr = NULL;
2480 return JB_ERR_MEMORY;
2486 * Substitution failed, keep the original buffer,
2487 * log the problem and ignore it.
2489 * The user might see some unresolved @CGI_VARIABLES@,
2490 * but returning a special CGI error page seems unreasonable
2491 * and could mask more important error messages.
2493 free(tmp_out_buffer);
2494 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2495 buf, m->value, flags, pcrs_strerror(error));
2499 /* Substitution succeeded, use modified buffer. */
2501 file_buffer = tmp_out_buffer;
2509 *template_ptr = file_buffer;
2514 /*********************************************************************
2516 * Function : template_fill_for_cgi
2518 * Description : CGI support function that loads a HTML template
2519 * and fills it in. Handles file-not-found errors
2520 * by sending a HTML error message. For convenience,
2521 * this function also frees the passed "exports" map.
2524 * 1 : csp = Client state
2525 * 2 : templatename = name of the HTML template to be used
2526 * 3 : exports = map with fill in symbol -> name pairs.
2527 * Will be freed by this function.
2528 * 4 : rsp = Response structure to fill in.
2530 * Returns : JB_ERR_OK on success
2531 * JB_ERR_MEMORY on out-of-memory error
2533 *********************************************************************/
2534 jb_err template_fill_for_cgi(const struct client_state *csp,
2535 const char *templatename,
2536 struct map *exports,
2537 struct http_response *rsp)
2542 assert(templatename);
2546 err = template_load(csp, &rsp->body, templatename, 0);
2547 if (err == JB_ERR_FILE)
2550 return cgi_error_no_template(csp, rsp, templatename);
2555 return err; /* JB_ERR_MEMORY */
2557 err = template_fill(&rsp->body, exports);
2563 /*********************************************************************
2565 * Function : default_exports
2567 * Description : returns a struct map list that contains exports
2568 * which are common to all CGI functions.
2571 * 1 : csp = Current client state (buffers, headers, etc...)
2572 * 2 : caller = name of CGI who calls us and which should
2573 * be excluded from the generated menu. May be
2575 * Returns : NULL if no memory, else a new map. Caller frees.
2577 *********************************************************************/
2578 struct map *default_exports(const struct client_state *csp, const char *caller)
2582 struct map * exports;
2583 int local_help_exists = 0;
2584 char *ip_address = NULL;
2585 char *hostname = NULL;
2589 exports = new_map();
2590 if (exports == NULL)
2595 if (csp->config->hostname)
2597 get_host_information(csp->cfd, &ip_address, NULL);
2598 hostname = strdup(csp->config->hostname);
2602 get_host_information(csp->cfd, &ip_address, &hostname);
2605 err = map(exports, "version", 1, html_encode(VERSION), 0);
2606 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2608 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2610 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2611 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2612 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2613 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2614 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2615 !strncmpic(csp->config->usermanual, "http", 4))
2617 /* Manual is located somewhere else, just link to it. */
2618 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2622 /* Manual is delivered by Privoxy. */
2623 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2625 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2626 #ifdef FEATURE_TOGGLE
2627 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2629 if (!err) err = map_block_killer(exports, "can-toggle");
2632 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2633 if (!err) err = map(exports, "my-port", 1, buf, 1);
2635 if(!strcmp(CODE_STATUS, "stable"))
2637 if (!err) err = map_block_killer(exports, "unstable");
2640 if (csp->config->admin_address != NULL)
2642 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2643 local_help_exists = 1;
2647 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2650 if (csp->config->proxy_info_url != NULL)
2652 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2653 local_help_exists = 1;
2657 if (!err) err = map_block_killer(exports, "have-proxy-info");
2660 if (local_help_exists == 0)
2662 if (!err) err = map_block_killer(exports, "have-help-info");
2675 /*********************************************************************
2677 * Function : map_block_killer
2679 * Description : Convenience function.
2680 * Adds a "killer" for the conditional HTML-template
2681 * block <name>, i.e. a substitution of the regex
2682 * "if-<name>-start.*if-<name>-end" to the given
2686 * 1 : exports = map to extend
2687 * 2 : name = name of conditional block
2689 * Returns : JB_ERR_OK on success
2690 * JB_ERR_MEMORY on out-of-memory error.
2692 *********************************************************************/
2693 jb_err map_block_killer(struct map *exports, const char *name)
2695 char buf[1000]; /* Will do, since the names are hardwired */
2699 assert(strlen(name) < 490);
2701 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2702 return map(exports, buf, 1, "", 1);
2706 /*********************************************************************
2708 * Function : map_block_keep
2710 * Description : Convenience function. Removes the markers used
2711 * by map-block-killer, to save a few bytes.
2712 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2715 * 1 : exports = map to extend
2716 * 2 : name = name of conditional block
2718 * Returns : JB_ERR_OK on success
2719 * JB_ERR_MEMORY on out-of-memory error.
2721 *********************************************************************/
2722 jb_err map_block_keep(struct map *exports, const char *name)
2725 char buf[500]; /* Will do, since the names are hardwired */
2729 assert(strlen(name) < 490);
2731 snprintf(buf, sizeof(buf), "if-%s-start", name);
2732 err = map(exports, buf, 1, "", 1);
2739 snprintf(buf, sizeof(buf), "if-%s-end", name);
2740 return map(exports, buf, 1, "", 1);
2744 /*********************************************************************
2746 * Function : map_conditional
2748 * Description : Convenience function.
2749 * Adds an "if-then-else" for the conditional HTML-template
2750 * block <name>, i.e. a substitution of the form:
2757 * The control structure and one of the alternatives
2761 * 1 : exports = map to extend
2762 * 2 : name = name of conditional block
2763 * 3 : choose_first = nonzero for first, zero for second.
2765 * Returns : JB_ERR_OK on success
2766 * JB_ERR_MEMORY on out-of-memory error.
2768 *********************************************************************/
2769 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2771 char buf[1000]; /* Will do, since the names are hardwired */
2776 assert(strlen(name) < 480);
2778 snprintf(buf, sizeof(buf), (choose_first
2779 ? "else-not-%s@.*@endif-%s"
2780 : "if-%s-then@.*@else-not-%s"),
2783 err = map(exports, buf, 1, "", 1);
2789 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2790 return map(exports, buf, 1, "", 1);
2794 /*********************************************************************
2796 * Function : make_menu
2798 * Description : Returns an HTML-formatted menu of the available
2799 * unhidden CGIs, excluding the one given in <self>
2800 * and the toggle CGI if toggling is disabled.
2803 * 1 : self = name of CGI to leave out, can be NULL for
2805 * 2 : feature_flags = feature bitmap from csp->config
2808 * Returns : menu string, or NULL on out-of-memory error.
2810 *********************************************************************/
2811 char *make_menu(const char *self, const unsigned feature_flags)
2813 const struct cgi_dispatcher *d;
2814 char *result = strdup("");
2818 self = "NO-SUCH-CGI!";
2821 /* List available unhidden CGI's and export as "other-cgis" */
2822 for (d = cgi_dispatchers; d->name; d++)
2825 #ifdef FEATURE_TOGGLE
2826 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2829 * Suppress the toggle link if remote toggling is disabled.
2833 #endif /* def FEATURE_TOGGLE */
2835 if (d->description && strcmp(d->name, self))
2837 char *html_encoded_prefix;
2840 * Line breaks would be great, but break
2841 * the "blocked" template's JavaScript.
2843 string_append(&result, "<li><a href=\"");
2844 html_encoded_prefix = html_encode(CGI_PREFIX);
2845 if (html_encoded_prefix == NULL)
2851 string_append(&result, html_encoded_prefix);
2852 free(html_encoded_prefix);
2854 string_append(&result, d->name);
2855 string_append(&result, "\">");
2856 string_append(&result, d->description);
2857 string_append(&result, "</a></li>");
2865 /*********************************************************************
2867 * Function : dump_map
2869 * Description : HTML-dump a map for debugging (as table)
2872 * 1 : the_map = map to dump
2874 * Returns : string with HTML
2876 *********************************************************************/
2877 char *dump_map(const struct map *the_map)
2879 struct map_entry *cur_entry;
2880 char *ret = strdup("");
2882 string_append(&ret, "<table>\n");
2884 for (cur_entry = the_map->first;
2885 (cur_entry != NULL) && (ret != NULL);
2886 cur_entry = cur_entry->next)
2888 string_append(&ret, "<tr><td><b>");
2889 string_join (&ret, html_encode(cur_entry->name));
2890 string_append(&ret, "</b></td><td>");
2891 string_join (&ret, html_encode(cur_entry->value));
2892 string_append(&ret, "</td></tr>\n");
2895 string_append(&ret, "</table>\n");