1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.94 2009/08/01 11:42:43 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-2008 the SourceForge
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 (!parameters->first)
695 /* requested http://p.p/user-manual (without trailing slash) */
696 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
699 get_string_param(parameters, "file", &filename);
700 /* Check paramter for hack attempts */
701 if (filename && strchr(filename, '/'))
703 return JB_ERR_CGI_PARAMS;
705 if (filename && strstr(filename, ".."))
707 return JB_ERR_CGI_PARAMS;
710 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
711 if (full_path == NULL)
713 return JB_ERR_MEMORY;
716 err = load_file(full_path, &rsp->body, &rsp->content_length);
717 if (JB_ERR_OK != err)
719 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
720 if (JB_ERR_FILE == err)
722 err = cgi_error_no_template(csp, rsp, full_path);
729 /* Guess correct Content-Type based on the filename's ending */
732 length = strlen(filename);
738 if((length>=4) && !strcmp(&filename[length-4], ".css"))
740 err = enlist(rsp->headers, "Content-Type: text/css");
742 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
744 err = enlist(rsp->headers, "Content-Type: image/jpeg");
748 err = enlist(rsp->headers, "Content-Type: text/html");
755 /*********************************************************************
757 * Function : cgi_show_version
759 * Description : CGI function that returns a a web page describing the
760 * file versions of Privoxy.
763 * 1 : csp = Current client state (buffers, headers, etc...)
764 * 2 : rsp = http_response data structure for output
765 * 3 : parameters = map of cgi parameters
767 * CGI Parameters : none
769 * Returns : JB_ERR_OK on success
770 * JB_ERR_MEMORY on out-of-memory error.
772 *********************************************************************/
773 jb_err cgi_show_version(struct client_state *csp,
774 struct http_response *rsp,
775 const struct map *parameters)
783 if (NULL == (exports = default_exports(csp, "show-version")))
785 return JB_ERR_MEMORY;
788 if (map(exports, "sourceversions", 1, show_rcs(), 0))
791 return JB_ERR_MEMORY;
794 return template_fill_for_cgi(csp, "show-version", exports, rsp);
798 /*********************************************************************
800 * Function : cgi_show_status
802 * Description : CGI function that returns a web page describing the
803 * current status of Privoxy.
806 * 1 : csp = Current client state (buffers, headers, etc...)
807 * 2 : rsp = http_response data structure for output
808 * 3 : parameters = map of cgi parameters
811 * file : Which file to show. Only first letter is checked,
816 * Default is to show menu and other information.
818 * Returns : JB_ERR_OK on success
819 * JB_ERR_MEMORY on out-of-memory error.
821 *********************************************************************/
822 jb_err cgi_show_status(struct client_state *csp,
823 struct http_response *rsp,
824 const struct map *parameters)
830 char buf[BUFFER_SIZE];
831 #ifdef FEATURE_STATISTICS
832 float perc_rej; /* Percentage of http requests rejected */
834 int local_urls_rejected;
835 #endif /* ndef FEATURE_STATISTICS */
836 jb_err err = JB_ERR_OK;
844 if ('\0' != *(lookup(parameters, "file")))
846 return cgi_show_file(csp, rsp, parameters);
849 if (NULL == (exports = default_exports(csp, "show-status")))
851 return JB_ERR_MEMORY;
855 for (j = 0; (s != NULL) && (j < Argc); j++)
857 if (!err) err = string_join (&s, html_encode(Argv[j]));
858 if (!err) err = string_append(&s, " ");
860 if (!err) err = map(exports, "invocation", 1, s, 0);
862 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
863 if (!err) err = show_defines(exports);
868 return JB_ERR_MEMORY;
871 #ifdef FEATURE_STATISTICS
872 local_urls_read = urls_read;
873 local_urls_rejected = urls_rejected;
876 * Need to alter the stats not to include the fetch of this
879 * Can't do following thread safely! doh!
882 * urls_rejected--; * This will be incremented subsequently *
885 if (local_urls_read == 0)
887 if (!err) err = map_block_killer(exports, "have-stats");
891 if (!err) err = map_block_killer(exports, "have-no-stats");
893 perc_rej = (float)local_urls_rejected * 100.0F /
894 (float)local_urls_read;
896 snprintf(buf, sizeof(buf), "%d", local_urls_read);
897 if (!err) err = map(exports, "requests-received", 1, buf, 1);
899 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
900 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
902 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
903 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
906 #else /* ndef FEATURE_STATISTICS */
907 err = err || map_block_killer(exports, "statistics");
908 #endif /* ndef FEATURE_STATISTICS */
911 * List all action files in use, together with view and edit links,
912 * except for standard.action, which should only be viewable. (Not
913 * enforced in the editor itself)
914 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
917 for (i = 0; i < MAX_AF_FILES; i++)
919 if (csp->actions_list[i] != NULL)
921 if (!err) err = string_append(&s, "<tr><td>");
922 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
923 snprintf(buf, sizeof(buf),
924 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%u\">View</a>", i);
925 if (!err) err = string_append(&s, buf);
927 #ifdef FEATURE_CGI_EDIT_ACTIONS
928 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
929 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
930 && (NULL != csp->config->actions_file_short[i]))
933 if (access(csp->config->actions_file[i], W_OK) == 0)
935 #endif /* def HAVE_ACCESS */
936 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%u\">Edit</a>", i);
937 if (!err) err = string_append(&s, buf);
942 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
944 #endif /* def HAVE_ACCESS */
948 if (!err) err = string_append(&s, "</td></tr>\n");
953 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
957 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
961 * List all re_filterfiles in use, together with view options.
962 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
965 for (i = 0; i < MAX_AF_FILES; i++)
967 if (csp->rlist[i] != NULL)
969 if (!err) err = string_append(&s, "<tr><td>");
970 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
971 snprintf(buf, sizeof(buf),
972 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%u\">View</a>", i);
973 if (!err) err = string_append(&s, buf);
974 if (!err) err = string_append(&s, "</td></tr>\n");
979 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
983 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
984 if (!err) err = map_block_killer(exports, "have-filterfile");
990 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
994 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
995 if (!err) err = map_block_killer(exports, "have-trustfile");
998 if (!err) err = map_block_killer(exports, "trust-support");
999 #endif /* ndef FEATURE_TRUST */
1001 #ifdef FEATURE_CGI_EDIT_ACTIONS
1002 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1004 err = map_block_killer(exports, "cgi-editor-is-disabled");
1006 #endif /* ndef CGI_EDIT_ACTIONS */
1011 return JB_ERR_MEMORY;
1014 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1018 /*********************************************************************
1020 * Function : cgi_show_url_info
1022 * Description : CGI function that determines and shows which actions
1023 * Privoxy will perform for a given url, and which
1024 * matches starting from the defaults have lead to that.
1027 * 1 : csp = Current client state (buffers, headers, etc...)
1028 * 2 : rsp = http_response data structure for output
1029 * 3 : parameters = map of cgi parameters
1032 * url : The url whose actions are to be determined.
1033 * If url is unset, the url-given conditional will be
1034 * set, so that all but the form can be suppressed in
1037 * Returns : JB_ERR_OK on success
1038 * JB_ERR_MEMORY on out-of-memory error.
1040 *********************************************************************/
1041 jb_err cgi_show_url_info(struct client_state *csp,
1042 struct http_response *rsp,
1043 const struct map *parameters)
1046 struct map *exports;
1053 if (NULL == (exports = default_exports(csp, "show-url-info")))
1055 return JB_ERR_MEMORY;
1059 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1061 url_param = strdup(lookup(parameters, "url"));
1062 if (url_param == NULL)
1065 return JB_ERR_MEMORY;
1070 * Handle prefixes. 4 possibilities:
1071 * 1) "http://" or "https://" prefix present and followed by URL - OK
1072 * 2) Only the "http://" or "https://" part is present, no URL - change
1073 * to empty string so it will be detected later as "no URL".
1074 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1076 * 4) Parameter not specified or is empty string - let this fall through
1077 * for now, next block of code will handle it.
1079 if (0 == strncmp(url_param, "http://", 7))
1081 if (url_param[7] == '\0')
1084 * Empty URL (just prefix).
1085 * Make it totally empty so it's caught by the next if()
1087 url_param[0] = '\0';
1090 else if (0 == strncmp(url_param, "https://", 8))
1092 if (url_param[8] == '\0')
1095 * Empty URL (just prefix).
1096 * Make it totally empty so it's caught by the next if()
1098 url_param[0] = '\0';
1101 else if ((url_param[0] != '\0') && (NULL == strstr(url_param, "://")))
1103 /* No prefix - assume http:// */
1104 char *url_param_prefixed = strdup("http://");
1106 if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1109 return JB_ERR_MEMORY;
1111 url_param = url_param_prefixed;
1115 * Hide "toggle off" warning if Privoxy is toggled on.
1118 #ifdef FEATURE_TOGGLE
1119 (global_toggle_state == 1) &&
1120 #endif /* def FEATURE_TOGGLE */
1121 map_block_killer(exports, "privoxy-is-toggled-off")
1125 return JB_ERR_MEMORY;
1128 if (url_param[0] == '\0')
1130 /* URL paramater not specified, display query form only. */
1132 if (map_block_killer(exports, "url-given")
1133 || map(exports, "url", 1, "", 1))
1136 return JB_ERR_MEMORY;
1141 /* Given a URL, so query it. */
1146 struct file_list *fl;
1147 struct url_actions *b;
1148 struct http_request url_to_query[1];
1149 struct current_action_spec action[1];
1152 if (map(exports, "url", 1, html_encode(url_param), 0))
1156 return JB_ERR_MEMORY;
1159 init_current_action(action);
1161 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1163 free_current_action(action);
1166 return JB_ERR_MEMORY;
1169 memset(url_to_query, '\0', sizeof(url_to_query));
1170 err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1171 assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1175 if (err == JB_ERR_MEMORY)
1177 free_http_request(url_to_query);
1178 free_current_action(action);
1180 return JB_ERR_MEMORY;
1186 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1187 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1188 if (!err) err = map_block_killer(exports, "valid-url");
1190 free_current_action(action);
1191 free_http_request(url_to_query);
1196 return JB_ERR_MEMORY;
1199 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1203 * We have a warning about SSL paths. Hide it for unencrypted sites.
1205 if (!url_to_query->ssl)
1207 if (map_block_killer(exports, "https"))
1209 free_current_action(action);
1211 free_http_request(url_to_query);
1212 return JB_ERR_MEMORY;
1216 matches = strdup("<table summary=\"\" class=\"transparent\">");
1218 for (i = 0; i < MAX_AF_FILES; i++)
1220 if (NULL == csp->config->actions_file_short[i]
1221 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1225 if ((fl = csp->actions_list[i]) != NULL)
1227 if ((b = fl->f) != NULL)
1229 /* FIXME: Hardcoded HTML! */
1230 string_append(&matches, "<tr><th>In file: ");
1231 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1232 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1233 string_append(&matches, buf);
1234 string_append(&matches, "View</a>");
1235 #ifdef FEATURE_CGI_EDIT_ACTIONS
1236 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1239 if (access(csp->config->actions_file[i], W_OK) == 0)
1241 #endif /* def HAVE_ACCESS */
1242 snprintf(buf, sizeof(buf),
1243 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1244 string_append(&matches, buf);
1245 string_append(&matches, "Edit</a>");
1250 string_append(&matches, " <strong>No write access.</strong>");
1252 #endif /* def HAVE_ACCESS */
1254 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1256 string_append(&matches, "</th></tr>\n");
1263 for (; (b != NULL) && (matches != NULL); b = b->next)
1265 if (url_match(b->url, url_to_query))
1267 string_append(&matches, "<tr><td>{");
1268 string_join (&matches, actions_to_html(csp, b->action));
1269 string_append(&matches, " }<br>\n<code>");
1270 string_join (&matches, html_encode(b->url->spec));
1271 string_append(&matches, "</code></td></tr>\n");
1273 if (merge_current_action(action, b->action))
1276 free_http_request(url_to_query);
1277 free_current_action(action);
1279 return JB_ERR_MEMORY;
1287 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1290 string_append(&matches, "</table>\n");
1293 * XXX: Kludge to make sure the "Forward settings" section
1294 * shows what forward-override{} would do with the requested URL.
1295 * No one really cares how the CGI request would be forwarded
1296 * if it wasn't intercepted as CGI request in the first place.
1298 * From here on the action bitmask will no longer reflect
1299 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1300 * but luckily it's no longer required later on anyway.
1302 free_current_action(csp->action);
1303 get_url_actions(csp, url_to_query);
1306 * Fill in forwarding settings.
1308 * The possibilities are:
1310 * - http forwarding only
1311 * - socks4(a) forwarding only
1312 * - socks4(a) and http forwarding.
1314 * XXX: Parts of this code could be reused for the
1315 * "forwarding-failed" template which currently doesn't
1316 * display the proxy port and an eventual second forwarder.
1319 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1321 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1323 if (!err) err = map_block_killer(exports, "socks-forwarder");
1324 if (!err) err = map_block_killer(exports, "http-forwarder");
1328 char port[10]; /* We save proxy ports as int but need a string here */
1330 if (!err) err = map_block_killer(exports, "no-forwarder");
1332 if (fwd->gateway_host != NULL)
1334 char *socks_type = NULL;
1339 socks_type = "socks4";
1342 socks_type = "socks4a";
1345 socks_type = "socks5";
1348 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1351 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1352 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1353 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1354 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1358 if (!err) err = map_block_killer(exports, "socks-forwarder");
1361 if (fwd->forward_host != NULL)
1363 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1364 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1365 if (!err) err = map(exports, "forward-port", 1, port, 1);
1369 if (!err) err = map_block_killer(exports, "http-forwarder");
1374 free_http_request(url_to_query);
1376 if (err || matches == NULL)
1378 free_current_action(action);
1380 return JB_ERR_MEMORY;
1383 #ifdef FEATURE_CGI_EDIT_ACTIONS
1384 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1386 err = map_block_killer(exports, "cgi-editor-is-disabled");
1388 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1391 * If zlib support is available, if no content filters
1392 * are enabled or if the prevent-compression action is enabled,
1393 * suppress the "compression could prevent filtering" warning.
1395 #ifndef FEATURE_ZLIB
1396 if (!content_filters_enabled(action) ||
1397 (action->flags & ACTION_NO_COMPRESSION))
1400 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1403 if (err || map(exports, "matches", 1, matches , 0))
1405 free_current_action(action);
1407 return JB_ERR_MEMORY;
1410 s = current_action_to_html(csp, action);
1412 free_current_action(action);
1414 if (map(exports, "final", 1, s, 0))
1417 return JB_ERR_MEMORY;
1421 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1425 /*********************************************************************
1427 * Function : cgi_robots_txt
1429 * Description : CGI function to return "/robots.txt".
1432 * 1 : csp = Current client state (buffers, headers, etc...)
1433 * 2 : rsp = http_response data structure for output
1434 * 3 : parameters = map of cgi parameters
1436 * CGI Parameters : None
1438 * Returns : JB_ERR_OK on success
1439 * JB_ERR_MEMORY on out-of-memory error.
1441 *********************************************************************/
1442 jb_err cgi_robots_txt(struct client_state *csp,
1443 struct http_response *rsp,
1444 const struct map *parameters)
1453 "# This is the Privoxy control interface.\n"
1454 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1460 if (rsp->body == NULL)
1462 return JB_ERR_MEMORY;
1465 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1469 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1470 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1472 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1476 /*********************************************************************
1478 * Function : show_defines
1480 * Description : Add to a map the state od all conditional #defines
1481 * used when building
1484 * 1 : exports = map to extend
1486 * Returns : JB_ERR_OK on success
1487 * JB_ERR_MEMORY on out-of-memory error.
1489 *********************************************************************/
1490 static jb_err show_defines(struct map *exports)
1492 jb_err err = JB_ERR_OK;
1495 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1496 #else /* ifndef FEATURE_ACL */
1497 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1498 #endif /* ndef FEATURE_ACL */
1500 #ifdef FEATURE_CGI_EDIT_ACTIONS
1501 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1502 #else /* ifndef FEATURE_CGI_EDIT_ACTIONS */
1503 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1504 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1506 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1507 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 1);
1508 #else /* ifndef FEATURE_CONNECTION_KEEP_ALIVE */
1509 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_KEEP_ALIVE", 0);
1510 #endif /* ndef FEATURE_CONNECTION_KEEP_ALIVE */
1512 #ifdef FEATURE_CONNECTION_SHARING
1513 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 1);
1514 #else /* ifndef FEATURE_CONNECTION_SHARING */
1515 if (!err) err = map_conditional(exports, "FEATURE_CONNECTION_SHARING", 0);
1516 #endif /* ndef FEATURE_CONNECTION_SHARING */
1518 #ifdef FEATURE_FAST_REDIRECTS
1519 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1520 #else /* ifndef FEATURE_FAST_REDIRECTS */
1521 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1522 #endif /* ndef FEATURE_FAST_REDIRECTS */
1524 #ifdef FEATURE_FORCE_LOAD
1525 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1526 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1527 #else /* ifndef FEATURE_FORCE_LOAD */
1528 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1529 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1530 #endif /* ndef FEATURE_FORCE_LOAD */
1532 #ifdef FEATURE_GRACEFUL_TERMINATION
1533 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1534 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1535 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1536 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1538 #ifdef FEATURE_IMAGE_BLOCKING
1539 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1540 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1541 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1542 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1544 #ifdef FEATURE_IMAGE_DETECT_MSIE
1545 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1546 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1547 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1548 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1551 if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 1);
1552 #else /* ifndef HAVE_RFC2553 */
1553 if (!err) err = map_conditional(exports, "FEATURE_IPV6_SUPPORT", 0);
1554 #endif /* ndef HAVE_RFC2553 */
1556 #ifdef FEATURE_NO_GIFS
1557 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1558 #else /* ifndef FEATURE_NO_GIFS */
1559 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1560 #endif /* ndef FEATURE_NO_GIFS */
1562 #ifdef FEATURE_PTHREAD
1563 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1564 #else /* ifndef FEATURE_PTHREAD */
1565 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1566 #endif /* ndef FEATURE_PTHREAD */
1568 #ifdef FEATURE_STATISTICS
1569 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1570 #else /* ifndef FEATURE_STATISTICS */
1571 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1572 #endif /* ndef FEATURE_STATISTICS */
1574 #ifdef FEATURE_TOGGLE
1575 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1576 #else /* ifndef FEATURE_TOGGLE */
1577 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1578 #endif /* ndef FEATURE_TOGGLE */
1580 #ifdef FEATURE_TRUST
1581 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1582 #else /* ifndef FEATURE_TRUST */
1583 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1584 #endif /* ndef FEATURE_TRUST */
1587 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1588 #else /* ifndef FEATURE_ZLIB */
1589 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1590 #endif /* ndef FEATURE_ZLIB */
1593 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1594 #else /* ifndef STATIC_PCRE */
1595 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1596 #endif /* ndef STATIC_PCRE */
1599 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1600 #else /* ifndef STATIC_PCRS */
1601 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1602 #endif /* ndef STATIC_PCRS */
1608 /*********************************************************************
1610 * Function : show_rcs
1612 * Description : Create a string with the rcs info for all sourcefiles
1616 * Returns : A string, or NULL on out-of-memory.
1618 *********************************************************************/
1619 static char *show_rcs(void)
1621 char *result = strdup("");
1622 char buf[BUFFER_SIZE];
1624 /* Instead of including *all* dot h's in the project (thus creating a
1625 * tremendous amount of dependencies), I will concede to declaring them
1626 * as extern's. This forces the developer to add to this list, but oh well.
1629 #define SHOW_RCS(__x) \
1631 extern const char __x[]; \
1632 snprintf(buf, sizeof(buf), " %s\n", __x); \
1633 string_append(&result, buf); \
1636 /* In alphabetical order */
1637 SHOW_RCS(actions_h_rcs)
1638 SHOW_RCS(actions_rcs)
1640 SHOW_RCS(amiga_h_rcs)
1642 #endif /* def AMIGA */
1645 #ifdef FEATURE_CGI_EDIT_ACTIONS
1646 SHOW_RCS(cgiedit_h_rcs)
1647 SHOW_RCS(cgiedit_rcs)
1648 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1649 SHOW_RCS(cgisimple_h_rcs)
1650 SHOW_RCS(cgisimple_rcs)
1652 SHOW_RCS(cygwin_h_rcs)
1654 SHOW_RCS(deanimate_h_rcs)
1655 SHOW_RCS(deanimate_rcs)
1656 SHOW_RCS(encode_h_rcs)
1657 SHOW_RCS(encode_rcs)
1658 SHOW_RCS(errlog_h_rcs)
1659 SHOW_RCS(errlog_rcs)
1660 SHOW_RCS(filters_h_rcs)
1661 SHOW_RCS(filters_rcs)
1662 SHOW_RCS(gateway_h_rcs)
1663 SHOW_RCS(gateway_rcs)
1664 SHOW_RCS(jbsockets_h_rcs)
1665 SHOW_RCS(jbsockets_rcs)
1668 SHOW_RCS(list_h_rcs)
1670 SHOW_RCS(loadcfg_h_rcs)
1671 SHOW_RCS(loadcfg_rcs)
1672 SHOW_RCS(loaders_h_rcs)
1673 SHOW_RCS(loaders_rcs)
1674 SHOW_RCS(miscutil_h_rcs)
1675 SHOW_RCS(miscutil_rcs)
1676 SHOW_RCS(parsers_h_rcs)
1677 SHOW_RCS(parsers_rcs)
1679 SHOW_RCS(pcrs_h_rcs)
1680 SHOW_RCS(project_h_rcs)
1681 SHOW_RCS(ssplit_h_rcs)
1682 SHOW_RCS(ssplit_rcs)
1683 SHOW_RCS(urlmatch_h_rcs)
1684 SHOW_RCS(urlmatch_rcs)
1686 #ifndef _WIN_CONSOLE
1687 SHOW_RCS(w32log_h_rcs)
1688 SHOW_RCS(w32log_rcs)
1689 SHOW_RCS(w32res_h_rcs)
1690 SHOW_RCS(w32taskbar_h_rcs)
1691 SHOW_RCS(w32taskbar_rcs)
1692 #endif /* ndef _WIN_CONSOLE */
1693 SHOW_RCS(win32_h_rcs)
1695 #endif /* def _WIN32 */
1704 /*********************************************************************
1706 * Function : cgi_show_file
1708 * Description : CGI function that shows the content of a
1709 * configuration file.
1712 * 1 : csp = Current client state (buffers, headers, etc...)
1713 * 2 : rsp = http_response data structure for output
1714 * 3 : parameters = map of cgi parameters
1717 * file : Which file to show. Only first letter is checked,
1722 * Default is to show menu and other information.
1724 * Returns : JB_ERR_OK on success
1725 * JB_ERR_MEMORY on out-of-memory error.
1727 *********************************************************************/
1728 static jb_err cgi_show_file(struct client_state *csp,
1729 struct http_response *rsp,
1730 const struct map *parameters)
1733 const char * filename = NULL;
1734 char * file_description = NULL;
1740 switch (*(lookup(parameters, "file")))
1743 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
1745 filename = csp->actions_list[i]->filename;
1746 file_description = "Actions File";
1751 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
1753 filename = csp->rlist[i]->filename;
1754 file_description = "Filter File";
1758 #ifdef FEATURE_TRUST
1762 filename = csp->tlist->filename;
1763 file_description = "Trust File";
1766 #endif /* def FEATURE_TRUST */
1769 if (NULL != filename)
1771 struct map *exports;
1776 exports = default_exports(csp, "show-status");
1777 if (NULL == exports)
1779 return JB_ERR_MEMORY;
1782 if ( map(exports, "file-description", 1, file_description, 1)
1783 || map(exports, "filepath", 1, html_encode(filename), 0) )
1786 return JB_ERR_MEMORY;
1789 err = load_file(filename, &s, &length);
1790 if (JB_ERR_OK != err)
1792 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
1795 return JB_ERR_MEMORY;
1800 s = html_encode_and_free_original(s);
1803 return JB_ERR_MEMORY;
1806 if (map(exports, "contents", 1, s, 0))
1809 return JB_ERR_MEMORY;
1813 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
1816 return JB_ERR_CGI_PARAMS;
1820 /*********************************************************************
1822 * Function : load_file
1824 * Description : Loads a file into a buffer.
1827 * 1 : filename = Name of the file to be loaded.
1828 * 2 : buffer = Used to return the file's content.
1829 * 3 : length = Used to return the size of the file.
1831 * Returns : JB_ERR_OK in case of success,
1832 * JB_ERR_FILE in case of ordinary file loading errors
1833 * (fseek() and ftell() errors are fatal)
1834 * JB_ERR_MEMORY in case of out-of-memory.
1836 *********************************************************************/
1837 static jb_err load_file(const char *filename, char **buffer, size_t *length)
1841 jb_err err = JB_ERR_OK;
1843 fp = fopen(filename, "rb");
1849 /* Get file length */
1850 if (fseek(fp, 0, SEEK_END))
1852 log_error(LOG_LEVEL_FATAL,
1853 "Unexpected error while fseek()ing to the end of %s: %E",
1859 log_error(LOG_LEVEL_FATAL,
1860 "Unexpected ftell() error while loading %s: %E",
1863 *length = (size_t)ret;
1865 /* Go back to the beginning. */
1866 if (fseek(fp, 0, SEEK_SET))
1868 log_error(LOG_LEVEL_FATAL,
1869 "Unexpected error while fseek()ing to the beginning of %s: %E",
1873 *buffer = (char *)zalloc(*length + 1);
1874 if (NULL == *buffer)
1876 err = JB_ERR_MEMORY;
1878 else if (!fread(*buffer, *length, 1, fp))
1881 * May happen if the file size changes between fseek() and
1882 * fread(). If it does, we just log it and serve what we got.
1884 log_error(LOG_LEVEL_ERROR,
1885 "Couldn't completely read file %s.", filename);