1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.148 2017/03/08 13:13:18 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
6 * Purpose : Simple CGIs to get information about Privoxy's
9 * Copyright : Written by and Copyright (C) 2001-2017 the
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 **********************************************************************/
40 #include <sys/types.h>
46 #if defined (HAVE_ACCESS) && defined (HAVE_UNISTD_H)
48 #endif /* def HAVE_ACCESS && HAVE_UNISTD_H */
52 #include "cgisimple.h"
63 #ifdef FEATURE_CLIENT_TAGS
64 #include "client-tags.h"
67 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
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);
76 /*********************************************************************
78 * Function : cgi_default
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.
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
89 * CGI Parameters : none
91 * Returns : JB_ERR_OK on success
92 * JB_ERR_MEMORY on out-of-memory
94 *********************************************************************/
95 jb_err cgi_default(struct client_state *csp,
96 struct http_response *rsp,
97 const struct map *parameters)
106 if (NULL == (exports = default_exports(csp, "")))
108 return JB_ERR_MEMORY;
111 return template_fill_for_cgi(csp, "default", exports, rsp);
115 /*********************************************************************
117 * Function : cgi_error_404
119 * Description : CGI function that is called if an unknown action was
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
127 * CGI Parameters : none
129 * Returns : JB_ERR_OK on success
130 * JB_ERR_MEMORY on out-of-memory error.
132 *********************************************************************/
133 jb_err cgi_error_404(struct client_state *csp,
134 struct http_response *rsp,
135 const struct map *parameters)
143 if (NULL == (exports = default_exports(csp, NULL)))
145 return JB_ERR_MEMORY;
148 rsp->status = strdup_or_die("404 Privoxy configuration page not found");
150 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
154 #ifdef FEATURE_GRACEFUL_TERMINATION
155 /*********************************************************************
159 * Description : CGI function to shut down Privoxy.
160 * NOTE: Turning this on in a production build
161 * would be a BAD idea. An EXTREMELY BAD idea.
162 * In short, don't do it.
165 * 1 : csp = Current client state (buffers, headers, etc...)
166 * 2 : rsp = http_response data structure for output
167 * 3 : parameters = map of cgi parameters
169 * CGI Parameters : none
171 * Returns : JB_ERR_OK on success
173 *********************************************************************/
174 jb_err cgi_die (struct client_state *csp,
175 struct http_response *rsp,
176 const struct map *parameters)
178 static const char status[] = "200 OK Privoxy shutdown request received";
179 static const char body[] =
182 " <title>Privoxy shutdown request received</title>\n"
183 " <link rel=\"shortcut icon\" href=\"" CGI_PREFIX "error-favicon.ico\" type=\"image/x-icon\">\n"
184 " <link rel=\"stylesheet\" type=\"text/css\" href=\"" CGI_PREFIX "send-stylesheet\">\n"
187 "<h1>Privoxy shutdown request received</h1>\n"
188 "<p>Privoxy is going to shut down after the next request.</p>\n"
199 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
201 rsp->content_length = 0;
202 rsp->head_length = 0;
205 rsp->body = strdup_or_die(body);
206 rsp->status = strdup_or_die(status);
210 #endif /* def FEATURE_GRACEFUL_TERMINATION */
213 /*********************************************************************
215 * Function : cgi_show_request
217 * Description : Show the client's request and what sed() would have
221 * 1 : csp = Current client state (buffers, headers, etc...)
222 * 2 : rsp = http_response data structure for output
223 * 3 : parameters = map of cgi parameters
225 * CGI Parameters : none
227 * Returns : JB_ERR_OK on success
228 * JB_ERR_MEMORY on out-of-memory error.
230 *********************************************************************/
231 jb_err cgi_show_request(struct client_state *csp,
232 struct http_response *rsp,
233 const struct map *parameters)
242 if (NULL == (exports = default_exports(csp, "show-request")))
244 return JB_ERR_MEMORY;
248 * Repair the damage done to the IOB by get_header()
250 for (p = csp->client_iob->buf; p < csp->client_iob->cur; p++)
252 if (*p == '\0') *p = '\n';
256 * Export the original client's request and the one we would
257 * be sending to the server if this wasn't a CGI call
260 if (map(exports, "client-request", 1, html_encode(csp->client_iob->buf), 0))
263 return JB_ERR_MEMORY;
266 if (map(exports, "processed-request", 1,
267 html_encode_and_free_original(list_to_text(csp->headers)), 0))
270 return JB_ERR_MEMORY;
273 return template_fill_for_cgi(csp, "show-request", exports, rsp);
277 #ifdef FEATURE_CLIENT_TAGS
278 /*********************************************************************
280 * Function : cgi_create_client_tag_form
282 * Description : Creates a HTML form to enable or disable a given
284 * XXX: Could use a template.
287 * 1 : form = Buffer to fill with the generated form
288 * 2 : size = Size of the form buffer
289 * 3 : tag = Name of the tag this form should affect
290 * 4 : toggle_state = Desired state after the button pressed 0
291 * 5 : expires = Whether or not the tag should be enabled.
292 * Only checked if toggle_state is 1.
296 *********************************************************************/
297 static void cgi_create_client_tag_form(char *form, size_t size,
298 const char *tag, int toggle_state, int expires)
302 if (toggle_state == 1)
304 button_name = (expires == 1) ? "Enable" : "Enable temporarily";
308 assert(toggle_state == 0);
309 button_name = "Disable";
313 "<form method=\"GET\" action=\""CGI_PREFIX"toggle-client-tag\" style=\"display: inline\">\n"
314 " <input type=\"hidden\" name=\"tag\" value=\"%s\">\n"
315 " <input type=\"hidden\" name=\"toggle-state\" value=\"%u\">\n"
316 " <input type=\"hidden\" name=\"expires\" value=\"%u\">\n"
317 " <input type=\"submit\" value=\"%s\">\n"
318 "</form>", tag, toggle_state, !expires, button_name);
321 /*********************************************************************
323 * Function : cgi_show_client_tags
325 * Description : Shows the tags that can be set based on the client
329 * 1 : csp = Current client state (buffers, headers, etc...)
330 * 2 : rsp = http_response data structure for output
331 * 3 : parameters = map of cgi parameters
333 * CGI Parameters : none
335 * Returns : JB_ERR_OK on success
336 * JB_ERR_MEMORY on out-of-memory error.
338 *********************************************************************/
339 jb_err cgi_show_client_tags(struct client_state *csp,
340 struct http_response *rsp,
341 const struct map *parameters)
344 struct client_tag_spec *this_tag;
345 jb_err err = JB_ERR_OK;
346 char *client_tag_status;
348 time_t refresh_delay;
354 if (NULL == (exports = default_exports(csp, "client-tags")))
356 return JB_ERR_MEMORY;
358 assert(csp->client_address != NULL);
360 this_tag = csp->config->client_tags;
361 if (this_tag->name == NULL)
363 client_tag_status = strdup_or_die("<p>No tags available.</p>\n");
367 client_tag_status = strdup_or_die("<table border=\"1\">\n"
368 "<tr><th>Tag name</th>\n"
369 "<th>Current state</th><th>Change state</th><th>Description</th></tr>\n");
370 while ((this_tag != NULL) && (this_tag->name != NULL))
374 privoxy_mutex_lock(&client_tags_mutex);
375 tag_state = client_has_requested_tag(csp->client_address, this_tag->name);
376 privoxy_mutex_unlock(&client_tags_mutex);
377 if (!err) err = string_append(&client_tag_status, "<tr><td>");
378 if (!err) err = string_append(&client_tag_status, this_tag->name);
379 if (!err) err = string_append(&client_tag_status, "</td><td>");
380 if (!err) err = string_append(&client_tag_status, tag_state == 1 ? "Enabled" : "Disabled");
381 if (!err) err = string_append(&client_tag_status, "</td><td>");
382 cgi_create_client_tag_form(buf, sizeof(buf), this_tag->name, !tag_state, 1);
383 if (!err) err = string_append(&client_tag_status, buf);
386 cgi_create_client_tag_form(buf, sizeof(buf), this_tag->name, !tag_state, 0);
387 if (!err) err = string_append(&client_tag_status, buf);
389 if (!err) err = string_append(&client_tag_status, "</td><td>");
390 if (!err) err = string_append(&client_tag_status, this_tag->description);
391 if (!err) err = string_append(&client_tag_status, "</td></tr>\n");
395 return JB_ERR_MEMORY;
397 this_tag = this_tag->next;
399 if (!err) err = string_append(&client_tag_status, "</table>\n");
401 refresh_delay = get_next_tag_timeout_for_client(csp->client_address);
402 if (refresh_delay != 0)
404 snprintf(buf, sizeof(buf), "%d", csp->config->client_tag_lifetime);
405 if (map(exports, "refresh-delay", 1, buf, 1))
408 return JB_ERR_MEMORY;
413 err = map_block_killer(exports, "tags-expire");
414 if (err != JB_ERR_OK)
420 if (map(exports, "client-tags", 1, client_tag_status, 0))
423 return JB_ERR_MEMORY;
426 if (map(exports, "client-ip-addr", 1, csp->client_address, 1))
429 return JB_ERR_MEMORY;
432 return template_fill_for_cgi(csp, "client-tags", exports, rsp);
436 /*********************************************************************
438 * Function : cgi_toggle_client_tag
440 * Description : Toggles a client tag and redirects to the show-tags
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
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
454 * Returns : JB_ERR_OK on success
455 * JB_ERR_MEMORY on out-of-memory error.
457 *********************************************************************/
458 jb_err cgi_toggle_client_tag(struct client_state *csp,
459 struct http_response *rsp,
460 const struct map *parameters)
462 const char *toggled_tag;
463 const char *toggle_state;
464 const char *tag_expires;
471 toggled_tag = lookup(parameters, "tag");
472 if (*toggled_tag == '\0')
474 log_error(LOG_LEVEL_ERROR, "Received tag toggle request without tag");
478 tag_expires = lookup(parameters, "expires");
479 if (*tag_expires == '0')
485 time_to_live = csp->config->client_tag_lifetime;
487 toggle_state = lookup(parameters, "toggle-state");
488 if (*toggle_state == '1')
490 enable_client_specific_tag(csp, toggled_tag, time_to_live);
494 disable_client_specific_tag(csp, toggled_tag);
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"))
501 return JB_ERR_MEMORY;
506 #endif /* def FEATURE_CLIENT_TAGS */
509 /*********************************************************************
511 * Function : cgi_send_banner
513 * Description : CGI function that returns a banner.
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
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
527 * Returns : JB_ERR_OK on success
528 * JB_ERR_MEMORY on out-of-memory error.
530 *********************************************************************/
531 jb_err cgi_send_banner(struct client_state *csp,
532 struct http_response *rsp,
533 const struct map *parameters)
535 char imagetype = lookup(parameters, "type")[0];
538 * If type is auto, then determine the right thing
539 * to do from the set-image-blocker action
541 if (imagetype == 'a')
548 #ifdef FEATURE_IMAGE_BLOCKING
549 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
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];
557 /* Use default - nothing to do here. */
559 else if (0 == strcmpic(p, "blank"))
563 else if (0 == strcmpic(p, "pattern"))
569 * If the action is to call this CGI, determine
572 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
574 imagetype = p[sizeof(prefix1) - 1];
576 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
578 imagetype = p[sizeof(prefix2) - 1];
582 * Everything else must (should) be a URL to
590 #endif /* def FEATURE_IMAGE_BLOCKING */
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:
599 if (imagetype == 'r')
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]))
605 return JB_ERR_MEMORY;
610 if ((imagetype == 'b') || (imagetype == 't'))
612 rsp->body = bindup(image_blank_data, image_blank_length);
613 rsp->content_length = image_blank_length;
617 rsp->body = bindup(image_pattern_data, image_pattern_length);
618 rsp->content_length = image_pattern_length;
621 if (rsp->body == NULL)
623 return JB_ERR_MEMORY;
625 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
627 return JB_ERR_MEMORY;
638 /*********************************************************************
640 * Function : cgi_transparent_image
642 * Description : CGI function that sends a 1x1 transparent image.
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
649 * CGI Parameters : None
651 * Returns : JB_ERR_OK on success
652 * JB_ERR_MEMORY on out-of-memory error.
654 *********************************************************************/
655 jb_err cgi_transparent_image(struct client_state *csp,
656 struct http_response *rsp,
657 const struct map *parameters)
662 rsp->body = bindup(image_blank_data, image_blank_length);
663 rsp->content_length = image_blank_length;
665 if (rsp->body == NULL)
667 return JB_ERR_MEMORY;
670 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
672 return JB_ERR_MEMORY;
682 /*********************************************************************
684 * Function : cgi_send_default_favicon
686 * Description : CGI function that sends the standard favicon.
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
693 * CGI Parameters : None
695 * Returns : JB_ERR_OK on success
696 * JB_ERR_MEMORY on out-of-memory error.
698 *********************************************************************/
699 jb_err cgi_send_default_favicon(struct client_state *csp,
700 struct http_response *rsp,
701 const struct map *parameters)
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"
718 static const size_t favicon_length = sizeof(default_favicon_data) - 1;
723 rsp->body = bindup(default_favicon_data, favicon_length);
724 rsp->content_length = favicon_length;
726 if (rsp->body == NULL)
728 return JB_ERR_MEMORY;
731 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
733 return JB_ERR_MEMORY;
743 /*********************************************************************
745 * Function : cgi_send_error_favicon
747 * Description : CGI function that sends the favicon for error pages.
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
754 * CGI Parameters : None
756 * Returns : JB_ERR_OK on success
757 * JB_ERR_MEMORY on out-of-memory error.
759 *********************************************************************/
760 jb_err cgi_send_error_favicon(struct client_state *csp,
761 struct http_response *rsp,
762 const struct map *parameters)
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"
779 static const size_t favicon_length = sizeof(error_favicon_data) - 1;
784 rsp->body = bindup(error_favicon_data, favicon_length);
785 rsp->content_length = favicon_length;
787 if (rsp->body == NULL)
789 return JB_ERR_MEMORY;
792 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
794 return JB_ERR_MEMORY;
804 /*********************************************************************
806 * Function : cgi_send_stylesheet
808 * Description : CGI function that sends a css stylesheet found
809 * in the cgi-style.css template
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
816 * CGI Parameters : None
818 * Returns : JB_ERR_OK on success
819 * JB_ERR_MEMORY on out-of-memory error.
821 *********************************************************************/
822 jb_err cgi_send_stylesheet(struct client_state *csp,
823 struct http_response *rsp,
824 const struct map *parameters)
833 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
835 if (err == JB_ERR_FILE)
838 * No way to tell user; send empty stylesheet
840 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
844 return err; /* JB_ERR_MEMORY */
847 if (enlist(rsp->headers, "Content-Type: text/css"))
849 return JB_ERR_MEMORY;
857 /*********************************************************************
859 * Function : cgi_send_url_info_osd
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".
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
870 * CGI Parameters : None
872 * Returns : JB_ERR_OK on success
873 * JB_ERR_MEMORY on out-of-memory error.
875 *********************************************************************/
876 jb_err cgi_send_url_info_osd(struct client_state *csp,
877 struct http_response *rsp,
878 const struct map *parameters)
880 jb_err err = JB_ERR_MEMORY;
881 struct map *exports = default_exports(csp, NULL);
888 err = template_fill_for_cgi(csp, "url-info-osd.xml", exports, rsp);
889 if (JB_ERR_OK == err)
891 err = enlist(rsp->headers,
892 "Content-Type: application/opensearchdescription+xml");
901 /*********************************************************************
903 * Function : get_content_type
905 * Description : Use the file extension to guess the content type
906 * header we should use to serve the file.
909 * 1 : filename = Name of the file whose content type
912 * Returns : The guessed content type.
914 *********************************************************************/
915 static const char *get_content_type(const char *filename)
920 const char extension[6];
921 const char content_type[11];
923 static const struct content_type content_types[] =
925 {".css", "text/css"},
926 {".jpg", "image/jpeg"},
927 {".jpeg", "image/jpeg"},
928 {".png", "image/png"},
931 for (i = 0; i < SZ(content_types); i++)
933 if (strstr(filename, content_types[i].extension))
935 return content_types[i].content_type;
939 /* No match by extension, default to html */
943 /*********************************************************************
945 * Function : cgi_send_user_manual
947 * Description : CGI function that sends a file in the user
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
955 * CGI Parameters : file=name.html, the name of the HTML file
956 * (relative to user-manual from config)
958 * Returns : JB_ERR_OK on success
959 * JB_ERR_MEMORY on out-of-memory error.
961 *********************************************************************/
962 jb_err cgi_send_user_manual(struct client_state *csp,
963 struct http_response *rsp,
964 const struct map *parameters)
966 const char *filename;
968 jb_err err = JB_ERR_OK;
969 const char *content_type;
975 if (0 == strncmpic(csp->config->usermanual, "http://", 7))
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);
982 if (!parameters->first)
984 /* requested http://p.p/user-manual (without trailing slash) */
985 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
988 get_string_param(parameters, "file", &filename);
989 if (filename == NULL)
991 /* It's '/' so serve the index.html if there is one. */
992 filename = "index.html";
994 else if (NULL != strchr(filename, '/') || NULL != strstr(filename, ".."))
997 * We currently only support a flat file
998 * hierarchy for the documentation.
1000 log_error(LOG_LEVEL_ERROR,
1001 "Rejecting the request to serve '%s' as it contains '/' or '..'",
1003 return JB_ERR_CGI_PARAMS;
1006 full_path = make_path(csp->config->usermanual, filename);
1007 if (full_path == NULL)
1009 return JB_ERR_MEMORY;
1012 err = load_file(full_path, &rsp->body, &rsp->content_length);
1013 if (JB_ERR_OK != err)
1015 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1016 if (JB_ERR_FILE == err)
1018 err = cgi_error_no_template(csp, rsp, full_path);
1025 content_type = get_content_type(filename);
1026 log_error(LOG_LEVEL_CGI,
1027 "Content-Type guessed for %s: %s", filename, content_type);
1029 return enlist_unique_header(rsp->headers, "Content-Type", content_type);
1034 /*********************************************************************
1036 * Function : cgi_show_version
1038 * Description : CGI function that returns a a web page describing the
1039 * file versions of Privoxy.
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
1046 * CGI Parameters : none
1048 * Returns : JB_ERR_OK on success
1049 * JB_ERR_MEMORY on out-of-memory error.
1051 *********************************************************************/
1052 jb_err cgi_show_version(struct client_state *csp,
1053 struct http_response *rsp,
1054 const struct map *parameters)
1056 struct map *exports;
1062 if (NULL == (exports = default_exports(csp, "show-version")))
1064 return JB_ERR_MEMORY;
1067 if (map(exports, "sourceversions", 1, show_rcs(), 0))
1070 return JB_ERR_MEMORY;
1073 return template_fill_for_cgi(csp, "show-version", exports, rsp);
1077 /*********************************************************************
1079 * Function : cgi_show_status
1081 * Description : CGI function that returns a web page describing the
1082 * current status of Privoxy.
1085 * 1 : csp = Current client state (buffers, headers, etc...)
1086 * 2 : rsp = http_response data structure for output
1087 * 3 : parameters = map of cgi parameters
1090 * file : Which file to show. Only first letter is checked,
1095 * Default is to show menu and other information.
1097 * Returns : JB_ERR_OK on success
1098 * JB_ERR_MEMORY on out-of-memory error.
1100 *********************************************************************/
1101 jb_err cgi_show_status(struct client_state *csp,
1102 struct http_response *rsp,
1103 const struct map *parameters)
1109 char buf[BUFFER_SIZE];
1110 #ifdef FEATURE_STATISTICS
1111 float perc_rej; /* Percentage of http requests rejected */
1112 int local_urls_read;
1113 int local_urls_rejected;
1114 #endif /* ndef FEATURE_STATISTICS */
1115 jb_err err = JB_ERR_OK;
1117 struct map *exports;
1123 if ('\0' != *(lookup(parameters, "file")))
1125 return cgi_show_file(csp, rsp, parameters);
1128 if (NULL == (exports = default_exports(csp, "show-status")))
1130 return JB_ERR_MEMORY;
1134 for (j = 0; (s != NULL) && (j < Argc); j++)
1136 if (!err) err = string_join (&s, html_encode(Argv[j]));
1137 if (!err) err = string_append(&s, " ");
1139 if (!err) err = map(exports, "invocation", 1, s, 0);
1141 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1142 if (!err) err = show_defines(exports);
1147 return JB_ERR_MEMORY;
1150 #ifdef FEATURE_STATISTICS
1151 local_urls_read = urls_read;
1152 local_urls_rejected = urls_rejected;
1155 * Need to alter the stats not to include the fetch of this
1158 * Can't do following thread safely! doh!
1161 * urls_rejected--; * This will be incremented subsequently *
1164 if (local_urls_read == 0)
1166 if (!err) err = map_block_killer(exports, "have-stats");
1170 if (!err) err = map_block_killer(exports, "have-no-stats");
1172 perc_rej = (float)local_urls_rejected * 100.0F /
1173 (float)local_urls_read;
1175 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1176 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1178 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1179 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1181 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1182 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1185 #else /* ndef FEATURE_STATISTICS */
1186 if (!err) err = map_block_killer(exports, "statistics");
1187 #endif /* ndef FEATURE_STATISTICS */
1190 * List all action files in use, together with view and edit links,
1191 * except for standard.action, which should only be viewable. (Not
1192 * enforced in the editor itself)
1193 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1196 for (i = 0; i < MAX_AF_FILES; i++)
1198 if (csp->actions_list[i] != NULL)
1200 if (!err) err = string_append(&s, "<tr><td>");
1201 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1202 snprintf(buf, sizeof(buf),
1203 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%u\">View</a>", i);
1204 if (!err) err = string_append(&s, buf);
1206 #ifdef FEATURE_CGI_EDIT_ACTIONS
1207 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1208 && (NULL != csp->config->actions_file_short[i]))
1211 if (access(csp->config->actions_file[i], W_OK) == 0)
1213 #endif /* def HAVE_ACCESS */
1214 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
1215 if (!err) err = string_append(&s, buf);
1220 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
1222 #endif /* def HAVE_ACCESS */
1226 if (!err) err = string_append(&s, "</td></tr>\n");
1231 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1235 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1239 * List all re_filterfiles in use, together with view options.
1240 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1243 for (i = 0; i < MAX_AF_FILES; i++)
1245 if (csp->rlist[i] != NULL)
1247 if (!err) err = string_append(&s, "<tr><td>");
1248 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1249 snprintf(buf, sizeof(buf),
1250 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%u\">View</a>", i);
1251 if (!err) err = string_append(&s, buf);
1252 if (!err) err = string_append(&s, "</td></tr>\n");
1257 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1261 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1262 if (!err) err = map_block_killer(exports, "have-filterfile");
1265 #ifdef FEATURE_TRUST
1268 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1272 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1273 if (!err) err = map_block_killer(exports, "have-trustfile");
1276 if (!err) err = map_block_killer(exports, "trust-support");
1277 #endif /* ndef FEATURE_TRUST */
1279 #ifdef FEATURE_CGI_EDIT_ACTIONS
1280 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1282 err = map_block_killer(exports, "cgi-editor-is-disabled");
1284 #endif /* ndef CGI_EDIT_ACTIONS */
1286 if (!err) err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
1291 return JB_ERR_MEMORY;
1294 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1298 /*********************************************************************
1300 * Function : cgi_show_url_info
1302 * Description : CGI function that determines and shows which actions
1303 * Privoxy will perform for a given url, and which
1304 * matches starting from the defaults have lead to that.
1307 * 1 : csp = Current client state (buffers, headers, etc...)
1308 * 2 : rsp = http_response data structure for output
1309 * 3 : parameters = map of cgi parameters
1312 * url : The url whose actions are to be determined.
1313 * If url is unset, the url-given conditional will be
1314 * set, so that all but the form can be suppressed in
1317 * Returns : JB_ERR_OK on success
1318 * JB_ERR_MEMORY on out-of-memory error.
1320 *********************************************************************/
1321 jb_err cgi_show_url_info(struct client_state *csp,
1322 struct http_response *rsp,
1323 const struct map *parameters)
1326 struct map *exports;
1333 if (NULL == (exports = default_exports(csp, "show-url-info")))
1335 return JB_ERR_MEMORY;
1339 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1341 url_param = strdup_or_die(lookup(parameters, "url"));
1345 * Handle prefixes. 4 possibilities:
1346 * 1) "http://" or "https://" prefix present and followed by URL - OK
1347 * 2) Only the "http://" or "https://" part is present, no URL - change
1348 * to empty string so it will be detected later as "no URL".
1349 * 3) Parameter specified but doesn't start with "http(s?)://" - add a
1351 * 4) Parameter not specified or is empty string - let this fall through
1352 * for now, next block of code will handle it.
1354 if (0 == strncmp(url_param, "http://", 7))
1356 if (url_param[7] == '\0')
1359 * Empty URL (just prefix).
1360 * Make it totally empty so it's caught by the next if ()
1362 url_param[0] = '\0';
1365 else if (0 == strncmp(url_param, "https://", 8))
1367 if (url_param[8] == '\0')
1370 * Empty URL (just prefix).
1371 * Make it totally empty so it's caught by the next if ()
1373 url_param[0] = '\0';
1376 else if ((url_param[0] != '\0')
1377 && ((NULL == strstr(url_param, "://")
1378 || (strstr(url_param, "://") > strstr(url_param, "/")))))
1381 * No prefix or at least no prefix before
1382 * the first slash - assume http://
1384 char *url_param_prefixed = strdup_or_die("http://");
1386 if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1389 return JB_ERR_MEMORY;
1391 url_param = url_param_prefixed;
1395 * Hide "toggle off" warning if Privoxy is toggled on.
1398 #ifdef FEATURE_TOGGLE
1399 (global_toggle_state == 1) &&
1400 #endif /* def FEATURE_TOGGLE */
1401 map_block_killer(exports, "privoxy-is-toggled-off")
1406 return JB_ERR_MEMORY;
1409 if (url_param[0] == '\0')
1411 /* URL paramater not specified, display query form only. */
1413 if (map_block_killer(exports, "url-given")
1414 || map(exports, "url", 1, "", 1))
1417 return JB_ERR_MEMORY;
1422 /* Given a URL, so query it. */
1427 struct file_list *fl;
1428 struct url_actions *b;
1429 struct http_request url_to_query[1];
1430 struct current_action_spec action[1];
1433 if (map(exports, "url", 1, html_encode(url_param), 0))
1437 return JB_ERR_MEMORY;
1440 init_current_action(action);
1442 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1444 free_current_action(action);
1447 return JB_ERR_MEMORY;
1450 memset(url_to_query, '\0', sizeof(url_to_query));
1451 err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1452 assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1456 if (err == JB_ERR_MEMORY)
1458 free_http_request(url_to_query);
1459 free_current_action(action);
1461 return JB_ERR_MEMORY;
1467 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1468 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1469 if (!err) err = map_block_killer(exports, "valid-url");
1471 free_current_action(action);
1472 free_http_request(url_to_query);
1477 return JB_ERR_MEMORY;
1480 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1484 * We have a warning about SSL paths. Hide it for unencrypted sites.
1486 if (!url_to_query->ssl)
1488 if (map_block_killer(exports, "https"))
1490 free_current_action(action);
1492 free_http_request(url_to_query);
1493 return JB_ERR_MEMORY;
1497 matches = strdup_or_die("<table summary=\"\" class=\"transparent\">");
1499 for (i = 0; i < MAX_AF_FILES; i++)
1501 if (NULL == csp->config->actions_file_short[i]
1502 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1506 if ((fl = csp->actions_list[i]) != NULL)
1508 if ((b = fl->f) != NULL)
1510 /* FIXME: Hardcoded HTML! */
1511 string_append(&matches, "<tr><th>In file: ");
1512 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1513 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1514 string_append(&matches, buf);
1515 string_append(&matches, "View</a>");
1516 #ifdef FEATURE_CGI_EDIT_ACTIONS
1517 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1520 if (access(csp->config->actions_file[i], W_OK) == 0)
1522 #endif /* def HAVE_ACCESS */
1523 snprintf(buf, sizeof(buf),
1524 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1525 string_append(&matches, buf);
1526 string_append(&matches, "Edit</a>");
1531 string_append(&matches, " <strong>No write access.</strong>");
1533 #endif /* def HAVE_ACCESS */
1535 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1537 string_append(&matches, "</th></tr>\n");
1544 for (; (b != NULL) && (matches != NULL); b = b->next)
1546 if (url_match(b->url, url_to_query))
1548 string_append(&matches, "<tr><td>{");
1549 string_join (&matches, actions_to_html(csp, b->action));
1550 string_append(&matches, " }<br>\n<code>");
1551 string_join (&matches, html_encode(b->url->spec));
1552 string_append(&matches, "</code></td></tr>\n");
1554 if (merge_current_action(action, b->action))
1557 free_http_request(url_to_query);
1558 free_current_action(action);
1560 return JB_ERR_MEMORY;
1568 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1571 string_append(&matches, "</table>\n");
1574 * XXX: Kludge to make sure the "Forward settings" section
1575 * shows what forward-override{} would do with the requested URL.
1576 * No one really cares how the CGI request would be forwarded
1577 * if it wasn't intercepted as CGI request in the first place.
1579 * From here on the action bitmask will no longer reflect
1580 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1581 * but luckily it's no longer required later on anyway.
1583 free_current_action(csp->action);
1584 get_url_actions(csp, url_to_query);
1587 * Fill in forwarding settings.
1589 * The possibilities are:
1591 * - http forwarding only
1592 * - socks4(a) forwarding only
1593 * - socks4(a) and http forwarding.
1595 * XXX: Parts of this code could be reused for the
1596 * "forwarding-failed" template which currently doesn't
1597 * display the proxy port and an eventual second forwarder.
1600 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1602 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1604 if (!err) err = map_block_killer(exports, "socks-forwarder");
1605 if (!err) err = map_block_killer(exports, "http-forwarder");
1609 char port[10]; /* We save proxy ports as int but need a string here */
1611 if (!err) err = map_block_killer(exports, "no-forwarder");
1613 if (fwd->gateway_host != NULL)
1615 char *socks_type = NULL;
1620 socks_type = "socks4";
1623 socks_type = "socks4a";
1626 socks_type = "socks5";
1629 socks_type = "socks5t";
1632 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1635 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1636 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1637 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1638 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1642 if (!err) err = map_block_killer(exports, "socks-forwarder");
1645 if (fwd->forward_host != NULL)
1647 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1648 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1649 if (!err) err = map(exports, "forward-port", 1, port, 1);
1653 if (!err) err = map_block_killer(exports, "http-forwarder");
1658 free_http_request(url_to_query);
1660 if (err || matches == NULL)
1662 free_current_action(action);
1664 return JB_ERR_MEMORY;
1667 #ifdef FEATURE_CGI_EDIT_ACTIONS
1668 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1670 err = map_block_killer(exports, "cgi-editor-is-disabled");
1672 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1675 * If zlib support is available, if no content filters
1676 * are enabled or if the prevent-compression action is enabled,
1677 * suppress the "compression could prevent filtering" warning.
1679 #ifndef FEATURE_ZLIB
1680 if (!content_filters_enabled(action) ||
1681 (action->flags & ACTION_NO_COMPRESSION))
1684 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1687 if (err || map(exports, "matches", 1, matches , 0))
1689 free_current_action(action);
1691 return JB_ERR_MEMORY;
1694 s = current_action_to_html(csp, action);
1696 free_current_action(action);
1698 if (map(exports, "final", 1, s, 0))
1701 return JB_ERR_MEMORY;
1705 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1709 /*********************************************************************
1711 * Function : cgi_robots_txt
1713 * Description : CGI function to return "/robots.txt".
1716 * 1 : csp = Current client state (buffers, headers, etc...)
1717 * 2 : rsp = http_response data structure for output
1718 * 3 : parameters = map of cgi parameters
1720 * CGI Parameters : None
1722 * Returns : JB_ERR_OK on success
1723 * JB_ERR_MEMORY on out-of-memory error.
1725 *********************************************************************/
1726 jb_err cgi_robots_txt(struct client_state *csp,
1727 struct http_response *rsp,
1728 const struct map *parameters)
1736 rsp->body = strdup_or_die(
1737 "# This is the Privoxy control interface.\n"
1738 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1745 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1749 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1750 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1752 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1756 /*********************************************************************
1758 * Function : show_defines
1760 * Description : Add to a map the state od all conditional #defines
1761 * used when building
1764 * 1 : exports = map to extend
1766 * Returns : JB_ERR_OK on success
1767 * JB_ERR_MEMORY on out-of-memory error.
1769 *********************************************************************/
1770 static jb_err show_defines(struct map *exports)
1772 jb_err err = JB_ERR_OK;
1775 const char name[31];
1776 const unsigned char is_available;
1779 static const struct feature features[] = {
1781 "FEATURE_64_BIT_TIME_T",
1782 #if (SIZEOF_TIME_T == 8)
1789 "FEATURE_ACCEPT_FILTER",
1790 #ifdef FEATURE_ACCEPT_FILTER
1805 "FEATURE_CGI_EDIT_ACTIONS",
1806 #ifdef FEATURE_CGI_EDIT_ACTIONS
1813 "FEATURE_CLIENT_TAGS",
1814 #ifdef FEATURE_CLIENT_TAGS
1821 "FEATURE_COMPRESSION",
1822 #ifdef FEATURE_COMPRESSION
1829 "FEATURE_CONNECTION_KEEP_ALIVE",
1830 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1837 "FEATURE_CONNECTION_SHARING",
1838 #ifdef FEATURE_CONNECTION_SHARING
1845 "FEATURE_EXTERNAL_FILTERS",
1846 #ifdef FEATURE_EXTERNAL_FILTERS
1853 "FEATURE_FAST_REDIRECTS",
1854 #ifdef FEATURE_FAST_REDIRECTS
1861 "FEATURE_FORCE_LOAD",
1862 #ifdef FEATURE_FORCE_LOAD
1869 "FEATURE_GRACEFUL_TERMINATION",
1870 #ifdef FEATURE_GRACEFUL_TERMINATION
1877 "FEATURE_IMAGE_BLOCKING",
1878 #ifdef FEATURE_IMAGE_BLOCKING
1885 "FEATURE_IPV6_SUPPORT",
1894 #ifdef FEATURE_NO_GIFS
1902 #ifdef FEATURE_PTHREAD
1909 "FEATURE_STATISTICS",
1910 #ifdef FEATURE_STATISTICS
1917 "FEATURE_STRPTIME_SANITY_CHECKS",
1918 #ifdef FEATURE_STRPTIME_SANITY_CHECKS
1926 #ifdef FEATURE_TOGGLE
1934 #ifdef FEATURE_TRUST
1949 "FEATURE_DYNAMIC_PCRE",
1950 #ifdef FEATURE_DYNAMIC_PCRE
1958 for (i = 0; i < SZ(features); i++)
1960 err = map_conditional(exports, features[i].name, features[i].is_available);
1972 /*********************************************************************
1974 * Function : show_rcs
1976 * Description : Create a string with the rcs info for all sourcefiles
1980 * Returns : A string, or NULL on out-of-memory.
1982 *********************************************************************/
1983 static char *show_rcs(void)
1985 char *result = strdup_or_die("");
1986 char buf[BUFFER_SIZE];
1988 /* Instead of including *all* dot h's in the project (thus creating a
1989 * tremendous amount of dependencies), I will concede to declaring them
1990 * as extern's. This forces the developer to add to this list, but oh well.
1993 #define SHOW_RCS(__x) \
1995 extern const char __x[]; \
1996 snprintf(buf, sizeof(buf), " %s\n", __x); \
1997 string_append(&result, buf); \
2000 /* In alphabetical order */
2001 SHOW_RCS(actions_h_rcs)
2002 SHOW_RCS(actions_rcs)
2004 SHOW_RCS(amiga_h_rcs)
2006 #endif /* def AMIGA */
2009 #ifdef FEATURE_CGI_EDIT_ACTIONS
2010 SHOW_RCS(cgiedit_h_rcs)
2011 SHOW_RCS(cgiedit_rcs)
2012 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
2013 SHOW_RCS(cgisimple_h_rcs)
2014 SHOW_RCS(cgisimple_rcs)
2015 SHOW_RCS(deanimate_h_rcs)
2016 SHOW_RCS(deanimate_rcs)
2017 SHOW_RCS(encode_h_rcs)
2018 SHOW_RCS(encode_rcs)
2019 SHOW_RCS(errlog_h_rcs)
2020 SHOW_RCS(errlog_rcs)
2021 SHOW_RCS(filters_h_rcs)
2022 SHOW_RCS(filters_rcs)
2023 SHOW_RCS(gateway_h_rcs)
2024 SHOW_RCS(gateway_rcs)
2025 SHOW_RCS(jbsockets_h_rcs)
2026 SHOW_RCS(jbsockets_rcs)
2029 SHOW_RCS(list_h_rcs)
2031 SHOW_RCS(loadcfg_h_rcs)
2032 SHOW_RCS(loadcfg_rcs)
2033 SHOW_RCS(loaders_h_rcs)
2034 SHOW_RCS(loaders_rcs)
2035 SHOW_RCS(miscutil_h_rcs)
2036 SHOW_RCS(miscutil_rcs)
2037 SHOW_RCS(parsers_h_rcs)
2038 SHOW_RCS(parsers_rcs)
2040 SHOW_RCS(pcrs_h_rcs)
2041 SHOW_RCS(project_h_rcs)
2042 SHOW_RCS(ssplit_h_rcs)
2043 SHOW_RCS(ssplit_rcs)
2044 SHOW_RCS(urlmatch_h_rcs)
2045 SHOW_RCS(urlmatch_rcs)
2047 #ifndef _WIN_CONSOLE
2048 SHOW_RCS(w32log_h_rcs)
2049 SHOW_RCS(w32log_rcs)
2050 SHOW_RCS(w32res_h_rcs)
2051 SHOW_RCS(w32taskbar_h_rcs)
2052 SHOW_RCS(w32taskbar_rcs)
2053 #endif /* ndef _WIN_CONSOLE */
2054 SHOW_RCS(win32_h_rcs)
2056 #endif /* def _WIN32 */
2065 /*********************************************************************
2067 * Function : cgi_show_file
2069 * Description : CGI function that shows the content of a
2070 * configuration file.
2073 * 1 : csp = Current client state (buffers, headers, etc...)
2074 * 2 : rsp = http_response data structure for output
2075 * 3 : parameters = map of cgi parameters
2078 * file : Which file to show. Only first letter is checked,
2083 * Default is to show menu and other information.
2085 * Returns : JB_ERR_OK on success
2086 * JB_ERR_MEMORY on out-of-memory error.
2088 *********************************************************************/
2089 static jb_err cgi_show_file(struct client_state *csp,
2090 struct http_response *rsp,
2091 const struct map *parameters)
2094 const char * filename = NULL;
2095 char * file_description = NULL;
2101 switch (*(lookup(parameters, "file")))
2104 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2106 filename = csp->actions_list[i]->filename;
2107 file_description = "Actions File";
2112 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2114 filename = csp->rlist[i]->filename;
2115 file_description = "Filter File";
2119 #ifdef FEATURE_TRUST
2123 filename = csp->tlist->filename;
2124 file_description = "Trust File";
2127 #endif /* def FEATURE_TRUST */
2130 if (NULL != filename)
2132 struct map *exports;
2137 exports = default_exports(csp, "show-status");
2138 if (NULL == exports)
2140 return JB_ERR_MEMORY;
2143 if (map(exports, "file-description", 1, file_description, 1)
2144 || map(exports, "filepath", 1, html_encode(filename), 0))
2147 return JB_ERR_MEMORY;
2150 err = load_file(filename, &s, &length);
2151 if (JB_ERR_OK != err)
2153 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2156 return JB_ERR_MEMORY;
2161 s = html_encode_and_free_original(s);
2165 return JB_ERR_MEMORY;
2168 if (map(exports, "contents", 1, s, 0))
2171 return JB_ERR_MEMORY;
2175 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2178 return JB_ERR_CGI_PARAMS;
2182 /*********************************************************************
2184 * Function : load_file
2186 * Description : Loads a file into a buffer.
2189 * 1 : filename = Name of the file to be loaded.
2190 * 2 : buffer = Used to return the file's content.
2191 * 3 : length = Used to return the size of the file.
2193 * Returns : JB_ERR_OK in case of success,
2194 * JB_ERR_FILE in case of ordinary file loading errors
2195 * (fseek() and ftell() errors are fatal)
2196 * JB_ERR_MEMORY in case of out-of-memory.
2198 *********************************************************************/
2199 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2203 jb_err err = JB_ERR_OK;
2205 fp = fopen(filename, "rb");
2208 log_error(LOG_LEVEL_ERROR, "Failed to open %s: %E", filename);
2212 /* Get file length */
2213 if (fseek(fp, 0, SEEK_END))
2215 log_error(LOG_LEVEL_FATAL,
2216 "Unexpected error while fseek()ing to the end of %s: %E",
2222 log_error(LOG_LEVEL_FATAL,
2223 "Unexpected ftell() error while loading %s: %E",
2226 *length = (size_t)ret;
2228 /* Go back to the beginning. */
2229 if (fseek(fp, 0, SEEK_SET))
2231 log_error(LOG_LEVEL_FATAL,
2232 "Unexpected error while fseek()ing to the beginning of %s: %E",
2236 *buffer = zalloc_or_die(*length + 1);
2238 if (1 != fread(*buffer, *length, 1, fp))
2241 * May theoretically happen if the file size changes between
2242 * fseek() and fread() because it's edited in-place. Privoxy
2243 * and common text editors don't do that, thus we just fail.
2245 log_error(LOG_LEVEL_ERROR,
2246 "Couldn't completely read file %s.", filename);