1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.102 2011/02/14 16:05:37 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"},
689 for (i = 0; i < SZ(content_types); i++)
691 if (strstr(filename, content_types[i].extension))
693 return content_types[i].content_type;
697 /* No match by extension, default to html */
701 /*********************************************************************
703 * Function : cgi_send_user_manual
705 * Description : CGI function that sends a file in the user
709 * 1 : csp = Current client state (buffers, headers, etc...)
710 * 2 : rsp = http_response data structure for output
711 * 3 : parameters = map of cgi parameters
713 * CGI Parameters : file=name.html, the name of the HTML file
714 * (relative to user-manual from config)
716 * Returns : JB_ERR_OK on success
717 * JB_ERR_MEMORY on out-of-memory error.
719 *********************************************************************/
720 jb_err cgi_send_user_manual(struct client_state *csp,
721 struct http_response *rsp,
722 const struct map *parameters)
724 const char * filename;
726 jb_err err = JB_ERR_OK;
732 if (0 == strncmpic(csp->config->usermanual, "http://", 7))
734 log_error(LOG_LEVEL_CGI, "Request for local user-manual "
735 "received while user-manual delivery is disabled.");
736 return cgi_error_404(csp, rsp, parameters);
739 if (!parameters->first)
741 /* requested http://p.p/user-manual (without trailing slash) */
742 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
745 get_string_param(parameters, "file", &filename);
746 if (filename == NULL)
748 /* It's '/' so serve the index.html if there is one. */
749 filename = "index.html";
751 else if (NULL != strchr(filename, '/') || NULL != strstr(filename, ".."))
754 * We currently only support a flat file
755 * hierachy for the documentation.
757 log_error(LOG_LEVEL_ERROR,
758 "Rejecting the request to serve '%s' as it contains '/' or '..'",
760 return JB_ERR_CGI_PARAMS;
763 full_path = make_path(csp->config->usermanual, filename);
764 if (full_path == NULL)
766 return JB_ERR_MEMORY;
769 err = load_file(full_path, &rsp->body, &rsp->content_length);
770 if (JB_ERR_OK != err)
772 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
773 if (JB_ERR_FILE == err)
775 err = cgi_error_no_template(csp, rsp, full_path);
782 /* Guess correct Content-Type based on the filename's ending */
785 const char *content_type = get_content_type(filename);
786 log_error(LOG_LEVEL_CGI,
787 "Content-Type guessed for %s: %s", filename, content_type);
788 err = enlist_unique_header(rsp->headers, "Content-Type", content_type);
792 /* XXX: why should this happen */
799 /*********************************************************************
801 * Function : cgi_show_version
803 * Description : CGI function that returns a a web page describing the
804 * file versions of Privoxy.
807 * 1 : csp = Current client state (buffers, headers, etc...)
808 * 2 : rsp = http_response data structure for output
809 * 3 : parameters = map of cgi parameters
811 * CGI Parameters : none
813 * Returns : JB_ERR_OK on success
814 * JB_ERR_MEMORY on out-of-memory error.
816 *********************************************************************/
817 jb_err cgi_show_version(struct client_state *csp,
818 struct http_response *rsp,
819 const struct map *parameters)
827 if (NULL == (exports = default_exports(csp, "show-version")))
829 return JB_ERR_MEMORY;
832 if (map(exports, "sourceversions", 1, show_rcs(), 0))
835 return JB_ERR_MEMORY;
838 return template_fill_for_cgi(csp, "show-version", exports, rsp);
842 /*********************************************************************
844 * Function : cgi_show_status
846 * Description : CGI function that returns a web page describing the
847 * current status of Privoxy.
850 * 1 : csp = Current client state (buffers, headers, etc...)
851 * 2 : rsp = http_response data structure for output
852 * 3 : parameters = map of cgi parameters
855 * file : Which file to show. Only first letter is checked,
860 * Default is to show menu and other information.
862 * Returns : JB_ERR_OK on success
863 * JB_ERR_MEMORY on out-of-memory error.
865 *********************************************************************/
866 jb_err cgi_show_status(struct client_state *csp,
867 struct http_response *rsp,
868 const struct map *parameters)
874 char buf[BUFFER_SIZE];
875 #ifdef FEATURE_STATISTICS
876 float perc_rej; /* Percentage of http requests rejected */
878 int local_urls_rejected;
879 #endif /* ndef FEATURE_STATISTICS */
880 jb_err err = JB_ERR_OK;
888 if ('\0' != *(lookup(parameters, "file")))
890 return cgi_show_file(csp, rsp, parameters);
893 if (NULL == (exports = default_exports(csp, "show-status")))
895 return JB_ERR_MEMORY;
899 for (j = 0; (s != NULL) && (j < Argc); j++)
901 if (!err) err = string_join (&s, html_encode(Argv[j]));
902 if (!err) err = string_append(&s, " ");
904 if (!err) err = map(exports, "invocation", 1, s, 0);
906 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
907 if (!err) err = show_defines(exports);
912 return JB_ERR_MEMORY;
915 #ifdef FEATURE_STATISTICS
916 local_urls_read = urls_read;
917 local_urls_rejected = urls_rejected;
920 * Need to alter the stats not to include the fetch of this
923 * Can't do following thread safely! doh!
926 * urls_rejected--; * This will be incremented subsequently *
929 if (local_urls_read == 0)
931 if (!err) err = map_block_killer(exports, "have-stats");
935 if (!err) err = map_block_killer(exports, "have-no-stats");
937 perc_rej = (float)local_urls_rejected * 100.0F /
938 (float)local_urls_read;
940 snprintf(buf, sizeof(buf), "%d", local_urls_read);
941 if (!err) err = map(exports, "requests-received", 1, buf, 1);
943 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
944 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
946 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
947 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
950 #else /* ndef FEATURE_STATISTICS */
951 err = err || map_block_killer(exports, "statistics");
952 #endif /* ndef FEATURE_STATISTICS */
955 * List all action files in use, together with view and edit links,
956 * except for standard.action, which should only be viewable. (Not
957 * enforced in the editor itself)
958 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
961 for (i = 0; i < MAX_AF_FILES; i++)
963 if (csp->actions_list[i] != NULL)
965 if (!err) err = string_append(&s, "<tr><td>");
966 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
967 snprintf(buf, sizeof(buf),
968 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%u\">View</a>", i);
969 if (!err) err = string_append(&s, buf);
971 #ifdef FEATURE_CGI_EDIT_ACTIONS
972 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
973 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
974 && (NULL != csp->config->actions_file_short[i]))
977 if (access(csp->config->actions_file[i], W_OK) == 0)
979 #endif /* def HAVE_ACCESS */
980 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
981 if (!err) err = string_append(&s, buf);
986 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
988 #endif /* def HAVE_ACCESS */
992 if (!err) err = string_append(&s, "</td></tr>\n");
997 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1001 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1005 * List all re_filterfiles in use, together with view options.
1006 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1009 for (i = 0; i < MAX_AF_FILES; i++)
1011 if (csp->rlist[i] != NULL)
1013 if (!err) err = string_append(&s, "<tr><td>");
1014 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1015 snprintf(buf, sizeof(buf),
1016 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%u\">View</a>", i);
1017 if (!err) err = string_append(&s, buf);
1018 if (!err) err = string_append(&s, "</td></tr>\n");
1023 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1027 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1028 if (!err) err = map_block_killer(exports, "have-filterfile");
1031 #ifdef FEATURE_TRUST
1034 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1038 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1039 if (!err) err = map_block_killer(exports, "have-trustfile");
1042 if (!err) err = map_block_killer(exports, "trust-support");
1043 #endif /* ndef FEATURE_TRUST */
1045 #ifdef FEATURE_CGI_EDIT_ACTIONS
1046 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1048 err = map_block_killer(exports, "cgi-editor-is-disabled");
1050 #endif /* ndef CGI_EDIT_ACTIONS */
1055 return JB_ERR_MEMORY;
1058 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1062 /*********************************************************************
1064 * Function : cgi_show_url_info
1066 * Description : CGI function that determines and shows which actions
1067 * Privoxy will perform for a given url, and which
1068 * matches starting from the defaults have lead to that.
1071 * 1 : csp = Current client state (buffers, headers, etc...)
1072 * 2 : rsp = http_response data structure for output
1073 * 3 : parameters = map of cgi parameters
1076 * url : The url whose actions are to be determined.
1077 * If url is unset, the url-given conditional will be
1078 * set, so that all but the form can be suppressed in
1081 * Returns : JB_ERR_OK on success
1082 * JB_ERR_MEMORY on out-of-memory error.
1084 *********************************************************************/
1085 jb_err cgi_show_url_info(struct client_state *csp,
1086 struct http_response *rsp,
1087 const struct map *parameters)
1090 struct map *exports;
1097 if (NULL == (exports = default_exports(csp, "show-url-info")))
1099 return JB_ERR_MEMORY;
1103 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1105 url_param = strdup(lookup(parameters, "url"));
1106 if (url_param == NULL)
1109 return JB_ERR_MEMORY;
1114 * Handle prefixes. 4 possibilities:
1115 * 1) "http://" or "https://" prefix present and followed by URL - OK
1116 * 2) Only the "http://" or "https://" part is present, no URL - change
1117 * to empty string so it will be detected later as "no URL".
1118 * 3) Parameter specified but doesn't start with "http(s?)://" - add a
1120 * 4) Parameter not specified or is empty string - let this fall through
1121 * for now, next block of code will handle it.
1123 if (0 == strncmp(url_param, "http://", 7))
1125 if (url_param[7] == '\0')
1128 * Empty URL (just prefix).
1129 * Make it totally empty so it's caught by the next if()
1131 url_param[0] = '\0';
1134 else if (0 == strncmp(url_param, "https://", 8))
1136 if (url_param[8] == '\0')
1139 * Empty URL (just prefix).
1140 * Make it totally empty so it's caught by the next if()
1142 url_param[0] = '\0';
1145 else if ((url_param[0] != '\0')
1146 && ((NULL == strstr(url_param, "://")
1147 || (strstr(url_param, "://") > strstr(url_param, "/")))))
1150 * No prefix or at least no prefix before
1151 * the first slash - assume http://
1153 char *url_param_prefixed = strdup("http://");
1155 if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1158 return JB_ERR_MEMORY;
1160 url_param = url_param_prefixed;
1164 * Hide "toggle off" warning if Privoxy is toggled on.
1167 #ifdef FEATURE_TOGGLE
1168 (global_toggle_state == 1) &&
1169 #endif /* def FEATURE_TOGGLE */
1170 map_block_killer(exports, "privoxy-is-toggled-off")
1174 return JB_ERR_MEMORY;
1177 if (url_param[0] == '\0')
1179 /* URL paramater not specified, display query form only. */
1181 if (map_block_killer(exports, "url-given")
1182 || map(exports, "url", 1, "", 1))
1185 return JB_ERR_MEMORY;
1190 /* Given a URL, so query it. */
1195 struct file_list *fl;
1196 struct url_actions *b;
1197 struct http_request url_to_query[1];
1198 struct current_action_spec action[1];
1201 if (map(exports, "url", 1, html_encode(url_param), 0))
1205 return JB_ERR_MEMORY;
1208 init_current_action(action);
1210 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1212 free_current_action(action);
1215 return JB_ERR_MEMORY;
1218 memset(url_to_query, '\0', sizeof(url_to_query));
1219 err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1220 assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1224 if (err == JB_ERR_MEMORY)
1226 free_http_request(url_to_query);
1227 free_current_action(action);
1229 return JB_ERR_MEMORY;
1235 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1236 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1237 if (!err) err = map_block_killer(exports, "valid-url");
1239 free_current_action(action);
1240 free_http_request(url_to_query);
1245 return JB_ERR_MEMORY;
1248 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1252 * We have a warning about SSL paths. Hide it for unencrypted sites.
1254 if (!url_to_query->ssl)
1256 if (map_block_killer(exports, "https"))
1258 free_current_action(action);
1260 free_http_request(url_to_query);
1261 return JB_ERR_MEMORY;
1265 matches = strdup("<table summary=\"\" class=\"transparent\">");
1267 for (i = 0; i < MAX_AF_FILES; i++)
1269 if (NULL == csp->config->actions_file_short[i]
1270 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1274 if ((fl = csp->actions_list[i]) != NULL)
1276 if ((b = fl->f) != NULL)
1278 /* FIXME: Hardcoded HTML! */
1279 string_append(&matches, "<tr><th>In file: ");
1280 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1281 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1282 string_append(&matches, buf);
1283 string_append(&matches, "View</a>");
1284 #ifdef FEATURE_CGI_EDIT_ACTIONS
1285 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1288 if (access(csp->config->actions_file[i], W_OK) == 0)
1290 #endif /* def HAVE_ACCESS */
1291 snprintf(buf, sizeof(buf),
1292 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1293 string_append(&matches, buf);
1294 string_append(&matches, "Edit</a>");
1299 string_append(&matches, " <strong>No write access.</strong>");
1301 #endif /* def HAVE_ACCESS */
1303 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1305 string_append(&matches, "</th></tr>\n");
1312 for (; (b != NULL) && (matches != NULL); b = b->next)
1314 if (url_match(b->url, url_to_query))
1316 string_append(&matches, "<tr><td>{");
1317 string_join (&matches, actions_to_html(csp, b->action));
1318 string_append(&matches, " }<br>\n<code>");
1319 string_join (&matches, html_encode(b->url->spec));
1320 string_append(&matches, "</code></td></tr>\n");
1322 if (merge_current_action(action, b->action))
1325 free_http_request(url_to_query);
1326 free_current_action(action);
1328 return JB_ERR_MEMORY;
1336 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1339 string_append(&matches, "</table>\n");
1342 * XXX: Kludge to make sure the "Forward settings" section
1343 * shows what forward-override{} would do with the requested URL.
1344 * No one really cares how the CGI request would be forwarded
1345 * if it wasn't intercepted as CGI request in the first place.
1347 * From here on the action bitmask will no longer reflect
1348 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1349 * but luckily it's no longer required later on anyway.
1351 free_current_action(csp->action);
1352 get_url_actions(csp, url_to_query);
1355 * Fill in forwarding settings.
1357 * The possibilities are:
1359 * - http forwarding only
1360 * - socks4(a) forwarding only
1361 * - socks4(a) and http forwarding.
1363 * XXX: Parts of this code could be reused for the
1364 * "forwarding-failed" template which currently doesn't
1365 * display the proxy port and an eventual second forwarder.
1368 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1370 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1372 if (!err) err = map_block_killer(exports, "socks-forwarder");
1373 if (!err) err = map_block_killer(exports, "http-forwarder");
1377 char port[10]; /* We save proxy ports as int but need a string here */
1379 if (!err) err = map_block_killer(exports, "no-forwarder");
1381 if (fwd->gateway_host != NULL)
1383 char *socks_type = NULL;
1388 socks_type = "socks4";
1391 socks_type = "socks4a";
1394 socks_type = "socks5";
1397 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1400 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1401 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1402 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1403 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1407 if (!err) err = map_block_killer(exports, "socks-forwarder");
1410 if (fwd->forward_host != NULL)
1412 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1413 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1414 if (!err) err = map(exports, "forward-port", 1, port, 1);
1418 if (!err) err = map_block_killer(exports, "http-forwarder");
1423 free_http_request(url_to_query);
1425 if (err || matches == NULL)
1427 free_current_action(action);
1429 return JB_ERR_MEMORY;
1432 #ifdef FEATURE_CGI_EDIT_ACTIONS
1433 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1435 err = map_block_killer(exports, "cgi-editor-is-disabled");
1437 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1440 * If zlib support is available, if no content filters
1441 * are enabled or if the prevent-compression action is enabled,
1442 * suppress the "compression could prevent filtering" warning.
1444 #ifndef FEATURE_ZLIB
1445 if (!content_filters_enabled(action) ||
1446 (action->flags & ACTION_NO_COMPRESSION))
1449 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1452 if (err || map(exports, "matches", 1, matches , 0))
1454 free_current_action(action);
1456 return JB_ERR_MEMORY;
1459 s = current_action_to_html(csp, action);
1461 free_current_action(action);
1463 if (map(exports, "final", 1, s, 0))
1466 return JB_ERR_MEMORY;
1470 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1474 /*********************************************************************
1476 * Function : cgi_robots_txt
1478 * Description : CGI function to return "/robots.txt".
1481 * 1 : csp = Current client state (buffers, headers, etc...)
1482 * 2 : rsp = http_response data structure for output
1483 * 3 : parameters = map of cgi parameters
1485 * CGI Parameters : None
1487 * Returns : JB_ERR_OK on success
1488 * JB_ERR_MEMORY on out-of-memory error.
1490 *********************************************************************/
1491 jb_err cgi_robots_txt(struct client_state *csp,
1492 struct http_response *rsp,
1493 const struct map *parameters)
1502 "# This is the Privoxy control interface.\n"
1503 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1509 if (rsp->body == NULL)
1511 return JB_ERR_MEMORY;
1514 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1518 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1519 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1521 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1525 /*********************************************************************
1527 * Function : show_defines
1529 * Description : Add to a map the state od all conditional #defines
1530 * used when building
1533 * 1 : exports = map to extend
1535 * Returns : JB_ERR_OK on success
1536 * JB_ERR_MEMORY on out-of-memory error.
1538 *********************************************************************/
1539 static jb_err show_defines(struct map *exports)
1541 jb_err err = JB_ERR_OK;
1543 #ifdef FEATURE_ACCEPT_FILTER
1544 if (!err) err = map_conditional(exports, "FEATURE_ACCEPT_FILTER", 1);
1545 #else /* ifndef FEATURE_ACCEPT_FILTER */
1546 if (!err) err = map_conditional(exports, "FEATURE_ACCEPT_FILTER", 0);
1547 #endif /* ndef FEATURE_ACCEPT_FILTER */
1550 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1551 #else /* ifndef FEATURE_ACL */
1552 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1553 #endif /* ndef FEATURE_ACL */
1555 #ifdef FEATURE_CGI_EDIT_ACTIONS
1556 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1557 #else /* ifndef FEATURE_CGI_EDIT_ACTIONS */
1558 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1559 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1561 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1562 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 1);
1563 #else /* ifndef FEATURE_CONNECTION_KEEP_ALIVE */
1564 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 0);
1565 #endif /* ndef FEATURE_CONNECTION_KEEP_ALIVE */
1567 #ifdef FEATURE_CONNECTION_SHARING
1568 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 1);
1569 #else /* ifndef FEATURE_CONNECTION_SHARING */
1570 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 0);
1571 #endif /* ndef FEATURE_CONNECTION_SHARING */
1573 #ifdef FEATURE_FAST_REDIRECTS
1574 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1575 #else /* ifndef FEATURE_FAST_REDIRECTS */
1576 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1577 #endif /* ndef FEATURE_FAST_REDIRECTS */
1579 #ifdef FEATURE_FORCE_LOAD
1580 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1581 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1582 #else /* ifndef FEATURE_FORCE_LOAD */
1583 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1584 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1585 #endif /* ndef FEATURE_FORCE_LOAD */
1587 #ifdef FEATURE_GRACEFUL_TERMINATION
1588 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1589 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1590 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1591 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1593 #ifdef FEATURE_IMAGE_BLOCKING
1594 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1595 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1596 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1597 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1599 #ifdef FEATURE_IMAGE_DETECT_MSIE
1600 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1601 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1602 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1603 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1606 if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 1);
1607 #else /* ifndef HAVE_RFC2553 */
1608 if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 0);
1609 #endif /* ndef HAVE_RFC2553 */
1611 #ifdef FEATURE_NO_GIFS
1612 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1613 #else /* ifndef FEATURE_NO_GIFS */
1614 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1615 #endif /* ndef FEATURE_NO_GIFS */
1617 #ifdef FEATURE_PTHREAD
1618 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1619 #else /* ifndef FEATURE_PTHREAD */
1620 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1621 #endif /* ndef FEATURE_PTHREAD */
1623 #ifdef FEATURE_STATISTICS
1624 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1625 #else /* ifndef FEATURE_STATISTICS */
1626 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1627 #endif /* ndef FEATURE_STATISTICS */
1629 #ifdef FEATURE_TOGGLE
1630 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1631 #else /* ifndef FEATURE_TOGGLE */
1632 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1633 #endif /* ndef FEATURE_TOGGLE */
1635 #ifdef FEATURE_TRUST
1636 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1637 #else /* ifndef FEATURE_TRUST */
1638 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1639 #endif /* ndef FEATURE_TRUST */
1642 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1643 #else /* ifndef FEATURE_ZLIB */
1644 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1645 #endif /* ndef FEATURE_ZLIB */
1648 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1649 #else /* ifndef STATIC_PCRE */
1650 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1651 #endif /* ndef STATIC_PCRE */
1654 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1655 #else /* ifndef STATIC_PCRS */
1656 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1657 #endif /* ndef STATIC_PCRS */
1663 /*********************************************************************
1665 * Function : show_rcs
1667 * Description : Create a string with the rcs info for all sourcefiles
1671 * Returns : A string, or NULL on out-of-memory.
1673 *********************************************************************/
1674 static char *show_rcs(void)
1676 char *result = strdup("");
1677 char buf[BUFFER_SIZE];
1679 /* Instead of including *all* dot h's in the project (thus creating a
1680 * tremendous amount of dependencies), I will concede to declaring them
1681 * as extern's. This forces the developer to add to this list, but oh well.
1684 #define SHOW_RCS(__x) \
1686 extern const char __x[]; \
1687 snprintf(buf, sizeof(buf), " %s\n", __x); \
1688 string_append(&result, buf); \
1691 /* In alphabetical order */
1692 SHOW_RCS(actions_h_rcs)
1693 SHOW_RCS(actions_rcs)
1695 SHOW_RCS(amiga_h_rcs)
1697 #endif /* def AMIGA */
1700 #ifdef FEATURE_CGI_EDIT_ACTIONS
1701 SHOW_RCS(cgiedit_h_rcs)
1702 SHOW_RCS(cgiedit_rcs)
1703 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1704 SHOW_RCS(cgisimple_h_rcs)
1705 SHOW_RCS(cgisimple_rcs)
1707 SHOW_RCS(cygwin_h_rcs)
1709 SHOW_RCS(deanimate_h_rcs)
1710 SHOW_RCS(deanimate_rcs)
1711 SHOW_RCS(encode_h_rcs)
1712 SHOW_RCS(encode_rcs)
1713 SHOW_RCS(errlog_h_rcs)
1714 SHOW_RCS(errlog_rcs)
1715 SHOW_RCS(filters_h_rcs)
1716 SHOW_RCS(filters_rcs)
1717 SHOW_RCS(gateway_h_rcs)
1718 SHOW_RCS(gateway_rcs)
1719 SHOW_RCS(jbsockets_h_rcs)
1720 SHOW_RCS(jbsockets_rcs)
1723 SHOW_RCS(list_h_rcs)
1725 SHOW_RCS(loadcfg_h_rcs)
1726 SHOW_RCS(loadcfg_rcs)
1727 SHOW_RCS(loaders_h_rcs)
1728 SHOW_RCS(loaders_rcs)
1729 SHOW_RCS(miscutil_h_rcs)
1730 SHOW_RCS(miscutil_rcs)
1731 SHOW_RCS(parsers_h_rcs)
1732 SHOW_RCS(parsers_rcs)
1734 SHOW_RCS(pcrs_h_rcs)
1735 SHOW_RCS(project_h_rcs)
1736 SHOW_RCS(ssplit_h_rcs)
1737 SHOW_RCS(ssplit_rcs)
1738 SHOW_RCS(urlmatch_h_rcs)
1739 SHOW_RCS(urlmatch_rcs)
1741 #ifndef _WIN_CONSOLE
1742 SHOW_RCS(w32log_h_rcs)
1743 SHOW_RCS(w32log_rcs)
1744 SHOW_RCS(w32res_h_rcs)
1745 SHOW_RCS(w32taskbar_h_rcs)
1746 SHOW_RCS(w32taskbar_rcs)
1747 #endif /* ndef _WIN_CONSOLE */
1748 SHOW_RCS(win32_h_rcs)
1750 #endif /* def _WIN32 */
1759 /*********************************************************************
1761 * Function : cgi_show_file
1763 * Description : CGI function that shows the content of a
1764 * configuration file.
1767 * 1 : csp = Current client state (buffers, headers, etc...)
1768 * 2 : rsp = http_response data structure for output
1769 * 3 : parameters = map of cgi parameters
1772 * file : Which file to show. Only first letter is checked,
1777 * Default is to show menu and other information.
1779 * Returns : JB_ERR_OK on success
1780 * JB_ERR_MEMORY on out-of-memory error.
1782 *********************************************************************/
1783 static jb_err cgi_show_file(struct client_state *csp,
1784 struct http_response *rsp,
1785 const struct map *parameters)
1788 const char * filename = NULL;
1789 char * file_description = NULL;
1795 switch (*(lookup(parameters, "file")))
1798 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
1800 filename = csp->actions_list[i]->filename;
1801 file_description = "Actions File";
1806 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
1808 filename = csp->rlist[i]->filename;
1809 file_description = "Filter File";
1813 #ifdef FEATURE_TRUST
1817 filename = csp->tlist->filename;
1818 file_description = "Trust File";
1821 #endif /* def FEATURE_TRUST */
1824 if (NULL != filename)
1826 struct map *exports;
1831 exports = default_exports(csp, "show-status");
1832 if (NULL == exports)
1834 return JB_ERR_MEMORY;
1837 if ( map(exports, "file-description", 1, file_description, 1)
1838 || map(exports, "filepath", 1, html_encode(filename), 0) )
1841 return JB_ERR_MEMORY;
1844 err = load_file(filename, &s, &length);
1845 if (JB_ERR_OK != err)
1847 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
1850 return JB_ERR_MEMORY;
1855 s = html_encode_and_free_original(s);
1858 return JB_ERR_MEMORY;
1861 if (map(exports, "contents", 1, s, 0))
1864 return JB_ERR_MEMORY;
1868 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
1871 return JB_ERR_CGI_PARAMS;
1875 /*********************************************************************
1877 * Function : load_file
1879 * Description : Loads a file into a buffer.
1882 * 1 : filename = Name of the file to be loaded.
1883 * 2 : buffer = Used to return the file's content.
1884 * 3 : length = Used to return the size of the file.
1886 * Returns : JB_ERR_OK in case of success,
1887 * JB_ERR_FILE in case of ordinary file loading errors
1888 * (fseek() and ftell() errors are fatal)
1889 * JB_ERR_MEMORY in case of out-of-memory.
1891 *********************************************************************/
1892 static jb_err load_file(const char *filename, char **buffer, size_t *length)
1896 jb_err err = JB_ERR_OK;
1898 fp = fopen(filename, "rb");
1901 log_error(LOG_LEVEL_ERROR, "Failed to open %s: %E", filename);
1905 /* Get file length */
1906 if (fseek(fp, 0, SEEK_END))
1908 log_error(LOG_LEVEL_FATAL,
1909 "Unexpected error while fseek()ing to the end of %s: %E",
1915 log_error(LOG_LEVEL_FATAL,
1916 "Unexpected ftell() error while loading %s: %E",
1919 *length = (size_t)ret;
1921 /* Go back to the beginning. */
1922 if (fseek(fp, 0, SEEK_SET))
1924 log_error(LOG_LEVEL_FATAL,
1925 "Unexpected error while fseek()ing to the beginning of %s: %E",
1929 *buffer = (char *)zalloc(*length + 1);
1930 if (NULL == *buffer)
1932 err = JB_ERR_MEMORY;
1934 else if (!fread(*buffer, *length, 1, fp))
1937 * May happen if the file size changes between fseek() and
1938 * fread(). If it does, we just log it and serve what we got.
1940 log_error(LOG_LEVEL_ERROR,
1941 "Couldn't completely read file %s.", filename);