1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.75 2008/04/27 13:52:52 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.
38 * $Log: cgisimple.c,v $
39 * Revision 1.75 2008/04/27 13:52:52 fabiankeil
40 * Move CGI file loading code into load_file() and
41 * add checks for unexpected errors.
43 * Revision 1.74 2008/04/26 15:50:56 fabiankeil
44 * Fix macro name in cgi_show_file() error path.
46 * Revision 1.73 2008/04/26 12:21:55 fabiankeil
47 * Forget about JB_ERR_PARSE. JB_ERR_CGI_PARAMS to the rescue.
49 * Revision 1.72 2008/04/26 10:34:15 fabiankeil
50 * If zlib support is unavailable and there are content filters active
51 * but the prevent-compression action is disabled, include a warning
52 * on the show-url-info page that compression might prevent filtering.
54 * Revision 1.71 2008/04/25 13:33:56 fabiankeil
55 * - Factor cgi_show_file() out of cgi_show_status().
56 * - Adjust cgi_show_status()'s parameter description to match reality.
58 * Revision 1.70 2008/04/24 16:12:38 fabiankeil
59 * In cgi_show_status(), load the requested file at once.
60 * Using string_join() for every line really doesn't scale.
62 * Revision 1.69 2008/04/17 14:40:48 fabiankeil
63 * Provide get_http_time() with the buffer size so it doesn't
64 * have to blindly assume that the buffer is big enough.
66 * Revision 1.68 2008/03/27 18:27:21 fabiankeil
67 * Remove kill-popups action.
69 * Revision 1.67 2008/03/27 17:00:05 fabiankeil
70 * Turn the favicon blobs into locals.
72 * Revision 1.66 2008/02/23 16:57:12 fabiankeil
73 * Rename url_actions() to get_url_actions() and let it
74 * use the standard parameter ordering.
76 * Revision 1.65 2008/02/23 16:33:43 fabiankeil
77 * Let forward_url() use the standard parameter ordering
78 * and mark its second parameter immutable.
80 * Revision 1.64 2008/02/03 13:56:07 fabiankeil
81 * Add SOCKS5 support for show-url-info CGI page.
83 * Revision 1.63 2008/02/01 06:04:31 fabiankeil
84 * If edit buttons on the show-url-info CGI page are hidden, explain why.
86 * Revision 1.62 2008/02/01 05:52:40 fabiankeil
87 * Hide edit buttons on the show-url-info CGI page if enable-edit-action
88 * is disabled. Patch by Lee with additional white space adjustments.
90 * Revision 1.61 2008/01/26 11:13:25 fabiankeil
91 * If enable-edit-actions is disabled, hide the edit buttons and explain why.
93 * Revision 1.60 2007/10/27 13:12:13 fabiankeil
94 * Finish 1.49 and check write access before
95 * showing edit buttons on show-url-info page.
97 * Revision 1.59 2007/10/19 16:42:36 fabiankeil
98 * Plug memory leak I introduced five months ago.
99 * Yay Valgrind and Privoxy-Regression-Test.
101 * Revision 1.58 2007/07/21 12:19:50 fabiankeil
102 * If show-url-info is called with an URL that Privoxy
103 * would reject as invalid, don't show unresolved forwarding
104 * variables, "final matches" or claim the site's secure.
106 * Revision 1.57 2007/06/01 16:53:05 fabiankeil
107 * Adjust cgi_show_url_info() to show what forward-override{}
108 * would do with the requested URL (instead of showing how the
109 * request for the CGI page would be forwarded if it wasn't a
112 * Revision 1.56 2007/05/21 10:50:35 fabiankeil
113 * - Use strlcpy() instead of strcpy().
114 * - Stop treating actions files special. Expect a complete file name
115 * (with or without path) like it's done for the rest of the files.
117 * - Don't rerun sed() in cgi_show_request().
119 * Revision 1.55 2007/04/13 13:36:46 fabiankeil
120 * Reference action files in CGI URLs by id instead
121 * of using the first part of the file name.
122 * Fixes BR 1694250 and BR 1590556.
124 * Revision 1.54 2007/04/09 18:11:35 fabiankeil
125 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
127 * Revision 1.53 2007/04/08 13:21:04 fabiankeil
128 * Reference action files in CGI URLs by id instead
129 * of using the first part of the file name.
130 * Fixes BR 1694250 and BR 1590556.
132 * Revision 1.52 2007/02/13 15:10:26 fabiankeil
133 * Apparently fopen()ing in "binary" mode doesn't require
134 * #ifdefs, it's already done without them in cgiedit.c.
136 * Revision 1.51 2007/02/10 16:55:22 fabiankeil
137 * - Show forwarding settings on the show-url-info page
138 * - Fix some HTML syntax errors.
140 * Revision 1.50 2007/01/23 15:51:17 fabiankeil
141 * Add favicon delivery functions.
143 * Revision 1.49 2007/01/20 16:29:38 fabiankeil
144 * Suppress edit buttons for action files if Privoxy has
145 * no write access. Suggested by Roland in PR 1564026.
147 * Revision 1.48 2007/01/20 15:31:31 fabiankeil
148 * Display warning if show-url-info CGI page
149 * is used while Privoxy is toggled off.
151 * Revision 1.47 2007/01/12 15:07:10 fabiankeil
152 * Use zalloc in cgi_send_user_manual.
154 * Revision 1.46 2007/01/02 12:49:46 fabiankeil
155 * Add FEATURE_ZLIB to the list of conditional
156 * defines at the show-status page.
158 * Revision 1.45 2006/12/28 18:16:41 fabiankeil
159 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
160 * body memory before using it, replaced sprintf calls with snprintf.
162 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
163 * Removed checks whether or not AF_FILES have
164 * data structures associated with them in cgi_show_status.
165 * It doesn't matter as we're only interested in the file names.
167 * For the action files the checks were always true,
168 * but they prevented empty filter files from being
169 * listed. Fixes parts of BR 1619208.
171 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
172 * - Added FEATURE_GRACEFUL_TERMINATION to the
173 * "conditional #defines" section
174 * - Escaped ampersands in generated HTML.
175 * - Renamed re-filter-filename to re-filter-filenames
177 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
178 * Add special treatment for WIN32 to make sure
179 * cgi_send_user_manual opens the files in binary mode.
180 * Fixes BR 1600411 and unbreaks image delivery.
182 * Remove outdated comment.
184 * Revision 1.41 2006/10/09 19:18:28 roro
185 * Redirect http://p.p/user-manual (without trailing slash) to
186 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
188 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
189 * Modified cgi_send_user_manual to serve binary
190 * content without destroying it first. Should also be
191 * faster now. Added ".jpg" check for Content-Type guessing.
193 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
194 * Deliver documents in the user-manual directory
195 * with "Content-Type text/css" if their filename
198 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
199 * Incorporate modified version of Roland Rosenfeld's patch to
200 * optionally access the user-manual via Privoxy. Closes patch 679075.
202 * Formatting changed to Privoxy style, added call to
203 * cgi_error_no_template if the requested file doesn't
204 * exist and modified check whether or not Privoxy itself
205 * should serve the manual. Should work cross-platform now.
207 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
208 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
209 * with what was really the latest development (the v_3_0_branch branch)
211 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
212 * Multiple filter file support
214 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
215 * Undo some damaging memory leak patches
217 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
218 * A few memory leaks plugged (mostly on error paths)
220 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
221 * Another instance of:
222 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
223 * Thanks to Magnus Holmgren for the patch
225 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
226 * - Prevent line wrap beween "View/Edit" link buttons on status page
227 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
229 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
230 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
232 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
233 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
235 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
236 * Applying patch from Andreas as provided by Hal on the list.
237 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
239 * Revision 1.35 2002/05/12 21:44:44 jongfoster
240 * Adding amiga.[ch] revision information, if on an amiga.
242 * Revision 1.34 2002/04/30 12:06:12 oes
243 * Deleted unused code from default_cgi
245 * Revision 1.33 2002/04/30 11:14:52 oes
246 * Made csp the first parameter in *action_to_html
248 * Revision 1.32 2002/04/26 18:29:13 jongfoster
249 * Fixing this Visual C++ warning:
250 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
252 * Revision 1.31 2002/04/26 12:54:36 oes
253 * - Kill obsolete REDIRECT_URL code
254 * - Error handling fixes
255 * - Style sheet related HTML snipplet changes
256 * - cgi_show_url_info:
257 * - Matches now in table, actions on single lines,
259 * - standard.action suppressed
260 * - Buttons to View and Edit AFs
262 * Revision 1.30 2002/04/24 02:18:08 oes
263 * - show-status is now the starting point for editing
264 * the actions files, generate list of all AFs with buttons
265 * for viewing and editing, new look for file list (Jon:
266 * buttons now aligned ;-P ), view mode now supports multiple
267 * AFs, name changes, no view links for unspecified files,
268 * no edit link for standard.action.
270 * - Jon's multiple AF patch: cgi_show_url_info now uses all
271 * AFs and marks the output accordingly
273 * Revision 1.29 2002/04/10 13:38:35 oes
274 * load_template signature changed
276 * Revision 1.28 2002/04/07 15:42:12 jongfoster
277 * Fixing send-banner?type=auto when the image-blocker is
278 * a redirect to send-banner
280 * Revision 1.27 2002/04/05 15:50:48 oes
281 * added send-stylesheet CGI
283 * Revision 1.26 2002/04/04 00:36:36 gliptak
284 * always use pcre for matching
286 * Revision 1.25 2002/04/03 22:28:03 gliptak
287 * Removed references to gnu_regex
289 * Revision 1.24 2002/04/02 16:12:47 oes
290 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
292 * Revision 1.23 2002/03/26 22:29:54 swa
293 * we have a new homepage!
295 * Revision 1.22 2002/03/24 16:18:15 jongfoster
298 * Revision 1.21 2002/03/24 15:23:33 jongfoster
301 * Revision 1.20 2002/03/24 13:25:43 swa
302 * name change related issues
304 * Revision 1.19 2002/03/16 23:54:06 jongfoster
305 * Adding graceful termination feature, to help look for memory leaks.
306 * If you enable this (which, by design, has to be done by hand
307 * editing config.h) and then go to http://i.j.b/die, then the program
308 * will exit cleanly after the *next* request. It should free all the
309 * memory that was used.
311 * Revision 1.18 2002/03/12 01:44:49 oes
312 * Changed default for "blocked" image from jb logo to checkboard pattern
314 * Revision 1.17 2002/03/08 16:43:18 oes
315 * Added choice beween GIF and PNG built-in images
317 * Revision 1.16 2002/03/07 03:48:38 oes
318 * - Changed built-in images from GIF to PNG
319 * (with regard to Unisys patent issue)
320 * - Added a 4x4 pattern PNG which is less intrusive
321 * than the logo but also clearly marks the deleted banners
323 * Revision 1.15 2002/03/06 22:54:35 jongfoster
324 * Automated function-comment nitpicking.
326 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
327 * Clean up a little CRLF unpleasantness that suddenly appeared
329 * Revision 1.13 2002/02/21 00:10:37 jongfoster
330 * Adding send-banner?type=auto option
332 * Revision 1.12 2002/01/23 01:03:32 jongfoster
333 * Fixing gcc [CygWin] compiler warnings
335 * Revision 1.11 2002/01/23 00:01:04 jongfoster
336 * Adding cgi_transparent_gif() for http://i.j.b/t
337 * Adding missing html_encode() to many CGI functions.
338 * Adding urlmatch.[ch] to http://i.j.b/show-version
340 * Revision 1.10 2002/01/17 21:10:37 jongfoster
341 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
342 * Also fixing a problem in the same function with improperly quoted URLs
343 * in output HTML, and adding code to handle https:// URLs correctly.
345 * Revision 1.9 2001/11/30 23:09:15 jongfoster
346 * Now reports on FEATURE_CGI_EDIT_ACTIONS
347 * Removing FEATURE_DENY_GZIP from template
349 * Revision 1.8 2001/11/13 00:14:07 jongfoster
350 * Fixing stupid bug now I've figured out what || means.
351 * (It always returns 0 or 1, not one of it's paramaters.)
353 * Revision 1.7 2001/10/23 21:48:19 jongfoster
354 * Cleaning up error handling in CGI functions - they now send back
355 * a HTML error page and should never cause a FATAL error. (Fixes one
356 * potential source of "denial of service" attacks).
358 * CGI actions file editor that works and is actually useful.
360 * Ability to toggle JunkBuster remotely using a CGI call.
362 * You can turn off both the above features in the main configuration
363 * file, e.g. if you are running a multi-user proxy.
365 * Revision 1.6 2001/10/14 22:00:32 jongfoster
366 * Adding support for a 404 error when an invalid CGI page is requested.
368 * Revision 1.5 2001/10/07 15:30:41 oes
369 * Removed FEATURE_DENY_GZIP
371 * Revision 1.4 2001/10/02 15:31:12 oes
372 * Introduced show-request cgi
374 * Revision 1.3 2001/09/22 16:34:44 jongfoster
375 * Removing unneeded #includes
377 * Revision 1.2 2001/09/19 18:01:11 oes
378 * Fixed comments; cosmetics
380 * Revision 1.1 2001/09/16 17:08:54 jongfoster
381 * Moving simple CGI functions from cgi.c to new file cgisimple.c
384 **********************************************************************/
390 #include <sys/types.h>
398 #endif /* def HAVE_ACCESS */
402 #include "cgisimple.h"
408 #include "miscutil.h"
411 #include "urlmatch.h"
414 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
416 static char *show_rcs(void);
417 static jb_err show_defines(struct map *exports);
418 static jb_err cgi_show_file(struct client_state *csp,
419 struct http_response *rsp,
420 const struct map *parameters);
421 static jb_err load_file(const char *filename, char **buffer, size_t *length);
423 /*********************************************************************
425 * Function : cgi_default
427 * Description : CGI function that is called for the CGI_SITE_1_HOST
428 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
429 * Boring - only exports the default exports.
432 * 1 : csp = Current client state (buffers, headers, etc...)
433 * 2 : rsp = http_response data structure for output
434 * 3 : parameters = map of cgi parameters
436 * CGI Parameters : none
438 * Returns : JB_ERR_OK on success
439 * JB_ERR_MEMORY on out-of-memory
441 *********************************************************************/
442 jb_err cgi_default(struct client_state *csp,
443 struct http_response *rsp,
444 const struct map *parameters)
451 if (NULL == (exports = default_exports(csp, "")))
453 return JB_ERR_MEMORY;
456 return template_fill_for_cgi(csp, "default", exports, rsp);
460 /*********************************************************************
462 * Function : cgi_error_404
464 * Description : CGI function that is called if an unknown action was
468 * 1 : csp = Current client state (buffers, headers, etc...)
469 * 2 : rsp = http_response data structure for output
470 * 3 : parameters = map of cgi parameters
472 * CGI Parameters : none
474 * Returns : JB_ERR_OK on success
475 * JB_ERR_MEMORY on out-of-memory error.
477 *********************************************************************/
478 jb_err cgi_error_404(struct client_state *csp,
479 struct http_response *rsp,
480 const struct map *parameters)
488 if (NULL == (exports = default_exports(csp, NULL)))
490 return JB_ERR_MEMORY;
493 rsp->status = strdup("404 Privoxy configuration page not found");
494 if (rsp->status == NULL)
497 return JB_ERR_MEMORY;
500 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
504 #ifdef FEATURE_GRACEFUL_TERMINATION
505 /*********************************************************************
509 * Description : CGI function to shut down Privoxy.
510 * NOTE: Turning this on in a production build
511 * would be a BAD idea. An EXTREMELY BAD idea.
512 * In short, don't do it.
515 * 1 : csp = Current client state (buffers, headers, etc...)
516 * 2 : rsp = http_response data structure for output
517 * 3 : parameters = map of cgi parameters
519 * CGI Parameters : none
521 * Returns : JB_ERR_OK on success
522 * JB_ERR_MEMORY on out-of-memory error.
524 *********************************************************************/
525 jb_err cgi_die (struct client_state *csp,
526 struct http_response *rsp,
527 const struct map *parameters)
537 * I don't really care what gets sent back to the browser.
538 * Take the easy option - "out of memory" page.
541 return JB_ERR_MEMORY;
543 #endif /* def FEATURE_GRACEFUL_TERMINATION */
546 /*********************************************************************
548 * Function : cgi_show_request
550 * Description : Show the client's request and what sed() would have
554 * 1 : csp = Current client state (buffers, headers, etc...)
555 * 2 : rsp = http_response data structure for output
556 * 3 : parameters = map of cgi parameters
558 * CGI Parameters : none
560 * Returns : JB_ERR_OK on success
561 * JB_ERR_MEMORY on out-of-memory error.
563 *********************************************************************/
564 jb_err cgi_show_request(struct client_state *csp,
565 struct http_response *rsp,
566 const struct map *parameters)
575 if (NULL == (exports = default_exports(csp, "show-request")))
577 return JB_ERR_MEMORY;
581 * Repair the damage done to the IOB by get_header()
583 for (p = csp->iob->buf; p < csp->iob->eod; p++)
585 if (*p == '\0') *p = '\n';
589 * Export the original client's request and the one we would
590 * be sending to the server if this wasn't a CGI call
593 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
596 return JB_ERR_MEMORY;
599 if (map(exports, "processed-request", 1,
600 html_encode_and_free_original(list_to_text(csp->headers)), 0))
603 return JB_ERR_MEMORY;
606 return template_fill_for_cgi(csp, "show-request", exports, rsp);
610 /*********************************************************************
612 * Function : cgi_send_banner
614 * Description : CGI function that returns a banner.
617 * 1 : csp = Current client state (buffers, headers, etc...)
618 * 2 : rsp = http_response data structure for output
619 * 3 : parameters = map of cgi parameters
622 * type : Selects the type of banner between "trans", "logo",
623 * and "auto". Defaults to "logo" if absent or invalid.
624 * "auto" means to select as if we were image-blocking.
625 * (Only the first character really counts; b and t are
628 * Returns : JB_ERR_OK on success
629 * JB_ERR_MEMORY on out-of-memory error.
631 *********************************************************************/
632 jb_err cgi_send_banner(struct client_state *csp,
633 struct http_response *rsp,
634 const struct map *parameters)
636 char imagetype = lookup(parameters, "type")[0];
639 * If type is auto, then determine the right thing
640 * to do from the set-image-blocker action
642 if (imagetype == 'a')
649 #ifdef FEATURE_IMAGE_BLOCKING
650 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
652 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
653 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
654 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
658 /* Use default - nothing to do here. */
660 else if (0 == strcmpic(p, "blank"))
664 else if (0 == strcmpic(p, "pattern"))
670 * If the action is to call this CGI, determine
673 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
675 imagetype = p[sizeof(prefix1) - 1];
677 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
679 imagetype = p[sizeof(prefix2) - 1];
683 * Everything else must (should) be a URL to
691 #endif /* def FEATURE_IMAGE_BLOCKING */
695 * Now imagetype is either the non-auto type we were called with,
696 * or it was auto and has since been determined. In any case, we
697 * can proceed to actually answering the request by sending a redirect
698 * or an image as appropriate:
700 if (imagetype == 'r')
702 rsp->status = strdup("302 Local Redirect from Privoxy");
703 if (rsp->status == NULL)
705 return JB_ERR_MEMORY;
707 if (enlist_unique_header(rsp->headers, "Location",
708 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
710 return JB_ERR_MEMORY;
715 if ((imagetype == 'b') || (imagetype == 't'))
717 rsp->body = bindup(image_blank_data, image_blank_length);
718 rsp->content_length = image_blank_length;
722 rsp->body = bindup(image_pattern_data, image_pattern_length);
723 rsp->content_length = image_pattern_length;
726 if (rsp->body == NULL)
728 return JB_ERR_MEMORY;
730 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
732 return JB_ERR_MEMORY;
743 /*********************************************************************
745 * Function : cgi_transparent_image
747 * Description : CGI function that sends a 1x1 transparent image.
750 * 1 : csp = Current client state (buffers, headers, etc...)
751 * 2 : rsp = http_response data structure for output
752 * 3 : parameters = map of cgi parameters
754 * CGI Parameters : None
756 * Returns : JB_ERR_OK on success
757 * JB_ERR_MEMORY on out-of-memory error.
759 *********************************************************************/
760 jb_err cgi_transparent_image(struct client_state *csp,
761 struct http_response *rsp,
762 const struct map *parameters)
764 rsp->body = bindup(image_blank_data, image_blank_length);
765 rsp->content_length = image_blank_length;
767 if (rsp->body == NULL)
769 return JB_ERR_MEMORY;
772 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
774 return JB_ERR_MEMORY;
784 /*********************************************************************
786 * Function : cgi_send_default_favicon
788 * Description : CGI function that sends the standard favicon.
791 * 1 : csp = Current client state (buffers, headers, etc...)
792 * 2 : rsp = http_response data structure for output
793 * 3 : parameters = map of cgi parameters
795 * CGI Parameters : None
797 * Returns : JB_ERR_OK on success
798 * JB_ERR_MEMORY on out-of-memory error.
800 *********************************************************************/
801 jb_err cgi_send_default_favicon(struct client_state *csp,
802 struct http_response *rsp,
803 const struct map *parameters)
805 static const char default_favicon_data[] =
806 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
807 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
808 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
809 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
810 "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
811 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
812 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
813 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
814 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
815 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
816 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
817 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
818 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
820 static const size_t favicon_length = sizeof(default_favicon_data) - 1;
822 rsp->body = bindup(default_favicon_data, favicon_length);
823 rsp->content_length = favicon_length;
825 if (rsp->body == NULL)
827 return JB_ERR_MEMORY;
830 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
832 return JB_ERR_MEMORY;
842 /*********************************************************************
844 * Function : cgi_send_error_favicon
846 * Description : CGI function that sends the favicon for error pages.
849 * 1 : csp = Current client state (buffers, headers, etc...)
850 * 2 : rsp = http_response data structure for output
851 * 3 : parameters = map of cgi parameters
853 * CGI Parameters : None
855 * Returns : JB_ERR_OK on success
856 * JB_ERR_MEMORY on out-of-memory error.
858 *********************************************************************/
859 jb_err cgi_send_error_favicon(struct client_state *csp,
860 struct http_response *rsp,
861 const struct map *parameters)
863 static const char error_favicon_data[] =
864 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
865 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
866 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
867 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
868 "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
869 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
870 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
871 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
872 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
873 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
874 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
875 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
876 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
878 static const size_t favicon_length = sizeof(error_favicon_data) - 1;
880 rsp->body = bindup(error_favicon_data, favicon_length);
881 rsp->content_length = favicon_length;
883 if (rsp->body == NULL)
885 return JB_ERR_MEMORY;
888 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
890 return JB_ERR_MEMORY;
900 /*********************************************************************
902 * Function : cgi_send_stylesheet
904 * Description : CGI function that sends a css stylesheet found
905 * in the cgi-style.css template
908 * 1 : csp = Current client state (buffers, headers, etc...)
909 * 2 : rsp = http_response data structure for output
910 * 3 : parameters = map of cgi parameters
912 * CGI Parameters : None
914 * Returns : JB_ERR_OK on success
915 * JB_ERR_MEMORY on out-of-memory error.
917 *********************************************************************/
918 jb_err cgi_send_stylesheet(struct client_state *csp,
919 struct http_response *rsp,
920 const struct map *parameters)
927 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
929 if (err == JB_ERR_FILE)
932 * No way to tell user; send empty stylesheet
934 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
938 return err; /* JB_ERR_MEMORY */
941 if (enlist(rsp->headers, "Content-Type: text/css"))
943 return JB_ERR_MEMORY;
949 /*********************************************************************
951 * Function : cgi_send_user_manual
953 * Description : CGI function that sends a file in the user
957 * 1 : csp = Current client state (buffers, headers, etc...)
958 * 2 : rsp = http_response data structure for output
959 * 3 : parameters = map of cgi parameters
961 * CGI Parameters : file=name.html, the name of the HTML file
962 * (relative to user-manual from config)
964 * Returns : JB_ERR_OK on success
965 * JB_ERR_MEMORY on out-of-memory error.
967 *********************************************************************/
968 jb_err cgi_send_user_manual(struct client_state *csp,
969 struct http_response *rsp,
970 const struct map *parameters)
972 const char * filename;
974 jb_err err = JB_ERR_OK;
981 if (!parameters->first)
983 /* requested http://p.p/user-manual (without trailing slash) */
984 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
987 get_string_param(parameters, "file", &filename);
988 /* Check paramter for hack attempts */
989 if (filename && strchr(filename, '/'))
991 return JB_ERR_CGI_PARAMS;
993 if (filename && strstr(filename, ".."))
995 return JB_ERR_CGI_PARAMS;
998 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
999 if (full_path == NULL)
1001 return JB_ERR_MEMORY;
1004 err = load_file(full_path, &rsp->body, &rsp->content_length);
1005 if (JB_ERR_OK != err)
1007 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1008 if (JB_ERR_FILE == err)
1010 err = cgi_error_no_template(csp, rsp, full_path);
1017 /* Guess correct Content-Type based on the filename's ending */
1020 length = strlen(filename);
1026 if((length>=4) && !strcmp(&filename[length-4], ".css"))
1028 err = enlist(rsp->headers, "Content-Type: text/css");
1030 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
1032 err = enlist(rsp->headers, "Content-Type: image/jpeg");
1036 err = enlist(rsp->headers, "Content-Type: text/html");
1043 /*********************************************************************
1045 * Function : cgi_show_version
1047 * Description : CGI function that returns a a web page describing the
1048 * file versions of Privoxy.
1051 * 1 : csp = Current client state (buffers, headers, etc...)
1052 * 2 : rsp = http_response data structure for output
1053 * 3 : parameters = map of cgi parameters
1055 * CGI Parameters : none
1057 * Returns : JB_ERR_OK on success
1058 * JB_ERR_MEMORY on out-of-memory error.
1060 *********************************************************************/
1061 jb_err cgi_show_version(struct client_state *csp,
1062 struct http_response *rsp,
1063 const struct map *parameters)
1065 struct map *exports;
1071 if (NULL == (exports = default_exports(csp, "show-version")))
1073 return JB_ERR_MEMORY;
1076 if (map(exports, "sourceversions", 1, show_rcs(), 0))
1079 return JB_ERR_MEMORY;
1082 return template_fill_for_cgi(csp, "show-version", exports, rsp);
1086 /*********************************************************************
1088 * Function : cgi_show_status
1090 * Description : CGI function that returns a web page describing the
1091 * current status of Privoxy.
1094 * 1 : csp = Current client state (buffers, headers, etc...)
1095 * 2 : rsp = http_response data structure for output
1096 * 3 : parameters = map of cgi parameters
1099 * file : Which file to show. Only first letter is checked,
1104 * Default is to show menu and other information.
1106 * Returns : JB_ERR_OK on success
1107 * JB_ERR_MEMORY on out-of-memory error.
1109 *********************************************************************/
1110 jb_err cgi_show_status(struct client_state *csp,
1111 struct http_response *rsp,
1112 const struct map *parameters)
1118 char buf[BUFFER_SIZE];
1119 #ifdef FEATURE_STATISTICS
1120 float perc_rej; /* Percentage of http requests rejected */
1121 int local_urls_read;
1122 int local_urls_rejected;
1123 #endif /* ndef FEATURE_STATISTICS */
1124 jb_err err = JB_ERR_OK;
1126 struct map *exports;
1132 if ('\0' != *(lookup(parameters, "file")))
1134 return cgi_show_file(csp, rsp, parameters);
1137 if (NULL == (exports = default_exports(csp, "show-status")))
1139 return JB_ERR_MEMORY;
1143 for (j = 0; (s != NULL) && (j < Argc); j++)
1145 if (!err) err = string_join (&s, html_encode(Argv[j]));
1146 if (!err) err = string_append(&s, " ");
1148 if (!err) err = map(exports, "invocation", 1, s, 0);
1150 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1151 if (!err) err = show_defines(exports);
1156 return JB_ERR_MEMORY;
1159 #ifdef FEATURE_STATISTICS
1160 local_urls_read = urls_read;
1161 local_urls_rejected = urls_rejected;
1164 * Need to alter the stats not to include the fetch of this
1167 * Can't do following thread safely! doh!
1170 * urls_rejected--; * This will be incremented subsequently *
1173 if (local_urls_read == 0)
1175 if (!err) err = map_block_killer(exports, "have-stats");
1179 if (!err) err = map_block_killer(exports, "have-no-stats");
1181 perc_rej = (float)local_urls_rejected * 100.0F /
1182 (float)local_urls_read;
1184 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1185 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1187 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1188 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1190 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1191 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1194 #else /* ndef FEATURE_STATISTICS */
1195 err = err || map_block_killer(exports, "statistics");
1196 #endif /* ndef FEATURE_STATISTICS */
1199 * List all action files in use, together with view and edit links,
1200 * except for standard.action, which should only be viewable. (Not
1201 * enforced in the editor itself)
1202 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1205 for (i = 0; i < MAX_AF_FILES; i++)
1207 if (csp->actions_list[i] != NULL)
1209 if (!err) err = string_append(&s, "<tr><td>");
1210 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1211 snprintf(buf, sizeof(buf),
1212 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1213 if (!err) err = string_append(&s, buf);
1215 #ifdef FEATURE_CGI_EDIT_ACTIONS
1216 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1217 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
1218 && (NULL != csp->config->actions_file_short[i]))
1221 if (access(csp->config->actions_file[i], W_OK) == 0)
1223 #endif /* def HAVE_ACCESS */
1224 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%d\">Edit</a>", i);
1225 if (!err) err = string_append(&s, buf);
1230 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
1232 #endif /* def HAVE_ACCESS */
1236 if (!err) err = string_append(&s, "</td></tr>\n");
1241 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1245 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1249 * List all re_filterfiles in use, together with view options.
1250 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1253 for (i = 0; i < MAX_AF_FILES; i++)
1255 if (csp->rlist[i] != NULL)
1257 if (!err) err = string_append(&s, "<tr><td>");
1258 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1260 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1261 if (!err) err = string_append(&s, buf);
1262 if (!err) err = string_append(&s, "</td></tr>\n");
1267 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1271 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1272 if (!err) err = map_block_killer(exports, "have-filterfile");
1275 #ifdef FEATURE_TRUST
1278 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1282 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1283 if (!err) err = map_block_killer(exports, "have-trustfile");
1286 if (!err) err = map_block_killer(exports, "trust-support");
1287 #endif /* ndef FEATURE_TRUST */
1289 #ifdef FEATURE_CGI_EDIT_ACTIONS
1290 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1292 err = map_block_killer(exports, "cgi-editor-is-disabled");
1294 #endif /* ndef CGI_EDIT_ACTIONS */
1299 return JB_ERR_MEMORY;
1302 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1306 /*********************************************************************
1308 * Function : cgi_show_url_info
1310 * Description : CGI function that determines and shows which actions
1311 * Privoxy will perform for a given url, and which
1312 * matches starting from the defaults have lead to that.
1315 * 1 : csp = Current client state (buffers, headers, etc...)
1316 * 2 : rsp = http_response data structure for output
1317 * 3 : parameters = map of cgi parameters
1320 * url : The url whose actions are to be determined.
1321 * If url is unset, the url-given conditional will be
1322 * set, so that all but the form can be suppressed in
1325 * Returns : JB_ERR_OK on success
1326 * JB_ERR_MEMORY on out-of-memory error.
1328 *********************************************************************/
1329 jb_err cgi_show_url_info(struct client_state *csp,
1330 struct http_response *rsp,
1331 const struct map *parameters)
1334 struct map *exports;
1341 if (NULL == (exports = default_exports(csp, "show-url-info")))
1343 return JB_ERR_MEMORY;
1347 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1349 url_param = strdup(lookup(parameters, "url"));
1350 if (url_param == NULL)
1353 return JB_ERR_MEMORY;
1358 * Handle prefixes. 4 possibilities:
1359 * 1) "http://" or "https://" prefix present and followed by URL - OK
1360 * 2) Only the "http://" or "https://" part is present, no URL - change
1361 * to empty string so it will be detected later as "no URL".
1362 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1364 * 4) Parameter not specified or is empty string - let this fall through
1365 * for now, next block of code will handle it.
1367 if (0 == strncmp(url_param, "http://", 7))
1369 if (url_param[7] == '\0')
1372 * Empty URL (just prefix).
1373 * Make it totally empty so it's caught by the next if()
1375 url_param[0] = '\0';
1378 else if (0 == strncmp(url_param, "https://", 8))
1380 if (url_param[8] == '\0')
1383 * Empty URL (just prefix).
1384 * Make it totally empty so it's caught by the next if()
1386 url_param[0] = '\0';
1389 else if (url_param[0] != '\0')
1392 * Unknown prefix - assume http://
1394 const size_t url_param_prefixed_size = 7 + 1 + strlen(url_param);
1395 char * url_param_prefixed = malloc(url_param_prefixed_size);
1396 if (NULL == url_param_prefixed)
1400 return JB_ERR_MEMORY;
1402 strlcpy(url_param_prefixed, "http://", url_param_prefixed_size);
1403 strlcat(url_param_prefixed, url_param, url_param_prefixed_size);
1405 url_param = url_param_prefixed;
1409 * Hide "toggle off" warning if Privoxy is toggled on.
1412 #ifdef FEATURE_TOGGLE
1413 (global_toggle_state == 1) &&
1414 #endif /* def FEATURE_TOGGLE */
1415 map_block_killer(exports, "privoxy-is-toggled-off")
1419 return JB_ERR_MEMORY;
1422 if (url_param[0] == '\0')
1424 /* URL paramater not specified, display query form only. */
1426 if (map_block_killer(exports, "url-given")
1427 || map(exports, "url", 1, "", 1))
1430 return JB_ERR_MEMORY;
1435 /* Given a URL, so query it. */
1440 struct file_list *fl;
1441 struct url_actions *b;
1442 struct http_request url_to_query[1];
1443 struct current_action_spec action[1];
1446 if (map(exports, "url", 1, html_encode(url_param), 0))
1450 return JB_ERR_MEMORY;
1453 init_current_action(action);
1455 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1457 free_current_action(action);
1460 return JB_ERR_MEMORY;
1463 err = parse_http_url(url_param, url_to_query, csp);
1467 if (err == JB_ERR_MEMORY)
1469 free_http_request(url_to_query);
1470 free_current_action(action);
1472 return JB_ERR_MEMORY;
1478 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1479 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1480 if (!err) err = map_block_killer(exports, "valid-url");
1482 free_current_action(action);
1483 free_http_request(url_to_query);
1488 return JB_ERR_MEMORY;
1491 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1495 * We have a warning about SSL paths. Hide it for unencrypted sites.
1497 if (!url_to_query->ssl)
1499 if (map_block_killer(exports, "https"))
1501 free_current_action(action);
1503 free_http_request(url_to_query);
1504 return JB_ERR_MEMORY;
1508 matches = strdup("<table summary=\"\" class=\"transparent\">");
1510 for (i = 0; i < MAX_AF_FILES; i++)
1512 if (NULL == csp->config->actions_file_short[i]
1513 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1517 if ((fl = csp->actions_list[i]) != NULL)
1519 if ((b = fl->f) != NULL)
1521 /* FIXME: Hardcoded HTML! */
1522 string_append(&matches, "<tr><th>In file: ");
1523 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1524 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1525 string_append(&matches, buf);
1526 string_append(&matches, "View</a>");
1527 #ifdef FEATURE_CGI_EDIT_ACTIONS
1528 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1531 if (access(csp->config->actions_file[i], W_OK) == 0)
1533 #endif /* def HAVE_ACCESS */
1534 snprintf(buf, sizeof(buf),
1535 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1536 string_append(&matches, buf);
1537 string_append(&matches, "Edit</a>");
1542 string_append(&matches, " <strong>No write access.</strong>");
1544 #endif /* def HAVE_ACCESS */
1546 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1548 string_append(&matches, "</th></tr>\n");
1555 for (; (b != NULL) && (matches != NULL); b = b->next)
1557 if (url_match(b->url, url_to_query))
1559 string_append(&matches, "<tr><td>{");
1560 string_join (&matches, actions_to_html(csp, b->action));
1561 string_append(&matches, " }<br>\n<code>");
1562 string_join (&matches, html_encode(b->url->spec));
1563 string_append(&matches, "</code></td></tr>\n");
1565 if (merge_current_action(action, b->action))
1568 free_http_request(url_to_query);
1569 free_current_action(action);
1571 return JB_ERR_MEMORY;
1579 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1582 string_append(&matches, "</table>\n");
1585 * XXX: Kludge to make sure the "Forward settings" section
1586 * shows what forward-override{} would do with the requested URL.
1587 * No one really cares how the CGI request would be forwarded
1588 * if it wasn't intercepted as CGI request in the first place.
1590 * From here on the action bitmask will no longer reflect
1591 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1592 * but luckily it's no longer required later on anyway.
1594 free_current_action(csp->action);
1595 get_url_actions(csp, url_to_query);
1598 * Fill in forwarding settings.
1600 * The possibilities are:
1602 * - http forwarding only
1603 * - socks4(a) forwarding only
1604 * - socks4(a) and http forwarding.
1606 * XXX: Parts of this code could be reused for the
1607 * "forwarding-failed" template which currently doesn't
1608 * display the proxy port and an eventual second forwarder.
1611 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1613 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1615 if (!err) err = map_block_killer(exports, "socks-forwarder");
1616 if (!err) err = map_block_killer(exports, "http-forwarder");
1620 char port[10]; /* We save proxy ports as int but need a string here */
1622 if (!err) err = map_block_killer(exports, "no-forwarder");
1624 if (fwd->gateway_host != NULL)
1626 char *socks_type = NULL;
1631 socks_type = "socks4";
1634 socks_type = "socks4a";
1637 socks_type = "socks5";
1640 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1643 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1644 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1645 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1646 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1650 if (!err) err = map_block_killer(exports, "socks-forwarder");
1653 if (fwd->forward_host != NULL)
1655 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1656 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1657 if (!err) err = map(exports, "forward-port", 1, port, 1);
1661 if (!err) err = map_block_killer(exports, "http-forwarder");
1666 free_http_request(url_to_query);
1668 if (err || matches == NULL)
1670 free_current_action(action);
1672 return JB_ERR_MEMORY;
1675 #ifdef FEATURE_CGI_EDIT_ACTIONS
1676 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1678 err = map_block_killer(exports, "cgi-editor-is-disabled");
1680 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1683 * If zlib support is available, if no content filters
1684 * are enabled or if the prevent-compression action is enabled,
1685 * suppress the "compression could prevent filtering" warning.
1687 * XXX: Change content_filters_enabled()'s prototype so we can
1690 #ifndef FEATURE_ZLIB
1691 if ((list_is_empty(action->multi[ACTION_MULTI_FILTER])
1692 && !(action->flags & ACTION_DEANIMATE))
1693 || (action->flags & ACTION_NO_COMPRESSION))
1696 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1699 if (err || map(exports, "matches", 1, matches , 0))
1701 free_current_action(action);
1703 return JB_ERR_MEMORY;
1706 s = current_action_to_html(csp, action);
1708 free_current_action(action);
1710 if (map(exports, "final", 1, s, 0))
1713 return JB_ERR_MEMORY;
1717 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1721 /*********************************************************************
1723 * Function : cgi_robots_txt
1725 * Description : CGI function to return "/robots.txt".
1728 * 1 : csp = Current client state (buffers, headers, etc...)
1729 * 2 : rsp = http_response data structure for output
1730 * 3 : parameters = map of cgi parameters
1732 * CGI Parameters : None
1734 * Returns : JB_ERR_OK on success
1735 * JB_ERR_MEMORY on out-of-memory error.
1737 *********************************************************************/
1738 jb_err cgi_robots_txt(struct client_state *csp,
1739 struct http_response *rsp,
1740 const struct map *parameters)
1746 "# This is the Privoxy control interface.\n"
1747 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1753 if (rsp->body == NULL)
1755 return JB_ERR_MEMORY;
1758 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1762 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1763 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1765 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1769 /*********************************************************************
1771 * Function : show_defines
1773 * Description : Add to a map the state od all conditional #defines
1774 * used when building
1777 * 1 : exports = map to extend
1779 * Returns : JB_ERR_OK on success
1780 * JB_ERR_MEMORY on out-of-memory error.
1782 *********************************************************************/
1783 static jb_err show_defines(struct map *exports)
1785 jb_err err = JB_ERR_OK;
1788 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1789 #else /* ifndef FEATURE_ACL */
1790 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1791 #endif /* ndef FEATURE_ACL */
1793 #ifdef FEATURE_CGI_EDIT_ACTIONS
1794 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1795 #else /* ifndef FEATURE_COOKIE_JAR */
1796 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1797 #endif /* ndef FEATURE_COOKIE_JAR */
1799 #ifdef FEATURE_COOKIE_JAR
1800 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1801 #else /* ifndef FEATURE_COOKIE_JAR */
1802 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1803 #endif /* ndef FEATURE_COOKIE_JAR */
1805 #ifdef FEATURE_FAST_REDIRECTS
1806 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1807 #else /* ifndef FEATURE_FAST_REDIRECTS */
1808 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1809 #endif /* ndef FEATURE_FAST_REDIRECTS */
1811 #ifdef FEATURE_FORCE_LOAD
1812 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1813 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1814 #else /* ifndef FEATURE_FORCE_LOAD */
1815 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1816 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1817 #endif /* ndef FEATURE_FORCE_LOAD */
1819 #ifdef FEATURE_GRACEFUL_TERMINATION
1820 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1821 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1822 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1823 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1825 #ifdef FEATURE_IMAGE_BLOCKING
1826 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1827 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1828 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1829 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1831 #ifdef FEATURE_IMAGE_DETECT_MSIE
1832 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1833 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1834 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1835 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1837 #ifdef FEATURE_NO_GIFS
1838 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1839 #else /* ifndef FEATURE_NO_GIFS */
1840 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1841 #endif /* ndef FEATURE_NO_GIFS */
1843 #ifdef FEATURE_PTHREAD
1844 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1845 #else /* ifndef FEATURE_PTHREAD */
1846 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1847 #endif /* ndef FEATURE_PTHREAD */
1849 #ifdef FEATURE_STATISTICS
1850 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1851 #else /* ifndef FEATURE_STATISTICS */
1852 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1853 #endif /* ndef FEATURE_STATISTICS */
1855 #ifdef FEATURE_TOGGLE
1856 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1857 #else /* ifndef FEATURE_TOGGLE */
1858 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1859 #endif /* ndef FEATURE_TOGGLE */
1861 #ifdef FEATURE_TRUST
1862 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1863 #else /* ifndef FEATURE_TRUST */
1864 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1865 #endif /* ndef FEATURE_TRUST */
1868 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1869 #else /* ifndef FEATURE_ZLIB */
1870 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1871 #endif /* ndef FEATURE_ZLIB */
1874 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1875 #else /* ifndef STATIC_PCRE */
1876 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1877 #endif /* ndef STATIC_PCRE */
1880 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1881 #else /* ifndef STATIC_PCRS */
1882 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1883 #endif /* ndef STATIC_PCRS */
1889 /*********************************************************************
1891 * Function : show_rcs
1893 * Description : Create a string with the rcs info for all sourcefiles
1897 * Returns : A string, or NULL on out-of-memory.
1899 *********************************************************************/
1900 static char *show_rcs(void)
1902 char *result = strdup("");
1903 char buf[BUFFER_SIZE];
1905 /* Instead of including *all* dot h's in the project (thus creating a
1906 * tremendous amount of dependencies), I will concede to declaring them
1907 * as extern's. This forces the developer to add to this list, but oh well.
1910 #define SHOW_RCS(__x) \
1912 extern const char __x[]; \
1913 snprintf(buf, sizeof(buf), " %s\n", __x); \
1914 string_append(&result, buf); \
1917 /* In alphabetical order */
1918 SHOW_RCS(actions_h_rcs)
1919 SHOW_RCS(actions_rcs)
1921 SHOW_RCS(amiga_h_rcs)
1923 #endif /* def AMIGA */
1926 #ifdef FEATURE_CGI_EDIT_ACTIONS
1927 SHOW_RCS(cgiedit_h_rcs)
1928 SHOW_RCS(cgiedit_rcs)
1929 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1930 SHOW_RCS(cgisimple_h_rcs)
1931 SHOW_RCS(cgisimple_rcs)
1933 SHOW_RCS(cygwin_h_rcs)
1935 SHOW_RCS(deanimate_h_rcs)
1936 SHOW_RCS(deanimate_rcs)
1937 SHOW_RCS(encode_h_rcs)
1938 SHOW_RCS(encode_rcs)
1939 SHOW_RCS(errlog_h_rcs)
1940 SHOW_RCS(errlog_rcs)
1941 SHOW_RCS(filters_h_rcs)
1942 SHOW_RCS(filters_rcs)
1943 SHOW_RCS(gateway_h_rcs)
1944 SHOW_RCS(gateway_rcs)
1945 SHOW_RCS(jbsockets_h_rcs)
1946 SHOW_RCS(jbsockets_rcs)
1949 SHOW_RCS(list_h_rcs)
1951 SHOW_RCS(loadcfg_h_rcs)
1952 SHOW_RCS(loadcfg_rcs)
1953 SHOW_RCS(loaders_h_rcs)
1954 SHOW_RCS(loaders_rcs)
1955 SHOW_RCS(miscutil_h_rcs)
1956 SHOW_RCS(miscutil_rcs)
1957 SHOW_RCS(parsers_h_rcs)
1958 SHOW_RCS(parsers_rcs)
1960 SHOW_RCS(pcrs_h_rcs)
1961 SHOW_RCS(project_h_rcs)
1962 SHOW_RCS(ssplit_h_rcs)
1963 SHOW_RCS(ssplit_rcs)
1964 SHOW_RCS(urlmatch_h_rcs)
1965 SHOW_RCS(urlmatch_rcs)
1967 #ifndef _WIN_CONSOLE
1968 SHOW_RCS(w32log_h_rcs)
1969 SHOW_RCS(w32log_rcs)
1970 SHOW_RCS(w32res_h_rcs)
1971 SHOW_RCS(w32taskbar_h_rcs)
1972 SHOW_RCS(w32taskbar_rcs)
1973 #endif /* ndef _WIN_CONSOLE */
1974 SHOW_RCS(win32_h_rcs)
1976 #endif /* def _WIN32 */
1985 /*********************************************************************
1987 * Function : cgi_show_file
1989 * Description : CGI function that shows the content of a
1990 * configuration file.
1993 * 1 : csp = Current client state (buffers, headers, etc...)
1994 * 2 : rsp = http_response data structure for output
1995 * 3 : parameters = map of cgi parameters
1998 * file : Which file to show. Only first letter is checked,
2003 * Default is to show menu and other information.
2005 * Returns : JB_ERR_OK on success
2006 * JB_ERR_MEMORY on out-of-memory error.
2008 *********************************************************************/
2009 static jb_err cgi_show_file(struct client_state *csp,
2010 struct http_response *rsp,
2011 const struct map *parameters)
2014 const char * filename = NULL;
2015 char * file_description = NULL;
2021 switch (*(lookup(parameters, "file")))
2024 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2026 filename = csp->actions_list[i]->filename;
2027 file_description = "Actions File";
2032 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2034 filename = csp->rlist[i]->filename;
2035 file_description = "Filter File";
2039 #ifdef FEATURE_TRUST
2043 filename = csp->tlist->filename;
2044 file_description = "Trust File";
2047 #endif /* def FEATURE_TRUST */
2050 if (NULL != filename)
2052 struct map *exports;
2057 exports = default_exports(csp, "show-status");
2058 if (NULL == exports)
2060 return JB_ERR_MEMORY;
2063 if ( map(exports, "file-description", 1, file_description, 1)
2064 || map(exports, "filepath", 1, html_encode(filename), 0) )
2067 return JB_ERR_MEMORY;
2070 err = load_file(filename, &s, &length);
2071 if (JB_ERR_OK != err)
2073 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2076 return JB_ERR_MEMORY;
2081 s = html_encode_and_free_original(s);
2084 return JB_ERR_MEMORY;
2087 if (map(exports, "contents", 1, s, 0))
2090 return JB_ERR_MEMORY;
2094 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2097 return JB_ERR_CGI_PARAMS;
2101 /*********************************************************************
2103 * Function : load_file
2105 * Description : Loads a file into a buffer.
2108 * 1 : filename = Name of the file to be loaded.
2109 * 2 : buffer = Used to return the file's content.
2110 * 3 : length = Used to return the size of the file.
2112 * Returns : JB_ERR_OK in case of success,
2113 * JB_ERR_FILE in case of ordinary file loading errors
2114 * (fseek() and ftell() errors are fatal)
2115 * JB_ERR_MEMORY in case of out-of-memory.
2117 *********************************************************************/
2118 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2122 jb_err err = JB_ERR_OK;
2124 fp = fopen(filename, "rb");
2130 /* Get file length */
2131 if (fseek(fp, 0, SEEK_END))
2133 log_error(LOG_LEVEL_FATAL,
2134 "Unexpected erro while fseek()ing to the end of %s: %E",
2140 log_error(LOG_LEVEL_FATAL,
2141 "Unexpected ftell() error while loading %s: %E",
2144 *length = (size_t)ret;
2146 /* Go back to the beginning. */
2147 if (fseek(fp, 0, SEEK_SET))
2149 log_error(LOG_LEVEL_FATAL,
2150 "Unexpected error while fseek()ing to the beginning of %s: %E",
2154 *buffer = (char *)zalloc(*length + 1);
2155 if (NULL == *buffer)
2157 err = JB_ERR_MEMORY;
2159 else if (!fread(*buffer, *length, 1, fp))
2162 * May happen if the file size changes between fseek() and
2163 * fread(). If it does, we just log it and serve what we got.
2165 log_error(LOG_LEVEL_ERROR,
2166 "Couldn't completely read file %s.", filename);