cgi.c

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