cgisimple.c

   1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.103 2011/02/14 16:06: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    const char *content_type;
 728
 729    assert(csp);
 730    assert(rsp);
 731    assert(parameters);
 732
 733    if (0 == strncmpic(csp->config->usermanual, "http://", 7))
 734    {
 735       log_error(LOG_LEVEL_CGI, "Request for local user-manual "
 736          "received while user-manual delivery is disabled.");
 737       return cgi_error_404(csp, rsp, parameters);
 738    }
 739
 740    if (!parameters->first)
 741    {
 742       /* requested http://p.p/user-manual (without trailing slash) */
 743       return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
 744    }
 745
 746    get_string_param(parameters, "file", &filename);
 747    if (filename == NULL)
 748    {
 749       /* It's '/' so serve the index.html if there is one.  */
 750       filename = "index.html";
 751    }
 752    else if (NULL != strchr(filename, '/') || NULL != strstr(filename, ".."))
 753    {
 754       /*
 755        * We currently only support a flat file
 756        * hierachy for the documentation.
 757        */
 758       log_error(LOG_LEVEL_ERROR,
 759          "Rejecting the request to serve '%s' as it contains '/' or '..'",
 760          filename);
 761       return JB_ERR_CGI_PARAMS;
 762    }
 763
 764    full_path = make_path(csp->config->usermanual, filename);
 765    if (full_path == NULL)
 766    {
 767       return JB_ERR_MEMORY;
 768    }
 769
 770    err = load_file(full_path, &rsp->body, &rsp->content_length);
 771    if (JB_ERR_OK != err)
 772    {
 773       assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
 774       if (JB_ERR_FILE == err)
 775       {
 776          err = cgi_error_no_template(csp, rsp, full_path);
 777       }
 778       freez(full_path);
 779       return err;
 780    }
 781    freez(full_path);
 782
 783    content_type = get_content_type(filename);
 784    log_error(LOG_LEVEL_CGI,
 785       "Content-Type guessed for %s: %s", filename, content_type);
 786
 787    return enlist_unique_header(rsp->headers, "Content-Type", content_type);
 788
 789 }
 790
 791
 792 /*********************************************************************
 793  *
 794  * Function    :  cgi_show_version
 795  *
 796  * Description :  CGI function that returns a a web page describing the
 797  *                file versions of Privoxy.
 798  *
 799  * Parameters  :
 800  *          1  :  csp = Current client state (buffers, headers, etc...)
 801  *          2  :  rsp = http_response data structure for output
 802  *          3  :  parameters = map of cgi parameters
 803  *
 804  * CGI Parameters : none
 805  *
 806  * Returns     :  JB_ERR_OK on success
 807  *                JB_ERR_MEMORY on out-of-memory error.
 808  *
 809  *********************************************************************/
 810 jb_err cgi_show_version(struct client_state *csp,
 811                         struct http_response *rsp,
 812                         const struct map *parameters)
 813 {
 814    struct map *exports;
 815
 816    assert(csp);
 817    assert(rsp);
 818    assert(parameters);
 819
 820    if (NULL == (exports = default_exports(csp, "show-version")))
 821    {
 822       return JB_ERR_MEMORY;
 823    }
 824
 825    if (map(exports, "sourceversions", 1, show_rcs(), 0))
 826    {
 827       free_map(exports);
 828       return JB_ERR_MEMORY;
 829    }
 830
 831    return template_fill_for_cgi(csp, "show-version", exports, rsp);
 832 }
 833
 834
 835 /*********************************************************************
 836  *
 837  * Function    :  cgi_show_status
 838  *
 839  * Description :  CGI function that returns a web page describing the
 840  *                current status of Privoxy.
 841  *
 842  * Parameters  :
 843  *          1  :  csp = Current client state (buffers, headers, etc...)
 844  *          2  :  rsp = http_response data structure for output
 845  *          3  :  parameters = map of cgi parameters
 846  *
 847  * CGI Parameters :
 848  *        file :  Which file to show.  Only first letter is checked,
 849  *                valid values are:
 850  *                - "a"ction file
 851  *                - "r"egex
 852  *                - "t"rust
 853  *                Default is to show menu and other information.
 854  *
 855  * Returns     :  JB_ERR_OK on success
 856  *                JB_ERR_MEMORY on out-of-memory error.
 857  *
 858  *********************************************************************/
 859 jb_err cgi_show_status(struct client_state *csp,
 860                        struct http_response *rsp,
 861                        const struct map *parameters)
 862 {
 863    char *s = NULL;
 864    unsigned i;
 865    int j;
 866
 867    char buf[BUFFER_SIZE];
 868 #ifdef FEATURE_STATISTICS
 869    float perc_rej;   /* Percentage of http requests rejected */
 870    int local_urls_read;
 871    int local_urls_rejected;
 872 #endif /* ndef FEATURE_STATISTICS */
 873    jb_err err = JB_ERR_OK;
 874
 875    struct map *exports;
 876
 877    assert(csp);
 878    assert(rsp);
 879    assert(parameters);
 880
 881    if ('\0' != *(lookup(parameters, "file")))
 882    {
 883       return cgi_show_file(csp, rsp, parameters);
 884    }
 885
 886    if (NULL == (exports = default_exports(csp, "show-status")))
 887    {
 888       return JB_ERR_MEMORY;
 889    }
 890
 891    s = strdup("");
 892    for (j = 0; (s != NULL) && (j < Argc); j++)
 893    {
 894       if (!err) err = string_join  (&s, html_encode(Argv[j]));
 895       if (!err) err = string_append(&s, " ");
 896    }
 897    if (!err) err = map(exports, "invocation", 1, s, 0);
 898
 899    if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
 900    if (!err) err = show_defines(exports);
 901
 902    if (err)
 903    {
 904       free_map(exports);
 905       return JB_ERR_MEMORY;
 906    }
 907
 908 #ifdef FEATURE_STATISTICS
 909    local_urls_read     = urls_read;
 910    local_urls_rejected = urls_rejected;
 911
 912    /*
 913     * Need to alter the stats not to include the fetch of this
 914     * page.
 915     *
 916     * Can't do following thread safely! doh!
 917     *
 918     * urls_read--;
 919     * urls_rejected--; * This will be incremented subsequently *
 920     */
 921
 922    if (local_urls_read == 0)
 923    {
 924       if (!err) err = map_block_killer(exports, "have-stats");
 925    }
 926    else
 927    {
 928       if (!err) err = map_block_killer(exports, "have-no-stats");
 929
 930       perc_rej = (float)local_urls_rejected * 100.0F /
 931             (float)local_urls_read;
 932
 933       snprintf(buf, sizeof(buf), "%d", local_urls_read);
 934       if (!err) err = map(exports, "requests-received", 1, buf, 1);
 935
 936       snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
 937       if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
 938
 939       snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
 940       if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
 941    }
 942
 943 #else /* ndef FEATURE_STATISTICS */
 944    err = err || map_block_killer(exports, "statistics");
 945 #endif /* ndef FEATURE_STATISTICS */
 946
 947    /*
 948     * List all action files in use, together with view and edit links,
 949     * except for standard.action, which should only be viewable. (Not
 950     * enforced in the editor itself)
 951     * FIXME: Shouldn't include hardwired HTML here, use line template instead!
 952     */
 953    s = strdup("");
 954    for (i = 0; i < MAX_AF_FILES; i++)
 955    {
 956       if (csp->actions_list[i] != NULL)
 957       {
 958          if (!err) err = string_append(&s, "<tr><td>");
 959          if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
 960          snprintf(buf, sizeof(buf),
 961             "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&amp;index=%u\">View</a>", i);
 962          if (!err) err = string_append(&s, buf);
 963
 964 #ifdef FEATURE_CGI_EDIT_ACTIONS
 965          if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
 966             && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
 967             && (NULL != csp->config->actions_file_short[i]))
 968          {
 969 #ifdef HAVE_ACCESS
 970             if (access(csp->config->actions_file[i], W_OK) == 0)
 971             {
 972 #endif /* def HAVE_ACCESS */
 973                snprintf(buf, sizeof(buf), "&nbsp;&nbsp;<a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
 974                if (!err) err = string_append(&s, buf);
 975 #ifdef HAVE_ACCESS
 976             }
 977             else
 978             {
 979                if (!err) err = string_append(&s, "&nbsp;&nbsp;<strong>No write access.</strong>");
 980             }
 981 #endif /* def HAVE_ACCESS */
 982          }
 983 #endif
 984
 985          if (!err) err = string_append(&s, "</td></tr>\n");
 986       }
 987    }
 988    if (*s != '\0')
 989    {
 990       if (!err) err = map(exports, "actions-filenames", 1, s, 0);
 991    }
 992    else
 993    {
 994       if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
 995    }
 996
 997    /*
 998     * List all re_filterfiles in use, together with view options.
 999     * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1000     */
1001    s = strdup("");
1002    for (i = 0; i < MAX_AF_FILES; i++)
1003    {
1004       if (csp->rlist[i] != NULL)
1005       {
1006          if (!err) err = string_append(&s, "<tr><td>");
1007          if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1008          snprintf(buf, sizeof(buf),
1009             "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&amp;index=%u\">View</a>", i);
1010          if (!err) err = string_append(&s, buf);
1011          if (!err) err = string_append(&s, "</td></tr>\n");
1012       }
1013    }
1014    if (*s != '\0')
1015    {
1016       if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1017    }
1018    else
1019    {
1020       if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1021       if (!err) err = map_block_killer(exports, "have-filterfile");
1022    }
1023
1024 #ifdef FEATURE_TRUST
1025    if (csp->tlist)
1026    {
1027       if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1028    }
1029    else
1030    {
1031       if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1032       if (!err) err = map_block_killer(exports, "have-trustfile");
1033    }
1034 #else
1035    if (!err) err = map_block_killer(exports, "trust-support");
1036 #endif /* ndef FEATURE_TRUST */
1037
1038 #ifdef FEATURE_CGI_EDIT_ACTIONS
1039    if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1040    {
1041       err = map_block_killer(exports, "cgi-editor-is-disabled");
1042    }
1043 #endif /* ndef CGI_EDIT_ACTIONS */
1044
1045    if (err)
1046    {
1047       free_map(exports);
1048       return JB_ERR_MEMORY;
1049    }
1050
1051    return template_fill_for_cgi(csp, "show-status", exports, rsp);
1052 }
1053
1054
1055 /*********************************************************************
1056  *
1057  * Function    :  cgi_show_url_info
1058  *
1059  * Description :  CGI function that determines and shows which actions
1060  *                Privoxy will perform for a given url, and which
1061  *                matches starting from the defaults have lead to that.
1062  *
1063  * Parameters  :
1064  *          1  :  csp = Current client state (buffers, headers, etc...)
1065  *          2  :  rsp = http_response data structure for output
1066  *          3  :  parameters = map of cgi parameters
1067  *
1068  * CGI Parameters :
1069  *            url : The url whose actions are to be determined.
1070  *                  If url is unset, the url-given conditional will be
1071  *                  set, so that all but the form can be suppressed in
1072  *                  the template.
1073  *
1074  * Returns     :  JB_ERR_OK on success
1075  *                JB_ERR_MEMORY on out-of-memory error.
1076  *
1077  *********************************************************************/
1078 jb_err cgi_show_url_info(struct client_state *csp,
1079                          struct http_response *rsp,
1080                          const struct map *parameters)
1081 {
1082    char *url_param;
1083    struct map *exports;
1084    char buf[150];
1085
1086    assert(csp);
1087    assert(rsp);
1088    assert(parameters);
1089
1090    if (NULL == (exports = default_exports(csp, "show-url-info")))
1091    {
1092       return JB_ERR_MEMORY;
1093    }
1094
1095    /*
1096     * Get the url= parameter (if present) and remove any leading/trailing spaces.
1097     */
1098    url_param = strdup(lookup(parameters, "url"));
1099    if (url_param == NULL)
1100    {
1101       free_map(exports);
1102       return JB_ERR_MEMORY;
1103    }
1104    chomp(url_param);
1105
1106    /*
1107     * Handle prefixes.  4 possibilities:
1108     * 1) "http://" or "https://" prefix present and followed by URL - OK
1109     * 2) Only the "http://" or "https://" part is present, no URL - change
1110     *    to empty string so it will be detected later as "no URL".
1111     * 3) Parameter specified but doesn't start with "http(s?)://" - add a
1112     *    "http://" prefix.
1113     * 4) Parameter not specified or is empty string - let this fall through
1114     *    for now, next block of code will handle it.
1115     */
1116    if (0 == strncmp(url_param, "http://", 7))
1117    {
1118       if (url_param[7] == '\0')
1119       {
1120          /*
1121           * Empty URL (just prefix).
1122           * Make it totally empty so it's caught by the next if()
1123           */
1124          url_param[0] = '\0';
1125       }
1126    }
1127    else if (0 == strncmp(url_param, "https://", 8))
1128    {
1129       if (url_param[8] == '\0')
1130       {
1131          /*
1132           * Empty URL (just prefix).
1133           * Make it totally empty so it's caught by the next if()
1134           */
1135          url_param[0] = '\0';
1136       }
1137    }
1138    else if ((url_param[0] != '\0')
1139       && ((NULL == strstr(url_param, "://")
1140             || (strstr(url_param, "://") > strstr(url_param, "/")))))
1141    {
1142       /*
1143        * No prefix or at least no prefix before
1144        * the first slash - assume http://
1145        */
1146       char *url_param_prefixed = strdup("http://");
1147
1148       if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1149       {
1150          free_map(exports);
1151          return JB_ERR_MEMORY;
1152       }
1153       url_param = url_param_prefixed;
1154    }
1155
1156    /*
1157     * Hide "toggle off" warning if Privoxy is toggled on.
1158     */
1159    if (
1160 #ifdef FEATURE_TOGGLE
1161        (global_toggle_state == 1) &&
1162 #endif /* def FEATURE_TOGGLE */
1163        map_block_killer(exports, "privoxy-is-toggled-off")
1164       )
1165    {
1166       free_map(exports);
1167       return JB_ERR_MEMORY;
1168    }
1169
1170    if (url_param[0] == '\0')
1171    {
1172       /* URL paramater not specified, display query form only. */
1173       free(url_param);
1174       if (map_block_killer(exports, "url-given")
1175         || map(exports, "url", 1, "", 1))
1176       {
1177          free_map(exports);
1178          return JB_ERR_MEMORY;
1179       }
1180    }
1181    else
1182    {
1183       /* Given a URL, so query it. */
1184       jb_err err;
1185       char *matches;
1186       char *s;
1187       int hits = 0;
1188       struct file_list *fl;
1189       struct url_actions *b;
1190       struct http_request url_to_query[1];
1191       struct current_action_spec action[1];
1192       int i;
1193
1194       if (map(exports, "url", 1, html_encode(url_param), 0))
1195       {
1196          free(url_param);
1197          free_map(exports);
1198          return JB_ERR_MEMORY;
1199       }
1200
1201       init_current_action(action);
1202
1203       if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1204       {
1205          free_current_action(action);
1206          free(url_param);
1207          free_map(exports);
1208          return JB_ERR_MEMORY;
1209       }
1210
1211       memset(url_to_query, '\0', sizeof(url_to_query));
1212       err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1213       assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1214
1215       free(url_param);
1216
1217       if (err == JB_ERR_MEMORY)
1218       {
1219          free_http_request(url_to_query);
1220          free_current_action(action);
1221          free_map(exports);
1222          return JB_ERR_MEMORY;
1223       }
1224       else if (err)
1225       {
1226          /* Invalid URL */
1227
1228          err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1229          if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1230          if (!err) err = map_block_killer(exports, "valid-url");
1231
1232          free_current_action(action);
1233          free_http_request(url_to_query);
1234
1235          if (err)
1236          {
1237             free_map(exports);
1238             return JB_ERR_MEMORY;
1239          }
1240
1241          return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1242       }
1243
1244       /*
1245        * We have a warning about SSL paths.  Hide it for unencrypted sites.
1246        */
1247       if (!url_to_query->ssl)
1248       {
1249          if (map_block_killer(exports, "https"))
1250          {
1251             free_current_action(action);
1252             free_map(exports);
1253             free_http_request(url_to_query);
1254             return JB_ERR_MEMORY;
1255          }
1256       }
1257
1258       matches = strdup("<table summary=\"\" class=\"transparent\">");
1259
1260       for (i = 0; i < MAX_AF_FILES; i++)
1261       {
1262          if (NULL == csp->config->actions_file_short[i]
1263              || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1264
1265          b = NULL;
1266          hits = 1;
1267          if ((fl = csp->actions_list[i]) != NULL)
1268          {
1269             if ((b = fl->f) != NULL)
1270             {
1271                /* FIXME: Hardcoded HTML! */
1272                string_append(&matches, "<tr><th>In file: ");
1273                string_join  (&matches, html_encode(csp->config->actions_file_short[i]));
1274                snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&amp;index=%d\">", i);
1275                string_append(&matches, buf);
1276                string_append(&matches, "View</a>");
1277 #ifdef FEATURE_CGI_EDIT_ACTIONS
1278                if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1279                {
1280 #ifdef HAVE_ACCESS
1281                   if (access(csp->config->actions_file[i], W_OK) == 0)
1282                   {
1283 #endif /* def HAVE_ACCESS */
1284                      snprintf(buf, sizeof(buf),
1285                         " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1286                      string_append(&matches, buf);
1287                      string_append(&matches, "Edit</a>");
1288 #ifdef HAVE_ACCESS
1289                   }
1290                   else
1291                   {
1292                      string_append(&matches, " <strong>No write access.</strong>");
1293                   }
1294 #endif /* def HAVE_ACCESS */
1295                }
1296 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1297
1298                string_append(&matches, "</th></tr>\n");
1299
1300                hits = 0;
1301                b = b->next;
1302             }
1303          }
1304
1305          for (; (b != NULL) && (matches != NULL); b = b->next)
1306          {
1307             if (url_match(b->url, url_to_query))
1308             {
1309                string_append(&matches, "<tr><td>{");
1310                string_join  (&matches, actions_to_html(csp, b->action));
1311                string_append(&matches, " }<br>\n<code>");
1312                string_join  (&matches, html_encode(b->url->spec));
1313                string_append(&matches, "</code></td></tr>\n");
1314
1315                if (merge_current_action(action, b->action))
1316                {
1317                   freez(matches);
1318                   free_http_request(url_to_query);
1319                   free_current_action(action);
1320                   free_map(exports);
1321                   return JB_ERR_MEMORY;
1322                }
1323                hits++;
1324             }
1325          }
1326
1327          if (!hits)
1328          {
1329             string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1330          }
1331       }
1332       string_append(&matches, "</table>\n");
1333
1334       /*
1335        * XXX: Kludge to make sure the "Forward settings" section
1336        * shows what forward-override{} would do with the requested URL.
1337        * No one really cares how the CGI request would be forwarded
1338        * if it wasn't intercepted as CGI request in the first place.
1339        *
1340        * From here on the action bitmask will no longer reflect
1341        * the real url (http://config.privoxy.org/show-url-info?url=.*),
1342        * but luckily it's no longer required later on anyway.
1343        */
1344       free_current_action(csp->action);
1345       get_url_actions(csp, url_to_query);
1346
1347       /*
1348        * Fill in forwarding settings.
1349        *
1350        * The possibilities are:
1351        *  - no forwarding
1352        *  - http forwarding only
1353        *  - socks4(a) forwarding only
1354        *  - socks4(a) and http forwarding.
1355        *
1356        * XXX: Parts of this code could be reused for the
1357        * "forwarding-failed" template which currently doesn't
1358        * display the proxy port and an eventual second forwarder.
1359        */
1360       {
1361          const struct forward_spec *fwd = forward_url(csp, url_to_query);
1362
1363          if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1364          {
1365             if (!err) err = map_block_killer(exports, "socks-forwarder");
1366             if (!err) err = map_block_killer(exports, "http-forwarder");
1367          }
1368          else
1369          {
1370             char port[10]; /* We save proxy ports as int but need a string here */
1371
1372             if (!err) err = map_block_killer(exports, "no-forwarder");
1373
1374             if (fwd->gateway_host != NULL)
1375             {
1376                char *socks_type = NULL;
1377
1378                switch (fwd->type)
1379                {
1380                   case SOCKS_4:
1381                      socks_type = "socks4";
1382                      break;
1383                   case SOCKS_4A:
1384                      socks_type = "socks4a";
1385                      break;
1386                   case SOCKS_5:
1387                      socks_type = "socks5";
1388                      break;
1389                   default:
1390                      log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1391                }
1392
1393                if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1394                if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1395                snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1396                if (!err) err = map(exports, "gateway-port", 1, port, 1);
1397             }
1398             else
1399             {
1400                if (!err) err = map_block_killer(exports, "socks-forwarder");
1401             }
1402
1403             if (fwd->forward_host != NULL)
1404             {
1405                if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1406                snprintf(port, sizeof(port), "%d", fwd->forward_port);
1407                if (!err) err = map(exports, "forward-port", 1, port, 1);
1408             }
1409             else
1410             {
1411                if (!err) err = map_block_killer(exports, "http-forwarder");
1412             }
1413          }
1414       }
1415
1416       free_http_request(url_to_query);
1417
1418       if (err || matches == NULL)
1419       {
1420          free_current_action(action);
1421          free_map(exports);
1422          return JB_ERR_MEMORY;
1423       }
1424
1425 #ifdef FEATURE_CGI_EDIT_ACTIONS
1426       if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1427       {
1428          err = map_block_killer(exports, "cgi-editor-is-disabled");
1429       }
1430 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1431
1432       /*
1433        * If zlib support is available, if no content filters
1434        * are enabled or if the prevent-compression action is enabled,
1435        * suppress the "compression could prevent filtering" warning.
1436        */
1437 #ifndef FEATURE_ZLIB
1438       if (!content_filters_enabled(action) ||
1439          (action->flags & ACTION_NO_COMPRESSION))
1440 #endif
1441       {
1442          if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1443       }
1444
1445       if (err || map(exports, "matches", 1, matches , 0))
1446       {
1447          free_current_action(action);
1448          free_map(exports);
1449          return JB_ERR_MEMORY;
1450       }
1451
1452       s = current_action_to_html(csp, action);
1453
1454       free_current_action(action);
1455
1456       if (map(exports, "final", 1, s, 0))
1457       {
1458          free_map(exports);
1459          return JB_ERR_MEMORY;
1460       }
1461    }
1462
1463    return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1464 }
1465
1466
1467 /*********************************************************************
1468  *
1469  * Function    :  cgi_robots_txt
1470  *
1471  * Description :  CGI function to return "/robots.txt".
1472  *
1473  * Parameters  :
1474  *          1  :  csp = Current client state (buffers, headers, etc...)
1475  *          2  :  rsp = http_response data structure for output
1476  *          3  :  parameters = map of cgi parameters
1477  *
1478  * CGI Parameters : None
1479  *
1480  * Returns     :  JB_ERR_OK on success
1481  *                JB_ERR_MEMORY on out-of-memory error.
1482  *
1483  *********************************************************************/
1484 jb_err cgi_robots_txt(struct client_state *csp,
1485                       struct http_response *rsp,
1486                       const struct map *parameters)
1487 {
1488    char buf[100];
1489    jb_err err;
1490
1491    (void)csp;
1492    (void)parameters;
1493
1494    rsp->body = strdup(
1495       "# This is the Privoxy control interface.\n"
1496       "# It isn't very useful to index it, and you're likely to break stuff.\n"
1497       "# So go away!\n"
1498       "\n"
1499       "User-agent: *\n"
1500       "Disallow: /\n"
1501       "\n");
1502    if (rsp->body == NULL)
1503    {
1504       return JB_ERR_MEMORY;
1505    }
1506
1507    err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1508
1509    rsp->is_static = 1;
1510
1511    get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1512    if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1513
1514    return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1515 }
1516
1517
1518 /*********************************************************************
1519  *
1520  * Function    :  show_defines
1521  *
1522  * Description :  Add to a map the state od all conditional #defines
1523  *                used when building
1524  *
1525  * Parameters  :
1526  *          1  :  exports = map to extend
1527  *
1528  * Returns     :  JB_ERR_OK on success
1529  *                JB_ERR_MEMORY on out-of-memory error.
1530  *
1531  *********************************************************************/
1532 static jb_err show_defines(struct map *exports)
1533 {
1534    jb_err err = JB_ERR_OK;
1535
1536 #ifdef FEATURE_ACCEPT_FILTER
1537    if (!err) err = map_conditional(exports, "FEATURE_ACCEPT_FILTER", 1);
1538 #else /* ifndef FEATURE_ACCEPT_FILTER */
1539    if (!err) err = map_conditional(exports, "FEATURE_ACCEPT_FILTER", 0);
1540 #endif /* ndef FEATURE_ACCEPT_FILTER */
1541
1542 #ifdef FEATURE_ACL
1543    if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1544 #else /* ifndef FEATURE_ACL */
1545    if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1546 #endif /* ndef FEATURE_ACL */
1547
1548 #ifdef FEATURE_CGI_EDIT_ACTIONS
1549    if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1550 #else /* ifndef FEATURE_CGI_EDIT_ACTIONS */
1551    if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1552 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1553
1554 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1555    if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 1);
1556 #else /* ifndef FEATURE_CONNECTION_KEEP_ALIVE */
1557    if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 0);
1558 #endif /* ndef FEATURE_CONNECTION_KEEP_ALIVE */
1559
1560 #ifdef FEATURE_CONNECTION_SHARING
1561    if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 1);
1562 #else /* ifndef FEATURE_CONNECTION_SHARING */
1563    if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 0);
1564 #endif /* ndef FEATURE_CONNECTION_SHARING */
1565
1566 #ifdef FEATURE_FAST_REDIRECTS
1567    if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1568 #else /* ifndef FEATURE_FAST_REDIRECTS */
1569    if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1570 #endif /* ndef FEATURE_FAST_REDIRECTS */
1571
1572 #ifdef FEATURE_FORCE_LOAD
1573    if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1574    if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1575 #else /* ifndef FEATURE_FORCE_LOAD */
1576    if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1577    if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1578 #endif /* ndef FEATURE_FORCE_LOAD */
1579
1580 #ifdef FEATURE_GRACEFUL_TERMINATION
1581    if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1582 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1583    if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1584 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1585
1586 #ifdef FEATURE_IMAGE_BLOCKING
1587    if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1588 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1589    if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1590 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1591
1592 #ifdef FEATURE_IMAGE_DETECT_MSIE
1593    if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1594 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1595    if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1596 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1597
1598 #ifdef HAVE_RFC2553
1599    if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 1);
1600 #else /* ifndef HAVE_RFC2553 */
1601    if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 0);
1602 #endif /* ndef HAVE_RFC2553 */
1603
1604 #ifdef FEATURE_NO_GIFS
1605    if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1606 #else /* ifndef FEATURE_NO_GIFS */
1607    if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1608 #endif /* ndef FEATURE_NO_GIFS */
1609
1610 #ifdef FEATURE_PTHREAD
1611    if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1612 #else /* ifndef FEATURE_PTHREAD */
1613    if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1614 #endif /* ndef FEATURE_PTHREAD */
1615
1616 #ifdef FEATURE_STATISTICS
1617    if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1618 #else /* ifndef FEATURE_STATISTICS */
1619    if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1620 #endif /* ndef FEATURE_STATISTICS */
1621
1622 #ifdef FEATURE_TOGGLE
1623    if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1624 #else /* ifndef FEATURE_TOGGLE */
1625    if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1626 #endif /* ndef FEATURE_TOGGLE */
1627
1628 #ifdef FEATURE_TRUST
1629    if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1630 #else /* ifndef FEATURE_TRUST */
1631    if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1632 #endif /* ndef FEATURE_TRUST */
1633
1634 #ifdef FEATURE_ZLIB
1635    if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1636 #else /* ifndef FEATURE_ZLIB */
1637    if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1638 #endif /* ndef FEATURE_ZLIB */
1639
1640 #ifdef STATIC_PCRE
1641    if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1642 #else /* ifndef STATIC_PCRE */
1643    if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1644 #endif /* ndef STATIC_PCRE */
1645
1646 #ifdef STATIC_PCRS
1647    if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1648 #else /* ifndef STATIC_PCRS */
1649    if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1650 #endif /* ndef STATIC_PCRS */
1651
1652    return err;
1653 }
1654
1655
1656 /*********************************************************************
1657  *
1658  * Function    :  show_rcs
1659  *
1660  * Description :  Create a string with the rcs info for all sourcefiles
1661  *
1662  * Parameters  :  None
1663  *
1664  * Returns     :  A string, or NULL on out-of-memory.
1665  *
1666  *********************************************************************/
1667 static char *show_rcs(void)
1668 {
1669    char *result = strdup("");
1670    char buf[BUFFER_SIZE];
1671
1672    /* Instead of including *all* dot h's in the project (thus creating a
1673     * tremendous amount of dependencies), I will concede to declaring them
1674     * as extern's.  This forces the developer to add to this list, but oh well.
1675     */
1676
1677 #define SHOW_RCS(__x)              \
1678    {                               \
1679       extern const char __x[];     \
1680       snprintf(buf, sizeof(buf), " %s\n", __x);   \
1681       string_append(&result, buf); \
1682    }
1683
1684    /* In alphabetical order */
1685    SHOW_RCS(actions_h_rcs)
1686    SHOW_RCS(actions_rcs)
1687 #ifdef AMIGA
1688    SHOW_RCS(amiga_h_rcs)
1689    SHOW_RCS(amiga_rcs)
1690 #endif /* def AMIGA */
1691    SHOW_RCS(cgi_h_rcs)
1692    SHOW_RCS(cgi_rcs)
1693 #ifdef FEATURE_CGI_EDIT_ACTIONS
1694    SHOW_RCS(cgiedit_h_rcs)
1695    SHOW_RCS(cgiedit_rcs)
1696 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1697    SHOW_RCS(cgisimple_h_rcs)
1698    SHOW_RCS(cgisimple_rcs)
1699 #ifdef __MINGW32__
1700    SHOW_RCS(cygwin_h_rcs)
1701 #endif
1702    SHOW_RCS(deanimate_h_rcs)
1703    SHOW_RCS(deanimate_rcs)
1704    SHOW_RCS(encode_h_rcs)
1705    SHOW_RCS(encode_rcs)
1706    SHOW_RCS(errlog_h_rcs)
1707    SHOW_RCS(errlog_rcs)
1708    SHOW_RCS(filters_h_rcs)
1709    SHOW_RCS(filters_rcs)
1710    SHOW_RCS(gateway_h_rcs)
1711    SHOW_RCS(gateway_rcs)
1712    SHOW_RCS(jbsockets_h_rcs)
1713    SHOW_RCS(jbsockets_rcs)
1714    SHOW_RCS(jcc_h_rcs)
1715    SHOW_RCS(jcc_rcs)
1716    SHOW_RCS(list_h_rcs)
1717    SHOW_RCS(list_rcs)
1718    SHOW_RCS(loadcfg_h_rcs)
1719    SHOW_RCS(loadcfg_rcs)
1720    SHOW_RCS(loaders_h_rcs)
1721    SHOW_RCS(loaders_rcs)
1722    SHOW_RCS(miscutil_h_rcs)
1723    SHOW_RCS(miscutil_rcs)
1724    SHOW_RCS(parsers_h_rcs)
1725    SHOW_RCS(parsers_rcs)
1726    SHOW_RCS(pcrs_rcs)
1727    SHOW_RCS(pcrs_h_rcs)
1728    SHOW_RCS(project_h_rcs)
1729    SHOW_RCS(ssplit_h_rcs)
1730    SHOW_RCS(ssplit_rcs)
1731    SHOW_RCS(urlmatch_h_rcs)
1732    SHOW_RCS(urlmatch_rcs)
1733 #ifdef _WIN32
1734 #ifndef _WIN_CONSOLE
1735    SHOW_RCS(w32log_h_rcs)
1736    SHOW_RCS(w32log_rcs)
1737    SHOW_RCS(w32res_h_rcs)
1738    SHOW_RCS(w32taskbar_h_rcs)
1739    SHOW_RCS(w32taskbar_rcs)
1740 #endif /* ndef _WIN_CONSOLE */
1741    SHOW_RCS(win32_h_rcs)
1742    SHOW_RCS(win32_rcs)
1743 #endif /* def _WIN32 */
1744
1745 #undef SHOW_RCS
1746
1747    return result;
1748
1749 }
1750
1751
1752 /*********************************************************************
1753  *
1754  * Function    :  cgi_show_file
1755  *
1756  * Description :  CGI function that shows the content of a
1757  *                configuration file.
1758  *
1759  * Parameters  :
1760  *          1  :  csp = Current client state (buffers, headers, etc...)
1761  *          2  :  rsp = http_response data structure for output
1762  *          3  :  parameters = map of cgi parameters
1763  *
1764  * CGI Parameters :
1765  *        file :  Which file to show.  Only first letter is checked,
1766  *                valid values are:
1767  *                - "a"ction file
1768  *                - "r"egex
1769  *                - "t"rust
1770  *                Default is to show menu and other information.
1771  *
1772  * Returns     :  JB_ERR_OK on success
1773  *                JB_ERR_MEMORY on out-of-memory error.
1774  *
1775  *********************************************************************/
1776 static jb_err cgi_show_file(struct client_state *csp,
1777                             struct http_response *rsp,
1778                             const struct map *parameters)
1779 {
1780    unsigned i;
1781    const char * filename = NULL;
1782    char * file_description = NULL;
1783
1784    assert(csp);
1785    assert(rsp);
1786    assert(parameters);
1787
1788    switch (*(lookup(parameters, "file")))
1789    {
1790    case 'a':
1791       if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
1792       {
1793          filename = csp->actions_list[i]->filename;
1794          file_description = "Actions File";
1795       }
1796       break;
1797
1798    case 'f':
1799       if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
1800       {
1801          filename = csp->rlist[i]->filename;
1802          file_description = "Filter File";
1803       }
1804       break;
1805
1806 #ifdef FEATURE_TRUST
1807    case 't':
1808       if (csp->tlist)
1809       {
1810          filename = csp->tlist->filename;
1811          file_description = "Trust File";
1812       }
1813       break;
1814 #endif /* def FEATURE_TRUST */
1815    }
1816
1817    if (NULL != filename)
1818    {
1819       struct map *exports;
1820       char *s;
1821       jb_err err;
1822       size_t length;
1823
1824       exports = default_exports(csp, "show-status");
1825       if (NULL == exports)
1826       {
1827          return JB_ERR_MEMORY;
1828       }
1829
1830       if ( map(exports, "file-description", 1, file_description, 1)
1831         || map(exports, "filepath", 1, html_encode(filename), 0) )
1832       {
1833          free_map(exports);
1834          return JB_ERR_MEMORY;
1835       }
1836
1837       err = load_file(filename, &s, &length);
1838       if (JB_ERR_OK != err)
1839       {
1840          if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
1841          {
1842             free_map(exports);
1843             return JB_ERR_MEMORY;
1844          }
1845       }
1846       else
1847       {
1848          s = html_encode_and_free_original(s);
1849          if (NULL == s)
1850          {
1851             return JB_ERR_MEMORY;
1852          }
1853
1854          if (map(exports, "contents", 1, s, 0))
1855          {
1856             free_map(exports);
1857             return JB_ERR_MEMORY;
1858          }
1859       }
1860
1861       return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
1862    }
1863
1864    return JB_ERR_CGI_PARAMS;
1865 }
1866
1867
1868 /*********************************************************************
1869  *
1870  * Function    :  load_file
1871  *
1872  * Description :  Loads a file into a buffer.
1873  *
1874  * Parameters  :
1875  *          1  :  filename = Name of the file to be loaded.
1876  *          2  :  buffer   = Used to return the file's content.
1877  *          3  :  length   = Used to return the size of the file.
1878  *
1879  * Returns     :  JB_ERR_OK in case of success,
1880  *                JB_ERR_FILE in case of ordinary file loading errors
1881  *                            (fseek() and ftell() errors are fatal)
1882  *                JB_ERR_MEMORY in case of out-of-memory.
1883  *
1884  *********************************************************************/
1885 static jb_err load_file(const char *filename, char **buffer, size_t *length)
1886 {
1887    FILE *fp;
1888    long ret;
1889    jb_err err = JB_ERR_OK;
1890
1891    fp = fopen(filename, "rb");
1892    if (NULL == fp)
1893    {
1894       log_error(LOG_LEVEL_ERROR, "Failed to open %s: %E", filename);
1895       return JB_ERR_FILE;
1896    }
1897
1898    /* Get file length */
1899    if (fseek(fp, 0, SEEK_END))
1900    {
1901       log_error(LOG_LEVEL_FATAL,
1902          "Unexpected error while fseek()ing to the end of %s: %E",
1903          filename);
1904    }
1905    ret = ftell(fp);
1906    if (-1 == ret)
1907    {
1908       log_error(LOG_LEVEL_FATAL,
1909          "Unexpected ftell() error while loading %s: %E",
1910          filename);
1911    }
1912    *length = (size_t)ret;
1913
1914    /* Go back to the beginning. */
1915    if (fseek(fp, 0, SEEK_SET))
1916    {
1917       log_error(LOG_LEVEL_FATAL,
1918          "Unexpected error while fseek()ing to the beginning of %s: %E",
1919          filename);
1920    }
1921
1922    *buffer = (char *)zalloc(*length + 1);
1923    if (NULL == *buffer)
1924    {
1925       err = JB_ERR_MEMORY;
1926    }
1927    else if (!fread(*buffer, *length, 1, fp))
1928    {
1929       /*
1930        * May happen if the file size changes between fseek() and
1931        * fread(). If it does, we just log it and serve what we got.
1932        */
1933       log_error(LOG_LEVEL_ERROR,
1934          "Couldn't completely read file %s.", filename);
1935       err = JB_ERR_FILE;
1936    }
1937
1938    fclose(fp);
1939
1940    return err;
1941
1942 }
1943
1944
1945 /*
1946   Local Variables:
1947   tab-width: 3
1948   end:
1949 */