cgisimple.c

   1 /*********************************************************************
   2  *
   3  * File        :  $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
   4  *
   5  * Purpose     :  Simple CGIs to get information about Privoxy's
   6  *                status.
   7  *
   8  * Copyright   :  Written by and Copyright (C) 2001-2017 the
   9  *                Privoxy team. https://www.privoxy.org/
  10  *
  11  *                Based on the Internet Junkbuster originally written
  12  *                by and Copyright (C) 1997 Anonymous Coders and
  13  *                Junkbusters Corporation.  http://www.junkbusters.com
  14  *
  15  *                This program is free software; you can redistribute it
  16  *                and/or modify it under the terms of the GNU General
  17  *                Public License as published by the Free Software
  18  *                Foundation; either version 2 of the License, or (at
  19  *                your option) any later version.
  20  *
  21  *                This program is distributed in the hope that it will
  22  *                be useful, but WITHOUT ANY WARRANTY; without even the
  23  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  24  *                PARTICULAR PURPOSE.  See the GNU General Public
  25  *                License for more details.
  26  *
  27  *                The GNU General Public License should be included with
  28  *                this file.  If not, you can view it at
  29  *                http://www.gnu.org/copyleft/gpl.html
  30  *                or write to the Free Software Foundation, Inc., 59
  31  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  32  *
  33  **********************************************************************/
  34
  35
  36 #include "config.h"
  37
  38 #include <stdio.h>
  39 #include <sys/types.h>
  40 #include <stdlib.h>
  41 #include <ctype.h>
  42 #include <string.h>
  43 #include <assert.h>
  44
  45 #if defined (HAVE_ACCESS) && defined (HAVE_UNISTD_H)
  46 #include <unistd.h>
  47 #endif /* def HAVE_ACCESS && HAVE_UNISTD_H */
  48
  49 #include "project.h"
  50 #include "cgi.h"
  51 #include "cgisimple.h"
  52 #include "list.h"
  53 #include "encode.h"
  54 #include "jcc.h"
  55 #include "filters.h"
  56 #include "actions.h"
  57 #include "miscutil.h"
  58 #include "loadcfg.h"
  59 #include "parsers.h"
  60 #include "urlmatch.h"
  61 #include "errlog.h"
  62 #ifdef FEATURE_CLIENT_TAGS
  63 #include "client-tags.h"
  64 #endif
  65
  66 static jb_err show_defines(struct map *exports);
  67 static jb_err cgi_show_file(struct client_state *csp,
  68                             struct http_response *rsp,
  69                             const struct map *parameters);
  70 static jb_err load_file(const char *filename, char **buffer, size_t *length);
  71
  72 /*********************************************************************
  73  *
  74  * Function    :  cgi_default
  75  *
  76  * Description :  CGI function that is called for the CGI_SITE_1_HOST
  77  *                and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
  78  *                Boring - only exports the default exports.
  79  *
  80  * Parameters  :
  81  *          1  :  csp = Current client state (buffers, headers, etc...)
  82  *          2  :  rsp = http_response data structure for output
  83  *          3  :  parameters = map of cgi parameters
  84  *
  85  * CGI Parameters : none
  86  *
  87  * Returns     :  JB_ERR_OK on success
  88  *                JB_ERR_MEMORY on out-of-memory
  89  *
  90  *********************************************************************/
  91 jb_err cgi_default(struct client_state *csp,
  92                    struct http_response *rsp,
  93                    const struct map *parameters)
  94 {
  95    struct map *exports;
  96
  97    (void)parameters;
  98
  99    assert(csp);
 100    assert(rsp);
 101
 102    if (NULL == (exports = default_exports(csp, "")))
 103    {
 104       return JB_ERR_MEMORY;
 105    }
 106
 107    return template_fill_for_cgi(csp, "default", exports, rsp);
 108 }
 109
 110
 111 /*********************************************************************
 112  *
 113  * Function    :  cgi_error_404
 114  *
 115  * Description :  CGI function that is called if an unknown action was
 116  *                given.
 117  *
 118  * Parameters  :
 119  *          1  :  csp = Current client state (buffers, headers, etc...)
 120  *          2  :  rsp = http_response data structure for output
 121  *          3  :  parameters = map of cgi parameters
 122  *
 123  * CGI Parameters : none
 124  *
 125  * Returns     :  JB_ERR_OK on success
 126  *                JB_ERR_MEMORY on out-of-memory error.
 127  *
 128  *********************************************************************/
 129 jb_err cgi_error_404(struct client_state *csp,
 130                      struct http_response *rsp,
 131                      const struct map *parameters)
 132 {
 133    struct map *exports;
 134
 135    assert(csp);
 136    assert(rsp);
 137    assert(parameters);
 138
 139    if (NULL == (exports = default_exports(csp, NULL)))
 140    {
 141       return JB_ERR_MEMORY;
 142    }
 143
 144    rsp->status = strdup_or_die("404 Privoxy configuration page not found");
 145
 146    return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
 147 }
 148
 149
 150 #ifdef FEATURE_GRACEFUL_TERMINATION
 151 /*********************************************************************
 152  *
 153  * Function    :  cgi_die
 154  *
 155  * Description :  CGI function to shut down Privoxy.
 156  *                NOTE: Turning this on in a production build
 157  *                would be a BAD idea.  An EXTREMELY BAD idea.
 158  *                In short, don't do it.
 159  *
 160  * Parameters  :
 161  *          1  :  csp = Current client state (buffers, headers, etc...)
 162  *          2  :  rsp = http_response data structure for output
 163  *          3  :  parameters = map of cgi parameters
 164  *
 165  * CGI Parameters : none
 166  *
 167  * Returns     :  JB_ERR_OK on success
 168  *
 169  *********************************************************************/
 170 jb_err cgi_die (struct client_state *csp,
 171                 struct http_response *rsp,
 172                 const struct map *parameters)
 173 {
 174    static const char status[] = "200 OK Privoxy shutdown request received";
 175    static const char body[] =
 176       "<html>\n"
 177       "<head>\n"
 178       " <title>Privoxy shutdown request received</title>\n"
 179       " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">\n"
 180       " <link rel=\"stylesheet\" type=\"text/css\" href=\"" CGI_PREFIX "send-stylesheet\">\n"
 181       "</head>\n"
 182       "<body>\n"
 183       "<h1>Privoxy shutdown request received</h1>\n"
 184       "<p>Privoxy is going to shut down after the next request.</p>\n"
 185       "</body>\n"
 186       "</html>\n";
 187
 188    assert(csp);
 189    assert(rsp);
 190    assert(parameters);
 191
 192    /* quit */
 193    g_terminate = 1;
 194
 195    csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
 196
 197    rsp->content_length = 0;
 198    rsp->head_length = 0;
 199    rsp->is_static = 0;
 200
 201    rsp->body = strdup_or_die(body);
 202    rsp->status = strdup_or_die(status);
 203
 204    return JB_ERR_OK;
 205 }
 206 #endif /* def FEATURE_GRACEFUL_TERMINATION */
 207
 208
 209 /*********************************************************************
 210  *
 211  * Function    :  cgi_show_request
 212  *
 213  * Description :  Show the client's request and what sed() would have
 214  *                made of it.
 215  *
 216  * Parameters  :
 217  *          1  :  csp = Current client state (buffers, headers, etc...)
 218  *          2  :  rsp = http_response data structure for output
 219  *          3  :  parameters = map of cgi parameters
 220  *
 221  * CGI Parameters : none
 222  *
 223  * Returns     :  JB_ERR_OK on success
 224  *                JB_ERR_MEMORY on out-of-memory error.
 225  *
 226  *********************************************************************/
 227 jb_err cgi_show_request(struct client_state *csp,
 228                         struct http_response *rsp,
 229                         const struct map *parameters)
 230 {
 231    char *p;
 232    struct map *exports;
 233
 234    assert(csp);
 235    assert(rsp);
 236    assert(parameters);
 237
 238    if (NULL == (exports = default_exports(csp, "show-request")))
 239    {
 240       return JB_ERR_MEMORY;
 241    }
 242
 243    /*
 244     * Repair the damage done to the IOB by get_header()
 245     */
 246    for (p = csp->client_iob->buf; p < csp->client_iob->cur; p++)
 247    {
 248       if (*p == '\0') *p = '\n';
 249    }
 250
 251    /*
 252     * Export the original client's request and the one we would
 253     * be sending to the server if this wasn't a CGI call
 254     */
 255
 256    if (map(exports, "client-request", 1, html_encode(csp->client_iob->buf), 0))
 257    {
 258       free_map(exports);
 259       return JB_ERR_MEMORY;
 260    }
 261
 262    if (map(exports, "processed-request", 1,
 263          html_encode_and_free_original(list_to_text(csp->headers)), 0))
 264    {
 265       free_map(exports);
 266       return JB_ERR_MEMORY;
 267    }
 268
 269    return template_fill_for_cgi(csp, "show-request", exports, rsp);
 270 }
 271
 272
 273 #ifdef FEATURE_CLIENT_TAGS
 274 /*********************************************************************
 275  *
 276  * Function    :  cgi_create_client_tag_form
 277  *
 278  * Description :  Creates a HTML form to enable or disable a given
 279  *                client tag.
 280  *                XXX: Could use a template.
 281  *
 282  * Parameters  :
 283  *          1  :  form = Buffer to fill with the generated form
 284  *          2  :  size = Size of the form buffer
 285  *          3  :  tag = Name of the tag this form should affect
 286  *          4  :  toggle_state = Desired state after the button pressed 0
 287  *          5  :  expires = Whether or not the tag should be enabled.
 288  *                          Only checked if toggle_state is 1.
 289  *
 290  * Returns     :  void
 291  *
 292  *********************************************************************/
 293 static void cgi_create_client_tag_form(char *form, size_t size,
 294    const char *tag, int toggle_state, int expires)
 295 {
 296    char *button_name;
 297
 298    if (toggle_state == 1)
 299    {
 300       button_name = (expires == 1) ? "Enable" : "Enable temporarily";
 301    }
 302    else
 303    {
 304       assert(toggle_state == 0);
 305       button_name = "Disable";
 306    }
 307
 308    snprintf(form, size,
 309       "<form method=\"GET\" action=\""CGI_PREFIX"toggle-client-tag\" style=\"display: inline\">\n"
 310       " <input type=\"hidden\" name=\"tag\" value=\"%s\">\n"
 311       " <input type=\"hidden\" name=\"toggle-state\" value=\"%i\">\n"
 312       " <input type=\"hidden\" name=\"expires\" value=\"%u\">\n"
 313       " <input type=\"submit\" value=\"%s\">\n"
 314       "</form>", tag, toggle_state, !expires, button_name);
 315 }
 316
 317 /*********************************************************************
 318  *
 319  * Function    :  cgi_show_client_tags
 320  *
 321  * Description :  Shows the tags that can be set based on the client
 322  *                address (opt-in).
 323  *
 324  * Parameters  :
 325  *          1  :  csp = Current client state (buffers, headers, etc...)
 326  *          2  :  rsp = http_response data structure for output
 327  *          3  :  parameters = map of cgi parameters
 328  *
 329  * CGI Parameters : none
 330  *
 331  * Returns     :  JB_ERR_OK on success
 332  *                JB_ERR_MEMORY on out-of-memory error.
 333  *
 334  *********************************************************************/
 335 jb_err cgi_show_client_tags(struct client_state *csp,
 336                         struct http_response *rsp,
 337                         const struct map *parameters)
 338 {
 339    struct map *exports;
 340    struct client_tag_spec *this_tag;
 341    jb_err err = JB_ERR_OK;
 342    char *client_tag_status;
 343    char buf[1000];
 344    time_t refresh_delay;
 345
 346    assert(csp);
 347    assert(rsp);
 348    assert(parameters);
 349
 350    if (NULL == (exports = default_exports(csp, "client-tags")))
 351    {
 352       return JB_ERR_MEMORY;
 353    }
 354    assert(csp->client_address != NULL);
 355
 356    this_tag = csp->config->client_tags;
 357    if (this_tag->name == NULL)
 358    {
 359       client_tag_status = strdup_or_die("<p>No tags available.</p>\n");
 360    }
 361    else
 362    {
 363       client_tag_status = strdup_or_die("<table border=\"1\">\n"
 364          "<tr><th>Tag name</th>\n"
 365          "<th>Current state</th><th>Change state</th><th>Description</th></tr>\n");
 366       while ((this_tag != NULL) && (this_tag->name != NULL))
 367       {
 368          int tag_state;
 369
 370          privoxy_mutex_lock(&client_tags_mutex);
 371          tag_state = client_has_requested_tag(csp->client_address, this_tag->name);
 372          privoxy_mutex_unlock(&client_tags_mutex);
 373          if (!err) err = string_append(&client_tag_status, "<tr><td>");
 374          if (!err) err = string_append(&client_tag_status, this_tag->name);
 375          if (!err) err = string_append(&client_tag_status, "</td><td>");
 376          if (!err) err = string_append(&client_tag_status, tag_state == 1 ? "Enabled" : "Disabled");
 377          if (!err) err = string_append(&client_tag_status, "</td><td>");
 378          cgi_create_client_tag_form(buf, sizeof(buf), this_tag->name, !tag_state, 1);
 379          if (!err) err = string_append(&client_tag_status, buf);
 380          if (tag_state == 0)
 381          {
 382             cgi_create_client_tag_form(buf, sizeof(buf), this_tag->name, !tag_state, 0);
 383             if (!err) err = string_append(&client_tag_status, buf);
 384          }
 385          if (!err) err = string_append(&client_tag_status, "</td><td>");
 386          if (!err) err = string_append(&client_tag_status, this_tag->description);
 387          if (!err) err = string_append(&client_tag_status, "</td></tr>\n");
 388          if (err)
 389          {
 390             break;
 391          }
 392          this_tag = this_tag->next;
 393       }
 394       if (!err) err = string_append(&client_tag_status, "</table>\n");
 395       if (err)
 396       {
 397          free_map(exports);
 398          return JB_ERR_MEMORY;
 399       }
 400    }
 401    refresh_delay = get_next_tag_timeout_for_client(csp->client_address);
 402    if (refresh_delay != 0)
 403    {
 404       snprintf(buf, sizeof(buf), "%u", csp->config->client_tag_lifetime);
 405       if (map(exports, "refresh-delay", 1, buf, 1))
 406       {
 407          free_map(exports);
 408          return JB_ERR_MEMORY;
 409       }
 410    }
 411    else
 412    {
 413       err = map_block_killer(exports, "tags-expire");
 414       if (err != JB_ERR_OK)
 415       {
 416          return err;
 417       }
 418    }
 419
 420    if (map(exports, "client-tags", 1, client_tag_status, 0))
 421    {
 422       free_map(exports);
 423       return JB_ERR_MEMORY;
 424    }
 425
 426    if (map(exports, "client-ip-addr", 1, csp->client_address, 1))
 427    {
 428       free_map(exports);
 429       return JB_ERR_MEMORY;
 430    }
 431
 432    return template_fill_for_cgi(csp, "client-tags", exports, rsp);
 433 }
 434
 435
 436 /*********************************************************************
 437  *
 438  * Function    :  cgi_toggle_client_tag
 439  *
 440  * Description :  Toggles a client tag and redirects to the show-tags
 441  *                page
 442  *
 443  * Parameters  :
 444  *          1  :  csp = Current client state (buffers, headers, etc...)
 445  *          2  :  rsp = http_response data structure for output
 446  *          3  :  parameters = map of cgi parameters
 447  *
 448  * CGI Parameters : none
 449  *          1  :  tag = Name of the tag to enable or disable
 450  *          2  :  toggle-state = How to toggle the tag (0/1)
 451  *          3  :  expires = Set to 1 if the tag should be enabled
 452  *                          temporarily, otherwise set to 0
 453  *
 454  * Returns     :  JB_ERR_OK on success
 455  *                JB_ERR_MEMORY on out-of-memory error.
 456  *
 457  *********************************************************************/
 458 jb_err cgi_toggle_client_tag(struct client_state *csp,
 459                              struct http_response *rsp,
 460                              const struct map *parameters)
 461 {
 462    const char *toggled_tag;
 463    const char *toggle_state;
 464    const char *tag_expires;
 465    time_t time_to_live;
 466
 467    assert(csp);
 468    assert(rsp);
 469    assert(parameters);
 470
 471    toggled_tag = lookup(parameters, "tag");
 472    if (*toggled_tag == '\0')
 473    {
 474       log_error(LOG_LEVEL_ERROR, "Received tag toggle request without tag");
 475    }
 476    else
 477    {
 478       tag_expires = lookup(parameters, "expires");
 479       if (*tag_expires == '0')
 480       {
 481          time_to_live = 0;
 482       }
 483       else
 484       {
 485          time_to_live = csp->config->client_tag_lifetime;
 486       }
 487       toggle_state = lookup(parameters, "toggle-state");
 488       if (*toggle_state == '1')
 489       {
 490          enable_client_specific_tag(csp, toggled_tag, time_to_live);
 491       }
 492       else
 493       {
 494          disable_client_specific_tag(csp, toggled_tag);
 495       }
 496    }
 497    rsp->status = strdup_or_die("302 Done dealing with toggle request");
 498    if (enlist_unique_header(rsp->headers,
 499          "Location", CGI_PREFIX "client-tags"))
 500    {
 501          return JB_ERR_MEMORY;
 502    }
 503    return JB_ERR_OK;
 504
 505 }
 506 #endif /* def FEATURE_CLIENT_TAGS */
 507
 508
 509 /*********************************************************************
 510  *
 511  * Function    :  cgi_send_banner
 512  *
 513  * Description :  CGI function that returns a banner.
 514  *
 515  * Parameters  :
 516  *          1  :  csp = Current client state (buffers, headers, etc...)
 517  *          2  :  rsp = http_response data structure for output
 518  *          3  :  parameters = map of cgi parameters
 519  *
 520  * CGI Parameters :
 521  *           type : Selects the type of banner between "trans", "logo",
 522  *                  and "auto". Defaults to "logo" if absent or invalid.
 523  *                  "auto" means to select as if we were image-blocking.
 524  *                  (Only the first character really counts; b and t are
 525  *                  equivalent).
 526  *
 527  * Returns     :  JB_ERR_OK on success
 528  *                JB_ERR_MEMORY on out-of-memory error.
 529  *
 530  *********************************************************************/
 531 jb_err cgi_send_banner(struct client_state *csp,
 532                        struct http_response *rsp,
 533                        const struct map *parameters)
 534 {
 535    char imagetype = lookup(parameters, "type")[0];
 536
 537    /*
 538     * If type is auto, then determine the right thing
 539     * to do from the set-image-blocker action
 540     */
 541    if (imagetype == 'a')
 542    {
 543       /*
 544        * Default to pattern
 545        */
 546       imagetype = 'p';
 547
 548 #ifdef FEATURE_IMAGE_BLOCKING
 549       if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
 550       {
 551          static const char prefix1[] = CGI_PREFIX "send-banner?type=";
 552          static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
 553          const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
 554
 555          if (p == NULL)
 556          {
 557             /* Use default - nothing to do here. */
 558          }
 559          else if (0 == strcmpic(p, "blank"))
 560          {
 561             imagetype = 'b';
 562          }
 563          else if (0 == strcmpic(p, "pattern"))
 564          {
 565             imagetype = 'p';
 566          }
 567
 568          /*
 569           * If the action is to call this CGI, determine
 570           * the argument:
 571           */
 572          else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
 573          {
 574             imagetype = p[sizeof(prefix1) - 1];
 575          }
 576          else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
 577          {
 578             imagetype = p[sizeof(prefix2) - 1];
 579          }
 580
 581          /*
 582           * Everything else must (should) be a URL to
 583           * redirect to.
 584           */
 585          else
 586          {
 587             imagetype = 'r';
 588          }
 589       }
 590 #endif /* def FEATURE_IMAGE_BLOCKING */
 591    }
 592
 593    /*
 594     * Now imagetype is either the non-auto type we were called with,
 595     * or it was auto and has since been determined. In any case, we
 596     * can proceed to actually answering the request by sending a redirect
 597     * or an image as appropriate:
 598     */
 599    if (imagetype == 'r')
 600    {
 601       rsp->status = strdup_or_die("302 Local Redirect from Privoxy");
 602       if (enlist_unique_header(rsp->headers, "Location",
 603                                csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
 604       {
 605          return JB_ERR_MEMORY;
 606       }
 607    }
 608    else
 609    {
 610       if ((imagetype == 'b') || (imagetype == 't'))
 611       {
 612          rsp->body = bindup(image_blank_data, image_blank_length);
 613          rsp->content_length = image_blank_length;
 614       }
 615       else
 616       {
 617          rsp->body = bindup(image_pattern_data, image_pattern_length);
 618          rsp->content_length = image_pattern_length;
 619       }
 620
 621       if (rsp->body == NULL)
 622       {
 623          return JB_ERR_MEMORY;
 624       }
 625       if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
 626       {
 627          return JB_ERR_MEMORY;
 628       }
 629
 630       rsp->is_static = 1;
 631    }
 632
 633    return JB_ERR_OK;
 634
 635 }
 636
 637
 638 /*********************************************************************
 639  *
 640  * Function    :  cgi_transparent_image
 641  *
 642  * Description :  CGI function that sends a 1x1 transparent image.
 643  *
 644  * Parameters  :
 645  *          1  :  csp = Current client state (buffers, headers, etc...)
 646  *          2  :  rsp = http_response data structure for output
 647  *          3  :  parameters = map of cgi parameters
 648  *
 649  * CGI Parameters : None
 650  *
 651  * Returns     :  JB_ERR_OK on success
 652  *                JB_ERR_MEMORY on out-of-memory error.
 653  *
 654  *********************************************************************/
 655 jb_err cgi_transparent_image(struct client_state *csp,
 656                              struct http_response *rsp,
 657                              const struct map *parameters)
 658 {
 659    (void)csp;
 660    (void)parameters;
 661
 662    rsp->body = bindup(image_blank_data, image_blank_length);
 663    rsp->content_length = image_blank_length;
 664
 665    if (rsp->body == NULL)
 666    {
 667       return JB_ERR_MEMORY;
 668    }
 669
 670    if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
 671    {
 672       return JB_ERR_MEMORY;
 673    }
 674
 675    rsp->is_static = 1;
 676
 677    return JB_ERR_OK;
 678
 679 }
 680
 681
 682 /*********************************************************************
 683  *
 684  * Function    :  cgi_send_default_favicon
 685  *
 686  * Description :  CGI function that sends the standard favicon.
 687  *
 688  * Parameters  :
 689  *          1  :  csp = Current client state (buffers, headers, etc...)
 690  *          2  :  rsp = http_response data structure for output
 691  *          3  :  parameters = map of cgi parameters
 692  *
 693  * CGI Parameters : None
 694  *
 695  * Returns     :  JB_ERR_OK on success
 696  *                JB_ERR_MEMORY on out-of-memory error.
 697  *
 698  *********************************************************************/
 699 jb_err cgi_send_default_favicon(struct client_state *csp,
 700                                 struct http_response *rsp,
 701                                 const struct map *parameters)
 702 {
 703    static const char default_favicon_data[] =
 704       "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
 705       "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
 706       "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
 707       "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
 708       "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
 709       "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
 710       "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
 711       "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
 712       "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
 713       "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
 714       "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 715       "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 716       "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
 717       "\017\000\000";
 718    static const size_t favicon_length = sizeof(default_favicon_data) - 1;
 719
 720    (void)csp;
 721    (void)parameters;
 722
 723    rsp->body = bindup(default_favicon_data, favicon_length);
 724    rsp->content_length = favicon_length;
 725
 726    if (rsp->body == NULL)
 727    {
 728       return JB_ERR_MEMORY;
 729    }
 730
 731    if (enlist(rsp->headers, "Content-Type: image/x-icon"))
 732    {
 733       return JB_ERR_MEMORY;
 734    }
 735
 736    rsp->is_static = 1;
 737
 738    return JB_ERR_OK;
 739
 740 }
 741
 742
 743 /*********************************************************************
 744  *
 745  * Function    :  cgi_send_error_favicon
 746  *
 747  * Description :  CGI function that sends the favicon for error pages.
 748  *
 749  * Parameters  :
 750  *          1  :  csp = Current client state (buffers, headers, etc...)
 751  *          2  :  rsp = http_response data structure for output
 752  *          3  :  parameters = map of cgi parameters
 753  *
 754  * CGI Parameters : None
 755  *
 756  * Returns     :  JB_ERR_OK on success
 757  *                JB_ERR_MEMORY on out-of-memory error.
 758  *
 759  *********************************************************************/
 760 jb_err cgi_send_error_favicon(struct client_state *csp,
 761                               struct http_response *rsp,
 762                               const struct map *parameters)
 763 {
 764    static const char error_favicon_data[] =
 765       "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
 766       "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
 767       "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
 768       "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
 769       "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
 770       "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
 771       "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
 772       "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
 773       "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
 774       "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
 775       "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 776       "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 777       "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
 778       "\017\000\000";
 779    static const size_t favicon_length = sizeof(error_favicon_data) - 1;
 780
 781    (void)csp;
 782    (void)parameters;
 783
 784    rsp->body = bindup(error_favicon_data, favicon_length);
 785    rsp->content_length = favicon_length;
 786
 787    if (rsp->body == NULL)
 788    {
 789       return JB_ERR_MEMORY;
 790    }
 791
 792    if (enlist(rsp->headers, "Content-Type: image/x-icon"))
 793    {
 794       return JB_ERR_MEMORY;
 795    }
 796
 797    rsp->is_static = 1;
 798
 799    return JB_ERR_OK;
 800
 801 }
 802
 803
 804 /*********************************************************************
 805  *
 806  * Function    :  cgi_send_stylesheet
 807  *
 808  * Description :  CGI function that sends a css stylesheet found
 809  *                in the cgi-style.css template
 810  *
 811  * Parameters  :
 812  *          1  :  csp = Current client state (buffers, headers, etc...)
 813  *          2  :  rsp = http_response data structure for output
 814  *          3  :  parameters = map of cgi parameters
 815  *
 816  * CGI Parameters : None
 817  *
 818  * Returns     :  JB_ERR_OK on success
 819  *                JB_ERR_MEMORY on out-of-memory error.
 820  *
 821  *********************************************************************/
 822 jb_err cgi_send_stylesheet(struct client_state *csp,
 823                            struct http_response *rsp,
 824                            const struct map *parameters)
 825 {
 826    jb_err err;
 827
 828    assert(csp);
 829    assert(rsp);
 830
 831    (void)parameters;
 832
 833    err = template_load(csp, &rsp->body, "cgi-style.css", 0);
 834
 835    if (err == JB_ERR_FILE)
 836    {
 837       /*
 838        * No way to tell user; send empty stylesheet
 839        */
 840       log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
 841    }
 842    else if (err)
 843    {
 844       return err; /* JB_ERR_MEMORY */
 845    }
 846
 847    if (enlist(rsp->headers, "Content-Type: text/css"))
 848    {
 849       return JB_ERR_MEMORY;
 850    }
 851
 852    return JB_ERR_OK;
 853
 854 }
 855
 856
 857 /*********************************************************************
 858  *
 859  * Function    :  cgi_send_url_info_osd
 860  *
 861  * Description :  CGI function that sends the OpenSearch Description
 862  *                template for the show-url-info page. It allows to
 863  *                access the page through "search engine plugins".
 864  *
 865  * Parameters  :
 866  *          1  :  csp = Current client state (buffers, headers, etc...)
 867  *          2  :  rsp = http_response data structure for output
 868  *          3  :  parameters = map of cgi parameters
 869  *
 870  * CGI Parameters : None
 871  *
 872  * Returns     :  JB_ERR_OK on success
 873  *                JB_ERR_MEMORY on out-of-memory error.
 874  *
 875  *********************************************************************/
 876 jb_err cgi_send_url_info_osd(struct client_state *csp,
 877                                struct http_response *rsp,
 878                                const struct map *parameters)
 879 {
 880    jb_err err = JB_ERR_MEMORY;
 881    struct map *exports = default_exports(csp, NULL);
 882
 883    (void)csp;
 884    (void)parameters;
 885
 886    if (NULL != exports)
 887    {
 888       err = template_fill_for_cgi(csp, "url-info-osd.xml", exports, rsp);
 889       if (JB_ERR_OK == err)
 890       {
 891          err = enlist(rsp->headers,
 892             "Content-Type: application/opensearchdescription+xml");
 893       }
 894    }
 895
 896    return err;
 897
 898 }
 899
 900
 901 /*********************************************************************
 902  *
 903  * Function    :  get_content_type
 904  *
 905  * Description :  Use the file extension to guess the content type
 906  *                header we should use to serve the file.
 907  *
 908  * Parameters  :
 909  *          1  :  filename = Name of the file whose content type
 910  *                           we care about
 911  *
 912  * Returns     :  The guessed content type.
 913  *
 914  *********************************************************************/
 915 static const char *get_content_type(const char *filename)
 916 {
 917    int i;
 918    struct content_type
 919    {
 920       const char extension[6];
 921       const char content_type[11];
 922    };
 923    static const struct content_type content_types[] =
 924    {
 925       {".css",  "text/css"},
 926       {".jpg",  "image/jpeg"},
 927       {".jpeg", "image/jpeg"},
 928       {".png",  "image/png"},
 929    };
 930
 931    for (i = 0; i < SZ(content_types); i++)
 932    {
 933       if (strstr(filename, content_types[i].extension))
 934       {
 935          return content_types[i].content_type;
 936       }
 937    }
 938
 939    /* No match by extension, default to html */
 940    return "text/html";
 941 }
 942
 943 /*********************************************************************
 944  *
 945  * Function    :  cgi_send_user_manual
 946  *
 947  * Description :  CGI function that sends a file in the user
 948  *                manual directory.
 949  *
 950  * Parameters  :
 951  *          1  :  csp = Current client state (buffers, headers, etc...)
 952  *          2  :  rsp = http_response data structure for output
 953  *          3  :  parameters = map of cgi parameters
 954  *
 955  * CGI Parameters : file=name.html, the name of the HTML file
 956  *                  (relative to user-manual from config)
 957  *
 958  * Returns     :  JB_ERR_OK on success
 959  *                JB_ERR_MEMORY on out-of-memory error.
 960  *
 961  *********************************************************************/
 962 jb_err cgi_send_user_manual(struct client_state *csp,
 963                             struct http_response *rsp,
 964                             const struct map *parameters)
 965 {
 966    const char *filename;
 967    char *full_path;
 968    jb_err err = JB_ERR_OK;
 969    const char *content_type;
 970
 971    assert(csp);
 972    assert(rsp);
 973    assert(parameters);
 974
 975    if (0 == strncmpic(csp->config->usermanual, "http://", 7))
 976    {
 977       log_error(LOG_LEVEL_CGI, "Request for local user-manual "
 978          "received while user-manual delivery is disabled.");
 979       return cgi_error_404(csp, rsp, parameters);
 980    }
 981
 982    if (!parameters->first)
 983    {
 984       /* requested http://p.p/user-manual (without trailing slash) */
 985       return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
 986    }
 987
 988    get_string_param(parameters, "file", &filename);
 989    if (filename == NULL)
 990    {
 991       /* It's '/' so serve the index.html if there is one.  */
 992       filename = "index.html";
 993    }
 994    else if (NULL != strchr(filename, '/') || NULL != strstr(filename, ".."))
 995    {
 996       /*
 997        * We currently only support a flat file
 998        * hierarchy for the documentation.
 999        */
1000       log_error(LOG_LEVEL_ERROR,
1001          "Rejecting the request to serve '%s' as it contains '/' or '..'",
1002          filename);
1003       return JB_ERR_CGI_PARAMS;
1004    }
1005
1006    full_path = make_path(csp->config->usermanual, filename);
1007    if (full_path == NULL)
1008    {
1009       return JB_ERR_MEMORY;
1010    }
1011
1012    err = load_file(full_path, &rsp->body, &rsp->content_length);
1013    if (JB_ERR_OK != err)
1014    {
1015       assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1016       if (JB_ERR_FILE == err)
1017       {
1018          err = cgi_error_no_template(csp, rsp, full_path);
1019       }
1020       freez(full_path);
1021       return err;
1022    }
1023    freez(full_path);
1024
1025    content_type = get_content_type(filename);
1026    log_error(LOG_LEVEL_CGI,
1027       "Content-Type guessed for %s: %s", filename, content_type);
1028
1029    return enlist_unique_header(rsp->headers, "Content-Type", content_type);
1030
1031 }
1032
1033
1034 #ifdef FEATURE_EXTENDED_STATISTICS
1035 /*********************************************************************
1036  *
1037  * Function    :  get_filter_statistics_table
1038  *
1039  * Description :  Produces the filter statistic table content.
1040  *
1041  * Parameters  :
1042  *          1  :  csp = Current client state (buffers, headers, etc...)
1043  *
1044  * Returns     :  Pointer to the HTML statistic table content or
1045  *                NULL on out of memory
1046  *
1047  *********************************************************************/
1048 static char *get_filter_statistics_table(const struct client_state *csp)
1049 {
1050    char buf[BUFFER_SIZE];
1051    char *statistics;
1052    int i;
1053    struct file_list *fl;
1054    struct re_filterfile_spec *b;
1055    jb_err err = JB_ERR_OK;
1056
1057    statistics = strdup_or_die("");
1058
1059    for (i = 0; i < MAX_AF_FILES; i++)
1060    {
1061      fl = csp->rlist[i];
1062      if ((NULL == fl) || (NULL == fl->f))
1063      {
1064         /*
1065          * Either there are no filter files left or this
1066          * filter file just contains no valid filters.
1067          *
1068          * Continue to be sure we don't miss valid filter
1069          * files that are chained after empty or invalid ones.
1070          */
1071         continue;
1072      }
1073
1074      for (b = fl->f; b != NULL; b = b->next)
1075      {
1076         if (b->type == FT_CONTENT_FILTER)
1077         {
1078            unsigned long long executions;
1079            unsigned long long pages_modified;
1080            unsigned long long hits;
1081
1082            get_filter_statistics(b->name, &executions, &pages_modified, &hits);
1083            snprintf(buf, sizeof(buf),
1084               "<tr><td>%s</td><td style=\"text-align: right\">%llu</td>"
1085               "<td style=\"text-align: right\">%llu</td>"
1086               "<td style=\"text-align: right\">%llu</td><tr>\n",
1087               b->name, executions, pages_modified, hits);
1088
1089            if (!err) err = string_append(&statistics, buf);
1090         }
1091      }
1092    }
1093
1094    return statistics;
1095
1096 }
1097 #endif
1098
1099
1100 /*********************************************************************
1101  *
1102  * Function    :  cgi_show_status
1103  *
1104  * Description :  CGI function that returns a web page describing the
1105  *                current status of Privoxy.
1106  *
1107  * Parameters  :
1108  *          1  :  csp = Current client state (buffers, headers, etc...)
1109  *          2  :  rsp = http_response data structure for output
1110  *          3  :  parameters = map of cgi parameters
1111  *
1112  * CGI Parameters :
1113  *        file :  Which file to show.  Only first letter is checked,
1114  *                valid values are:
1115  *                - "a"ction file
1116  *                - "r"egex
1117  *                - "t"rust
1118  *                Default is to show menu and other information.
1119  *
1120  * Returns     :  JB_ERR_OK on success
1121  *                JB_ERR_MEMORY on out-of-memory error.
1122  *
1123  *********************************************************************/
1124 jb_err cgi_show_status(struct client_state *csp,
1125                        struct http_response *rsp,
1126                        const struct map *parameters)
1127 {
1128    char *s = NULL;
1129    unsigned i;
1130    int j;
1131
1132    char buf[BUFFER_SIZE];
1133 #ifdef FEATURE_STATISTICS
1134    float perc_rej;   /* Percentage of http requests rejected */
1135    int local_urls_read;
1136    int local_urls_rejected;
1137 #endif /* ndef FEATURE_STATISTICS */
1138    jb_err err = JB_ERR_OK;
1139
1140    struct map *exports;
1141
1142    assert(csp);
1143    assert(rsp);
1144    assert(parameters);
1145
1146    if ('\0' != *(lookup(parameters, "file")))
1147    {
1148       return cgi_show_file(csp, rsp, parameters);
1149    }
1150
1151    if (NULL == (exports = default_exports(csp, "show-status")))
1152    {
1153       return JB_ERR_MEMORY;
1154    }
1155
1156    s = strdup("");
1157    for (j = 0; (s != NULL) && (j < Argc); j++)
1158    {
1159       if (!err) err = string_join  (&s, html_encode(Argv[j]));
1160       if (!err) err = string_append(&s, " ");
1161    }
1162    if (!err) err = map(exports, "invocation", 1, s, 0);
1163
1164    if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1165    if (!err) err = show_defines(exports);
1166
1167    if (err)
1168    {
1169       free_map(exports);
1170       return JB_ERR_MEMORY;
1171    }
1172
1173 #ifdef FEATURE_STATISTICS
1174    local_urls_read     = urls_read;
1175    local_urls_rejected = urls_rejected;
1176
1177    /*
1178     * Need to alter the stats not to include the fetch of this
1179     * page.
1180     *
1181     * Can't do following thread safely! doh!
1182     *
1183     * urls_read--;
1184     * urls_rejected--; * This will be incremented subsequently *
1185     */
1186
1187    if (local_urls_read == 0)
1188    {
1189       if (!err) err = map_block_killer(exports, "have-stats");
1190    }
1191    else
1192    {
1193       if (!err) err = map_block_killer(exports, "have-no-stats");
1194
1195       perc_rej = (float)local_urls_rejected * 100.0F /
1196             (float)local_urls_read;
1197
1198       snprintf(buf, sizeof(buf), "%d", local_urls_read);
1199       if (!err) err = map(exports, "requests-received", 1, buf, 1);
1200
1201       snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1202       if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1203
1204       snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1205       if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1206    }
1207
1208 #else /* ndef FEATURE_STATISTICS */
1209    if (!err) err = map_block_killer(exports, "statistics");
1210 #endif /* ndef FEATURE_STATISTICS */
1211
1212 #ifdef FEATURE_EXTENDED_STATISTICS
1213    {
1214       char *filter_statistics = get_filter_statistics_table(csp);
1215       if (filter_statistics != NULL)
1216       {
1217          if (!err) err = map(exports, "filter-statistics", 1, filter_statistics, 0);
1218       }
1219       else
1220       {
1221          if (!err) err = map_block_killer(exports, "extended-statistics");
1222       }
1223    }
1224 #else /* ndef FEATURE_EXTENDED_STATISTICS */
1225    if (!err) err = map_block_killer(exports, "extended-statistics");
1226 #endif /* def FEATURE_EXTENDED_STATISTICS */
1227
1228    /*
1229     * List all action files in use, together with view and edit links,
1230     * except for standard.action, which should only be viewable. (Not
1231     * enforced in the editor itself)
1232     * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1233     */
1234    s = strdup("");
1235    for (i = 0; i < MAX_AF_FILES; i++)
1236    {
1237       if (csp->actions_list[i] != NULL)
1238       {
1239          if (!err) err = string_append(&s, "<tr><td>");
1240          if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1241          snprintf(buf, sizeof(buf),
1242             "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&amp;index=%u\">View</a>", i);
1243          if (!err) err = string_append(&s, buf);
1244
1245 #ifdef FEATURE_CGI_EDIT_ACTIONS
1246          if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1247             && (NULL != csp->config->actions_file_short[i]))
1248          {
1249 #ifdef HAVE_ACCESS
1250             if (access(csp->config->actions_file[i], W_OK) == 0)
1251             {
1252 #endif /* def HAVE_ACCESS */
1253                snprintf(buf, sizeof(buf), "&nbsp;&nbsp;<a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
1254                if (!err) err = string_append(&s, buf);
1255 #ifdef HAVE_ACCESS
1256             }
1257             else
1258             {
1259                if (!err) err = string_append(&s, "&nbsp;&nbsp;<strong>No write access.</strong>");
1260             }
1261 #endif /* def HAVE_ACCESS */
1262          }
1263 #endif
1264
1265          if (!err) err = string_append(&s, "</td></tr>\n");
1266       }
1267    }
1268    if (*s != '\0')
1269    {
1270       if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1271    }
1272    else
1273    {
1274       if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1275    }
1276
1277    /*
1278     * List all re_filterfiles in use, together with view options.
1279     * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1280     */
1281    s = strdup("");
1282    for (i = 0; i < MAX_AF_FILES; i++)
1283    {
1284       if (csp->rlist[i] != NULL)
1285       {
1286          if (!err) err = string_append(&s, "<tr><td>");
1287          if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1288          snprintf(buf, sizeof(buf),
1289             "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&amp;index=%u\">View</a>", i);
1290          if (!err) err = string_append(&s, buf);
1291          if (!err) err = string_append(&s, "</td></tr>\n");
1292       }
1293    }
1294    if (*s != '\0')
1295    {
1296       if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1297    }
1298    else
1299    {
1300       if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1301       if (!err) err = map_block_killer(exports, "have-filterfile");
1302    }
1303
1304 #ifdef FEATURE_TRUST
1305    if (csp->tlist)
1306    {
1307       if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1308    }
1309    else
1310    {
1311       if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1312       if (!err) err = map_block_killer(exports, "have-trustfile");
1313    }
1314 #else
1315    if (!err) err = map_block_killer(exports, "trust-support");
1316 #endif /* ndef FEATURE_TRUST */
1317
1318 #ifdef FEATURE_CGI_EDIT_ACTIONS
1319    if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1320    {
1321       err = map_block_killer(exports, "cgi-editor-is-disabled");
1322    }
1323 #endif /* ndef CGI_EDIT_ACTIONS */
1324
1325    if (!err) err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
1326
1327    if (err)
1328    {
1329       free_map(exports);
1330       return JB_ERR_MEMORY;
1331    }
1332
1333    return template_fill_for_cgi(csp, "show-status", exports, rsp);
1334 }
1335
1336
1337 /*********************************************************************
1338  *
1339  * Function    :  cgi_show_url_info
1340  *
1341  * Description :  CGI function that determines and shows which actions
1342  *                Privoxy will perform for a given url, and which
1343  *                matches starting from the defaults have lead to that.
1344  *
1345  * Parameters  :
1346  *          1  :  csp = Current client state (buffers, headers, etc...)
1347  *          2  :  rsp = http_response data structure for output
1348  *          3  :  parameters = map of cgi parameters
1349  *
1350  * CGI Parameters :
1351  *            url : The url whose actions are to be determined.
1352  *                  If url is unset, the url-given conditional will be
1353  *                  set, so that all but the form can be suppressed in
1354  *                  the template.
1355  *
1356  * Returns     :  JB_ERR_OK on success
1357  *                JB_ERR_MEMORY on out-of-memory error.
1358  *
1359  *********************************************************************/
1360 jb_err cgi_show_url_info(struct client_state *csp,
1361                          struct http_response *rsp,
1362                          const struct map *parameters)
1363 {
1364    char *url_param;
1365    struct map *exports;
1366    char buf[150];
1367
1368    assert(csp);
1369    assert(rsp);
1370    assert(parameters);
1371
1372    if (NULL == (exports = default_exports(csp, "show-url-info")))
1373    {
1374       return JB_ERR_MEMORY;
1375    }
1376
1377    /*
1378     * Get the url= parameter (if present) and remove any leading/trailing spaces.
1379     */
1380    url_param = strdup_or_die(lookup(parameters, "url"));
1381    chomp(url_param);
1382
1383    /*
1384     * Handle prefixes.  4 possibilities:
1385     * 1) "http://" or "https://" prefix present and followed by URL - OK
1386     * 2) Only the "http://" or "https://" part is present, no URL - change
1387     *    to empty string so it will be detected later as "no URL".
1388     * 3) Parameter specified but doesn't start with "http(s?)://" - add a
1389     *    "http://" prefix.
1390     * 4) Parameter not specified or is empty string - let this fall through
1391     *    for now, next block of code will handle it.
1392     */
1393    if (0 == strncmp(url_param, "http://", 7))
1394    {
1395       if (url_param[7] == '\0')
1396       {
1397          /*
1398           * Empty URL (just prefix).
1399           * Make it totally empty so it's caught by the next if ()
1400           */
1401          url_param[0] = '\0';
1402       }
1403    }
1404    else if (0 == strncmp(url_param, "https://", 8))
1405    {
1406       if (url_param[8] == '\0')
1407       {
1408          /*
1409           * Empty URL (just prefix).
1410           * Make it totally empty so it's caught by the next if ()
1411           */
1412          url_param[0] = '\0';
1413       }
1414    }
1415    else if ((url_param[0] != '\0')
1416       && ((NULL == strstr(url_param, "://")
1417             || (strstr(url_param, "://") > strstr(url_param, "/")))))
1418    {
1419       /*
1420        * No prefix or at least no prefix before
1421        * the first slash - assume http://
1422        */
1423       char *url_param_prefixed = strdup_or_die("http://");
1424
1425       if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1426       {
1427          free_map(exports);
1428          return JB_ERR_MEMORY;
1429       }
1430       url_param = url_param_prefixed;
1431    }
1432
1433    /*
1434     * Hide "toggle off" warning if Privoxy is toggled on.
1435     */
1436    if (
1437 #ifdef FEATURE_TOGGLE
1438        (global_toggle_state == 1) &&
1439 #endif /* def FEATURE_TOGGLE */
1440        map_block_killer(exports, "privoxy-is-toggled-off")
1441       )
1442    {
1443       freez(url_param);
1444       free_map(exports);
1445       return JB_ERR_MEMORY;
1446    }
1447
1448    if (url_param[0] == '\0')
1449    {
1450       /* URL parameter not specified, display query form only. */
1451       free(url_param);
1452       if (map_block_killer(exports, "url-given")
1453         || map(exports, "url", 1, "", 1))
1454       {
1455          free_map(exports);
1456          return JB_ERR_MEMORY;
1457       }
1458    }
1459    else
1460    {
1461       /* Given a URL, so query it. */
1462       jb_err err;
1463       char *matches;
1464       char *s;
1465       int hits = 0;
1466       struct file_list *fl;
1467       struct url_actions *b;
1468       struct http_request url_to_query[1];
1469       struct current_action_spec action[1];
1470       int i;
1471
1472       if (map(exports, "url", 1, html_encode(url_param), 0))
1473       {
1474          free(url_param);
1475          free_map(exports);
1476          return JB_ERR_MEMORY;
1477       }
1478
1479       init_current_action(action);
1480
1481       if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1482       {
1483          free_current_action(action);
1484          free(url_param);
1485          free_map(exports);
1486          return JB_ERR_MEMORY;
1487       }
1488
1489       memset(url_to_query, '\0', sizeof(url_to_query));
1490       err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1491       assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1492
1493       free(url_param);
1494
1495       if (err == JB_ERR_MEMORY)
1496       {
1497          free_http_request(url_to_query);
1498          free_current_action(action);
1499          free_map(exports);
1500          return JB_ERR_MEMORY;
1501       }
1502       else if (err)
1503       {
1504          /* Invalid URL */
1505
1506          err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1507          if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1508          if (!err) err = map_block_killer(exports, "valid-url");
1509
1510          free_current_action(action);
1511          free_http_request(url_to_query);
1512
1513          if (err)
1514          {
1515             free_map(exports);
1516             return JB_ERR_MEMORY;
1517          }
1518
1519          return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1520       }
1521
1522       /*
1523        * We have a warning about SSL paths. Hide it for unencrypted sites
1524        * and unconditionally if https inspection is enabled.
1525        */
1526 #ifndef FEATURE_HTTPS_INSPECTION
1527       if (!url_to_query->ssl)
1528 #endif
1529       {
1530          if (map_block_killer(exports, "https-and-no-https-inspection"))
1531          {
1532             free_current_action(action);
1533             free_map(exports);
1534             free_http_request(url_to_query);
1535             return JB_ERR_MEMORY;
1536          }
1537       }
1538
1539       matches = strdup_or_die("<table summary=\"\" class=\"transparent\">");
1540
1541       for (i = 0; i < MAX_AF_FILES; i++)
1542       {
1543          if (NULL == csp->config->actions_file_short[i]
1544              || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1545
1546          b = NULL;
1547          hits = 1;
1548          if ((fl = csp->actions_list[i]) != NULL)
1549          {
1550             if ((b = fl->f) != NULL)
1551             {
1552                /* FIXME: Hardcoded HTML! */
1553                string_append(&matches, "<tr><th>In file: ");
1554                string_join  (&matches, html_encode(csp->config->actions_file_short[i]));
1555                snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&amp;index=%d\">", i);
1556                string_append(&matches, buf);
1557                string_append(&matches, "View</a>");
1558 #ifdef FEATURE_CGI_EDIT_ACTIONS
1559                if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1560                {
1561 #ifdef HAVE_ACCESS
1562                   if (access(csp->config->actions_file[i], W_OK) == 0)
1563                   {
1564 #endif /* def HAVE_ACCESS */
1565                      snprintf(buf, sizeof(buf),
1566                         " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1567                      string_append(&matches, buf);
1568                      string_append(&matches, "Edit</a>");
1569 #ifdef HAVE_ACCESS
1570                   }
1571                   else
1572                   {
1573                      string_append(&matches, " <strong>No write access.</strong>");
1574                   }
1575 #endif /* def HAVE_ACCESS */
1576                }
1577 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1578
1579                string_append(&matches, "</th></tr>\n");
1580
1581                hits = 0;
1582                b = b->next;
1583             }
1584          }
1585
1586          for (; (b != NULL) && (matches != NULL); b = b->next)
1587          {
1588             if (url_match(b->url, url_to_query))
1589             {
1590                string_append(&matches, "<tr><td>{");
1591                string_join  (&matches, actions_to_html(csp, b->action));
1592                string_append(&matches, " }<br>\n<code>");
1593                string_join  (&matches, html_encode(b->url->spec));
1594                string_append(&matches, "</code></td></tr>\n");
1595
1596                if (merge_current_action(action, b->action))
1597                {
1598                   freez(matches);
1599                   free_http_request(url_to_query);
1600                   free_current_action(action);
1601                   free_map(exports);
1602                   return JB_ERR_MEMORY;
1603                }
1604                hits++;
1605             }
1606          }
1607
1608          if (!hits)
1609          {
1610             string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1611          }
1612       }
1613       string_append(&matches, "</table>\n");
1614
1615       /*
1616        * XXX: Kludge to make sure the "Forward settings" section
1617        * shows what forward-override{} would do with the requested URL.
1618        * No one really cares how the CGI request would be forwarded
1619        * if it wasn't intercepted as CGI request in the first place.
1620        *
1621        * From here on the action bitmask will no longer reflect
1622        * the real url (http://config.privoxy.org/show-url-info?url=.*),
1623        * but luckily it's no longer required later on anyway.
1624        */
1625       free_current_action(csp->action);
1626       get_url_actions(csp, url_to_query);
1627
1628       /*
1629        * Fill in forwarding settings.
1630        *
1631        * The possibilities are:
1632        *  - no forwarding
1633        *  - http forwarding only
1634        *  - socks4(a) forwarding only
1635        *  - socks4(a) and http forwarding.
1636        *
1637        * XXX: Parts of this code could be reused for the
1638        * "forwarding-failed" template which currently doesn't
1639        * display the proxy port and an eventual second forwarder.
1640        */
1641       {
1642          const struct forward_spec *fwd = forward_url(csp, url_to_query);
1643
1644          if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1645          {
1646             if (!err) err = map_block_killer(exports, "socks-forwarder");
1647             if (!err) err = map_block_killer(exports, "http-forwarder");
1648          }
1649          else
1650          {
1651             char port[10]; /* We save proxy ports as int but need a string here */
1652
1653             if (!err) err = map_block_killer(exports, "no-forwarder");
1654
1655             if (fwd->gateway_host != NULL)
1656             {
1657                char *socks_type = NULL;
1658
1659                switch (fwd->type)
1660                {
1661                   case SOCKS_4:
1662                      socks_type = "socks4";
1663                      break;
1664                   case SOCKS_4A:
1665                      socks_type = "socks4a";
1666                      break;
1667                   case SOCKS_5:
1668                      socks_type = "socks5";
1669                      break;
1670                   case SOCKS_5T:
1671                      socks_type = "socks5t";
1672                      break;
1673                   default:
1674                      log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1675                }
1676
1677                if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1678                if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1679                snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1680                if (!err) err = map(exports, "gateway-port", 1, port, 1);
1681             }
1682             else
1683             {
1684                if (!err) err = map_block_killer(exports, "socks-forwarder");
1685             }
1686
1687             if (fwd->forward_host != NULL)
1688             {
1689                if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1690                snprintf(port, sizeof(port), "%d", fwd->forward_port);
1691                if (!err) err = map(exports, "forward-port", 1, port, 1);
1692             }
1693             else
1694             {
1695                if (!err) err = map_block_killer(exports, "http-forwarder");
1696             }
1697          }
1698       }
1699
1700       free_http_request(url_to_query);
1701
1702       if (err || matches == NULL)
1703       {
1704          free_current_action(action);
1705          free_map(exports);
1706          return JB_ERR_MEMORY;
1707       }
1708
1709 #ifdef FEATURE_CGI_EDIT_ACTIONS
1710       if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1711       {
1712          err = map_block_killer(exports, "cgi-editor-is-disabled");
1713       }
1714 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1715
1716       /*
1717        * If zlib support is available, if no content filters
1718        * are enabled or if the prevent-compression action is enabled,
1719        * suppress the "compression could prevent filtering" warning.
1720        */
1721 #ifndef FEATURE_ZLIB
1722       if (!content_filters_enabled(action) ||
1723          (action->flags & ACTION_NO_COMPRESSION))
1724 #endif
1725       {
1726          if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1727       }
1728
1729       if (err || map(exports, "matches", 1, matches , 0))
1730       {
1731          free_current_action(action);
1732          free_map(exports);
1733          return JB_ERR_MEMORY;
1734       }
1735
1736       s = current_action_to_html(csp, action);
1737
1738       free_current_action(action);
1739
1740       if (map(exports, "final", 1, s, 0))
1741       {
1742          free_map(exports);
1743          return JB_ERR_MEMORY;
1744       }
1745    }
1746
1747    return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1748 }
1749
1750
1751 /*********************************************************************
1752  *
1753  * Function    :  cgi_robots_txt
1754  *
1755  * Description :  CGI function to return "/robots.txt".
1756  *
1757  * Parameters  :
1758  *          1  :  csp = Current client state (buffers, headers, etc...)
1759  *          2  :  rsp = http_response data structure for output
1760  *          3  :  parameters = map of cgi parameters
1761  *
1762  * CGI Parameters : None
1763  *
1764  * Returns     :  JB_ERR_OK on success
1765  *                JB_ERR_MEMORY on out-of-memory error.
1766  *
1767  *********************************************************************/
1768 jb_err cgi_robots_txt(struct client_state *csp,
1769                       struct http_response *rsp,
1770                       const struct map *parameters)
1771 {
1772    char buf[100];
1773    jb_err err;
1774
1775    (void)csp;
1776    (void)parameters;
1777
1778    rsp->body = strdup_or_die(
1779       "# This is the Privoxy control interface.\n"
1780       "# It isn't very useful to index it, and you're likely to break stuff.\n"
1781       "# So go away!\n"
1782       "\n"
1783       "User-agent: *\n"
1784       "Disallow: /\n"
1785       "\n");
1786
1787    err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1788
1789    rsp->is_static = 1;
1790
1791    get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1792    if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1793
1794    return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1795 }
1796
1797
1798 /*********************************************************************
1799  *
1800  * Function    :  show_defines
1801  *
1802  * Description :  Add to a map the state of all conditional #defines
1803  *                used when building
1804  *
1805  * Parameters  :
1806  *          1  :  exports = map to extend
1807  *
1808  * Returns     :  JB_ERR_OK on success
1809  *                JB_ERR_MEMORY on out-of-memory error.
1810  *
1811  *********************************************************************/
1812 static jb_err show_defines(struct map *exports)
1813 {
1814    jb_err err = JB_ERR_OK;
1815    int i;
1816    struct feature {
1817       const char name[31];
1818       const unsigned char is_available;
1819    };
1820
1821    static const struct feature features[] = {
1822       {
1823          "FEATURE_64_BIT_TIME_T",
1824 #if (SIZEOF_TIME_T == 8)
1825          1,
1826 #else
1827          0,
1828 #endif
1829       },
1830       {
1831          "FEATURE_ACCEPT_FILTER",
1832 #ifdef FEATURE_ACCEPT_FILTER
1833          1,
1834 #else
1835          0,
1836 #endif
1837       },
1838       {
1839          "FEATURE_ACL",
1840 #ifdef FEATURE_ACL
1841          1,
1842 #else
1843          0,
1844 #endif
1845       },
1846       {
1847          "FEATURE_BROTLI",
1848 #ifdef FEATURE_BROTLI
1849          1,
1850 #else
1851          0,
1852 #endif
1853       },
1854       {
1855          "FEATURE_CGI_EDIT_ACTIONS",
1856 #ifdef FEATURE_CGI_EDIT_ACTIONS
1857          1,
1858 #else
1859          0,
1860 #endif
1861       },
1862       {
1863          "FEATURE_CLIENT_TAGS",
1864 #ifdef FEATURE_CLIENT_TAGS
1865          1,
1866 #else
1867          0,
1868 #endif
1869       },
1870       {
1871          "FEATURE_COMPRESSION",
1872 #ifdef FEATURE_COMPRESSION
1873          1,
1874 #else
1875          0,
1876 #endif
1877       },
1878       {
1879          "FEATURE_CONNECTION_KEEP_ALIVE",
1880 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1881          1,
1882 #else
1883          0,
1884 #endif
1885       },
1886       {
1887          "FEATURE_CONNECTION_SHARING",
1888 #ifdef FEATURE_CONNECTION_SHARING
1889          1,
1890 #else
1891          0,
1892 #endif
1893       },
1894       {
1895          "FEATURE_EXTERNAL_FILTERS",
1896 #ifdef FEATURE_EXTERNAL_FILTERS
1897          1,
1898 #else
1899          0,
1900 #endif
1901       },
1902       {
1903          "FEATURE_FAST_REDIRECTS",
1904 #ifdef FEATURE_FAST_REDIRECTS
1905          1,
1906 #else
1907          0,
1908 #endif
1909       },
1910       {
1911          "FEATURE_FORCE_LOAD",
1912 #ifdef FEATURE_FORCE_LOAD
1913          1,
1914 #else
1915          0,
1916 #endif
1917       },
1918       {
1919          "FEATURE_GRACEFUL_TERMINATION",
1920 #ifdef FEATURE_GRACEFUL_TERMINATION
1921          1,
1922 #else
1923          0,
1924 #endif
1925       },
1926       {
1927          "FEATURE_HTTPS_INSPECTION",
1928 #ifdef FEATURE_HTTPS_INSPECTION
1929          1,
1930 #else
1931          0,
1932 #endif
1933       },
1934       {
1935          "FEATURE_IMAGE_BLOCKING",
1936 #ifdef FEATURE_IMAGE_BLOCKING
1937          1,
1938 #else
1939          0,
1940 #endif
1941       },
1942       {
1943          "FEATURE_IPV6_SUPPORT",
1944 #ifdef HAVE_RFC2553
1945          1,
1946 #else
1947          0,
1948 #endif
1949       },
1950       {
1951          "FEATURE_NO_GIFS",
1952 #ifdef FEATURE_NO_GIFS
1953          1,
1954 #else
1955          0,
1956 #endif
1957       },
1958       {
1959          "FEATURE_PTHREAD",
1960 #ifdef FEATURE_PTHREAD
1961          1,
1962 #else
1963          0,
1964 #endif
1965       },
1966       {
1967          "FEATURE_STATISTICS",
1968 #ifdef FEATURE_STATISTICS
1969          1,
1970 #else
1971          0,
1972 #endif
1973       },
1974       {
1975          "FEATURE_STRPTIME_SANITY_CHECKS",
1976 #ifdef FEATURE_STRPTIME_SANITY_CHECKS
1977          1,
1978 #else
1979          0,
1980 #endif
1981       },
1982       {
1983          "FEATURE_TOGGLE",
1984 #ifdef FEATURE_TOGGLE
1985          1,
1986 #else
1987          0,
1988 #endif
1989       },
1990       {
1991          "FEATURE_TRUST",
1992 #ifdef FEATURE_TRUST
1993          1,
1994 #else
1995          0,
1996 #endif
1997       },
1998       {
1999          "FEATURE_ZLIB",
2000 #ifdef FEATURE_ZLIB
2001          1,
2002 #else
2003          0,
2004 #endif
2005       },
2006       {
2007          "FEATURE_DYNAMIC_PCRE",
2008 #ifdef FEATURE_DYNAMIC_PCRE
2009          1,
2010 #else
2011          0,
2012 #endif
2013       }
2014    };
2015
2016    for (i = 0; i < SZ(features); i++)
2017    {
2018       err = map_conditional(exports, features[i].name, features[i].is_available);
2019       if (err)
2020       {
2021          break;
2022       }
2023    }
2024
2025    return err;
2026
2027 }
2028
2029
2030 /*********************************************************************
2031  *
2032  * Function    :  cgi_show_file
2033  *
2034  * Description :  CGI function that shows the content of a
2035  *                configuration file.
2036  *
2037  * Parameters  :
2038  *          1  :  csp = Current client state (buffers, headers, etc...)
2039  *          2  :  rsp = http_response data structure for output
2040  *          3  :  parameters = map of cgi parameters
2041  *
2042  * CGI Parameters :
2043  *        file :  Which file to show.  Only first letter is checked,
2044  *                valid values are:
2045  *                - "a"ction file
2046  *                - "r"egex
2047  *                - "t"rust
2048  *                Default is to show menu and other information.
2049  *
2050  * Returns     :  JB_ERR_OK on success
2051  *                JB_ERR_MEMORY on out-of-memory error.
2052  *
2053  *********************************************************************/
2054 static jb_err cgi_show_file(struct client_state *csp,
2055                             struct http_response *rsp,
2056                             const struct map *parameters)
2057 {
2058    unsigned i;
2059    const char * filename = NULL;
2060    char * file_description = NULL;
2061
2062    assert(csp);
2063    assert(rsp);
2064    assert(parameters);
2065
2066    switch (*(lookup(parameters, "file")))
2067    {
2068    case 'a':
2069       if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2070       {
2071          filename = csp->actions_list[i]->filename;
2072          file_description = "Actions File";
2073       }
2074       break;
2075
2076    case 'f':
2077       if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2078       {
2079          filename = csp->rlist[i]->filename;
2080          file_description = "Filter File";
2081       }
2082       break;
2083
2084 #ifdef FEATURE_TRUST
2085    case 't':
2086       if (csp->tlist)
2087       {
2088          filename = csp->tlist->filename;
2089          file_description = "Trust File";
2090       }
2091       break;
2092 #endif /* def FEATURE_TRUST */
2093    }
2094
2095    if (NULL != filename)
2096    {
2097       struct map *exports;
2098       char *s;
2099       jb_err err;
2100       size_t length;
2101
2102       exports = default_exports(csp, "show-status");
2103       if (NULL == exports)
2104       {
2105          return JB_ERR_MEMORY;
2106       }
2107
2108       if (map(exports, "file-description", 1, file_description, 1)
2109         || map(exports, "filepath", 1, html_encode(filename), 0))
2110       {
2111          free_map(exports);
2112          return JB_ERR_MEMORY;
2113       }
2114
2115       err = load_file(filename, &s, &length);
2116       if (JB_ERR_OK != err)
2117       {
2118          if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2119          {
2120             free_map(exports);
2121             return JB_ERR_MEMORY;
2122          }
2123       }
2124       else
2125       {
2126          s = html_encode_and_free_original(s);
2127          if (NULL == s)
2128          {
2129             free_map(exports);
2130             return JB_ERR_MEMORY;
2131          }
2132
2133          if (map(exports, "contents", 1, s, 0))
2134          {
2135             free_map(exports);
2136             return JB_ERR_MEMORY;
2137          }
2138       }
2139
2140       return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2141    }
2142
2143    return JB_ERR_CGI_PARAMS;
2144 }
2145
2146
2147 /*********************************************************************
2148  *
2149  * Function    :  load_file
2150  *
2151  * Description :  Loads a file into a buffer.
2152  *
2153  * Parameters  :
2154  *          1  :  filename = Name of the file to be loaded.
2155  *          2  :  buffer   = Used to return the file's content.
2156  *          3  :  length   = Used to return the size of the file.
2157  *
2158  * Returns     :  JB_ERR_OK in case of success,
2159  *                JB_ERR_FILE in case of ordinary file loading errors
2160  *                            (fseek() and ftell() errors are fatal)
2161  *                JB_ERR_MEMORY in case of out-of-memory.
2162  *
2163  *********************************************************************/
2164 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2165 {
2166    FILE *fp;
2167    long ret;
2168    jb_err err = JB_ERR_OK;
2169
2170    fp = fopen(filename, "rb");
2171    if (NULL == fp)
2172    {
2173       log_error(LOG_LEVEL_ERROR, "Failed to open %s: %E", filename);
2174       return JB_ERR_FILE;
2175    }
2176
2177    /* Get file length */
2178    if (fseek(fp, 0, SEEK_END))
2179    {
2180       log_error(LOG_LEVEL_FATAL,
2181          "Unexpected error while fseek()ing to the end of %s: %E",
2182          filename);
2183    }
2184    ret = ftell(fp);
2185    if (-1 == ret)
2186    {
2187       log_error(LOG_LEVEL_FATAL,
2188          "Unexpected ftell() error while loading %s: %E",
2189          filename);
2190    }
2191    *length = (size_t)ret;
2192
2193    /* Go back to the beginning. */
2194    if (fseek(fp, 0, SEEK_SET))
2195    {
2196       log_error(LOG_LEVEL_FATAL,
2197          "Unexpected error while fseek()ing to the beginning of %s: %E",
2198          filename);
2199    }
2200
2201    *buffer = zalloc_or_die(*length + 1);
2202
2203    if (1 != fread(*buffer, *length, 1, fp))
2204    {
2205       /*
2206        * May theoretically happen if the file size changes between
2207        * fseek() and fread() because it's edited in-place. Privoxy
2208        * and common text editors don't do that, thus we just fail.
2209        */
2210       log_error(LOG_LEVEL_ERROR,
2211          "Couldn't completely read file %s.", filename);
2212       freez(*buffer);
2213       err = JB_ERR_FILE;
2214    }
2215
2216    fclose(fp);
2217
2218    return err;
2219
2220 }
2221
2222
2223 /*
2224   Local Variables:
2225   tab-width: 3
2226   end:
2227 */