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-2020 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          freez(client_tag_status);
 408          free_map(exports);
 409          return JB_ERR_MEMORY;
 410       }
 411    }
 412    else
 413    {
 414       err = map_block_killer(exports, "tags-expire");
 415       if (err != JB_ERR_OK)
 416       {
 417          freez(client_tag_status);
 418          return err;
 419       }
 420    }
 421
 422    if (map(exports, "client-tags", 1, client_tag_status, 0))
 423    {
 424       free_map(exports);
 425       return JB_ERR_MEMORY;
 426    }
 427
 428    if (map(exports, "client-ip-addr", 1, csp->client_address, 1))
 429    {
 430       free_map(exports);
 431       return JB_ERR_MEMORY;
 432    }
 433
 434    return template_fill_for_cgi(csp, "client-tags", exports, rsp);
 435 }
 436
 437
 438 /*********************************************************************
 439  *
 440  * Function    :  cgi_toggle_client_tag
 441  *
 442  * Description :  Toggles a client tag and redirects to the show-tags
 443  *                page
 444  *
 445  * Parameters  :
 446  *          1  :  csp = Current client state (buffers, headers, etc...)
 447  *          2  :  rsp = http_response data structure for output
 448  *          3  :  parameters = map of cgi parameters
 449  *
 450  * CGI Parameters : none
 451  *          1  :  tag = Name of the tag to enable or disable
 452  *          2  :  toggle-state = How to toggle the tag (0/1)
 453  *          3  :  expires = Set to 1 if the tag should be enabled
 454  *                          temporarily, otherwise set to 0
 455  *
 456  * Returns     :  JB_ERR_OK on success
 457  *                JB_ERR_MEMORY on out-of-memory error.
 458  *
 459  *********************************************************************/
 460 jb_err cgi_toggle_client_tag(struct client_state *csp,
 461                              struct http_response *rsp,
 462                              const struct map *parameters)
 463 {
 464    const char *toggled_tag;
 465    const char *toggle_state;
 466    const char *tag_expires;
 467    time_t time_to_live;
 468
 469    assert(csp);
 470    assert(rsp);
 471    assert(parameters);
 472
 473    toggled_tag = lookup(parameters, "tag");
 474    if (*toggled_tag == '\0')
 475    {
 476       log_error(LOG_LEVEL_ERROR, "Received tag toggle request without tag");
 477    }
 478    else
 479    {
 480       tag_expires = lookup(parameters, "expires");
 481       if (*tag_expires == '0')
 482       {
 483          time_to_live = 0;
 484       }
 485       else
 486       {
 487          time_to_live = csp->config->client_tag_lifetime;
 488       }
 489       toggle_state = lookup(parameters, "toggle-state");
 490       if (*toggle_state == '1')
 491       {
 492          enable_client_specific_tag(csp, toggled_tag, time_to_live);
 493       }
 494       else
 495       {
 496          disable_client_specific_tag(csp, toggled_tag);
 497       }
 498    }
 499    rsp->status = strdup_or_die("302 Done dealing with toggle request");
 500    if (enlist_unique_header(rsp->headers,
 501          "Location", CGI_PREFIX "client-tags"))
 502    {
 503          return JB_ERR_MEMORY;
 504    }
 505    return JB_ERR_OK;
 506
 507 }
 508 #endif /* def FEATURE_CLIENT_TAGS */
 509
 510
 511 /*********************************************************************
 512  *
 513  * Function    :  cgi_send_banner
 514  *
 515  * Description :  CGI function that returns a banner.
 516  *
 517  * Parameters  :
 518  *          1  :  csp = Current client state (buffers, headers, etc...)
 519  *          2  :  rsp = http_response data structure for output
 520  *          3  :  parameters = map of cgi parameters
 521  *
 522  * CGI Parameters :
 523  *           type : Selects the type of banner between "trans", "logo",
 524  *                  and "auto". Defaults to "logo" if absent or invalid.
 525  *                  "auto" means to select as if we were image-blocking.
 526  *                  (Only the first character really counts; b and t are
 527  *                  equivalent).
 528  *
 529  * Returns     :  JB_ERR_OK on success
 530  *                JB_ERR_MEMORY on out-of-memory error.
 531  *
 532  *********************************************************************/
 533 jb_err cgi_send_banner(struct client_state *csp,
 534                        struct http_response *rsp,
 535                        const struct map *parameters)
 536 {
 537    char imagetype = lookup(parameters, "type")[0];
 538
 539    /*
 540     * If type is auto, then determine the right thing
 541     * to do from the set-image-blocker action
 542     */
 543    if (imagetype == 'a')
 544    {
 545       /*
 546        * Default to pattern
 547        */
 548       imagetype = 'p';
 549
 550 #ifdef FEATURE_IMAGE_BLOCKING
 551       if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
 552       {
 553          static const char prefix1[] = CGI_PREFIX "send-banner?type=";
 554          static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
 555          const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
 556
 557          if (p == NULL)
 558          {
 559             /* Use default - nothing to do here. */
 560          }
 561          else if (0 == strcmpic(p, "blank"))
 562          {
 563             imagetype = 'b';
 564          }
 565          else if (0 == strcmpic(p, "pattern"))
 566          {
 567             imagetype = 'p';
 568          }
 569
 570          /*
 571           * If the action is to call this CGI, determine
 572           * the argument:
 573           */
 574          else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
 575          {
 576             imagetype = p[sizeof(prefix1) - 1];
 577          }
 578          else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
 579          {
 580             imagetype = p[sizeof(prefix2) - 1];
 581          }
 582
 583          /*
 584           * Everything else must (should) be a URL to
 585           * redirect to.
 586           */
 587          else
 588          {
 589             imagetype = 'r';
 590          }
 591       }
 592 #endif /* def FEATURE_IMAGE_BLOCKING */
 593    }
 594
 595    /*
 596     * Now imagetype is either the non-auto type we were called with,
 597     * or it was auto and has since been determined. In any case, we
 598     * can proceed to actually answering the request by sending a redirect
 599     * or an image as appropriate:
 600     */
 601    if (imagetype == 'r')
 602    {
 603       rsp->status = strdup_or_die("302 Local Redirect from Privoxy");
 604       if (enlist_unique_header(rsp->headers, "Location",
 605                                csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
 606       {
 607          return JB_ERR_MEMORY;
 608       }
 609    }
 610    else
 611    {
 612       if ((imagetype == 'b') || (imagetype == 't'))
 613       {
 614          rsp->body = bindup(image_blank_data, image_blank_length);
 615          rsp->content_length = image_blank_length;
 616       }
 617       else
 618       {
 619          rsp->body = bindup(image_pattern_data, image_pattern_length);
 620          rsp->content_length = image_pattern_length;
 621       }
 622
 623       if (rsp->body == NULL)
 624       {
 625          return JB_ERR_MEMORY;
 626       }
 627       if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
 628       {
 629          return JB_ERR_MEMORY;
 630       }
 631
 632       rsp->is_static = 1;
 633    }
 634
 635    return JB_ERR_OK;
 636
 637 }
 638
 639
 640 /*********************************************************************
 641  *
 642  * Function    :  cgi_transparent_image
 643  *
 644  * Description :  CGI function that sends a 1x1 transparent image.
 645  *
 646  * Parameters  :
 647  *          1  :  csp = Current client state (buffers, headers, etc...)
 648  *          2  :  rsp = http_response data structure for output
 649  *          3  :  parameters = map of cgi parameters
 650  *
 651  * CGI Parameters : None
 652  *
 653  * Returns     :  JB_ERR_OK on success
 654  *                JB_ERR_MEMORY on out-of-memory error.
 655  *
 656  *********************************************************************/
 657 jb_err cgi_transparent_image(struct client_state *csp,
 658                              struct http_response *rsp,
 659                              const struct map *parameters)
 660 {
 661    (void)csp;
 662    (void)parameters;
 663
 664    rsp->body = bindup(image_blank_data, image_blank_length);
 665    rsp->content_length = image_blank_length;
 666
 667    if (rsp->body == NULL)
 668    {
 669       return JB_ERR_MEMORY;
 670    }
 671
 672    if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
 673    {
 674       return JB_ERR_MEMORY;
 675    }
 676
 677    rsp->is_static = 1;
 678
 679    return JB_ERR_OK;
 680
 681 }
 682
 683
 684 /*********************************************************************
 685  *
 686  * Function    :  cgi_send_default_favicon
 687  *
 688  * Description :  CGI function that sends the standard favicon.
 689  *
 690  * Parameters  :
 691  *          1  :  csp = Current client state (buffers, headers, etc...)
 692  *          2  :  rsp = http_response data structure for output
 693  *          3  :  parameters = map of cgi parameters
 694  *
 695  * CGI Parameters : None
 696  *
 697  * Returns     :  JB_ERR_OK on success
 698  *                JB_ERR_MEMORY on out-of-memory error.
 699  *
 700  *********************************************************************/
 701 jb_err cgi_send_default_favicon(struct client_state *csp,
 702                                 struct http_response *rsp,
 703                                 const struct map *parameters)
 704 {
 705    static const char default_favicon_data[] =
 706       "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
 707       "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
 708       "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
 709       "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
 710       "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
 711       "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
 712       "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
 713       "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
 714       "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
 715       "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
 716       "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 717       "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 718       "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
 719       "\017\000\000";
 720    static const size_t favicon_length = sizeof(default_favicon_data) - 1;
 721
 722    (void)csp;
 723    (void)parameters;
 724
 725    rsp->body = bindup(default_favicon_data, favicon_length);
 726    rsp->content_length = favicon_length;
 727
 728    if (rsp->body == NULL)
 729    {
 730       return JB_ERR_MEMORY;
 731    }
 732
 733    if (enlist(rsp->headers, "Content-Type: image/x-icon"))
 734    {
 735       return JB_ERR_MEMORY;
 736    }
 737
 738    rsp->is_static = 1;
 739
 740    return JB_ERR_OK;
 741
 742 }
 743
 744
 745 /*********************************************************************
 746  *
 747  * Function    :  cgi_send_error_favicon
 748  *
 749  * Description :  CGI function that sends the favicon for error pages.
 750  *
 751  * Parameters  :
 752  *          1  :  csp = Current client state (buffers, headers, etc...)
 753  *          2  :  rsp = http_response data structure for output
 754  *          3  :  parameters = map of cgi parameters
 755  *
 756  * CGI Parameters : None
 757  *
 758  * Returns     :  JB_ERR_OK on success
 759  *                JB_ERR_MEMORY on out-of-memory error.
 760  *
 761  *********************************************************************/
 762 jb_err cgi_send_error_favicon(struct client_state *csp,
 763                               struct http_response *rsp,
 764                               const struct map *parameters)
 765 {
 766    static const char error_favicon_data[] =
 767       "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
 768       "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
 769       "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
 770       "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
 771       "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
 772       "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
 773       "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
 774       "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
 775       "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
 776       "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
 777       "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 778       "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
 779       "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
 780       "\017\000\000";
 781    static const size_t favicon_length = sizeof(error_favicon_data) - 1;
 782
 783    (void)csp;
 784    (void)parameters;
 785
 786    rsp->body = bindup(error_favicon_data, favicon_length);
 787    rsp->content_length = favicon_length;
 788
 789    if (rsp->body == NULL)
 790    {
 791       return JB_ERR_MEMORY;
 792    }
 793
 794    if (enlist(rsp->headers, "Content-Type: image/x-icon"))
 795    {
 796       return JB_ERR_MEMORY;
 797    }
 798
 799    rsp->is_static = 1;
 800
 801    return JB_ERR_OK;
 802
 803 }
 804
 805
 806 /*********************************************************************
 807  *
 808  * Function    :  cgi_send_stylesheet
 809  *
 810  * Description :  CGI function that sends a css stylesheet found
 811  *                in the cgi-style.css template
 812  *
 813  * Parameters  :
 814  *          1  :  csp = Current client state (buffers, headers, etc...)
 815  *          2  :  rsp = http_response data structure for output
 816  *          3  :  parameters = map of cgi parameters
 817  *
 818  * CGI Parameters : None
 819  *
 820  * Returns     :  JB_ERR_OK on success
 821  *                JB_ERR_MEMORY on out-of-memory error.
 822  *
 823  *********************************************************************/
 824 jb_err cgi_send_stylesheet(struct client_state *csp,
 825                            struct http_response *rsp,
 826                            const struct map *parameters)
 827 {
 828    jb_err err;
 829
 830    assert(csp);
 831    assert(rsp);
 832
 833    (void)parameters;
 834
 835    err = template_load(csp, &rsp->body, "cgi-style.css", 0);
 836
 837    if (err == JB_ERR_FILE)
 838    {
 839       /*
 840        * No way to tell user; send empty stylesheet
 841        */
 842       log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
 843    }
 844    else if (err)
 845    {
 846       return err; /* JB_ERR_MEMORY */
 847    }
 848
 849    if (enlist(rsp->headers, "Content-Type: text/css"))
 850    {
 851       return JB_ERR_MEMORY;
 852    }
 853
 854    return JB_ERR_OK;
 855
 856 }
 857
 858
 859 /*********************************************************************
 860  *
 861  * Function    :  cgi_send_url_info_osd
 862  *
 863  * Description :  CGI function that sends the OpenSearch Description
 864  *                template for the show-url-info page. It allows to
 865  *                access the page through "search engine plugins".
 866  *
 867  * Parameters  :
 868  *          1  :  csp = Current client state (buffers, headers, etc...)
 869  *          2  :  rsp = http_response data structure for output
 870  *          3  :  parameters = map of cgi parameters
 871  *
 872  * CGI Parameters : None
 873  *
 874  * Returns     :  JB_ERR_OK on success
 875  *                JB_ERR_MEMORY on out-of-memory error.
 876  *
 877  *********************************************************************/
 878 jb_err cgi_send_url_info_osd(struct client_state *csp,
 879                                struct http_response *rsp,
 880                                const struct map *parameters)
 881 {
 882    jb_err err = JB_ERR_MEMORY;
 883    struct map *exports = default_exports(csp, NULL);
 884
 885    (void)csp;
 886    (void)parameters;
 887
 888    if (NULL != exports)
 889    {
 890       err = template_fill_for_cgi(csp, "url-info-osd.xml", exports, rsp);
 891       if (JB_ERR_OK == err)
 892       {
 893          err = enlist(rsp->headers,
 894             "Content-Type: application/opensearchdescription+xml");
 895       }
 896    }
 897
 898    return err;
 899
 900 }
 901
 902
 903 /*********************************************************************
 904  *
 905  * Function    :  get_content_type
 906  *
 907  * Description :  Use the file extension to guess the content type
 908  *                header we should use to serve the file.
 909  *
 910  * Parameters  :
 911  *          1  :  filename = Name of the file whose content type
 912  *                           we care about
 913  *
 914  * Returns     :  The guessed content type.
 915  *
 916  *********************************************************************/
 917 static const char *get_content_type(const char *filename)
 918 {
 919    int i;
 920    struct content_type
 921    {
 922       const char extension[6];
 923       const char content_type[11];
 924    };
 925    static const struct content_type content_types[] =
 926    {
 927       {".css",  "text/css"},
 928       {".jpg",  "image/jpeg"},
 929       {".jpeg", "image/jpeg"},
 930       {".png",  "image/png"},
 931    };
 932
 933    for (i = 0; i < SZ(content_types); i++)
 934    {
 935       if (strstr(filename, content_types[i].extension))
 936       {
 937          return content_types[i].content_type;
 938       }
 939    }
 940
 941    /* No match by extension, default to html */
 942    return "text/html";
 943 }
 944
 945 /*********************************************************************
 946  *
 947  * Function    :  cgi_send_user_manual
 948  *
 949  * Description :  CGI function that sends a file in the user
 950  *                manual directory.
 951  *
 952  * Parameters  :
 953  *          1  :  csp = Current client state (buffers, headers, etc...)
 954  *          2  :  rsp = http_response data structure for output
 955  *          3  :  parameters = map of cgi parameters
 956  *
 957  * CGI Parameters : file=name.html, the name of the HTML file
 958  *                  (relative to user-manual from config)
 959  *
 960  * Returns     :  JB_ERR_OK on success
 961  *                JB_ERR_MEMORY on out-of-memory error.
 962  *
 963  *********************************************************************/
 964 jb_err cgi_send_user_manual(struct client_state *csp,
 965                             struct http_response *rsp,
 966                             const struct map *parameters)
 967 {
 968    const char *filename;
 969    char *full_path;
 970    jb_err err = JB_ERR_OK;
 971    const char *content_type;
 972
 973    assert(csp);
 974    assert(rsp);
 975    assert(parameters);
 976
 977    if (0 == strncmpic(csp->config->usermanual, "http://", 7))
 978    {
 979       log_error(LOG_LEVEL_CGI, "Request for local user-manual "
 980          "received while user-manual delivery is disabled.");
 981       return cgi_error_404(csp, rsp, parameters);
 982    }
 983
 984    if (!parameters->first)
 985    {
 986       /* requested http://p.p/user-manual (without trailing slash) */
 987       return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
 988    }
 989
 990    get_string_param(parameters, "file", &filename);
 991    if (filename == NULL)
 992    {
 993       /* It's '/' so serve the index.html if there is one.  */
 994       filename = "index.html";
 995    }
 996    else if (NULL != strchr(filename, '/') || NULL != strstr(filename, ".."))
 997    {
 998       /*
 999        * We currently only support a flat file
1000        * hierarchy for the documentation.
1001        */
1002       log_error(LOG_LEVEL_ERROR,
1003          "Rejecting the request to serve '%s' as it contains '/' or '..'",
1004          filename);
1005       return JB_ERR_CGI_PARAMS;
1006    }
1007
1008    full_path = make_path(csp->config->usermanual, filename);
1009    if (full_path == NULL)
1010    {
1011       return JB_ERR_MEMORY;
1012    }
1013
1014    err = load_file(full_path, &rsp->body, &rsp->content_length);
1015    if (JB_ERR_OK != err)
1016    {
1017       assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1018       if (JB_ERR_FILE == err)
1019       {
1020          err = cgi_error_no_template(csp, rsp, full_path);
1021       }
1022       freez(full_path);
1023       return err;
1024    }
1025    freez(full_path);
1026
1027    content_type = get_content_type(filename);
1028    log_error(LOG_LEVEL_CGI,
1029       "Content-Type guessed for %s: %s", filename, content_type);
1030
1031    return enlist_unique_header(rsp->headers, "Content-Type", content_type);
1032
1033 }
1034
1035
1036 #ifdef FEATURE_EXTENDED_STATISTICS
1037 /*********************************************************************
1038  *
1039  * Function    :  get_block_reason_statistics_table
1040  *
1041  * Description :  Produces the block reason statistic table content.
1042  *
1043  * Parameters  :
1044  *          1  :  csp = Current client state (buffers, headers, etc...)
1045  *
1046  * Returns     :  Pointer to the HTML statistic table content or
1047  *                NULL on out of memory
1048  *
1049  *********************************************************************/
1050 static char *get_block_reason_statistics_table(const struct client_state *csp)
1051 {
1052    char buf[BUFFER_SIZE];
1053    char *statistics;
1054    int i;
1055    struct file_list *fl;
1056    jb_err err = JB_ERR_OK;
1057
1058    statistics = strdup_or_die("");
1059
1060    /* Run through all action files. */
1061    for (i = 0; i < MAX_AF_FILES; i++)
1062    {
1063       struct url_actions *b;
1064       struct action_spec *last_action = NULL;
1065
1066       if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
1067       {
1068          /* Skip empty files */
1069          continue;
1070       }
1071
1072       /* Go through all the actions. */
1073       for (b = b->next; NULL != b; b = b->next)
1074       {
1075          if (last_action == b->action)
1076          {
1077             continue;
1078          }
1079          if ((b->action->add & ACTION_BLOCK))
1080          {
1081             unsigned long long count;
1082             const char *block_reason = b->action->string[ACTION_STRING_BLOCK];
1083             const char *encoded_block_reason = html_encode(block_reason);
1084
1085             if (encoded_block_reason == NULL)
1086             {
1087                freez(statistics);
1088                return NULL;
1089             }
1090             get_block_reason_count(block_reason, &count);
1091             snprintf(buf, sizeof(buf),
1092                "<tr><td>%s</td><td style=\"text-align: right\">%llu</td>\n",
1093                encoded_block_reason, count);
1094             freez(encoded_block_reason);
1095
1096             if (!err) err = string_append(&statistics, buf);
1097          }
1098          last_action = b->action;
1099       }
1100    }
1101
1102    return statistics;
1103
1104 }
1105
1106
1107 /*********************************************************************
1108  *
1109  * Function    :  get_filter_statistics_table
1110  *
1111  * Description :  Produces the filter statistic table content.
1112  *
1113  * Parameters  :
1114  *          1  :  csp = Current client state (buffers, headers, etc...)
1115  *
1116  * Returns     :  Pointer to the HTML statistic table content or
1117  *                NULL on out of memory
1118  *
1119  *********************************************************************/
1120 static char *get_filter_statistics_table(const struct client_state *csp)
1121 {
1122    char buf[BUFFER_SIZE];
1123    char *statistics;
1124    int i;
1125    struct file_list *fl;
1126    struct re_filterfile_spec *b;
1127    jb_err err = JB_ERR_OK;
1128
1129    statistics = strdup_or_die("");
1130
1131    for (i = 0; i < MAX_AF_FILES; i++)
1132    {
1133      fl = csp->rlist[i];
1134      if ((NULL == fl) || (NULL == fl->f))
1135      {
1136         /*
1137          * Either there are no filter files left or this
1138          * filter file just contains no valid filters.
1139          *
1140          * Continue to be sure we don't miss valid filter
1141          * files that are chained after empty or invalid ones.
1142          */
1143         continue;
1144      }
1145
1146      for (b = fl->f; b != NULL; b = b->next)
1147      {
1148         if (b->type == FT_CONTENT_FILTER)
1149         {
1150            unsigned long long executions;
1151            unsigned long long response_bodies_modified;
1152            unsigned long long hits;
1153
1154            get_filter_statistics(b->name, &executions, &response_bodies_modified, &hits);
1155            snprintf(buf, sizeof(buf),
1156               "<tr><td>%s</td><td style=\"text-align: right\">%llu</td>"
1157               "<td style=\"text-align: right\">%llu</td>"
1158               "<td style=\"text-align: right\">%llu</td><tr>\n",
1159               b->name, executions, response_bodies_modified, hits);
1160
1161            if (!err) err = string_append(&statistics, buf);
1162         }
1163      }
1164    }
1165
1166    return statistics;
1167
1168 }
1169 #endif /* def FEATURE_EXTENDED_STATISTICS */
1170
1171
1172 /*********************************************************************
1173  *
1174  * Function    :  cgi_show_status
1175  *
1176  * Description :  CGI function that returns a web page describing the
1177  *                current status of Privoxy.
1178  *
1179  * Parameters  :
1180  *          1  :  csp = Current client state (buffers, headers, etc...)
1181  *          2  :  rsp = http_response data structure for output
1182  *          3  :  parameters = map of cgi parameters
1183  *
1184  * CGI Parameters :
1185  *        file :  Which file to show.  Only first letter is checked,
1186  *                valid values are:
1187  *                - "a"ction file
1188  *                - "r"egex
1189  *                - "t"rust
1190  *                Default is to show menu and other information.
1191  *
1192  * Returns     :  JB_ERR_OK on success
1193  *                JB_ERR_MEMORY on out-of-memory error.
1194  *
1195  *********************************************************************/
1196 jb_err cgi_show_status(struct client_state *csp,
1197                        struct http_response *rsp,
1198                        const struct map *parameters)
1199 {
1200    char *s = NULL;
1201    unsigned i;
1202    int j;
1203
1204    char buf[BUFFER_SIZE];
1205 #ifdef FEATURE_STATISTICS
1206    float perc_rej;   /* Percentage of http requests rejected */
1207    int local_urls_read;
1208    int local_urls_rejected;
1209 #endif /* ndef FEATURE_STATISTICS */
1210    jb_err err = JB_ERR_OK;
1211
1212    struct map *exports;
1213
1214    assert(csp);
1215    assert(rsp);
1216    assert(parameters);
1217
1218    if ('\0' != *(lookup(parameters, "file")))
1219    {
1220       return cgi_show_file(csp, rsp, parameters);
1221    }
1222
1223    if (NULL == (exports = default_exports(csp, "show-status")))
1224    {
1225       return JB_ERR_MEMORY;
1226    }
1227
1228    s = strdup("");
1229    for (j = 0; (s != NULL) && (j < Argc); j++)
1230    {
1231       if (!err) err = string_join  (&s, html_encode(Argv[j]));
1232       if (!err) err = string_append(&s, " ");
1233    }
1234    if (!err) err = map(exports, "invocation", 1, s, 0);
1235
1236    if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1237    if (!err) err = show_defines(exports);
1238
1239    if (err)
1240    {
1241       free_map(exports);
1242       return JB_ERR_MEMORY;
1243    }
1244
1245 #ifdef FEATURE_STATISTICS
1246    local_urls_read     = urls_read;
1247    local_urls_rejected = urls_rejected;
1248
1249    /*
1250     * Need to alter the stats not to include the fetch of this
1251     * page.
1252     *
1253     * Can't do following thread safely! doh!
1254     *
1255     * urls_read--;
1256     * urls_rejected--; * This will be incremented subsequently *
1257     */
1258
1259    if (local_urls_read == 0)
1260    {
1261       if (!err) err = map_block_killer(exports, "have-stats");
1262    }
1263    else
1264    {
1265       if (!err) err = map_block_killer(exports, "have-no-stats");
1266
1267       perc_rej = (float)local_urls_rejected * 100.0F /
1268             (float)local_urls_read;
1269
1270       snprintf(buf, sizeof(buf), "%d", local_urls_read);
1271       if (!err) err = map(exports, "requests-received", 1, buf, 1);
1272
1273       snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1274       if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1275
1276       snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1277       if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1278    }
1279
1280 #else /* ndef FEATURE_STATISTICS */
1281    if (!err) err = map_block_killer(exports, "statistics");
1282 #endif /* ndef FEATURE_STATISTICS */
1283
1284 #ifdef FEATURE_EXTENDED_STATISTICS
1285    if (!err)
1286    {
1287       char *block_reason_statistics = get_block_reason_statistics_table(csp);
1288       if (block_reason_statistics != NULL)
1289       {
1290          err = map(exports, "block-reason-statistics", 1, block_reason_statistics, 0);
1291       }
1292       else
1293       {
1294          err = map_block_killer(exports, "extended-statistics");
1295       }
1296    }
1297    if (!err)
1298    {
1299       char *filter_statistics = get_filter_statistics_table(csp);
1300       if (filter_statistics != NULL)
1301       {
1302          err = map(exports, "filter-statistics", 1, filter_statistics, 0);
1303       }
1304       else
1305       {
1306          err = map_block_killer(exports, "extended-statistics");
1307       }
1308    }
1309 #else /* ndef FEATURE_EXTENDED_STATISTICS */
1310    if (!err) err = map_block_killer(exports, "extended-statistics");
1311 #endif /* def FEATURE_EXTENDED_STATISTICS */
1312
1313    /*
1314     * List all action files in use, together with view and edit links,
1315     * except for standard.action, which should only be viewable. (Not
1316     * enforced in the editor itself)
1317     * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1318     */
1319    s = strdup("");
1320    for (i = 0; i < MAX_AF_FILES; i++)
1321    {
1322       if (csp->actions_list[i] != NULL)
1323       {
1324          if (!err) err = string_append(&s, "<tr><td>");
1325          if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1326          snprintf(buf, sizeof(buf),
1327             "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&amp;index=%u\">View</a>", i);
1328          if (!err) err = string_append(&s, buf);
1329
1330 #ifdef FEATURE_CGI_EDIT_ACTIONS
1331          if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1332             && (NULL != csp->config->actions_file_short[i]))
1333          {
1334 #ifdef HAVE_ACCESS
1335             if (access(csp->config->actions_file[i], W_OK) == 0)
1336             {
1337 #endif /* def HAVE_ACCESS */
1338                snprintf(buf, sizeof(buf), "&nbsp;&nbsp;<a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
1339                if (!err) err = string_append(&s, buf);
1340 #ifdef HAVE_ACCESS
1341             }
1342             else
1343             {
1344                if (!err) err = string_append(&s, "&nbsp;&nbsp;<strong>No write access.</strong>");
1345             }
1346 #endif /* def HAVE_ACCESS */
1347          }
1348 #endif
1349
1350          if (!err) err = string_append(&s, "</td></tr>\n");
1351       }
1352    }
1353    if (!err && *s != '\0')
1354    {
1355       err = map(exports, "actions-filenames", 1, s, 0);
1356    }
1357    else
1358    {
1359       if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1360       freez(s);
1361    }
1362
1363    /*
1364     * List all re_filterfiles in use, together with view options.
1365     * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1366     */
1367    s = strdup("");
1368    for (i = 0; i < MAX_AF_FILES; i++)
1369    {
1370       if (csp->rlist[i] != NULL)
1371       {
1372          if (!err) err = string_append(&s, "<tr><td>");
1373          if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1374          snprintf(buf, sizeof(buf),
1375             "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&amp;index=%u\">View</a>", i);
1376          if (!err) err = string_append(&s, buf);
1377          if (!err) err = string_append(&s, "</td></tr>\n");
1378       }
1379    }
1380    if (!err && *s != '\0')
1381    {
1382       err = map(exports, "re-filter-filenames", 1, s, 0);
1383    }
1384    else
1385    {
1386       if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1387       if (!err) err = map_block_killer(exports, "have-filterfile");
1388       freez(s);
1389    }
1390
1391 #ifdef FEATURE_TRUST
1392    if (csp->tlist)
1393    {
1394       if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1395    }
1396    else
1397    {
1398       if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1399       if (!err) err = map_block_killer(exports, "have-trustfile");
1400    }
1401 #else
1402    if (!err) err = map_block_killer(exports, "trust-support");
1403 #endif /* ndef FEATURE_TRUST */
1404
1405 #ifdef FEATURE_CGI_EDIT_ACTIONS
1406    if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1407    {
1408       err = map_block_killer(exports, "cgi-editor-is-disabled");
1409    }
1410 #endif /* ndef CGI_EDIT_ACTIONS */
1411
1412    if (!err) err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
1413
1414    if (err)
1415    {
1416       free_map(exports);
1417       return JB_ERR_MEMORY;
1418    }
1419
1420    return template_fill_for_cgi(csp, "show-status", exports, rsp);
1421 }
1422
1423
1424 /*********************************************************************
1425  *
1426  * Function    :  cgi_show_url_info
1427  *
1428  * Description :  CGI function that determines and shows which actions
1429  *                Privoxy will perform for a given url, and which
1430  *                matches starting from the defaults have lead to that.
1431  *
1432  * Parameters  :
1433  *          1  :  csp = Current client state (buffers, headers, etc...)
1434  *          2  :  rsp = http_response data structure for output
1435  *          3  :  parameters = map of cgi parameters
1436  *
1437  * CGI Parameters :
1438  *            url : The url whose actions are to be determined.
1439  *                  If url is unset, the url-given conditional will be
1440  *                  set, so that all but the form can be suppressed in
1441  *                  the template.
1442  *
1443  * Returns     :  JB_ERR_OK on success
1444  *                JB_ERR_MEMORY on out-of-memory error.
1445  *
1446  *********************************************************************/
1447 jb_err cgi_show_url_info(struct client_state *csp,
1448                          struct http_response *rsp,
1449                          const struct map *parameters)
1450 {
1451    char *url_param;
1452    struct map *exports;
1453    char buf[150];
1454
1455    assert(csp);
1456    assert(rsp);
1457    assert(parameters);
1458
1459    if (NULL == (exports = default_exports(csp, "show-url-info")))
1460    {
1461       return JB_ERR_MEMORY;
1462    }
1463
1464    /*
1465     * Get the url= parameter (if present) and remove any leading/trailing spaces.
1466     */
1467    url_param = strdup_or_die(lookup(parameters, "url"));
1468    chomp(url_param);
1469
1470    /*
1471     * Handle prefixes.  4 possibilities:
1472     * 1) "http://" or "https://" prefix present and followed by URL - OK
1473     * 2) Only the "http://" or "https://" part is present, no URL - change
1474     *    to empty string so it will be detected later as "no URL".
1475     * 3) Parameter specified but doesn't start with "http(s?)://" - add a
1476     *    "http://" prefix.
1477     * 4) Parameter not specified or is empty string - let this fall through
1478     *    for now, next block of code will handle it.
1479     */
1480    if (0 == strncmp(url_param, "http://", 7))
1481    {
1482       if (url_param[7] == '\0')
1483       {
1484          /*
1485           * Empty URL (just prefix).
1486           * Make it totally empty so it's caught by the next if ()
1487           */
1488          url_param[0] = '\0';
1489       }
1490    }
1491    else if (0 == strncmp(url_param, "https://", 8))
1492    {
1493       if (url_param[8] == '\0')
1494       {
1495          /*
1496           * Empty URL (just prefix).
1497           * Make it totally empty so it's caught by the next if ()
1498           */
1499          url_param[0] = '\0';
1500       }
1501    }
1502    else if ((url_param[0] != '\0')
1503       && ((NULL == strstr(url_param, "://")
1504             || (strstr(url_param, "://") > strstr(url_param, "/")))))
1505    {
1506       /*
1507        * No prefix or at least no prefix before
1508        * the first slash - assume http://
1509        */
1510       char *url_param_prefixed = strdup_or_die("http://");
1511
1512       if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1513       {
1514          free_map(exports);
1515          return JB_ERR_MEMORY;
1516       }
1517       url_param = url_param_prefixed;
1518    }
1519
1520    /*
1521     * Hide "toggle off" warning if Privoxy is toggled on.
1522     */
1523    if (
1524 #ifdef FEATURE_TOGGLE
1525        (global_toggle_state == 1) &&
1526 #endif /* def FEATURE_TOGGLE */
1527        map_block_killer(exports, "privoxy-is-toggled-off")
1528       )
1529    {
1530       freez(url_param);
1531       free_map(exports);
1532       return JB_ERR_MEMORY;
1533    }
1534
1535    if (url_param[0] == '\0')
1536    {
1537       /* URL parameter not specified, display query form only. */
1538       free(url_param);
1539       if (map_block_killer(exports, "url-given")
1540         || map(exports, "url", 1, "", 1))
1541       {
1542          free_map(exports);
1543          return JB_ERR_MEMORY;
1544       }
1545    }
1546    else
1547    {
1548       /* Given a URL, so query it. */
1549       jb_err err;
1550       char *matches;
1551       char *s;
1552       int hits = 0;
1553       struct file_list *fl;
1554       struct url_actions *b;
1555       struct http_request url_to_query[1];
1556       struct current_action_spec action[1];
1557       int i;
1558
1559       if (map(exports, "url", 1, html_encode(url_param), 0))
1560       {
1561          free(url_param);
1562          free_map(exports);
1563          return JB_ERR_MEMORY;
1564       }
1565
1566       init_current_action(action);
1567
1568       if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1569       {
1570          free_current_action(action);
1571          free(url_param);
1572          free_map(exports);
1573          return JB_ERR_MEMORY;
1574       }
1575
1576       memset(url_to_query, '\0', sizeof(url_to_query));
1577       err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1578       assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1579
1580       free(url_param);
1581
1582       if (err == JB_ERR_MEMORY)
1583       {
1584          free_http_request(url_to_query);
1585          free_current_action(action);
1586          free_map(exports);
1587          return JB_ERR_MEMORY;
1588       }
1589       else if (err)
1590       {
1591          /* Invalid URL */
1592
1593          err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1594          if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1595          if (!err) err = map_block_killer(exports, "valid-url");
1596
1597          free_current_action(action);
1598          free_http_request(url_to_query);
1599
1600          if (err)
1601          {
1602             free_map(exports);
1603             return JB_ERR_MEMORY;
1604          }
1605
1606          return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1607       }
1608
1609       /*
1610        * We have a warning about SSL paths. Hide it for unencrypted sites
1611        * and unconditionally if https inspection is enabled.
1612        */
1613 #ifndef FEATURE_HTTPS_INSPECTION
1614       if (!url_to_query->ssl)
1615 #endif
1616       {
1617          if (map_block_killer(exports, "https-and-no-https-inspection"))
1618          {
1619             free_current_action(action);
1620             free_map(exports);
1621             free_http_request(url_to_query);
1622             return JB_ERR_MEMORY;
1623          }
1624       }
1625
1626       matches = strdup_or_die("<table summary=\"\" class=\"transparent\">");
1627
1628       for (i = 0; i < MAX_AF_FILES; i++)
1629       {
1630          if (NULL == csp->config->actions_file_short[i]
1631              || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1632
1633          b = NULL;
1634          hits = 1;
1635          if ((fl = csp->actions_list[i]) != NULL)
1636          {
1637             if ((b = fl->f) != NULL)
1638             {
1639                /* FIXME: Hardcoded HTML! */
1640                string_append(&matches, "<tr><th>In file: ");
1641                string_join  (&matches, html_encode(csp->config->actions_file_short[i]));
1642                snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&amp;index=%d\">", i);
1643                string_append(&matches, buf);
1644                string_append(&matches, "View</a>");
1645 #ifdef FEATURE_CGI_EDIT_ACTIONS
1646                if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1647                {
1648 #ifdef HAVE_ACCESS
1649                   if (access(csp->config->actions_file[i], W_OK) == 0)
1650                   {
1651 #endif /* def HAVE_ACCESS */
1652                      snprintf(buf, sizeof(buf),
1653                         " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1654                      string_append(&matches, buf);
1655                      string_append(&matches, "Edit</a>");
1656 #ifdef HAVE_ACCESS
1657                   }
1658                   else
1659                   {
1660                      string_append(&matches, " <strong>No write access.</strong>");
1661                   }
1662 #endif /* def HAVE_ACCESS */
1663                }
1664 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1665
1666                string_append(&matches, "</th></tr>\n");
1667
1668                hits = 0;
1669                b = b->next;
1670             }
1671          }
1672
1673          for (; (b != NULL) && (matches != NULL); b = b->next)
1674          {
1675             if (url_match(b->url, url_to_query))
1676             {
1677                string_append(&matches, "<tr><td>{");
1678                string_join  (&matches, actions_to_html(csp, b->action));
1679                string_append(&matches, " }<br>\n<code>");
1680                string_join  (&matches, html_encode(b->url->spec));
1681                string_append(&matches, "</code></td></tr>\n");
1682
1683                if (merge_current_action(action, b->action))
1684                {
1685                   freez(matches);
1686                   free_http_request(url_to_query);
1687                   free_current_action(action);
1688                   free_map(exports);
1689                   return JB_ERR_MEMORY;
1690                }
1691                hits++;
1692             }
1693          }
1694
1695          if (!hits)
1696          {
1697             string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1698          }
1699       }
1700       string_append(&matches, "</table>\n");
1701
1702       /*
1703        * XXX: Kludge to make sure the "Forward settings" section
1704        * shows what forward-override{} would do with the requested URL.
1705        * No one really cares how the CGI request would be forwarded
1706        * if it wasn't intercepted as CGI request in the first place.
1707        *
1708        * From here on the action bitmask will no longer reflect
1709        * the real url (http://config.privoxy.org/show-url-info?url=.*),
1710        * but luckily it's no longer required later on anyway.
1711        */
1712       free_current_action(csp->action);
1713       get_url_actions(csp, url_to_query);
1714
1715       /*
1716        * Fill in forwarding settings.
1717        *
1718        * The possibilities are:
1719        *  - no forwarding
1720        *  - http forwarding only
1721        *  - socks4(a) forwarding only
1722        *  - socks4(a) and http forwarding.
1723        *
1724        * XXX: Parts of this code could be reused for the
1725        * "forwarding-failed" template which currently doesn't
1726        * display the proxy port and an eventual second forwarder.
1727        */
1728       {
1729          const struct forward_spec *fwd = forward_url(csp, url_to_query);
1730
1731          if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1732          {
1733             if (!err) err = map_block_killer(exports, "socks-forwarder");
1734             if (!err) err = map_block_killer(exports, "http-forwarder");
1735          }
1736          else
1737          {
1738             char port[10]; /* We save proxy ports as int but need a string here */
1739
1740             if (!err) err = map_block_killer(exports, "no-forwarder");
1741
1742             if (fwd->gateway_host != NULL)
1743             {
1744                char *socks_type = NULL;
1745
1746                switch (fwd->type)
1747                {
1748                   case SOCKS_4:
1749                      socks_type = "socks4";
1750                      break;
1751                   case SOCKS_4A:
1752                      socks_type = "socks4a";
1753                      break;
1754                   case SOCKS_5:
1755                      socks_type = "socks5";
1756                      break;
1757                   case SOCKS_5T:
1758                      socks_type = "socks5t";
1759                      break;
1760                   default:
1761                      log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1762                }
1763
1764                if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1765                if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1766                snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1767                if (!err) err = map(exports, "gateway-port", 1, port, 1);
1768             }
1769             else
1770             {
1771                if (!err) err = map_block_killer(exports, "socks-forwarder");
1772             }
1773
1774             if (fwd->forward_host != NULL)
1775             {
1776                if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1777                snprintf(port, sizeof(port), "%d", fwd->forward_port);
1778                if (!err) err = map(exports, "forward-port", 1, port, 1);
1779             }
1780             else
1781             {
1782                if (!err) err = map_block_killer(exports, "http-forwarder");
1783             }
1784          }
1785       }
1786
1787       free_http_request(url_to_query);
1788
1789       if (err || matches == NULL)
1790       {
1791          free_current_action(action);
1792          free_map(exports);
1793          return JB_ERR_MEMORY;
1794       }
1795
1796 #ifdef FEATURE_CGI_EDIT_ACTIONS
1797       if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1798       {
1799          err = map_block_killer(exports, "cgi-editor-is-disabled");
1800       }
1801 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1802
1803       /*
1804        * If zlib support is available, if no content filters
1805        * are enabled or if the prevent-compression action is enabled,
1806        * suppress the "compression could prevent filtering" warning.
1807        */
1808 #ifndef FEATURE_ZLIB
1809       if (!content_filters_enabled(action) ||
1810          (action->flags & ACTION_NO_COMPRESSION))
1811 #endif
1812       {
1813          if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1814       }
1815
1816       if (err || map(exports, "matches", 1, matches , 0))
1817       {
1818          free_current_action(action);
1819          free_map(exports);
1820          return JB_ERR_MEMORY;
1821       }
1822
1823       s = current_action_to_html(csp, action);
1824
1825       free_current_action(action);
1826
1827       if (map(exports, "final", 1, s, 0))
1828       {
1829          free_map(exports);
1830          return JB_ERR_MEMORY;
1831       }
1832    }
1833
1834    return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1835 }
1836
1837
1838 /*********************************************************************
1839  *
1840  * Function    :  cgi_robots_txt
1841  *
1842  * Description :  CGI function to return "/robots.txt".
1843  *
1844  * Parameters  :
1845  *          1  :  csp = Current client state (buffers, headers, etc...)
1846  *          2  :  rsp = http_response data structure for output
1847  *          3  :  parameters = map of cgi parameters
1848  *
1849  * CGI Parameters : None
1850  *
1851  * Returns     :  JB_ERR_OK on success
1852  *                JB_ERR_MEMORY on out-of-memory error.
1853  *
1854  *********************************************************************/
1855 jb_err cgi_robots_txt(struct client_state *csp,
1856                       struct http_response *rsp,
1857                       const struct map *parameters)
1858 {
1859    char buf[100];
1860    jb_err err;
1861
1862    (void)csp;
1863    (void)parameters;
1864
1865    rsp->body = strdup_or_die(
1866       "# This is the Privoxy control interface.\n"
1867       "# It isn't very useful to index it, and you're likely to break stuff.\n"
1868       "# So go away!\n"
1869       "\n"
1870       "User-agent: *\n"
1871       "Disallow: /\n"
1872       "\n");
1873
1874    err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1875
1876    rsp->is_static = 1;
1877
1878    get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1879    if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1880
1881    return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1882 }
1883
1884
1885 /*********************************************************************
1886  *
1887  * Function    :  show_defines
1888  *
1889  * Description :  Add to a map the state of all conditional #defines
1890  *                used when building
1891  *
1892  * Parameters  :
1893  *          1  :  exports = map to extend
1894  *
1895  * Returns     :  JB_ERR_OK on success
1896  *                JB_ERR_MEMORY on out-of-memory error.
1897  *
1898  *********************************************************************/
1899 static jb_err show_defines(struct map *exports)
1900 {
1901    jb_err err = JB_ERR_OK;
1902    int i;
1903    struct feature {
1904       const char name[31];
1905       const unsigned char is_available;
1906    };
1907
1908    static const struct feature features[] = {
1909       {
1910          "FEATURE_64_BIT_TIME_T",
1911 #if (SIZEOF_TIME_T == 8)
1912          1,
1913 #else
1914          0,
1915 #endif
1916       },
1917       {
1918          "FEATURE_ACCEPT_FILTER",
1919 #ifdef FEATURE_ACCEPT_FILTER
1920          1,
1921 #else
1922          0,
1923 #endif
1924       },
1925       {
1926          "FEATURE_ACL",
1927 #ifdef FEATURE_ACL
1928          1,
1929 #else
1930          0,
1931 #endif
1932       },
1933       {
1934          "FEATURE_BROTLI",
1935 #ifdef FEATURE_BROTLI
1936          1,
1937 #else
1938          0,
1939 #endif
1940       },
1941       {
1942          "FEATURE_CGI_EDIT_ACTIONS",
1943 #ifdef FEATURE_CGI_EDIT_ACTIONS
1944          1,
1945 #else
1946          0,
1947 #endif
1948       },
1949       {
1950          "FEATURE_CLIENT_TAGS",
1951 #ifdef FEATURE_CLIENT_TAGS
1952          1,
1953 #else
1954          0,
1955 #endif
1956       },
1957       {
1958          "FEATURE_COMPRESSION",
1959 #ifdef FEATURE_COMPRESSION
1960          1,
1961 #else
1962          0,
1963 #endif
1964       },
1965       {
1966          "FEATURE_CONNECTION_KEEP_ALIVE",
1967 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1968          1,
1969 #else
1970          0,
1971 #endif
1972       },
1973       {
1974          "FEATURE_CONNECTION_SHARING",
1975 #ifdef FEATURE_CONNECTION_SHARING
1976          1,
1977 #else
1978          0,
1979 #endif
1980       },
1981       {
1982          "FEATURE_EXTERNAL_FILTERS",
1983 #ifdef FEATURE_EXTERNAL_FILTERS
1984          1,
1985 #else
1986          0,
1987 #endif
1988       },
1989       {
1990          "FEATURE_FAST_REDIRECTS",
1991 #ifdef FEATURE_FAST_REDIRECTS
1992          1,
1993 #else
1994          0,
1995 #endif
1996       },
1997       {
1998          "FEATURE_FORCE_LOAD",
1999 #ifdef FEATURE_FORCE_LOAD
2000          1,
2001 #else
2002          0,
2003 #endif
2004       },
2005       {
2006          "FEATURE_GRACEFUL_TERMINATION",
2007 #ifdef FEATURE_GRACEFUL_TERMINATION
2008          1,
2009 #else
2010          0,
2011 #endif
2012       },
2013       {
2014          "FEATURE_HTTPS_INSPECTION",
2015 #ifdef FEATURE_HTTPS_INSPECTION
2016          1,
2017 #else
2018          0,
2019 #endif
2020       },
2021       {
2022          "FEATURE_IMAGE_BLOCKING",
2023 #ifdef FEATURE_IMAGE_BLOCKING
2024          1,
2025 #else
2026          0,
2027 #endif
2028       },
2029       {
2030          "FEATURE_IPV6_SUPPORT",
2031 #ifdef HAVE_RFC2553
2032          1,
2033 #else
2034          0,
2035 #endif
2036       },
2037       {
2038          "FEATURE_NO_GIFS",
2039 #ifdef FEATURE_NO_GIFS
2040          1,
2041 #else
2042          0,
2043 #endif
2044       },
2045       {
2046          "FEATURE_PTHREAD",
2047 #ifdef FEATURE_PTHREAD
2048          1,
2049 #else
2050          0,
2051 #endif
2052       },
2053       {
2054          "FEATURE_STATISTICS",
2055 #ifdef FEATURE_STATISTICS
2056          1,
2057 #else
2058          0,
2059 #endif
2060       },
2061       {
2062          "FEATURE_STRPTIME_SANITY_CHECKS",
2063 #ifdef FEATURE_STRPTIME_SANITY_CHECKS
2064          1,
2065 #else
2066          0,
2067 #endif
2068       },
2069       {
2070          "FEATURE_TOGGLE",
2071 #ifdef FEATURE_TOGGLE
2072          1,
2073 #else
2074          0,
2075 #endif
2076       },
2077       {
2078          "FEATURE_TRUST",
2079 #ifdef FEATURE_TRUST
2080          1,
2081 #else
2082          0,
2083 #endif
2084       },
2085       {
2086          "FEATURE_ZLIB",
2087 #ifdef FEATURE_ZLIB
2088          1,
2089 #else
2090          0,
2091 #endif
2092       },
2093       {
2094          "FEATURE_DYNAMIC_PCRE",
2095 #ifdef FEATURE_DYNAMIC_PCRE
2096          1,
2097 #else
2098          0,
2099 #endif
2100       },
2101       {
2102          "FEATURE_EXTENDED_STATISTICS",
2103 #ifdef FEATURE_EXTENDED_STATISTICS
2104          1,
2105 #else
2106          0,
2107 #endif
2108       },
2109       {
2110          "FEATURE_PCRE_HOST_PATTERNS",
2111 #ifdef FEATURE_PCRE_HOST_PATTERNS
2112          1,
2113 #else
2114          0,
2115 #endif
2116       }
2117    };
2118
2119    for (i = 0; i < SZ(features); i++)
2120    {
2121       err = map_conditional(exports, features[i].name, features[i].is_available);
2122       if (err)
2123       {
2124          break;
2125       }
2126    }
2127
2128    return err;
2129
2130 }
2131
2132
2133 /*********************************************************************
2134  *
2135  * Function    :  cgi_show_file
2136  *
2137  * Description :  CGI function that shows the content of a
2138  *                configuration file.
2139  *
2140  * Parameters  :
2141  *          1  :  csp = Current client state (buffers, headers, etc...)
2142  *          2  :  rsp = http_response data structure for output
2143  *          3  :  parameters = map of cgi parameters
2144  *
2145  * CGI Parameters :
2146  *        file :  Which file to show.  Only first letter is checked,
2147  *                valid values are:
2148  *                - "a"ction file
2149  *                - "r"egex
2150  *                - "t"rust
2151  *                Default is to show menu and other information.
2152  *
2153  * Returns     :  JB_ERR_OK on success
2154  *                JB_ERR_MEMORY on out-of-memory error.
2155  *
2156  *********************************************************************/
2157 static jb_err cgi_show_file(struct client_state *csp,
2158                             struct http_response *rsp,
2159                             const struct map *parameters)
2160 {
2161    unsigned i;
2162    const char * filename = NULL;
2163    char * file_description = NULL;
2164
2165    assert(csp);
2166    assert(rsp);
2167    assert(parameters);
2168
2169    switch (*(lookup(parameters, "file")))
2170    {
2171    case 'a':
2172       if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2173       {
2174          filename = csp->actions_list[i]->filename;
2175          file_description = "Actions File";
2176       }
2177       break;
2178
2179    case 'f':
2180       if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2181       {
2182          filename = csp->rlist[i]->filename;
2183          file_description = "Filter File";
2184       }
2185       break;
2186
2187 #ifdef FEATURE_TRUST
2188    case 't':
2189       if (csp->tlist)
2190       {
2191          filename = csp->tlist->filename;
2192          file_description = "Trust File";
2193       }
2194       break;
2195 #endif /* def FEATURE_TRUST */
2196    }
2197
2198    if (NULL != filename)
2199    {
2200       struct map *exports;
2201       char *s;
2202       jb_err err;
2203       size_t length;
2204
2205       exports = default_exports(csp, "show-status");
2206       if (NULL == exports)
2207       {
2208          return JB_ERR_MEMORY;
2209       }
2210
2211       if (map(exports, "file-description", 1, file_description, 1)
2212         || map(exports, "filepath", 1, html_encode(filename), 0))
2213       {
2214          free_map(exports);
2215          return JB_ERR_MEMORY;
2216       }
2217
2218       err = load_file(filename, &s, &length);
2219       if (JB_ERR_OK != err)
2220       {
2221          if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2222          {
2223             free_map(exports);
2224             return JB_ERR_MEMORY;
2225          }
2226       }
2227       else
2228       {
2229          s = html_encode_and_free_original(s);
2230          if (NULL == s)
2231          {
2232             free_map(exports);
2233             return JB_ERR_MEMORY;
2234          }
2235
2236          if (map(exports, "contents", 1, s, 0))
2237          {
2238             free_map(exports);
2239             return JB_ERR_MEMORY;
2240          }
2241       }
2242
2243       return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2244    }
2245
2246    return JB_ERR_CGI_PARAMS;
2247 }
2248
2249
2250 /*********************************************************************
2251  *
2252  * Function    :  load_file
2253  *
2254  * Description :  Loads a file into a buffer.
2255  *
2256  * Parameters  :
2257  *          1  :  filename = Name of the file to be loaded.
2258  *          2  :  buffer   = Used to return the file's content.
2259  *          3  :  length   = Used to return the size of the file.
2260  *
2261  * Returns     :  JB_ERR_OK in case of success,
2262  *                JB_ERR_FILE in case of ordinary file loading errors
2263  *                            (fseek() and ftell() errors are fatal)
2264  *                JB_ERR_MEMORY in case of out-of-memory.
2265  *
2266  *********************************************************************/
2267 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2268 {
2269    FILE *fp;
2270    long ret;
2271    jb_err err = JB_ERR_OK;
2272
2273    fp = fopen(filename, "rb");
2274    if (NULL == fp)
2275    {
2276       log_error(LOG_LEVEL_ERROR, "Failed to open %s: %E", filename);
2277       return JB_ERR_FILE;
2278    }
2279
2280    /* Get file length */
2281    if (fseek(fp, 0, SEEK_END))
2282    {
2283       log_error(LOG_LEVEL_FATAL,
2284          "Unexpected error while fseek()ing to the end of %s: %E",
2285          filename);
2286    }
2287    ret = ftell(fp);
2288    if (-1 == ret)
2289    {
2290       log_error(LOG_LEVEL_FATAL,
2291          "Unexpected ftell() error while loading %s: %E",
2292          filename);
2293    }
2294    *length = (size_t)ret;
2295
2296    /* Go back to the beginning. */
2297    if (fseek(fp, 0, SEEK_SET))
2298    {
2299       log_error(LOG_LEVEL_FATAL,
2300          "Unexpected error while fseek()ing to the beginning of %s: %E",
2301          filename);
2302    }
2303
2304    *buffer = zalloc_or_die(*length + 1);
2305
2306    if (1 != fread(*buffer, *length, 1, fp))
2307    {
2308       /*
2309        * May theoretically happen if the file size changes between
2310        * fseek() and fread() because it's edited in-place. Privoxy
2311        * and common text editors don't do that, thus we just fail.
2312        */
2313       log_error(LOG_LEVEL_ERROR,
2314          "Couldn't completely read file %s.", filename);
2315       freez(*buffer);
2316       err = JB_ERR_FILE;
2317    }
2318
2319    fclose(fp);
2320
2321    return err;
2322
2323 }
2324
2325
2326 /*
2327   Local Variables:
2328   tab-width: 3
2329   end:
2330 */