1 const char cgi_rcs[] = "$Id: cgi.c,v 2.1 2002/06/04 17:55:24 jongfoster Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/src/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 the SourceForge
15 * 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 2.1 2002/06/04 17:55:24 jongfoster
44 * Revision 2.0 2002/06/04 14:34:21 jongfoster
45 * Moving source files to src/
47 * Revision 1.70 2002/05/19 11:33:20 jongfoster
48 * If a CGI error was not handled, and propogated back to
49 * dispatch_known_cgi(), then it was assumed to be "out of memory".
50 * This gave a very misleading error message.
52 * Now other errors will cause a simple message giving the error
53 * number and asking the user to report a bug.
56 * http://sourceforge.net/tracker/index.php?func=detail
57 * &aid=557905&group_id=11118&atid=111118
59 * Revision 1.69 2002/05/14 21:28:40 oes
60 * - Fixed add_help_link to link to the (now split) actions
61 * part of the config chapter
62 * - Renamed helplink export to actions-help-prefix
64 * Revision 1.68 2002/05/12 21:36:29 jongfoster
65 * Correcting function comments
67 * Revision 1.67 2002/04/30 12:02:07 oes
68 * Nit: updated a comment
70 * Revision 1.66 2002/04/26 18:32:57 jongfoster
71 * Fixing a memory leak on error
73 * Revision 1.65 2002/04/26 12:53:51 oes
74 * - New function add_help_link
75 * - default_exports now exports links to the user manual
76 * and a prefix for links into the config chapter
78 * Revision 1.64 2002/04/24 02:17:21 oes
79 * - Better descriptions for CGIs
80 * - Hide edit-actions, more shortcuts
81 * - Moved get_char_param, get_string_param and get_number_param here
84 * Revision 1.63 2002/04/15 19:06:43 jongfoster
87 * Revision 1.62 2002/04/10 19:59:46 jongfoster
88 * Fixes to #include in templates:
89 * - Didn't close main file if loading an included template fails.
90 * - I'm paranoid and want to disallow "#include /etc/passwd".
92 * Revision 1.61 2002/04/10 13:37:48 oes
93 * Made templates modular: template_load now recursive with max depth 1
95 * Revision 1.60 2002/04/08 20:50:25 swa
98 * Revision 1.59 2002/04/05 15:51:51 oes
99 * - added send-stylesheet CGI
100 * - bugfix: error-pages now get correct request protocol
102 * - kludged CGI descriptions and menu not to break JS syntax
104 * Revision 1.58 2002/03/29 03:33:13 david__schmidt
105 * Fix Mac OSX compiler warnings
107 * Revision 1.57 2002/03/26 22:29:54 swa
108 * we have a new homepage!
110 * Revision 1.56 2002/03/24 17:50:46 jongfoster
111 * Fixing compile error if actions file editor disabled
113 * Revision 1.55 2002/03/24 16:55:06 oes
114 * Making GIF checkerboard transparent
116 * Revision 1.54 2002/03/24 16:18:15 jongfoster
119 * Revision 1.53 2002/03/24 16:06:00 oes
120 * Correct transparency for checkerboard PNG. Thanks, Magnus!
122 * Revision 1.52 2002/03/24 15:23:33 jongfoster
125 * Revision 1.51 2002/03/24 13:25:43 swa
126 * name change related issues
128 * Revision 1.50 2002/03/16 23:54:06 jongfoster
129 * Adding graceful termination feature, to help look for memory leaks.
130 * If you enable this (which, by design, has to be done by hand
131 * editing config.h) and then go to http://i.j.b/die, then the program
132 * will exit cleanly after the *next* request. It should free all the
133 * memory that was used.
135 * Revision 1.49 2002/03/13 00:27:04 jongfoster
138 * Revision 1.48 2002/03/08 17:47:07 jongfoster
141 * Revision 1.47 2002/03/08 16:41:33 oes
142 * Added GIF images again
144 * Revision 1.46 2002/03/07 03:48:38 oes
145 * - Changed built-in images from GIF to PNG
146 * (with regard to Unisys patent issue)
147 * - Added a 4x4 pattern PNG which is less intrusive
148 * than the logo but also clearly marks the deleted banners
150 * Revision 1.45 2002/03/06 22:54:35 jongfoster
151 * Automated function-comment nitpicking.
153 * Revision 1.44 2002/03/05 22:43:45 david__schmidt
154 * - Better error reporting on OS/2
155 * - Fix double-slash comment (oops)
157 * Revision 1.43 2002/03/05 21:33:45 david__schmidt
158 * - Re-enable OS/2 building after new parms were added
159 * - Fix false out of memory report when resolving CGI templates when no IP
160 * address is available of failed attempt (a la no such domain)
162 * Revision 1.42 2002/01/21 00:33:20 jongfoster
163 * Replacing strsav() with the safer string_append() or string_join().
164 * Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
165 * Adding missing html_encode() to error message generators.
166 * Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
168 * Revision 1.41 2002/01/17 20:56:22 jongfoster
169 * Replacing hard references to the URL of the config interface
170 * with #defines from project.h
172 * Revision 1.40 2002/01/09 14:26:46 oes
173 * Added support for thread-safe gmtime_r call.
175 * Revision 1.39 2001/11/16 00:48:13 jongfoster
176 * Fixing a compiler warning
178 * Revision 1.38 2001/11/13 00:31:21 jongfoster
179 * - Adding new CGIs for use by non-JavaScript browsers:
180 * edit-actions-url-form
181 * edit-actions-add-url-form
182 * edit-actions-remove-url-form
183 * - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
186 * Revision 1.37 2001/11/01 14:28:47 david__schmidt
187 * Show enablement/disablement status in almost all templates.
188 * There is a little trickiness here: apparent recursive resolution of
189 * @if-enabled-then@ caused the toggle template to show status out-of-phase with
190 * the actual enablement status. So a similar construct,
191 * @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
194 * Revision 1.36 2001/10/26 17:33:27 oes
197 * Revision 1.35 2001/10/23 21:48:19 jongfoster
198 * Cleaning up error handling in CGI functions - they now send back
199 * a HTML error page and should never cause a FATAL error. (Fixes one
200 * potential source of "denial of service" attacks).
202 * CGI actions file editor that works and is actually useful.
204 * Ability to toggle Junkbuster remotely using a CGI call.
206 * You can turn off both the above features in the main configuration
207 * file, e.g. if you are running a multi-user proxy.
209 * Revision 1.34 2001/10/18 22:22:09 david__schmidt
210 * Only show "Local support" on templates conditionally:
211 * - if either 'admin-address' or 'proxy-info-url' are uncommented in config
212 * - if not, no Local support section appears
214 * Revision 1.33 2001/10/14 22:28:41 jongfoster
215 * Fixing stupid typo.
217 * Revision 1.32 2001/10/14 22:20:18 jongfoster
218 * - Changes to CGI dispatching method to match CGI names exactly,
219 * rather than doing a prefix match.
220 * - No longer need to count the length of the CGI handler names by hand.
221 * - Adding new handler for 404 error when disptching a CGI, if none of
222 * the handlers match.
223 * - Adding new handlers for CGI actionsfile editor.
225 * Revision 1.31 2001/10/10 10:56:39 oes
226 * Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
228 * Revision 1.30 2001/10/02 15:30:57 oes
229 * Introduced show-request cgi
231 * Revision 1.29 2001/09/20 15:47:44 steudten
233 * Fix BUG: Modify int size to size_t size in fill_template()
234 * - removes big trouble on machines where sizeof(int) != sizeof(size_t).
236 * Revision 1.28 2001/09/19 18:00:37 oes
237 * - Deletef time() FIXME (Can't fail under Linux either, if
238 * the argument is guaranteed to be in out address space,
241 * - Pointer notation cosmetics
242 * - Fixed a minor bug in template_fill(): Failiure of
243 * pcrs_execute() now secure.
245 * Revision 1.27 2001/09/16 17:08:54 jongfoster
246 * Moving simple CGI functions from cgi.c to new file cgisimple.c
248 * Revision 1.26 2001/09/16 15:47:37 jongfoster
249 * First version of CGI-based edit interface. This is very much a
250 * work-in-progress, and you can't actually use it to edit anything
251 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
252 * to have any effect.
254 * Revision 1.25 2001/09/16 15:02:35 jongfoster
255 * Adding i.j.b/robots.txt.
256 * Inlining add_stats() since it's only ever called from one place.
258 * Revision 1.24 2001/09/16 11:38:01 jongfoster
259 * Splitting fill_template() into 2 functions:
260 * template_load() loads the file
261 * template_fill() performs the PCRS regexps.
262 * This is because the CGI edit interface has a "table row"
263 * template which is used many times in the page - this
264 * change means it's only loaded from disk once.
266 * Revision 1.23 2001/09/16 11:16:05 jongfoster
267 * Better error handling in dispatch_cgi() and parse_cgi_parameters()
269 * Revision 1.22 2001/09/16 11:00:10 jongfoster
270 * New function alloc_http_response, for symmetry with free_http_response
272 * Revision 1.21 2001/09/13 23:53:03 jongfoster
273 * Support for both static and dynamically generated CGI pages.
274 * Correctly setting Last-Modified: and Expires: HTTP headers.
276 * Revision 1.20 2001/09/13 23:40:36 jongfoster
277 * (Cosmetic only) Indentation correction
279 * Revision 1.19 2001/09/13 23:31:25 jongfoster
280 * Moving image data to cgi.c rather than cgi.h.
282 * Revision 1.18 2001/08/05 16:06:20 jongfoster
283 * Modifiying "struct map" so that there are now separate header and
284 * "map_entry" structures. This means that functions which modify a
285 * map no longer need to return a pointer to the modified map.
286 * Also, it no longer reverses the order of the entries (which may be
287 * important with some advanced template substitutions).
289 * Revision 1.17 2001/08/05 15:57:38 oes
290 * Adapted finish_http_response to new list_to_text
292 * Revision 1.16 2001/08/01 21:33:18 jongfoster
293 * Changes to fill_template() that reduce memory usage without having
294 * an impact on performance. I also renamed some variables so as not
295 * to clash with the C++ keywords "new" and "template".
297 * Revision 1.15 2001/08/01 21:19:22 jongfoster
298 * Moving file version information to a separate CGI page.
300 * Revision 1.14 2001/08/01 00:19:03 jongfoster
301 * New function: map_conditional() for an if-then-else syntax.
302 * Changing to use new version of show_defines()
304 * Revision 1.13 2001/07/30 22:08:36 jongfoster
305 * Tidying up #defines:
306 * - All feature #defines are now of the form FEATURE_xxx
307 * - Permanently turned off WIN_GUI_EDIT
308 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
310 * Revision 1.12 2001/07/29 18:47:05 jongfoster
311 * Adding missing #include "loadcfg.h"
313 * Revision 1.11 2001/07/18 17:24:37 oes
314 * Changed to conform to new pcrs interface
316 * Revision 1.10 2001/07/13 13:53:13 oes
317 * Removed all #ifdef PCRS and related code
319 * Revision 1.9 2001/06/29 21:45:41 oes
320 * Indentation, CRLF->LF, Tab-> Space
322 * Revision 1.8 2001/06/29 13:21:46 oes
323 * - Cosmetics: renamed and reordered functions, variables,
324 * texts, improved comments etc
326 * - Removed ij_untrusted_url() The relevant
327 * info is now part of the "untrusted" page,
328 * which is generated by filters.c:trust_url()
330 * - Generators of content now call finish_http_response()
331 * themselves, making jcc.c:chat() a little less
334 * - Removed obsolete "Pragma: no-cache" from our headers
336 * - http_responses now know their head length
338 * - fill_template now uses the new interface to pcrs, so that
339 * - long jobs (like whole files) no longer have to be assembled
340 * in a fixed size buffer
341 * - the new T (trivial) option is used, and the replacement may
342 * contain Perl syntax backrefs without confusing pcrs
344 * - Introduced default_exports() which generates a set of exports
345 * common to all CGIs and other content generators
347 * - Introduced convenience function map_block_killer()
349 * - Introduced convenience function make_menu()
351 * - Introduced CGI-like function error_response() which generates
352 * the "No such domain" and "Connect failed" messages using the
355 * - cgi_show_url_info:
356 * - adapted to new CGI features
357 * - form and answers now generated from same template
358 * - http:// prefix in URL now OK
361 * - adapted to new CGI features
362 * - no longer uses csp->init_proxy_args
365 * - moved menu generation to make_menu()
367 * - add_stats now writes single export map entries instead
370 * - Moved redirect_url() to filters.c
372 * - Fixed mem leak in free_http_response(), map_block_killer(),
374 * - Removed logentry from cancelled commit
376 * Revision 1.7 2001/06/09 10:51:58 jongfoster
377 * Changing "show URL info" handler to new style.
378 * Changing BUFSIZ ==> BUFFER_SIZE
380 * Revision 1.6 2001/06/07 23:05:19 jongfoster
381 * Removing code related to old forward and ACL files.
383 * Revision 1.5 2001/06/05 19:59:16 jongfoster
384 * Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
386 * Revision 1.4 2001/06/04 10:41:52 swa
387 * show version string of cgi.h and cgi.c
389 * Revision 1.3 2001/06/03 19:12:16 oes
390 * introduced new cgi handling
392 * No revisions before 1.3
394 **********************************************************************/
400 #include <sys/types.h>
408 #define snprintf _snprintf
409 #endif /* def _WIN32 */
417 #include "miscutil.h"
418 #include "cgisimple.h"
419 #ifdef FEATURE_CGI_EDIT_ACTIONS
421 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
423 /* loadcfg.h is for g_bToggleIJB only */
425 const char cgi_h_rcs[] = CGI_H_VERSION;
428 * List of CGI functions: name, handler, description.
429 * Note: Do NOT use single quotes in the description;
430 * this will break the dynamic "blocked" template!
432 static const struct cgi_dispatcher cgi_dispatchers[] = {
435 "Privoxy main page" },
436 #ifdef FEATURE_GRACEFUL_TERMINATION
439 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
440 "this is a one click Denial Of Service attack!!!</em>" },
444 "View & change the current configuration" },
447 "View the source code version numbers" },
450 "View the request headers." },
453 "Look up which actions apply to a URL and why" },
454 #ifdef FEATURE_CGI_EDIT_ACTIONS
457 "Toggle Privoxy on or off" },
459 { "edit-actions", /* Edit the actions list */
462 { "eaa", /* Shortcut for edit-actions-add-url-form */
463 cgi_edit_actions_add_url_form,
465 { "eau", /* Shortcut for edit-actions-url-form */
466 cgi_edit_actions_url_form,
468 { "ear", /* Shortcut for edit-actions-remove-url-form */
469 cgi_edit_actions_remove_url_form,
471 { "eafu", /* Shortcut for edit-actions-for-url */
472 cgi_edit_actions_for_url,
474 { "eas", /* Shortcut for edit-actions-submit */
475 cgi_edit_actions_submit,
477 { "easa", /* Shortcut for edit-actions-section-add */
478 cgi_edit_actions_section_add,
480 { "easr", /* Shortcut for edit-actions-section-remove */
481 cgi_edit_actions_section_remove,
483 { "eass", /* Shortcut for edit-actions-section-swap */
484 cgi_edit_actions_section_swap,
486 { "edit-actions-for-url",
487 cgi_edit_actions_for_url,
488 NULL /* Edit the actions for (a) specified URL(s) */ },
489 { "edit-actions-list",
490 cgi_edit_actions_list,
491 NULL /* Edit the actions list */ },
492 { "edit-actions-submit",
493 cgi_edit_actions_submit,
494 NULL /* Change the actions for (a) specified URL(s) */ },
495 { "edit-actions-url",
496 cgi_edit_actions_url,
497 NULL /* Change a URL pattern in the actionsfile */ },
498 { "edit-actions-url-form",
499 cgi_edit_actions_url_form,
500 NULL /* Form to change a URL pattern in the actionsfile */ },
501 { "edit-actions-add-url",
502 cgi_edit_actions_add_url,
503 NULL /* Add a URL pattern to the actionsfile */ },
504 { "edit-actions-add-url-form",
505 cgi_edit_actions_add_url_form,
506 NULL /* Form to add a URL pattern to the actionsfile */ },
507 { "edit-actions-remove-url",
508 cgi_edit_actions_remove_url,
509 NULL /* Remove a URL pattern from the actionsfile */ },
510 { "edit-actions-remove-url-form",
511 cgi_edit_actions_remove_url_form,
512 NULL /* Form to remove a URL pattern from the actionsfile */ },
513 { "edit-actions-section-add",
514 cgi_edit_actions_section_add,
515 NULL /* Remove a section from the actionsfile */ },
516 { "edit-actions-section-remove",
517 cgi_edit_actions_section_remove,
518 NULL /* Remove a section from the actionsfile */ },
519 { "edit-actions-section-swap",
520 cgi_edit_actions_section_swap,
521 NULL /* Swap two sections in the actionsfile */ },
522 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
525 NULL /* Sends a robots.txt file to tell robots to go away. */ },
528 NULL /* Send a built-in image */ },
531 NULL /* Send templates/cgi-style.css */ },
533 cgi_transparent_image,
534 NULL /* Send a transparent image (short name) */ },
535 { NULL, /* NULL Indicates end of list and default page */
537 NULL /* Unknown CGI page */ }
542 * Built-in images for ad replacement
544 * Hint: You can encode your own images like this:
545 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
548 #ifdef FEATURE_NO_GIFS
551 * Checkerboard pattern, as a PNG.
553 const char image_pattern_data[] =
554 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
555 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
556 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
557 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
558 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
559 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
560 "\000\000\000\111\105\116\104\256\102\140\202";
563 * 1x1 transparant PNG.
565 const char image_blank_data[] =
566 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
567 "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236"
568 "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070"
569 "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022"
570 "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115"
571 "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101"
572 "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006"
573 "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110"
574 "\000\000\000\000\111\105\116\104\256\102\140\202";
578 * Checkerboard pattern, as a GIF.
580 const char image_pattern_data[] =
581 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
582 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
583 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
584 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
588 * 1x1 transparant GIF.
590 const char image_blank_data[] =
591 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
592 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
593 "\000\001\000\000\002\002D\001\000;";
597 * The size of the image_pattern, in bytes.
599 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
602 * The size of the image_blank, in bytes.
604 const size_t image_blank_length = sizeof(image_blank_data) - 1;
608 * The "Out of memory" CGI response. This is statically allocated
609 * and is initialized at startup, for obvious reasons. It's
610 * read-only. finish_http_response() and free_http_response()
611 * have been special-cased to do nothing if they are passed
614 static struct http_response cgi_error_memory_response[1];
617 static struct http_response *dispatch_known_cgi(struct client_state * csp,
619 static struct map *parse_cgi_parameters(char *argstring);
622 /*********************************************************************
624 * Function : dispatch_cgi
626 * Description : Checks if a request URL has either the magical
627 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
628 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
629 * http://config.privoxy.org/). If so, it passes
630 * the (rest of the) path onto dispatch_known_cgi, which
631 * calls the relevant CGI handler function.
634 * 1 : csp = Current client state (buffers, headers, etc...)
636 * Returns : http_response if match, NULL if nonmatch or handler fail
638 *********************************************************************/
639 struct http_response *dispatch_cgi(struct client_state *csp)
641 const char *host = csp->http->host;
642 const char *path = csp->http->path;
645 * Should we intercept ?
648 /* Note: "example.com" and "example.com." are equivalent hostnames. */
650 /* Either the host matches CGI_SITE_1_HOST ..*/
651 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
652 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
653 && (path[0] == '/') )
655 /* ..then the path will all be for us. Remove leading '/' */
658 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
659 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
660 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
661 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
663 /* take everything following CGI_SITE_2_PATH */
664 path += strlen(CGI_SITE_2_PATH);
667 /* skip the forward slash after CGI_SITE_2_PATH */
670 else if (*path != '\0')
673 * wierdness: URL is /configXXX, where XXX is some string
674 * Do *NOT* intercept.
686 * This is a CGI call.
689 return dispatch_known_cgi(csp, path);
693 /*********************************************************************
695 * Function : dispatch_known_cgi
697 * Description : Processes a CGI once dispatch_cgi has determined that
698 * it matches one of the magic prefixes. Parses the path
699 * as a cgi name plus query string, prepares a map that
700 * maps CGI parameter names to their values, initializes
701 * the http_response struct, and calls the relevant CGI
705 * 1 : csp = Current client state (buffers, headers, etc...)
706 * 2 : path = Path of CGI, with the CGI prefix removed.
707 * Should not have a leading "/".
709 * Returns : http_response, or NULL on handler failure or out of
712 *********************************************************************/
713 static struct http_response *dispatch_known_cgi(struct client_state * csp,
716 const struct cgi_dispatcher *d;
717 struct map *param_list;
718 struct http_response *rsp;
719 char *query_args_start;
723 if (NULL == (path_copy = strdup(path)))
725 return cgi_error_memory();
728 query_args_start = path_copy;
729 while (*query_args_start && *query_args_start != '?')
733 if (*query_args_start == '?')
735 *query_args_start++ = '\0';
738 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
741 return cgi_error_memory();
747 * path_copy = CGI call name
748 * param_list = CGI params, as map
751 /* Get mem for response or fail*/
752 if (NULL == (rsp = alloc_http_response()))
755 free_map(param_list);
756 return cgi_error_memory();
759 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
760 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
761 csp->ip_addr_str, csp->http->cmd);
763 /* Find and start the right CGI function*/
767 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
769 err = (d->handler)(csp, rsp, param_list);
771 free_map(param_list);
772 if (err == JB_ERR_CGI_PARAMS)
774 err = cgi_error_bad_param(csp, rsp);
776 if (err && (err != JB_ERR_MEMORY))
778 /* Unexpected error! Shouldn't get here */
779 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
780 err = cgi_error_unknown(csp, rsp, err);
785 return finish_http_response(rsp);
789 /* Error in handler, probably out-of-memory */
790 free_http_response(rsp);
791 return cgi_error_memory();
799 /*********************************************************************
801 * Function : parse_cgi_parameters
803 * Description : Parse a URL-encoded argument string into name/value
804 * pairs and store them in a struct map list.
807 * 1 : argstring = string to be parsed. Will be trashed.
809 * Returns : pointer to param list, or NULL if out of memory.
811 *********************************************************************/
812 static struct map *parse_cgi_parameters(char *argstring)
815 char *vector[BUFFER_SIZE];
817 struct map *cgi_params;
819 if (NULL == (cgi_params = new_map()))
825 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
826 * the fragment identifier along with the request, so we must
827 * cut it off here, so it won't pollute the CGI params:
829 if (NULL != (p = strchr(argstring, '#')))
834 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
836 for (i = 0; i < pairs; i++)
838 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
841 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
843 free_map(cgi_params);
854 /*********************************************************************
856 * Function : get_char_param
858 * Description : Get a single-character parameter passed to a CGI
862 * 1 : parameters = map of cgi parameters
863 * 2 : param_name = The name of the parameter to read
865 * Returns : Uppercase character on success, '\0' on error.
867 *********************************************************************/
868 char get_char_param(const struct map *parameters,
869 const char *param_name)
876 ch = *(lookup(parameters, param_name));
877 if ((ch >= 'a') && (ch <= 'z'))
886 /*********************************************************************
888 * Function : get_string_param
890 * Description : Get a string paramater, to be used as an
891 * ACTION_STRING or ACTION_MULTI paramater.
892 * Validates the input to prevent stupid/malicious
893 * users from corrupting their action file.
896 * 1 : parameters = map of cgi parameters
897 * 2 : param_name = The name of the parameter to read
898 * 3 : pparam = destination for paramater. Allocated as
899 * part of the map "parameters", so don't free it.
900 * Set to NULL if not specified.
902 * Returns : JB_ERR_OK on success, or if the paramater
904 * JB_ERR_MEMORY on out-of-memory.
905 * JB_ERR_CGI_PARAMS if the paramater is not valid.
907 *********************************************************************/
908 jb_err get_string_param(const struct map *parameters,
909 const char *param_name,
922 param = lookup(parameters, param_name);
928 if (strlen(param) >= CGI_PARAM_LEN_MAX)
933 * Note that the length limit is arbitrary, it just seems
934 * sensible to limit it to *something*. There's no
935 * technical reason for any limit at all.
937 return JB_ERR_CGI_PARAMS;
940 /* Check every character to see if it's legal */
942 while ((ch = *s++) != '\0')
944 if ( ((unsigned char)ch < (unsigned char)' ')
947 /* Probable hack attempt, or user accidentally used '}'. */
948 return JB_ERR_CGI_PARAMS;
959 /*********************************************************************
961 * Function : get_number_param
963 * Description : Get a non-negative integer from the parameters
964 * passed to a CGI function.
967 * 1 : csp = Current client state (buffers, headers, etc...)
968 * 2 : parameters = map of cgi parameters
969 * 3 : name = Name of CGI parameter to read
970 * 4 : pvalue = destination for value.
971 * Set to -1 on error.
973 * Returns : JB_ERR_OK on success
974 * JB_ERR_MEMORY on out-of-memory
975 * JB_ERR_CGI_PARAMS if the parameter was not specified
978 *********************************************************************/
979 jb_err get_number_param(struct client_state *csp,
980 const struct map *parameters,
995 param = lookup(parameters, name);
998 return JB_ERR_CGI_PARAMS;
1001 /* We don't use atoi because I want to check this carefully... */
1004 while ((ch = *param++) != '\0')
1006 if ((ch < '0') || (ch > '9'))
1008 return JB_ERR_CGI_PARAMS;
1015 * <limits.h> defines UINT_MAX
1017 * (UINT_MAX - ch) / 10 is the largest number that
1018 * can be safely multiplied by 10 then have ch added.
1020 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1022 return JB_ERR_CGI_PARAMS;
1025 value = value * 10 + ch;
1036 /*********************************************************************
1038 * Function : error_response
1040 * Description : returns an http_response that explains the reason
1041 * why a request failed.
1044 * 1 : csp = Current client state (buffers, headers, etc...)
1045 * 2 : templatename = Which template should be used for the answer
1046 * 3 : sys_err = system error number
1048 * Returns : A http_response. If we run out of memory, this
1049 * will be cgi_error_memory().
1051 *********************************************************************/
1052 struct http_response *error_response(struct client_state *csp,
1053 const char *templatename,
1057 struct http_response *rsp;
1058 struct map * exports = default_exports(csp, NULL);
1059 if (exports == NULL)
1061 return cgi_error_memory();
1064 if (NULL == (rsp = alloc_http_response()))
1067 return cgi_error_memory();
1070 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1071 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1072 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1073 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1074 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1077 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1080 /* Some failures, like "404 no such domain", don't have an IP address. */
1081 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1089 free_http_response(rsp);
1090 return cgi_error_memory();
1093 if (!strcmp(templatename, "no-such-domain"))
1095 rsp->status = strdup("404 No such domain");
1096 if (rsp->status == NULL)
1099 free_http_response(rsp);
1100 return cgi_error_memory();
1103 else if (!strcmp(templatename, "connect-failed"))
1105 rsp->status = strdup("503 Connect failed");
1106 if (rsp->status == NULL)
1109 free_http_response(rsp);
1110 return cgi_error_memory();
1114 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1117 free_http_response(rsp);
1118 return cgi_error_memory();
1121 return finish_http_response(rsp);
1125 /*********************************************************************
1127 * Function : cgi_init_error_messages
1129 * Description : Call at the start of the program to initialize
1130 * the error message used by cgi_error_memory().
1136 *********************************************************************/
1137 void cgi_init_error_messages(void)
1139 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1140 cgi_error_memory_response->head =
1141 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1142 "Content-Type: text/html\r\n"
1144 cgi_error_memory_response->body =
1146 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1148 "<h1>500 Internal Privoxy Error</h1>\r\n"
1149 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1150 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1154 cgi_error_memory_response->head_length =
1155 strlen(cgi_error_memory_response->head);
1156 cgi_error_memory_response->content_length =
1157 strlen(cgi_error_memory_response->body);
1161 /*********************************************************************
1163 * Function : cgi_error_memory
1165 * Description : Called if a CGI function runs out of memory.
1166 * Returns a statically-allocated error response.
1170 * Returns : http_response data structure for output. This is
1171 * statically allocated, for obvious reasons.
1173 *********************************************************************/
1174 struct http_response *cgi_error_memory(void)
1176 /* assert that it's been initialized. */
1177 assert(cgi_error_memory_response->head);
1179 return cgi_error_memory_response;
1183 /*********************************************************************
1185 * Function : cgi_error_no_template
1187 * Description : Almost-CGI function that is called if a template
1188 * cannot be loaded. Note this is not a true CGI,
1189 * it takes a template name rather than a map of
1193 * 1 : csp = Current client state (buffers, headers, etc...)
1194 * 2 : rsp = http_response data structure for output
1195 * 3 : template_name = Name of template that could not
1198 * Returns : JB_ERR_OK on success
1199 * JB_ERR_MEMORY on out-of-memory error.
1201 *********************************************************************/
1202 jb_err cgi_error_no_template(struct client_state *csp,
1203 struct http_response *rsp,
1204 const char *template_name)
1206 static const char status[] =
1207 "500 Internal Privoxy Error";
1208 static const char body_prefix[] =
1210 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1212 "<h1>500 Internal Privoxy Error</h1>\r\n"
1213 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1214 "<p><b>Could not load template file <code>";
1215 static const char body_suffix[] =
1216 "</code> or one of it's included components.</b></p>\r\n"
1217 "<p>Please contact your proxy administrator.</p>\r\n"
1218 "<p>If you are the proxy administrator, please put the required file(s)"
1219 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1220 "location of the <code><i>(confdir)</i></code> directory "
1221 "is specified in the main Privoxy <code>config</code> "
1222 "file. (It's typically the Privoxy install directory"
1224 ", or <code>/etc/privoxy/</code>"
1225 #endif /* ndef _WIN32 */
1232 assert(template_name);
1234 /* Reset rsp, if needed */
1238 rsp->content_length = 0;
1239 rsp->head_length = 0;
1242 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1243 if (rsp->body == NULL)
1245 return JB_ERR_MEMORY;
1247 strcpy(rsp->body, body_prefix);
1248 strcat(rsp->body, template_name);
1249 strcat(rsp->body, body_suffix);
1251 rsp->status = strdup(status);
1252 if (rsp->body == NULL)
1254 return JB_ERR_MEMORY;
1261 /*********************************************************************
1263 * Function : cgi_error_unknown
1265 * Description : Almost-CGI function that is called if an unexpected
1266 * error occurs in the top-level CGI dispatcher.
1267 * In this context, "unexpected" means "anything other
1268 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1269 * expected to handle all other errors internally,
1270 * since they can give more relavent error messages
1273 * Note this is not a true CGI, it takes an error
1274 * code rather than a map of parameters.
1277 * 1 : csp = Current client state (buffers, headers, etc...)
1278 * 2 : rsp = http_response data structure for output
1279 * 3 : error_to_report = Error code to report.
1281 * Returns : JB_ERR_OK on success
1282 * JB_ERR_MEMORY on out-of-memory error.
1284 *********************************************************************/
1285 jb_err cgi_error_unknown(struct client_state *csp,
1286 struct http_response *rsp,
1287 jb_err error_to_report)
1289 static const char status[] =
1290 "500 Internal Privoxy Error";
1291 static const char body_prefix[] =
1293 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1295 "<h1>500 Internal Privoxy Error</h1>\r\n"
1296 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1297 "<p><b>Unexpected internal error: ";
1298 static const char body_suffix[] =
1301 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1302 "file a bug report</a>.</p>\r\n"
1309 /* Reset rsp, if needed */
1313 rsp->content_length = 0;
1314 rsp->head_length = 0;
1317 sprintf(errnumbuf, "%d", error_to_report);
1319 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1320 if (rsp->body == NULL)
1322 return JB_ERR_MEMORY;
1324 strcpy(rsp->body, body_prefix);
1325 strcat(rsp->body, errnumbuf);
1326 strcat(rsp->body, body_suffix);
1328 rsp->status = strdup(status);
1329 if (rsp->body == NULL)
1331 return JB_ERR_MEMORY;
1338 /*********************************************************************
1340 * Function : cgi_error_bad_param
1342 * Description : CGI function that is called if the parameters
1343 * (query string) for a CGI were wrong.
1346 * 1 : csp = Current client state (buffers, headers, etc...)
1347 * 2 : rsp = http_response data structure for output
1349 * CGI Parameters : none
1351 * Returns : JB_ERR_OK on success
1352 * JB_ERR_MEMORY on out-of-memory error.
1354 *********************************************************************/
1355 jb_err cgi_error_bad_param(struct client_state *csp,
1356 struct http_response *rsp)
1358 struct map *exports;
1363 if (NULL == (exports = default_exports(csp, NULL)))
1365 return JB_ERR_MEMORY;
1368 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1372 /*********************************************************************
1374 * Function : add_help_link
1376 * Description : Produce a copy of the string given as item,
1377 * embedded in an HTML link to its corresponding
1378 * section (item name in uppercase) in the actions
1379 * chapter of the user manual, (whose URL is given in
1380 * the config and defaults to our web site).
1382 * FIXME: I currently only work for actions, and would
1383 * like to be generalized for other topics.
1386 * 1 : item = item (will NOT be free()d.)
1387 * It is assumed to be HTML-safe.
1388 * 2 : config = The current configuration.
1390 * Returns : String with item embedded in link, or NULL on
1393 *********************************************************************/
1394 char *add_help_link(const char *item,
1395 struct configuration_spec *config)
1399 if (!item) return NULL;
1401 result = strdup("<a href=\"");
1402 string_append(&result, config->usermanual);
1403 string_append(&result, ACTIONS_HELP_PREFIX);
1404 string_join (&result, string_toupper(item));
1405 string_append(&result, "\">");
1406 string_append(&result, item);
1407 string_append(&result, "</a> ");
1413 /*********************************************************************
1415 * Function : get_http_time
1417 * Description : Get the time in a format suitable for use in a
1418 * HTTP header - e.g.:
1419 * "Sun, 06 Nov 1994 08:49:37 GMT"
1422 * 1 : time_offset = Time returned will be current time
1423 * plus this number of seconds.
1424 * 2 : buf = Destination for result. Must be long enough
1425 * to hold 29 characters plus a trailing zero.
1429 *********************************************************************/
1430 void get_http_time(int time_offset, char *buf)
1432 static const char day_names[7][4] =
1433 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1434 static const char month_names[12][4] =
1435 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1436 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1439 time_t current_time;
1443 time(¤t_time); /* get current time */
1445 current_time += time_offset;
1447 /* get and save the gmt */
1449 #ifdef HAVE_GMTIME_R
1451 t = gmtime_r(¤t_time, &dummy);
1453 t = gmtime(¤t_time);
1457 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1459 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1460 day_names[t->tm_wday],
1462 month_names[t->tm_mon],
1472 /*********************************************************************
1474 * Function : finish_http_response
1476 * Description : Fill in the missing headers in an http response,
1477 * and flatten the headers to an http head.
1480 * 1 : rsp = pointer to http_response to be processed
1482 * Returns : A http_response, usually the rsp parameter.
1483 * On error, free()s rsp and returns cgi_error_memory()
1485 *********************************************************************/
1486 struct http_response *finish_http_response(struct http_response *rsp)
1488 char buf[BUFFER_SIZE];
1491 /* Special case - do NOT change this statically allocated response,
1492 * which is ready for output anyway.
1494 if (rsp == cgi_error_memory_response)
1500 * Fill in the HTTP Status
1502 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1503 err = enlist_first(rsp->headers, buf);
1506 * Set the Content-Length
1508 if (rsp->content_length == 0)
1510 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1514 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1515 err = enlist(rsp->headers, buf);
1519 * Fill in the default headers:
1521 * Content-Type: default to text/html if not already specified.
1522 * Date: set to current date/time.
1523 * Last-Modified: set to date/time the page was last changed.
1524 * Expires: set to date/time page next needs reloading.
1525 * Cache-Control: set to "no-cache" if applicable.
1527 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1529 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1534 * Set Expires to about 10 min into the future so it'll get reloaded
1535 * occasionally, e.g. if Privoxy gets upgraded.
1540 get_http_time(0, buf);
1541 err = enlist_unique_header(rsp->headers, "Date", buf);
1544 /* Some date in the past. */
1545 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1549 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1550 err = enlist_unique_header(rsp->headers, "Expires", buf);
1556 * Compliant browsers should not cache this due to the "Cache-Control"
1557 * setting. However, to be certain, we also set both "Last-Modified"
1558 * and "Expires" to the current time.
1560 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1562 get_http_time(0, buf);
1563 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1564 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1565 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1572 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1574 free_http_response(rsp);
1575 return cgi_error_memory();
1577 rsp->head_length = strlen(rsp->head);
1584 /*********************************************************************
1586 * Function : alloc_http_response
1588 * Description : Allocates a new http_response structure.
1592 * Returns : pointer to a new http_response, or NULL.
1594 *********************************************************************/
1595 struct http_response *alloc_http_response(void)
1597 return (struct http_response *) zalloc(sizeof(struct http_response));
1602 /*********************************************************************
1604 * Function : free_http_response
1606 * Description : Free the memory occupied by an http_response
1607 * and its depandant structures.
1610 * 1 : rsp = pointer to http_response to be freed
1614 *********************************************************************/
1615 void free_http_response(struct http_response *rsp)
1618 * Must special case cgi_error_memory_response, which is never freed.
1620 if (rsp && (rsp != cgi_error_memory_response))
1625 destroy_list(rsp->headers);
1632 /*********************************************************************
1634 * Function : template_load
1636 * Description : CGI support function that loads a given HTML
1637 * template from the confdir, ignoring comment
1638 * lines and following #include statements up to
1642 * 1 : csp = Current client state (buffers, headers, etc...)
1643 * 2 : template_ptr = Destination for pointer to loaded
1645 * 3 : templatename = name of the HTML template to be used
1646 * 4 : recursive = Flag set if this function calls itself
1647 * following an #include statament
1649 * Returns : JB_ERR_OK on success
1650 * JB_ERR_MEMORY on out-of-memory error.
1651 * JB_ERR_FILE if the template file cannot be read
1653 *********************************************************************/
1654 jb_err template_load(struct client_state *csp, char **template_ptr,
1655 const char *templatename, int recursive)
1658 char *templates_dir_path;
1661 char *included_module;
1664 char buf[BUFFER_SIZE];
1667 assert(template_ptr);
1668 assert(templatename);
1670 *template_ptr = NULL;
1672 /* Validate template name. Paranoia. */
1673 for (p = templatename; *p != 0; p++)
1675 if ( ((*p < 'a') || (*p > 'z'))
1676 && ((*p < 'A') || (*p > 'Z'))
1677 && ((*p < '0') || (*p > '9'))
1681 /* Illegal character */
1686 /* Generate full path */
1688 templates_dir_path = make_path(csp->config->confdir, "templates");
1689 if (templates_dir_path == NULL)
1691 return JB_ERR_MEMORY;
1694 full_path = make_path(templates_dir_path, templatename);
1695 free(templates_dir_path);
1696 if (full_path == NULL)
1698 return JB_ERR_MEMORY;
1701 /* Allocate buffer */
1703 file_buffer = strdup("");
1704 if (file_buffer == NULL)
1707 return JB_ERR_MEMORY;
1710 /* Open template file */
1712 if (NULL == (fp = fopen(full_path, "r")))
1714 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1722 * Read the file, ignoring comments, and honoring #include
1723 * statements, unless we're already called recursively.
1725 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1726 * This is unlikely in practise.
1728 while (fgets(buf, BUFFER_SIZE, fp))
1730 if (!recursive && !strncmp(buf, "#include ", 9))
1732 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1739 if (string_join(&file_buffer, included_module))
1742 return JB_ERR_MEMORY;
1748 /* skip lines starting with '#' */
1754 if (string_append(&file_buffer, buf))
1757 return JB_ERR_MEMORY;
1762 *template_ptr = file_buffer;
1768 /*********************************************************************
1770 * Function : template_fill
1772 * Description : CGI support function that fills in a pre-loaded
1773 * HTML template by replacing @name@ with value using
1774 * pcrs, for each item in the output map.
1776 * Note that a leading '$' charachter in the export map's
1777 * values will be stripped and toggle on backreference
1781 * 1 : template_ptr = IN: Template to be filled out.
1783 * OUT: Filled out template.
1784 * Caller must free().
1785 * 2 : exports = map with fill in symbol -> name pairs
1787 * Returns : JB_ERR_OK on success
1788 * JB_ERR_MEMORY on out-of-memory error
1790 *********************************************************************/
1791 jb_err template_fill(char **template_ptr, const struct map *exports)
1793 struct map_entry *m;
1795 char buf[BUFFER_SIZE];
1796 char *tmp_out_buffer;
1802 assert(template_ptr);
1803 assert(*template_ptr);
1806 file_buffer = *template_ptr;
1807 size = strlen(file_buffer) + 1;
1810 * Assemble pcrs joblist from exports map
1812 for (m = exports->first; m != NULL; m = m->next)
1814 if (*m->name == '$')
1817 * First character of name is '$', so remove this flag
1818 * character and allow backreferences ($1 etc) in the
1819 * "replace with" text.
1821 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1827 * Treat the "replace with" text as a literal string -
1828 * no quoting needed, no backreferences allowed.
1829 * ("Trivial" ['T'] flag).
1833 /* Enclose name in @@ */
1834 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1838 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
1840 /* Make and run job. */
1841 job = pcrs_compile(buf, m->value, flags, &error);
1844 if (error == PCRS_ERR_NOMEM)
1847 *template_ptr = NULL;
1848 return JB_ERR_MEMORY;
1852 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
1853 /* Hope it wasn't important and silently ignore the invalid job */
1858 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
1861 if (NULL == tmp_out_buffer)
1863 *template_ptr = NULL;
1864 return JB_ERR_MEMORY;
1866 file_buffer = tmp_out_buffer;
1873 *template_ptr = file_buffer;
1878 /*********************************************************************
1880 * Function : template_fill_for_cgi
1882 * Description : CGI support function that loads a HTML template
1883 * and fills it in. Handles file-not-found errors
1884 * by sending a HTML error message. For convenience,
1885 * this function also frees the passed "exports" map.
1888 * 1 : csp = Client state
1889 * 2 : templatename = name of the HTML template to be used
1890 * 3 : exports = map with fill in symbol -> name pairs.
1891 * Will be freed by this function.
1892 * 4 : rsp = Response structure to fill in.
1894 * Returns : JB_ERR_OK on success
1895 * JB_ERR_MEMORY on out-of-memory error
1897 *********************************************************************/
1898 jb_err template_fill_for_cgi(struct client_state *csp,
1899 const char *templatename,
1900 struct map *exports,
1901 struct http_response *rsp)
1906 assert(templatename);
1910 err = template_load(csp, &rsp->body, templatename, 0);
1911 if (err == JB_ERR_FILE)
1914 return cgi_error_no_template(csp, rsp, templatename);
1919 return err; /* JB_ERR_MEMORY */
1921 err = template_fill(&rsp->body, exports);
1927 /*********************************************************************
1929 * Function : default_exports
1931 * Description : returns a struct map list that contains exports
1932 * which are common to all CGI functions.
1935 * 1 : csp = Current client state (buffers, headers, etc...)
1936 * 2 : caller = name of CGI who calls us and which should
1937 * be excluded from the generated menu. May be
1939 * Returns : NULL if no memory, else a new map. Caller frees.
1941 *********************************************************************/
1942 struct map *default_exports(const struct client_state *csp, const char *caller)
1946 struct map * exports;
1947 int local_help_exists = 0;
1951 exports = new_map();
1952 if (exports == NULL)
1957 err = map(exports, "version", 1, html_encode(VERSION), 0);
1958 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
1959 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
1960 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
1961 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
1962 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
1963 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
1964 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
1965 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
1966 if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB);
1968 snprintf(buf, 20, "%d", csp->config->hport);
1969 if (!err) err = map(exports, "my-port", 1, buf, 1);
1971 if(!strcmp(CODE_STATUS, "stable"))
1973 if (!err) err = map_block_killer(exports, "unstable");
1976 if (csp->config->admin_address != NULL)
1978 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
1979 local_help_exists = 1;
1983 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
1986 if (csp->config->proxy_info_url != NULL)
1988 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
1989 local_help_exists = 1;
1993 if (!err) err = map_block_killer(exports, "have-proxy-info");
1996 if (local_help_exists == 0)
1998 if (!err) err = map_block_killer(exports, "have-help-info");
2011 /*********************************************************************
2013 * Function : map_block_killer
2015 * Description : Convenience function.
2016 * Adds a "killer" for the conditional HTML-template
2017 * block <name>, i.e. a substitution of the regex
2018 * "if-<name>-start.*if-<name>-end" to the given
2022 * 1 : exports = map to extend
2023 * 2 : name = name of conditional block
2025 * Returns : JB_ERR_OK on success
2026 * JB_ERR_MEMORY on out-of-memory error.
2028 *********************************************************************/
2029 jb_err map_block_killer(struct map *exports, const char *name)
2031 char buf[1000]; /* Will do, since the names are hardwired */
2035 assert(strlen(name) < 490);
2037 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2038 return map(exports, buf, 1, "", 1);
2042 /*********************************************************************
2044 * Function : map_block_keep
2046 * Description : Convenience function. Removes the markers used
2047 * by map-block-killer, to save a few bytes.
2048 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2051 * 1 : exports = map to extend
2052 * 2 : name = name of conditional block
2054 * Returns : JB_ERR_OK on success
2055 * JB_ERR_MEMORY on out-of-memory error.
2057 *********************************************************************/
2058 jb_err map_block_keep(struct map *exports, const char *name)
2061 char buf[500]; /* Will do, since the names are hardwired */
2065 assert(strlen(name) < 490);
2067 snprintf(buf, 500, "if-%s-start", name);
2068 err = map(exports, buf, 1, "", 1);
2075 snprintf(buf, 500, "if-%s-end", name);
2076 return map(exports, buf, 1, "", 1);
2080 /*********************************************************************
2082 * Function : map_conditional
2084 * Description : Convenience function.
2085 * Adds an "if-then-else" for the conditional HTML-template
2086 * block <name>, i.e. a substitution of the form:
2093 * The control structure and one of the alternatives
2097 * 1 : exports = map to extend
2098 * 2 : name = name of conditional block
2099 * 3 : choose_first = nonzero for first, zero for second.
2101 * Returns : JB_ERR_OK on success
2102 * JB_ERR_MEMORY on out-of-memory error.
2104 *********************************************************************/
2105 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2107 char buf[1000]; /* Will do, since the names are hardwired */
2112 assert(strlen(name) < 480);
2114 snprintf(buf, 1000, (choose_first
2115 ? "else-not-%s@.*@endif-%s"
2116 : "if-%s-then@.*@else-not-%s"),
2119 err = map(exports, buf, 1, "", 1);
2125 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2126 return map(exports, buf, 1, "", 1);
2130 /*********************************************************************
2132 * Function : make_menu
2134 * Description : Returns an HTML-formatted menu of the available
2135 * unhidden CGIs, excluding the one given in <self>
2137 * Parameters : self = name of CGI to leave out, can be NULL for
2140 * Returns : menu string, or NULL on out-of-memory error.
2142 *********************************************************************/
2143 char *make_menu(const char *self)
2145 const struct cgi_dispatcher *d;
2146 char *result = strdup("");
2150 self = "NO-SUCH-CGI!";
2153 /* List available unhidden CGI's and export as "other-cgis" */
2154 for (d = cgi_dispatchers; d->name; d++)
2156 if (d->description && strcmp(d->name, self))
2158 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2159 string_append(&result, d->name);
2160 string_append(&result, "\">");
2161 string_append(&result, d->description);
2162 string_append(&result, "</a></li>");
2170 /*********************************************************************
2172 * Function : dump_map
2174 * Description : HTML-dump a map for debugging (as table)
2177 * 1 : the_map = map to dump
2179 * Returns : string with HTML
2181 *********************************************************************/
2182 char *dump_map(const struct map *the_map)
2184 struct map_entry *cur_entry;
2185 char *ret = strdup("");
2187 string_append(&ret, "<table>\n");
2189 for (cur_entry = the_map->first;
2190 (cur_entry != NULL) && (ret != NULL);
2191 cur_entry = cur_entry->next)
2193 string_append(&ret, "<tr><td><b>");
2194 string_join (&ret, html_encode(cur_entry->name));
2195 string_append(&ret, "</b></td><td>");
2196 string_join (&ret, html_encode(cur_entry->value));
2197 string_append(&ret, "</td></tr>\n");
2200 string_append(&ret, "</table>\n");