cgi.c

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