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