1 const char cgi_rcs[] = "$Id: cgi.c,v 1.105 2008/04/17 14:40:47 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.105 2008/04/17 14:40:47 fabiankeil
42 * Provide get_http_time() with the buffer size so it doesn't
43 * have to blindly assume that the buffer is big enough.
45 * Revision 1.104 2008/03/26 18:07:06 fabiankeil
46 * Add hostname directive. Closes PR#1918189.
48 * Revision 1.103 2008/03/21 11:13:57 fabiankeil
49 * Only gather host information if it's actually needed.
50 * Also move the code out of accept_connection() so it's less likely
51 * to delay other incoming connections if the host is misconfigured.
53 * Revision 1.102 2008/02/23 16:33:43 fabiankeil
54 * Let forward_url() use the standard parameter ordering
55 * and mark its second parameter immutable.
57 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
58 * Add SOCKS5 support for "Forwarding failure" CGI page.
60 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
61 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
64 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
65 * #1763173 from Stefan Huehner: declare some more functions static.
67 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
68 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
70 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
71 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
73 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
74 * Use sizeof() more often.
76 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
77 * Don't overlook map result for the forwarding-type.
79 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
80 * Use a transparent background for the PNG replacement pattern.
82 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
83 * - Save the reason for generating http_responses.
84 * - Fix --disable-toggle (again).
85 * - Use TBL birthday hack for 403 responses as well.
86 * - Uglify the @menu@ again to fix JavaScript
87 * errors on the "blocked" template.
88 * - Escape an ampersand in cgi_error_unknown().
90 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
91 * - Add HEAD support to finish_http_response.
92 * - Add error favicon to internal HTML error messages.
94 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
95 * Add new config option "templdir" to
96 * change the templates directory.
98 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
99 * Added "forwarding-failed" template support for error_response().
101 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
102 * Add favicon delivery functions.
104 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
105 * - Map variables that aren't guaranteed to be
106 * pure ASCII html_encoded.
107 * - Use CGI_PREFIX to generate URL for user manual
108 * CGI page to make sure CGI_SITE_2_PATH is included.
110 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
111 * - "Protect" against a rather lame JavaScript-based
112 * Privoxy detection "attack" and check the referrer
113 * before delivering the CGI style sheet.
114 * - Move referrer check for unsafe CGI pages into
115 * referrer_is_safe() and log the result.
116 * - Map @url@ in cgi-error-disabled page.
117 * It's required for the "go there anyway" link.
118 * - Mark *csp as immutable for grep_cgi_referrer().
120 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
121 * Fix strdup() error handling in cgi_error_unknown()
122 * and cgi_error_no_template(). Reported by Markus Elfring.
124 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
125 * Handle pcrs_execute() errors in template_fill() properly.
127 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
128 * Fixed gcc43 conversion warnings and replaced sprintf
129 * calls with snprintf to give OpenBSD's gcc one less reason
132 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
133 * Escape ampersand in Privoxy menu.
135 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
136 * Suppress the toggle link if remote toggling is disabled.
138 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
139 * Fix configure option --disable-toggle.
140 * Thanks to Peter Thoenen for reporting this.
142 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
143 * Don't lose the FORCE_PREFIX in case of
144 * connection problems. Fixes #612235.
146 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
147 * Make pthread mutex locking more generic. Instead of
148 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
149 * and use mutex locking unless there is an _r function
150 * available. Better safe than sorry.
152 * Fixes "./configure --disable-pthread" and should result
153 * in less threading-related problems on pthread-using platforms,
154 * but it still doesn't fix BR#1122404.
156 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
157 * Use CGI_PREFIX to check the referrer.
158 * The check for "http://config.privoxy.org/" fails
159 * if the user modified CGI_SITE_2_HOST.
161 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
162 * Adjusted headers for Privoxy's cgi responses:
163 * Don't set Last-Modified, Expires and Cache-Control
164 * headers for redirects; always set "Connection: close".
166 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
167 * Only predate the Last-Modified header for cgi responses
168 * that are delivered with status code 404 or 503.
170 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
171 * Mark cgi_send_user_manual as harmless,
172 * to fix the access denied problem Hal spotted.
173 * The manual has no secret content, therefore we
174 * don't have to care about "secure" referrers.
176 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
177 * Incorporate modified version of Roland Rosenfeld's patch to
178 * optionally access the user-manual via Privoxy. Closes patch 679075.
180 * Formatting changed to Privoxy style, added call to
181 * cgi_error_no_template if the requested file doesn't
182 * exist and modified check whether or not Privoxy itself
183 * should serve the manual. Should work cross-platform now.
185 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
186 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
188 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
189 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
190 * with what was really the latest development (the v_3_0_branch branch)
192 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
193 * Moved cgi_error_disabled() from cgiedit.c to
194 * cgi.c to re-enable build with --disable-editor.
195 * Fixes Bug #892744. Thanks to Matthew Fischer
198 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
199 * - Added new function cgi_redirect to handle creation of
200 * HTTP redirect messages formerly repeated in the code.
201 * - Send cgi_error_disabled instead of cgi_error_404 when
202 * referrer check fails
203 * - Dynamic content now gets Expires header field with date
206 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
207 * Bugfix: Transparent PNG was not transparent. Thanks to
208 * Dan Razzell of Starfish Systems for notice and new PNG.
210 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
211 * Security fix: dspatch_known_cgi no longer considers an empty
212 * referrer safe for critical CGIs, since malicious links could
213 * reside on https:// locations which browsers don't advertize as
214 * referrers. Closes bug #749916, thanks to Jeff Epler for the
215 * hint. Goodbye One-Click[tm] toggling :-(
217 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
220 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
221 * Killed a compiler warning on OSX
223 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
224 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
225 * (fixes bug #710056)
226 * - Show toggle info only if we have it
228 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
229 * Move declaration of struct tm dummy outside of a control block so it is
230 * accessible later on during snprintf in get_http_time.
232 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
233 * Cosmetic: Renamed cryptic variable
235 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
236 * 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.
238 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
239 * Disable access to critical CGIs via untrusted referrers.
240 * This prevents users from being tricked by malicious websites
241 * into making unintentional configuration changes:
243 * - Added flag to each cgi_dispatcher that allows or denies
245 * - Introduced proviorical function that greps for the
246 * referrer header before regular header parsing happens
247 * - Added safety check to dispatch_known_cgi. CGI is called
248 * if (cgi harmless || no referrer || we are referrer).
249 * Else a) toggle calls are modified not to change status and
250 * b) all other calls are denied.
252 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
253 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
255 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
256 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
258 * Revision 1.70 2002/05/19 11:33:20 jongfoster
259 * If a CGI error was not handled, and propogated back to
260 * dispatch_known_cgi(), then it was assumed to be "out of memory".
261 * This gave a very misleading error message.
263 * Now other errors will cause a simple message giving the error
264 * number and asking the user to report a bug.
267 * http://sourceforge.net/tracker/index.php?func=detail
268 * &aid=557905&group_id=11118&atid=111118
270 * Revision 1.69 2002/05/14 21:28:40 oes
271 * - Fixed add_help_link to link to the (now split) actions
272 * part of the config chapter
273 * - Renamed helplink export to actions-help-prefix
275 * Revision 1.68 2002/05/12 21:36:29 jongfoster
276 * Correcting function comments
278 * Revision 1.67 2002/04/30 12:02:07 oes
279 * Nit: updated a comment
281 * Revision 1.66 2002/04/26 18:32:57 jongfoster
282 * Fixing a memory leak on error
284 * Revision 1.65 2002/04/26 12:53:51 oes
285 * - New function add_help_link
286 * - default_exports now exports links to the user manual
287 * and a prefix for links into the config chapter
289 * Revision 1.64 2002/04/24 02:17:21 oes
290 * - Better descriptions for CGIs
291 * - Hide edit-actions, more shortcuts
292 * - Moved get_char_param, get_string_param and get_number_param here
295 * Revision 1.63 2002/04/15 19:06:43 jongfoster
298 * Revision 1.62 2002/04/10 19:59:46 jongfoster
299 * Fixes to #include in templates:
300 * - Didn't close main file if loading an included template fails.
301 * - I'm paranoid and want to disallow "#include /etc/passwd".
303 * Revision 1.61 2002/04/10 13:37:48 oes
304 * Made templates modular: template_load now recursive with max depth 1
306 * Revision 1.60 2002/04/08 20:50:25 swa
309 * Revision 1.59 2002/04/05 15:51:51 oes
310 * - added send-stylesheet CGI
311 * - bugfix: error-pages now get correct request protocol
313 * - kludged CGI descriptions and menu not to break JS syntax
315 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
316 * Fix Mac OSX compiler warnings
318 * Revision 1.57 2002/03/26 22:29:54 swa
319 * we have a new homepage!
321 * Revision 1.56 2002/03/24 17:50:46 jongfoster
322 * Fixing compile error if actions file editor disabled
324 * Revision 1.55 2002/03/24 16:55:06 oes
325 * Making GIF checkerboard transparent
327 * Revision 1.54 2002/03/24 16:18:15 jongfoster
330 * Revision 1.53 2002/03/24 16:06:00 oes
331 * Correct transparency for checkerboard PNG. Thanks, Magnus!
333 * Revision 1.52 2002/03/24 15:23:33 jongfoster
336 * Revision 1.51 2002/03/24 13:25:43 swa
337 * name change related issues
339 * Revision 1.50 2002/03/16 23:54:06 jongfoster
340 * Adding graceful termination feature, to help look for memory leaks.
341 * If you enable this (which, by design, has to be done by hand
342 * editing config.h) and then go to http://i.j.b/die, then the program
343 * will exit cleanly after the *next* request. It should free all the
344 * memory that was used.
346 * Revision 1.49 2002/03/13 00:27:04 jongfoster
349 * Revision 1.48 2002/03/08 17:47:07 jongfoster
352 * Revision 1.47 2002/03/08 16:41:33 oes
353 * Added GIF images again
355 * Revision 1.46 2002/03/07 03:48:38 oes
356 * - Changed built-in images from GIF to PNG
357 * (with regard to Unisys patent issue)
358 * - Added a 4x4 pattern PNG which is less intrusive
359 * than the logo but also clearly marks the deleted banners
361 * Revision 1.45 2002/03/06 22:54:35 jongfoster
362 * Automated function-comment nitpicking.
364 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
365 * - Better error reporting on OS/2
366 * - Fix double-slash comment (oops)
368 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
369 * - Re-enable OS/2 building after new parms were added
370 * - Fix false out of memory report when resolving CGI templates when no IP
371 * address is available of failed attempt (a la no such domain)
373 * Revision 1.42 2002/01/21 00:33:20 jongfoster
374 * Replacing strsav() with the safer string_append() or string_join().
375 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
376 * Adding missing html_encode() to error message generators.
377 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
379 * Revision 1.41 2002/01/17 20:56:22 jongfoster
380 * Replacing hard references to the URL of the config interface
381 * with #defines from project.h
383 * Revision 1.40 2002/01/09 14:26:46 oes
384 * Added support for thread-safe gmtime_r call.
386 * Revision 1.39 2001/11/16 00:48:13 jongfoster
387 * Fixing a compiler warning
389 * Revision 1.38 2001/11/13 00:31:21 jongfoster
390 * - Adding new CGIs for use by non-JavaScript browsers:
391 * edit-actions-url-form
392 * edit-actions-add-url-form
393 * edit-actions-remove-url-form
394 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
397 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
398 * Show enablement/disablement status in almost all templates.
399 * There is a little trickiness here: apparent recursive resolution of
400 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
401 * the actual enablement status. So a similar construct,
402 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
405 * Revision 1.36 2001/10/26 17:33:27 oes
408 * Revision 1.35 2001/10/23 21:48:19 jongfoster
409 * Cleaning up error handling in CGI functions - they now send back
410 * a HTML error page and should never cause a FATAL error. (Fixes one
411 * potential source of "denial of service" attacks).
413 * CGI actions file editor that works and is actually useful.
415 * Ability to toggle Junkbuster remotely using a CGI call.
417 * You can turn off both the above features in the main configuration
418 * file, e.g. if you are running a multi-user proxy.
420 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
421 * Only show "Local support" on templates conditionally:
422 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
423 * - if not, no Local support section appears
425 * Revision 1.33 2001/10/14 22:28:41 jongfoster
426 * Fixing stupid typo.
428 * Revision 1.32 2001/10/14 22:20:18 jongfoster
429 * - Changes to CGI dispatching method to match CGI names exactly,
430 * rather than doing a prefix match.
431 * - No longer need to count the length of the CGI handler names by hand.
432 * - Adding new handler for 404 error when disptching a CGI, if none of
433 * the handlers match.
434 * - Adding new handlers for CGI actionsfile editor.
436 * Revision 1.31 2001/10/10 10:56:39 oes
437 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
439 * Revision 1.30 2001/10/02 15:30:57 oes
440 * Introduced show-request cgi
442 * Revision 1.29 2001/09/20 15:47:44 steudten
444 * Fix BUG: Modify int size to size_t size in fill_template()
445 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
447 * Revision 1.28 2001/09/19 18:00:37 oes
448 * - Deletef time() FIXME (Can't fail under Linux either, if
449 * the argument is guaranteed to be in out address space,
452 * - Pointer notation cosmetics
453 * - Fixed a minor bug in template_fill(): Failiure of
454 * pcrs_execute() now secure.
456 * Revision 1.27 2001/09/16 17:08:54 jongfoster
457 * Moving simple CGI functions from cgi.c to new file cgisimple.c
459 * Revision 1.26 2001/09/16 15:47:37 jongfoster
460 * First version of CGI-based edit interface. This is very much a
461 * work-in-progress, and you can't actually use it to edit anything
462 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
463 * to have any effect.
465 * Revision 1.25 2001/09/16 15:02:35 jongfoster
466 * Adding i.j.b/robots.txt.
467 * Inlining add_stats() since it's only ever called from one place.
469 * Revision 1.24 2001/09/16 11:38:01 jongfoster
470 * Splitting fill_template() into 2 functions:
471 * template_load() loads the file
472 * template_fill() performs the PCRS regexps.
473 * This is because the CGI edit interface has a "table row"
474 * template which is used many times in the page - this
475 * change means it's only loaded from disk once.
477 * Revision 1.23 2001/09/16 11:16:05 jongfoster
478 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
480 * Revision 1.22 2001/09/16 11:00:10 jongfoster
481 * New function alloc_http_response, for symmetry with free_http_response
483 * Revision 1.21 2001/09/13 23:53:03 jongfoster
484 * Support for both static and dynamically generated CGI pages.
485 * Correctly setting Last-Modified: and Expires: HTTP headers.
487 * Revision 1.20 2001/09/13 23:40:36 jongfoster
488 * (Cosmetic only) Indentation correction
490 * Revision 1.19 2001/09/13 23:31:25 jongfoster
491 * Moving image data to cgi.c rather than cgi.h.
493 * Revision 1.18 2001/08/05 16:06:20 jongfoster
494 * Modifiying "struct map" so that there are now separate header and
495 * "map_entry" structures. This means that functions which modify a
496 * map no longer need to return a pointer to the modified map.
497 * Also, it no longer reverses the order of the entries (which may be
498 * important with some advanced template substitutions).
500 * Revision 1.17 2001/08/05 15:57:38 oes
501 * Adapted finish_http_response to new list_to_text
503 * Revision 1.16 2001/08/01 21:33:18 jongfoster
504 * Changes to fill_template() that reduce memory usage without having
505 * an impact on performance. I also renamed some variables so as not
506 * to clash with the C++ keywords "new" and "template".
508 * Revision 1.15 2001/08/01 21:19:22 jongfoster
509 * Moving file version information to a separate CGI page.
511 * Revision 1.14 2001/08/01 00:19:03 jongfoster
512 * New function: map_conditional() for an if-then-else syntax.
513 * Changing to use new version of show_defines()
515 * Revision 1.13 2001/07/30 22:08:36 jongfoster
516 * Tidying up #defines:
517 * - All feature #defines are now of the form FEATURE_xxx
518 * - Permanently turned off WIN_GUI_EDIT
519 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
521 * Revision 1.12 2001/07/29 18:47:05 jongfoster
522 * Adding missing #include "loadcfg.h"
524 * Revision 1.11 2001/07/18 17:24:37 oes
525 * Changed to conform to new pcrs interface
527 * Revision 1.10 2001/07/13 13:53:13 oes
528 * Removed all #ifdef PCRS and related code
530 * Revision 1.9 2001/06/29 21:45:41 oes
531 * Indentation, CRLF->LF, Tab-> Space
533 * Revision 1.8 2001/06/29 13:21:46 oes
534 * - Cosmetics: renamed and reordered functions, variables,
535 * texts, improved comments etc
537 * - Removed ij_untrusted_url() The relevant
538 * info is now part of the "untrusted" page,
539 * which is generated by filters.c:trust_url()
541 * - Generators of content now call finish_http_response()
542 * themselves, making jcc.c:chat() a little less
545 * - Removed obsolete "Pragma: no-cache" from our headers
547 * - http_responses now know their head length
549 * - fill_template now uses the new interface to pcrs, so that
550 * - long jobs (like whole files) no longer have to be assembled
551 * in a fixed size buffer
552 * - the new T (trivial) option is used, and the replacement may
553 * contain Perl syntax backrefs without confusing pcrs
555 * - Introduced default_exports() which generates a set of exports
556 * common to all CGIs and other content generators
558 * - Introduced convenience function map_block_killer()
560 * - Introduced convenience function make_menu()
562 * - Introduced CGI-like function error_response() which generates
563 * the "No such domain" and "Connect failed" messages using the
566 * - cgi_show_url_info:
567 * - adapted to new CGI features
568 * - form and answers now generated from same template
569 * - http:// prefix in URL now OK
572 * - adapted to new CGI features
573 * - no longer uses csp->init_proxy_args
576 * - moved menu generation to make_menu()
578 * - add_stats now writes single export map entries instead
581 * - Moved redirect_url() to filters.c
583 * - Fixed mem leak in free_http_response(), map_block_killer(),
585 * - Removed logentry from cancelled commit
587 * Revision 1.7 2001/06/09 10:51:58 jongfoster
588 * Changing "show URL info" handler to new style.
589 * Changing BUFSIZ ==> BUFFER_SIZE
591 * Revision 1.6 2001/06/07 23:05:19 jongfoster
592 * Removing code related to old forward and ACL files.
594 * Revision 1.5 2001/06/05 19:59:16 jongfoster
595 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
597 * Revision 1.4 2001/06/04 10:41:52 swa
598 * show version string of cgi.h and cgi.c
600 * Revision 1.3 2001/06/03 19:12:16 oes
601 * introduced new cgi handling
603 * No revisions before 1.3
605 **********************************************************************/
611 #include <sys/types.h>
625 #include "miscutil.h"
626 #include "cgisimple.h"
627 #include "jbsockets.h"
628 #ifdef FEATURE_CGI_EDIT_ACTIONS
630 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
632 /* loadcfg.h is for global_toggle_state only */
633 #ifdef FEATURE_PTHREAD
635 /* jcc.h is for mutex semaphore globals only */
636 #endif /* def FEATURE_PTHREAD */
637 const char cgi_h_rcs[] = CGI_H_VERSION;
640 * List of CGI functions: name, handler, description
641 * Note: Do NOT use single quotes in the description;
642 * this will break the dynamic "blocked" template!
644 static const struct cgi_dispatcher cgi_dispatchers[] = {
649 #ifdef FEATURE_GRACEFUL_TERMINATION
652 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
653 "this is a one click Denial Of Service attack!!!</em>",
658 #ifdef FEATURE_CGI_EDIT_ACTIONS
659 "View & change the current configuration",
661 "View the current configuration",
666 "View the source code version numbers",
670 "View the request headers.",
674 "Look up which actions apply to a URL and why",
676 #ifdef FEATURE_CGI_EDIT_ACTIONS
677 #ifdef FEATURE_TOGGLE
680 "Toggle Privoxy on or off",
682 #endif /* def FEATURE_TOGGLE */
683 { "edit-actions", /* Edit the actions list */
686 { "eaa", /* Shortcut for edit-actions-add-url-form */
687 cgi_edit_actions_add_url_form,
689 { "eau", /* Shortcut for edit-actions-url-form */
690 cgi_edit_actions_url_form,
692 { "ear", /* Shortcut for edit-actions-remove-url-form */
693 cgi_edit_actions_remove_url_form,
695 { "eal", /* Shortcut for edit-actions-list */
696 cgi_edit_actions_list,
698 { "eafu", /* Shortcut for edit-actions-for-url */
699 cgi_edit_actions_for_url,
701 { "eas", /* Shortcut for edit-actions-submit */
702 cgi_edit_actions_submit,
704 { "easa", /* Shortcut for edit-actions-section-add */
705 cgi_edit_actions_section_add,
707 { "easr", /* Shortcut for edit-actions-section-remove */
708 cgi_edit_actions_section_remove,
710 { "eass", /* Shortcut for edit-actions-section-swap */
711 cgi_edit_actions_section_swap,
713 { "edit-actions-for-url",
714 cgi_edit_actions_for_url,
715 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
716 { "edit-actions-list",
717 cgi_edit_actions_list,
718 NULL, TRUE /* Edit the actions list */ },
719 { "edit-actions-submit",
720 cgi_edit_actions_submit,
721 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
722 { "edit-actions-url",
723 cgi_edit_actions_url,
724 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
725 { "edit-actions-url-form",
726 cgi_edit_actions_url_form,
727 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
728 { "edit-actions-add-url",
729 cgi_edit_actions_add_url,
730 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
731 { "edit-actions-add-url-form",
732 cgi_edit_actions_add_url_form,
733 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
734 { "edit-actions-remove-url",
735 cgi_edit_actions_remove_url,
736 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
737 { "edit-actions-remove-url-form",
738 cgi_edit_actions_remove_url_form,
739 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
740 { "edit-actions-section-add",
741 cgi_edit_actions_section_add,
742 NULL, FALSE /* Remove a section from the actionsfile */ },
743 { "edit-actions-section-remove",
744 cgi_edit_actions_section_remove,
745 NULL, FALSE /* Remove a section from the actionsfile */ },
746 { "edit-actions-section-swap",
747 cgi_edit_actions_section_swap,
748 NULL, FALSE /* Swap two sections in the actionsfile */ },
749 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
750 { "error-favicon.ico",
751 cgi_send_error_favicon,
752 NULL, TRUE /* Sends the favicon image for error pages. */ },
754 cgi_send_default_favicon,
755 NULL, TRUE /* Sends the default favicon image. */ },
758 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
761 NULL, TRUE /* Send a built-in image */ },
764 NULL, FALSE /* Send templates/cgi-style.css */ },
766 cgi_transparent_image,
767 NULL, TRUE /* Send a transparent image (short name) */ },
769 cgi_send_user_manual,
770 NULL, TRUE /* Send user-manual */ },
771 { NULL, /* NULL Indicates end of list and default page */
773 NULL, TRUE /* Unknown CGI page */ }
778 * Built-in images for ad replacement
780 * Hint: You can encode your own images like this:
781 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
784 #ifdef FEATURE_NO_GIFS
787 * Checkerboard pattern, as a PNG.
789 const char image_pattern_data[] =
790 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
791 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
792 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
793 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
794 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
795 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
796 "\000\000\000\000\111\105\116\104\256\102\140\202";
799 * 1x1 transparant PNG.
801 const char image_blank_data[] =
802 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
803 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
804 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
805 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
806 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
807 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
808 "\000\000\000\000\111\105\116\104\256\102\140\202";
812 * Checkerboard pattern, as a GIF.
814 const char image_pattern_data[] =
815 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
816 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
817 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
818 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
822 * 1x1 transparant GIF.
824 const char image_blank_data[] =
825 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
826 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
827 "\000\001\000\000\002\002D\001\000;";
830 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
831 const size_t image_blank_length = sizeof(image_blank_data) - 1;
834 static struct http_response cgi_error_memory_response[1];
836 static struct http_response *dispatch_known_cgi(struct client_state * csp,
838 static struct map *parse_cgi_parameters(char *argstring);
841 /*********************************************************************
843 * Function : dispatch_cgi
845 * Description : Checks if a request URL has either the magical
846 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
847 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
848 * http://config.privoxy.org/). If so, it passes
849 * the (rest of the) path onto dispatch_known_cgi, which
850 * calls the relevant CGI handler function.
853 * 1 : csp = Current client state (buffers, headers, etc...)
855 * Returns : http_response if match, NULL if nonmatch or handler fail
857 *********************************************************************/
858 struct http_response *dispatch_cgi(struct client_state *csp)
860 const char *host = csp->http->host;
861 const char *path = csp->http->path;
864 * Should we intercept ?
867 /* Note: "example.com" and "example.com." are equivalent hostnames. */
869 /* Either the host matches CGI_SITE_1_HOST ..*/
870 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
871 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
872 && (path[0] == '/') )
874 /* ..then the path will all be for us. Remove leading '/' */
877 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
878 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
879 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
880 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
882 /* take everything following CGI_SITE_2_PATH */
883 path += strlen(CGI_SITE_2_PATH);
886 /* skip the forward slash after CGI_SITE_2_PATH */
889 else if (*path != '\0')
892 * weirdness: URL is /configXXX, where XXX is some string
893 * Do *NOT* intercept.
905 * This is a CGI call.
908 return dispatch_known_cgi(csp, path);
912 /*********************************************************************
914 * Function : grep_cgi_referrer
916 * Description : Ugly provisorical fix that greps the value of the
917 * referer HTTP header field out of a linked list of
918 * strings like found at csp->headers. Will disappear
921 * FIXME: csp->headers ought to be csp->http->headers
922 * FIXME: Parsing all client header lines should
923 * happen right after the request is received!
926 * 1 : csp = Current client state (buffers, headers, etc...)
928 * Returns : pointer to value (no copy!), or NULL if none found.
930 *********************************************************************/
931 static char *grep_cgi_referrer(const struct client_state *csp)
933 struct list_entry *p;
935 for (p = csp->headers->first; p != NULL; p = p->next)
937 if (p->str == NULL) continue;
938 if (strncmpic(p->str, "Referer: ", 9) == 0)
940 return ((p->str) + 9);
948 /*********************************************************************
950 * Function : referrer_is_safe
952 * Description : Decides whether we trust the Referer for
953 * CGI pages which are only meant to be reachable
954 * through Privoxy's web interface directly.
957 * 1 : csp = Current client state (buffers, headers, etc...)
959 * Returns : TRUE if the referrer is safe, or
960 * FALSE if the referrer is unsafe or not set.
962 *********************************************************************/
963 static int referrer_is_safe(const struct client_state *csp)
966 const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
968 referrer = grep_cgi_referrer(csp);
970 if (NULL == referrer)
972 /* No referrer, no access */
973 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
976 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
977 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
979 /* Trustworthy referrer */
980 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
981 csp->http->url, referrer);
987 /* Untrustworthy referrer */
988 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
989 csp->http->url, referrer);
996 /*********************************************************************
998 * Function : dispatch_known_cgi
1000 * Description : Processes a CGI once dispatch_cgi has determined that
1001 * it matches one of the magic prefixes. Parses the path
1002 * as a cgi name plus query string, prepares a map that
1003 * maps CGI parameter names to their values, initializes
1004 * the http_response struct, and calls the relevant CGI
1008 * 1 : csp = Current client state (buffers, headers, etc...)
1009 * 2 : path = Path of CGI, with the CGI prefix removed.
1010 * Should not have a leading "/".
1012 * Returns : http_response, or NULL on handler failure or out of
1015 *********************************************************************/
1016 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1019 const struct cgi_dispatcher *d;
1020 struct map *param_list;
1021 struct http_response *rsp;
1022 char *query_args_start;
1026 if (NULL == (path_copy = strdup(path)))
1028 return cgi_error_memory();
1030 query_args_start = path_copy;
1031 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1035 if (*query_args_start == '/')
1037 *query_args_start++ = '\0';
1038 if ((param_list = new_map()))
1040 map(param_list, "file", 1, url_decode(query_args_start), 0);
1045 if (*query_args_start == '?')
1047 *query_args_start++ = '\0';
1049 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1052 return cgi_error_memory();
1058 * path_copy = CGI call name
1059 * param_list = CGI params, as map
1062 /* Get mem for response or fail*/
1063 if (NULL == (rsp = alloc_http_response()))
1066 free_map(param_list);
1067 return cgi_error_memory();
1071 * Find and start the right CGI function
1073 d = cgi_dispatchers;
1076 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1079 * If the called CGI is either harmless, or referred
1080 * from a trusted source, start it.
1082 if (d->harmless || referrer_is_safe(csp))
1084 err = (d->handler)(csp, rsp, param_list);
1089 * Else, modify toggle calls so that they only display
1090 * the status, and deny all other calls.
1092 if (0 == strcmp(path_copy, "toggle"))
1094 unmap(param_list, "set");
1095 err = (d->handler)(csp, rsp, param_list);
1099 err = cgi_error_disabled(csp, rsp);
1104 free_map(param_list);
1106 if (err == JB_ERR_CGI_PARAMS)
1108 err = cgi_error_bad_param(csp, rsp);
1110 if (err && (err != JB_ERR_MEMORY))
1112 /* Unexpected error! Shouldn't get here */
1113 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1114 err = cgi_error_unknown(csp, rsp, err);
1119 rsp->reason = RSP_REASON_CGI_CALL;
1120 return finish_http_response(csp, rsp);
1124 /* Error in handler, probably out-of-memory */
1125 free_http_response(rsp);
1126 return cgi_error_memory();
1134 /*********************************************************************
1136 * Function : parse_cgi_parameters
1138 * Description : Parse a URL-encoded argument string into name/value
1139 * pairs and store them in a struct map list.
1142 * 1 : argstring = string to be parsed. Will be trashed.
1144 * Returns : pointer to param list, or NULL if out of memory.
1146 *********************************************************************/
1147 static struct map *parse_cgi_parameters(char *argstring)
1150 char *vector[BUFFER_SIZE];
1152 struct map *cgi_params;
1154 if (NULL == (cgi_params = new_map()))
1160 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1161 * the fragment identifier along with the request, so we must
1162 * cut it off here, so it won't pollute the CGI params:
1164 if (NULL != (p = strchr(argstring, '#')))
1169 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1171 for (i = 0; i < pairs; i++)
1173 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1176 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1178 free_map(cgi_params);
1189 /*********************************************************************
1191 * Function : get_char_param
1193 * Description : Get a single-character parameter passed to a CGI
1197 * 1 : parameters = map of cgi parameters
1198 * 2 : param_name = The name of the parameter to read
1200 * Returns : Uppercase character on success, '\0' on error.
1202 *********************************************************************/
1203 char get_char_param(const struct map *parameters,
1204 const char *param_name)
1211 ch = *(lookup(parameters, param_name));
1212 if ((ch >= 'a') && (ch <= 'z'))
1214 ch = (char)(ch - 'a' + 'A');
1221 /*********************************************************************
1223 * Function : get_string_param
1225 * Description : Get a string paramater, to be used as an
1226 * ACTION_STRING or ACTION_MULTI paramater.
1227 * Validates the input to prevent stupid/malicious
1228 * users from corrupting their action file.
1231 * 1 : parameters = map of cgi parameters
1232 * 2 : param_name = The name of the parameter to read
1233 * 3 : pparam = destination for paramater. Allocated as
1234 * part of the map "parameters", so don't free it.
1235 * Set to NULL if not specified.
1237 * Returns : JB_ERR_OK on success, or if the paramater
1238 * was not specified.
1239 * JB_ERR_MEMORY on out-of-memory.
1240 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1242 *********************************************************************/
1243 jb_err get_string_param(const struct map *parameters,
1244 const char *param_name,
1245 const char **pparam)
1257 param = lookup(parameters, param_name);
1263 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1268 * Note that the length limit is arbitrary, it just seems
1269 * sensible to limit it to *something*. There's no
1270 * technical reason for any limit at all.
1272 return JB_ERR_CGI_PARAMS;
1275 /* Check every character to see if it's legal */
1277 while ((ch = *s++) != '\0')
1279 if ( ((unsigned char)ch < (unsigned char)' ')
1282 /* Probable hack attempt, or user accidentally used '}'. */
1283 return JB_ERR_CGI_PARAMS;
1294 /*********************************************************************
1296 * Function : get_number_param
1298 * Description : Get a non-negative integer from the parameters
1299 * passed to a CGI function.
1302 * 1 : csp = Current client state (buffers, headers, etc...)
1303 * 2 : parameters = map of cgi parameters
1304 * 3 : name = Name of CGI parameter to read
1305 * 4 : pvalue = destination for value.
1306 * Set to -1 on error.
1308 * Returns : JB_ERR_OK on success
1309 * JB_ERR_MEMORY on out-of-memory
1310 * JB_ERR_CGI_PARAMS if the parameter was not specified
1313 *********************************************************************/
1314 jb_err get_number_param(struct client_state *csp,
1315 const struct map *parameters,
1330 param = lookup(parameters, name);
1333 return JB_ERR_CGI_PARAMS;
1336 /* We don't use atoi because I want to check this carefully... */
1339 while ((ch = *param++) != '\0')
1341 if ((ch < '0') || (ch > '9'))
1343 return JB_ERR_CGI_PARAMS;
1346 ch = (char)(ch - '0');
1350 * <limits.h> defines UINT_MAX
1352 * (UINT_MAX - ch) / 10 is the largest number that
1353 * can be safely multiplied by 10 then have ch added.
1355 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1357 return JB_ERR_CGI_PARAMS;
1360 value = value * 10 + (unsigned)ch;
1371 /*********************************************************************
1373 * Function : error_response
1375 * Description : returns an http_response that explains the reason
1376 * why a request failed.
1379 * 1 : csp = Current client state (buffers, headers, etc...)
1380 * 2 : templatename = Which template should be used for the answer
1381 * 3 : sys_err = system error number
1383 * Returns : A http_response. If we run out of memory, this
1384 * will be cgi_error_memory().
1386 *********************************************************************/
1387 struct http_response *error_response(struct client_state *csp,
1388 const char *templatename,
1392 struct http_response *rsp;
1393 struct map *exports = default_exports(csp, NULL);
1396 if (exports == NULL)
1398 return cgi_error_memory();
1401 if (NULL == (rsp = alloc_http_response()))
1404 return cgi_error_memory();
1407 #ifdef FEATURE_FORCE_LOAD
1408 if (csp->flags & CSP_FLAG_FORCED)
1410 path = strdup(FORCE_PREFIX);
1413 #endif /* def FEATURE_FORCE_LOAD */
1417 err = string_append(&path, csp->http->path);
1419 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1420 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1421 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1422 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1423 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1426 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1429 /* Some failures, like "404 no such domain", don't have an IP address. */
1430 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1438 free_http_response(rsp);
1439 return cgi_error_memory();
1442 if (!strcmp(templatename, "no-such-domain"))
1444 rsp->status = strdup("404 No such domain");
1445 if (rsp->status == NULL)
1448 free_http_response(rsp);
1449 return cgi_error_memory();
1451 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1453 else if (!strcmp(templatename, "forwarding-failed"))
1455 const struct forward_spec *fwd = forward_url(csp, csp->http);
1456 char *socks_type = NULL;
1459 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1460 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1464 * XXX: While the template is called forwarding-failed,
1465 * it currently only handles socks forwarding failures.
1467 assert(fwd->type != SOCKS_NONE);
1470 * Map failure reason, forwarding type and forwarder.
1472 if (NULL == csp->error_message)
1475 * Either we forgot to record the failure reason,
1476 * or the memory allocation failed.
1478 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1479 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1481 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1484 * XXX: this is almost the same code as in cgi_show_url_info()
1485 * and thus should be factored out and shared.
1490 socks_type = "socks4-";
1493 socks_type = "socks4a-";
1496 socks_type = "socks5-";
1499 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1502 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1503 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1505 if (!err) rsp->status = strdup("503 Forwarding failure");
1506 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1509 free_http_response(rsp);
1510 return cgi_error_memory();
1512 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1514 else if (!strcmp(templatename, "connect-failed"))
1516 rsp->status = strdup("503 Connect failed");
1517 if (rsp->status == NULL)
1520 free_http_response(rsp);
1521 return cgi_error_memory();
1523 rsp->reason = RSP_REASON_CONNECT_FAILED;
1526 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1529 free_http_response(rsp);
1530 return cgi_error_memory();
1533 return finish_http_response(csp, rsp);
1537 /*********************************************************************
1539 * Function : cgi_error_disabled
1541 * Description : CGI function that is called to generate an error
1542 * response if the actions editor or toggle CGI are
1543 * accessed despite having being disabled at compile-
1544 * or run-time, or if the user followed an untrusted link
1545 * to access a unsafe CGI feature that is only reachable
1546 * through Privoxy directly.
1549 * 1 : csp = Current client state (buffers, headers, etc...)
1550 * 2 : rsp = http_response data structure for output
1552 * CGI Parameters : none
1554 * Returns : JB_ERR_OK on success
1555 * JB_ERR_MEMORY on out-of-memory error.
1557 *********************************************************************/
1558 jb_err cgi_error_disabled(const struct client_state *csp,
1559 struct http_response *rsp)
1561 struct map *exports;
1566 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1568 return JB_ERR_MEMORY;
1570 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1572 /* Not important enough to do anything */
1573 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1576 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1580 /*********************************************************************
1582 * Function : cgi_init_error_messages
1584 * Description : Call at the start of the program to initialize
1585 * the error message used by cgi_error_memory().
1591 *********************************************************************/
1592 void cgi_init_error_messages(void)
1594 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1595 cgi_error_memory_response->head =
1596 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1597 "Content-Type: text/html\r\n"
1599 cgi_error_memory_response->body =
1602 " <title>500 Internal Privoxy Error</title>\r\n"
1603 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1606 "<h1>500 Internal Privoxy Error</h1>\r\n"
1607 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1608 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1612 cgi_error_memory_response->head_length =
1613 strlen(cgi_error_memory_response->head);
1614 cgi_error_memory_response->content_length =
1615 strlen(cgi_error_memory_response->body);
1616 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1620 /*********************************************************************
1622 * Function : cgi_error_memory
1624 * Description : Called if a CGI function runs out of memory.
1625 * Returns a statically-allocated error response.
1629 * Returns : http_response data structure for output. This is
1630 * statically allocated, for obvious reasons.
1632 *********************************************************************/
1633 struct http_response *cgi_error_memory(void)
1635 /* assert that it's been initialized. */
1636 assert(cgi_error_memory_response->head);
1638 return cgi_error_memory_response;
1642 /*********************************************************************
1644 * Function : cgi_error_no_template
1646 * Description : Almost-CGI function that is called if a template
1647 * cannot be loaded. Note this is not a true CGI,
1648 * it takes a template name rather than a map of
1652 * 1 : csp = Current client state (buffers, headers, etc...)
1653 * 2 : rsp = http_response data structure for output
1654 * 3 : template_name = Name of template that could not
1657 * Returns : JB_ERR_OK on success
1658 * JB_ERR_MEMORY on out-of-memory error.
1660 *********************************************************************/
1661 jb_err cgi_error_no_template(const struct client_state *csp,
1662 struct http_response *rsp,
1663 const char *template_name)
1665 static const char status[] =
1666 "500 Internal Privoxy Error";
1667 static const char body_prefix[] =
1670 " <title>500 Internal Privoxy Error</title>\r\n"
1671 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1674 "<h1>500 Internal Privoxy Error</h1>\r\n"
1675 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1676 "<p><b>Could not load template file <code>";
1677 static const char body_suffix[] =
1678 "</code> or one of it's included components.</b></p>\r\n"
1679 "<p>Please contact your proxy administrator.</p>\r\n"
1680 "<p>If you are the proxy administrator, please put the required file(s)"
1681 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1682 "location of the <code><i>(confdir)</i></code> directory "
1683 "is specified in the main Privoxy <code>config</code> "
1684 "file. (It's typically the Privoxy install directory"
1686 ", or <code>/etc/privoxy/</code>"
1687 #endif /* ndef _WIN32 */
1691 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1695 assert(template_name);
1697 /* Reset rsp, if needed */
1701 rsp->content_length = 0;
1702 rsp->head_length = 0;
1705 rsp->body = malloc(body_size);
1706 if (rsp->body == NULL)
1708 return JB_ERR_MEMORY;
1710 strlcpy(rsp->body, body_prefix, body_size);
1711 strlcat(rsp->body, template_name, body_size);
1712 strlcat(rsp->body, body_suffix, body_size);
1714 rsp->status = strdup(status);
1715 if (rsp->status == NULL)
1717 return JB_ERR_MEMORY;
1724 /*********************************************************************
1726 * Function : cgi_error_unknown
1728 * Description : Almost-CGI function that is called if an unexpected
1729 * error occurs in the top-level CGI dispatcher.
1730 * In this context, "unexpected" means "anything other
1731 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1732 * expected to handle all other errors internally,
1733 * since they can give more relavent error messages
1736 * Note this is not a true CGI, it takes an error
1737 * code rather than a map of parameters.
1740 * 1 : csp = Current client state (buffers, headers, etc...)
1741 * 2 : rsp = http_response data structure for output
1742 * 3 : error_to_report = Error code to report.
1744 * Returns : JB_ERR_OK on success
1745 * JB_ERR_MEMORY on out-of-memory error.
1747 *********************************************************************/
1748 jb_err cgi_error_unknown(const struct client_state *csp,
1749 struct http_response *rsp,
1750 jb_err error_to_report)
1752 static const char status[] =
1753 "500 Internal Privoxy Error";
1754 static const char body_prefix[] =
1757 " <title>500 Internal Privoxy Error</title>\r\n"
1758 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1761 "<h1>500 Internal Privoxy Error</h1>\r\n"
1762 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1763 "<p><b>Unexpected internal error: ";
1764 static const char body_suffix[] =
1767 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1768 "file a bug report</a>.</p>\r\n"
1773 * Due to sizeof(errnumbuf), body_size will be slightly
1774 * bigger than necessary but it doesn't really matter.
1776 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1780 /* Reset rsp, if needed */
1784 rsp->content_length = 0;
1785 rsp->head_length = 0;
1787 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1789 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1791 rsp->body = malloc(body_size);
1792 if (rsp->body == NULL)
1794 return JB_ERR_MEMORY;
1796 strlcpy(rsp->body, body_prefix, body_size);
1797 strlcat(rsp->body, errnumbuf, body_size);
1798 strlcat(rsp->body, body_suffix, body_size);
1800 rsp->status = strdup(status);
1801 if (rsp->status == NULL)
1803 return JB_ERR_MEMORY;
1810 /*********************************************************************
1812 * Function : cgi_error_bad_param
1814 * Description : CGI function that is called if the parameters
1815 * (query string) for a CGI were wrong.
1818 * 1 : csp = Current client state (buffers, headers, etc...)
1819 * 2 : rsp = http_response data structure for output
1821 * CGI Parameters : none
1823 * Returns : JB_ERR_OK on success
1824 * JB_ERR_MEMORY on out-of-memory error.
1826 *********************************************************************/
1827 jb_err cgi_error_bad_param(const struct client_state *csp,
1828 struct http_response *rsp)
1830 struct map *exports;
1835 if (NULL == (exports = default_exports(csp, NULL)))
1837 return JB_ERR_MEMORY;
1840 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1844 /*********************************************************************
1846 * Function : cgi_redirect
1848 * Description : CGI support function to generate a HTTP redirect
1852 * 1 : rsp = http_response data structure for output
1853 * 2 : target = string with the target URL
1855 * CGI Parameters : None
1857 * Returns : JB_ERR_OK on success
1858 * JB_ERR_MEMORY on out-of-memory error.
1860 *********************************************************************/
1861 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1868 err = enlist_unique_header(rsp->headers, "Location", target);
1870 rsp->status = strdup("302 Local Redirect from Privoxy");
1871 if (rsp->status == NULL)
1873 return JB_ERR_MEMORY;
1880 /*********************************************************************
1882 * Function : add_help_link
1884 * Description : Produce a copy of the string given as item,
1885 * embedded in an HTML link to its corresponding
1886 * section (item name in uppercase) in the actions
1887 * chapter of the user manual, (whose URL is given in
1888 * the config and defaults to our web site).
1890 * FIXME: I currently only work for actions, and would
1891 * like to be generalized for other topics.
1894 * 1 : item = item (will NOT be free()d.)
1895 * It is assumed to be HTML-safe.
1896 * 2 : config = The current configuration.
1898 * Returns : String with item embedded in link, or NULL on
1901 *********************************************************************/
1902 char *add_help_link(const char *item,
1903 struct configuration_spec *config)
1907 if (!item) return NULL;
1909 result = strdup("<a href=\"");
1910 if (!strncmpic(config->usermanual, "file://", 7) ||
1911 !strncmpic(config->usermanual, "http", 4))
1913 string_append(&result, config->usermanual);
1917 string_append(&result, "http://");
1918 string_append(&result, CGI_SITE_2_HOST);
1919 string_append(&result, "/user-manual/");
1921 string_append(&result, ACTIONS_HELP_PREFIX);
1922 string_join (&result, string_toupper(item));
1923 string_append(&result, "\">");
1924 string_append(&result, item);
1925 string_append(&result, "</a> ");
1931 /*********************************************************************
1933 * Function : get_http_time
1935 * Description : Get the time in a format suitable for use in a
1936 * HTTP header - e.g.:
1937 * "Sun, 06 Nov 1994 08:49:37 GMT"
1940 * 1 : time_offset = Time returned will be current time
1941 * plus this number of seconds.
1942 * 2 : buf = Destination for result.
1943 * 3 : buffer_size = Size of the buffer above. Must be big
1944 * enough to hold 29 characters plus a
1949 *********************************************************************/
1950 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1952 static const char day_names[7][4] =
1953 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1954 static const char month_names[12][4] =
1955 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1956 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1959 time_t current_time;
1960 #if defined(HAVE_GMTIME_R)
1962 * Declare dummy up here (instead of inside get/set gmt block) so it
1963 * doesn't go out of scope before it's potentially used in snprintf later.
1964 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1965 * !defined HAVE_GMTIME_R.
1971 assert(buffer_size > 29);
1973 time(¤t_time); /* get current time */
1975 current_time += time_offset;
1977 /* get and save the gmt */
1980 t = gmtime_r(¤t_time, &dummy);
1981 #elif FEATURE_PTHREAD
1982 pthread_mutex_lock(&gmtime_mutex);
1983 t = gmtime(¤t_time);
1984 pthread_mutex_unlock(&gmtime_mutex);
1986 t = gmtime(¤t_time);
1990 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1991 snprintf(buf, buffer_size,
1992 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1993 day_names[t->tm_wday],
1995 month_names[t->tm_mon],
2005 /*********************************************************************
2007 * Function : finish_http_response
2009 * Description : Fill in the missing headers in an http response,
2010 * and flatten the headers to an http head.
2011 * For HEAD requests the body is freed once
2012 * the Content-Length header is set.
2015 * 1 : rsp = pointer to http_response to be processed
2017 * Returns : A http_response, usually the rsp parameter.
2018 * On error, free()s rsp and returns cgi_error_memory()
2020 *********************************************************************/
2021 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2023 char buf[BUFFER_SIZE];
2026 /* Special case - do NOT change this statically allocated response,
2027 * which is ready for output anyway.
2029 if (rsp == cgi_error_memory_response)
2035 * Fill in the HTTP Status, using HTTP/1.1
2036 * unless the client asked for HTTP/1.0.
2038 snprintf(buf, sizeof(buf), "%s %s",
2039 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2040 rsp->status ? rsp->status : "200 OK");
2041 err = enlist_first(rsp->headers, buf);
2044 * Set the Content-Length
2046 if (rsp->content_length == 0)
2048 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2052 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2053 err = enlist(rsp->headers, buf);
2056 if (0 == strcmpic(csp->http->gpc, "head"))
2059 * The client only asked for the head. Dispose
2060 * the body and log an offensive message.
2062 * While it may seem to be a bit inefficient to
2063 * prepare the body if it isn't needed, it's the
2064 * only way to get the Content-Length right for
2065 * dynamic pages. We could have disposed the body
2066 * earlier, but not without duplicating the
2067 * Content-Length setting code above.
2069 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2071 rsp->content_length = 0;
2074 if (strncmpic(rsp->status, "302", 3))
2077 * If it's not a redirect without any content,
2078 * set the Content-Type to text/html if it's
2079 * not already specified.
2081 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2085 * Fill in the rest of the default headers:
2087 * Date: set to current date/time.
2088 * Last-Modified: set to date/time the page was last changed.
2089 * Expires: set to date/time page next needs reloading.
2090 * Cache-Control: set to "no-cache" if applicable.
2092 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2097 * Set Expires to about 10 min into the future so it'll get reloaded
2098 * occasionally, e.g. if Privoxy gets upgraded.
2103 get_http_time(0, buf, sizeof(buf));
2104 err = enlist_unique_header(rsp->headers, "Date", buf);
2107 /* Some date in the past. */
2108 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2112 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
2113 err = enlist_unique_header(rsp->headers, "Expires", buf);
2116 else if (!strncmpic(rsp->status, "302", 3))
2118 get_http_time(0, buf, sizeof(buf));
2119 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2124 * Setting "Cache-Control" to "no-cache" and "Expires" to
2125 * the current time doesn't exactly forbid caching, it just
2126 * requires the client to revalidate the cached copy.
2128 * If a temporary problem occurs and the user tries again after
2129 * getting Privoxy's error message, a compliant browser may set the
2130 * If-Modified-Since header with the content of the error page's
2131 * Last-Modified header. More often than not, the document on the server
2132 * is older than Privoxy's error message, the server would send status code
2133 * 304 and the browser would display the outdated error message again and again.
2135 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2136 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2137 * and can be safely used to "revalidate" without getting a status code 304.
2139 * There is no need to let the useless If-Modified-Since header reach the
2140 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2142 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2144 get_http_time(0, buf, sizeof(buf));
2145 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2146 if (!strncmpic(rsp->status, "403", 3)
2147 || !strncmpic(rsp->status, "404", 3)
2148 || !strncmpic(rsp->status, "503", 3))
2150 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2154 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2156 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2157 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2163 * HTTP/1.1 applications that do not support persistent connections MUST
2164 * include the "close" connection option in every message.
2166 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2171 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2173 free_http_response(rsp);
2174 return cgi_error_memory();
2176 rsp->head_length = strlen(rsp->head);
2183 /*********************************************************************
2185 * Function : alloc_http_response
2187 * Description : Allocates a new http_response structure.
2191 * Returns : pointer to a new http_response, or NULL.
2193 *********************************************************************/
2194 struct http_response *alloc_http_response(void)
2196 return (struct http_response *) zalloc(sizeof(struct http_response));
2201 /*********************************************************************
2203 * Function : free_http_response
2205 * Description : Free the memory occupied by an http_response
2206 * and its depandant structures.
2209 * 1 : rsp = pointer to http_response to be freed
2213 *********************************************************************/
2214 void free_http_response(struct http_response *rsp)
2217 * Must special case cgi_error_memory_response, which is never freed.
2219 if (rsp && (rsp != cgi_error_memory_response))
2224 destroy_list(rsp->headers);
2231 /*********************************************************************
2233 * Function : template_load
2235 * Description : CGI support function that loads a given HTML
2236 * template, ignoring comment lines and following
2237 * #include statements up to a depth of 1.
2240 * 1 : csp = Current client state (buffers, headers, etc...)
2241 * 2 : template_ptr = Destination for pointer to loaded
2243 * 3 : templatename = name of the HTML template to be used
2244 * 4 : recursive = Flag set if this function calls itself
2245 * following an #include statament
2247 * Returns : JB_ERR_OK on success
2248 * JB_ERR_MEMORY on out-of-memory error.
2249 * JB_ERR_FILE if the template file cannot be read
2251 *********************************************************************/
2252 jb_err template_load(const struct client_state *csp, char **template_ptr,
2253 const char *templatename, int recursive)
2256 char *templates_dir_path;
2259 char *included_module;
2262 char buf[BUFFER_SIZE];
2265 assert(template_ptr);
2266 assert(templatename);
2268 *template_ptr = NULL;
2270 /* Validate template name. Paranoia. */
2271 for (p = templatename; *p != 0; p++)
2273 if ( ((*p < 'a') || (*p > 'z'))
2274 && ((*p < 'A') || (*p > 'Z'))
2275 && ((*p < '0') || (*p > '9'))
2279 /* Illegal character */
2285 * Generate full path using either templdir
2286 * or confdir/templates as base directory.
2288 if (NULL != csp->config->templdir)
2290 templates_dir_path = strdup(csp->config->templdir);
2294 templates_dir_path = make_path(csp->config->confdir, "templates");
2297 if (templates_dir_path == NULL)
2299 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2301 return JB_ERR_MEMORY;
2304 full_path = make_path(templates_dir_path, templatename);
2305 free(templates_dir_path);
2306 if (full_path == NULL)
2308 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2310 return JB_ERR_MEMORY;
2313 /* Allocate buffer */
2315 file_buffer = strdup("");
2316 if (file_buffer == NULL)
2318 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2320 return JB_ERR_MEMORY;
2323 /* Open template file */
2325 if (NULL == (fp = fopen(full_path, "r")))
2327 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2335 * Read the file, ignoring comments, and honoring #include
2336 * statements, unless we're already called recursively.
2338 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2339 * This is unlikely in practise.
2341 while (fgets(buf, BUFFER_SIZE, fp))
2343 if (!recursive && !strncmp(buf, "#include ", 9))
2345 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2352 if (string_join(&file_buffer, included_module))
2355 return JB_ERR_MEMORY;
2361 /* skip lines starting with '#' */
2367 if (string_append(&file_buffer, buf))
2370 return JB_ERR_MEMORY;
2375 *template_ptr = file_buffer;
2381 /*********************************************************************
2383 * Function : template_fill
2385 * Description : CGI support function that fills in a pre-loaded
2386 * HTML template by replacing @name@ with value using
2387 * pcrs, for each item in the output map.
2389 * Note that a leading '$' charachter in the export map's
2390 * values will be stripped and toggle on backreference
2394 * 1 : template_ptr = IN: Template to be filled out.
2396 * OUT: Filled out template.
2397 * Caller must free().
2398 * 2 : exports = map with fill in symbol -> name pairs
2400 * Returns : JB_ERR_OK on success (and for uncritical errors)
2401 * JB_ERR_MEMORY on out-of-memory error
2403 *********************************************************************/
2404 jb_err template_fill(char **template_ptr, const struct map *exports)
2406 struct map_entry *m;
2408 char buf[BUFFER_SIZE];
2409 char *tmp_out_buffer;
2415 assert(template_ptr);
2416 assert(*template_ptr);
2419 file_buffer = *template_ptr;
2420 size = strlen(file_buffer) + 1;
2423 * Assemble pcrs joblist from exports map
2425 for (m = exports->first; m != NULL; m = m->next)
2427 if (*m->name == '$')
2430 * First character of name is '$', so remove this flag
2431 * character and allow backreferences ($1 etc) in the
2432 * "replace with" text.
2434 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2440 * Treat the "replace with" text as a literal string -
2441 * no quoting needed, no backreferences allowed.
2442 * ("Trivial" ['T'] flag).
2446 /* Enclose name in @@ */
2447 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2451 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2453 /* Make and run job. */
2454 job = pcrs_compile(buf, m->value, flags, &error);
2457 if (error == PCRS_ERR_NOMEM)
2460 *template_ptr = NULL;
2461 return JB_ERR_MEMORY;
2465 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2466 /* Hope it wasn't important and silently ignore the invalid job */
2471 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2474 if (NULL == tmp_out_buffer)
2476 *template_ptr = NULL;
2477 return JB_ERR_MEMORY;
2483 * Substitution failed, keep the original buffer,
2484 * log the problem and ignore it.
2486 * The user might see some unresolved @CGI_VARIABLES@,
2487 * but returning a special CGI error page seems unreasonable
2488 * and could mask more important error messages.
2490 free(tmp_out_buffer);
2491 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2492 buf, m->value, flags, pcrs_strerror(error));
2496 /* Substitution succeeded, use modified buffer. */
2498 file_buffer = tmp_out_buffer;
2506 *template_ptr = file_buffer;
2511 /*********************************************************************
2513 * Function : template_fill_for_cgi
2515 * Description : CGI support function that loads a HTML template
2516 * and fills it in. Handles file-not-found errors
2517 * by sending a HTML error message. For convenience,
2518 * this function also frees the passed "exports" map.
2521 * 1 : csp = Client state
2522 * 2 : templatename = name of the HTML template to be used
2523 * 3 : exports = map with fill in symbol -> name pairs.
2524 * Will be freed by this function.
2525 * 4 : rsp = Response structure to fill in.
2527 * Returns : JB_ERR_OK on success
2528 * JB_ERR_MEMORY on out-of-memory error
2530 *********************************************************************/
2531 jb_err template_fill_for_cgi(const struct client_state *csp,
2532 const char *templatename,
2533 struct map *exports,
2534 struct http_response *rsp)
2539 assert(templatename);
2543 err = template_load(csp, &rsp->body, templatename, 0);
2544 if (err == JB_ERR_FILE)
2547 return cgi_error_no_template(csp, rsp, templatename);
2552 return err; /* JB_ERR_MEMORY */
2554 err = template_fill(&rsp->body, exports);
2560 /*********************************************************************
2562 * Function : default_exports
2564 * Description : returns a struct map list that contains exports
2565 * which are common to all CGI functions.
2568 * 1 : csp = Current client state (buffers, headers, etc...)
2569 * 2 : caller = name of CGI who calls us and which should
2570 * be excluded from the generated menu. May be
2572 * Returns : NULL if no memory, else a new map. Caller frees.
2574 *********************************************************************/
2575 struct map *default_exports(const struct client_state *csp, const char *caller)
2579 struct map * exports;
2580 int local_help_exists = 0;
2581 char *ip_address = NULL;
2582 char *hostname = NULL;
2586 exports = new_map();
2587 if (exports == NULL)
2592 if (csp->config->hostname)
2594 get_host_information(csp->cfd, &ip_address, NULL);
2595 hostname = strdup(csp->config->hostname);
2599 get_host_information(csp->cfd, &ip_address, &hostname);
2602 err = map(exports, "version", 1, html_encode(VERSION), 0);
2603 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2605 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2607 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2608 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2609 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2610 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2611 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2612 !strncmpic(csp->config->usermanual, "http", 4))
2614 /* Manual is located somewhere else, just link to it. */
2615 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2619 /* Manual is delivered by Privoxy. */
2620 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2622 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2623 #ifdef FEATURE_TOGGLE
2624 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2626 if (!err) err = map_block_killer(exports, "can-toggle");
2629 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2630 if (!err) err = map(exports, "my-port", 1, buf, 1);
2632 if(!strcmp(CODE_STATUS, "stable"))
2634 if (!err) err = map_block_killer(exports, "unstable");
2637 if (csp->config->admin_address != NULL)
2639 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2640 local_help_exists = 1;
2644 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2647 if (csp->config->proxy_info_url != NULL)
2649 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2650 local_help_exists = 1;
2654 if (!err) err = map_block_killer(exports, "have-proxy-info");
2657 if (local_help_exists == 0)
2659 if (!err) err = map_block_killer(exports, "have-help-info");
2672 /*********************************************************************
2674 * Function : map_block_killer
2676 * Description : Convenience function.
2677 * Adds a "killer" for the conditional HTML-template
2678 * block <name>, i.e. a substitution of the regex
2679 * "if-<name>-start.*if-<name>-end" to the given
2683 * 1 : exports = map to extend
2684 * 2 : name = name of conditional block
2686 * Returns : JB_ERR_OK on success
2687 * JB_ERR_MEMORY on out-of-memory error.
2689 *********************************************************************/
2690 jb_err map_block_killer(struct map *exports, const char *name)
2692 char buf[1000]; /* Will do, since the names are hardwired */
2696 assert(strlen(name) < 490);
2698 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2699 return map(exports, buf, 1, "", 1);
2703 /*********************************************************************
2705 * Function : map_block_keep
2707 * Description : Convenience function. Removes the markers used
2708 * by map-block-killer, to save a few bytes.
2709 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2712 * 1 : exports = map to extend
2713 * 2 : name = name of conditional block
2715 * Returns : JB_ERR_OK on success
2716 * JB_ERR_MEMORY on out-of-memory error.
2718 *********************************************************************/
2719 jb_err map_block_keep(struct map *exports, const char *name)
2722 char buf[500]; /* Will do, since the names are hardwired */
2726 assert(strlen(name) < 490);
2728 snprintf(buf, sizeof(buf), "if-%s-start", name);
2729 err = map(exports, buf, 1, "", 1);
2736 snprintf(buf, sizeof(buf), "if-%s-end", name);
2737 return map(exports, buf, 1, "", 1);
2741 /*********************************************************************
2743 * Function : map_conditional
2745 * Description : Convenience function.
2746 * Adds an "if-then-else" for the conditional HTML-template
2747 * block <name>, i.e. a substitution of the form:
2754 * The control structure and one of the alternatives
2758 * 1 : exports = map to extend
2759 * 2 : name = name of conditional block
2760 * 3 : choose_first = nonzero for first, zero for second.
2762 * Returns : JB_ERR_OK on success
2763 * JB_ERR_MEMORY on out-of-memory error.
2765 *********************************************************************/
2766 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2768 char buf[1000]; /* Will do, since the names are hardwired */
2773 assert(strlen(name) < 480);
2775 snprintf(buf, sizeof(buf), (choose_first
2776 ? "else-not-%s@.*@endif-%s"
2777 : "if-%s-then@.*@else-not-%s"),
2780 err = map(exports, buf, 1, "", 1);
2786 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2787 return map(exports, buf, 1, "", 1);
2791 /*********************************************************************
2793 * Function : make_menu
2795 * Description : Returns an HTML-formatted menu of the available
2796 * unhidden CGIs, excluding the one given in <self>
2797 * and the toggle CGI if toggling is disabled.
2800 * 1 : self = name of CGI to leave out, can be NULL for
2802 * 2 : feature_flags = feature bitmap from csp->config
2805 * Returns : menu string, or NULL on out-of-memory error.
2807 *********************************************************************/
2808 char *make_menu(const char *self, const unsigned feature_flags)
2810 const struct cgi_dispatcher *d;
2811 char *result = strdup("");
2815 self = "NO-SUCH-CGI!";
2818 /* List available unhidden CGI's and export as "other-cgis" */
2819 for (d = cgi_dispatchers; d->name; d++)
2822 #ifdef FEATURE_TOGGLE
2823 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2826 * Suppress the toggle link if remote toggling is disabled.
2830 #endif /* def FEATURE_TOGGLE */
2832 if (d->description && strcmp(d->name, self))
2834 char *html_encoded_prefix;
2837 * Line breaks would be great, but break
2838 * the "blocked" template's JavaScript.
2840 string_append(&result, "<li><a href=\"");
2841 html_encoded_prefix = html_encode(CGI_PREFIX);
2842 if (html_encoded_prefix == NULL)
2848 string_append(&result, html_encoded_prefix);
2849 free(html_encoded_prefix);
2851 string_append(&result, d->name);
2852 string_append(&result, "\">");
2853 string_append(&result, d->description);
2854 string_append(&result, "</a></li>");
2862 /*********************************************************************
2864 * Function : dump_map
2866 * Description : HTML-dump a map for debugging (as table)
2869 * 1 : the_map = map to dump
2871 * Returns : string with HTML
2873 *********************************************************************/
2874 char *dump_map(const struct map *the_map)
2876 struct map_entry *cur_entry;
2877 char *ret = strdup("");
2879 string_append(&ret, "<table>\n");
2881 for (cur_entry = the_map->first;
2882 (cur_entry != NULL) && (ret != NULL);
2883 cur_entry = cur_entry->next)
2885 string_append(&ret, "<tr><td><b>");
2886 string_join (&ret, html_encode(cur_entry->name));
2887 string_append(&ret, "</b></td><td>");
2888 string_join (&ret, html_encode(cur_entry->value));
2889 string_append(&ret, "</td></tr>\n");
2892 string_append(&ret, "</table>\n");