cgisimple.c

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