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