Add a @date@ symbol to include a date(1)-like time string
[privoxy.git] / cgi.c
1 const char cgi_rcs[] = "$Id: cgi.c,v 1.109 2008/07/26 09:40:27 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/cgi.c,v $
5  *
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.
10  *                
11  *                Functions declared include:
12  * 
13  *
14  * Copyright   :  Written by and Copyright (C) 2001-2004, 2006-2008
15  *                the SourceForge Privoxy team. http://www.privoxy.org/
16  *
17  *                Based on the Internet Junkbuster originally written
18  *                by and Copyright (C) 1997 Anonymous Coders and 
19  *                Junkbusters Corporation.  http://www.junkbusters.com
20  *
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.
26  *
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.
32  *
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.
38  *
39  * Revisions   :
40  *    $Log: cgi.c,v $
41  *    Revision 1.109  2008/07/26 09:40:27  fabiankeil
42  *    Remove the unconditional block in get_http_time().
43  *    It's pointless now that it's no longer used to limit
44  *    dummy's scope. While at it, remove obvious comments
45  *    and a trailing space.
46  *
47  *    Revision 1.108  2008/05/26 17:30:53  fabiankeil
48  *    Provide an OpenSearch Description to access the
49  *    show-url-info page through "search engine plugins".
50  *
51  *    Revision 1.107  2008/05/26 16:23:19  fabiankeil
52  *    - Fix spelling in template-not-found message.
53  *    - Declare referrer_is_safe()'s alternative_prefix[] static.
54  *
55  *    Revision 1.106  2008/05/21 15:24:38  fabiankeil
56  *    Mark csp as immutable for a bunch of functions.
57  *
58  *    Revision 1.105  2008/04/17 14:40:47  fabiankeil
59  *    Provide get_http_time() with the buffer size so it doesn't
60  *    have to blindly assume that the buffer is big enough.
61  *
62  *    Revision 1.104  2008/03/26 18:07:06  fabiankeil
63  *    Add hostname directive. Closes PR#1918189.
64  *
65  *    Revision 1.103  2008/03/21 11:13:57  fabiankeil
66  *    Only gather host information if it's actually needed.
67  *    Also move the code out of accept_connection() so it's less likely
68  *    to delay other incoming connections if the host is misconfigured.
69  *
70  *    Revision 1.102  2008/02/23 16:33:43  fabiankeil
71  *    Let forward_url() use the standard parameter ordering
72  *    and mark its second parameter immutable.
73  *
74  *    Revision 1.101  2008/02/03 15:45:06  fabiankeil
75  *    Add SOCKS5 support for "Forwarding failure" CGI page.
76  *
77  *    Revision 1.100  2007/10/17 18:40:53  fabiankeil
78  *    - Send CGI pages as HTTP/1.1 unless the client asked for HTTP/1.0.
79  *    - White space fix.
80  *
81  *    Revision 1.99  2007/08/05 13:42:22  fabiankeil
82  *    #1763173 from Stefan Huehner: declare some more functions static.
83  *
84  *    Revision 1.98  2007/05/14 10:33:51  fabiankeil
85  *    - Use strlcpy() and strlcat() instead of strcpy() and strcat().
86  *
87  *    Revision 1.97  2007/04/09 18:11:35  fabiankeil
88  *    Don't mistake VC++'s _snprintf() for a snprintf() replacement.
89  *
90  *    Revision 1.96  2007/03/08 17:41:05  fabiankeil
91  *    Use sizeof() more often.
92  *
93  *    Revision 1.95  2007/02/10 17:01:37  fabiankeil
94  *    Don't overlook map result for the forwarding-type.
95  *
96  *    Revision 1.94  2007/02/08 19:44:49  fabiankeil
97  *    Use a transparent background for the PNG replacement pattern.
98  *
99  *    Revision 1.93  2007/02/07 10:45:22  fabiankeil
100  *    - Save the reason for generating http_responses.
101  *    - Fix --disable-toggle (again).
102  *    - Use TBL birthday hack for 403 responses as well.
103  *    - Uglify the @menu@ again to fix JavaScript
104  *      errors on the "blocked" template.
105  *    - Escape an ampersand in cgi_error_unknown().
106  *
107  *    Revision 1.92  2007/01/28 13:41:17  fabiankeil
108  *    - Add HEAD support to finish_http_response.
109  *    - Add error favicon to internal HTML error messages.
110  *
111  *    Revision 1.91  2007/01/27 13:09:16  fabiankeil
112  *    Add new config option "templdir" to
113  *    change the templates directory.
114  *
115  *    Revision 1.90  2007/01/25 13:47:26  fabiankeil
116  *    Added "forwarding-failed" template support for error_response().
117  *
118  *    Revision 1.89  2007/01/23 15:51:16  fabiankeil
119  *    Add favicon delivery functions.
120  *
121  *    Revision 1.88  2007/01/23 13:14:32  fabiankeil
122  *    - Map variables that aren't guaranteed to be
123  *      pure ASCII html_encoded.
124  *    - Use CGI_PREFIX to generate URL for user manual
125  *      CGI page to make sure CGI_SITE_2_PATH is included.
126  *
127  *    Revision 1.87  2007/01/22 15:34:13  fabiankeil
128  *    - "Protect" against a rather lame JavaScript-based
129  *      Privoxy detection "attack" and check the referrer
130  *      before delivering the CGI style sheet.
131  *    - Move referrer check for unsafe CGI pages into
132  *      referrer_is_safe() and log the result.
133  *    - Map @url@ in cgi-error-disabled page.
134  *      It's required for the "go there anyway" link.
135  *    - Mark *csp as immutable for grep_cgi_referrer().
136  *
137  *    Revision 1.86  2007/01/09 11:54:26  fabiankeil
138  *    Fix strdup() error handling in cgi_error_unknown()
139  *    and cgi_error_no_template(). Reported by Markus Elfring.
140  *
141  *    Revision 1.85  2007/01/05 14:19:02  fabiankeil
142  *    Handle pcrs_execute() errors in template_fill() properly.
143  *
144  *    Revision 1.84  2006/12/28 17:54:22  fabiankeil
145  *    Fixed gcc43 conversion warnings and replaced sprintf
146  *    calls with snprintf to give OpenBSD's gcc one less reason
147  *    to complain.
148  *
149  *    Revision 1.83  2006/12/17 19:35:19  fabiankeil
150  *    Escape ampersand in Privoxy menu.
151  *
152  *    Revision 1.82  2006/12/17 17:53:39  fabiankeil
153  *    Suppress the toggle link if remote toggling is disabled.
154  *
155  *    Revision 1.81  2006/12/09 13:49:16  fabiankeil
156  *    Fix configure option --disable-toggle.
157  *    Thanks to Peter Thoenen for reporting this.
158  *
159  *    Revision 1.80  2006/12/08 14:45:32  fabiankeil
160  *    Don't lose the FORCE_PREFIX in case of
161  *    connection problems. Fixes #612235.
162  *
163  *    Revision 1.79  2006/11/13 19:05:50  fabiankeil
164  *    Make pthread mutex locking more generic. Instead of
165  *    checking for OSX and OpenBSD, check for FEATURE_PTHREAD
166  *    and use mutex locking unless there is an _r function
167  *    available. Better safe than sorry.
168  *
169  *    Fixes "./configure --disable-pthread" and should result
170  *    in less threading-related problems on pthread-using platforms,
171  *    but it still doesn't fix BR#1122404.
172  *
173  *    Revision 1.78  2006/09/21 19:22:07  fabiankeil
174  *    Use CGI_PREFIX to check the referrer.
175  *    The check for "http://config.privoxy.org/" fails
176  *    if the user modified CGI_SITE_2_HOST.
177  *
178  *    Revision 1.77  2006/09/21 15:17:23  fabiankeil
179  *    Adjusted headers for Privoxy's cgi responses:
180  *    Don't set Last-Modified, Expires and Cache-Control
181  *    headers for redirects; always set "Connection: close".
182  *
183  *    Revision 1.76  2006/09/07 14:06:38  fabiankeil
184  *    Only predate the Last-Modified header for cgi responses
185  *    that are delivered with status code 404 or 503.
186  *
187  *    Revision 1.75  2006/09/07 11:56:39  fabiankeil
188  *    Mark cgi_send_user_manual as harmless,
189  *    to fix the access denied problem Hal spotted.
190  *    The manual has no secret content, therefore we
191  *    don't have to care about "secure" referrers.
192  *
193  *    Revision 1.74  2006/09/06 18:45:03  fabiankeil
194  *    Incorporate modified version of Roland Rosenfeld's patch to
195  *    optionally access the user-manual via Privoxy. Closes patch 679075.
196  *
197  *    Formatting changed to Privoxy style, added call to
198  *    cgi_error_no_template if the requested file doesn't
199  *    exist and modified check whether or not Privoxy itself
200  *    should serve the manual. Should work cross-platform now.
201  *
202  *    Revision 1.73  2006/08/03 02:46:41  david__schmidt
203  *    Incorporate Fabian Keil's patch work:\rhttp://www.fabiankeil.de/sourcecode/privoxy/
204  *
205  *    Revision 1.72  2006/07/18 14:48:45  david__schmidt
206  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
207  *    with what was really the latest development (the v_3_0_branch branch)
208  *
209  *    Revision 1.70.2.13  2004/02/17 13:30:23  oes
210  *    Moved cgi_error_disabled() from cgiedit.c to
211  *    cgi.c to re-enable build with --disable-editor.
212  *    Fixes Bug #892744. Thanks to Matthew Fischer
213  *    for spotting.
214  *
215  *    Revision 1.70.2.12  2003/12/17 16:33:16  oes
216  *     - Added new function cgi_redirect to handle creation of
217  *       HTTP redirect messages formerly repeated in the code.
218  *     - Send cgi_error_disabled instead of cgi_error_404 when
219  *       referrer check fails
220  *     - Dynamic content now gets Expires header field with date
221  *       in the past
222  *
223  *    Revision 1.70.2.11  2003/10/23 12:29:26  oes
224  *    Bugfix: Transparent PNG was not transparent. Thanks to
225  *    Dan Razzell of Starfish Systems for notice and new PNG.
226  *
227  *    Revision 1.70.2.10  2003/06/06 07:54:25  oes
228  *    Security fix: dspatch_known_cgi no longer considers an empty
229  *    referrer safe for critical CGIs, since malicious links could
230  *    reside on https:// locations which browsers don't advertize as
231  *    referrers. Closes bug #749916, thanks to Jeff Epler for the
232  *    hint. Goodbye One-Click[tm] toggling :-(
233  *
234  *    Revision 1.70.2.9  2003/05/08 15:11:31  oes
235  *    Nit
236  *
237  *    Revision 1.70.2.8  2003/04/29 13:33:51  oes
238  *    Killed a compiler warning on OSX
239  *
240  *    Revision 1.70.2.7  2003/04/03 13:50:58  oes
241  *    - Don't call cgi_error_disabled ifndef FEATURE_CGI_EDIT_ACTIONS
242  *      (fixes bug #710056)
243  *    - Show toggle info only if we have it
244  *
245  *    Revision 1.70.2.6  2003/03/12 01:26:25  david__schmidt
246  *    Move declaration of struct tm dummy outside of a control block so it is
247  *    accessible later on during snprintf in get_http_time.
248  *
249  *    Revision 1.70.2.5  2003/03/11 11:53:58  oes
250  *    Cosmetic: Renamed cryptic variable
251  *
252  *    Revision 1.70.2.4  2003/03/07 03:41:03  david__schmidt
253  *    Wrapping all *_r functions (the non-_r versions of them) with mutex semaphores for OSX.  Hopefully this will take care of all of those pesky crash reports.
254  *
255  *    Revision 1.70.2.3  2002/11/28 18:14:32  oes
256  *    Disable access to critical CGIs via untrusted referrers.
257  *    This prevents users from being tricked by malicious websites
258  *    into making unintentional configuration changes:
259  *
260  *     - Added flag to each cgi_dispatcher that allows or denies
261  *       external linking
262  *     - Introduced proviorical function that greps for the
263  *       referrer header before regular header parsing happens
264  *     - Added safety check to dispatch_known_cgi. CGI is called
265  *       if (cgi harmless || no referrer || we are referrer).
266  *       Else a) toggle calls are modified not to change status and
267  *       b) all other calls are denied.
268  *
269  *    Revision 1.70.2.2  2002/11/12 16:20:37  oes
270  *    Added missing #ifdef FEATURE_TOGGLE around g_bToggleIJB; fixes bug #636651
271  *
272  *    Revision 1.70.2.1  2002/08/05 11:17:46  oes
273  *    Fixed Bug #587820, i.e. added workaround for IE bug that includes fragment identifier in (cgi) query
274  *
275  *    Revision 1.70  2002/05/19 11:33:20  jongfoster
276  *    If a CGI error was not handled, and propogated back to
277  *    dispatch_known_cgi(), then it was assumed to be "out of memory".
278  *    This gave a very misleading error message.
279  *
280  *    Now other errors will cause a simple message giving the error
281  *    number and asking the user to report a bug.
282  *
283  *    Bug report:
284  *    http://sourceforge.net/tracker/index.php?func=detail
285  *    &aid=557905&group_id=11118&atid=111118
286  *
287  *    Revision 1.69  2002/05/14 21:28:40  oes
288  *     - Fixed add_help_link to link to the (now split) actions
289  *       part of the config chapter
290  *     - Renamed helplink export to actions-help-prefix
291  *
292  *    Revision 1.68  2002/05/12 21:36:29  jongfoster
293  *    Correcting function comments
294  *
295  *    Revision 1.67  2002/04/30 12:02:07  oes
296  *    Nit: updated a comment
297  *
298  *    Revision 1.66  2002/04/26 18:32:57  jongfoster
299  *    Fixing a memory leak on error
300  *
301  *    Revision 1.65  2002/04/26 12:53:51  oes
302  *     - New function add_help_link
303  *     - default_exports now exports links to the user manual
304  *       and a prefix for links into the config chapter
305  *
306  *    Revision 1.64  2002/04/24 02:17:21  oes
307  *     - Better descriptions for CGIs
308  *     - Hide edit-actions, more shortcuts
309  *     - Moved get_char_param, get_string_param and get_number_param here
310  *       from cgiedit.c
311  *
312  *    Revision 1.63  2002/04/15 19:06:43  jongfoster
313  *    Typos
314  *
315  *    Revision 1.62  2002/04/10 19:59:46  jongfoster
316  *    Fixes to #include in templates:
317  *    - Didn't close main file if loading an included template fails.
318  *    - I'm paranoid and want to disallow "#include /etc/passwd".
319  *
320  *    Revision 1.61  2002/04/10 13:37:48  oes
321  *    Made templates modular: template_load now recursive with max depth 1
322  *
323  *    Revision 1.60  2002/04/08 20:50:25  swa
324  *    fixed JB spelling
325  *
326  *    Revision 1.59  2002/04/05 15:51:51  oes
327  *     - added send-stylesheet CGI
328  *     - bugfix: error-pages now get correct request protocol
329  *     - fixed
330  *     - kludged CGI descriptions and menu not to break JS syntax
331  *
332  *    Revision 1.58  2002/03/29 03:33:13  david__schmidt
333  *    Fix Mac OSX compiler warnings
334  *
335  *    Revision 1.57  2002/03/26 22:29:54  swa
336  *    we have a new homepage!
337  *
338  *    Revision 1.56  2002/03/24 17:50:46  jongfoster
339  *    Fixing compile error if actions file editor disabled
340  *
341  *    Revision 1.55  2002/03/24 16:55:06  oes
342  *    Making GIF checkerboard transparent
343  *
344  *    Revision 1.54  2002/03/24 16:18:15  jongfoster
345  *    Removing old logo
346  *
347  *    Revision 1.53  2002/03/24 16:06:00  oes
348  *    Correct transparency for checkerboard PNG. Thanks, Magnus!
349  *
350  *    Revision 1.52  2002/03/24 15:23:33  jongfoster
351  *    Name changes
352  *
353  *    Revision 1.51  2002/03/24 13:25:43  swa
354  *    name change related issues
355  *
356  *    Revision 1.50  2002/03/16 23:54:06  jongfoster
357  *    Adding graceful termination feature, to help look for memory leaks.
358  *    If you enable this (which, by design, has to be done by hand
359  *    editing config.h) and then go to http://i.j.b/die, then the program
360  *    will exit cleanly after the *next* request.  It should free all the
361  *    memory that was used.
362  *
363  *    Revision 1.49  2002/03/13 00:27:04  jongfoster
364  *    Killing warnings
365  *
366  *    Revision 1.48  2002/03/08 17:47:07  jongfoster
367  *    Adding comments
368  *
369  *    Revision 1.47  2002/03/08 16:41:33  oes
370  *    Added GIF images again
371  *
372  *    Revision 1.46  2002/03/07 03:48:38  oes
373  *     - Changed built-in images from GIF to PNG
374  *       (with regard to Unisys patent issue)
375  *     - Added a 4x4 pattern PNG which is less intrusive
376  *       than the logo but also clearly marks the deleted banners
377  *
378  *    Revision 1.45  2002/03/06 22:54:35  jongfoster
379  *    Automated function-comment nitpicking.
380  *
381  *    Revision 1.44  2002/03/05 22:43:45  david__schmidt
382  *    - Better error reporting on OS/2
383  *    - Fix double-slash comment (oops)
384  *
385  *    Revision 1.43  2002/03/05 21:33:45  david__schmidt
386  *    - Re-enable OS/2 building after new parms were added
387  *    - Fix false out of memory report when resolving CGI templates when no IP
388  *      address is available of failed attempt (a la no such domain)
389  *
390  *    Revision 1.42  2002/01/21 00:33:20  jongfoster
391  *    Replacing strsav() with the safer string_append() or string_join().
392  *    Adding map_block_keep() to save a few bytes in the edit-actions-list HTML.
393  *    Adding missing html_encode() to error message generators.
394  *    Adding edit-actions-section-swap and many "shortcuts" to the list of CGIs.
395  *
396  *    Revision 1.41  2002/01/17 20:56:22  jongfoster
397  *    Replacing hard references to the URL of the config interface
398  *    with #defines from project.h
399  *
400  *    Revision 1.40  2002/01/09 14:26:46  oes
401  *    Added support for thread-safe gmtime_r call.
402  *
403  *    Revision 1.39  2001/11/16 00:48:13  jongfoster
404  *    Fixing a compiler warning
405  *
406  *    Revision 1.38  2001/11/13 00:31:21  jongfoster
407  *    - Adding new CGIs for use by non-JavaScript browsers:
408  *        edit-actions-url-form
409  *        edit-actions-add-url-form
410  *        edit-actions-remove-url-form
411  *    - Fixing make_menu()'s HTML generation - it now quotes the href parameter.
412  *    - Fixing || bug.
413  *
414  *    Revision 1.37  2001/11/01 14:28:47  david__schmidt
415  *    Show enablement/disablement status in almost all templates.
416  *    There is a little trickiness here: apparent recursive resolution of
417  *    @if-enabled-then@ caused the toggle template to show status out-of-phase with
418  *    the actual enablement status.  So a similar construct,
419  *    @if-enabled-display-then@, is used to resolve the status display on non-'toggle'
420  *    templates.
421  *
422  *    Revision 1.36  2001/10/26 17:33:27  oes
423  *    marginal bugfix
424  *
425  *    Revision 1.35  2001/10/23 21:48:19  jongfoster
426  *    Cleaning up error handling in CGI functions - they now send back
427  *    a HTML error page and should never cause a FATAL error.  (Fixes one
428  *    potential source of "denial of service" attacks).
429  *
430  *    CGI actions file editor that works and is actually useful.
431  *
432  *    Ability to toggle Junkbuster remotely using a CGI call.
433  *
434  *    You can turn off both the above features in the main configuration
435  *    file, e.g. if you are running a multi-user proxy.
436  *
437  *    Revision 1.34  2001/10/18 22:22:09  david__schmidt
438  *    Only show "Local support" on templates conditionally:
439  *      - if either 'admin-address' or 'proxy-info-url' are uncommented in config
440  *      - if not, no Local support section appears
441  *
442  *    Revision 1.33  2001/10/14 22:28:41  jongfoster
443  *    Fixing stupid typo.
444  *
445  *    Revision 1.32  2001/10/14 22:20:18  jongfoster
446  *    - Changes to CGI dispatching method to match CGI names exactly,
447  *      rather than doing a prefix match.
448  *    - No longer need to count the length of the CGI handler names by hand.
449  *    - Adding new handler for 404 error when disptching a CGI, if none of
450  *      the handlers match.
451  *    - Adding new handlers for CGI actionsfile editor.
452  *
453  *    Revision 1.31  2001/10/10 10:56:39  oes
454  *    Failiure to load template now fatal. Before, the user got a hard-to-understand assertion failure from cgi.c
455  *
456  *    Revision 1.30  2001/10/02 15:30:57  oes
457  *    Introduced show-request cgi
458  *
459  *    Revision 1.29  2001/09/20 15:47:44  steudten
460  *
461  *    Fix BUG: Modify int size to size_t size in fill_template()
462  *     - removes big trouble on machines where sizeof(int) != sizeof(size_t).
463  *
464  *    Revision 1.28  2001/09/19 18:00:37  oes
465  *     - Deletef time() FIXME (Can't fail under Linux either, if
466  *       the argument is guaranteed to be in out address space,
467  *       which it is.)
468  *     - Fixed comments
469  *     - Pointer notation cosmetics
470  *     - Fixed a minor bug in template_fill(): Failiure of
471  *       pcrs_execute() now secure.
472  *
473  *    Revision 1.27  2001/09/16 17:08:54  jongfoster
474  *    Moving simple CGI functions from cgi.c to new file cgisimple.c
475  *
476  *    Revision 1.26  2001/09/16 15:47:37  jongfoster
477  *    First version of CGI-based edit interface.  This is very much a
478  *    work-in-progress, and you can't actually use it to edit anything
479  *    yet.  You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
480  *    to have any effect.
481  *
482  *    Revision 1.25  2001/09/16 15:02:35  jongfoster
483  *    Adding i.j.b/robots.txt.
484  *    Inlining add_stats() since it's only ever called from one place.
485  *
486  *    Revision 1.24  2001/09/16 11:38:01  jongfoster
487  *    Splitting fill_template() into 2 functions:
488  *    template_load() loads the file
489  *    template_fill() performs the PCRS regexps.
490  *    This is because the CGI edit interface has a "table row"
491  *    template which is used many times in the page - this
492  *    change means it's only loaded from disk once.
493  *
494  *    Revision 1.23  2001/09/16 11:16:05  jongfoster
495  *    Better error handling in dispatch_cgi() and parse_cgi_parameters()
496  *
497  *    Revision 1.22  2001/09/16 11:00:10  jongfoster
498  *    New function alloc_http_response, for symmetry with free_http_response
499  *
500  *    Revision 1.21  2001/09/13 23:53:03  jongfoster
501  *    Support for both static and dynamically generated CGI pages.
502  *    Correctly setting Last-Modified: and Expires: HTTP headers.
503  *
504  *    Revision 1.20  2001/09/13 23:40:36  jongfoster
505  *    (Cosmetic only) Indentation correction
506  *
507  *    Revision 1.19  2001/09/13 23:31:25  jongfoster
508  *    Moving image data to cgi.c rather than cgi.h.
509  *
510  *    Revision 1.18  2001/08/05 16:06:20  jongfoster
511  *    Modifiying "struct map" so that there are now separate header and
512  *    "map_entry" structures.  This means that functions which modify a
513  *    map no longer need to return a pointer to the modified map.
514  *    Also, it no longer reverses the order of the entries (which may be
515  *    important with some advanced template substitutions).
516  *
517  *    Revision 1.17  2001/08/05 15:57:38  oes
518  *    Adapted finish_http_response to new list_to_text
519  *
520  *    Revision 1.16  2001/08/01 21:33:18  jongfoster
521  *    Changes to fill_template() that reduce memory usage without having
522  *    an impact on performance.  I also renamed some variables so as not
523  *    to clash with the C++ keywords "new" and "template".
524  *
525  *    Revision 1.15  2001/08/01 21:19:22  jongfoster
526  *    Moving file version information to a separate CGI page.
527  *
528  *    Revision 1.14  2001/08/01 00:19:03  jongfoster
529  *    New function: map_conditional() for an if-then-else syntax.
530  *    Changing to use new version of show_defines()
531  *
532  *    Revision 1.13  2001/07/30 22:08:36  jongfoster
533  *    Tidying up #defines:
534  *    - All feature #defines are now of the form FEATURE_xxx
535  *    - Permanently turned off WIN_GUI_EDIT
536  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
537  *
538  *    Revision 1.12  2001/07/29 18:47:05  jongfoster
539  *    Adding missing #include "loadcfg.h"
540  *
541  *    Revision 1.11  2001/07/18 17:24:37  oes
542  *    Changed to conform to new pcrs interface
543  *
544  *    Revision 1.10  2001/07/13 13:53:13  oes
545  *    Removed all #ifdef PCRS and related code
546  *
547  *    Revision 1.9  2001/06/29 21:45:41  oes
548  *    Indentation, CRLF->LF, Tab-> Space
549  *
550  *    Revision 1.8  2001/06/29 13:21:46  oes
551  *    - Cosmetics: renamed and reordered functions, variables,
552  *      texts, improved comments  etc
553  *
554  *    - Removed ij_untrusted_url() The relevant
555  *      info is now part of the "untrusted" page,
556  *      which is generated by filters.c:trust_url()
557  *
558  *    - Generators of content now call finish_http_response()
559  *      themselves, making jcc.c:chat() a little less
560  *      cluttered
561  *
562  *    - Removed obsolete "Pragma: no-cache" from our headers
563  *
564  *    - http_responses now know their head length
565  *
566  *    - fill_template now uses the new interface to pcrs, so that
567  *       - long jobs (like whole files) no longer have to be assembled
568  *         in a fixed size buffer
569  *       - the new T (trivial) option is used, and the replacement may
570  *         contain Perl syntax backrefs without confusing pcrs
571  *
572  *    - Introduced default_exports() which generates a set of exports
573  *      common to all CGIs and other content generators
574  *
575  *    - Introduced convenience function map_block_killer()
576  *
577  *    - Introduced convenience function make_menu()
578  *
579  *    - Introduced CGI-like function error_response() which generates
580  *      the "No such domain" and "Connect failed" messages using the
581  *      CGI platform
582  *
583  *    - cgi_show_url_info:
584  *      - adapted to new CGI features
585  *      - form and answers now generated from same template
586  *      - http:// prefix in URL now OK
587  *
588  *    - cgi_show_status:
589  *      - adapted to new CGI features
590  *      - no longer uses csp->init_proxy_args
591  *
592  *    - cgi_default:
593  *      - moved menu generation to make_menu()
594  *
595  *    - add_stats now writes single export map entries instead
596  *      of a fixed string
597  *
598  *    - Moved redirect_url() to filters.c
599  *
600  *    - Fixed mem leak in free_http_response(), map_block_killer(),
601  *
602  *    - Removed logentry from cancelled commit
603  *
604  *    Revision 1.7  2001/06/09 10:51:58  jongfoster
605  *    Changing "show URL info" handler to new style.
606  *    Changing BUFSIZ ==> BUFFER_SIZE
607  *
608  *    Revision 1.6  2001/06/07 23:05:19  jongfoster
609  *    Removing code related to old forward and ACL files.
610  *
611  *    Revision 1.5  2001/06/05 19:59:16  jongfoster
612  *    Fixing multiline character string (a GCC-only "feature"), and snprintf (it's _snprintf under VC++).
613  *
614  *    Revision 1.4  2001/06/04 10:41:52  swa
615  *    show version string of cgi.h and cgi.c
616  *
617  *    Revision 1.3  2001/06/03 19:12:16  oes
618  *    introduced new cgi handling
619  *
620  *    No revisions before 1.3
621  *
622  **********************************************************************/
623 \f
624
625 #include "config.h"
626
627 #include <stdio.h>
628 #include <sys/types.h>
629 #include <stdlib.h>
630 #include <ctype.h>
631 #include <string.h>
632 #include <limits.h>
633 #include <assert.h>
634
635 #include "project.h"
636 #include "cgi.h"
637 #include "list.h"
638 #include "encode.h"
639 #include "ssplit.h"
640 #include "errlog.h"
641 #include "filters.h"
642 #include "miscutil.h"
643 #include "cgisimple.h"
644 #include "jbsockets.h"
645 #ifdef FEATURE_CGI_EDIT_ACTIONS
646 #include "cgiedit.h"
647 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
648 #include "loadcfg.h"
649 /* loadcfg.h is for global_toggle_state only */
650 #ifdef FEATURE_PTHREAD
651 #include "jcc.h"
652 /* jcc.h is for mutex semaphore globals only */
653 #endif /* def FEATURE_PTHREAD */
654 const char cgi_h_rcs[] = CGI_H_VERSION;
655
656 /*
657  * List of CGI functions: name, handler, description
658  * Note: Do NOT use single quotes in the description;
659  *       this will break the dynamic "blocked" template!
660  */
661 static const struct cgi_dispatcher cgi_dispatchers[] = {
662    { "",
663          cgi_default,
664          "Privoxy main page",
665          TRUE },
666 #ifdef FEATURE_GRACEFUL_TERMINATION
667    { "die", 
668          cgi_die,  
669          "<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
670         "this is a one click Denial Of Service attack!!!</em>",
671          FALSE }, 
672 #endif
673    { "show-status", 
674          cgi_show_status,  
675 #ifdef FEATURE_CGI_EDIT_ACTIONS
676         "View &amp; change the current configuration",
677 #else
678         "View the current configuration",
679 #endif
680          TRUE }, 
681    { "show-version", 
682          cgi_show_version,  
683          "View the source code version numbers",
684           TRUE }, 
685    { "show-request", 
686          cgi_show_request,  
687          "View the request headers.",
688          TRUE }, 
689    { "show-url-info",
690          cgi_show_url_info, 
691          "Look up which actions apply to a URL and why",
692          TRUE },
693 #ifdef FEATURE_CGI_EDIT_ACTIONS
694 #ifdef FEATURE_TOGGLE
695    { "toggle",
696          cgi_toggle, 
697          "Toggle Privoxy on or off",
698          FALSE },
699 #endif /* def FEATURE_TOGGLE */
700    { "edit-actions", /* Edit the actions list */
701          cgi_edit_actions, 
702          NULL, FALSE },
703    { "eaa", /* Shortcut for edit-actions-add-url-form */
704          cgi_edit_actions_add_url_form, 
705          NULL, FALSE },
706    { "eau", /* Shortcut for edit-actions-url-form */
707          cgi_edit_actions_url_form, 
708          NULL, FALSE },
709    { "ear", /* Shortcut for edit-actions-remove-url-form */
710          cgi_edit_actions_remove_url_form, 
711          NULL, FALSE },
712    { "eal", /* Shortcut for edit-actions-list */
713          cgi_edit_actions_list, 
714          NULL, FALSE },
715    { "eafu", /* Shortcut for edit-actions-for-url */
716          cgi_edit_actions_for_url, 
717          NULL, FALSE },
718    { "eas", /* Shortcut for edit-actions-submit */
719          cgi_edit_actions_submit, 
720          NULL, FALSE },
721    { "easa", /* Shortcut for edit-actions-section-add */
722          cgi_edit_actions_section_add, 
723          NULL, FALSE  },
724    { "easr", /* Shortcut for edit-actions-section-remove */
725          cgi_edit_actions_section_remove, 
726          NULL, FALSE  },
727    { "eass", /* Shortcut for edit-actions-section-swap */
728          cgi_edit_actions_section_swap, 
729          NULL, FALSE  },
730    { "edit-actions-for-url",
731          cgi_edit_actions_for_url, 
732          NULL, FALSE  /* Edit the actions for (a) specified URL(s) */ },
733    { "edit-actions-list",
734          cgi_edit_actions_list, 
735          NULL, TRUE /* Edit the actions list */ },
736    { "edit-actions-submit",
737          cgi_edit_actions_submit, 
738          NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
739    { "edit-actions-url",
740          cgi_edit_actions_url, 
741          NULL, FALSE /* Change a URL pattern in the actionsfile */ },
742    { "edit-actions-url-form",
743          cgi_edit_actions_url_form, 
744          NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
745    { "edit-actions-add-url",
746          cgi_edit_actions_add_url, 
747          NULL, FALSE /* Add a URL pattern to the actionsfile */ },
748    { "edit-actions-add-url-form",
749          cgi_edit_actions_add_url_form, 
750          NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
751    { "edit-actions-remove-url",
752          cgi_edit_actions_remove_url, 
753          NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
754    { "edit-actions-remove-url-form",
755          cgi_edit_actions_remove_url_form, 
756          NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
757    { "edit-actions-section-add",
758          cgi_edit_actions_section_add, 
759          NULL, FALSE /* Remove a section from the actionsfile */ },
760    { "edit-actions-section-remove",
761          cgi_edit_actions_section_remove, 
762          NULL, FALSE /* Remove a section from the actionsfile */ },
763    { "edit-actions-section-swap",
764          cgi_edit_actions_section_swap, 
765          NULL, FALSE /* Swap two sections in the actionsfile */ },
766 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
767    { "error-favicon.ico", 
768          cgi_send_error_favicon,  
769          NULL, TRUE /* Sends the favicon image for error pages. */ },
770    { "favicon.ico", 
771          cgi_send_default_favicon,  
772          NULL, TRUE /* Sends the default favicon image. */ },
773    { "robots.txt", 
774          cgi_robots_txt,  
775          NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ }, 
776    { "send-banner",
777          cgi_send_banner, 
778          NULL, TRUE /* Send a built-in image */ },
779    { "send-stylesheet",
780          cgi_send_stylesheet, 
781          NULL, FALSE /* Send templates/cgi-style.css */ },
782    { "t",
783          cgi_transparent_image, 
784          NULL, TRUE /* Send a transparent image (short name) */ },
785    { "url-info-osd.xml",
786          cgi_send_url_info_osd, 
787          NULL, TRUE /* Send templates/url-info-osd.xml */ },
788    { "user-manual",
789           cgi_send_user_manual,
790           NULL, TRUE /* Send user-manual */ },
791    { NULL, /* NULL Indicates end of list and default page */
792          cgi_error_404,
793          NULL, TRUE /* Unknown CGI page */ }
794 };
795
796
797 /*
798  * Built-in images for ad replacement
799  *
800  * Hint: You can encode your own images like this:
801  * cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
802  */
803
804 #ifdef FEATURE_NO_GIFS
805
806 /*
807  * Checkerboard pattern, as a PNG.
808  */
809 const char image_pattern_data[] =
810    "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
811    "\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
812    "\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
813    "\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
814    "\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
815    "\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
816    "\000\000\000\000\111\105\116\104\256\102\140\202";
817
818 /*
819  * 1x1 transparant PNG.
820  */
821 const char image_blank_data[] =
822  "\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
823  "\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
824  "\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
825  "\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
826  "\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
827  "\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
828  "\000\000\000\000\111\105\116\104\256\102\140\202";
829 #else
830
831 /*
832  * Checkerboard pattern, as a GIF.
833  */
834 const char image_pattern_data[] =
835    "\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
836    "\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
837    "\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
838    "\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
839    "\270\005\000\073";
840
841 /*
842  * 1x1 transparant GIF.
843  */
844 const char image_blank_data[] =
845    "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
846    "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
847    "\000\001\000\000\002\002D\001\000;";
848 #endif
849
850 const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
851 const size_t image_blank_length   = sizeof(image_blank_data) - 1;
852
853
854 static struct http_response cgi_error_memory_response[1];
855
856 static struct http_response *dispatch_known_cgi(struct client_state * csp,
857                                                 const char * path);
858 static struct map *parse_cgi_parameters(char *argstring);
859
860
861 /*********************************************************************
862  * 
863  * Function    :  dispatch_cgi
864  *
865  * Description :  Checks if a request URL has either the magical
866  *                hostname CGI_SITE_1_HOST (usually http://p.p/) or
867  *                matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
868  *                http://config.privoxy.org/). If so, it passes
869  *                the (rest of the) path onto dispatch_known_cgi, which
870  *                calls the relevant CGI handler function.
871  *
872  * Parameters  :
873  *          1  :  csp = Current client state (buffers, headers, etc...)
874  *
875  * Returns     :  http_response if match, NULL if nonmatch or handler fail
876  *
877  *********************************************************************/
878 struct http_response *dispatch_cgi(struct client_state *csp)
879 {
880    const char *host = csp->http->host;
881    const char *path = csp->http->path;
882
883    /*
884     * Should we intercept ?
885     */
886
887    /* Note: "example.com" and "example.com." are equivalent hostnames. */
888
889    /* Either the host matches CGI_SITE_1_HOST ..*/
890    if (   ( (0 == strcmpic(host, CGI_SITE_1_HOST))
891          || (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
892        && (path[0] == '/') )
893    {
894       /* ..then the path will all be for us.  Remove leading '/' */
895       path++;
896    }
897    /* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
898    else if ( ( (0 == strcmpic(host, CGI_SITE_2_HOST ))
899             || (0 == strcmpic(host, CGI_SITE_2_HOST ".")) )
900           && (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))) )
901    {
902       /* take everything following CGI_SITE_2_PATH */
903       path += strlen(CGI_SITE_2_PATH);
904       if (*path == '/')
905       {
906          /* skip the forward slash after CGI_SITE_2_PATH */
907          path++;
908       }
909       else if (*path != '\0')
910       {
911          /*
912           * weirdness: URL is /configXXX, where XXX is some string
913           * Do *NOT* intercept.
914           */
915          return NULL;
916       }
917    }
918    else
919    {
920       /* Not a CGI */
921       return NULL;
922    }
923
924    /* 
925     * This is a CGI call.
926     */
927
928    return dispatch_known_cgi(csp, path);
929 }
930
931
932 /*********************************************************************
933  *
934  * Function    :  grep_cgi_referrer
935  *
936  * Description :  Ugly provisorical fix that greps the value of the
937  *                referer HTTP header field out of a linked list of
938  *                strings like found at csp->headers. Will disappear
939  *                in Privoxy 3.1.
940  *
941  *                FIXME: csp->headers ought to be csp->http->headers
942  *                FIXME: Parsing all client header lines should
943  *                       happen right after the request is received!
944  *
945  * Parameters  :
946  *          1  :  csp = Current client state (buffers, headers, etc...)
947  *
948  * Returns     :  pointer to value (no copy!), or NULL if none found.
949  *
950  *********************************************************************/
951 static char *grep_cgi_referrer(const struct client_state *csp)
952 {
953    struct list_entry *p;
954
955    for (p = csp->headers->first; p != NULL; p = p->next)
956    {
957       if (p->str == NULL) continue;
958       if (strncmpic(p->str, "Referer: ", 9) == 0)
959       {
960          return ((p->str) + 9);
961       }
962    }
963    return NULL;
964
965 }
966
967
968 /*********************************************************************
969  * 
970  * Function    :  referrer_is_safe
971  *
972  * Description :  Decides whether we trust the Referer for
973  *                CGI pages which are only meant to be reachable
974  *                through Privoxy's web interface directly.
975  *
976  * Parameters  :
977  *          1  :  csp = Current client state (buffers, headers, etc...)
978  *
979  * Returns     :  TRUE  if the referrer is safe, or
980  *                FALSE if the referrer is unsafe or not set.
981  *
982  *********************************************************************/
983 static int referrer_is_safe(const struct client_state *csp)
984 {
985    char *referrer;
986    static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
987
988    referrer = grep_cgi_referrer(csp);
989
990    if (NULL == referrer)
991    {
992       /* No referrer, no access  */
993       log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
994          csp->http->url);
995    }
996    else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
997          || (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
998    {
999       /* Trustworthy referrer */
1000       log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
1001          csp->http->url, referrer);
1002
1003       return TRUE;
1004    }
1005    else
1006    {
1007       /* Untrustworthy referrer */
1008       log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
1009          csp->http->url, referrer);
1010    }
1011
1012    return FALSE;
1013
1014 }
1015
1016 /*********************************************************************
1017  * 
1018  * Function    :  dispatch_known_cgi
1019  *
1020  * Description :  Processes a CGI once dispatch_cgi has determined that
1021  *                it matches one of the magic prefixes. Parses the path
1022  *                as a cgi name plus query string, prepares a map that
1023  *                maps CGI parameter names to their values, initializes
1024  *                the http_response struct, and calls the relevant CGI
1025  *                handler function.
1026  *
1027  * Parameters  :
1028  *          1  :  csp = Current client state (buffers, headers, etc...)
1029  *          2  :  path = Path of CGI, with the CGI prefix removed.
1030  *                       Should not have a leading "/".
1031  *
1032  * Returns     :  http_response, or NULL on handler failure or out of
1033  *                memory.
1034  *
1035  *********************************************************************/
1036 static struct http_response *dispatch_known_cgi(struct client_state * csp,
1037                                                 const char * path)
1038 {
1039    const struct cgi_dispatcher *d;
1040    struct map *param_list;
1041    struct http_response *rsp;
1042    char *query_args_start;
1043    char *path_copy;
1044    jb_err err;
1045
1046    if (NULL == (path_copy = strdup(path)))
1047    {
1048       return cgi_error_memory();
1049    }
1050    query_args_start = path_copy;
1051    while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
1052    {
1053       query_args_start++;
1054    }
1055    if (*query_args_start == '/') 
1056    {
1057       *query_args_start++ = '\0';
1058       if ((param_list = new_map()))
1059       {
1060          map(param_list, "file", 1, url_decode(query_args_start), 0);
1061       }
1062    }
1063    else
1064    {
1065       if (*query_args_start == '?')
1066       {
1067          *query_args_start++ = '\0';
1068       }
1069       if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
1070       {
1071          free(path_copy);
1072          return cgi_error_memory();
1073       }
1074    }
1075
1076    /*
1077     * At this point:
1078     * path_copy        = CGI call name
1079     * param_list       = CGI params, as map
1080     */
1081
1082    /* Get mem for response or fail*/
1083    if (NULL == (rsp = alloc_http_response()))
1084    {
1085       free(path_copy);
1086       free_map(param_list);
1087       return cgi_error_memory();
1088    }
1089
1090    /* 
1091     * Find and start the right CGI function
1092     */
1093    d = cgi_dispatchers;
1094    for (;;)
1095    {
1096       if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
1097       {
1098          /*
1099           * If the called CGI is either harmless, or referred
1100           * from a trusted source, start it.
1101           */
1102          if (d->harmless || referrer_is_safe(csp))
1103          {
1104             err = (d->handler)(csp, rsp, param_list);
1105          }
1106          else
1107          {
1108             /*
1109              * Else, modify toggle calls so that they only display
1110              * the status, and deny all other calls.
1111              */
1112             if (0 == strcmp(path_copy, "toggle"))
1113             {
1114                unmap(param_list, "set");
1115                err = (d->handler)(csp, rsp, param_list);
1116             }
1117             else
1118             {
1119                err = cgi_error_disabled(csp, rsp);
1120             }
1121          }
1122
1123          free(path_copy);
1124          free_map(param_list);
1125
1126          if (err == JB_ERR_CGI_PARAMS)
1127          {
1128             err = cgi_error_bad_param(csp, rsp);
1129          }
1130          if (err && (err != JB_ERR_MEMORY))
1131          {
1132             /* Unexpected error! Shouldn't get here */
1133             log_error(LOG_LEVEL_ERROR, "Unexpected CGI error %d in top-level handler.  Please file a bug report!", err);
1134             err = cgi_error_unknown(csp, rsp, err);
1135          }
1136          if (!err)
1137          {
1138             /* It worked */
1139             rsp->reason = RSP_REASON_CGI_CALL;
1140             return finish_http_response(csp, rsp);
1141          }
1142          else
1143          {
1144             /* Error in handler, probably out-of-memory */
1145             free_http_response(rsp);
1146             return cgi_error_memory();
1147          }
1148       }
1149       d++;
1150    }
1151 }
1152    
1153         
1154 /*********************************************************************
1155  *
1156  * Function    :  parse_cgi_parameters
1157  *
1158  * Description :  Parse a URL-encoded argument string into name/value
1159  *                pairs and store them in a struct map list.
1160  *
1161  * Parameters  :
1162  *          1  :  argstring = string to be parsed.  Will be trashed.
1163  *
1164  * Returns     :  pointer to param list, or NULL if out of memory.
1165  *
1166  *********************************************************************/
1167 static struct map *parse_cgi_parameters(char *argstring)
1168 {
1169    char *p;
1170    char *vector[BUFFER_SIZE];
1171    int pairs, i;
1172    struct map *cgi_params;
1173
1174    if (NULL == (cgi_params = new_map()))
1175    {
1176       return NULL;
1177    }
1178
1179    /* 
1180     * IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
1181     * the fragment identifier along with the request, so we must
1182     * cut it off here, so it won't pollute the CGI params:
1183     */
1184    if (NULL != (p = strchr(argstring, '#')))
1185    {
1186       *p = '\0';
1187    }
1188
1189    pairs = ssplit(argstring, "&", vector, SZ(vector), 1, 1);
1190
1191    for (i = 0; i < pairs; i++)
1192    {
1193       if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
1194       {
1195          *p = '\0';
1196          if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
1197          {
1198             free_map(cgi_params);
1199             return NULL;
1200          }
1201       }
1202    }
1203
1204    return cgi_params;
1205
1206 }
1207
1208
1209 /*********************************************************************
1210  *
1211  * Function    :  get_char_param
1212  *
1213  * Description :  Get a single-character parameter passed to a CGI
1214  *                function.
1215  *
1216  * Parameters  :
1217  *          1  :  parameters = map of cgi parameters
1218  *          2  :  param_name = The name of the parameter to read
1219  *
1220  * Returns     :  Uppercase character on success, '\0' on error.
1221  *
1222  *********************************************************************/
1223 char get_char_param(const struct map *parameters,
1224                     const char *param_name)
1225 {
1226    char ch;
1227
1228    assert(parameters);
1229    assert(param_name);
1230
1231    ch = *(lookup(parameters, param_name));
1232    if ((ch >= 'a') && (ch <= 'z'))
1233    {
1234       ch = (char)(ch - 'a' + 'A');
1235    }
1236
1237    return ch;
1238 }
1239
1240
1241 /*********************************************************************
1242  *
1243  * Function    :  get_string_param
1244  *
1245  * Description :  Get a string paramater, to be used as an
1246  *                ACTION_STRING or ACTION_MULTI paramater.
1247  *                Validates the input to prevent stupid/malicious
1248  *                users from corrupting their action file.
1249  *
1250  * Parameters  :
1251  *          1  :  parameters = map of cgi parameters
1252  *          2  :  param_name = The name of the parameter to read
1253  *          3  :  pparam = destination for paramater.  Allocated as
1254  *                part of the map "parameters", so don't free it.
1255  *                Set to NULL if not specified.
1256  *
1257  * Returns     :  JB_ERR_OK         on success, or if the paramater
1258  *                                  was not specified.
1259  *                JB_ERR_MEMORY     on out-of-memory.
1260  *                JB_ERR_CGI_PARAMS if the paramater is not valid.
1261  *
1262  *********************************************************************/
1263 jb_err get_string_param(const struct map *parameters,
1264                         const char *param_name,
1265                         const char **pparam)
1266 {
1267    const char *param;
1268    const char *s;
1269    char ch;
1270
1271    assert(parameters);
1272    assert(param_name);
1273    assert(pparam);
1274
1275    *pparam = NULL;
1276
1277    param = lookup(parameters, param_name);
1278    if (!*param)
1279    {
1280       return JB_ERR_OK;
1281    }
1282
1283    if (strlen(param) >= CGI_PARAM_LEN_MAX)
1284    {
1285       /*
1286        * Too long.
1287        *
1288        * Note that the length limit is arbitrary, it just seems
1289        * sensible to limit it to *something*.  There's no
1290        * technical reason for any limit at all.
1291        */
1292       return JB_ERR_CGI_PARAMS;
1293    }
1294
1295    /* Check every character to see if it's legal */
1296    s = param;
1297    while ((ch = *s++) != '\0')
1298    {
1299       if ( ((unsigned char)ch < (unsigned char)' ')
1300         || (ch == '}') )
1301       {
1302          /* Probable hack attempt, or user accidentally used '}'. */
1303          return JB_ERR_CGI_PARAMS;
1304       }
1305    }
1306
1307    /* Success */
1308    *pparam = param;
1309
1310    return JB_ERR_OK;
1311 }
1312
1313
1314 /*********************************************************************
1315  *
1316  * Function    :  get_number_param
1317  *
1318  * Description :  Get a non-negative integer from the parameters
1319  *                passed to a CGI function.
1320  *
1321  * Parameters  :
1322  *          1  :  csp = Current client state (buffers, headers, etc...)
1323  *          2  :  parameters = map of cgi parameters
1324  *          3  :  name = Name of CGI parameter to read
1325  *          4  :  pvalue = destination for value.
1326  *                         Set to -1 on error.
1327  *
1328  * Returns     :  JB_ERR_OK         on success
1329  *                JB_ERR_MEMORY     on out-of-memory
1330  *                JB_ERR_CGI_PARAMS if the parameter was not specified
1331  *                                  or is not valid.
1332  *
1333  *********************************************************************/
1334 jb_err get_number_param(struct client_state *csp,
1335                         const struct map *parameters,
1336                         char *name,
1337                         unsigned *pvalue)
1338 {
1339    const char *param;
1340    char ch;
1341    unsigned value;
1342
1343    assert(csp);
1344    assert(parameters);
1345    assert(name);
1346    assert(pvalue);
1347
1348    *pvalue = 0; 
1349
1350    param = lookup(parameters, name);
1351    if (!*param)
1352    {
1353       return JB_ERR_CGI_PARAMS;
1354    }
1355
1356    /* We don't use atoi because I want to check this carefully... */
1357
1358    value = 0;
1359    while ((ch = *param++) != '\0')
1360    {
1361       if ((ch < '0') || (ch > '9'))
1362       {
1363          return JB_ERR_CGI_PARAMS;
1364       }
1365
1366       ch = (char)(ch - '0');
1367
1368       /* Note:
1369        *
1370        * <limits.h> defines UINT_MAX
1371        *
1372        * (UINT_MAX - ch) / 10 is the largest number that
1373        *     can be safely multiplied by 10 then have ch added.
1374        */
1375       if (value > ((UINT_MAX - (unsigned)ch) / 10U))
1376       {
1377          return JB_ERR_CGI_PARAMS;
1378       }
1379
1380       value = value * 10 + (unsigned)ch;
1381    }
1382
1383    /* Success */
1384    *pvalue = value;
1385
1386    return JB_ERR_OK;
1387
1388 }
1389
1390
1391 /*********************************************************************
1392  *
1393  * Function    :  error_response
1394  *
1395  * Description :  returns an http_response that explains the reason
1396  *                why a request failed.
1397  *
1398  * Parameters  :
1399  *          1  :  csp = Current client state (buffers, headers, etc...)
1400  *          2  :  templatename = Which template should be used for the answer
1401  *          3  :  sys_err = system error number
1402  *
1403  * Returns     :  A http_response.  If we run out of memory, this
1404  *                will be cgi_error_memory().
1405  *
1406  *********************************************************************/
1407 struct http_response *error_response(struct client_state *csp,
1408                                      const char *templatename,
1409                                      int sys_err)
1410 {
1411    jb_err err;
1412    struct http_response *rsp;
1413    struct map *exports = default_exports(csp, NULL);
1414    char *path = NULL;
1415
1416    if (exports == NULL)
1417    {
1418       return cgi_error_memory();
1419    }
1420
1421    if (NULL == (rsp = alloc_http_response()))
1422    {
1423       free_map(exports);
1424       return cgi_error_memory();
1425    }
1426
1427 #ifdef FEATURE_FORCE_LOAD
1428    if (csp->flags & CSP_FLAG_FORCED)
1429    {
1430       path = strdup(FORCE_PREFIX);
1431    }
1432    else
1433 #endif /* def FEATURE_FORCE_LOAD */
1434    {
1435       path = strdup("");
1436    }
1437    err = string_append(&path, csp->http->path);
1438
1439    if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
1440    if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
1441    if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
1442    if (!err) err = map(exports, "error", 1, html_encode_and_free_original(safe_strerror(sys_err)), 0);
1443    if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1); 
1444    if (!err)
1445    {
1446      err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
1447      if (err)
1448      {
1449        /* Some failures, like "404 no such domain", don't have an IP address. */
1450        err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
1451      }
1452    }
1453
1454
1455    if (err)
1456    {
1457       free_map(exports);
1458       free_http_response(rsp);
1459       return cgi_error_memory();
1460    }
1461
1462    if (!strcmp(templatename, "no-such-domain"))
1463    {
1464       rsp->status = strdup("404 No such domain");
1465       if (rsp->status == NULL)
1466       {
1467          free_map(exports);
1468          free_http_response(rsp);
1469          return cgi_error_memory();
1470       }
1471       rsp->reason = RSP_REASON_NO_SUCH_DOMAIN;
1472    }
1473    else if (!strcmp(templatename, "forwarding-failed"))
1474    {
1475       const struct forward_spec *fwd = forward_url(csp, csp->http);
1476       char *socks_type = NULL;
1477       if (fwd == NULL)
1478       {
1479          log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
1480          /* Never get here - LOG_LEVEL_FATAL causes program exit */
1481       }
1482
1483       /*
1484        * XXX: While the template is called forwarding-failed,
1485        * it currently only handles socks forwarding failures.
1486        */
1487       assert(fwd->type != SOCKS_NONE);
1488
1489       /*
1490        * Map failure reason, forwarding type and forwarder.
1491        */
1492       if (NULL == csp->error_message)
1493       {
1494          /*
1495           * Either we forgot to record the failure reason,
1496           * or the memory allocation failed.
1497           */
1498          log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
1499          csp->error_message = strdup("Failure reason missing. Check the log file for details.");
1500       }
1501       if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
1502
1503       /*
1504        * XXX: this is almost the same code as in cgi_show_url_info()
1505        * and thus should be factored out and shared.
1506        */
1507       switch (fwd->type)
1508       {
1509          case SOCKS_4:
1510             socks_type = "socks4-";
1511             break;
1512          case SOCKS_4A:
1513             socks_type = "socks4a-";
1514             break;
1515          case SOCKS_5:
1516             socks_type = "socks5-";
1517             break;
1518          default:
1519             log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1520       }
1521
1522       if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
1523       if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
1524
1525       if (!err) rsp->status = strdup("503 Forwarding failure");
1526       if ((rsp->status == NULL) || (NULL == csp->error_message) || err)
1527       {
1528          free_map(exports);
1529          free_http_response(rsp);
1530          return cgi_error_memory();
1531       }
1532       rsp->reason = RSP_REASON_FORWARDING_FAILED;
1533    }
1534    else if (!strcmp(templatename, "connect-failed"))
1535    {
1536       rsp->status = strdup("503 Connect failed");
1537       if (rsp->status == NULL)
1538       {
1539          free_map(exports);
1540          free_http_response(rsp);
1541          return cgi_error_memory();
1542       }
1543       rsp->reason = RSP_REASON_CONNECT_FAILED;
1544    }
1545
1546    err = template_fill_for_cgi(csp, templatename, exports, rsp);
1547    if (err)
1548    {
1549       free_http_response(rsp);
1550       return cgi_error_memory();
1551    }
1552
1553    return finish_http_response(csp, rsp);
1554 }
1555
1556
1557 /*********************************************************************
1558  *
1559  * Function    :  cgi_error_disabled
1560  *
1561  * Description :  CGI function that is called to generate an error
1562  *                response if the actions editor or toggle CGI are
1563  *                accessed despite having being disabled at compile-
1564  *                or run-time, or if the user followed an untrusted link
1565  *                to access a unsafe CGI feature that is only reachable
1566  *                through Privoxy directly.
1567  *
1568  * Parameters  :
1569  *          1  :  csp = Current client state (buffers, headers, etc...)
1570  *          2  :  rsp = http_response data structure for output
1571  *
1572  * CGI Parameters : none
1573  *
1574  * Returns     :  JB_ERR_OK on success
1575  *                JB_ERR_MEMORY on out-of-memory error.
1576  *
1577  *********************************************************************/
1578 jb_err cgi_error_disabled(const struct client_state *csp,
1579                           struct http_response *rsp)
1580 {
1581    struct map *exports;
1582
1583    assert(csp);
1584    assert(rsp);
1585
1586    if (NULL == (exports = default_exports(csp, "cgi-error-disabled")))
1587    {
1588       return JB_ERR_MEMORY;
1589    }
1590    if (map(exports, "url", 1, html_encode(csp->http->url), 0))
1591    {
1592       /* Not important enough to do anything */
1593       log_error(LOG_LEVEL_ERROR, "Failed to fill in url.");
1594    }
1595
1596    return template_fill_for_cgi(csp, "cgi-error-disabled", exports, rsp);
1597 }
1598
1599
1600 /*********************************************************************
1601  *
1602  * Function    :  cgi_init_error_messages
1603  *
1604  * Description :  Call at the start of the program to initialize
1605  *                the error message used by cgi_error_memory().
1606  *
1607  * Parameters  :  N/A
1608  *
1609  * Returns     :  N/A
1610  *
1611  *********************************************************************/
1612 void cgi_init_error_messages(void)
1613 {
1614    memset(cgi_error_memory_response, '\0', sizeof(*cgi_error_memory_response));
1615    cgi_error_memory_response->head =
1616       "HTTP/1.0 500 Internal Privoxy Error\r\n"
1617       "Content-Type: text/html\r\n"
1618       "\r\n";
1619    cgi_error_memory_response->body =
1620       "<html>\r\n"
1621       "<head>\r\n"
1622       " <title>500 Internal Privoxy Error</title>\r\n"
1623       " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1624       "</head>\r\n"
1625       "<body>\r\n"
1626       "<h1>500 Internal Privoxy Error</h1>\r\n"
1627       "<p>Privoxy <b>ran out of memory</b> while processing your request.</p>\r\n"
1628       "<p>Please contact your proxy administrator, or try again later</p>\r\n"
1629       "</body>\r\n"
1630       "</html>\r\n";
1631
1632    cgi_error_memory_response->head_length =
1633       strlen(cgi_error_memory_response->head);
1634    cgi_error_memory_response->content_length =
1635       strlen(cgi_error_memory_response->body);
1636    cgi_error_memory_response->reason = RSP_REASON_OUT_OF_MEMORY;
1637 }
1638
1639
1640 /*********************************************************************
1641  *
1642  * Function    :  cgi_error_memory
1643  *
1644  * Description :  Called if a CGI function runs out of memory.
1645  *                Returns a statically-allocated error response.
1646  *
1647  * Parameters  :  N/A
1648  *
1649  * Returns     :  http_response data structure for output.  This is
1650  *                statically allocated, for obvious reasons.
1651  *
1652  *********************************************************************/
1653 struct http_response *cgi_error_memory(void)
1654 {
1655    /* assert that it's been initialized. */
1656    assert(cgi_error_memory_response->head);
1657
1658    return cgi_error_memory_response;
1659 }
1660
1661
1662 /*********************************************************************
1663  *
1664  * Function    :  cgi_error_no_template
1665  *
1666  * Description :  Almost-CGI function that is called if a template
1667  *                cannot be loaded.  Note this is not a true CGI,
1668  *                it takes a template name rather than a map of 
1669  *                parameters.
1670  *
1671  * Parameters  :
1672  *          1  :  csp = Current client state (buffers, headers, etc...)
1673  *          2  :  rsp = http_response data structure for output
1674  *          3  :  template_name = Name of template that could not
1675  *                                be loaded.
1676  *
1677  * Returns     :  JB_ERR_OK on success
1678  *                JB_ERR_MEMORY on out-of-memory error.  
1679  *
1680  *********************************************************************/
1681 jb_err cgi_error_no_template(const struct client_state *csp,
1682                              struct http_response *rsp,
1683                              const char *template_name)
1684 {
1685    static const char status[] =
1686       "500 Internal Privoxy Error";
1687    static const char body_prefix[] =
1688       "<html>\r\n"
1689       "<head>\r\n"
1690       " <title>500 Internal Privoxy Error</title>\r\n"
1691       " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1692       "</head>\r\n"
1693       "<body>\r\n"
1694       "<h1>500 Internal Privoxy Error</h1>\r\n"
1695       "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1696       "<p><b>Could not load template file <code>";
1697    static const char body_suffix[] =
1698       "</code> or one of its included components.</b></p>\r\n"
1699       "<p>Please contact your proxy administrator.</p>\r\n"
1700       "<p>If you are the proxy administrator, please put the required file(s)"
1701       "in the <code><i>(confdir)</i>/templates</code> directory.  The "
1702       "location of the <code><i>(confdir)</i></code> directory "
1703       "is specified in the main Privoxy <code>config</code> "
1704       "file.  (It's typically the Privoxy install directory"
1705 #ifndef _WIN32
1706       ", or <code>/etc/privoxy/</code>"
1707 #endif /* ndef _WIN32 */
1708       ").</p>\r\n"
1709       "</body>\r\n"
1710       "</html>\r\n";
1711    const size_t body_size = strlen(body_prefix) + strlen(template_name) + strlen(body_suffix) + 1;
1712
1713    assert(csp);
1714    assert(rsp);
1715    assert(template_name);
1716
1717    /* Reset rsp, if needed */
1718    freez(rsp->status);
1719    freez(rsp->head);
1720    freez(rsp->body);
1721    rsp->content_length = 0;
1722    rsp->head_length = 0;
1723    rsp->is_static = 0;
1724
1725    rsp->body = malloc(body_size);
1726    if (rsp->body == NULL)
1727    {
1728       return JB_ERR_MEMORY;
1729    }
1730    strlcpy(rsp->body, body_prefix, body_size);
1731    strlcat(rsp->body, template_name, body_size);
1732    strlcat(rsp->body, body_suffix, body_size);
1733
1734    rsp->status = strdup(status);
1735    if (rsp->status == NULL)
1736    {
1737       return JB_ERR_MEMORY;
1738    }
1739
1740    return JB_ERR_OK;
1741 }
1742
1743
1744 /*********************************************************************
1745  *
1746  * Function    :  cgi_error_unknown
1747  *
1748  * Description :  Almost-CGI function that is called if an unexpected
1749  *                error occurs in the top-level CGI dispatcher.
1750  *                In this context, "unexpected" means "anything other
1751  *                than JB_ERR_MEMORY or JB_ERR_CGI_PARAMS" - CGIs are
1752  *                expected to handle all other errors internally,
1753  *                since they can give more relavent error messages
1754  *                that way.
1755  *
1756  *                Note this is not a true CGI, it takes an error
1757  *                code rather than a map of parameters.
1758  *
1759  * Parameters  :
1760  *          1  :  csp = Current client state (buffers, headers, etc...)
1761  *          2  :  rsp = http_response data structure for output
1762  *          3  :  error_to_report = Error code to report.
1763  *
1764  * Returns     :  JB_ERR_OK on success
1765  *                JB_ERR_MEMORY on out-of-memory error.  
1766  *
1767  *********************************************************************/
1768 jb_err cgi_error_unknown(const struct client_state *csp,
1769                          struct http_response *rsp,
1770                          jb_err error_to_report)
1771 {
1772    static const char status[] =
1773       "500 Internal Privoxy Error";
1774    static const char body_prefix[] =
1775       "<html>\r\n"
1776       "<head>\r\n"
1777       " <title>500 Internal Privoxy Error</title>\r\n"
1778       " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">"
1779       "</head>\r\n"
1780       "<body>\r\n"
1781       "<h1>500 Internal Privoxy Error</h1>\r\n"
1782       "<p>Privoxy encountered an error while processing your request:</p>\r\n"
1783       "<p><b>Unexpected internal error: ";
1784    static const char body_suffix[] =
1785       "</b></p>\r\n"
1786       "<p>Please "
1787       "<a href=\"http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118\">"
1788       "file a bug report</a>.</p>\r\n"
1789       "</body>\r\n"
1790       "</html>\r\n";
1791    char errnumbuf[30];
1792    /*
1793     * Due to sizeof(errnumbuf), body_size will be slightly
1794     * bigger than necessary but it doesn't really matter.
1795     */
1796    const size_t body_size = strlen(body_prefix) + sizeof(errnumbuf) + strlen(body_suffix) + 1;
1797    assert(csp);
1798    assert(rsp);
1799
1800    /* Reset rsp, if needed */
1801    freez(rsp->status);
1802    freez(rsp->head);
1803    freez(rsp->body);
1804    rsp->content_length = 0;
1805    rsp->head_length = 0;
1806    rsp->is_static = 0;
1807    rsp->reason = RSP_REASON_INTERNAL_ERROR;
1808
1809    snprintf(errnumbuf, sizeof(errnumbuf), "%d", error_to_report);
1810
1811    rsp->body = malloc(body_size);
1812    if (rsp->body == NULL)
1813    {
1814       return JB_ERR_MEMORY;
1815    }
1816    strlcpy(rsp->body, body_prefix, body_size);
1817    strlcat(rsp->body, errnumbuf,   body_size);
1818    strlcat(rsp->body, body_suffix, body_size);
1819
1820    rsp->status = strdup(status);
1821    if (rsp->status == NULL)
1822    {
1823       return JB_ERR_MEMORY;
1824    }
1825
1826    return JB_ERR_OK;
1827 }
1828
1829
1830 /*********************************************************************
1831  *
1832  * Function    :  cgi_error_bad_param
1833  *
1834  * Description :  CGI function that is called if the parameters
1835  *                (query string) for a CGI were wrong.
1836  *               
1837  * Parameters  :
1838  *          1  :  csp = Current client state (buffers, headers, etc...)
1839  *          2  :  rsp = http_response data structure for output
1840  *
1841  * CGI Parameters : none
1842  *
1843  * Returns     :  JB_ERR_OK on success
1844  *                JB_ERR_MEMORY on out-of-memory error.  
1845  *
1846  *********************************************************************/
1847 jb_err cgi_error_bad_param(const struct client_state *csp,
1848                            struct http_response *rsp)
1849 {
1850    struct map *exports;
1851
1852    assert(csp);
1853    assert(rsp);
1854
1855    if (NULL == (exports = default_exports(csp, NULL)))
1856    {
1857       return JB_ERR_MEMORY;
1858    }
1859
1860    return template_fill_for_cgi(csp, "cgi-error-bad-param", exports, rsp);
1861 }
1862
1863
1864 /*********************************************************************
1865  *
1866  * Function    :  cgi_redirect 
1867  *
1868  * Description :  CGI support function to generate a HTTP redirect
1869  *                message
1870  *
1871  * Parameters  :
1872  *          1  :  rsp = http_response data structure for output
1873  *          2  :  target = string with the target URL
1874  *
1875  * CGI Parameters : None
1876  *
1877  * Returns     :  JB_ERR_OK on success
1878  *                JB_ERR_MEMORY on out-of-memory error.  
1879  *
1880  *********************************************************************/
1881 jb_err cgi_redirect (struct http_response * rsp, const char *target)
1882 {
1883    jb_err err;
1884
1885    assert(rsp);
1886    assert(target);
1887
1888    err = enlist_unique_header(rsp->headers, "Location", target);
1889
1890    rsp->status = strdup("302 Local Redirect from Privoxy");
1891    if (rsp->status == NULL)
1892    {
1893       return JB_ERR_MEMORY;
1894    }
1895
1896    return err;
1897 }
1898
1899
1900 /*********************************************************************
1901  *
1902  * Function    :  add_help_link
1903  *
1904  * Description :  Produce a copy of the string given as item,
1905  *                embedded in an HTML link to its corresponding
1906  *                section (item name in uppercase) in the actions
1907  *                chapter of the user manual, (whose URL is given in
1908  *                the config and defaults to our web site).
1909  *
1910  *                FIXME: I currently only work for actions, and would
1911  *                       like to be generalized for other topics.
1912  *
1913  * Parameters  :  
1914  *          1  :  item = item (will NOT be free()d.) 
1915  *                       It is assumed to be HTML-safe.
1916  *          2  :  config = The current configuration.
1917  *
1918  * Returns     :  String with item embedded in link, or NULL on
1919  *                out-of-memory
1920  *
1921  *********************************************************************/
1922 char *add_help_link(const char *item,
1923                     struct configuration_spec *config)
1924 {
1925    char *result;
1926
1927    if (!item) return NULL;
1928
1929    result = strdup("<a href=\"");
1930    if (!strncmpic(config->usermanual, "file://", 7) ||
1931        !strncmpic(config->usermanual, "http", 4))
1932    {
1933       string_append(&result, config->usermanual);
1934    }
1935    else
1936    {
1937       string_append(&result, "http://");
1938       string_append(&result, CGI_SITE_2_HOST);
1939       string_append(&result, "/user-manual/");
1940    }
1941    string_append(&result, ACTIONS_HELP_PREFIX);
1942    string_join  (&result, string_toupper(item));
1943    string_append(&result, "\">");
1944    string_append(&result, item);
1945    string_append(&result, "</a> ");
1946
1947    return result;
1948 }
1949
1950
1951 /*********************************************************************
1952  *
1953  * Function    :  get_http_time
1954  *
1955  * Description :  Get the time in a format suitable for use in a
1956  *                HTTP header - e.g.:
1957  *                "Sun, 06 Nov 1994 08:49:37 GMT"
1958  *
1959  * Parameters  :  
1960  *          1  :  time_offset = Time returned will be current time
1961  *                              plus this number of seconds.
1962  *          2  :  buf = Destination for result.
1963  *          3  :  buffer_size = Size of the buffer above. Must be big
1964  *                              enough to hold 29 characters plus a
1965  *                              trailing zero.
1966  *
1967  * Returns     :  N/A
1968  *
1969  *********************************************************************/
1970 void get_http_time(int time_offset, char *buf, size_t buffer_size)
1971 {
1972    static const char day_names[7][4] =
1973       { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
1974    static const char month_names[12][4] =
1975       { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1976         "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
1977
1978    struct tm *t;
1979    time_t current_time;
1980 #if defined(HAVE_GMTIME_R)
1981    struct tm dummy;
1982 #endif
1983
1984    assert(buf);
1985    assert(buffer_size > 29);
1986
1987    time(&current_time);
1988
1989    current_time += time_offset;
1990
1991    /* get and save the gmt */
1992 #if HAVE_GMTIME_R
1993    t = gmtime_r(&current_time, &dummy);
1994 #elif FEATURE_PTHREAD
1995    pthread_mutex_lock(&gmtime_mutex);
1996    t = gmtime(&current_time);
1997    pthread_mutex_unlock(&gmtime_mutex);
1998 #else
1999    t = gmtime(&current_time);
2000 #endif
2001
2002    /* Format: "Sun, 06 Nov 1994 08:49:37 GMT" */
2003    snprintf(buf, buffer_size,
2004       "%s, %02d %s %4d %02d:%02d:%02d GMT",
2005       day_names[t->tm_wday],
2006       t->tm_mday,
2007       month_names[t->tm_mon],
2008       t->tm_year + 1900,
2009       t->tm_hour,
2010       t->tm_min,
2011       t->tm_sec
2012       );
2013
2014 }
2015
2016 /*********************************************************************
2017  *
2018  * Function    :  get_locale_time
2019  *
2020  * Description :  Get the time in a date(1)-like format
2021  *                according to the current locale - e.g.:
2022  *                "Fri Aug 29 19:37:12 CEST 2008"
2023  *
2024  *                XXX: Should we allow the user to change the format?
2025  *
2026  * Parameters  :
2027  *          1  :  buf         = Destination for result.
2028  *          2  :  buffer_size = Size of the buffer above. Must be big
2029  *                              enough to hold 29 characters plus a
2030  *                              trailing zero.
2031  *
2032  * Returns     :  N/A
2033  *
2034  *********************************************************************/
2035 static void get_locale_time(char *buf, size_t buffer_size)
2036 {
2037    struct tm *timeptr;
2038    time_t current_time;
2039 #if defined(HAVE_LOCALTIME_R)
2040    struct tm dummy;
2041 #endif
2042
2043    assert(buf);
2044    assert(buffer_size > 29);
2045
2046    time(&current_time);
2047
2048 #if HAVE_LOCALTIME_R
2049    timeptr = localtime_r(&current_time, &dummy);
2050 #elif FEATURE_PTHREAD
2051    pthread_mutex_lock(&localtime_mutex);
2052    timeptr = localtime(&current_time);
2053    pthread_mutex_unlock(&localtime_mutex);
2054 #else
2055    timeptr = localtime(&current_time);
2056 #endif
2057
2058    strftime(buf, buffer_size, "%a %b %d %X %Z %Y", timeptr);
2059
2060 }
2061
2062 /*********************************************************************
2063  *
2064  * Function    :  finish_http_response
2065  *
2066  * Description :  Fill in the missing headers in an http response,
2067  *                and flatten the headers to an http head.
2068  *                For HEAD requests the body is freed once
2069  *                the Content-Length header is set.
2070  *
2071  * Parameters  :
2072  *          1  :  rsp = pointer to http_response to be processed
2073  *
2074  * Returns     :  A http_response, usually the rsp parameter.
2075  *                On error, free()s rsp and returns cgi_error_memory()
2076  *
2077  *********************************************************************/
2078 struct http_response *finish_http_response(const struct client_state *csp, struct http_response *rsp)
2079 {
2080    char buf[BUFFER_SIZE];
2081    jb_err err;
2082
2083    /* Special case - do NOT change this statically allocated response,
2084     * which is ready for output anyway.
2085     */
2086    if (rsp == cgi_error_memory_response)
2087    {
2088       return rsp;
2089    }
2090
2091    /* 
2092     * Fill in the HTTP Status, using HTTP/1.1
2093     * unless the client asked for HTTP/1.0.
2094     */
2095    snprintf(buf, sizeof(buf), "%s %s",
2096       strcmpic(csp->http->ver, "HTTP/1.0") ? "HTTP/1.1" : "HTTP/1.0",
2097       rsp->status ? rsp->status : "200 OK");
2098    err = enlist_first(rsp->headers, buf);
2099
2100    /* 
2101     * Set the Content-Length
2102     */
2103    if (rsp->content_length == 0)
2104    {
2105       rsp->content_length = rsp->body ? strlen(rsp->body) : 0;
2106    }
2107    if (!err)
2108    {
2109       snprintf(buf, sizeof(buf), "Content-Length: %d", (int)rsp->content_length);
2110       err = enlist(rsp->headers, buf);
2111    }
2112
2113    if (0 == strcmpic(csp->http->gpc, "head"))
2114    {
2115       /*
2116        * The client only asked for the head. Dispose
2117        * the body and log an offensive message.
2118        *
2119        * While it may seem to be a bit inefficient to
2120        * prepare the body if it isn't needed, it's the
2121        * only way to get the Content-Length right for
2122        * dynamic pages. We could have disposed the body
2123        * earlier, but not without duplicating the
2124        * Content-Length setting code above.
2125        */
2126       log_error(LOG_LEVEL_CGI, "Preparing to give head to %s.", csp->ip_addr_str);
2127       freez(rsp->body);
2128       rsp->content_length = 0;
2129    }
2130
2131    if (strncmpic(rsp->status, "302", 3))
2132    {
2133       /*
2134        * If it's not a redirect without any content,
2135        * set the Content-Type to text/html if it's
2136        * not already specified.
2137        */
2138       if (!err) err = enlist_unique(rsp->headers, "Content-Type: text/html", 13);
2139    }
2140
2141    /*
2142     * Fill in the rest of the default headers:
2143     *
2144     * Date: set to current date/time.
2145     * Last-Modified: set to date/time the page was last changed.
2146     * Expires: set to date/time page next needs reloading.
2147     * Cache-Control: set to "no-cache" if applicable.
2148     * 
2149     * See http://www.w3.org/Protocols/rfc2068/rfc2068
2150     */
2151    if (rsp->is_static)
2152    {
2153       /*
2154        * Set Expires to about 10 min into the future so it'll get reloaded
2155        * occasionally, e.g. if Privoxy gets upgraded.
2156        */
2157
2158       if (!err)
2159       {
2160          get_http_time(0, buf, sizeof(buf));
2161          err = enlist_unique_header(rsp->headers, "Date", buf);
2162       }
2163
2164       /* Some date in the past. */
2165       if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Sat, 17 Jun 2000 12:00:00 GMT");
2166
2167       if (!err)
2168       {
2169          get_http_time(10 * 60, buf, sizeof(buf)); /* 10 * 60sec = 10 minutes */
2170          err = enlist_unique_header(rsp->headers, "Expires", buf);
2171       }
2172    }
2173    else if (!strncmpic(rsp->status, "302", 3))
2174    {
2175       get_http_time(0, buf, sizeof(buf));
2176       if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2177    }
2178    else
2179    {
2180       /*
2181        * Setting "Cache-Control" to "no-cache" and  "Expires" to
2182        * the current time doesn't exactly forbid caching, it just
2183        * requires the client to revalidate the cached copy.
2184        *
2185        * If a temporary problem occurs and the user tries again after
2186        * getting Privoxy's error message, a compliant browser may set the
2187        * If-Modified-Since header with the content of the error page's
2188        * Last-Modified header. More often than not, the document on the server
2189        * is older than Privoxy's error message, the server would send status code
2190        * 304 and the browser would display the outdated error message again and again.
2191        *
2192        * For documents delivered with status code 403, 404 and 503 we set "Last-Modified"
2193        * to Tim Berners-Lee's birthday, which predates the age of any page on the web
2194        * and can be safely used to "revalidate" without getting a status code 304.
2195        *
2196        * There is no need to let the useless If-Modified-Since header reach the
2197        * server, it is therefore stripped by client_if_modified_since in parsers.c.
2198        */
2199       if (!err) err = enlist_unique_header(rsp->headers, "Cache-Control", "no-cache");
2200
2201       get_http_time(0, buf, sizeof(buf));
2202       if (!err) err = enlist_unique_header(rsp->headers, "Date", buf);
2203       if (!strncmpic(rsp->status, "403", 3)
2204        || !strncmpic(rsp->status, "404", 3)
2205        || !strncmpic(rsp->status, "503", 3))
2206       {
2207          if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", "Wed, 08 Jun 1955 12:00:00 GMT");
2208       }
2209       else
2210       {
2211          if (!err) err = enlist_unique_header(rsp->headers, "Last-Modified", buf);
2212       }
2213       if (!err) err = enlist_unique_header(rsp->headers, "Expires", "Sat, 17 Jun 2000 12:00:00 GMT");
2214       if (!err) err = enlist_unique_header(rsp->headers, "Pragma", "no-cache");
2215    }
2216
2217    /*
2218     * Quoting RFC 2616:
2219     *
2220     * HTTP/1.1 applications that do not support persistent connections MUST
2221     * include the "close" connection option in every message.
2222     */
2223    if (!err) err = enlist_unique_header(rsp->headers, "Connection", "close");
2224
2225    /* 
2226     * Write the head
2227     */
2228    if (err || (NULL == (rsp->head = list_to_text(rsp->headers))))
2229    {
2230       free_http_response(rsp);
2231       return cgi_error_memory();
2232    }
2233    rsp->head_length = strlen(rsp->head);
2234
2235    return rsp;
2236
2237 }
2238
2239
2240 /*********************************************************************
2241  *
2242  * Function    :  alloc_http_response
2243  *
2244  * Description :  Allocates a new http_response structure.
2245  *
2246  * Parameters  :  N/A
2247  *
2248  * Returns     :  pointer to a new http_response, or NULL.
2249  *
2250  *********************************************************************/
2251 struct http_response *alloc_http_response(void)
2252 {
2253    return (struct http_response *) zalloc(sizeof(struct http_response));
2254
2255 }
2256
2257
2258 /*********************************************************************
2259  *
2260  * Function    :  free_http_response
2261  *
2262  * Description :  Free the memory occupied by an http_response
2263  *                and its depandant structures.
2264  *
2265  * Parameters  :
2266  *          1  :  rsp = pointer to http_response to be freed
2267  *
2268  * Returns     :  N/A
2269  *
2270  *********************************************************************/
2271 void free_http_response(struct http_response *rsp)
2272 {
2273    /*
2274     * Must special case cgi_error_memory_response, which is never freed.
2275     */
2276    if (rsp && (rsp != cgi_error_memory_response))
2277    {
2278       freez(rsp->status);
2279       freez(rsp->head);
2280       freez(rsp->body);
2281       destroy_list(rsp->headers);
2282       free(rsp);
2283    }
2284
2285 }
2286
2287
2288 /*********************************************************************
2289  *
2290  * Function    :  template_load
2291  *
2292  * Description :  CGI support function that loads a given HTML
2293  *                template, ignoring comment lines and following
2294  *                #include statements up to a depth of 1.
2295  *
2296  * Parameters  :
2297  *          1  :  csp = Current client state (buffers, headers, etc...)
2298  *          2  :  template_ptr = Destination for pointer to loaded
2299  *                               template text.
2300  *          3  :  templatename = name of the HTML template to be used
2301  *          4  :  recursive = Flag set if this function calls itself
2302  *                            following an #include statament
2303  *
2304  * Returns     :  JB_ERR_OK on success
2305  *                JB_ERR_MEMORY on out-of-memory error.  
2306  *                JB_ERR_FILE if the template file cannot be read
2307  *
2308  *********************************************************************/
2309 jb_err template_load(const struct client_state *csp, char **template_ptr, 
2310                      const char *templatename, int recursive)
2311 {
2312    jb_err err;
2313    char *templates_dir_path;
2314    char *full_path;
2315    char *file_buffer;
2316    char *included_module;
2317    const char *p;
2318    FILE *fp;
2319    char buf[BUFFER_SIZE];
2320
2321    assert(csp);
2322    assert(template_ptr);
2323    assert(templatename);
2324
2325    *template_ptr = NULL;
2326
2327    /* Validate template name.  Paranoia. */
2328    for (p = templatename; *p != 0; p++)
2329    {
2330       if ( ((*p < 'a') || (*p > 'z'))
2331         && ((*p < 'A') || (*p > 'Z'))
2332         && ((*p < '0') || (*p > '9'))
2333         && (*p != '-')
2334         && (*p != '.'))
2335       {
2336          /* Illegal character */
2337          return JB_ERR_FILE;
2338       }
2339    }
2340
2341    /*
2342     * Generate full path using either templdir
2343     * or confdir/templates as base directory.
2344     */
2345    if (NULL != csp->config->templdir)
2346    {
2347       templates_dir_path = strdup(csp->config->templdir);
2348    }
2349    else
2350    {
2351       templates_dir_path = make_path(csp->config->confdir, "templates");
2352    }
2353
2354    if (templates_dir_path == NULL)
2355    {
2356       log_error(LOG_LEVEL_ERROR, "Out of memory while generating template path for %s.",
2357          templatename);
2358       return JB_ERR_MEMORY;
2359    }
2360
2361    full_path = make_path(templates_dir_path, templatename);
2362    free(templates_dir_path);
2363    if (full_path == NULL)
2364    {
2365       log_error(LOG_LEVEL_ERROR, "Out of memory while generating full template path for %s.",
2366          templatename);
2367       return JB_ERR_MEMORY;
2368    }
2369
2370    /* Allocate buffer */
2371
2372    file_buffer = strdup("");
2373    if (file_buffer == NULL)
2374    {
2375       log_error(LOG_LEVEL_ERROR, "Not enough free memory to buffer %s.", full_path);
2376       free(full_path);
2377       return JB_ERR_MEMORY;
2378    }
2379
2380    /* Open template file */
2381
2382    if (NULL == (fp = fopen(full_path, "r")))
2383    {
2384       log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
2385       free(full_path);
2386       free(file_buffer);
2387       return JB_ERR_FILE;
2388    }
2389    free(full_path);
2390
2391    /* 
2392     * Read the file, ignoring comments, and honoring #include
2393     * statements, unless we're already called recursively.
2394     *
2395     * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
2396     *        This is unlikely in practise.
2397     */
2398    while (fgets(buf, BUFFER_SIZE, fp))
2399    {
2400       if (!recursive && !strncmp(buf, "#include ", 9))
2401       {
2402          if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
2403          {
2404             free(file_buffer);
2405             fclose(fp);
2406             return err;
2407          }
2408
2409          if (string_join(&file_buffer, included_module))
2410          {
2411             fclose(fp);
2412             return JB_ERR_MEMORY;
2413          }
2414
2415          continue;
2416       }
2417
2418       /* skip lines starting with '#' */
2419       if (*buf == '#')
2420       {
2421          continue;
2422       }
2423
2424       if (string_append(&file_buffer, buf))
2425       {
2426          fclose(fp);
2427          return JB_ERR_MEMORY;
2428       }
2429    }
2430    fclose(fp);
2431
2432    *template_ptr = file_buffer;
2433
2434    return JB_ERR_OK;
2435 }
2436
2437
2438 /*********************************************************************
2439  *
2440  * Function    :  template_fill
2441  *
2442  * Description :  CGI support function that fills in a pre-loaded
2443  *                HTML template by replacing @name@ with value using
2444  *                pcrs, for each item in the output map.
2445  *
2446  *                Note that a leading '$' charachter in the export map's
2447  *                values will be stripped and toggle on backreference
2448  *                interpretation.
2449  *
2450  * Parameters  :
2451  *          1  :  template_ptr = IN: Template to be filled out.
2452  *                                   Will be free()d.
2453  *                               OUT: Filled out template.
2454  *                                    Caller must free().
2455  *          2  :  exports = map with fill in symbol -> name pairs
2456  *
2457  * Returns     :  JB_ERR_OK on success (and for uncritical errors)
2458  *                JB_ERR_MEMORY on out-of-memory error
2459  *
2460  *********************************************************************/
2461 jb_err template_fill(char **template_ptr, const struct map *exports)
2462 {
2463    struct map_entry *m;
2464    pcrs_job *job;
2465    char buf[BUFFER_SIZE];
2466    char *tmp_out_buffer;
2467    char *file_buffer;
2468    size_t  size;
2469    int error;
2470    const char *flags;
2471
2472    assert(template_ptr);
2473    assert(*template_ptr);
2474    assert(exports);
2475
2476    file_buffer = *template_ptr;
2477    size = strlen(file_buffer) + 1;
2478
2479    /* 
2480     * Assemble pcrs joblist from exports map
2481     */
2482    for (m = exports->first; m != NULL; m = m->next)
2483    {
2484       if (*m->name == '$')
2485       {
2486          /*
2487           * First character of name is '$', so remove this flag
2488           * character and allow backreferences ($1 etc) in the
2489           * "replace with" text.
2490           */
2491          snprintf(buf, BUFFER_SIZE, "%s", m->name + 1);
2492          flags = "sigU";
2493       }
2494       else
2495       {
2496          /*
2497           * Treat the "replace with" text as a literal string - 
2498           * no quoting needed, no backreferences allowed.
2499           * ("Trivial" ['T'] flag).
2500           */
2501          flags = "sigTU";
2502
2503          /* Enclose name in @@ */
2504          snprintf(buf, BUFFER_SIZE, "@%s@", m->name);
2505       }
2506
2507
2508       log_error(LOG_LEVEL_CGI, "Substituting: s/%s/%s/%s", buf, m->value, flags);
2509
2510       /* Make and run job. */
2511       job = pcrs_compile(buf, m->value, flags,  &error);
2512       if (job == NULL) 
2513       {
2514          if (error == PCRS_ERR_NOMEM)
2515          {
2516             free(file_buffer);
2517             *template_ptr = NULL;
2518             return JB_ERR_MEMORY;
2519          }
2520          else
2521          {
2522             log_error(LOG_LEVEL_ERROR, "Error compiling template fill job %s: %d", m->name, error);
2523             /* Hope it wasn't important and silently ignore the invalid job */
2524          }
2525       }
2526       else
2527       {
2528          error = pcrs_execute(job, file_buffer, size, &tmp_out_buffer, &size);
2529
2530          pcrs_free_job(job);
2531          if (NULL == tmp_out_buffer)
2532          {
2533             *template_ptr = NULL;
2534             return JB_ERR_MEMORY;
2535          }
2536
2537          if (error < 0)
2538          {
2539             /* 
2540              * Substitution failed, keep the original buffer,
2541              * log the problem and ignore it.
2542              * 
2543              * The user might see some unresolved @CGI_VARIABLES@,
2544              * but returning a special CGI error page seems unreasonable
2545              * and could mask more important error messages.
2546              */
2547             free(tmp_out_buffer);
2548             log_error(LOG_LEVEL_ERROR, "Failed to execute s/%s/%s/%s. %s",
2549                buf, m->value, flags, pcrs_strerror(error));
2550          }
2551          else
2552          {
2553             /* Substitution succeeded, use modified buffer. */
2554             free(file_buffer);
2555             file_buffer = tmp_out_buffer;
2556          }
2557       }
2558    }
2559
2560    /*
2561     * Return
2562     */
2563    *template_ptr = file_buffer;
2564    return JB_ERR_OK;
2565 }
2566
2567
2568 /*********************************************************************
2569  *
2570  * Function    :  template_fill_for_cgi
2571  *
2572  * Description :  CGI support function that loads a HTML template
2573  *                and fills it in.  Handles file-not-found errors
2574  *                by sending a HTML error message.  For convenience,
2575  *                this function also frees the passed "exports" map.
2576  *
2577  * Parameters  :
2578  *          1  :  csp = Client state
2579  *          2  :  templatename = name of the HTML template to be used
2580  *          3  :  exports = map with fill in symbol -> name pairs.
2581  *                          Will be freed by this function.
2582  *          4  :  rsp = Response structure to fill in.
2583  *
2584  * Returns     :  JB_ERR_OK on success
2585  *                JB_ERR_MEMORY on out-of-memory error
2586  *
2587  *********************************************************************/
2588 jb_err template_fill_for_cgi(const struct client_state *csp,
2589                              const char *templatename,
2590                              struct map *exports,
2591                              struct http_response *rsp)
2592 {
2593    jb_err err;
2594    
2595    assert(csp);
2596    assert(templatename);
2597    assert(exports);
2598    assert(rsp);
2599
2600    err = template_load(csp, &rsp->body, templatename, 0);
2601    if (err == JB_ERR_FILE)
2602    {
2603       free_map(exports);
2604       return cgi_error_no_template(csp, rsp, templatename);
2605    }
2606    else if (err)
2607    {
2608       free_map(exports);
2609       return err; /* JB_ERR_MEMORY */
2610    }
2611    err = template_fill(&rsp->body, exports);
2612    free_map(exports);
2613    return err;
2614 }
2615
2616
2617 /*********************************************************************
2618  *
2619  * Function    :  default_exports
2620  *
2621  * Description :  returns a struct map list that contains exports
2622  *                which are common to all CGI functions.
2623  *
2624  * Parameters  :
2625  *          1  :  csp = Current client state (buffers, headers, etc...)
2626  *          2  :  caller = name of CGI who calls us and which should
2627  *                         be excluded from the generated menu. May be
2628  *                         NULL.
2629  * Returns     :  NULL if no memory, else a new map.  Caller frees.
2630  *
2631  *********************************************************************/
2632 struct map *default_exports(const struct client_state *csp, const char *caller)
2633 {
2634    char buf[30];
2635    jb_err err;
2636    struct map * exports;
2637    int local_help_exists = 0;
2638    char *ip_address = NULL;
2639    char *hostname = NULL;
2640
2641    assert(csp);
2642
2643    exports = new_map();
2644    if (exports == NULL)
2645    {
2646       return NULL;
2647    }
2648
2649    if (csp->config->hostname)
2650    {
2651       get_host_information(csp->cfd, &ip_address, NULL);
2652       hostname = strdup(csp->config->hostname);
2653    }
2654    else
2655    {
2656       get_host_information(csp->cfd, &ip_address, &hostname);
2657    }
2658
2659    err = map(exports, "version", 1, html_encode(VERSION), 0);
2660    get_locale_time(buf, sizeof(buf));
2661    if (!err) err = map(exports, "time",          1, html_encode(buf), 0);
2662    if (!err) err = map(exports, "my-ip-address", 1, html_encode(ip_address ? ip_address : "unknown"), 0);
2663    freez(ip_address);
2664    if (!err) err = map(exports, "my-hostname",   1, html_encode(hostname ? hostname : "unknown"), 0);
2665    freez(hostname);
2666    if (!err) err = map(exports, "homepage",      1, html_encode(HOME_PAGE_URL), 0);
2667    if (!err) err = map(exports, "default-cgi",   1, html_encode(CGI_PREFIX), 0);
2668    if (!err) err = map(exports, "menu",          1, make_menu(caller, csp->config->feature_flags), 0);
2669    if (!err) err = map(exports, "code-status",   1, CODE_STATUS, 1);
2670    if (!strncmpic(csp->config->usermanual, "file://", 7) ||
2671        !strncmpic(csp->config->usermanual, "http", 4))
2672    {
2673       /* Manual is located somewhere else, just link to it. */
2674       if (!err) err = map(exports, "user-manual", 1, html_encode(csp->config->usermanual), 0);
2675    }
2676    else
2677    {
2678       /* Manual is delivered by Privoxy. */
2679       if (!err) err = map(exports, "user-manual", 1, html_encode(CGI_PREFIX"user-manual/"), 0);
2680    }
2681    if (!err) err = map(exports, "actions-help-prefix", 1, ACTIONS_HELP_PREFIX ,1);
2682 #ifdef FEATURE_TOGGLE
2683    if (!err) err = map_conditional(exports, "enabled-display", global_toggle_state);
2684 #else
2685    if (!err) err = map_block_killer(exports, "can-toggle");
2686 #endif
2687
2688    snprintf(buf, sizeof(buf), "%d", csp->config->hport);
2689    if (!err) err = map(exports, "my-port", 1, buf, 1);
2690
2691    if(!strcmp(CODE_STATUS, "stable"))
2692    {
2693       if (!err) err = map_block_killer(exports, "unstable");
2694    }
2695
2696    if (csp->config->admin_address != NULL)
2697    {
2698       if (!err) err = map(exports, "admin-address", 1, html_encode(csp->config->admin_address), 0);
2699       local_help_exists = 1;
2700    }
2701    else
2702    {
2703       if (!err) err = map_block_killer(exports, "have-adminaddr-info");
2704    }
2705
2706    if (csp->config->proxy_info_url != NULL)
2707    {
2708       if (!err) err = map(exports, "proxy-info-url", 1, html_encode(csp->config->proxy_info_url), 0);
2709       local_help_exists = 1;
2710    }
2711    else
2712    {
2713       if (!err) err = map_block_killer(exports, "have-proxy-info");
2714    }
2715
2716    if (local_help_exists == 0)
2717    {
2718       if (!err) err = map_block_killer(exports, "have-help-info");
2719    }
2720
2721    if (err)
2722    {
2723       free_map(exports);
2724       return NULL;
2725    }
2726
2727    return exports;
2728 }
2729
2730
2731 /*********************************************************************
2732  *
2733  * Function    :  map_block_killer
2734  *
2735  * Description :  Convenience function.
2736  *                Adds a "killer" for the conditional HTML-template
2737  *                block <name>, i.e. a substitution of the regex
2738  *                "if-<name>-start.*if-<name>-end" to the given
2739  *                export list.
2740  *
2741  * Parameters  :  
2742  *          1  :  exports = map to extend
2743  *          2  :  name = name of conditional block
2744  *
2745  * Returns     :  JB_ERR_OK on success
2746  *                JB_ERR_MEMORY on out-of-memory error.  
2747  *
2748  *********************************************************************/
2749 jb_err map_block_killer(struct map *exports, const char *name)
2750 {
2751    char buf[1000]; /* Will do, since the names are hardwired */
2752
2753    assert(exports);
2754    assert(name);
2755    assert(strlen(name) < 490);
2756
2757    snprintf(buf, sizeof(buf), "if-%s-start.*if-%s-end", name, name);
2758    return map(exports, buf, 1, "", 1);
2759 }
2760
2761
2762 /*********************************************************************
2763  *
2764  * Function    :  map_block_keep
2765  *
2766  * Description :  Convenience function.  Removes the markers used
2767  *                by map-block-killer, to save a few bytes.
2768  *                i.e. removes "@if-<name>-start@" and "@if-<name>-end@"
2769  *
2770  * Parameters  :  
2771  *          1  :  exports = map to extend
2772  *          2  :  name = name of conditional block
2773  *
2774  * Returns     :  JB_ERR_OK on success
2775  *                JB_ERR_MEMORY on out-of-memory error.  
2776  *
2777  *********************************************************************/
2778 jb_err map_block_keep(struct map *exports, const char *name)
2779 {
2780    jb_err err;
2781    char buf[500]; /* Will do, since the names are hardwired */
2782
2783    assert(exports);
2784    assert(name);
2785    assert(strlen(name) < 490);
2786
2787    snprintf(buf, sizeof(buf), "if-%s-start", name);
2788    err = map(exports, buf, 1, "", 1);
2789
2790    if (err)
2791    {
2792       return err;
2793    }
2794
2795    snprintf(buf, sizeof(buf), "if-%s-end", name);
2796    return map(exports, buf, 1, "", 1);
2797 }
2798
2799
2800 /*********************************************************************
2801  *
2802  * Function    :  map_conditional
2803  *
2804  * Description :  Convenience function.
2805  *                Adds an "if-then-else" for the conditional HTML-template
2806  *                block <name>, i.e. a substitution of the form:
2807  *                @if-<name>-then@
2808  *                   True text
2809  *                @else-not-<name>@
2810  *                   False text
2811  *                @endif-<name>@
2812  *
2813  *                The control structure and one of the alternatives
2814  *                will be hidden.
2815  *
2816  * Parameters  :  
2817  *          1  :  exports = map to extend
2818  *          2  :  name = name of conditional block
2819  *          3  :  choose_first = nonzero for first, zero for second.
2820  *
2821  * Returns     :  JB_ERR_OK on success
2822  *                JB_ERR_MEMORY on out-of-memory error.  
2823  *
2824  *********************************************************************/
2825 jb_err map_conditional(struct map *exports, const char *name, int choose_first)
2826 {
2827    char buf[1000]; /* Will do, since the names are hardwired */
2828    jb_err err;
2829
2830    assert(exports);
2831    assert(name);
2832    assert(strlen(name) < 480);
2833
2834    snprintf(buf, sizeof(buf), (choose_first
2835       ? "else-not-%s@.*@endif-%s"
2836       : "if-%s-then@.*@else-not-%s"),
2837       name, name);
2838
2839    err = map(exports, buf, 1, "", 1);
2840    if (err)
2841    {
2842       return err;
2843    }
2844
2845    snprintf(buf, sizeof(buf), (choose_first ? "if-%s-then" : "endif-%s"), name);
2846    return map(exports, buf, 1, "", 1);
2847 }
2848
2849
2850 /*********************************************************************
2851  *
2852  * Function    :  make_menu
2853  *
2854  * Description :  Returns an HTML-formatted menu of the available 
2855  *                unhidden CGIs, excluding the one given in <self>
2856  *                and the toggle CGI if toggling is disabled.
2857  *
2858  * Parameters  :
2859  *          1  :  self = name of CGI to leave out, can be NULL for
2860  *                complete listing.
2861  *          2  :  feature_flags = feature bitmap from csp->config
2862  *                
2863  *
2864  * Returns     :  menu string, or NULL on out-of-memory error.
2865  *
2866  *********************************************************************/
2867 char *make_menu(const char *self, const unsigned feature_flags)
2868 {
2869    const struct cgi_dispatcher *d;
2870    char *result = strdup("");
2871
2872    if (self == NULL)
2873    {
2874       self = "NO-SUCH-CGI!";
2875    }
2876
2877    /* List available unhidden CGI's and export as "other-cgis" */
2878    for (d = cgi_dispatchers; d->name; d++)
2879    {
2880
2881 #ifdef FEATURE_TOGGLE
2882       if (!(feature_flags & RUNTIME_FEATURE_CGI_TOGGLE) && !strcmp(d->name, "toggle"))
2883       {
2884          /*
2885           * Suppress the toggle link if remote toggling is disabled.
2886           */
2887          continue;
2888       }
2889 #endif /* def FEATURE_TOGGLE */
2890
2891       if (d->description && strcmp(d->name, self))
2892       {
2893          char *html_encoded_prefix;
2894
2895          /*
2896           * Line breaks would be great, but break
2897           * the "blocked" template's JavaScript.
2898           */
2899          string_append(&result, "<li><a href=\"");
2900          html_encoded_prefix = html_encode(CGI_PREFIX);
2901          if (html_encoded_prefix == NULL)
2902          {
2903             return NULL;  
2904          }
2905          else
2906          {
2907             string_append(&result, html_encoded_prefix);
2908             free(html_encoded_prefix);
2909          }
2910          string_append(&result, d->name);
2911          string_append(&result, "\">");
2912          string_append(&result, d->description);
2913          string_append(&result, "</a></li>");
2914       }
2915    }
2916
2917    return result;
2918 }
2919
2920
2921 /*********************************************************************
2922  *
2923  * Function    :  dump_map
2924  *
2925  * Description :  HTML-dump a map for debugging (as table)
2926  *
2927  * Parameters  :
2928  *          1  :  the_map = map to dump
2929  *
2930  * Returns     :  string with HTML
2931  *
2932  *********************************************************************/
2933 char *dump_map(const struct map *the_map)
2934 {
2935    struct map_entry *cur_entry;
2936    char *ret = strdup("");
2937
2938    string_append(&ret, "<table>\n");
2939
2940    for (cur_entry = the_map->first;
2941         (cur_entry != NULL) && (ret != NULL);
2942         cur_entry = cur_entry->next)
2943    {
2944       string_append(&ret, "<tr><td><b>");
2945       string_join  (&ret, html_encode(cur_entry->name));
2946       string_append(&ret, "</b></td><td>");
2947       string_join  (&ret, html_encode(cur_entry->value));
2948       string_append(&ret, "</td></tr>\n");
2949    }
2950
2951    string_append(&ret, "</table>\n");
2952    return ret;
2953 }
2954
2955
2956 /*
2957   Local Variables:
2958   tab-width: 3
2959   end:
2960 */