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