cgi.c

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