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          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_block_reason_statistics_table
1038  *
1039  * Description :  Produces the block reason 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_block_reason_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    jb_err err = JB_ERR_OK;
1055
1056    statistics = strdup_or_die("");
1057
1058    /* Run through all action files. */
1059    for (i = 0; i < MAX_AF_FILES; i++)
1060    {
1061       struct url_actions *b;
1062       struct action_spec *last_action = NULL;
1063
1064       if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
1065       {
1066          /* Skip empty files */
1067          continue;
1068       }
1069
1070       /* Go through all the actions. */
1071       for (b = b->next; NULL != b; b = b->next)
1072       {
1073          if (last_action == b->action)
1074          {
1075             continue;
1076          }
1077          if ((b->action->add & ACTION_BLOCK))
1078          {
1079             unsigned long long count;
1080             const char *block_reason = b->action->string[ACTION_STRING_BLOCK];
1081             const char *encoded_block_reason = html_encode(block_reason);
1082
1083             if (encoded_block_reason == NULL)
1084             {
1085                freez(statistics);
1086                return NULL;
1087             }
1088             get_block_reason_count(block_reason, &count);
1089             snprintf(buf, sizeof(buf),
1090                "<tr><td>%s</td><td style=\"text-align: right\">%llu</td>\n",
1091                encoded_block_reason, count);
1092             freez(encoded_block_reason);
1093
1094             if (!err) err = string_append(&statistics, buf);
1095          }
1096          last_action = b->action;
1097       }
1098    }
1099
1100    return statistics;
1101
1102 }
1103
1104
1105 /*********************************************************************
1106  *
1107  * Function    :  get_filter_statistics_table
1108  *
1109  * Description :  Produces the filter statistic table content.
1110  *
1111  * Parameters  :
1112  *          1  :  csp = Current client state (buffers, headers, etc...)
1113  *
1114  * Returns     :  Pointer to the HTML statistic table content or
1115  *                NULL on out of memory
1116  *
1117  *********************************************************************/
1118 static char *get_filter_statistics_table(const struct client_state *csp)
1119 {
1120    char buf[BUFFER_SIZE];
1121    char *statistics;
1122    int i;
1123    struct file_list *fl;
1124    struct re_filterfile_spec *b;
1125    jb_err err = JB_ERR_OK;
1126
1127    statistics = strdup_or_die("");
1128
1129    for (i = 0; i < MAX_AF_FILES; i++)
1130    {
1131      fl = csp->rlist[i];
1132      if ((NULL == fl) || (NULL == fl->f))
1133      {
1134         /*
1135          * Either there are no filter files left or this
1136          * filter file just contains no valid filters.
1137          *
1138          * Continue to be sure we don't miss valid filter
1139          * files that are chained after empty or invalid ones.
1140          */
1141         continue;
1142      }
1143
1144      for (b = fl->f; b != NULL; b = b->next)
1145      {
1146         if (b->type == FT_CONTENT_FILTER)
1147         {
1148            unsigned long long executions;
1149            unsigned long long pages_modified;
1150            unsigned long long hits;
1151
1152            get_filter_statistics(b->name, &executions, &pages_modified, &hits);
1153            snprintf(buf, sizeof(buf),
1154               "<tr><td>%s</td><td style=\"text-align: right\">%llu</td>"
1155               "<td style=\"text-align: right\">%llu</td>"
1156               "<td style=\"text-align: right\">%llu</td><tr>\n",
1157               b->name, executions, pages_modified, hits);
1158
1159            if (!err) err = string_append(&statistics, buf);
1160         }
1161      }
1162    }
1163
1164    return statistics;
1165
1166 }
1167 #endif /* def FEATURE_EXTENDED_STATISTICS */
1168
1169
1170 /*********************************************************************
1171  *
1172  * Function    :  cgi_show_status
1173  *
1174  * Description :  CGI function that returns a web page describing the
1175  *                current status of Privoxy.
1176  *
1177  * Parameters  :
1178  *          1  :  csp = Current client state (buffers, headers, etc...)
1179  *          2  :  rsp = http_response data structure for output
1180  *          3  :  parameters = map of cgi parameters
1181  *
1182  * CGI Parameters :
1183  *        file :  Which file to show.  Only first letter is checked,
1184  *                valid values are:
1185  *                - "a"ction file
1186  *                - "r"egex
1187  *                - "t"rust
1188  *                Default is to show menu and other information.
1189  *
1190  * Returns     :  JB_ERR_OK on success
1191  *                JB_ERR_MEMORY on out-of-memory error.
1192  *
1193  *********************************************************************/
1194 jb_err cgi_show_status(struct client_state *csp,
1195                        struct http_response *rsp,
1196                        const struct map *parameters)
1197 {
1198    char *s = NULL;
1199    unsigned i;
1200    int j;
1201
1202    char buf[BUFFER_SIZE];
1203 #ifdef FEATURE_STATISTICS
1204    float perc_rej;   /* Percentage of http requests rejected */
1205    int local_urls_read;
1206    int local_urls_rejected;
1207 #endif /* ndef FEATURE_STATISTICS */
1208    jb_err err = JB_ERR_OK;
1209
1210    struct map *exports;
1211
1212    assert(csp);
1213    assert(rsp);
1214    assert(parameters);
1215
1216    if ('\0' != *(lookup(parameters, "file")))
1217    {
1218       return cgi_show_file(csp, rsp, parameters);
1219    }
1220
1221    if (NULL == (exports = default_exports(csp, "show-status")))
1222    {
1223       return JB_ERR_MEMORY;
1224    }
1225
1226    s = strdup("");
1227    for (j = 0; (s != NULL) && (j < Argc); j++)
1228    {
1229       if (!err) err = string_join  (&s, html_encode(Argv[j]));
1230       if (!err) err = string_append(&s, " ");
1231    }
1232    if (!err) err = map(exports, "invocation", 1, s, 0);
1233
1234    if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1235    if (!err) err = show_defines(exports);
1236
1237    if (err)
1238    {
1239       free_map(exports);
1240       return JB_ERR_MEMORY;
1241    }
1242
1243 #ifdef FEATURE_STATISTICS
1244    local_urls_read     = urls_read;
1245    local_urls_rejected = urls_rejected;
1246
1247    /*
1248     * Need to alter the stats not to include the fetch of this
1249     * page.
1250     *
1251     * Can't do following thread safely! doh!
1252     *
1253     * urls_read--;
1254     * urls_rejected--; * This will be incremented subsequently *
1255     */
1256
1257    if (local_urls_read == 0)
1258    {
1259       if (!err) err = map_block_killer(exports, "have-stats");
1260    }
1261    else
1262    {
1263       if (!err) err = map_block_killer(exports, "have-no-stats");
1264
1265       perc_rej = (float)local_urls_rejected * 100.0F /
1266             (float)local_urls_read;
1267
1268       snprintf(buf, sizeof(buf), "%d", local_urls_read);
1269       if (!err) err = map(exports, "requests-received", 1, buf, 1);
1270
1271       snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1272       if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1273
1274       snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1275       if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1276    }
1277
1278 #else /* ndef FEATURE_STATISTICS */
1279    if (!err) err = map_block_killer(exports, "statistics");
1280 #endif /* ndef FEATURE_STATISTICS */
1281
1282 #ifdef FEATURE_EXTENDED_STATISTICS
1283    {
1284       char *block_reason_statistics = get_block_reason_statistics_table(csp);
1285       if (block_reason_statistics != NULL)
1286       {
1287          if (!err) err = map(exports, "block-reason-statistics", 1, block_reason_statistics, 0);
1288       }
1289       else
1290       {
1291          if (!err) err = map_block_killer(exports, "extended-statistics");
1292       }
1293    }
1294    {
1295       char *filter_statistics = get_filter_statistics_table(csp);
1296       if (filter_statistics != NULL)
1297       {
1298          if (!err) err = map(exports, "filter-statistics", 1, filter_statistics, 0);
1299       }
1300       else
1301       {
1302          if (!err) err = map_block_killer(exports, "extended-statistics");
1303       }
1304    }
1305 #else /* ndef FEATURE_EXTENDED_STATISTICS */
1306    if (!err) err = map_block_killer(exports, "extended-statistics");
1307 #endif /* def FEATURE_EXTENDED_STATISTICS */
1308
1309    /*
1310     * List all action files in use, together with view and edit links,
1311     * except for standard.action, which should only be viewable. (Not
1312     * enforced in the editor itself)
1313     * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1314     */
1315    s = strdup("");
1316    for (i = 0; i < MAX_AF_FILES; i++)
1317    {
1318       if (csp->actions_list[i] != NULL)
1319       {
1320          if (!err) err = string_append(&s, "<tr><td>");
1321          if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1322          snprintf(buf, sizeof(buf),
1323             "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&amp;index=%u\">View</a>", i);
1324          if (!err) err = string_append(&s, buf);
1325
1326 #ifdef FEATURE_CGI_EDIT_ACTIONS
1327          if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1328             && (NULL != csp->config->actions_file_short[i]))
1329          {
1330 #ifdef HAVE_ACCESS
1331             if (access(csp->config->actions_file[i], W_OK) == 0)
1332             {
1333 #endif /* def HAVE_ACCESS */
1334                snprintf(buf, sizeof(buf), "&nbsp;&nbsp;<a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
1335                if (!err) err = string_append(&s, buf);
1336 #ifdef HAVE_ACCESS
1337             }
1338             else
1339             {
1340                if (!err) err = string_append(&s, "&nbsp;&nbsp;<strong>No write access.</strong>");
1341             }
1342 #endif /* def HAVE_ACCESS */
1343          }
1344 #endif
1345
1346          if (!err) err = string_append(&s, "</td></tr>\n");
1347       }
1348    }
1349    if (*s != '\0')
1350    {
1351       if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1352    }
1353    else
1354    {
1355       if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1356    }
1357
1358    /*
1359     * List all re_filterfiles in use, together with view options.
1360     * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1361     */
1362    s = strdup("");
1363    for (i = 0; i < MAX_AF_FILES; i++)
1364    {
1365       if (csp->rlist[i] != NULL)
1366       {
1367          if (!err) err = string_append(&s, "<tr><td>");
1368          if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1369          snprintf(buf, sizeof(buf),
1370             "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&amp;index=%u\">View</a>", i);
1371          if (!err) err = string_append(&s, buf);
1372          if (!err) err = string_append(&s, "</td></tr>\n");
1373       }
1374    }
1375    if (*s != '\0')
1376    {
1377       if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1378    }
1379    else
1380    {
1381       if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1382       if (!err) err = map_block_killer(exports, "have-filterfile");
1383       freez(s);
1384    }
1385
1386 #ifdef FEATURE_TRUST
1387    if (csp->tlist)
1388    {
1389       if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1390    }
1391    else
1392    {
1393       if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1394       if (!err) err = map_block_killer(exports, "have-trustfile");
1395    }
1396 #else
1397    if (!err) err = map_block_killer(exports, "trust-support");
1398 #endif /* ndef FEATURE_TRUST */
1399
1400 #ifdef FEATURE_CGI_EDIT_ACTIONS
1401    if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1402    {
1403       err = map_block_killer(exports, "cgi-editor-is-disabled");
1404    }
1405 #endif /* ndef CGI_EDIT_ACTIONS */
1406
1407    if (!err) err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
1408
1409    if (err)
1410    {
1411       free_map(exports);
1412       return JB_ERR_MEMORY;
1413    }
1414
1415    return template_fill_for_cgi(csp, "show-status", exports, rsp);
1416 }
1417
1418
1419 /*********************************************************************
1420  *
1421  * Function    :  cgi_show_url_info
1422  *
1423  * Description :  CGI function that determines and shows which actions
1424  *                Privoxy will perform for a given url, and which
1425  *                matches starting from the defaults have lead to that.
1426  *
1427  * Parameters  :
1428  *          1  :  csp = Current client state (buffers, headers, etc...)
1429  *          2  :  rsp = http_response data structure for output
1430  *          3  :  parameters = map of cgi parameters
1431  *
1432  * CGI Parameters :
1433  *            url : The url whose actions are to be determined.
1434  *                  If url is unset, the url-given conditional will be
1435  *                  set, so that all but the form can be suppressed in
1436  *                  the template.
1437  *
1438  * Returns     :  JB_ERR_OK on success
1439  *                JB_ERR_MEMORY on out-of-memory error.
1440  *
1441  *********************************************************************/
1442 jb_err cgi_show_url_info(struct client_state *csp,
1443                          struct http_response *rsp,
1444                          const struct map *parameters)
1445 {
1446    char *url_param;
1447    struct map *exports;
1448    char buf[150];
1449
1450    assert(csp);
1451    assert(rsp);
1452    assert(parameters);
1453
1454    if (NULL == (exports = default_exports(csp, "show-url-info")))
1455    {
1456       return JB_ERR_MEMORY;
1457    }
1458
1459    /*
1460     * Get the url= parameter (if present) and remove any leading/trailing spaces.
1461     */
1462    url_param = strdup_or_die(lookup(parameters, "url"));
1463    chomp(url_param);
1464
1465    /*
1466     * Handle prefixes.  4 possibilities:
1467     * 1) "http://" or "https://" prefix present and followed by URL - OK
1468     * 2) Only the "http://" or "https://" part is present, no URL - change
1469     *    to empty string so it will be detected later as "no URL".
1470     * 3) Parameter specified but doesn't start with "http(s?)://" - add a
1471     *    "http://" prefix.
1472     * 4) Parameter not specified or is empty string - let this fall through
1473     *    for now, next block of code will handle it.
1474     */
1475    if (0 == strncmp(url_param, "http://", 7))
1476    {
1477       if (url_param[7] == '\0')
1478       {
1479          /*
1480           * Empty URL (just prefix).
1481           * Make it totally empty so it's caught by the next if ()
1482           */
1483          url_param[0] = '\0';
1484       }
1485    }
1486    else if (0 == strncmp(url_param, "https://", 8))
1487    {
1488       if (url_param[8] == '\0')
1489       {
1490          /*
1491           * Empty URL (just prefix).
1492           * Make it totally empty so it's caught by the next if ()
1493           */
1494          url_param[0] = '\0';
1495       }
1496    }
1497    else if ((url_param[0] != '\0')
1498       && ((NULL == strstr(url_param, "://")
1499             || (strstr(url_param, "://") > strstr(url_param, "/")))))
1500    {
1501       /*
1502        * No prefix or at least no prefix before
1503        * the first slash - assume http://
1504        */
1505       char *url_param_prefixed = strdup_or_die("http://");
1506
1507       if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1508       {
1509          free_map(exports);
1510          return JB_ERR_MEMORY;
1511       }
1512       url_param = url_param_prefixed;
1513    }
1514
1515    /*
1516     * Hide "toggle off" warning if Privoxy is toggled on.
1517     */
1518    if (
1519 #ifdef FEATURE_TOGGLE
1520        (global_toggle_state == 1) &&
1521 #endif /* def FEATURE_TOGGLE */
1522        map_block_killer(exports, "privoxy-is-toggled-off")
1523       )
1524    {
1525       freez(url_param);
1526       free_map(exports);
1527       return JB_ERR_MEMORY;
1528    }
1529
1530    if (url_param[0] == '\0')
1531    {
1532       /* URL parameter not specified, display query form only. */
1533       free(url_param);
1534       if (map_block_killer(exports, "url-given")
1535         || map(exports, "url", 1, "", 1))
1536       {
1537          free_map(exports);
1538          return JB_ERR_MEMORY;
1539       }
1540    }
1541    else
1542    {
1543       /* Given a URL, so query it. */
1544       jb_err err;
1545       char *matches;
1546       char *s;
1547       int hits = 0;
1548       struct file_list *fl;
1549       struct url_actions *b;
1550       struct http_request url_to_query[1];
1551       struct current_action_spec action[1];
1552       int i;
1553
1554       if (map(exports, "url", 1, html_encode(url_param), 0))
1555       {
1556          free(url_param);
1557          free_map(exports);
1558          return JB_ERR_MEMORY;
1559       }
1560
1561       init_current_action(action);
1562
1563       if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1564       {
1565          free_current_action(action);
1566          free(url_param);
1567          free_map(exports);
1568          return JB_ERR_MEMORY;
1569       }
1570
1571       memset(url_to_query, '\0', sizeof(url_to_query));
1572       err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1573       assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1574
1575       free(url_param);
1576
1577       if (err == JB_ERR_MEMORY)
1578       {
1579          free_http_request(url_to_query);
1580          free_current_action(action);
1581          free_map(exports);
1582          return JB_ERR_MEMORY;
1583       }
1584       else if (err)
1585       {
1586          /* Invalid URL */
1587
1588          err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1589          if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1590          if (!err) err = map_block_killer(exports, "valid-url");
1591
1592          free_current_action(action);
1593          free_http_request(url_to_query);
1594
1595          if (err)
1596          {
1597             free_map(exports);
1598             return JB_ERR_MEMORY;
1599          }
1600
1601          return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1602       }
1603
1604       /*
1605        * We have a warning about SSL paths. Hide it for unencrypted sites
1606        * and unconditionally if https inspection is enabled.
1607        */
1608 #ifndef FEATURE_HTTPS_INSPECTION
1609       if (!url_to_query->ssl)
1610 #endif
1611       {
1612          if (map_block_killer(exports, "https-and-no-https-inspection"))
1613          {
1614             free_current_action(action);
1615             free_map(exports);
1616             free_http_request(url_to_query);
1617             return JB_ERR_MEMORY;
1618          }
1619       }
1620
1621       matches = strdup_or_die("<table summary=\"\" class=\"transparent\">");
1622
1623       for (i = 0; i < MAX_AF_FILES; i++)
1624       {
1625          if (NULL == csp->config->actions_file_short[i]
1626              || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1627
1628          b = NULL;
1629          hits = 1;
1630          if ((fl = csp->actions_list[i]) != NULL)
1631          {
1632             if ((b = fl->f) != NULL)
1633             {
1634                /* FIXME: Hardcoded HTML! */
1635                string_append(&matches, "<tr><th>In file: ");
1636                string_join  (&matches, html_encode(csp->config->actions_file_short[i]));
1637                snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&amp;index=%d\">", i);
1638                string_append(&matches, buf);
1639                string_append(&matches, "View</a>");
1640 #ifdef FEATURE_CGI_EDIT_ACTIONS
1641                if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1642                {
1643 #ifdef HAVE_ACCESS
1644                   if (access(csp->config->actions_file[i], W_OK) == 0)
1645                   {
1646 #endif /* def HAVE_ACCESS */
1647                      snprintf(buf, sizeof(buf),
1648                         " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1649                      string_append(&matches, buf);
1650                      string_append(&matches, "Edit</a>");
1651 #ifdef HAVE_ACCESS
1652                   }
1653                   else
1654                   {
1655                      string_append(&matches, " <strong>No write access.</strong>");
1656                   }
1657 #endif /* def HAVE_ACCESS */
1658                }
1659 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1660
1661                string_append(&matches, "</th></tr>\n");
1662
1663                hits = 0;
1664                b = b->next;
1665             }
1666          }
1667
1668          for (; (b != NULL) && (matches != NULL); b = b->next)
1669          {
1670             if (url_match(b->url, url_to_query))
1671             {
1672                string_append(&matches, "<tr><td>{");
1673                string_join  (&matches, actions_to_html(csp, b->action));
1674                string_append(&matches, " }<br>\n<code>");
1675                string_join  (&matches, html_encode(b->url->spec));
1676                string_append(&matches, "</code></td></tr>\n");
1677
1678                if (merge_current_action(action, b->action))
1679                {
1680                   freez(matches);
1681                   free_http_request(url_to_query);
1682                   free_current_action(action);
1683                   free_map(exports);
1684                   return JB_ERR_MEMORY;
1685                }
1686                hits++;
1687             }
1688          }
1689
1690          if (!hits)
1691          {
1692             string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1693          }
1694       }
1695       string_append(&matches, "</table>\n");
1696
1697       /*
1698        * XXX: Kludge to make sure the "Forward settings" section
1699        * shows what forward-override{} would do with the requested URL.
1700        * No one really cares how the CGI request would be forwarded
1701        * if it wasn't intercepted as CGI request in the first place.
1702        *
1703        * From here on the action bitmask will no longer reflect
1704        * the real url (http://config.privoxy.org/show-url-info?url=.*),
1705        * but luckily it's no longer required later on anyway.
1706        */
1707       free_current_action(csp->action);
1708       get_url_actions(csp, url_to_query);
1709
1710       /*
1711        * Fill in forwarding settings.
1712        *
1713        * The possibilities are:
1714        *  - no forwarding
1715        *  - http forwarding only
1716        *  - socks4(a) forwarding only
1717        *  - socks4(a) and http forwarding.
1718        *
1719        * XXX: Parts of this code could be reused for the
1720        * "forwarding-failed" template which currently doesn't
1721        * display the proxy port and an eventual second forwarder.
1722        */
1723       {
1724          const struct forward_spec *fwd = forward_url(csp, url_to_query);
1725
1726          if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1727          {
1728             if (!err) err = map_block_killer(exports, "socks-forwarder");
1729             if (!err) err = map_block_killer(exports, "http-forwarder");
1730          }
1731          else
1732          {
1733             char port[10]; /* We save proxy ports as int but need a string here */
1734
1735             if (!err) err = map_block_killer(exports, "no-forwarder");
1736
1737             if (fwd->gateway_host != NULL)
1738             {
1739                char *socks_type = NULL;
1740
1741                switch (fwd->type)
1742                {
1743                   case SOCKS_4:
1744                      socks_type = "socks4";
1745                      break;
1746                   case SOCKS_4A:
1747                      socks_type = "socks4a";
1748                      break;
1749                   case SOCKS_5:
1750                      socks_type = "socks5";
1751                      break;
1752                   case SOCKS_5T:
1753                      socks_type = "socks5t";
1754                      break;
1755                   default:
1756                      log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1757                }
1758
1759                if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1760                if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1761                snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1762                if (!err) err = map(exports, "gateway-port", 1, port, 1);
1763             }
1764             else
1765             {
1766                if (!err) err = map_block_killer(exports, "socks-forwarder");
1767             }
1768
1769             if (fwd->forward_host != NULL)
1770             {
1771                if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1772                snprintf(port, sizeof(port), "%d", fwd->forward_port);
1773                if (!err) err = map(exports, "forward-port", 1, port, 1);
1774             }
1775             else
1776             {
1777                if (!err) err = map_block_killer(exports, "http-forwarder");
1778             }
1779          }
1780       }
1781
1782       free_http_request(url_to_query);
1783
1784       if (err || matches == NULL)
1785       {
1786          free_current_action(action);
1787          free_map(exports);
1788          return JB_ERR_MEMORY;
1789       }
1790
1791 #ifdef FEATURE_CGI_EDIT_ACTIONS
1792       if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1793       {
1794          err = map_block_killer(exports, "cgi-editor-is-disabled");
1795       }
1796 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1797
1798       /*
1799        * If zlib support is available, if no content filters
1800        * are enabled or if the prevent-compression action is enabled,
1801        * suppress the "compression could prevent filtering" warning.
1802        */
1803 #ifndef FEATURE_ZLIB
1804       if (!content_filters_enabled(action) ||
1805          (action->flags & ACTION_NO_COMPRESSION))
1806 #endif
1807       {
1808          if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1809       }
1810
1811       if (err || map(exports, "matches", 1, matches , 0))
1812       {
1813          free_current_action(action);
1814          free_map(exports);
1815          return JB_ERR_MEMORY;
1816       }
1817
1818       s = current_action_to_html(csp, action);
1819
1820       free_current_action(action);
1821
1822       if (map(exports, "final", 1, s, 0))
1823       {
1824          free_map(exports);
1825          return JB_ERR_MEMORY;
1826       }
1827    }
1828
1829    return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1830 }
1831
1832
1833 /*********************************************************************
1834  *
1835  * Function    :  cgi_robots_txt
1836  *
1837  * Description :  CGI function to return "/robots.txt".
1838  *
1839  * Parameters  :
1840  *          1  :  csp = Current client state (buffers, headers, etc...)
1841  *          2  :  rsp = http_response data structure for output
1842  *          3  :  parameters = map of cgi parameters
1843  *
1844  * CGI Parameters : None
1845  *
1846  * Returns     :  JB_ERR_OK on success
1847  *                JB_ERR_MEMORY on out-of-memory error.
1848  *
1849  *********************************************************************/
1850 jb_err cgi_robots_txt(struct client_state *csp,
1851                       struct http_response *rsp,
1852                       const struct map *parameters)
1853 {
1854    char buf[100];
1855    jb_err err;
1856
1857    (void)csp;
1858    (void)parameters;
1859
1860    rsp->body = strdup_or_die(
1861       "# This is the Privoxy control interface.\n"
1862       "# It isn't very useful to index it, and you're likely to break stuff.\n"
1863       "# So go away!\n"
1864       "\n"
1865       "User-agent: *\n"
1866       "Disallow: /\n"
1867       "\n");
1868
1869    err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1870
1871    rsp->is_static = 1;
1872
1873    get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1874    if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1875
1876    return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1877 }
1878
1879
1880 /*********************************************************************
1881  *
1882  * Function    :  show_defines
1883  *
1884  * Description :  Add to a map the state of all conditional #defines
1885  *                used when building
1886  *
1887  * Parameters  :
1888  *          1  :  exports = map to extend
1889  *
1890  * Returns     :  JB_ERR_OK on success
1891  *                JB_ERR_MEMORY on out-of-memory error.
1892  *
1893  *********************************************************************/
1894 static jb_err show_defines(struct map *exports)
1895 {
1896    jb_err err = JB_ERR_OK;
1897    int i;
1898    struct feature {
1899       const char name[31];
1900       const unsigned char is_available;
1901    };
1902
1903    static const struct feature features[] = {
1904       {
1905          "FEATURE_64_BIT_TIME_T",
1906 #if (SIZEOF_TIME_T == 8)
1907          1,
1908 #else
1909          0,
1910 #endif
1911       },
1912       {
1913          "FEATURE_ACCEPT_FILTER",
1914 #ifdef FEATURE_ACCEPT_FILTER
1915          1,
1916 #else
1917          0,
1918 #endif
1919       },
1920       {
1921          "FEATURE_ACL",
1922 #ifdef FEATURE_ACL
1923          1,
1924 #else
1925          0,
1926 #endif
1927       },
1928       {
1929          "FEATURE_BROTLI",
1930 #ifdef FEATURE_BROTLI
1931          1,
1932 #else
1933          0,
1934 #endif
1935       },
1936       {
1937          "FEATURE_CGI_EDIT_ACTIONS",
1938 #ifdef FEATURE_CGI_EDIT_ACTIONS
1939          1,
1940 #else
1941          0,
1942 #endif
1943       },
1944       {
1945          "FEATURE_CLIENT_TAGS",
1946 #ifdef FEATURE_CLIENT_TAGS
1947          1,
1948 #else
1949          0,
1950 #endif
1951       },
1952       {
1953          "FEATURE_COMPRESSION",
1954 #ifdef FEATURE_COMPRESSION
1955          1,
1956 #else
1957          0,
1958 #endif
1959       },
1960       {
1961          "FEATURE_CONNECTION_KEEP_ALIVE",
1962 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1963          1,
1964 #else
1965          0,
1966 #endif
1967       },
1968       {
1969          "FEATURE_CONNECTION_SHARING",
1970 #ifdef FEATURE_CONNECTION_SHARING
1971          1,
1972 #else
1973          0,
1974 #endif
1975       },
1976       {
1977          "FEATURE_EXTERNAL_FILTERS",
1978 #ifdef FEATURE_EXTERNAL_FILTERS
1979          1,
1980 #else
1981          0,
1982 #endif
1983       },
1984       {
1985          "FEATURE_FAST_REDIRECTS",
1986 #ifdef FEATURE_FAST_REDIRECTS
1987          1,
1988 #else
1989          0,
1990 #endif
1991       },
1992       {
1993          "FEATURE_FORCE_LOAD",
1994 #ifdef FEATURE_FORCE_LOAD
1995          1,
1996 #else
1997          0,
1998 #endif
1999       },
2000       {
2001          "FEATURE_GRACEFUL_TERMINATION",
2002 #ifdef FEATURE_GRACEFUL_TERMINATION
2003          1,
2004 #else
2005          0,
2006 #endif
2007       },
2008       {
2009          "FEATURE_HTTPS_INSPECTION",
2010 #ifdef FEATURE_HTTPS_INSPECTION
2011          1,
2012 #else
2013          0,
2014 #endif
2015       },
2016       {
2017          "FEATURE_IMAGE_BLOCKING",
2018 #ifdef FEATURE_IMAGE_BLOCKING
2019          1,
2020 #else
2021          0,
2022 #endif
2023       },
2024       {
2025          "FEATURE_IPV6_SUPPORT",
2026 #ifdef HAVE_RFC2553
2027          1,
2028 #else
2029          0,
2030 #endif
2031       },
2032       {
2033          "FEATURE_NO_GIFS",
2034 #ifdef FEATURE_NO_GIFS
2035          1,
2036 #else
2037          0,
2038 #endif
2039       },
2040       {
2041          "FEATURE_PTHREAD",
2042 #ifdef FEATURE_PTHREAD
2043          1,
2044 #else
2045          0,
2046 #endif
2047       },
2048       {
2049          "FEATURE_STATISTICS",
2050 #ifdef FEATURE_STATISTICS
2051          1,
2052 #else
2053          0,
2054 #endif
2055       },
2056       {
2057          "FEATURE_STRPTIME_SANITY_CHECKS",
2058 #ifdef FEATURE_STRPTIME_SANITY_CHECKS
2059          1,
2060 #else
2061          0,
2062 #endif
2063       },
2064       {
2065          "FEATURE_TOGGLE",
2066 #ifdef FEATURE_TOGGLE
2067          1,
2068 #else
2069          0,
2070 #endif
2071       },
2072       {
2073          "FEATURE_TRUST",
2074 #ifdef FEATURE_TRUST
2075          1,
2076 #else
2077          0,
2078 #endif
2079       },
2080       {
2081          "FEATURE_ZLIB",
2082 #ifdef FEATURE_ZLIB
2083          1,
2084 #else
2085          0,
2086 #endif
2087       },
2088       {
2089          "FEATURE_DYNAMIC_PCRE",
2090 #ifdef FEATURE_DYNAMIC_PCRE
2091          1,
2092 #else
2093          0,
2094 #endif
2095       }
2096    };
2097
2098    for (i = 0; i < SZ(features); i++)
2099    {
2100       err = map_conditional(exports, features[i].name, features[i].is_available);
2101       if (err)
2102       {
2103          break;
2104       }
2105    }
2106
2107    return err;
2108
2109 }
2110
2111
2112 /*********************************************************************
2113  *
2114  * Function    :  cgi_show_file
2115  *
2116  * Description :  CGI function that shows the content of a
2117  *                configuration file.
2118  *
2119  * Parameters  :
2120  *          1  :  csp = Current client state (buffers, headers, etc...)
2121  *          2  :  rsp = http_response data structure for output
2122  *          3  :  parameters = map of cgi parameters
2123  *
2124  * CGI Parameters :
2125  *        file :  Which file to show.  Only first letter is checked,
2126  *                valid values are:
2127  *                - "a"ction file
2128  *                - "r"egex
2129  *                - "t"rust
2130  *                Default is to show menu and other information.
2131  *
2132  * Returns     :  JB_ERR_OK on success
2133  *                JB_ERR_MEMORY on out-of-memory error.
2134  *
2135  *********************************************************************/
2136 static jb_err cgi_show_file(struct client_state *csp,
2137                             struct http_response *rsp,
2138                             const struct map *parameters)
2139 {
2140    unsigned i;
2141    const char * filename = NULL;
2142    char * file_description = NULL;
2143
2144    assert(csp);
2145    assert(rsp);
2146    assert(parameters);
2147
2148    switch (*(lookup(parameters, "file")))
2149    {
2150    case 'a':
2151       if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2152       {
2153          filename = csp->actions_list[i]->filename;
2154          file_description = "Actions File";
2155       }
2156       break;
2157
2158    case 'f':
2159       if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2160       {
2161          filename = csp->rlist[i]->filename;
2162          file_description = "Filter File";
2163       }
2164       break;
2165
2166 #ifdef FEATURE_TRUST
2167    case 't':
2168       if (csp->tlist)
2169       {
2170          filename = csp->tlist->filename;
2171          file_description = "Trust File";
2172       }
2173       break;
2174 #endif /* def FEATURE_TRUST */
2175    }
2176
2177    if (NULL != filename)
2178    {
2179       struct map *exports;
2180       char *s;
2181       jb_err err;
2182       size_t length;
2183
2184       exports = default_exports(csp, "show-status");
2185       if (NULL == exports)
2186       {
2187          return JB_ERR_MEMORY;
2188       }
2189
2190       if (map(exports, "file-description", 1, file_description, 1)
2191         || map(exports, "filepath", 1, html_encode(filename), 0))
2192       {
2193          free_map(exports);
2194          return JB_ERR_MEMORY;
2195       }
2196
2197       err = load_file(filename, &s, &length);
2198       if (JB_ERR_OK != err)
2199       {
2200          if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2201          {
2202             free_map(exports);
2203             return JB_ERR_MEMORY;
2204          }
2205       }
2206       else
2207       {
2208          s = html_encode_and_free_original(s);
2209          if (NULL == s)
2210          {
2211             free_map(exports);
2212             return JB_ERR_MEMORY;
2213          }
2214
2215          if (map(exports, "contents", 1, s, 0))
2216          {
2217             free_map(exports);
2218             return JB_ERR_MEMORY;
2219          }
2220       }
2221
2222       return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2223    }
2224
2225    return JB_ERR_CGI_PARAMS;
2226 }
2227
2228
2229 /*********************************************************************
2230  *
2231  * Function    :  load_file
2232  *
2233  * Description :  Loads a file into a buffer.
2234  *
2235  * Parameters  :
2236  *          1  :  filename = Name of the file to be loaded.
2237  *          2  :  buffer   = Used to return the file's content.
2238  *          3  :  length   = Used to return the size of the file.
2239  *
2240  * Returns     :  JB_ERR_OK in case of success,
2241  *                JB_ERR_FILE in case of ordinary file loading errors
2242  *                            (fseek() and ftell() errors are fatal)
2243  *                JB_ERR_MEMORY in case of out-of-memory.
2244  *
2245  *********************************************************************/
2246 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2247 {
2248    FILE *fp;
2249    long ret;
2250    jb_err err = JB_ERR_OK;
2251
2252    fp = fopen(filename, "rb");
2253    if (NULL == fp)
2254    {
2255       log_error(LOG_LEVEL_ERROR, "Failed to open %s: %E", filename);
2256       return JB_ERR_FILE;
2257    }
2258
2259    /* Get file length */
2260    if (fseek(fp, 0, SEEK_END))
2261    {
2262       log_error(LOG_LEVEL_FATAL,
2263          "Unexpected error while fseek()ing to the end of %s: %E",
2264          filename);
2265    }
2266    ret = ftell(fp);
2267    if (-1 == ret)
2268    {
2269       log_error(LOG_LEVEL_FATAL,
2270          "Unexpected ftell() error while loading %s: %E",
2271          filename);
2272    }
2273    *length = (size_t)ret;
2274
2275    /* Go back to the beginning. */
2276    if (fseek(fp, 0, SEEK_SET))
2277    {
2278       log_error(LOG_LEVEL_FATAL,
2279          "Unexpected error while fseek()ing to the beginning of %s: %E",
2280          filename);
2281    }
2282
2283    *buffer = zalloc_or_die(*length + 1);
2284
2285    if (1 != fread(*buffer, *length, 1, fp))
2286    {
2287       /*
2288        * May theoretically happen if the file size changes between
2289        * fseek() and fread() because it's edited in-place. Privoxy
2290        * and common text editors don't do that, thus we just fail.
2291        */
2292       log_error(LOG_LEVEL_ERROR,
2293          "Couldn't completely read file %s.", filename);
2294       freez(*buffer);
2295       err = JB_ERR_FILE;
2296    }
2297
2298    fclose(fp);
2299
2300    return err;
2301
2302 }
2303
2304
2305 /*
2306   Local Variables:
2307   tab-width: 3
2308   end:
2309 */