cgi.c

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