1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.105 2011/02/14 16:07:32 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
6 * Purpose : Simple CGIs to get information about Privoxy's
9 * Functions declared include:
12 * Copyright : Written by and Copyright (C) 2001-2011 the
13 * Privoxy team. http://www.privoxy.org/
15 * Based on the Internet Junkbuster originally written
16 * by and Copyright (C) 1997 Anonymous Coders and
17 * Junkbusters Corporation. http://www.junkbusters.com
19 * This program is free software; you can redistribute it
20 * and/or modify it under the terms of the GNU General
21 * Public License as published by the Free Software
22 * Foundation; either version 2 of the License, or (at
23 * your option) any later version.
25 * This program is distributed in the hope that it will
26 * be useful, but WITHOUT ANY WARRANTY; without even the
27 * implied warranty of MERCHANTABILITY or FITNESS FOR A
28 * PARTICULAR PURPOSE. See the GNU General Public
29 * License for more details.
31 * The GNU General Public License should be included with
32 * this file. If not, you can view it at
33 * http://www.gnu.org/copyleft/gpl.html
34 * or write to the Free Software Foundation, Inc., 59
35 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
37 **********************************************************************/
43 #include <sys/types.h>
51 #endif /* def HAVE_ACCESS */
55 #include "cgisimple.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("404 Privoxy configuration page not found");
149 if (rsp->status == NULL)
152 return JB_ERR_MEMORY;
155 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
159 #ifdef FEATURE_GRACEFUL_TERMINATION
160 /*********************************************************************
164 * Description : CGI function to shut down Privoxy.
165 * NOTE: Turning this on in a production build
166 * would be a BAD idea. An EXTREMELY BAD idea.
167 * In short, don't do it.
170 * 1 : csp = Current client state (buffers, headers, etc...)
171 * 2 : rsp = http_response data structure for output
172 * 3 : parameters = map of cgi parameters
174 * CGI Parameters : none
176 * Returns : JB_ERR_OK on success
177 * JB_ERR_MEMORY on out-of-memory error.
179 *********************************************************************/
180 jb_err cgi_die (struct client_state *csp,
181 struct http_response *rsp,
182 const struct map *parameters)
192 * I don't really care what gets sent back to the browser.
193 * Take the easy option - "out of memory" page.
196 return JB_ERR_MEMORY;
198 #endif /* def FEATURE_GRACEFUL_TERMINATION */
201 /*********************************************************************
203 * Function : cgi_show_request
205 * Description : Show the client's request and what sed() would have
209 * 1 : csp = Current client state (buffers, headers, etc...)
210 * 2 : rsp = http_response data structure for output
211 * 3 : parameters = map of cgi parameters
213 * CGI Parameters : none
215 * Returns : JB_ERR_OK on success
216 * JB_ERR_MEMORY on out-of-memory error.
218 *********************************************************************/
219 jb_err cgi_show_request(struct client_state *csp,
220 struct http_response *rsp,
221 const struct map *parameters)
230 if (NULL == (exports = default_exports(csp, "show-request")))
232 return JB_ERR_MEMORY;
236 * Repair the damage done to the IOB by get_header()
238 for (p = csp->iob->buf; p < csp->iob->eod; p++)
240 if (*p == '\0') *p = '\n';
244 * Export the original client's request and the one we would
245 * be sending to the server if this wasn't a CGI call
248 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
251 return JB_ERR_MEMORY;
254 if (map(exports, "processed-request", 1,
255 html_encode_and_free_original(list_to_text(csp->headers)), 0))
258 return JB_ERR_MEMORY;
261 return template_fill_for_cgi(csp, "show-request", exports, rsp);
265 /*********************************************************************
267 * Function : cgi_send_banner
269 * Description : CGI function that returns a banner.
272 * 1 : csp = Current client state (buffers, headers, etc...)
273 * 2 : rsp = http_response data structure for output
274 * 3 : parameters = map of cgi parameters
277 * type : Selects the type of banner between "trans", "logo",
278 * and "auto". Defaults to "logo" if absent or invalid.
279 * "auto" means to select as if we were image-blocking.
280 * (Only the first character really counts; b and t are
283 * Returns : JB_ERR_OK on success
284 * JB_ERR_MEMORY on out-of-memory error.
286 *********************************************************************/
287 jb_err cgi_send_banner(struct client_state *csp,
288 struct http_response *rsp,
289 const struct map *parameters)
291 char imagetype = lookup(parameters, "type")[0];
294 * If type is auto, then determine the right thing
295 * to do from the set-image-blocker action
297 if (imagetype == 'a')
304 #ifdef FEATURE_IMAGE_BLOCKING
305 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
307 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
308 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
309 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
313 /* Use default - nothing to do here. */
315 else if (0 == strcmpic(p, "blank"))
319 else if (0 == strcmpic(p, "pattern"))
325 * If the action is to call this CGI, determine
328 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
330 imagetype = p[sizeof(prefix1) - 1];
332 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
334 imagetype = p[sizeof(prefix2) - 1];
338 * Everything else must (should) be a URL to
346 #endif /* def FEATURE_IMAGE_BLOCKING */
350 * Now imagetype is either the non-auto type we were called with,
351 * or it was auto and has since been determined. In any case, we
352 * can proceed to actually answering the request by sending a redirect
353 * or an image as appropriate:
355 if (imagetype == 'r')
357 rsp->status = strdup("302 Local Redirect from Privoxy");
358 if (rsp->status == NULL)
360 return JB_ERR_MEMORY;
362 if (enlist_unique_header(rsp->headers, "Location",
363 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
365 return JB_ERR_MEMORY;
370 if ((imagetype == 'b') || (imagetype == 't'))
372 rsp->body = bindup(image_blank_data, image_blank_length);
373 rsp->content_length = image_blank_length;
377 rsp->body = bindup(image_pattern_data, image_pattern_length);
378 rsp->content_length = image_pattern_length;
381 if (rsp->body == NULL)
383 return JB_ERR_MEMORY;
385 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
387 return JB_ERR_MEMORY;
398 /*********************************************************************
400 * Function : cgi_transparent_image
402 * Description : CGI function that sends a 1x1 transparent image.
405 * 1 : csp = Current client state (buffers, headers, etc...)
406 * 2 : rsp = http_response data structure for output
407 * 3 : parameters = map of cgi parameters
409 * CGI Parameters : None
411 * Returns : JB_ERR_OK on success
412 * JB_ERR_MEMORY on out-of-memory error.
414 *********************************************************************/
415 jb_err cgi_transparent_image(struct client_state *csp,
416 struct http_response *rsp,
417 const struct map *parameters)
422 rsp->body = bindup(image_blank_data, image_blank_length);
423 rsp->content_length = image_blank_length;
425 if (rsp->body == NULL)
427 return JB_ERR_MEMORY;
430 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
432 return JB_ERR_MEMORY;
442 /*********************************************************************
444 * Function : cgi_send_default_favicon
446 * Description : CGI function that sends the standard favicon.
449 * 1 : csp = Current client state (buffers, headers, etc...)
450 * 2 : rsp = http_response data structure for output
451 * 3 : parameters = map of cgi parameters
453 * CGI Parameters : None
455 * Returns : JB_ERR_OK on success
456 * JB_ERR_MEMORY on out-of-memory error.
458 *********************************************************************/
459 jb_err cgi_send_default_favicon(struct client_state *csp,
460 struct http_response *rsp,
461 const struct map *parameters)
463 static const char default_favicon_data[] =
464 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
465 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
466 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
467 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
468 "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
469 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
470 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
471 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
472 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
473 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
474 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
475 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
476 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
478 static const size_t favicon_length = sizeof(default_favicon_data) - 1;
483 rsp->body = bindup(default_favicon_data, favicon_length);
484 rsp->content_length = favicon_length;
486 if (rsp->body == NULL)
488 return JB_ERR_MEMORY;
491 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
493 return JB_ERR_MEMORY;
503 /*********************************************************************
505 * Function : cgi_send_error_favicon
507 * Description : CGI function that sends the favicon for error pages.
510 * 1 : csp = Current client state (buffers, headers, etc...)
511 * 2 : rsp = http_response data structure for output
512 * 3 : parameters = map of cgi parameters
514 * CGI Parameters : None
516 * Returns : JB_ERR_OK on success
517 * JB_ERR_MEMORY on out-of-memory error.
519 *********************************************************************/
520 jb_err cgi_send_error_favicon(struct client_state *csp,
521 struct http_response *rsp,
522 const struct map *parameters)
524 static const char error_favicon_data[] =
525 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
526 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
527 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
528 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
529 "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
530 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
531 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
532 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
533 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
534 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
535 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
536 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
537 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
539 static const size_t favicon_length = sizeof(error_favicon_data) - 1;
544 rsp->body = bindup(error_favicon_data, favicon_length);
545 rsp->content_length = favicon_length;
547 if (rsp->body == NULL)
549 return JB_ERR_MEMORY;
552 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
554 return JB_ERR_MEMORY;
564 /*********************************************************************
566 * Function : cgi_send_stylesheet
568 * Description : CGI function that sends a css stylesheet found
569 * in the cgi-style.css template
572 * 1 : csp = Current client state (buffers, headers, etc...)
573 * 2 : rsp = http_response data structure for output
574 * 3 : parameters = map of cgi parameters
576 * CGI Parameters : None
578 * Returns : JB_ERR_OK on success
579 * JB_ERR_MEMORY on out-of-memory error.
581 *********************************************************************/
582 jb_err cgi_send_stylesheet(struct client_state *csp,
583 struct http_response *rsp,
584 const struct map *parameters)
593 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
595 if (err == JB_ERR_FILE)
598 * No way to tell user; send empty stylesheet
600 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
604 return err; /* JB_ERR_MEMORY */
607 if (enlist(rsp->headers, "Content-Type: text/css"))
609 return JB_ERR_MEMORY;
617 /*********************************************************************
619 * Function : cgi_send_url_info_osd
621 * Description : CGI function that sends the OpenSearch Description
622 * template for the show-url-info page. It allows to
623 * access the page through "search engine plugins".
626 * 1 : csp = Current client state (buffers, headers, etc...)
627 * 2 : rsp = http_response data structure for output
628 * 3 : parameters = map of cgi parameters
630 * CGI Parameters : None
632 * Returns : JB_ERR_OK on success
633 * JB_ERR_MEMORY on out-of-memory error.
635 *********************************************************************/
636 jb_err cgi_send_url_info_osd(struct client_state *csp,
637 struct http_response *rsp,
638 const struct map *parameters)
640 jb_err err = JB_ERR_MEMORY;
641 struct map *exports = default_exports(csp, NULL);
648 err = template_fill_for_cgi(csp, "url-info-osd.xml", exports, rsp);
649 if (JB_ERR_OK == err)
651 err = enlist(rsp->headers,
652 "Content-Type: application/opensearchdescription+xml");
661 /*********************************************************************
663 * Function : get_content_type
665 * Description : Use the file extension to guess the content type
666 * header we should use to serve the file.
669 * 1 : filename = Name of the file whose content type
672 * Returns : The guessed content type.
674 *********************************************************************/
675 static const char *get_content_type(const char *filename)
680 const char *extension;
681 const char *content_type;
683 static const struct content_type content_types[] =
685 {".css", "text/css"},
686 {".jpg", "image/jpeg"},
687 {".jpeg", "image/jpeg"},
688 {".png", "image/png"},
691 for (i = 0; i < SZ(content_types); i++)
693 if (strstr(filename, content_types[i].extension))
695 return content_types[i].content_type;
699 /* No match by extension, default to html */
703 /*********************************************************************
705 * Function : cgi_send_user_manual
707 * Description : CGI function that sends a file in the user
711 * 1 : csp = Current client state (buffers, headers, etc...)
712 * 2 : rsp = http_response data structure for output
713 * 3 : parameters = map of cgi parameters
715 * CGI Parameters : file=name.html, the name of the HTML file
716 * (relative to user-manual from config)
718 * Returns : JB_ERR_OK on success
719 * JB_ERR_MEMORY on out-of-memory error.
721 *********************************************************************/
722 jb_err cgi_send_user_manual(struct client_state *csp,
723 struct http_response *rsp,
724 const struct map *parameters)
726 const char *filename;
728 jb_err err = JB_ERR_OK;
729 const char *content_type;
735 if (0 == strncmpic(csp->config->usermanual, "http://", 7))
737 log_error(LOG_LEVEL_CGI, "Request for local user-manual "
738 "received while user-manual delivery is disabled.");
739 return cgi_error_404(csp, rsp, parameters);
742 if (!parameters->first)
744 /* requested http://p.p/user-manual (without trailing slash) */
745 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
748 get_string_param(parameters, "file", &filename);
749 if (filename == NULL)
751 /* It's '/' so serve the index.html if there is one. */
752 filename = "index.html";
754 else if (NULL != strchr(filename, '/') || NULL != strstr(filename, ".."))
757 * We currently only support a flat file
758 * hierachy for the documentation.
760 log_error(LOG_LEVEL_ERROR,
761 "Rejecting the request to serve '%s' as it contains '/' or '..'",
763 return JB_ERR_CGI_PARAMS;
766 full_path = make_path(csp->config->usermanual, filename);
767 if (full_path == NULL)
769 return JB_ERR_MEMORY;
772 err = load_file(full_path, &rsp->body, &rsp->content_length);
773 if (JB_ERR_OK != err)
775 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
776 if (JB_ERR_FILE == err)
778 err = cgi_error_no_template(csp, rsp, full_path);
785 content_type = get_content_type(filename);
786 log_error(LOG_LEVEL_CGI,
787 "Content-Type guessed for %s: %s", filename, content_type);
789 return enlist_unique_header(rsp->headers, "Content-Type", content_type);
794 /*********************************************************************
796 * Function : cgi_show_version
798 * Description : CGI function that returns a a web page describing the
799 * file versions of Privoxy.
802 * 1 : csp = Current client state (buffers, headers, etc...)
803 * 2 : rsp = http_response data structure for output
804 * 3 : parameters = map of cgi parameters
806 * CGI Parameters : none
808 * Returns : JB_ERR_OK on success
809 * JB_ERR_MEMORY on out-of-memory error.
811 *********************************************************************/
812 jb_err cgi_show_version(struct client_state *csp,
813 struct http_response *rsp,
814 const struct map *parameters)
822 if (NULL == (exports = default_exports(csp, "show-version")))
824 return JB_ERR_MEMORY;
827 if (map(exports, "sourceversions", 1, show_rcs(), 0))
830 return JB_ERR_MEMORY;
833 return template_fill_for_cgi(csp, "show-version", exports, rsp);
837 /*********************************************************************
839 * Function : cgi_show_status
841 * Description : CGI function that returns a web page describing the
842 * current status of Privoxy.
845 * 1 : csp = Current client state (buffers, headers, etc...)
846 * 2 : rsp = http_response data structure for output
847 * 3 : parameters = map of cgi parameters
850 * file : Which file to show. Only first letter is checked,
855 * Default is to show menu and other information.
857 * Returns : JB_ERR_OK on success
858 * JB_ERR_MEMORY on out-of-memory error.
860 *********************************************************************/
861 jb_err cgi_show_status(struct client_state *csp,
862 struct http_response *rsp,
863 const struct map *parameters)
869 char buf[BUFFER_SIZE];
870 #ifdef FEATURE_STATISTICS
871 float perc_rej; /* Percentage of http requests rejected */
873 int local_urls_rejected;
874 #endif /* ndef FEATURE_STATISTICS */
875 jb_err err = JB_ERR_OK;
883 if ('\0' != *(lookup(parameters, "file")))
885 return cgi_show_file(csp, rsp, parameters);
888 if (NULL == (exports = default_exports(csp, "show-status")))
890 return JB_ERR_MEMORY;
894 for (j = 0; (s != NULL) && (j < Argc); j++)
896 if (!err) err = string_join (&s, html_encode(Argv[j]));
897 if (!err) err = string_append(&s, " ");
899 if (!err) err = map(exports, "invocation", 1, s, 0);
901 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
902 if (!err) err = show_defines(exports);
907 return JB_ERR_MEMORY;
910 #ifdef FEATURE_STATISTICS
911 local_urls_read = urls_read;
912 local_urls_rejected = urls_rejected;
915 * Need to alter the stats not to include the fetch of this
918 * Can't do following thread safely! doh!
921 * urls_rejected--; * This will be incremented subsequently *
924 if (local_urls_read == 0)
926 if (!err) err = map_block_killer(exports, "have-stats");
930 if (!err) err = map_block_killer(exports, "have-no-stats");
932 perc_rej = (float)local_urls_rejected * 100.0F /
933 (float)local_urls_read;
935 snprintf(buf, sizeof(buf), "%d", local_urls_read);
936 if (!err) err = map(exports, "requests-received", 1, buf, 1);
938 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
939 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
941 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
942 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
945 #else /* ndef FEATURE_STATISTICS */
946 err = err || map_block_killer(exports, "statistics");
947 #endif /* ndef FEATURE_STATISTICS */
950 * List all action files in use, together with view and edit links,
951 * except for standard.action, which should only be viewable. (Not
952 * enforced in the editor itself)
953 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
956 for (i = 0; i < MAX_AF_FILES; i++)
958 if (csp->actions_list[i] != NULL)
960 if (!err) err = string_append(&s, "<tr><td>");
961 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
962 snprintf(buf, sizeof(buf),
963 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%u\">View</a>", i);
964 if (!err) err = string_append(&s, buf);
966 #ifdef FEATURE_CGI_EDIT_ACTIONS
967 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
968 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
969 && (NULL != csp->config->actions_file_short[i]))
972 if (access(csp->config->actions_file[i], W_OK) == 0)
974 #endif /* def HAVE_ACCESS */
975 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
976 if (!err) err = string_append(&s, buf);
981 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
983 #endif /* def HAVE_ACCESS */
987 if (!err) err = string_append(&s, "</td></tr>\n");
992 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
996 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1000 * List all re_filterfiles in use, together with view options.
1001 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1004 for (i = 0; i < MAX_AF_FILES; i++)
1006 if (csp->rlist[i] != NULL)
1008 if (!err) err = string_append(&s, "<tr><td>");
1009 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1010 snprintf(buf, sizeof(buf),
1011 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%u\">View</a>", i);
1012 if (!err) err = string_append(&s, buf);
1013 if (!err) err = string_append(&s, "</td></tr>\n");
1018 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1022 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1023 if (!err) err = map_block_killer(exports, "have-filterfile");
1026 #ifdef FEATURE_TRUST
1029 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1033 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1034 if (!err) err = map_block_killer(exports, "have-trustfile");
1037 if (!err) err = map_block_killer(exports, "trust-support");
1038 #endif /* ndef FEATURE_TRUST */
1040 #ifdef FEATURE_CGI_EDIT_ACTIONS
1041 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1043 err = map_block_killer(exports, "cgi-editor-is-disabled");
1045 #endif /* ndef CGI_EDIT_ACTIONS */
1050 return JB_ERR_MEMORY;
1053 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1057 /*********************************************************************
1059 * Function : cgi_show_url_info
1061 * Description : CGI function that determines and shows which actions
1062 * Privoxy will perform for a given url, and which
1063 * matches starting from the defaults have lead to that.
1066 * 1 : csp = Current client state (buffers, headers, etc...)
1067 * 2 : rsp = http_response data structure for output
1068 * 3 : parameters = map of cgi parameters
1071 * url : The url whose actions are to be determined.
1072 * If url is unset, the url-given conditional will be
1073 * set, so that all but the form can be suppressed in
1076 * Returns : JB_ERR_OK on success
1077 * JB_ERR_MEMORY on out-of-memory error.
1079 *********************************************************************/
1080 jb_err cgi_show_url_info(struct client_state *csp,
1081 struct http_response *rsp,
1082 const struct map *parameters)
1085 struct map *exports;
1092 if (NULL == (exports = default_exports(csp, "show-url-info")))
1094 return JB_ERR_MEMORY;
1098 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1100 url_param = strdup(lookup(parameters, "url"));
1101 if (url_param == NULL)
1104 return JB_ERR_MEMORY;
1109 * Handle prefixes. 4 possibilities:
1110 * 1) "http://" or "https://" prefix present and followed by URL - OK
1111 * 2) Only the "http://" or "https://" part is present, no URL - change
1112 * to empty string so it will be detected later as "no URL".
1113 * 3) Parameter specified but doesn't start with "http(s?)://" - add a
1115 * 4) Parameter not specified or is empty string - let this fall through
1116 * for now, next block of code will handle it.
1118 if (0 == strncmp(url_param, "http://", 7))
1120 if (url_param[7] == '\0')
1123 * Empty URL (just prefix).
1124 * Make it totally empty so it's caught by the next if()
1126 url_param[0] = '\0';
1129 else if (0 == strncmp(url_param, "https://", 8))
1131 if (url_param[8] == '\0')
1134 * Empty URL (just prefix).
1135 * Make it totally empty so it's caught by the next if()
1137 url_param[0] = '\0';
1140 else if ((url_param[0] != '\0')
1141 && ((NULL == strstr(url_param, "://")
1142 || (strstr(url_param, "://") > strstr(url_param, "/")))))
1145 * No prefix or at least no prefix before
1146 * the first slash - assume http://
1148 char *url_param_prefixed = strdup("http://");
1150 if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1153 return JB_ERR_MEMORY;
1155 url_param = url_param_prefixed;
1159 * Hide "toggle off" warning if Privoxy is toggled on.
1162 #ifdef FEATURE_TOGGLE
1163 (global_toggle_state == 1) &&
1164 #endif /* def FEATURE_TOGGLE */
1165 map_block_killer(exports, "privoxy-is-toggled-off")
1169 return JB_ERR_MEMORY;
1172 if (url_param[0] == '\0')
1174 /* URL paramater not specified, display query form only. */
1176 if (map_block_killer(exports, "url-given")
1177 || map(exports, "url", 1, "", 1))
1180 return JB_ERR_MEMORY;
1185 /* Given a URL, so query it. */
1190 struct file_list *fl;
1191 struct url_actions *b;
1192 struct http_request url_to_query[1];
1193 struct current_action_spec action[1];
1196 if (map(exports, "url", 1, html_encode(url_param), 0))
1200 return JB_ERR_MEMORY;
1203 init_current_action(action);
1205 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1207 free_current_action(action);
1210 return JB_ERR_MEMORY;
1213 memset(url_to_query, '\0', sizeof(url_to_query));
1214 err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1215 assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1219 if (err == JB_ERR_MEMORY)
1221 free_http_request(url_to_query);
1222 free_current_action(action);
1224 return JB_ERR_MEMORY;
1230 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1231 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1232 if (!err) err = map_block_killer(exports, "valid-url");
1234 free_current_action(action);
1235 free_http_request(url_to_query);
1240 return JB_ERR_MEMORY;
1243 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1247 * We have a warning about SSL paths. Hide it for unencrypted sites.
1249 if (!url_to_query->ssl)
1251 if (map_block_killer(exports, "https"))
1253 free_current_action(action);
1255 free_http_request(url_to_query);
1256 return JB_ERR_MEMORY;
1260 matches = strdup("<table summary=\"\" class=\"transparent\">");
1262 for (i = 0; i < MAX_AF_FILES; i++)
1264 if (NULL == csp->config->actions_file_short[i]
1265 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1269 if ((fl = csp->actions_list[i]) != NULL)
1271 if ((b = fl->f) != NULL)
1273 /* FIXME: Hardcoded HTML! */
1274 string_append(&matches, "<tr><th>In file: ");
1275 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1276 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1277 string_append(&matches, buf);
1278 string_append(&matches, "View</a>");
1279 #ifdef FEATURE_CGI_EDIT_ACTIONS
1280 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1283 if (access(csp->config->actions_file[i], W_OK) == 0)
1285 #endif /* def HAVE_ACCESS */
1286 snprintf(buf, sizeof(buf),
1287 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1288 string_append(&matches, buf);
1289 string_append(&matches, "Edit</a>");
1294 string_append(&matches, " <strong>No write access.</strong>");
1296 #endif /* def HAVE_ACCESS */
1298 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1300 string_append(&matches, "</th></tr>\n");
1307 for (; (b != NULL) && (matches != NULL); b = b->next)
1309 if (url_match(b->url, url_to_query))
1311 string_append(&matches, "<tr><td>{");
1312 string_join (&matches, actions_to_html(csp, b->action));
1313 string_append(&matches, " }<br>\n<code>");
1314 string_join (&matches, html_encode(b->url->spec));
1315 string_append(&matches, "</code></td></tr>\n");
1317 if (merge_current_action(action, b->action))
1320 free_http_request(url_to_query);
1321 free_current_action(action);
1323 return JB_ERR_MEMORY;
1331 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1334 string_append(&matches, "</table>\n");
1337 * XXX: Kludge to make sure the "Forward settings" section
1338 * shows what forward-override{} would do with the requested URL.
1339 * No one really cares how the CGI request would be forwarded
1340 * if it wasn't intercepted as CGI request in the first place.
1342 * From here on the action bitmask will no longer reflect
1343 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1344 * but luckily it's no longer required later on anyway.
1346 free_current_action(csp->action);
1347 get_url_actions(csp, url_to_query);
1350 * Fill in forwarding settings.
1352 * The possibilities are:
1354 * - http forwarding only
1355 * - socks4(a) forwarding only
1356 * - socks4(a) and http forwarding.
1358 * XXX: Parts of this code could be reused for the
1359 * "forwarding-failed" template which currently doesn't
1360 * display the proxy port and an eventual second forwarder.
1363 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1365 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1367 if (!err) err = map_block_killer(exports, "socks-forwarder");
1368 if (!err) err = map_block_killer(exports, "http-forwarder");
1372 char port[10]; /* We save proxy ports as int but need a string here */
1374 if (!err) err = map_block_killer(exports, "no-forwarder");
1376 if (fwd->gateway_host != NULL)
1378 char *socks_type = NULL;
1383 socks_type = "socks4";
1386 socks_type = "socks4a";
1389 socks_type = "socks5";
1392 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1395 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1396 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1397 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1398 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1402 if (!err) err = map_block_killer(exports, "socks-forwarder");
1405 if (fwd->forward_host != NULL)
1407 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1408 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1409 if (!err) err = map(exports, "forward-port", 1, port, 1);
1413 if (!err) err = map_block_killer(exports, "http-forwarder");
1418 free_http_request(url_to_query);
1420 if (err || matches == NULL)
1422 free_current_action(action);
1424 return JB_ERR_MEMORY;
1427 #ifdef FEATURE_CGI_EDIT_ACTIONS
1428 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1430 err = map_block_killer(exports, "cgi-editor-is-disabled");
1432 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1435 * If zlib support is available, if no content filters
1436 * are enabled or if the prevent-compression action is enabled,
1437 * suppress the "compression could prevent filtering" warning.
1439 #ifndef FEATURE_ZLIB
1440 if (!content_filters_enabled(action) ||
1441 (action->flags & ACTION_NO_COMPRESSION))
1444 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1447 if (err || map(exports, "matches", 1, matches , 0))
1449 free_current_action(action);
1451 return JB_ERR_MEMORY;
1454 s = current_action_to_html(csp, action);
1456 free_current_action(action);
1458 if (map(exports, "final", 1, s, 0))
1461 return JB_ERR_MEMORY;
1465 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1469 /*********************************************************************
1471 * Function : cgi_robots_txt
1473 * Description : CGI function to return "/robots.txt".
1476 * 1 : csp = Current client state (buffers, headers, etc...)
1477 * 2 : rsp = http_response data structure for output
1478 * 3 : parameters = map of cgi parameters
1480 * CGI Parameters : None
1482 * Returns : JB_ERR_OK on success
1483 * JB_ERR_MEMORY on out-of-memory error.
1485 *********************************************************************/
1486 jb_err cgi_robots_txt(struct client_state *csp,
1487 struct http_response *rsp,
1488 const struct map *parameters)
1497 "# This is the Privoxy control interface.\n"
1498 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1504 if (rsp->body == NULL)
1506 return JB_ERR_MEMORY;
1509 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1513 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1514 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1516 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1520 /*********************************************************************
1522 * Function : show_defines
1524 * Description : Add to a map the state od all conditional #defines
1525 * used when building
1528 * 1 : exports = map to extend
1530 * Returns : JB_ERR_OK on success
1531 * JB_ERR_MEMORY on out-of-memory error.
1533 *********************************************************************/
1534 static jb_err show_defines(struct map *exports)
1536 jb_err err = JB_ERR_OK;
1538 #ifdef FEATURE_ACCEPT_FILTER
1539 if (!err) err = map_conditional(exports, "FEATURE_ACCEPT_FILTER", 1);
1540 #else /* ifndef FEATURE_ACCEPT_FILTER */
1541 if (!err) err = map_conditional(exports, "FEATURE_ACCEPT_FILTER", 0);
1542 #endif /* ndef FEATURE_ACCEPT_FILTER */
1545 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1546 #else /* ifndef FEATURE_ACL */
1547 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1548 #endif /* ndef FEATURE_ACL */
1550 #ifdef FEATURE_CGI_EDIT_ACTIONS
1551 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1552 #else /* ifndef FEATURE_CGI_EDIT_ACTIONS */
1553 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1554 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1556 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1557 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 1);
1558 #else /* ifndef FEATURE_CONNECTION_KEEP_ALIVE */
1559 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 0);
1560 #endif /* ndef FEATURE_CONNECTION_KEEP_ALIVE */
1562 #ifdef FEATURE_CONNECTION_SHARING
1563 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 1);
1564 #else /* ifndef FEATURE_CONNECTION_SHARING */
1565 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 0);
1566 #endif /* ndef FEATURE_CONNECTION_SHARING */
1568 #ifdef FEATURE_FAST_REDIRECTS
1569 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1570 #else /* ifndef FEATURE_FAST_REDIRECTS */
1571 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1572 #endif /* ndef FEATURE_FAST_REDIRECTS */
1574 #ifdef FEATURE_FORCE_LOAD
1575 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1576 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1577 #else /* ifndef FEATURE_FORCE_LOAD */
1578 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1579 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1580 #endif /* ndef FEATURE_FORCE_LOAD */
1582 #ifdef FEATURE_GRACEFUL_TERMINATION
1583 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1584 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1585 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1586 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1588 #ifdef FEATURE_IMAGE_BLOCKING
1589 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1590 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1591 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1592 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1594 #ifdef FEATURE_IMAGE_DETECT_MSIE
1595 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1596 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1597 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1598 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1601 if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 1);
1602 #else /* ifndef HAVE_RFC2553 */
1603 if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 0);
1604 #endif /* ndef HAVE_RFC2553 */
1606 #ifdef FEATURE_NO_GIFS
1607 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1608 #else /* ifndef FEATURE_NO_GIFS */
1609 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1610 #endif /* ndef FEATURE_NO_GIFS */
1612 #ifdef FEATURE_PTHREAD
1613 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1614 #else /* ifndef FEATURE_PTHREAD */
1615 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1616 #endif /* ndef FEATURE_PTHREAD */
1618 #ifdef FEATURE_STATISTICS
1619 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1620 #else /* ifndef FEATURE_STATISTICS */
1621 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1622 #endif /* ndef FEATURE_STATISTICS */
1624 #ifdef FEATURE_TOGGLE
1625 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1626 #else /* ifndef FEATURE_TOGGLE */
1627 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1628 #endif /* ndef FEATURE_TOGGLE */
1630 #ifdef FEATURE_TRUST
1631 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1632 #else /* ifndef FEATURE_TRUST */
1633 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1634 #endif /* ndef FEATURE_TRUST */
1637 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1638 #else /* ifndef FEATURE_ZLIB */
1639 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1640 #endif /* ndef FEATURE_ZLIB */
1643 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1644 #else /* ifndef STATIC_PCRE */
1645 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1646 #endif /* ndef STATIC_PCRE */
1649 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1650 #else /* ifndef STATIC_PCRS */
1651 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1652 #endif /* ndef STATIC_PCRS */
1658 /*********************************************************************
1660 * Function : show_rcs
1662 * Description : Create a string with the rcs info for all sourcefiles
1666 * Returns : A string, or NULL on out-of-memory.
1668 *********************************************************************/
1669 static char *show_rcs(void)
1671 char *result = strdup("");
1672 char buf[BUFFER_SIZE];
1674 /* Instead of including *all* dot h's in the project (thus creating a
1675 * tremendous amount of dependencies), I will concede to declaring them
1676 * as extern's. This forces the developer to add to this list, but oh well.
1679 #define SHOW_RCS(__x) \
1681 extern const char __x[]; \
1682 snprintf(buf, sizeof(buf), " %s\n", __x); \
1683 string_append(&result, buf); \
1686 /* In alphabetical order */
1687 SHOW_RCS(actions_h_rcs)
1688 SHOW_RCS(actions_rcs)
1690 SHOW_RCS(amiga_h_rcs)
1692 #endif /* def AMIGA */
1695 #ifdef FEATURE_CGI_EDIT_ACTIONS
1696 SHOW_RCS(cgiedit_h_rcs)
1697 SHOW_RCS(cgiedit_rcs)
1698 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1699 SHOW_RCS(cgisimple_h_rcs)
1700 SHOW_RCS(cgisimple_rcs)
1702 SHOW_RCS(cygwin_h_rcs)
1704 SHOW_RCS(deanimate_h_rcs)
1705 SHOW_RCS(deanimate_rcs)
1706 SHOW_RCS(encode_h_rcs)
1707 SHOW_RCS(encode_rcs)
1708 SHOW_RCS(errlog_h_rcs)
1709 SHOW_RCS(errlog_rcs)
1710 SHOW_RCS(filters_h_rcs)
1711 SHOW_RCS(filters_rcs)
1712 SHOW_RCS(gateway_h_rcs)
1713 SHOW_RCS(gateway_rcs)
1714 SHOW_RCS(jbsockets_h_rcs)
1715 SHOW_RCS(jbsockets_rcs)
1718 SHOW_RCS(list_h_rcs)
1720 SHOW_RCS(loadcfg_h_rcs)
1721 SHOW_RCS(loadcfg_rcs)
1722 SHOW_RCS(loaders_h_rcs)
1723 SHOW_RCS(loaders_rcs)
1724 SHOW_RCS(miscutil_h_rcs)
1725 SHOW_RCS(miscutil_rcs)
1726 SHOW_RCS(parsers_h_rcs)
1727 SHOW_RCS(parsers_rcs)
1729 SHOW_RCS(pcrs_h_rcs)
1730 SHOW_RCS(project_h_rcs)
1731 SHOW_RCS(ssplit_h_rcs)
1732 SHOW_RCS(ssplit_rcs)
1733 SHOW_RCS(urlmatch_h_rcs)
1734 SHOW_RCS(urlmatch_rcs)
1736 #ifndef _WIN_CONSOLE
1737 SHOW_RCS(w32log_h_rcs)
1738 SHOW_RCS(w32log_rcs)
1739 SHOW_RCS(w32res_h_rcs)
1740 SHOW_RCS(w32taskbar_h_rcs)
1741 SHOW_RCS(w32taskbar_rcs)
1742 #endif /* ndef _WIN_CONSOLE */
1743 SHOW_RCS(win32_h_rcs)
1745 #endif /* def _WIN32 */
1754 /*********************************************************************
1756 * Function : cgi_show_file
1758 * Description : CGI function that shows the content of a
1759 * configuration file.
1762 * 1 : csp = Current client state (buffers, headers, etc...)
1763 * 2 : rsp = http_response data structure for output
1764 * 3 : parameters = map of cgi parameters
1767 * file : Which file to show. Only first letter is checked,
1772 * Default is to show menu and other information.
1774 * Returns : JB_ERR_OK on success
1775 * JB_ERR_MEMORY on out-of-memory error.
1777 *********************************************************************/
1778 static jb_err cgi_show_file(struct client_state *csp,
1779 struct http_response *rsp,
1780 const struct map *parameters)
1783 const char * filename = NULL;
1784 char * file_description = NULL;
1790 switch (*(lookup(parameters, "file")))
1793 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
1795 filename = csp->actions_list[i]->filename;
1796 file_description = "Actions File";
1801 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
1803 filename = csp->rlist[i]->filename;
1804 file_description = "Filter File";
1808 #ifdef FEATURE_TRUST
1812 filename = csp->tlist->filename;
1813 file_description = "Trust File";
1816 #endif /* def FEATURE_TRUST */
1819 if (NULL != filename)
1821 struct map *exports;
1826 exports = default_exports(csp, "show-status");
1827 if (NULL == exports)
1829 return JB_ERR_MEMORY;
1832 if ( map(exports, "file-description", 1, file_description, 1)
1833 || map(exports, "filepath", 1, html_encode(filename), 0) )
1836 return JB_ERR_MEMORY;
1839 err = load_file(filename, &s, &length);
1840 if (JB_ERR_OK != err)
1842 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
1845 return JB_ERR_MEMORY;
1850 s = html_encode_and_free_original(s);
1853 return JB_ERR_MEMORY;
1856 if (map(exports, "contents", 1, s, 0))
1859 return JB_ERR_MEMORY;
1863 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
1866 return JB_ERR_CGI_PARAMS;
1870 /*********************************************************************
1872 * Function : load_file
1874 * Description : Loads a file into a buffer.
1877 * 1 : filename = Name of the file to be loaded.
1878 * 2 : buffer = Used to return the file's content.
1879 * 3 : length = Used to return the size of the file.
1881 * Returns : JB_ERR_OK in case of success,
1882 * JB_ERR_FILE in case of ordinary file loading errors
1883 * (fseek() and ftell() errors are fatal)
1884 * JB_ERR_MEMORY in case of out-of-memory.
1886 *********************************************************************/
1887 static jb_err load_file(const char *filename, char **buffer, size_t *length)
1891 jb_err err = JB_ERR_OK;
1893 fp = fopen(filename, "rb");
1896 log_error(LOG_LEVEL_ERROR, "Failed to open %s: %E", filename);
1900 /* Get file length */
1901 if (fseek(fp, 0, SEEK_END))
1903 log_error(LOG_LEVEL_FATAL,
1904 "Unexpected error while fseek()ing to the end of %s: %E",
1910 log_error(LOG_LEVEL_FATAL,
1911 "Unexpected ftell() error while loading %s: %E",
1914 *length = (size_t)ret;
1916 /* Go back to the beginning. */
1917 if (fseek(fp, 0, SEEK_SET))
1919 log_error(LOG_LEVEL_FATAL,
1920 "Unexpected error while fseek()ing to the beginning of %s: %E",
1924 *buffer = (char *)zalloc(*length + 1);
1925 if (NULL == *buffer)
1927 err = JB_ERR_MEMORY;
1929 else if (!fread(*buffer, *length, 1, fp))
1932 * May happen if the file size changes between fseek() and
1933 * fread(). If it does, we just log it and serve what we got.
1935 log_error(LOG_LEVEL_ERROR,
1936 "Couldn't completely read file %s.", filename);