cgi.c

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