1 const char cgi_rcs[] = "$Id: cgi.c,v 1.70.2.2 2002/11/12 16:20:37 oes Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/Attic/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 1.70.2.2 2002/11/12 16:20:37 oes
42 * Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
44 * Revision 1.70.2.1 2002/08/05 11:17:46 oes
45 * Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
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[] = {
437 #ifdef FEATURE_GRACEFUL_TERMINATION
440 "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
441 "this is a one click Denial Of Service attack!!!</em>",
446 "View & change the current configuration",
450 "View the source code version numbers",
454 "View the request headers.",
458 "Look up which actions apply to a URL and why",
460 #ifdef FEATURE_CGI_EDIT_ACTIONS
463 "Toggle Privoxy on or off",
465 { "edit-actions", /* Edit the actions list */
468 { "eaa", /* Shortcut for edit-actions-add-url-form */
469 cgi_edit_actions_add_url_form,
471 { "eau", /* Shortcut for edit-actions-url-form */
472 cgi_edit_actions_url_form,
474 { "ear", /* Shortcut for edit-actions-remove-url-form */
475 cgi_edit_actions_remove_url_form,
477 { "eafu", /* Shortcut for edit-actions-for-url */
478 cgi_edit_actions_for_url,
480 { "eas", /* Shortcut for edit-actions-submit */
481 cgi_edit_actions_submit,
483 { "easa", /* Shortcut for edit-actions-section-add */
484 cgi_edit_actions_section_add,
486 { "easr", /* Shortcut for edit-actions-section-remove */
487 cgi_edit_actions_section_remove,
489 { "eass", /* Shortcut for edit-actions-section-swap */
490 cgi_edit_actions_section_swap,
492 { "edit-actions-for-url",
493 cgi_edit_actions_for_url,
494 NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
495 { "edit-actions-list",
496 cgi_edit_actions_list,
497 NULL, TRUE /* Edit the actions list */ },
498 { "edit-actions-submit",
499 cgi_edit_actions_submit,
500 NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
501 { "edit-actions-url",
502 cgi_edit_actions_url,
503 NULL, FALSE /* Change a URL pattern in the actionsfile */ },
504 { "edit-actions-url-form",
505 cgi_edit_actions_url_form,
506 NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
507 { "edit-actions-add-url",
508 cgi_edit_actions_add_url,
509 NULL, FALSE /* Add a URL pattern to the actionsfile */ },
510 { "edit-actions-add-url-form",
511 cgi_edit_actions_add_url_form,
512 NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
513 { "edit-actions-remove-url",
514 cgi_edit_actions_remove_url,
515 NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
516 { "edit-actions-remove-url-form",
517 cgi_edit_actions_remove_url_form,
518 NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
519 { "edit-actions-section-add",
520 cgi_edit_actions_section_add,
521 NULL, FALSE /* Remove a section from the actionsfile */ },
522 { "edit-actions-section-remove",
523 cgi_edit_actions_section_remove,
524 NULL, FALSE /* Remove a section from the actionsfile */ },
525 { "edit-actions-section-swap",
526 cgi_edit_actions_section_swap,
527 NULL, FALSE /* Swap two sections in the actionsfile */ },
528 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
531 NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
534 NULL, TRUE /* Send a built-in image */ },
537 NULL, TRUE /* Send templates/cgi-style.css */ },
539 cgi_transparent_image,
540 NULL, TRUE /* Send a transparent image (short name) */ },
541 { NULL, /* NULL Indicates end of list and default page */
543 NULL, TRUE /* Unknown CGI page */ }
548 * Bulit-in images for ad replacement
550 * Hint: You can encode your own images like this:
551 * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
554 #ifdef FEATURE_NO_GIFS
557 * Checkerboard pattern, as a PNG.
559 const char image_pattern_data[] =
560 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
561 "\122\000\000\000\004\000\000\000\004\010\002\000\000\000\046"
562 "\223\011\051\000\000\000\006\142\113\107\104\000\310\000\310"
563 "\000\310\052\045\225\037\000\000\000\032\111\104\101\124\170"
564 "\332\143\070\161\342\304\377\377\377\041\044\003\234\165\342"
565 "\304\011\006\234\062\000\125\200\052\251\125\174\360\223\000"
566 "\000\000\000\111\105\116\104\256\102\140\202";
569 * 1x1 transparant PNG.
571 const char image_blank_data[] =
572 "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
573 "\000\000\000\004\000\000\000\004\010\006\000\000\000\251\361\236"
574 "\176\000\000\000\007\164\111\115\105\007\322\003\013\020\073\070"
575 "\013\025\036\203\000\000\000\011\160\110\131\163\000\000\013\022"
576 "\000\000\013\022\001\322\335\176\374\000\000\000\004\147\101\115"
577 "\101\000\000\261\217\013\374\141\005\000\000\000\033\111\104\101"
578 "\124\170\332\143\070\161\342\304\207\377\377\377\347\302\150\006"
579 "\144\016\210\146\040\250\002\000\042\305\065\221\270\027\131\110"
580 "\000\000\000\000\111\105\116\104\256\102\140\202";
584 * Checkerboard pattern, as a GIF.
586 const char image_pattern_data[] =
587 "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
588 "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
589 "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
590 "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
594 * 1x1 transparant GIF.
596 const char image_blank_data[] =
597 "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
598 "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
599 "\000\001\000\000\002\002D\001\000;";
602 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
603 const size_t image_blank_length = sizeof(image_blank_data) - 1;
606 static struct http_response cgi_error_memory_response[1];
608 static struct http_response *dispatch_known_cgi(struct client_state * csp,
610 static struct map *parse_cgi_parameters(char *argstring);
613 /*********************************************************************
615 * Function : dispatch_cgi
617 * Description : Checks if a request URL has either the magical
618 * hostname CGI_SITE_1_HOST (usually http://p.p/) or
619 * matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
620 * http://config.privoxy.org/). If so, it passes
621 * the (rest of the) path onto dispatch_known_cgi, which
622 * calls the relevant CGI handler function.
625 * 1 : csp = Current client state (buffers, headers, etc...)
627 * Returns : http_response if match, NULL if nonmatch or handler fail
629 *********************************************************************/
630 struct http_response *dispatch_cgi(struct client_state *csp)
632 const char *host = csp->http->host;
633 const char *path = csp->http->path;
636 * Should we intercept ?
639 /* Note: "example.com" and "example.com." are equivalent hostnames. */
641 /* Either the host matches CGI_SITE_1_HOST ..*/
642 if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
643 || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
644 && (path[0] == '/') )
646 /* ..then the path will all be for us. Remove leading '/' */
649 /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
650 else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
651 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
652 && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
654 /* take everything following CGI_SITE_2_PATH */
655 path += strlen(CGI_SITE_2_PATH);
658 /* skip the forward slash after CGI_SITE_2_PATH */
661 else if (*path != '\0')
664 * wierdness: URL is /configXXX, where XXX is some string
665 * Do *NOT* intercept.
677 * This is a CGI call.
680 return dispatch_known_cgi(csp, path);
684 /*********************************************************************
686 * Function : grep_cgi_referrer
688 * Description : Ugly provisorical fix that greps the value of the
689 * referer HTTP header field out of a linked list of
690 * strings like found at csp->headers. Will disappear
693 * FIXME: csp->headers ought to be csp->http->headers
694 * FIXME: Parsing all client header lines should
695 * happen right after the request is received!
698 * 1 : csp = Current client state (buffers, headers, etc...)
700 * Returns : pointer to value (no copy!), or NULL if none found.
702 *********************************************************************/
703 char *grep_cgi_referrer(struct client_state *csp)
705 struct list_entry *p;
707 for (p = csp->headers->first; p != NULL; p = p->next)
709 if (p->str == NULL) continue;
710 if (strncmpic(p->str, "Referer: ", 9) == 0)
712 return ((p->str) + 9);
720 /*********************************************************************
722 * Function : dispatch_known_cgi
724 * Description : Processes a CGI once dispatch_cgi has determined that
725 * it matches one of the magic prefixes. Parses the path
726 * as a cgi name plus query string, prepares a map that
727 * maps CGI parameter names to their values, initializes
728 * the http_response struct, and calls the relevant CGI
732 * 1 : csp = Current client state (buffers, headers, etc...)
733 * 2 : path = Path of CGI, with the CGI prefix removed.
734 * Should not have a leading "/".
736 * Returns : http_response, or NULL on handler failure or out of
739 *********************************************************************/
740 static struct http_response *dispatch_known_cgi(struct client_state * csp,
743 const struct cgi_dispatcher *d;
744 struct map *param_list;
745 struct http_response *rsp;
746 char *query_args_start;
751 if (NULL == (path_copy = strdup(path)))
753 return cgi_error_memory();
756 query_args_start = path_copy;
757 while (*query_args_start && *query_args_start != '?')
761 if (*query_args_start == '?')
763 *query_args_start++ = '\0';
766 if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
769 return cgi_error_memory();
774 * path_copy = CGI call name
775 * param_list = CGI params, as map
778 /* Get mem for response or fail*/
779 if (NULL == (rsp = alloc_http_response()))
782 free_map(param_list);
783 return cgi_error_memory();
786 log_error(LOG_LEVEL_GPC, "%s%s cgi call", csp->http->hostport, csp->http->path);
787 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 3",
788 csp->ip_addr_str, csp->http->cmd);
791 * Find and start the right CGI function
796 if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
799 * If the called CGI is either harmless, or not referred
800 * from an untrusted source, start it.
803 || (NULL == (referrer = grep_cgi_referrer(csp)))
804 || (0 == strncmp(referrer, "http://config.privoxy.org/", 26))
807 err = (d->handler)(csp, rsp, param_list);
812 * Else, modify toggle calls so that they only display
813 * the status, and deny all other calls.
815 if (0 == strcmp(path_copy, "toggle"))
817 unmap(param_list, "set");
818 err = (d->handler)(csp, rsp, param_list);
822 err = cgi_error_disabled(csp, rsp);
827 free_map(param_list);
829 if (err == JB_ERR_CGI_PARAMS)
831 err = cgi_error_bad_param(csp, rsp);
833 if (err && (err != JB_ERR_MEMORY))
835 /* Unexpected error! Shouldn't get here */
836 log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler. Please file a bug report!", err);
837 err = cgi_error_unknown(csp, rsp, err);
842 return finish_http_response(rsp);
846 /* Error in handler, probably out-of-memory */
847 free_http_response(rsp);
848 return cgi_error_memory();
856 /*********************************************************************
858 * Function : parse_cgi_parameters
860 * Description : Parse a URL-encoded argument string into name/value
861 * pairs and store them in a struct map list.
864 * 1 : argstring = string to be parsed. Will be trashed.
866 * Returns : pointer to param list, or NULL if out of memory.
868 *********************************************************************/
869 static struct map *parse_cgi_parameters(char *argstring)
872 char *vector[BUFFER_SIZE];
874 struct map *cgi_params;
876 if (NULL == (cgi_params = new_map()))
882 * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
883 * the fragment identifier along with the request, so we must
884 * cut it off here, so it won't pollute the CGI params:
886 if (NULL != (p = strchr(argstring, '#')))
891 pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
893 for (i = 0; i < pairs; i++)
895 if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
898 if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
900 free_map(cgi_params);
911 /*********************************************************************
913 * Function : get_char_param
915 * Description : Get a single-character parameter passed to a CGI
919 * 1 : parameters = map of cgi parameters
920 * 2 : param_name = The name of the parameter to read
922 * Returns : Uppercase character on success, '\0' on error.
924 *********************************************************************/
925 char get_char_param(const struct map *parameters,
926 const char *param_name)
933 ch = *(lookup(parameters, param_name));
934 if ((ch >= 'a') && (ch <= 'z'))
943 /*********************************************************************
945 * Function : get_string_param
947 * Description : Get a string paramater, to be used as an
948 * ACTION_STRING or ACTION_MULTI paramater.
949 * Validates the input to prevent stupid/malicious
950 * users from corrupting their action file.
953 * 1 : parameters = map of cgi parameters
954 * 2 : param_name = The name of the parameter to read
955 * 3 : pparam = destination for paramater. Allocated as
956 * part of the map "parameters", so don't free it.
957 * Set to NULL if not specified.
959 * Returns : JB_ERR_OK on success, or if the paramater
961 * JB_ERR_MEMORY on out-of-memory.
962 * JB_ERR_CGI_PARAMS if the paramater is not valid.
964 *********************************************************************/
965 jb_err get_string_param(const struct map *parameters,
966 const char *param_name,
979 param = lookup(parameters, param_name);
985 if (strlen(param) >= CGI_PARAM_LEN_MAX)
990 * Note that the length limit is arbitrary, it just seems
991 * sensible to limit it to *something*. There's no
992 * technical reason for any limit at all.
994 return JB_ERR_CGI_PARAMS;
997 /* Check every character to see if it's legal */
999 while ((ch = *s++) != '\0')
1001 if ( ((unsigned char)ch < (unsigned char)' ')
1004 /* Probable hack attempt, or user accidentally used '}'. */
1005 return JB_ERR_CGI_PARAMS;
1016 /*********************************************************************
1018 * Function : get_number_param
1020 * Description : Get a non-negative integer from the parameters
1021 * passed to a CGI function.
1024 * 1 : csp = Current client state (buffers, headers, etc...)
1025 * 2 : parameters = map of cgi parameters
1026 * 3 : name = Name of CGI parameter to read
1027 * 4 : pvalue = destination for value.
1028 * Set to -1 on error.
1030 * Returns : JB_ERR_OK on success
1031 * JB_ERR_MEMORY on out-of-memory
1032 * JB_ERR_CGI_PARAMS if the parameter was not specified
1035 *********************************************************************/
1036 jb_err get_number_param(struct client_state *csp,
1037 const struct map *parameters,
1052 param = lookup(parameters, name);
1055 return JB_ERR_CGI_PARAMS;
1058 /* We don't use atoi because I want to check this carefully... */
1061 while ((ch = *param++) != '\0')
1063 if ((ch < '0') || (ch > '9'))
1065 return JB_ERR_CGI_PARAMS;
1072 * <limits.h> defines UINT_MAX
1074 * (UINT_MAX - ch) / 10 is the largest number that
1075 * can be safely multiplied by 10 then have ch added.
1077 if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1079 return JB_ERR_CGI_PARAMS;
1082 value = value * 10 + ch;
1093 /*********************************************************************
1095 * Function : error_response
1097 * Description : returns an http_response that explains the reason
1098 * why a request failed.
1101 * 1 : csp = Current client state (buffers, headers, etc...)
1102 * 2 : templatename = Which template should be used for the answer
1103 * 3 : sys_err = system error number
1105 * Returns : A http_response. If we run out of memory, this
1106 * will be cgi_error_memory().
1108 *********************************************************************/
1109 struct http_response *error_response(struct client_state *csp,
1110 const char *templatename,
1114 struct http_response *rsp;
1115 struct map * exports = default_exports(csp, NULL);
1116 if (exports == NULL)
1118 return cgi_error_memory();
1121 if (NULL == (rsp = alloc_http_response()))
1124 return cgi_error_memory();
1127 err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1128 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1129 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
1130 if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1131 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
1134 err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1137 /* Some failures, like "404 no such domain", don't have an IP address. */
1138 err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1146 free_http_response(rsp);
1147 return cgi_error_memory();
1150 if (!strcmp(templatename, "no-such-domain"))
1152 rsp->status = strdup("404 No such domain");
1153 if (rsp->status == NULL)
1156 free_http_response(rsp);
1157 return cgi_error_memory();
1160 else if (!strcmp(templatename, "connect-failed"))
1162 rsp->status = strdup("503 Connect failed");
1163 if (rsp->status == NULL)
1166 free_http_response(rsp);
1167 return cgi_error_memory();
1171 err = template_fill_for_cgi(csp, templatename, exports, rsp);
1174 free_http_response(rsp);
1175 return cgi_error_memory();
1178 return finish_http_response(rsp);
1182 /*********************************************************************
1184 * Function : cgi_init_error_messages
1186 * Description : Call at the start of the program to initialize
1187 * the error message used by cgi_error_memory().
1193 *********************************************************************/
1194 void cgi_init_error_messages(void)
1196 memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1197 cgi_error_memory_response->head =
1198 "HTTP/1.0 500 Internal Privoxy Error\r\n"
1199 "Content-Type: text/html\r\n"
1201 cgi_error_memory_response->body =
1203 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1205 "<h1>500 Internal Privoxy Error</h1>\r\n"
1206 "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1207 "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1211 cgi_error_memory_response->head_length =
1212 strlen(cgi_error_memory_response->head);
1213 cgi_error_memory_response->content_length =
1214 strlen(cgi_error_memory_response->body);
1218 /*********************************************************************
1220 * Function : cgi_error_memory
1222 * Description : Called if a CGI function runs out of memory.
1223 * Returns a statically-allocated error response.
1227 * Returns : http_response data structure for output. This is
1228 * statically allocated, for obvious reasons.
1230 *********************************************************************/
1231 struct http_response *cgi_error_memory(void)
1233 /* assert that it's been initialized. */
1234 assert(cgi_error_memory_response->head);
1236 return cgi_error_memory_response;
1240 /*********************************************************************
1242 * Function : cgi_error_no_template
1244 * Description : Almost-CGI function that is called if a template
1245 * cannot be loaded. Note this is not a true CGI,
1246 * it takes a template name rather than a map of
1250 * 1 : csp = Current client state (buffers, headers, etc...)
1251 * 2 : rsp = http_response data structure for output
1252 * 3 : template_name = Name of template that could not
1255 * Returns : JB_ERR_OK on success
1256 * JB_ERR_MEMORY on out-of-memory error.
1258 *********************************************************************/
1259 jb_err cgi_error_no_template(struct client_state *csp,
1260 struct http_response *rsp,
1261 const char *template_name)
1263 static const char status[] =
1264 "500 Internal Privoxy Error";
1265 static const char body_prefix[] =
1267 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1269 "<h1>500 Internal Privoxy Error</h1>\r\n"
1270 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1271 "<p><b>Could not load template file <code>";
1272 static const char body_suffix[] =
1273 "</code> or one of it's included components.</b></p>\r\n"
1274 "<p>Please contact your proxy administrator.</p>\r\n"
1275 "<p>If you are the proxy administrator, please put the required file(s)"
1276 "in the <code><i>(confdir)</i>/templates</code> directory. The "
1277 "location of the <code><i>(confdir)</i></code> directory "
1278 "is specified in the main Privoxy <code>config</code> "
1279 "file. (It's typically the Privoxy install directory"
1281 ", or <code>/etc/privoxy/</code>"
1282 #endif /* ndef _WIN32 */
1289 assert(template_name);
1291 /* Reset rsp, if needed */
1295 rsp->content_length = 0;
1296 rsp->head_length = 0;
1299 rsp->body = malloc(strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1);
1300 if (rsp->body == NULL)
1302 return JB_ERR_MEMORY;
1304 strcpy(rsp->body, body_prefix);
1305 strcat(rsp->body, template_name);
1306 strcat(rsp->body, body_suffix);
1308 rsp->status = strdup(status);
1309 if (rsp->body == NULL)
1311 return JB_ERR_MEMORY;
1318 /*********************************************************************
1320 * Function : cgi_error_unknown
1322 * Description : Almost-CGI function that is called if an unexpected
1323 * error occurs in the top-level CGI dispatcher.
1324 * In this context, "unexpected" means "anything other
1325 * than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1326 * expected to handle all other errors internally,
1327 * since they can give more relavent error messages
1330 * Note this is not a true CGI, it takes an error
1331 * code rather than a map of parameters.
1334 * 1 : csp = Current client state (buffers, headers, etc...)
1335 * 2 : rsp = http_response data structure for output
1336 * 3 : error_to_report = Error code to report.
1338 * Returns : JB_ERR_OK on success
1339 * JB_ERR_MEMORY on out-of-memory error.
1341 *********************************************************************/
1342 jb_err cgi_error_unknown(struct client_state *csp,
1343 struct http_response *rsp,
1344 jb_err error_to_report)
1346 static const char status[] =
1347 "500 Internal Privoxy Error";
1348 static const char body_prefix[] =
1350 "<head><title>500 Internal Privoxy Error</title></head>\r\n"
1352 "<h1>500 Internal Privoxy Error</h1>\r\n"
1353 "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1354 "<p><b>Unexpected internal error: ";
1355 static const char body_suffix[] =
1358 "<a href=\"http://sourceforge.net/tracker/?group_id=11118&atid=111118\">"
1359 "file a bug report</a>.</p>\r\n"
1366 /* Reset rsp, if needed */
1370 rsp->content_length = 0;
1371 rsp->head_length = 0;
1374 sprintf(errnumbuf, "%d", error_to_report);
1376 rsp->body = malloc(strlen(body_prefix) + strlen(errnumbuf) + strlen(body_suffix) + 1);
1377 if (rsp->body == NULL)
1379 return JB_ERR_MEMORY;
1381 strcpy(rsp->body, body_prefix);
1382 strcat(rsp->body, errnumbuf);
1383 strcat(rsp->body, body_suffix);
1385 rsp->status = strdup(status);
1386 if (rsp->body == NULL)
1388 return JB_ERR_MEMORY;
1395 /*********************************************************************
1397 * Function : cgi_error_bad_param
1399 * Description : CGI function that is called if the parameters
1400 * (query string) for a CGI were wrong.
1403 * 1 : csp = Current client state (buffers, headers, etc...)
1404 * 2 : rsp = http_response data structure for output
1406 * CGI Parameters : none
1408 * Returns : JB_ERR_OK on success
1409 * JB_ERR_MEMORY on out-of-memory error.
1411 *********************************************************************/
1412 jb_err cgi_error_bad_param(struct client_state *csp,
1413 struct http_response *rsp)
1415 struct map *exports;
1420 if (NULL == (exports = default_exports(csp, NULL)))
1422 return JB_ERR_MEMORY;
1425 return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1429 /*********************************************************************
1431 * Function : add_help_link
1433 * Description : Produce a copy of the string given as item,
1434 * embedded in an HTML link to its corresponding
1435 * section (item name in uppercase) in the actions
1436 * chapter of the user manual, (whose URL is given in
1437 * the config and defaults to our web site).
1439 * FIXME: I currently only work for actions, and would
1440 * like to be generalized for other topics.
1443 * 1 : item = item (will NOT be free()d.)
1444 * It is assumed to be HTML-safe.
1445 * 2 : config = The current configuration.
1447 * Returns : String with item embedded in link, or NULL on
1450 *********************************************************************/
1451 char *add_help_link(const char *item,
1452 struct configuration_spec *config)
1456 if (!item) return NULL;
1458 result = strdup("<a href=\"");
1459 string_append(&result, config->usermanual);
1460 string_append(&result, ACTIONS_HELP_PREFIX);
1461 string_join (&result, string_toupper(item));
1462 string_append(&result, "\">");
1463 string_append(&result, item);
1464 string_append(&result, "</a> ");
1470 /*********************************************************************
1472 * Function : get_http_time
1474 * Description : Get the time in a format suitable for use in a
1475 * HTTP header - e.g.:
1476 * "Sun, 06 Nov 1994 08:49:37 GMT"
1479 * 1 : time_offset = Time returned will be current time
1480 * plus this number of seconds.
1481 * 2 : buf = Destination for result. Must be long enough
1482 * to hold 29 characters plus a trailing zero.
1486 *********************************************************************/
1487 void get_http_time(int time_offset, char *buf)
1489 static const char day_names[7][4] =
1490 { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1491 static const char month_names[12][4] =
1492 { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1493 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1496 time_t current_time;
1500 time(¤t_time); /* get current time */
1502 current_time += time_offset;
1504 /* get and save the gmt */
1506 #ifdef HAVE_GMTIME_R
1508 t = gmtime_r(¤t_time, &dummy);
1510 t = gmtime(¤t_time);
1514 /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
1516 "%s, %02d %s %4d %02d:%02d:%02d GMT",
1517 day_names[t->tm_wday],
1519 month_names[t->tm_mon],
1529 /*********************************************************************
1531 * Function : finish_http_response
1533 * Description : Fill in the missing headers in an http response,
1534 * and flatten the headers to an http head.
1537 * 1 : rsp = pointer to http_response to be processed
1539 * Returns : A http_response, usually the rsp parameter.
1540 * On error, free()s rsp and returns cgi_error_memory()
1542 *********************************************************************/
1543 struct http_response *finish_http_response(struct http_response *rsp)
1545 char buf[BUFFER_SIZE];
1548 /* Special case - do NOT change this statically allocated response,
1549 * which is ready for output anyway.
1551 if (rsp == cgi_error_memory_response)
1557 * Fill in the HTTP Status
1559 sprintf(buf, "HTTP/1.0 %s", rsp->status ? rsp->status : "200 OK");
1560 err = enlist_first(rsp->headers, buf);
1563 * Set the Content-Length
1565 if (rsp->content_length == 0)
1567 rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
1571 sprintf(buf, "Content-Length: %d", (int)rsp->content_length);
1572 err = enlist(rsp->headers, buf);
1576 * Fill in the default headers:
1578 * Content-Type: default to text/html if not already specified.
1579 * Date: set to current date/time.
1580 * Last-Modified: set to date/time the page was last changed.
1581 * Expires: set to date/time page next needs reloading.
1582 * Cache-Control: set to "no-cache" if applicable.
1584 * See http://www.w3.org/Protocols/rfc2068/rfc2068
1586 if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
1591 * Set Expires to about 10 min into the future so it'll get reloaded
1592 * occasionally, e.g. if Privoxy gets upgraded.
1597 get_http_time(0, buf);
1598 err = enlist_unique_header(rsp->headers, "Date", buf);
1601 /* Some date in the past. */
1602 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
1606 get_http_time(10 * 60, buf); /* 10 * 60sec = 10 minutes */
1607 err = enlist_unique_header(rsp->headers, "Expires", buf);
1613 * Compliant browsers should not cache this due to the "Cache-Control"
1614 * setting. However, to be certain, we also set both "Last-Modified"
1615 * and "Expires" to the current time.
1617 if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
1619 get_http_time(0, buf);
1620 if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
1621 if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
1622 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1629 if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
1631 free_http_response(rsp);
1632 return cgi_error_memory();
1634 rsp->head_length = strlen(rsp->head);
1641 /*********************************************************************
1643 * Function : alloc_http_response
1645 * Description : Allocates a new http_response structure.
1649 * Returns : pointer to a new http_response, or NULL.
1651 *********************************************************************/
1652 struct http_response *alloc_http_response(void)
1654 return (struct http_response *) zalloc(sizeof(struct http_response));
1659 /*********************************************************************
1661 * Function : free_http_response
1663 * Description : Free the memory occupied by an http_response
1664 * and its depandant structures.
1667 * 1 : rsp = pointer to http_response to be freed
1671 *********************************************************************/
1672 void free_http_response(struct http_response *rsp)
1675 * Must special case cgi_error_memory_response, which is never freed.
1677 if (rsp && (rsp != cgi_error_memory_response))
1682 destroy_list(rsp->headers);
1689 /*********************************************************************
1691 * Function : template_load
1693 * Description : CGI support function that loads a given HTML
1694 * template from the confdir, ignoring comment
1695 * lines and following #include statements up to
1699 * 1 : csp = Current client state (buffers, headers, etc...)
1700 * 2 : template_ptr = Destination for pointer to loaded
1702 * 3 : templatename = name of the HTML template to be used
1703 * 4 : recursive = Flag set if this function calls itself
1704 * following an #include statament
1706 * Returns : JB_ERR_OK on success
1707 * JB_ERR_MEMORY on out-of-memory error.
1708 * JB_ERR_FILE if the template file cannot be read
1710 *********************************************************************/
1711 jb_err template_load(struct client_state *csp, char **template_ptr,
1712 const char *templatename, int recursive)
1715 char *templates_dir_path;
1718 char *included_module;
1721 char buf[BUFFER_SIZE];
1724 assert(template_ptr);
1725 assert(templatename);
1727 *template_ptr = NULL;
1729 /* Validate template name. Paranoia. */
1730 for (p = templatename; *p != 0; p++)
1732 if ( ((*p < 'a') || (*p > 'z'))
1733 && ((*p < 'A') || (*p > 'Z'))
1734 && ((*p < '0') || (*p > '9'))
1738 /* Illegal character */
1743 /* Generate full path */
1745 templates_dir_path = make_path(csp->config->confdir, "templates");
1746 if (templates_dir_path == NULL)
1748 return JB_ERR_MEMORY;
1751 full_path = make_path(templates_dir_path, templatename);
1752 free(templates_dir_path);
1753 if (full_path == NULL)
1755 return JB_ERR_MEMORY;
1758 /* Allocate buffer */
1760 file_buffer = strdup("");
1761 if (file_buffer == NULL)
1764 return JB_ERR_MEMORY;
1767 /* Open template file */
1769 if (NULL == (fp = fopen(full_path, "r")))
1771 log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
1779 * Read the file, ignoring comments, and honoring #include
1780 * statements, unless we're already called recursively.
1782 * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
1783 * This is unlikely in practise.
1785 while (fgets(buf, BUFFER_SIZE, fp))
1787 if (!recursive && !strncmp(buf, "#include ", 9))
1789 if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
1796 if (string_join(&file_buffer, included_module))
1799 return JB_ERR_MEMORY;
1805 /* skip lines starting with '#' */
1811 if (string_append(&file_buffer, buf))
1814 return JB_ERR_MEMORY;
1819 *template_ptr = file_buffer;
1825 /*********************************************************************
1827 * Function : template_fill
1829 * Description : CGI support function that fills in a pre-loaded
1830 * HTML template by replacing @name@ with value using
1831 * pcrs, for each item in the output map.
1833 * Note that a leading '$' charachter in the export map's
1834 * values will be stripped and toggle on backreference
1838 * 1 : template_ptr = IN: Template to be filled out.
1840 * OUT: Filled out template.
1841 * Caller must free().
1842 * 2 : exports = map with fill in symbol -> name pairs
1844 * Returns : JB_ERR_OK on success
1845 * JB_ERR_MEMORY on out-of-memory error
1847 *********************************************************************/
1848 jb_err template_fill(char **template_ptr, const struct map *exports)
1850 struct map_entry *m;
1852 char buf[BUFFER_SIZE];
1853 char *tmp_out_buffer;
1859 assert(template_ptr);
1860 assert(*template_ptr);
1863 file_buffer = *template_ptr;
1864 size = strlen(file_buffer) + 1;
1867 * Assemble pcrs joblist from exports map
1869 for (m = exports->first; m != NULL; m = m->next)
1871 if (*m->name == '$')
1874 * First character of name is '$', so remove this flag
1875 * character and allow backreferences ($1 etc) in the
1876 * "replace with" text.
1878 snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
1884 * Treat the "replace with" text as a literal string -
1885 * no quoting needed, no backreferences allowed.
1886 * ("Trivial" ['T'] flag).
1890 /* Enclose name in @@ */
1891 snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
1895 log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
1897 /* Make and run job. */
1898 job = pcrs_compile(buf, m->value, flags, &error);
1901 if (error == PCRS_ERR_NOMEM)
1904 *template_ptr = NULL;
1905 return JB_ERR_MEMORY;
1909 log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
1910 /* Hope it wasn't important and silently ignore the invalid job */
1915 pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
1918 if (NULL == tmp_out_buffer)
1920 *template_ptr = NULL;
1921 return JB_ERR_MEMORY;
1923 file_buffer = tmp_out_buffer;
1930 *template_ptr = file_buffer;
1935 /*********************************************************************
1937 * Function : template_fill_for_cgi
1939 * Description : CGI support function that loads a HTML template
1940 * and fills it in. Handles file-not-found errors
1941 * by sending a HTML error message. For convenience,
1942 * this function also frees the passed "exports" map.
1945 * 1 : csp = Client state
1946 * 2 : templatename = name of the HTML template to be used
1947 * 3 : exports = map with fill in symbol -> name pairs.
1948 * Will be freed by this function.
1949 * 4 : rsp = Response structure to fill in.
1951 * Returns : JB_ERR_OK on success
1952 * JB_ERR_MEMORY on out-of-memory error
1954 *********************************************************************/
1955 jb_err template_fill_for_cgi(struct client_state *csp,
1956 const char *templatename,
1957 struct map *exports,
1958 struct http_response *rsp)
1963 assert(templatename);
1967 err = template_load(csp, &rsp->body, templatename, 0);
1968 if (err == JB_ERR_FILE)
1971 return cgi_error_no_template(csp, rsp, templatename);
1976 return err; /* JB_ERR_MEMORY */
1978 err = template_fill(&rsp->body, exports);
1984 /*********************************************************************
1986 * Function : default_exports
1988 * Description : returns a struct map list that contains exports
1989 * which are common to all CGI functions.
1992 * 1 : csp = Current client state (buffers, headers, etc...)
1993 * 2 : caller = name of CGI who calls us and which should
1994 * be excluded from the generated menu. May be
1996 * Returns : NULL if no memory, else a new map. Caller frees.
1998 *********************************************************************/
1999 struct map *default_exports(const struct client_state *csp, const char *caller)
2003 struct map * exports;
2004 int local_help_exists = 0;
2008 exports = new_map();
2009 if (exports == NULL)
2014 err = map(exports, "version", 1, html_encode(VERSION), 0);
2015 if (!err) err = map(exports, "my-ip-address", 1, html_encode(csp->my_ip_addr_str ? csp->my_ip_addr_str : "unknown"), 0);
2016 if (!err) err = map(exports, "my-hostname", 1, html_encode(csp->my_hostname ? csp->my_hostname : "unknown"), 0);
2017 if (!err) err = map(exports, "homepage", 1, html_encode(HOME_PAGE_URL), 0);
2018 if (!err) err = map(exports, "default-cgi", 1, html_encode(CGI_PREFIX), 0);
2019 if (!err) err = map(exports, "menu", 1, make_menu(caller), 0);
2020 if (!err) err = map(exports, "code-status", 1, CODE_STATUS, 1);
2021 if (!err) err = map(exports, "user-manual", 1, csp->config->usermanual ,1);
2022 if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2023 #ifdef FEATURE_TOGGLE
2024 if (!err) err = map_conditional(exports, "enabled-display", g_bToggleIJB);
2027 snprintf(buf, 20, "%d", csp->config->hport);
2028 if (!err) err = map(exports, "my-port", 1, buf, 1);
2030 if(!strcmp(CODE_STATUS, "stable"))
2032 if (!err) err = map_block_killer(exports, "unstable");
2035 if (csp->config->admin_address != NULL)
2037 if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2038 local_help_exists = 1;
2042 if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2045 if (csp->config->proxy_info_url != NULL)
2047 if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2048 local_help_exists = 1;
2052 if (!err) err = map_block_killer(exports, "have-proxy-info");
2055 if (local_help_exists == 0)
2057 if (!err) err = map_block_killer(exports, "have-help-info");
2070 /*********************************************************************
2072 * Function : map_block_killer
2074 * Description : Convenience function.
2075 * Adds a "killer" for the conditional HTML-template
2076 * block <name>, i.e. a substitution of the regex
2077 * "if-<name>-start.*if-<name>-end" to the given
2081 * 1 : exports = map to extend
2082 * 2 : name = name of conditional block
2084 * Returns : JB_ERR_OK on success
2085 * JB_ERR_MEMORY on out-of-memory error.
2087 *********************************************************************/
2088 jb_err map_block_killer(struct map *exports, const char *name)
2090 char buf[1000]; /* Will do, since the names are hardwired */
2094 assert(strlen(name) < 490);
2096 snprintf(buf, 1000, "if-%s-start.*if-%s-end", name, name);
2097 return map(exports, buf, 1, "", 1);
2101 /*********************************************************************
2103 * Function : map_block_keep
2105 * Description : Convenience function. Removes the markers used
2106 * by map-block-killer, to save a few bytes.
2107 * i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2110 * 1 : exports = map to extend
2111 * 2 : name = name of conditional block
2113 * Returns : JB_ERR_OK on success
2114 * JB_ERR_MEMORY on out-of-memory error.
2116 *********************************************************************/
2117 jb_err map_block_keep(struct map *exports, const char *name)
2120 char buf[500]; /* Will do, since the names are hardwired */
2124 assert(strlen(name) < 490);
2126 snprintf(buf, 500, "if-%s-start", name);
2127 err = map(exports, buf, 1, "", 1);
2134 snprintf(buf, 500, "if-%s-end", name);
2135 return map(exports, buf, 1, "", 1);
2139 /*********************************************************************
2141 * Function : map_conditional
2143 * Description : Convenience function.
2144 * Adds an "if-then-else" for the conditional HTML-template
2145 * block <name>, i.e. a substitution of the form:
2152 * The control structure and one of the alternatives
2156 * 1 : exports = map to extend
2157 * 2 : name = name of conditional block
2158 * 3 : choose_first = nonzero for first, zero for second.
2160 * Returns : JB_ERR_OK on success
2161 * JB_ERR_MEMORY on out-of-memory error.
2163 *********************************************************************/
2164 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2166 char buf[1000]; /* Will do, since the names are hardwired */
2171 assert(strlen(name) < 480);
2173 snprintf(buf, 1000, (choose_first
2174 ? "else-not-%s@.*@endif-%s"
2175 : "if-%s-then@.*@else-not-%s"),
2178 err = map(exports, buf, 1, "", 1);
2184 snprintf(buf, 1000, (choose_first ? "if-%s-then" : "endif-%s"), name);
2185 return map(exports, buf, 1, "", 1);
2189 /*********************************************************************
2191 * Function : make_menu
2193 * Description : Returns an HTML-formatted menu of the available
2194 * unhidden CGIs, excluding the one given in <self>
2196 * Parameters : self = name of CGI to leave out, can be NULL for
2199 * Returns : menu string, or NULL on out-of-memory error.
2201 *********************************************************************/
2202 char *make_menu(const char *self)
2204 const struct cgi_dispatcher *d;
2205 char *result = strdup("");
2209 self = "NO-SUCH-CGI!";
2212 /* List available unhidden CGI's and export as "other-cgis" */
2213 for (d = cgi_dispatchers; d->name; d++)
2215 if (d->description && strcmp(d->name, self))
2217 string_append(&result, "<li><a href=\"" CGI_PREFIX);
2218 string_append(&result, d->name);
2219 string_append(&result, "\">");
2220 string_append(&result, d->description);
2221 string_append(&result, "</a></li>");
2229 /*********************************************************************
2231 * Function : dump_map
2233 * Description : HTML-dump a map for debugging (as table)
2236 * 1 : the_map = map to dump
2238 * Returns : string with HTML
2240 *********************************************************************/
2241 char *dump_map(const struct map *the_map)
2243 struct map_entry *cur_entry;
2244 char *ret = strdup("");
2246 string_append(&ret, "<table>\n");
2248 for (cur_entry = the_map->first;
2249 (cur_entry != NULL) && (ret != NULL);
2250 cur_entry = cur_entry->next)
2252 string_append(&ret, "<tr><td><b>");
2253 string_join (&ret, html_encode(cur_entry->name));
2254 string_append(&ret, "</b></td><td>");
2255 string_join (&ret, html_encode(cur_entry->value));
2256 string_append(&ret, "</td></tr>\n");
2259 string_append(&ret, "</table>\n");