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