1 const char cgi_rcs[] = "$Id: cgi.c,v 1.107 2008/05/26 16:23:19 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
6 * Purpose : Declares functions to intercept request, generate
7 * html or gif answers, and to compose HTTP resonses.
8 * This only contains the framework functions, the
9 * actual handler functions are declared elsewhere.
11 * Functions declared include:
14 * Copyright : Written by and Copyright (C) 2001-2004, 2006-2008
15 * the SourceForge Privoxy team. http://www.privoxy.org/
17 * Based on the Internet Junkbuster originally written
18 * by and Copyright (C) 1997 Anonymous Coders and
19 * Junkbusters Corporation. http://www.junkbusters.com
21 * This program is free software; you can redistribute it
22 * and/or modify it under the terms of the GNU General
23 * Public License as published by the Free Software
24 * Foundation; either version 2 of the License, or (at
25 * your option) any later version.
27 * This program is distributed in the hope that it will
28 * be useful, but WITHOUT ANY WARRANTY; without even the
29 * implied warranty of MERCHANTABILITY or FITNESS FOR A
30 * PARTICULAR PURPOSE. See the GNU General Public
31 * License for more details.
33 * The GNU General Public License should be included with
34 * this file. If not, you can view it at
35 * http://www.gnu.org/copyleft/gpl.html
36 * or write to the Free Software Foundation, Inc., 59
37 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
41 * Revision 1.107 2008/05/26 16:23:19 fabiankeil
42 * - Fix spelling in template-not-found message.
43 * - Declare referrer_is_safe()'s alternative_prefix[] static.
45 * Revision 1.106 2008/05/21 15:24:38 fabiankeil
46 * Mark csp as immutable for a bunch of functions.
48 * Revision 1.105 2008/04/17 14:40:47 fabiankeil
49 * Provide get_http_time() with the buffer size so it doesn't
50 * have to blindly assume that the buffer is big enough.
52 * Revision 1.104 2008/03/26 18:07:06 fabiankeil
53 * Add hostname directive. Closes PR#1918189.
55 * Revision 1.103 2008/03/21 11:13:57 fabiankeil
56 * Only gather host information if it's actually needed.
57 * Also move the code out of accept_connection() so it's less likely
58 * to delay other incoming connections if the host is misconfigured.
60 * Revision 1.102 2008/02/23 16:33:43 fabiankeil
61 * Let forward_url() use the standard parameter ordering
62 * and mark its second parameter immutable.
64 * Revision 1.101 2008/02/03 15:45:06 fabiankeil
65 * Add SOCKS5 support for "Forwarding failure" CGI page.
67 * Revision 1.100 2007/10/17 18:40:53 fabiankeil
68 * - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
71 * Revision 1.99 2007/08/05 13:42:22 fabiankeil
72 * #1763173 from Stefan Huehner: declare some more functions static.
74 * Revision 1.98 2007/05/14 10:33:51 fabiankeil
75 * - Use strlcpy() and strlcat() instead of strcpy() and strcat().
77 * Revision 1.97 2007/04/09 18:11:35 fabiankeil
78 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
80 * Revision 1.96 2007/03/08 17:41:05 fabiankeil
81 * Use sizeof() more often.
83 * Revision 1.95 2007/02/10 17:01:37 fabiankeil
84 * Don't overlook map result for the forwarding-type.
86 * Revision 1.94 2007/02/08 19:44:49 fabiankeil
87 * Use a transparent background for the PNG replacement pattern.
89 * Revision 1.93 2007/02/07 10:45:22 fabiankeil
90 * - Save the reason for generating http_responses.
91 * - Fix --disable-toggle (again).
92 * - Use TBL birthday hack for 403 responses as well.
93 * - Uglify the @menu@ again to fix JavaScript
94 * errors on the "blocked" template.
95 * - Escape an ampersand in cgi_error_unknown().
97 * Revision 1.92 2007/01/28 13:41:17 fabiankeil
98 * - Add HEAD support to finish_http_response.
99 * - Add error favicon to internal HTML error messages.
101 * Revision 1.91 2007/01/27 13:09:16 fabiankeil
102 * Add new config option "templdir" to
103 * change the templates directory.
105 * Revision 1.90 2007/01/25 13:47:26 fabiankeil
106 * Added "forwarding-failed" template support for error_response().
108 * Revision 1.89 2007/01/23 15:51:16 fabiankeil
109 * Add favicon delivery functions.
111 * Revision 1.88 2007/01/23 13:14:32 fabiankeil
112 * - Map variables that aren't guaranteed to be
113 * pure ASCII html_encoded.
114 * - Use CGI_PREFIX to generate URL for user manual
115 * CGI page to make sure CGI_SITE_2_PATH is included.
117 * Revision 1.87 2007/01/22 15:34:13 fabiankeil
118 * - "Protect" against a rather lame JavaScript-based
119 * Privoxy detection "attack" and check the referrer
120 * before delivering the CGI style sheet.
121 * - Move referrer check for unsafe CGI pages into
122 * referrer_is_safe() and log the result.
123 * - Map @url@ in cgi-error-disabled page.
124 * It's required for the "go there anyway" link.
125 * - Mark *csp as immutable for grep_cgi_referrer().
127 * Revision 1.86 2007/01/09 11:54:26 fabiankeil
128 * Fix strdup() error handling in cgi_error_unknown()
129 * and cgi_error_no_template(). Reported by Markus Elfring.
131 * Revision 1.85 2007/01/05 14:19:02 fabiankeil
132 * Handle pcrs_execute() errors in template_fill() properly.
134 * Revision 1.84 2006/12/28 17:54:22 fabiankeil
135 * Fixed gcc43 conversion warnings and replaced sprintf
136 * calls with snprintf to give OpenBSD's gcc one less reason
139 * Revision 1.83 2006/12/17 19:35:19 fabiankeil
140 * Escape ampersand in Privoxy menu.
142 * Revision 1.82 2006/12/17 17:53:39 fabiankeil
143 * Suppress the toggle link if remote toggling is disabled.
145 * Revision 1.81 2006/12/09 13:49:16 fabiankeil
146 * Fix configure option --disable-toggle.
147 * Thanks to Peter Thoenen for reporting this.
149 * Revision 1.80 2006/12/08 14:45:32 fabiankeil
150 * Don't lose the FORCE_PREFIX in case of
151 * connection problems. Fixes #612235.
153 * Revision 1.79 2006/11/13 19:05:50 fabiankeil
154 * Make pthread mutex locking more generic. Instead of
155 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
156 * and use mutex locking unless there is an _r function
157 * available. Better safe than sorry.
159 * Fixes "./configure --disable-pthread" and should result
160 * in less threading-related problems on pthread-using platforms,
161 * but it still doesn't fix BR#1122404.
163 * Revision 1.78 2006/09/21 19:22:07 fabiankeil
164 * Use CGI_PREFIX to check the referrer.
165 * The check for "http://config.privoxy.org/" fails
166 * if the user modified CGI_SITE_2_HOST.
168 * Revision 1.77 2006/09/21 15:17:23 fabiankeil
169 * Adjusted headers for Privoxy's cgi responses:
170 * Don't set Last-Modified, Expires and Cache-Control
171 * headers for redirects; always set "Connection: close".
173 * Revision 1.76 2006/09/07 14:06:38 fabiankeil
174 * Only predate the Last-Modified header for cgi responses
175 * that are delivered with status code 404 or 503.
177 * Revision 1.75 2006/09/07 11:56:39 fabiankeil
178 * Mark cgi_send_user_manual as harmless,
179 * to fix the access denied problem Hal spotted.
180 * The manual has no secret content, therefore we
181 * don't have to care about "secure" referrers.
183 * Revision 1.74 2006/09/06 18:45:03 fabiankeil
184 * Incorporate modified version of Roland Rosenfeld's patch to
185 * optionally access the user-manual via Privoxy. Closes patch 679075.
187 * Formatting changed to Privoxy style, added call to
188 * cgi_error_no_template if the requested file doesn't
189 * exist and modified check whether or not Privoxy itself
190 * should serve the manual. Should work cross-platform now.
192 * Revision 1.73 2006/08/03 02:46:41 david__schmidt
193 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
195 * Revision 1.72 2006/07/18 14:48:45 david__schmidt
196 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
197 * with what was really the latest development (the v_3_0_branch branch)
199 * Revision 1.70.2.13 2004/02/17 13:30:23 oes
200 * Moved cgi_error_disabled() from cgiedit.c to
201 * cgi.c to re-enable build with --disable-editor.
202 * Fixes Bug #892744. Thanks to Matthew Fischer
205 * Revision 1.70.2.12 2003/12/17 16:33:16 oes
206 * - Added new function cgi_redirect to handle creation of
207 * HTTP redirect messages formerly repeated in the code.
208 * - Send cgi_error_disabled instead of cgi_error_404 when
209 * referrer check fails
210 * - Dynamic content now gets Expires header field with date
213 * Revision 1.70.2.11 2003/10/23 12:29:26 oes
214 * Bugfix: Transparent PNG was not transparent. Thanks to
215 * Dan Razzell of Starfish Systems for notice and new PNG.
217 * Revision 1.70.2.10 2003/06/06 07:54:25 oes
218 * Security fix: dspatch_known_cgi no longer considers an empty
219 * referrer safe for critical CGIs, since malicious links could
220 * reside on https:// locations which browsers don't advertize as
221 * referrers. Closes bug #749916, thanks to Jeff Epler for the
222 * hint. Goodbye One-Click[tm] toggling :-(
224 * Revision 1.70.2.9 2003/05/08 15:11:31 oes
227 * Revision 1.70.2.8 2003/04/29 13:33:51 oes
228 * Killed a compiler warning on OSX
230 * Revision 1.70.2.7 2003/04/03 13:50:58 oes
231 * - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
232 * (fixes bug #710056)
233 * - Show toggle info only if we have it
235 * Revision 1.70.2.6 2003/03/12 01:26:25 david__schmidt
236 * Move declaration of struct tm dummy outside of a control block so it is
237 * accessible later on during snprintf in get_http_time.
239 * Revision 1.70.2.5 2003/03/11 11:53:58 oes
240 * Cosmetic: Renamed cryptic variable
242 * Revision 1.70.2.4 2003/03/07 03:41:03 david__schmidt
243 * 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.
245 * Revision 1.70.2.3 2002/11/28 18:14:32 oes
246 * Disable access to critical CGIs via untrusted referrers.
247 * This prevents users from being tricked by malicious websites
248 * into making unintentional configuration changes:
250 * - Added flag to each cgi_dispatcher that allows or denies
252 * - Introduced proviorical function that greps for the
253 * referrer header before regular header parsing happens
254 * - Added safety check to dispatch_known_cgi. CGI is called
255 * if (cgi harmless || no referrer || we are referrer).
256 * Else a) toggle calls are modified not to change status and
257 * b) all other calls are denied.
259 * Revision 1.70.2.2 2002/11/12 16:20:37 oes
260 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
262 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
263 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
265 * Revision 1.70 2002/05/19 11:33:20 jongfoster
266 * If a CGI error was not handled, and propogated back to
267 * dispatch_known_cgi(), then it was assumed to be "out of memory".
268 * This gave a very misleading error message.
270 * Now other errors will cause a simple message giving the error
271 * number and asking the user to report a bug.
274 * http://sourceforge.net/tracker/index.php?func=detail
275 * &aid=557905&group_id=11118&atid=111118
277 * Revision 1.69 2002/05/14 21:28:40 oes
278 * - Fixed add_help_link to link to the (now split) actions
279 * part of the config chapter
280 * - Renamed helplink export to actions-help-prefix
282 * Revision 1.68 2002/05/12 21:36:29 jongfoster
283 * Correcting function comments
285 * Revision 1.67 2002/04/30 12:02:07 oes
286 * Nit: updated a comment
288 * Revision 1.66 2002/04/26 18:32:57 jongfoster
289 * Fixing a memory leak on error
291 * Revision 1.65 2002/04/26 12:53:51 oes
292 * - New function add_help_link
293 * - default_exports now exports links to the user manual
294 * and a prefix for links into the config chapter
296 * Revision 1.64 2002/04/24 02:17:21 oes
297 * - Better descriptions for CGIs
298 * - Hide edit-actions, more shortcuts
299 * - Moved get_char_param, get_string_param and get_number_param here
302 * Revision 1.63 2002/04/15 19:06:43 jongfoster
305 * Revision 1.62 2002/04/10 19:59:46 jongfoster
306 * Fixes to #include in templates:
307 * - Didn't close main file if loading an included template fails.
308 * - I'm paranoid and want to disallow "#include /etc/passwd".
310 * Revision 1.61 2002/04/10 13:37:48 oes
311 * Made templates modular: template_load now recursive with max depth 1
313 * Revision 1.60 2002/04/08 20:50:25 swa
316 * Revision 1.59 2002/04/05 15:51:51 oes
317 * - added send-stylesheet CGI
318 * - bugfix: error-pages now get correct request protocol
320 * - kludged CGI descriptions and menu not to break JS syntax
322 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
323 * Fix Mac OSX compiler warnings
325 * Revision 1.57 2002/03/26 22:29:54 swa
326 * we have a new homepage!
328 * Revision 1.56 2002/03/24 17:50:46 jongfoster
329 * Fixing compile error if actions file editor disabled
331 * Revision 1.55 2002/03/24 16:55:06 oes
332 * Making GIF checkerboard transparent
334 * Revision 1.54 2002/03/24 16:18:15 jongfoster
337 * Revision 1.53 2002/03/24 16:06:00 oes
338 * Correct transparency for checkerboard PNG. Thanks, Magnus!
340 * Revision 1.52 2002/03/24 15:23:33 jongfoster
343 * Revision 1.51 2002/03/24 13:25:43 swa
344 * name change related issues
346 * Revision 1.50 2002/03/16 23:54:06 jongfoster
347 * Adding graceful termination feature, to help look for memory leaks.
348 * If you enable this (which, by design, has to be done by hand
349 * editing config.h) and then go to http://i.j.b/die, then the program
350 * will exit cleanly after the *next* request. It should free all the
351 * memory that was used.
353 * Revision 1.49 2002/03/13 00:27:04 jongfoster
356 * Revision 1.48 2002/03/08 17:47:07 jongfoster
359 * Revision 1.47 2002/03/08 16:41:33 oes
360 * Added GIF images again
362 * Revision 1.46 2002/03/07 03:48:38 oes
363 * - Changed built-in images from GIF to PNG
364 * (with regard to Unisys patent issue)
365 * - Added a 4x4 pattern PNG which is less intrusive
366 * than the logo but also clearly marks the deleted banners
368 * Revision 1.45 2002/03/06 22:54:35 jongfoster
369 * Automated function-comment nitpicking.
371 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
372 * - Better error reporting on OS/2
373 * - Fix double-slash comment (oops)
375 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
376 * - Re-enable OS/2 building after new parms were added
377 * - Fix false out of memory report when resolving CGI templates when no IP
378 * address is available of failed attempt (a la no such domain)
380 * Revision 1.42 2002/01/21 00:33:20 jongfoster
381 * Replacing strsav() with the safer string_append() or string_join().
382 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
383 * Adding missing html_encode() to error message generators.
384 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
386 * Revision 1.41 2002/01/17 20:56:22 jongfoster
387 * Replacing hard references to the URL of the config interface
388 * with #defines from project.h
390 * Revision 1.40 2002/01/09 14:26:46 oes
391 * Added support for thread-safe gmtime_r call.
393 * Revision 1.39 2001/11/16 00:48:13 jongfoster
394 * Fixing a compiler warning
396 * Revision 1.38 2001/11/13 00:31:21 jongfoster
397 * - Adding new CGIs for use by non-JavaScript browsers:
398 * edit-actions-url-form
399 * edit-actions-add-url-form
400 * edit-actions-remove-url-form
401 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
404 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
405 * Show enablement/disablement status in almost all templates.
406 * There is a little trickiness here: apparent recursive resolution of
407 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
408 * the actual enablement status. So a similar construct,
409 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
412 * Revision 1.36 2001/10/26 17:33:27 oes
415 * Revision 1.35 2001/10/23 21:48:19 jongfoster
416 * Cleaning up error handling in CGI functions - they now send back
417 * a HTML error page and should never cause a FATAL error. (Fixes one
418 * potential source of "denial of service" attacks).
420 * CGI actions file editor that works and is actually useful.
422 * Ability to toggle Junkbuster remotely using a CGI call.
424 * You can turn off both the above features in the main configuration
425 * file, e.g. if you are running a multi-user proxy.
427 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
428 * Only show "Local support" on templates conditionally:
429 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
430 * - if not, no Local support section appears
432 * Revision 1.33 2001/10/14 22:28:41 jongfoster
433 * Fixing stupid typo.
435 * Revision 1.32 2001/10/14 22:20:18 jongfoster
436 * - Changes to CGI dispatching method to match CGI names exactly,
437 * rather than doing a prefix match.
438 * - No longer need to count the length of the CGI handler names by hand.
439 * - Adding new handler for 404 error when disptching a CGI, if none of
440 * the handlers match.
441 * - Adding new handlers for CGI actionsfile editor.
443 * Revision 1.31 2001/10/10 10:56:39 oes
444 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
446 * Revision 1.30 2001/10/02 15:30:57 oes
447 * Introduced show-request cgi
449 * Revision 1.29 2001/09/20 15:47:44 steudten
451 * Fix BUG: Modify int size to size_t size in fill_template()
452 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
454 * Revision 1.28 2001/09/19 18:00:37 oes
455 * - Deletef time() FIXME (Can't fail under Linux either, if
456 * the argument is guaranteed to be in out address space,
459 * - Pointer notation cosmetics
460 * - Fixed a minor bug in template_fill(): Failiure of
461 * pcrs_execute() now secure.
463 * Revision 1.27 2001/09/16 17:08:54 jongfoster
464 * Moving simple CGI functions from cgi.c to new file cgisimple.c
466 * Revision 1.26 2001/09/16 15:47:37 jongfoster
467 * First version of CGI-based edit interface. This is very much a
468 * work-in-progress, and you can't actually use it to edit anything
469 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
470 * to have any effect.
472 * Revision 1.25 2001/09/16 15:02:35 jongfoster
473 * Adding i.j.b/robots.txt.
474 * Inlining add_stats() since it's only ever called from one place.
476 * Revision 1.24 2001/09/16 11:38:01 jongfoster
477 * Splitting fill_template() into 2 functions:
478 * template_load() loads the file
479 * template_fill() performs the PCRS regexps.
480 * This is because the CGI edit interface has a "table row"
481 * template which is used many times in the page - this
482 * change means it's only loaded from disk once.
484 * Revision 1.23 2001/09/16 11:16:05 jongfoster
485 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
487 * Revision 1.22 2001/09/16 11:00:10 jongfoster
488 * New function alloc_http_response, for symmetry with free_http_response
490 * Revision 1.21 2001/09/13 23:53:03 jongfoster
491 * Support for both static and dynamically generated CGI pages.
492 * Correctly setting Last-Modified: and Expires: HTTP headers.
494 * Revision 1.20 2001/09/13 23:40:36 jongfoster
495 * (Cosmetic only) Indentation correction
497 * Revision 1.19 2001/09/13 23:31:25 jongfoster
498 * Moving image data to cgi.c rather than cgi.h.
500 * Revision 1.18 2001/08/05 16:06:20 jongfoster
501 * Modifiying "struct map" so that there are now separate header and
502 * "map_entry" structures. This means that functions which modify a
503 * map no longer need to return a pointer to the modified map.
504 * Also, it no longer reverses the order of the entries (which may be
505 * important with some advanced template substitutions).
507 * Revision 1.17 2001/08/05 15:57:38 oes
508 * Adapted finish_http_response to new list_to_text
510 * Revision 1.16 2001/08/01 21:33:18 jongfoster
511 * Changes to fill_template() that reduce memory usage without having
512 * an impact on performance. I also renamed some variables so as not
513 * to clash with the C++ keywords "new" and "template".
515 * Revision 1.15 2001/08/01 21:19:22 jongfoster
516 * Moving file version information to a separate CGI page.
518 * Revision 1.14 2001/08/01 00:19:03 jongfoster
519 * New function: map_conditional() for an if-then-else syntax.
520 * Changing to use new version of show_defines()
522 * Revision 1.13 2001/07/30 22:08:36 jongfoster
523 * Tidying up #defines:
524 * - All feature #defines are now of the form FEATURE_xxx
525 * - Permanently turned off WIN_GUI_EDIT
526 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
528 * Revision 1.12 2001/07/29 18:47:05 jongfoster
529 * Adding missing #include "loadcfg.h"
531 * Revision 1.11 2001/07/18 17:24:37 oes
532 * Changed to conform to new pcrs interface
534 * Revision 1.10 2001/07/13 13:53:13 oes
535 * Removed all #ifdef PCRS and related code
537 * Revision 1.9 2001/06/29 21:45:41 oes
538 * Indentation, CRLF->LF, Tab-> Space
540 * Revision 1.8 2001/06/29 13:21:46 oes
541 * - Cosmetics: renamed and reordered functions, variables,
542 * texts, improved comments etc
544 * - Removed ij_untrusted_url() The relevant
545 * info is now part of the "untrusted" page,
546 * which is generated by filters.c:trust_url()
548 * - Generators of content now call finish_http_response()
549 * themselves, making jcc.c:chat() a little less
552 * - Removed obsolete "Pragma: no-cache" from our headers
554 * - http_responses now know their head length
556 * - fill_template now uses the new interface to pcrs, so that
557 * - long jobs (like whole files) no longer have to be assembled
558 * in a fixed size buffer
559 * - the new T (trivial) option is used, and the replacement may
560 * contain Perl syntax backrefs without confusing pcrs
562 * - Introduced default_exports() which generates a set of exports
563 * common to all CGIs and other content generators
565 * - Introduced convenience function map_block_killer()
567 * - Introduced convenience function make_menu()
569 * - Introduced CGI-like function error_response() which generates
570 * the "No such domain" and "Connect failed" messages using the
573 * - cgi_show_url_info:
574 * - adapted to new CGI features
575 * - form and answers now generated from same template
576 * - http:// prefix in URL now OK
579 * - adapted to new CGI features
580 * - no longer uses csp->init_proxy_args
583 * - moved menu generation to make_menu()
585 * - add_stats now writes single export map entries instead
588 * - Moved redirect_url() to filters.c
590 * - Fixed mem leak in free_http_response(), map_block_killer(),
592 * - Removed logentry from cancelled commit
594 * Revision 1.7 2001/06/09 10:51:58 jongfoster
595 * Changing "show URL info" handler to new style.
596 * Changing BUFSIZ ==> BUFFER_SIZE
598 * Revision 1.6 2001/06/07 23:05:19 jongfoster
599 * Removing code related to old forward and ACL files.
601 * Revision 1.5 2001/06/05 19:59:16 jongfoster
602 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
604 * Revision 1.4 2001/06/04 10:41:52 swa
605 * show version string of cgi.h and cgi.c
607 * Revision 1.3 2001/06/03 19:12:16 oes
608 * introduced new cgi handling
610 * No revisions before 1.3
612 **********************************************************************/
618 #include <sys/types.h>
632 #include "miscutil.h"
633 #include "cgisimple.h"
634 #include "jbsockets.h"
635 #ifdef FEATURE_CGI_EDIT_ACTIONS
637 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
639 /* loadcfg.h is for global_toggle_state only */
640 #ifdef FEATURE_PTHREAD
642 /* jcc.h is for mutex semaphore globals only */
643 #endif /* def FEATURE_PTHREAD */
644 const char cgi_h_rcs[] = CGI_H_VERSION;
647 * List of CGI functions: name, handler, description
648 * Note: Do NOT use single quotes in the description;
649 * this will break the dynamic "blocked" template!
651 static const struct cgi_dispatcher cgi_dispatchers[] = {
656 #ifdef FEATURE_GRACEFUL_TERMINATION
659 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
660 "this is a one click Denial Of Service attack!!!</em>",
665 #ifdef FEATURE_CGI_EDIT_ACTIONS
666 "View & change the current configuration",
668 "View the current configuration",
673 "View the source code version numbers",
677 "View the request headers.",
681 "Look up which actions apply to a URL and why",
683 #ifdef FEATURE_CGI_EDIT_ACTIONS
684 #ifdef FEATURE_TOGGLE
687 "Toggle Privoxy on or off",
689 #endif /* def FEATURE_TOGGLE */
690 { "edit-actions", /* Edit the actions list */
693 { "eaa", /* Shortcut for edit-actions-add-url-form */
694 cgi_edit_actions_add_url_form,
696 { "eau", /* Shortcut for edit-actions-url-form */
697 cgi_edit_actions_url_form,
699 { "ear", /* Shortcut for edit-actions-remove-url-form */
700 cgi_edit_actions_remove_url_form,
702 { "eal", /* Shortcut for edit-actions-list */
703 cgi_edit_actions_list,
705 { "eafu", /* Shortcut for edit-actions-for-url */
706 cgi_edit_actions_for_url,
708 { "eas", /* Shortcut for edit-actions-submit */
709 cgi_edit_actions_submit,
711 { "easa", /* Shortcut for edit-actions-section-add */
712 cgi_edit_actions_section_add,
714 { "easr", /* Shortcut for edit-actions-section-remove */
715 cgi_edit_actions_section_remove,
717 { "eass", /* Shortcut for edit-actions-section-swap */
718 cgi_edit_actions_section_swap,
720 { "edit-actions-for-url",
721 cgi_edit_actions_for_url,
722 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
723 { "edit-actions-list",
724 cgi_edit_actions_list,
725 NULL, TRUE /* Edit the actions list */ },
726 { "edit-actions-submit",
727 cgi_edit_actions_submit,
728 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
729 { "edit-actions-url",
730 cgi_edit_actions_url,
731 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
732 { "edit-actions-url-form",
733 cgi_edit_actions_url_form,
734 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
735 { "edit-actions-add-url",
736 cgi_edit_actions_add_url,
737 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
738 { "edit-actions-add-url-form",
739 cgi_edit_actions_add_url_form,
740 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
741 { "edit-actions-remove-url",
742 cgi_edit_actions_remove_url,
743 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
744 { "edit-actions-remove-url-form",
745 cgi_edit_actions_remove_url_form,
746 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
747 { "edit-actions-section-add",
748 cgi_edit_actions_section_add,
749 NULL, FALSE /* Remove a section from the actionsfile */ },
750 { "edit-actions-section-remove",
751 cgi_edit_actions_section_remove,
752 NULL, FALSE /* Remove a section from the actionsfile */ },
753 { "edit-actions-section-swap",
754 cgi_edit_actions_section_swap,
755 NULL, FALSE /* Swap two sections in the actionsfile */ },
756 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
757 { "error-favicon.ico",
758 cgi_send_error_favicon,
759 NULL, TRUE /* Sends the favicon image for error pages. */ },
761 cgi_send_default_favicon,
762 NULL, TRUE /* Sends the default favicon image. */ },
765 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
768 NULL, TRUE /* Send a built-in image */ },
771 NULL, FALSE /* Send templates/cgi-style.css */ },
773 cgi_transparent_image,
774 NULL, TRUE /* Send a transparent image (short name) */ },
775 { "url-info-osd.xml",
776 cgi_send_url_info_osd,
777 NULL, TRUE /* Send templates/url-info-osd.xml */ },
779 cgi_send_user_manual,
780 NULL, TRUE /* Send user-manual */ },
781 { NULL, /* NULL Indicates end of list and default page */
783 NULL, TRUE /* Unknown CGI page */ }
788 * Built-in images for ad replacement
790 * Hint: You can encode your own images like this:
791 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
794 #ifdef FEATURE_NO_GIFS
797 * Checkerboard pattern, as a PNG.
799 const char image_pattern_data[] =
800 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
801 "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
802 "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
803 "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
804 "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
805 "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
806 "\000\000\000\000\111\105\116\104\256\102\140\202";
809 * 1x1 transparant PNG.
811 const char image_blank_data[] =
812 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
813 "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
814 "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
815 "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
816 "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
817 "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
818 "\000\000\000\000\111\105\116\104\256\102\140\202";
822 * Checkerboard pattern, as a GIF.
824 const char image_pattern_data[] =
825 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
826 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
827 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
828 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
832 * 1x1 transparant GIF.
834 const char image_blank_data[] =
835 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
836 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
837 "\000\001\000\000\002\002D\001\000;";
840 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
841 const size_t image_blank_length = sizeof(image_blank_data) - 1;
844 static struct http_response cgi_error_memory_response[1];
846 static struct http_response *dispatch_known_cgi(struct client_state * csp,
848 static struct map *parse_cgi_parameters(char *argstring);
851 /*********************************************************************
853 * Function : dispatch_cgi
855 * Description : Checks if a request URL has either the magical
856 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
857 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
858 * http://config.privoxy.org/). If so, it passes
859 * the (rest of the) path onto dispatch_known_cgi, which
860 * calls the relevant CGI handler function.
863 * 1 : csp = Current client state (buffers, headers, etc...)
865 * Returns : http_response if match, NULL if nonmatch or handler fail
867 *********************************************************************/
868 struct http_response *dispatch_cgi(struct client_state *csp)
870 const char *host = csp->http->host;
871 const char *path = csp->http->path;
874 * Should we intercept ?
877 /* Note: "example.com" and "example.com." are equivalent hostnames. */
879 /* Either the host matches CGI_SITE_1_HOST ..*/
880 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
881 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
882 && (path[0] == '/') )
884 /* ..then the path will all be for us. Remove leading '/' */
887 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
888 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
889 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
890 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
892 /* take everything following CGI_SITE_2_PATH */
893 path += strlen(CGI_SITE_2_PATH);
896 /* skip the forward slash after CGI_SITE_2_PATH */
899 else if (*path != '\0')
902 * weirdness: URL is /configXXX, where XXX is some string
903 * Do *NOT* intercept.
915 * This is a CGI call.
918 return dispatch_known_cgi(csp, path);
922 /*********************************************************************
924 * Function : grep_cgi_referrer
926 * Description : Ugly provisorical fix that greps the value of the
927 * referer HTTP header field out of a linked list of
928 * strings like found at csp->headers. Will disappear
931 * FIXME: csp->headers ought to be csp->http->headers
932 * FIXME: Parsing all client header lines should
933 * happen right after the request is received!
936 * 1 : csp = Current client state (buffers, headers, etc...)
938 * Returns : pointer to value (no copy!), or NULL if none found.
940 *********************************************************************/
941 static char *grep_cgi_referrer(const struct client_state *csp)
943 struct list_entry *p;
945 for (p = csp->headers->first; p != NULL; p = p->next)
947 if (p->str == NULL) continue;
948 if (strncmpic(p->str, "Referer: ", 9) == 0)
950 return ((p->str) + 9);
958 /*********************************************************************
960 * Function : referrer_is_safe
962 * Description : Decides whether we trust the Referer for
963 * CGI pages which are only meant to be reachable
964 * through Privoxy's web interface directly.
967 * 1 : csp = Current client state (buffers, headers, etc...)
969 * Returns : TRUE if the referrer is safe, or
970 * FALSE if the referrer is unsafe or not set.
972 *********************************************************************/
973 static int referrer_is_safe(const struct client_state *csp)
976 static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
978 referrer = grep_cgi_referrer(csp);
980 if (NULL == referrer)
982 /* No referrer, no access */
983 log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
986 else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
987 || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
989 /* Trustworthy referrer */
990 log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
991 csp->http->url, referrer);
997 /* Untrustworthy referrer */
998 log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
999 csp->http->url, referrer);
1006 /*********************************************************************
1008 * Function : dispatch_known_cgi
1010 * Description : Processes a CGI once dispatch_cgi has determined that
1011 * it matches one of the magic prefixes. Parses the path
1012 * as a cgi name plus query string, prepares a map that
1013 * maps CGI parameter names to their values, initializes
1014 * the http_response struct, and calls the relevant CGI
1018 * 1 : csp = Current client state (buffers, headers, etc...)
1019 * 2 : path = Path of CGI, with the CGI prefix removed.
1020 * Should not have a leading "/".
1022 * Returns : http_response, or NULL on handler failure or out of
1025 *********************************************************************/
1026 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1029 const struct cgi_dispatcher *d;
1030 struct map *param_list;
1031 struct http_response *rsp;
1032 char *query_args_start;
1036 if (NULL == (path_copy = strdup(path)))
1038 return cgi_error_memory();
1040 query_args_start = path_copy;
1041 while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1045 if (*query_args_start == '/')
1047 *query_args_start++ = '\0';
1048 if ((param_list = new_map()))
1050 map(param_list, "file", 1, url_decode(query_args_start), 0);
1055 if (*query_args_start == '?')
1057 *query_args_start++ = '\0';
1059 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1062 return cgi_error_memory();
1068 * path_copy = CGI call name
1069 * param_list = CGI params, as map
1072 /* Get mem for response or fail*/
1073 if (NULL == (rsp = alloc_http_response()))
1076 free_map(param_list);
1077 return cgi_error_memory();
1081 * Find and start the right CGI function
1083 d = cgi_dispatchers;
1086 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1089 * If the called CGI is either harmless, or referred
1090 * from a trusted source, start it.
1092 if (d->harmless || referrer_is_safe(csp))
1094 err = (d->handler)(csp, rsp, param_list);
1099 * Else, modify toggle calls so that they only display
1100 * the status, and deny all other calls.
1102 if (0 == strcmp(path_copy, "toggle"))
1104 unmap(param_list, "set");
1105 err = (d->handler)(csp, rsp, param_list);
1109 err = cgi_error_disabled(csp, rsp);
1114 free_map(param_list);
1116 if (err == JB_ERR_CGI_PARAMS)
1118 err = cgi_error_bad_param(csp, rsp);
1120 if (err && (err != JB_ERR_MEMORY))
1122 /* Unexpected error! Shouldn't get here */
1123 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
1124 err = cgi_error_unknown(csp, rsp, err);
1129 rsp->reason = RSP_REASON_CGI_CALL;
1130 return finish_http_response(csp, rsp);
1134 /* Error in handler, probably out-of-memory */
1135 free_http_response(rsp);
1136 return cgi_error_memory();
1144 /*********************************************************************
1146 * Function : parse_cgi_parameters
1148 * Description : Parse a URL-encoded argument string into name/value
1149 * pairs and store them in a struct map list.
1152 * 1 : argstring = string to be parsed. Will be trashed.
1154 * Returns : pointer to param list, or NULL if out of memory.
1156 *********************************************************************/
1157 static struct map *parse_cgi_parameters(char *argstring)
1160 char *vector[BUFFER_SIZE];
1162 struct map *cgi_params;
1164 if (NULL == (cgi_params = new_map()))
1170 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1171 * the fragment identifier along with the request, so we must
1172 * cut it off here, so it won't pollute the CGI params:
1174 if (NULL != (p = strchr(argstring, '#')))
1179 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1181 for (i = 0; i < pairs; i++)
1183 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1186 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1188 free_map(cgi_params);
1199 /*********************************************************************
1201 * Function : get_char_param
1203 * Description : Get a single-character parameter passed to a CGI
1207 * 1 : parameters = map of cgi parameters
1208 * 2 : param_name = The name of the parameter to read
1210 * Returns : Uppercase character on success, '\0' on error.
1212 *********************************************************************/
1213 char get_char_param(const struct map *parameters,
1214 const char *param_name)
1221 ch = *(lookup(parameters, param_name));
1222 if ((ch >= 'a') && (ch <= 'z'))
1224 ch = (char)(ch - 'a' + 'A');
1231 /*********************************************************************
1233 * Function : get_string_param
1235 * Description : Get a string paramater, to be used as an
1236 * ACTION_STRING or ACTION_MULTI paramater.
1237 * Validates the input to prevent stupid/malicious
1238 * users from corrupting their action file.
1241 * 1 : parameters = map of cgi parameters
1242 * 2 : param_name = The name of the parameter to read
1243 * 3 : pparam = destination for paramater. Allocated as
1244 * part of the map "parameters", so don't free it.
1245 * Set to NULL if not specified.
1247 * Returns : JB_ERR_OK on success, or if the paramater
1248 * was not specified.
1249 * JB_ERR_MEMORY on out-of-memory.
1250 * JB_ERR_CGI_PARAMS if the paramater is not valid.
1252 *********************************************************************/
1253 jb_err get_string_param(const struct map *parameters,
1254 const char *param_name,
1255 const char **pparam)
1267 param = lookup(parameters, param_name);
1273 if (strlen(param) >= CGI_PARAM_LEN_MAX)
1278 * Note that the length limit is arbitrary, it just seems
1279 * sensible to limit it to *something*. There's no
1280 * technical reason for any limit at all.
1282 return JB_ERR_CGI_PARAMS;
1285 /* Check every character to see if it's legal */
1287 while ((ch = *s++) != '\0')
1289 if ( ((unsigned char)ch < (unsigned char)' ')
1292 /* Probable hack attempt, or user accidentally used '}'. */
1293 return JB_ERR_CGI_PARAMS;
1304 /*********************************************************************
1306 * Function : get_number_param
1308 * Description : Get a non-negative integer from the parameters
1309 * passed to a CGI function.
1312 * 1 : csp = Current client state (buffers, headers, etc...)
1313 * 2 : parameters = map of cgi parameters
1314 * 3 : name = Name of CGI parameter to read
1315 * 4 : pvalue = destination for value.
1316 * Set to -1 on error.
1318 * Returns : JB_ERR_OK on success
1319 * JB_ERR_MEMORY on out-of-memory
1320 * JB_ERR_CGI_PARAMS if the parameter was not specified
1323 *********************************************************************/
1324 jb_err get_number_param(struct client_state *csp,
1325 const struct map *parameters,
1340 param = lookup(parameters, name);
1343 return JB_ERR_CGI_PARAMS;
1346 /* We don't use atoi because I want to check this carefully... */
1349 while ((ch = *param++) != '\0')
1351 if ((ch < '0') || (ch > '9'))
1353 return JB_ERR_CGI_PARAMS;
1356 ch = (char)(ch - '0');
1360 * <limits.h> defines UINT_MAX
1362 * (UINT_MAX - ch) / 10 is the largest number that
1363 * can be safely multiplied by 10 then have ch added.
1365 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1367 return JB_ERR_CGI_PARAMS;
1370 value = value * 10 + (unsigned)ch;
1381 /*********************************************************************
1383 * Function : error_response
1385 * Description : returns an http_response that explains the reason
1386 * why a request failed.
1389 * 1 : csp = Current client state (buffers, headers, etc...)
1390 * 2 : templatename = Which template should be used for the answer
1391 * 3 : sys_err = system error number
1393 * Returns : A http_response. If we run out of memory, this
1394 * will be cgi_error_memory().
1396 *********************************************************************/
1397 struct http_response *error_response(struct client_state *csp,
1398 const char *templatename,
1402 struct http_response *rsp;
1403 struct map *exports = default_exports(csp, NULL);
1406 if (exports == NULL)
1408 return cgi_error_memory();
1411 if (NULL == (rsp = alloc_http_response()))
1414 return cgi_error_memory();
1417 #ifdef FEATURE_FORCE_LOAD
1418 if (csp->flags & CSP_FLAG_FORCED)
1420 path = strdup(FORCE_PREFIX);
1423 #endif /* def FEATURE_FORCE_LOAD */
1427 err = string_append(&path, csp->http->path);
1429 if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1430 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1431 if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1432 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1433 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1436 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1439 /* Some failures, like "404 no such domain", don't have an IP address. */
1440 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1448 free_http_response(rsp);
1449 return cgi_error_memory();
1452 if (!strcmp(templatename, "no-such-domain"))
1454 rsp->status = strdup("404 No such domain");
1455 if (rsp->status == NULL)
1458 free_http_response(rsp);
1459 return cgi_error_memory();
1461 rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1463 else if (!strcmp(templatename, "forwarding-failed"))
1465 const struct forward_spec *fwd = forward_url(csp, csp->http);
1466 char *socks_type = NULL;
1469 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1470 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1474 * XXX: While the template is called forwarding-failed,
1475 * it currently only handles socks forwarding failures.
1477 assert(fwd->type != SOCKS_NONE);
1480 * Map failure reason, forwarding type and forwarder.
1482 if (NULL == csp->error_message)
1485 * Either we forgot to record the failure reason,
1486 * or the memory allocation failed.
1488 log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1489 csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1491 if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1494 * XXX: this is almost the same code as in cgi_show_url_info()
1495 * and thus should be factored out and shared.
1500 socks_type = "socks4-";
1503 socks_type = "socks4a-";
1506 socks_type = "socks5-";
1509 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1512 if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1513 if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1515 if (!err) rsp->status = strdup("503 Forwarding failure");
1516 if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1519 free_http_response(rsp);
1520 return cgi_error_memory();
1522 rsp->reason = RSP_REASON_FORWARDING_FAILED;
1524 else if (!strcmp(templatename, "connect-failed"))
1526 rsp->status = strdup("503 Connect failed");
1527 if (rsp->status == NULL)
1530 free_http_response(rsp);
1531 return cgi_error_memory();
1533 rsp->reason = RSP_REASON_CONNECT_FAILED;
1536 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1539 free_http_response(rsp);
1540 return cgi_error_memory();
1543 return finish_http_response(csp, rsp);
1547 /*********************************************************************
1549 * Function : cgi_error_disabled
1551 * Description : CGI function that is called to generate an error
1552 * response if the actions editor or toggle CGI are
1553 * accessed despite having being disabled at compile-
1554 * or run-time, or if the user followed an untrusted link
1555 * to access a unsafe CGI feature that is only reachable
1556 * through Privoxy directly.
1559 * 1 : csp = Current client state (buffers, headers, etc...)
1560 * 2 : rsp = http_response data structure for output
1562 * CGI Parameters : none
1564 * Returns : JB_ERR_OK on success
1565 * JB_ERR_MEMORY on out-of-memory error.
1567 *********************************************************************/
1568 jb_err cgi_error_disabled(const struct client_state *csp,
1569 struct http_response *rsp)
1571 struct map *exports;
1576 if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1578 return JB_ERR_MEMORY;
1580 if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1582 /* Not important enough to do anything */
1583 log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1586 return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1590 /*********************************************************************
1592 * Function : cgi_init_error_messages
1594 * Description : Call at the start of the program to initialize
1595 * the error message used by cgi_error_memory().
1601 *********************************************************************/
1602 void cgi_init_error_messages(void)
1604 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1605 cgi_error_memory_response->head =
1606 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1607 "Content-Type: text/html\r\n"
1609 cgi_error_memory_response->body =
1612 " <title>500 Internal Privoxy Error</title>\r\n"
1613 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1616 "<h1>500 Internal Privoxy Error</h1>\r\n"
1617 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1618 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1622 cgi_error_memory_response->head_length =
1623 strlen(cgi_error_memory_response->head);
1624 cgi_error_memory_response->content_length =
1625 strlen(cgi_error_memory_response->body);
1626 cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1630 /*********************************************************************
1632 * Function : cgi_error_memory
1634 * Description : Called if a CGI function runs out of memory.
1635 * Returns a statically-allocated error response.
1639 * Returns : http_response data structure for output. This is
1640 * statically allocated, for obvious reasons.
1642 *********************************************************************/
1643 struct http_response *cgi_error_memory(void)
1645 /* assert that it's been initialized. */
1646 assert(cgi_error_memory_response->head);
1648 return cgi_error_memory_response;
1652 /*********************************************************************
1654 * Function : cgi_error_no_template
1656 * Description : Almost-CGI function that is called if a template
1657 * cannot be loaded. Note this is not a true CGI,
1658 * it takes a template name rather than a map of
1662 * 1 : csp = Current client state (buffers, headers, etc...)
1663 * 2 : rsp = http_response data structure for output
1664 * 3 : template_name = Name of template that could not
1667 * Returns : JB_ERR_OK on success
1668 * JB_ERR_MEMORY on out-of-memory error.
1670 *********************************************************************/
1671 jb_err cgi_error_no_template(const struct client_state *csp,
1672 struct http_response *rsp,
1673 const char *template_name)
1675 static const char status[] =
1676 "500 Internal Privoxy Error";
1677 static const char body_prefix[] =
1680 " <title>500 Internal Privoxy Error</title>\r\n"
1681 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1684 "<h1>500 Internal Privoxy Error</h1>\r\n"
1685 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1686 "<p><b>Could not load template file <code>";
1687 static const char body_suffix[] =
1688 "</code> or one of its included components.</b></p>\r\n"
1689 "<p>Please contact your proxy administrator.</p>\r\n"
1690 "<p>If you are the proxy administrator, please put the required file(s)"
1691 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1692 "location of the <code><i>(confdir)</i></code> directory "
1693 "is specified in the main Privoxy <code>config</code> "
1694 "file. (It's typically the Privoxy install directory"
1696 ", or <code>/etc/privoxy/</code>"
1697 #endif /* ndef _WIN32 */
1701 const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1705 assert(template_name);
1707 /* Reset rsp, if needed */
1711 rsp->content_length = 0;
1712 rsp->head_length = 0;
1715 rsp->body = malloc(body_size);
1716 if (rsp->body == NULL)
1718 return JB_ERR_MEMORY;
1720 strlcpy(rsp->body, body_prefix, body_size);
1721 strlcat(rsp->body, template_name, body_size);
1722 strlcat(rsp->body, body_suffix, body_size);
1724 rsp->status = strdup(status);
1725 if (rsp->status == NULL)
1727 return JB_ERR_MEMORY;
1734 /*********************************************************************
1736 * Function : cgi_error_unknown
1738 * Description : Almost-CGI function that is called if an unexpected
1739 * error occurs in the top-level CGI dispatcher.
1740 * In this context, "unexpected" means "anything other
1741 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1742 * expected to handle all other errors internally,
1743 * since they can give more relavent error messages
1746 * Note this is not a true CGI, it takes an error
1747 * code rather than a map of parameters.
1750 * 1 : csp = Current client state (buffers, headers, etc...)
1751 * 2 : rsp = http_response data structure for output
1752 * 3 : error_to_report = Error code to report.
1754 * Returns : JB_ERR_OK on success
1755 * JB_ERR_MEMORY on out-of-memory error.
1757 *********************************************************************/
1758 jb_err cgi_error_unknown(const struct client_state *csp,
1759 struct http_response *rsp,
1760 jb_err error_to_report)
1762 static const char status[] =
1763 "500 Internal Privoxy Error";
1764 static const char body_prefix[] =
1767 " <title>500 Internal Privoxy Error</title>\r\n"
1768 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1771 "<h1>500 Internal Privoxy Error</h1>\r\n"
1772 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1773 "<p><b>Unexpected internal error: ";
1774 static const char body_suffix[] =
1777 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1778 "file a bug report</a>.</p>\r\n"
1783 * Due to sizeof(errnumbuf), body_size will be slightly
1784 * bigger than necessary but it doesn't really matter.
1786 const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1790 /* Reset rsp, if needed */
1794 rsp->content_length = 0;
1795 rsp->head_length = 0;
1797 rsp->reason = RSP_REASON_INTERNAL_ERROR;
1799 snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1801 rsp->body = malloc(body_size);
1802 if (rsp->body == NULL)
1804 return JB_ERR_MEMORY;
1806 strlcpy(rsp->body, body_prefix, body_size);
1807 strlcat(rsp->body, errnumbuf, body_size);
1808 strlcat(rsp->body, body_suffix, body_size);
1810 rsp->status = strdup(status);
1811 if (rsp->status == NULL)
1813 return JB_ERR_MEMORY;
1820 /*********************************************************************
1822 * Function : cgi_error_bad_param
1824 * Description : CGI function that is called if the parameters
1825 * (query string) for a CGI were wrong.
1828 * 1 : csp = Current client state (buffers, headers, etc...)
1829 * 2 : rsp = http_response data structure for output
1831 * CGI Parameters : none
1833 * Returns : JB_ERR_OK on success
1834 * JB_ERR_MEMORY on out-of-memory error.
1836 *********************************************************************/
1837 jb_err cgi_error_bad_param(const struct client_state *csp,
1838 struct http_response *rsp)
1840 struct map *exports;
1845 if (NULL == (exports = default_exports(csp, NULL)))
1847 return JB_ERR_MEMORY;
1850 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1854 /*********************************************************************
1856 * Function : cgi_redirect
1858 * Description : CGI support function to generate a HTTP redirect
1862 * 1 : rsp = http_response data structure for output
1863 * 2 : target = string with the target URL
1865 * CGI Parameters : None
1867 * Returns : JB_ERR_OK on success
1868 * JB_ERR_MEMORY on out-of-memory error.
1870 *********************************************************************/
1871 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1878 err = enlist_unique_header(rsp->headers, "Location", target);
1880 rsp->status = strdup("302 Local Redirect from Privoxy");
1881 if (rsp->status == NULL)
1883 return JB_ERR_MEMORY;
1890 /*********************************************************************
1892 * Function : add_help_link
1894 * Description : Produce a copy of the string given as item,
1895 * embedded in an HTML link to its corresponding
1896 * section (item name in uppercase) in the actions
1897 * chapter of the user manual, (whose URL is given in
1898 * the config and defaults to our web site).
1900 * FIXME: I currently only work for actions, and would
1901 * like to be generalized for other topics.
1904 * 1 : item = item (will NOT be free()d.)
1905 * It is assumed to be HTML-safe.
1906 * 2 : config = The current configuration.
1908 * Returns : String with item embedded in link, or NULL on
1911 *********************************************************************/
1912 char *add_help_link(const char *item,
1913 struct configuration_spec *config)
1917 if (!item) return NULL;
1919 result = strdup("<a href=\"");
1920 if (!strncmpic(config->usermanual, "file://", 7) ||
1921 !strncmpic(config->usermanual, "http", 4))
1923 string_append(&result, config->usermanual);
1927 string_append(&result, "http://");
1928 string_append(&result, CGI_SITE_2_HOST);
1929 string_append(&result, "/user-manual/");
1931 string_append(&result, ACTIONS_HELP_PREFIX);
1932 string_join (&result, string_toupper(item));
1933 string_append(&result, "\">");
1934 string_append(&result, item);
1935 string_append(&result, "</a> ");
1941 /*********************************************************************
1943 * Function : get_http_time
1945 * Description : Get the time in a format suitable for use in a
1946 * HTTP header - e.g.:
1947 * "Sun, 06 Nov 1994 08:49:37 GMT"
1950 * 1 : time_offset = Time returned will be current time
1951 * plus this number of seconds.
1952 * 2 : buf = Destination for result.
1953 * 3 : buffer_size = Size of the buffer above. Must be big
1954 * enough to hold 29 characters plus a
1959 *********************************************************************/
1960 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1962 static const char day_names[7][4] =
1963 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1964 static const char month_names[12][4] =
1965 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1966 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1969 time_t current_time;
1970 #if defined(HAVE_GMTIME_R)
1972 * Declare dummy up here (instead of inside get/set gmt block) so it
1973 * doesn't go out of scope before it's potentially used in snprintf later.
1974 * Wrapping declaration inside HAVE_GMTIME_R keeps the compiler quiet when
1975 * !defined HAVE_GMTIME_R.
1981 assert(buffer_size > 29);
1983 time(¤t_time); /* get current time */
1985 current_time += time_offset;
1987 /* get and save the gmt */
1990 t = gmtime_r(¤t_time, &dummy);
1991 #elif FEATURE_PTHREAD
1992 pthread_mutex_lock(&gmtime_mutex);
1993 t = gmtime(¤t_time);
1994 pthread_mutex_unlock(&gmtime_mutex);
1996 t = gmtime(¤t_time);
2000 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
2001 snprintf(buf, buffer_size,
2002 "%s, %02d %s %4d %02d:%02d:%02d GMT",
2003 day_names[t->tm_wday],
2005 month_names[t->tm_mon],
2015 /*********************************************************************
2017 * Function : finish_http_response
2019 * Description : Fill in the missing headers in an http response,
2020 * and flatten the headers to an http head.
2021 * For HEAD requests the body is freed once
2022 * the Content-Length header is set.
2025 * 1 : rsp = pointer to http_response to be processed
2027 * Returns : A http_response, usually the rsp parameter.
2028 * On error, free()s rsp and returns cgi_error_memory()
2030 *********************************************************************/
2031 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2033 char buf[BUFFER_SIZE];
2036 /* Special case - do NOT change this statically allocated response,
2037 * which is ready for output anyway.
2039 if (rsp == cgi_error_memory_response)
2045 * Fill in the HTTP Status, using HTTP/1.1
2046 * unless the client asked for HTTP/1.0.
2048 snprintf(buf, sizeof(buf), "%s %s",
2049 strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2050 rsp->status ? rsp->status : "200 OK");
2051 err = enlist_first(rsp->headers, buf);
2054 * Set the Content-Length
2056 if (rsp->content_length == 0)
2058 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2062 snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2063 err = enlist(rsp->headers, buf);
2066 if (0 == strcmpic(csp->http->gpc, "head"))
2069 * The client only asked for the head. Dispose
2070 * the body and log an offensive message.
2072 * While it may seem to be a bit inefficient to
2073 * prepare the body if it isn't needed, it's the
2074 * only way to get the Content-Length right for
2075 * dynamic pages. We could have disposed the body
2076 * earlier, but not without duplicating the
2077 * Content-Length setting code above.
2079 log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2081 rsp->content_length = 0;
2084 if (strncmpic(rsp->status, "302", 3))
2087 * If it's not a redirect without any content,
2088 * set the Content-Type to text/html if it's
2089 * not already specified.
2091 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2095 * Fill in the rest of the default headers:
2097 * Date: set to current date/time.
2098 * Last-Modified: set to date/time the page was last changed.
2099 * Expires: set to date/time page next needs reloading.
2100 * Cache-Control: set to "no-cache" if applicable.
2102 * See http://www.w3.org/Protocols/rfc2068/rfc2068
2107 * Set Expires to about 10 min into the future so it'll get reloaded
2108 * occasionally, e.g. if Privoxy gets upgraded.
2113 get_http_time(0, buf, sizeof(buf));
2114 err = enlist_unique_header(rsp->headers, "Date", buf);
2117 /* Some date in the past. */
2118 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2122 get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
2123 err = enlist_unique_header(rsp->headers, "Expires", buf);
2126 else if (!strncmpic(rsp->status, "302", 3))
2128 get_http_time(0, buf, sizeof(buf));
2129 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2134 * Setting "Cache-Control" to "no-cache" and "Expires" to
2135 * the current time doesn't exactly forbid caching, it just
2136 * requires the client to revalidate the cached copy.
2138 * If a temporary problem occurs and the user tries again after
2139 * getting Privoxy's error message, a compliant browser may set the
2140 * If-Modified-Since header with the content of the error page's
2141 * Last-Modified header. More often than not, the document on the server
2142 * is older than Privoxy's error message, the server would send status code
2143 * 304 and the browser would display the outdated error message again and again.
2145 * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2146 * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2147 * and can be safely used to "revalidate" without getting a status code 304.
2149 * There is no need to let the useless If-Modified-Since header reach the
2150 * server, it is therefore stripped by client_if_modified_since in parsers.c.
2152 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2154 get_http_time(0, buf, sizeof(buf));
2155 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2156 if (!strncmpic(rsp->status, "403", 3)
2157 || !strncmpic(rsp->status, "404", 3)
2158 || !strncmpic(rsp->status, "503", 3))
2160 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2164 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2166 if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2167 if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2173 * HTTP/1.1 applications that do not support persistent connections MUST
2174 * include the "close" connection option in every message.
2176 if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2181 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2183 free_http_response(rsp);
2184 return cgi_error_memory();
2186 rsp->head_length = strlen(rsp->head);
2193 /*********************************************************************
2195 * Function : alloc_http_response
2197 * Description : Allocates a new http_response structure.
2201 * Returns : pointer to a new http_response, or NULL.
2203 *********************************************************************/
2204 struct http_response *alloc_http_response(void)
2206 return (struct http_response *) zalloc(sizeof(struct http_response));
2211 /*********************************************************************
2213 * Function : free_http_response
2215 * Description : Free the memory occupied by an http_response
2216 * and its depandant structures.
2219 * 1 : rsp = pointer to http_response to be freed
2223 *********************************************************************/
2224 void free_http_response(struct http_response *rsp)
2227 * Must special case cgi_error_memory_response, which is never freed.
2229 if (rsp && (rsp != cgi_error_memory_response))
2234 destroy_list(rsp->headers);
2241 /*********************************************************************
2243 * Function : template_load
2245 * Description : CGI support function that loads a given HTML
2246 * template, ignoring comment lines and following
2247 * #include statements up to a depth of 1.
2250 * 1 : csp = Current client state (buffers, headers, etc...)
2251 * 2 : template_ptr = Destination for pointer to loaded
2253 * 3 : templatename = name of the HTML template to be used
2254 * 4 : recursive = Flag set if this function calls itself
2255 * following an #include statament
2257 * Returns : JB_ERR_OK on success
2258 * JB_ERR_MEMORY on out-of-memory error.
2259 * JB_ERR_FILE if the template file cannot be read
2261 *********************************************************************/
2262 jb_err template_load(const struct client_state *csp, char **template_ptr,
2263 const char *templatename, int recursive)
2266 char *templates_dir_path;
2269 char *included_module;
2272 char buf[BUFFER_SIZE];
2275 assert(template_ptr);
2276 assert(templatename);
2278 *template_ptr = NULL;
2280 /* Validate template name. Paranoia. */
2281 for (p = templatename; *p != 0; p++)
2283 if ( ((*p < 'a') || (*p > 'z'))
2284 && ((*p < 'A') || (*p > 'Z'))
2285 && ((*p < '0') || (*p > '9'))
2289 /* Illegal character */
2295 * Generate full path using either templdir
2296 * or confdir/templates as base directory.
2298 if (NULL != csp->config->templdir)
2300 templates_dir_path = strdup(csp->config->templdir);
2304 templates_dir_path = make_path(csp->config->confdir, "templates");
2307 if (templates_dir_path == NULL)
2309 log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2311 return JB_ERR_MEMORY;
2314 full_path = make_path(templates_dir_path, templatename);
2315 free(templates_dir_path);
2316 if (full_path == NULL)
2318 log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2320 return JB_ERR_MEMORY;
2323 /* Allocate buffer */
2325 file_buffer = strdup("");
2326 if (file_buffer == NULL)
2328 log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2330 return JB_ERR_MEMORY;
2333 /* Open template file */
2335 if (NULL == (fp = fopen(full_path, "r")))
2337 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2345 * Read the file, ignoring comments, and honoring #include
2346 * statements, unless we're already called recursively.
2348 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2349 * This is unlikely in practise.
2351 while (fgets(buf, BUFFER_SIZE, fp))
2353 if (!recursive && !strncmp(buf, "#include ", 9))
2355 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2362 if (string_join(&file_buffer, included_module))
2365 return JB_ERR_MEMORY;
2371 /* skip lines starting with '#' */
2377 if (string_append(&file_buffer, buf))
2380 return JB_ERR_MEMORY;
2385 *template_ptr = file_buffer;
2391 /*********************************************************************
2393 * Function : template_fill
2395 * Description : CGI support function that fills in a pre-loaded
2396 * HTML template by replacing @name@ with value using
2397 * pcrs, for each item in the output map.
2399 * Note that a leading '$' charachter in the export map's
2400 * values will be stripped and toggle on backreference
2404 * 1 : template_ptr = IN: Template to be filled out.
2406 * OUT: Filled out template.
2407 * Caller must free().
2408 * 2 : exports = map with fill in symbol -> name pairs
2410 * Returns : JB_ERR_OK on success (and for uncritical errors)
2411 * JB_ERR_MEMORY on out-of-memory error
2413 *********************************************************************/
2414 jb_err template_fill(char **template_ptr, const struct map *exports)
2416 struct map_entry *m;
2418 char buf[BUFFER_SIZE];
2419 char *tmp_out_buffer;
2425 assert(template_ptr);
2426 assert(*template_ptr);
2429 file_buffer = *template_ptr;
2430 size = strlen(file_buffer) + 1;
2433 * Assemble pcrs joblist from exports map
2435 for (m = exports->first; m != NULL; m = m->next)
2437 if (*m->name == '$')
2440 * First character of name is '$', so remove this flag
2441 * character and allow backreferences ($1 etc) in the
2442 * "replace with" text.
2444 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2450 * Treat the "replace with" text as a literal string -
2451 * no quoting needed, no backreferences allowed.
2452 * ("Trivial" ['T'] flag).
2456 /* Enclose name in @@ */
2457 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2461 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2463 /* Make and run job. */
2464 job = pcrs_compile(buf, m->value, flags, &error);
2467 if (error == PCRS_ERR_NOMEM)
2470 *template_ptr = NULL;
2471 return JB_ERR_MEMORY;
2475 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2476 /* Hope it wasn't important and silently ignore the invalid job */
2481 error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2484 if (NULL == tmp_out_buffer)
2486 *template_ptr = NULL;
2487 return JB_ERR_MEMORY;
2493 * Substitution failed, keep the original buffer,
2494 * log the problem and ignore it.
2496 * The user might see some unresolved @CGI_VARIABLES@,
2497 * but returning a special CGI error page seems unreasonable
2498 * and could mask more important error messages.
2500 free(tmp_out_buffer);
2501 log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2502 buf, m->value, flags, pcrs_strerror(error));
2506 /* Substitution succeeded, use modified buffer. */
2508 file_buffer = tmp_out_buffer;
2516 *template_ptr = file_buffer;
2521 /*********************************************************************
2523 * Function : template_fill_for_cgi
2525 * Description : CGI support function that loads a HTML template
2526 * and fills it in. Handles file-not-found errors
2527 * by sending a HTML error message. For convenience,
2528 * this function also frees the passed "exports" map.
2531 * 1 : csp = Client state
2532 * 2 : templatename = name of the HTML template to be used
2533 * 3 : exports = map with fill in symbol -> name pairs.
2534 * Will be freed by this function.
2535 * 4 : rsp = Response structure to fill in.
2537 * Returns : JB_ERR_OK on success
2538 * JB_ERR_MEMORY on out-of-memory error
2540 *********************************************************************/
2541 jb_err template_fill_for_cgi(const struct client_state *csp,
2542 const char *templatename,
2543 struct map *exports,
2544 struct http_response *rsp)
2549 assert(templatename);
2553 err = template_load(csp, &rsp->body, templatename, 0);
2554 if (err == JB_ERR_FILE)
2557 return cgi_error_no_template(csp, rsp, templatename);
2562 return err; /* JB_ERR_MEMORY */
2564 err = template_fill(&rsp->body, exports);
2570 /*********************************************************************
2572 * Function : default_exports
2574 * Description : returns a struct map list that contains exports
2575 * which are common to all CGI functions.
2578 * 1 : csp = Current client state (buffers, headers, etc...)
2579 * 2 : caller = name of CGI who calls us and which should
2580 * be excluded from the generated menu. May be
2582 * Returns : NULL if no memory, else a new map. Caller frees.
2584 *********************************************************************/
2585 struct map *default_exports(const struct client_state *csp, const char *caller)
2589 struct map * exports;
2590 int local_help_exists = 0;
2591 char *ip_address = NULL;
2592 char *hostname = NULL;
2596 exports = new_map();
2597 if (exports == NULL)
2602 if (csp->config->hostname)
2604 get_host_information(csp->cfd, &ip_address, NULL);
2605 hostname = strdup(csp->config->hostname);
2609 get_host_information(csp->cfd, &ip_address, &hostname);
2612 err = map(exports, "version", 1, html_encode(VERSION), 0);
2613 if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2615 if (!err) err = map(exports, "my-hostname", 1, html_encode(hostname ? hostname : "unknown"), 0);
2617 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2618 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2619 if (!err) err = map(exports, "menu", 1, make_menu(caller, csp->config->feature_flags), 0);
2620 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2621 if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2622 !strncmpic(csp->config->usermanual, "http", 4))
2624 /* Manual is located somewhere else, just link to it. */
2625 if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2629 /* Manual is delivered by Privoxy. */
2630 if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2632 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2633 #ifdef FEATURE_TOGGLE
2634 if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2636 if (!err) err = map_block_killer(exports, "can-toggle");
2639 snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2640 if (!err) err = map(exports, "my-port", 1, buf, 1);
2642 if(!strcmp(CODE_STATUS, "stable"))
2644 if (!err) err = map_block_killer(exports, "unstable");
2647 if (csp->config->admin_address != NULL)
2649 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2650 local_help_exists = 1;
2654 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2657 if (csp->config->proxy_info_url != NULL)
2659 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2660 local_help_exists = 1;
2664 if (!err) err = map_block_killer(exports, "have-proxy-info");
2667 if (local_help_exists == 0)
2669 if (!err) err = map_block_killer(exports, "have-help-info");
2682 /*********************************************************************
2684 * Function : map_block_killer
2686 * Description : Convenience function.
2687 * Adds a "killer" for the conditional HTML-template
2688 * block <name>, i.e. a substitution of the regex
2689 * "if-<name>-start.*if-<name>-end" to the given
2693 * 1 : exports = map to extend
2694 * 2 : name = name of conditional block
2696 * Returns : JB_ERR_OK on success
2697 * JB_ERR_MEMORY on out-of-memory error.
2699 *********************************************************************/
2700 jb_err map_block_killer(struct map *exports, const char *name)
2702 char buf[1000]; /* Will do, since the names are hardwired */
2706 assert(strlen(name) < 490);
2708 snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2709 return map(exports, buf, 1, "", 1);
2713 /*********************************************************************
2715 * Function : map_block_keep
2717 * Description : Convenience function. Removes the markers used
2718 * by map-block-killer, to save a few bytes.
2719 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2722 * 1 : exports = map to extend
2723 * 2 : name = name of conditional block
2725 * Returns : JB_ERR_OK on success
2726 * JB_ERR_MEMORY on out-of-memory error.
2728 *********************************************************************/
2729 jb_err map_block_keep(struct map *exports, const char *name)
2732 char buf[500]; /* Will do, since the names are hardwired */
2736 assert(strlen(name) < 490);
2738 snprintf(buf, sizeof(buf), "if-%s-start", name);
2739 err = map(exports, buf, 1, "", 1);
2746 snprintf(buf, sizeof(buf), "if-%s-end", name);
2747 return map(exports, buf, 1, "", 1);
2751 /*********************************************************************
2753 * Function : map_conditional
2755 * Description : Convenience function.
2756 * Adds an "if-then-else" for the conditional HTML-template
2757 * block <name>, i.e. a substitution of the form:
2764 * The control structure and one of the alternatives
2768 * 1 : exports = map to extend
2769 * 2 : name = name of conditional block
2770 * 3 : choose_first = nonzero for first, zero for second.
2772 * Returns : JB_ERR_OK on success
2773 * JB_ERR_MEMORY on out-of-memory error.
2775 *********************************************************************/
2776 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2778 char buf[1000]; /* Will do, since the names are hardwired */
2783 assert(strlen(name) < 480);
2785 snprintf(buf, sizeof(buf), (choose_first
2786 ? "else-not-%s@.*@endif-%s"
2787 : "if-%s-then@.*@else-not-%s"),
2790 err = map(exports, buf, 1, "", 1);
2796 snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2797 return map(exports, buf, 1, "", 1);
2801 /*********************************************************************
2803 * Function : make_menu
2805 * Description : Returns an HTML-formatted menu of the available
2806 * unhidden CGIs, excluding the one given in <self>
2807 * and the toggle CGI if toggling is disabled.
2810 * 1 : self = name of CGI to leave out, can be NULL for
2812 * 2 : feature_flags = feature bitmap from csp->config
2815 * Returns : menu string, or NULL on out-of-memory error.
2817 *********************************************************************/
2818 char *make_menu(const char *self, const unsigned feature_flags)
2820 const struct cgi_dispatcher *d;
2821 char *result = strdup("");
2825 self = "NO-SUCH-CGI!";
2828 /* List available unhidden CGI's and export as "other-cgis" */
2829 for (d = cgi_dispatchers; d->name; d++)
2832 #ifdef FEATURE_TOGGLE
2833 if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2836 * Suppress the toggle link if remote toggling is disabled.
2840 #endif /* def FEATURE_TOGGLE */
2842 if (d->description && strcmp(d->name, self))
2844 char *html_encoded_prefix;
2847 * Line breaks would be great, but break
2848 * the "blocked" template's JavaScript.
2850 string_append(&result, "<li><a href=\"");
2851 html_encoded_prefix = html_encode(CGI_PREFIX);
2852 if (html_encoded_prefix == NULL)
2858 string_append(&result, html_encoded_prefix);
2859 free(html_encoded_prefix);
2861 string_append(&result, d->name);
2862 string_append(&result, "\">");
2863 string_append(&result, d->description);
2864 string_append(&result, "</a></li>");
2872 /*********************************************************************
2874 * Function : dump_map
2876 * Description : HTML-dump a map for debugging (as table)
2879 * 1 : the_map = map to dump
2881 * Returns : string with HTML
2883 *********************************************************************/
2884 char *dump_map(const struct map *the_map)
2886 struct map_entry *cur_entry;
2887 char *ret = strdup("");
2889 string_append(&ret, "<table>\n");
2891 for (cur_entry = the_map->first;
2892 (cur_entry != NULL) && (ret != NULL);
2893 cur_entry = cur_entry->next)
2895 string_append(&ret, "<tr><td><b>");
2896 string_join (&ret, html_encode(cur_entry->name));
2897 string_append(&ret, "</b></td><td>");
2898 string_join (&ret, html_encode(cur_entry->value));
2899 string_append(&ret, "</td></tr>\n");
2902 string_append(&ret, "</table>\n");