1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.101 2011/02/14 16:04:55 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-2010 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 : cgi_send_user_manual
665 * Description : CGI function that sends a file in the user
669 * 1 : csp = Current client state (buffers, headers, etc...)
670 * 2 : rsp = http_response data structure for output
671 * 3 : parameters = map of cgi parameters
673 * CGI Parameters : file=name.html, the name of the HTML file
674 * (relative to user-manual from config)
676 * Returns : JB_ERR_OK on success
677 * JB_ERR_MEMORY on out-of-memory error.
679 *********************************************************************/
680 jb_err cgi_send_user_manual(struct client_state *csp,
681 struct http_response *rsp,
682 const struct map *parameters)
684 const char * filename;
686 jb_err err = JB_ERR_OK;
693 if (0 == strncmpic(csp->config->usermanual, "http://", 7))
695 log_error(LOG_LEVEL_CGI, "Request for local user-manual "
696 "received while user-manual delivery is disabled.");
697 return cgi_error_404(csp, rsp, parameters);
700 if (!parameters->first)
702 /* requested http://p.p/user-manual (without trailing slash) */
703 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
706 get_string_param(parameters, "file", &filename);
707 if (filename == NULL)
709 /* It's '/' so serve the index.html if there is one. */
710 filename = "index.html";
712 else if (NULL != strchr(filename, '/') || NULL != strstr(filename, ".."))
715 * We currently only support a flat file
716 * hierachy for the documentation.
718 log_error(LOG_LEVEL_ERROR,
719 "Rejecting the request to serve '%s' as it contains '/' or '..'",
721 return JB_ERR_CGI_PARAMS;
724 full_path = make_path(csp->config->usermanual, filename);
725 if (full_path == NULL)
727 return JB_ERR_MEMORY;
730 err = load_file(full_path, &rsp->body, &rsp->content_length);
731 if (JB_ERR_OK != err)
733 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
734 if (JB_ERR_FILE == err)
736 err = cgi_error_no_template(csp, rsp, full_path);
743 /* Guess correct Content-Type based on the filename's ending */
746 length = strlen(filename);
752 if((length>=4) && !strcmp(&filename[length-4], ".css"))
754 err = enlist(rsp->headers, "Content-Type: text/css");
756 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
758 err = enlist(rsp->headers, "Content-Type: image/jpeg");
762 err = enlist(rsp->headers, "Content-Type: text/html");
769 /*********************************************************************
771 * Function : cgi_show_version
773 * Description : CGI function that returns a a web page describing the
774 * file versions of Privoxy.
777 * 1 : csp = Current client state (buffers, headers, etc...)
778 * 2 : rsp = http_response data structure for output
779 * 3 : parameters = map of cgi parameters
781 * CGI Parameters : none
783 * Returns : JB_ERR_OK on success
784 * JB_ERR_MEMORY on out-of-memory error.
786 *********************************************************************/
787 jb_err cgi_show_version(struct client_state *csp,
788 struct http_response *rsp,
789 const struct map *parameters)
797 if (NULL == (exports = default_exports(csp, "show-version")))
799 return JB_ERR_MEMORY;
802 if (map(exports, "sourceversions", 1, show_rcs(), 0))
805 return JB_ERR_MEMORY;
808 return template_fill_for_cgi(csp, "show-version", exports, rsp);
812 /*********************************************************************
814 * Function : cgi_show_status
816 * Description : CGI function that returns a web page describing the
817 * current status of Privoxy.
820 * 1 : csp = Current client state (buffers, headers, etc...)
821 * 2 : rsp = http_response data structure for output
822 * 3 : parameters = map of cgi parameters
825 * file : Which file to show. Only first letter is checked,
830 * Default is to show menu and other information.
832 * Returns : JB_ERR_OK on success
833 * JB_ERR_MEMORY on out-of-memory error.
835 *********************************************************************/
836 jb_err cgi_show_status(struct client_state *csp,
837 struct http_response *rsp,
838 const struct map *parameters)
844 char buf[BUFFER_SIZE];
845 #ifdef FEATURE_STATISTICS
846 float perc_rej; /* Percentage of http requests rejected */
848 int local_urls_rejected;
849 #endif /* ndef FEATURE_STATISTICS */
850 jb_err err = JB_ERR_OK;
858 if ('\0' != *(lookup(parameters, "file")))
860 return cgi_show_file(csp, rsp, parameters);
863 if (NULL == (exports = default_exports(csp, "show-status")))
865 return JB_ERR_MEMORY;
869 for (j = 0; (s != NULL) && (j < Argc); j++)
871 if (!err) err = string_join (&s, html_encode(Argv[j]));
872 if (!err) err = string_append(&s, " ");
874 if (!err) err = map(exports, "invocation", 1, s, 0);
876 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
877 if (!err) err = show_defines(exports);
882 return JB_ERR_MEMORY;
885 #ifdef FEATURE_STATISTICS
886 local_urls_read = urls_read;
887 local_urls_rejected = urls_rejected;
890 * Need to alter the stats not to include the fetch of this
893 * Can't do following thread safely! doh!
896 * urls_rejected--; * This will be incremented subsequently *
899 if (local_urls_read == 0)
901 if (!err) err = map_block_killer(exports, "have-stats");
905 if (!err) err = map_block_killer(exports, "have-no-stats");
907 perc_rej = (float)local_urls_rejected * 100.0F /
908 (float)local_urls_read;
910 snprintf(buf, sizeof(buf), "%d", local_urls_read);
911 if (!err) err = map(exports, "requests-received", 1, buf, 1);
913 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
914 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
916 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
917 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
920 #else /* ndef FEATURE_STATISTICS */
921 err = err || map_block_killer(exports, "statistics");
922 #endif /* ndef FEATURE_STATISTICS */
925 * List all action files in use, together with view and edit links,
926 * except for standard.action, which should only be viewable. (Not
927 * enforced in the editor itself)
928 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
931 for (i = 0; i < MAX_AF_FILES; i++)
933 if (csp->actions_list[i] != NULL)
935 if (!err) err = string_append(&s, "<tr><td>");
936 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
937 snprintf(buf, sizeof(buf),
938 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%u\">View</a>", i);
939 if (!err) err = string_append(&s, buf);
941 #ifdef FEATURE_CGI_EDIT_ACTIONS
942 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
943 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
944 && (NULL != csp->config->actions_file_short[i]))
947 if (access(csp->config->actions_file[i], W_OK) == 0)
949 #endif /* def HAVE_ACCESS */
950 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
951 if (!err) err = string_append(&s, buf);
956 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
958 #endif /* def HAVE_ACCESS */
962 if (!err) err = string_append(&s, "</td></tr>\n");
967 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
971 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
975 * List all re_filterfiles in use, together with view options.
976 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
979 for (i = 0; i < MAX_AF_FILES; i++)
981 if (csp->rlist[i] != NULL)
983 if (!err) err = string_append(&s, "<tr><td>");
984 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
985 snprintf(buf, sizeof(buf),
986 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%u\">View</a>", i);
987 if (!err) err = string_append(&s, buf);
988 if (!err) err = string_append(&s, "</td></tr>\n");
993 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
997 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
998 if (!err) err = map_block_killer(exports, "have-filterfile");
1001 #ifdef FEATURE_TRUST
1004 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1008 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1009 if (!err) err = map_block_killer(exports, "have-trustfile");
1012 if (!err) err = map_block_killer(exports, "trust-support");
1013 #endif /* ndef FEATURE_TRUST */
1015 #ifdef FEATURE_CGI_EDIT_ACTIONS
1016 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1018 err = map_block_killer(exports, "cgi-editor-is-disabled");
1020 #endif /* ndef CGI_EDIT_ACTIONS */
1025 return JB_ERR_MEMORY;
1028 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1032 /*********************************************************************
1034 * Function : cgi_show_url_info
1036 * Description : CGI function that determines and shows which actions
1037 * Privoxy will perform for a given url, and which
1038 * matches starting from the defaults have lead to that.
1041 * 1 : csp = Current client state (buffers, headers, etc...)
1042 * 2 : rsp = http_response data structure for output
1043 * 3 : parameters = map of cgi parameters
1046 * url : The url whose actions are to be determined.
1047 * If url is unset, the url-given conditional will be
1048 * set, so that all but the form can be suppressed in
1051 * Returns : JB_ERR_OK on success
1052 * JB_ERR_MEMORY on out-of-memory error.
1054 *********************************************************************/
1055 jb_err cgi_show_url_info(struct client_state *csp,
1056 struct http_response *rsp,
1057 const struct map *parameters)
1060 struct map *exports;
1067 if (NULL == (exports = default_exports(csp, "show-url-info")))
1069 return JB_ERR_MEMORY;
1073 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1075 url_param = strdup(lookup(parameters, "url"));
1076 if (url_param == NULL)
1079 return JB_ERR_MEMORY;
1084 * Handle prefixes. 4 possibilities:
1085 * 1) "http://" or "https://" prefix present and followed by URL - OK
1086 * 2) Only the "http://" or "https://" part is present, no URL - change
1087 * to empty string so it will be detected later as "no URL".
1088 * 3) Parameter specified but doesn't start with "http(s?)://" - add a
1090 * 4) Parameter not specified or is empty string - let this fall through
1091 * for now, next block of code will handle it.
1093 if (0 == strncmp(url_param, "http://", 7))
1095 if (url_param[7] == '\0')
1098 * Empty URL (just prefix).
1099 * Make it totally empty so it's caught by the next if()
1101 url_param[0] = '\0';
1104 else if (0 == strncmp(url_param, "https://", 8))
1106 if (url_param[8] == '\0')
1109 * Empty URL (just prefix).
1110 * Make it totally empty so it's caught by the next if()
1112 url_param[0] = '\0';
1115 else if ((url_param[0] != '\0')
1116 && ((NULL == strstr(url_param, "://")
1117 || (strstr(url_param, "://") > strstr(url_param, "/")))))
1120 * No prefix or at least no prefix before
1121 * the first slash - assume http://
1123 char *url_param_prefixed = strdup("http://");
1125 if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1128 return JB_ERR_MEMORY;
1130 url_param = url_param_prefixed;
1134 * Hide "toggle off" warning if Privoxy is toggled on.
1137 #ifdef FEATURE_TOGGLE
1138 (global_toggle_state == 1) &&
1139 #endif /* def FEATURE_TOGGLE */
1140 map_block_killer(exports, "privoxy-is-toggled-off")
1144 return JB_ERR_MEMORY;
1147 if (url_param[0] == '\0')
1149 /* URL paramater not specified, display query form only. */
1151 if (map_block_killer(exports, "url-given")
1152 || map(exports, "url", 1, "", 1))
1155 return JB_ERR_MEMORY;
1160 /* Given a URL, so query it. */
1165 struct file_list *fl;
1166 struct url_actions *b;
1167 struct http_request url_to_query[1];
1168 struct current_action_spec action[1];
1171 if (map(exports, "url", 1, html_encode(url_param), 0))
1175 return JB_ERR_MEMORY;
1178 init_current_action(action);
1180 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1182 free_current_action(action);
1185 return JB_ERR_MEMORY;
1188 memset(url_to_query, '\0', sizeof(url_to_query));
1189 err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1190 assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1194 if (err == JB_ERR_MEMORY)
1196 free_http_request(url_to_query);
1197 free_current_action(action);
1199 return JB_ERR_MEMORY;
1205 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1206 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1207 if (!err) err = map_block_killer(exports, "valid-url");
1209 free_current_action(action);
1210 free_http_request(url_to_query);
1215 return JB_ERR_MEMORY;
1218 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1222 * We have a warning about SSL paths. Hide it for unencrypted sites.
1224 if (!url_to_query->ssl)
1226 if (map_block_killer(exports, "https"))
1228 free_current_action(action);
1230 free_http_request(url_to_query);
1231 return JB_ERR_MEMORY;
1235 matches = strdup("<table summary=\"\" class=\"transparent\">");
1237 for (i = 0; i < MAX_AF_FILES; i++)
1239 if (NULL == csp->config->actions_file_short[i]
1240 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1244 if ((fl = csp->actions_list[i]) != NULL)
1246 if ((b = fl->f) != NULL)
1248 /* FIXME: Hardcoded HTML! */
1249 string_append(&matches, "<tr><th>In file: ");
1250 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1251 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1252 string_append(&matches, buf);
1253 string_append(&matches, "View</a>");
1254 #ifdef FEATURE_CGI_EDIT_ACTIONS
1255 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1258 if (access(csp->config->actions_file[i], W_OK) == 0)
1260 #endif /* def HAVE_ACCESS */
1261 snprintf(buf, sizeof(buf),
1262 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1263 string_append(&matches, buf);
1264 string_append(&matches, "Edit</a>");
1269 string_append(&matches, " <strong>No write access.</strong>");
1271 #endif /* def HAVE_ACCESS */
1273 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1275 string_append(&matches, "</th></tr>\n");
1282 for (; (b != NULL) && (matches != NULL); b = b->next)
1284 if (url_match(b->url, url_to_query))
1286 string_append(&matches, "<tr><td>{");
1287 string_join (&matches, actions_to_html(csp, b->action));
1288 string_append(&matches, " }<br>\n<code>");
1289 string_join (&matches, html_encode(b->url->spec));
1290 string_append(&matches, "</code></td></tr>\n");
1292 if (merge_current_action(action, b->action))
1295 free_http_request(url_to_query);
1296 free_current_action(action);
1298 return JB_ERR_MEMORY;
1306 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1309 string_append(&matches, "</table>\n");
1312 * XXX: Kludge to make sure the "Forward settings" section
1313 * shows what forward-override{} would do with the requested URL.
1314 * No one really cares how the CGI request would be forwarded
1315 * if it wasn't intercepted as CGI request in the first place.
1317 * From here on the action bitmask will no longer reflect
1318 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1319 * but luckily it's no longer required later on anyway.
1321 free_current_action(csp->action);
1322 get_url_actions(csp, url_to_query);
1325 * Fill in forwarding settings.
1327 * The possibilities are:
1329 * - http forwarding only
1330 * - socks4(a) forwarding only
1331 * - socks4(a) and http forwarding.
1333 * XXX: Parts of this code could be reused for the
1334 * "forwarding-failed" template which currently doesn't
1335 * display the proxy port and an eventual second forwarder.
1338 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1340 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1342 if (!err) err = map_block_killer(exports, "socks-forwarder");
1343 if (!err) err = map_block_killer(exports, "http-forwarder");
1347 char port[10]; /* We save proxy ports as int but need a string here */
1349 if (!err) err = map_block_killer(exports, "no-forwarder");
1351 if (fwd->gateway_host != NULL)
1353 char *socks_type = NULL;
1358 socks_type = "socks4";
1361 socks_type = "socks4a";
1364 socks_type = "socks5";
1367 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1370 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1371 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1372 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1373 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1377 if (!err) err = map_block_killer(exports, "socks-forwarder");
1380 if (fwd->forward_host != NULL)
1382 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1383 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1384 if (!err) err = map(exports, "forward-port", 1, port, 1);
1388 if (!err) err = map_block_killer(exports, "http-forwarder");
1393 free_http_request(url_to_query);
1395 if (err || matches == NULL)
1397 free_current_action(action);
1399 return JB_ERR_MEMORY;
1402 #ifdef FEATURE_CGI_EDIT_ACTIONS
1403 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1405 err = map_block_killer(exports, "cgi-editor-is-disabled");
1407 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1410 * If zlib support is available, if no content filters
1411 * are enabled or if the prevent-compression action is enabled,
1412 * suppress the "compression could prevent filtering" warning.
1414 #ifndef FEATURE_ZLIB
1415 if (!content_filters_enabled(action) ||
1416 (action->flags & ACTION_NO_COMPRESSION))
1419 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1422 if (err || map(exports, "matches", 1, matches , 0))
1424 free_current_action(action);
1426 return JB_ERR_MEMORY;
1429 s = current_action_to_html(csp, action);
1431 free_current_action(action);
1433 if (map(exports, "final", 1, s, 0))
1436 return JB_ERR_MEMORY;
1440 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1444 /*********************************************************************
1446 * Function : cgi_robots_txt
1448 * Description : CGI function to return "/robots.txt".
1451 * 1 : csp = Current client state (buffers, headers, etc...)
1452 * 2 : rsp = http_response data structure for output
1453 * 3 : parameters = map of cgi parameters
1455 * CGI Parameters : None
1457 * Returns : JB_ERR_OK on success
1458 * JB_ERR_MEMORY on out-of-memory error.
1460 *********************************************************************/
1461 jb_err cgi_robots_txt(struct client_state *csp,
1462 struct http_response *rsp,
1463 const struct map *parameters)
1472 "# This is the Privoxy control interface.\n"
1473 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1479 if (rsp->body == NULL)
1481 return JB_ERR_MEMORY;
1484 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1488 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1489 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1491 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1495 /*********************************************************************
1497 * Function : show_defines
1499 * Description : Add to a map the state od all conditional #defines
1500 * used when building
1503 * 1 : exports = map to extend
1505 * Returns : JB_ERR_OK on success
1506 * JB_ERR_MEMORY on out-of-memory error.
1508 *********************************************************************/
1509 static jb_err show_defines(struct map *exports)
1511 jb_err err = JB_ERR_OK;
1513 #ifdef FEATURE_ACCEPT_FILTER
1514 if (!err) err = map_conditional(exports, "FEATURE_ACCEPT_FILTER", 1);
1515 #else /* ifndef FEATURE_ACCEPT_FILTER */
1516 if (!err) err = map_conditional(exports, "FEATURE_ACCEPT_FILTER", 0);
1517 #endif /* ndef FEATURE_ACCEPT_FILTER */
1520 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1521 #else /* ifndef FEATURE_ACL */
1522 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1523 #endif /* ndef FEATURE_ACL */
1525 #ifdef FEATURE_CGI_EDIT_ACTIONS
1526 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1527 #else /* ifndef FEATURE_CGI_EDIT_ACTIONS */
1528 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1529 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1531 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1532 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 1);
1533 #else /* ifndef FEATURE_CONNECTION_KEEP_ALIVE */
1534 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 0);
1535 #endif /* ndef FEATURE_CONNECTION_KEEP_ALIVE */
1537 #ifdef FEATURE_CONNECTION_SHARING
1538 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 1);
1539 #else /* ifndef FEATURE_CONNECTION_SHARING */
1540 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 0);
1541 #endif /* ndef FEATURE_CONNECTION_SHARING */
1543 #ifdef FEATURE_FAST_REDIRECTS
1544 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1545 #else /* ifndef FEATURE_FAST_REDIRECTS */
1546 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1547 #endif /* ndef FEATURE_FAST_REDIRECTS */
1549 #ifdef FEATURE_FORCE_LOAD
1550 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1551 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1552 #else /* ifndef FEATURE_FORCE_LOAD */
1553 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1554 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1555 #endif /* ndef FEATURE_FORCE_LOAD */
1557 #ifdef FEATURE_GRACEFUL_TERMINATION
1558 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1559 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1560 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1561 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1563 #ifdef FEATURE_IMAGE_BLOCKING
1564 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1565 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1566 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1567 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1569 #ifdef FEATURE_IMAGE_DETECT_MSIE
1570 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1571 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1572 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1573 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1576 if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 1);
1577 #else /* ifndef HAVE_RFC2553 */
1578 if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 0);
1579 #endif /* ndef HAVE_RFC2553 */
1581 #ifdef FEATURE_NO_GIFS
1582 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1583 #else /* ifndef FEATURE_NO_GIFS */
1584 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1585 #endif /* ndef FEATURE_NO_GIFS */
1587 #ifdef FEATURE_PTHREAD
1588 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1589 #else /* ifndef FEATURE_PTHREAD */
1590 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1591 #endif /* ndef FEATURE_PTHREAD */
1593 #ifdef FEATURE_STATISTICS
1594 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1595 #else /* ifndef FEATURE_STATISTICS */
1596 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1597 #endif /* ndef FEATURE_STATISTICS */
1599 #ifdef FEATURE_TOGGLE
1600 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1601 #else /* ifndef FEATURE_TOGGLE */
1602 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1603 #endif /* ndef FEATURE_TOGGLE */
1605 #ifdef FEATURE_TRUST
1606 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1607 #else /* ifndef FEATURE_TRUST */
1608 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1609 #endif /* ndef FEATURE_TRUST */
1612 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1613 #else /* ifndef FEATURE_ZLIB */
1614 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1615 #endif /* ndef FEATURE_ZLIB */
1618 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1619 #else /* ifndef STATIC_PCRE */
1620 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1621 #endif /* ndef STATIC_PCRE */
1624 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1625 #else /* ifndef STATIC_PCRS */
1626 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1627 #endif /* ndef STATIC_PCRS */
1633 /*********************************************************************
1635 * Function : show_rcs
1637 * Description : Create a string with the rcs info for all sourcefiles
1641 * Returns : A string, or NULL on out-of-memory.
1643 *********************************************************************/
1644 static char *show_rcs(void)
1646 char *result = strdup("");
1647 char buf[BUFFER_SIZE];
1649 /* Instead of including *all* dot h's in the project (thus creating a
1650 * tremendous amount of dependencies), I will concede to declaring them
1651 * as extern's. This forces the developer to add to this list, but oh well.
1654 #define SHOW_RCS(__x) \
1656 extern const char __x[]; \
1657 snprintf(buf, sizeof(buf), " %s\n", __x); \
1658 string_append(&result, buf); \
1661 /* In alphabetical order */
1662 SHOW_RCS(actions_h_rcs)
1663 SHOW_RCS(actions_rcs)
1665 SHOW_RCS(amiga_h_rcs)
1667 #endif /* def AMIGA */
1670 #ifdef FEATURE_CGI_EDIT_ACTIONS
1671 SHOW_RCS(cgiedit_h_rcs)
1672 SHOW_RCS(cgiedit_rcs)
1673 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1674 SHOW_RCS(cgisimple_h_rcs)
1675 SHOW_RCS(cgisimple_rcs)
1677 SHOW_RCS(cygwin_h_rcs)
1679 SHOW_RCS(deanimate_h_rcs)
1680 SHOW_RCS(deanimate_rcs)
1681 SHOW_RCS(encode_h_rcs)
1682 SHOW_RCS(encode_rcs)
1683 SHOW_RCS(errlog_h_rcs)
1684 SHOW_RCS(errlog_rcs)
1685 SHOW_RCS(filters_h_rcs)
1686 SHOW_RCS(filters_rcs)
1687 SHOW_RCS(gateway_h_rcs)
1688 SHOW_RCS(gateway_rcs)
1689 SHOW_RCS(jbsockets_h_rcs)
1690 SHOW_RCS(jbsockets_rcs)
1693 SHOW_RCS(list_h_rcs)
1695 SHOW_RCS(loadcfg_h_rcs)
1696 SHOW_RCS(loadcfg_rcs)
1697 SHOW_RCS(loaders_h_rcs)
1698 SHOW_RCS(loaders_rcs)
1699 SHOW_RCS(miscutil_h_rcs)
1700 SHOW_RCS(miscutil_rcs)
1701 SHOW_RCS(parsers_h_rcs)
1702 SHOW_RCS(parsers_rcs)
1704 SHOW_RCS(pcrs_h_rcs)
1705 SHOW_RCS(project_h_rcs)
1706 SHOW_RCS(ssplit_h_rcs)
1707 SHOW_RCS(ssplit_rcs)
1708 SHOW_RCS(urlmatch_h_rcs)
1709 SHOW_RCS(urlmatch_rcs)
1711 #ifndef _WIN_CONSOLE
1712 SHOW_RCS(w32log_h_rcs)
1713 SHOW_RCS(w32log_rcs)
1714 SHOW_RCS(w32res_h_rcs)
1715 SHOW_RCS(w32taskbar_h_rcs)
1716 SHOW_RCS(w32taskbar_rcs)
1717 #endif /* ndef _WIN_CONSOLE */
1718 SHOW_RCS(win32_h_rcs)
1720 #endif /* def _WIN32 */
1729 /*********************************************************************
1731 * Function : cgi_show_file
1733 * Description : CGI function that shows the content of a
1734 * configuration file.
1737 * 1 : csp = Current client state (buffers, headers, etc...)
1738 * 2 : rsp = http_response data structure for output
1739 * 3 : parameters = map of cgi parameters
1742 * file : Which file to show. Only first letter is checked,
1747 * Default is to show menu and other information.
1749 * Returns : JB_ERR_OK on success
1750 * JB_ERR_MEMORY on out-of-memory error.
1752 *********************************************************************/
1753 static jb_err cgi_show_file(struct client_state *csp,
1754 struct http_response *rsp,
1755 const struct map *parameters)
1758 const char * filename = NULL;
1759 char * file_description = NULL;
1765 switch (*(lookup(parameters, "file")))
1768 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
1770 filename = csp->actions_list[i]->filename;
1771 file_description = "Actions File";
1776 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
1778 filename = csp->rlist[i]->filename;
1779 file_description = "Filter File";
1783 #ifdef FEATURE_TRUST
1787 filename = csp->tlist->filename;
1788 file_description = "Trust File";
1791 #endif /* def FEATURE_TRUST */
1794 if (NULL != filename)
1796 struct map *exports;
1801 exports = default_exports(csp, "show-status");
1802 if (NULL == exports)
1804 return JB_ERR_MEMORY;
1807 if ( map(exports, "file-description", 1, file_description, 1)
1808 || map(exports, "filepath", 1, html_encode(filename), 0) )
1811 return JB_ERR_MEMORY;
1814 err = load_file(filename, &s, &length);
1815 if (JB_ERR_OK != err)
1817 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
1820 return JB_ERR_MEMORY;
1825 s = html_encode_and_free_original(s);
1828 return JB_ERR_MEMORY;
1831 if (map(exports, "contents", 1, s, 0))
1834 return JB_ERR_MEMORY;
1838 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
1841 return JB_ERR_CGI_PARAMS;
1845 /*********************************************************************
1847 * Function : load_file
1849 * Description : Loads a file into a buffer.
1852 * 1 : filename = Name of the file to be loaded.
1853 * 2 : buffer = Used to return the file's content.
1854 * 3 : length = Used to return the size of the file.
1856 * Returns : JB_ERR_OK in case of success,
1857 * JB_ERR_FILE in case of ordinary file loading errors
1858 * (fseek() and ftell() errors are fatal)
1859 * JB_ERR_MEMORY in case of out-of-memory.
1861 *********************************************************************/
1862 static jb_err load_file(const char *filename, char **buffer, size_t *length)
1866 jb_err err = JB_ERR_OK;
1868 fp = fopen(filename, "rb");
1871 log_error(LOG_LEVEL_ERROR, "Failed to open %s: %E", filename);
1875 /* Get file length */
1876 if (fseek(fp, 0, SEEK_END))
1878 log_error(LOG_LEVEL_FATAL,
1879 "Unexpected error while fseek()ing to the end of %s: %E",
1885 log_error(LOG_LEVEL_FATAL,
1886 "Unexpected ftell() error while loading %s: %E",
1889 *length = (size_t)ret;
1891 /* Go back to the beginning. */
1892 if (fseek(fp, 0, SEEK_SET))
1894 log_error(LOG_LEVEL_FATAL,
1895 "Unexpected error while fseek()ing to the beginning of %s: %E",
1899 *buffer = (char *)zalloc(*length + 1);
1900 if (NULL == *buffer)
1902 err = JB_ERR_MEMORY;
1904 else if (!fread(*buffer, *length, 1, fp))
1907 * May happen if the file size changes between fseek() and
1908 * fread(). If it does, we just log it and serve what we got.
1910 log_error(LOG_LEVEL_ERROR,
1911 "Couldn't completely read file %s.", filename);