cgisimple.c

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