1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.74 2008/04/26 15:50:56 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.74 2008/04/26 15:50:56 fabiankeil
40 * Fix macro name in cgi_show_file() error path.
42 * Revision 1.73 2008/04/26 12:21:55 fabiankeil
43 * Forget about JB_ERR_PARSE. JB_ERR_CGI_PARAMS to the rescue.
45 * Revision 1.72 2008/04/26 10:34:15 fabiankeil
46 * If zlib support is unavailable and there are content filters active
47 * but the prevent-compression action is disabled, include a warning
48 * on the show-url-info page that compression might prevent filtering.
50 * Revision 1.71 2008/04/25 13:33:56 fabiankeil
51 * - Factor cgi_show_file() out of cgi_show_status().
52 * - Adjust cgi_show_status()'s parameter description to match reality.
54 * Revision 1.70 2008/04/24 16:12:38 fabiankeil
55 * In cgi_show_status(), load the requested file at once.
56 * Using string_join() for every line really doesn't scale.
58 * Revision 1.69 2008/04/17 14:40:48 fabiankeil
59 * Provide get_http_time() with the buffer size so it doesn't
60 * have to blindly assume that the buffer is big enough.
62 * Revision 1.68 2008/03/27 18:27:21 fabiankeil
63 * Remove kill-popups action.
65 * Revision 1.67 2008/03/27 17:00:05 fabiankeil
66 * Turn the favicon blobs into locals.
68 * Revision 1.66 2008/02/23 16:57:12 fabiankeil
69 * Rename url_actions() to get_url_actions() and let it
70 * use the standard parameter ordering.
72 * Revision 1.65 2008/02/23 16:33:43 fabiankeil
73 * Let forward_url() use the standard parameter ordering
74 * and mark its second parameter immutable.
76 * Revision 1.64 2008/02/03 13:56:07 fabiankeil
77 * Add SOCKS5 support for show-url-info CGI page.
79 * Revision 1.63 2008/02/01 06:04:31 fabiankeil
80 * If edit buttons on the show-url-info CGI page are hidden, explain why.
82 * Revision 1.62 2008/02/01 05:52:40 fabiankeil
83 * Hide edit buttons on the show-url-info CGI page if enable-edit-action
84 * is disabled. Patch by Lee with additional white space adjustments.
86 * Revision 1.61 2008/01/26 11:13:25 fabiankeil
87 * If enable-edit-actions is disabled, hide the edit buttons and explain why.
89 * Revision 1.60 2007/10/27 13:12:13 fabiankeil
90 * Finish 1.49 and check write access before
91 * showing edit buttons on show-url-info page.
93 * Revision 1.59 2007/10/19 16:42:36 fabiankeil
94 * Plug memory leak I introduced five months ago.
95 * Yay Valgrind and Privoxy-Regression-Test.
97 * Revision 1.58 2007/07/21 12:19:50 fabiankeil
98 * If show-url-info is called with an URL that Privoxy
99 * would reject as invalid, don't show unresolved forwarding
100 * variables, "final matches" or claim the site's secure.
102 * Revision 1.57 2007/06/01 16:53:05 fabiankeil
103 * Adjust cgi_show_url_info() to show what forward-override{}
104 * would do with the requested URL (instead of showing how the
105 * request for the CGI page would be forwarded if it wasn't a
108 * Revision 1.56 2007/05/21 10:50:35 fabiankeil
109 * - Use strlcpy() instead of strcpy().
110 * - Stop treating actions files special. Expect a complete file name
111 * (with or without path) like it's done for the rest of the files.
113 * - Don't rerun sed() in cgi_show_request().
115 * Revision 1.55 2007/04/13 13:36:46 fabiankeil
116 * Reference action files in CGI URLs by id instead
117 * of using the first part of the file name.
118 * Fixes BR 1694250 and BR 1590556.
120 * Revision 1.54 2007/04/09 18:11:35 fabiankeil
121 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
123 * Revision 1.53 2007/04/08 13:21:04 fabiankeil
124 * Reference action files in CGI URLs by id instead
125 * of using the first part of the file name.
126 * Fixes BR 1694250 and BR 1590556.
128 * Revision 1.52 2007/02/13 15:10:26 fabiankeil
129 * Apparently fopen()ing in "binary" mode doesn't require
130 * #ifdefs, it's already done without them in cgiedit.c.
132 * Revision 1.51 2007/02/10 16:55:22 fabiankeil
133 * - Show forwarding settings on the show-url-info page
134 * - Fix some HTML syntax errors.
136 * Revision 1.50 2007/01/23 15:51:17 fabiankeil
137 * Add favicon delivery functions.
139 * Revision 1.49 2007/01/20 16:29:38 fabiankeil
140 * Suppress edit buttons for action files if Privoxy has
141 * no write access. Suggested by Roland in PR 1564026.
143 * Revision 1.48 2007/01/20 15:31:31 fabiankeil
144 * Display warning if show-url-info CGI page
145 * is used while Privoxy is toggled off.
147 * Revision 1.47 2007/01/12 15:07:10 fabiankeil
148 * Use zalloc in cgi_send_user_manual.
150 * Revision 1.46 2007/01/02 12:49:46 fabiankeil
151 * Add FEATURE_ZLIB to the list of conditional
152 * defines at the show-status page.
154 * Revision 1.45 2006/12/28 18:16:41 fabiankeil
155 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
156 * body memory before using it, replaced sprintf calls with snprintf.
158 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
159 * Removed checks whether or not AF_FILES have
160 * data structures associated with them in cgi_show_status.
161 * It doesn't matter as we're only interested in the file names.
163 * For the action files the checks were always true,
164 * but they prevented empty filter files from being
165 * listed. Fixes parts of BR 1619208.
167 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
168 * - Added FEATURE_GRACEFUL_TERMINATION to the
169 * "conditional #defines" section
170 * - Escaped ampersands in generated HTML.
171 * - Renamed re-filter-filename to re-filter-filenames
173 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
174 * Add special treatment for WIN32 to make sure
175 * cgi_send_user_manual opens the files in binary mode.
176 * Fixes BR 1600411 and unbreaks image delivery.
178 * Remove outdated comment.
180 * Revision 1.41 2006/10/09 19:18:28 roro
181 * Redirect http://p.p/user-manual (without trailing slash) to
182 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
184 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
185 * Modified cgi_send_user_manual to serve binary
186 * content without destroying it first. Should also be
187 * faster now. Added ".jpg" check for Content-Type guessing.
189 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
190 * Deliver documents in the user-manual directory
191 * with "Content-Type text/css" if their filename
194 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
195 * Incorporate modified version of Roland Rosenfeld's patch to
196 * optionally access the user-manual via Privoxy. Closes patch 679075.
198 * Formatting changed to Privoxy style, added call to
199 * cgi_error_no_template if the requested file doesn't
200 * exist and modified check whether or not Privoxy itself
201 * should serve the manual. Should work cross-platform now.
203 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
204 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
205 * with what was really the latest development (the v_3_0_branch branch)
207 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
208 * Multiple filter file support
210 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
211 * Undo some damaging memory leak patches
213 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
214 * A few memory leaks plugged (mostly on error paths)
216 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
217 * Another instance of:
218 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
219 * Thanks to Magnus Holmgren for the patch
221 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
222 * - Prevent line wrap beween "View/Edit" link buttons on status page
223 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
225 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
226 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
228 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
229 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
231 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
232 * Applying patch from Andreas as provided by Hal on the list.
233 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
235 * Revision 1.35 2002/05/12 21:44:44 jongfoster
236 * Adding amiga.[ch] revision information, if on an amiga.
238 * Revision 1.34 2002/04/30 12:06:12 oes
239 * Deleted unused code from default_cgi
241 * Revision 1.33 2002/04/30 11:14:52 oes
242 * Made csp the first parameter in *action_to_html
244 * Revision 1.32 2002/04/26 18:29:13 jongfoster
245 * Fixing this Visual C++ warning:
246 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
248 * Revision 1.31 2002/04/26 12:54:36 oes
249 * - Kill obsolete REDIRECT_URL code
250 * - Error handling fixes
251 * - Style sheet related HTML snipplet changes
252 * - cgi_show_url_info:
253 * - Matches now in table, actions on single lines,
255 * - standard.action suppressed
256 * - Buttons to View and Edit AFs
258 * Revision 1.30 2002/04/24 02:18:08 oes
259 * - show-status is now the starting point for editing
260 * the actions files, generate list of all AFs with buttons
261 * for viewing and editing, new look for file list (Jon:
262 * buttons now aligned ;-P ), view mode now supports multiple
263 * AFs, name changes, no view links for unspecified files,
264 * no edit link for standard.action.
266 * - Jon's multiple AF patch: cgi_show_url_info now uses all
267 * AFs and marks the output accordingly
269 * Revision 1.29 2002/04/10 13:38:35 oes
270 * load_template signature changed
272 * Revision 1.28 2002/04/07 15:42:12 jongfoster
273 * Fixing send-banner?type=auto when the image-blocker is
274 * a redirect to send-banner
276 * Revision 1.27 2002/04/05 15:50:48 oes
277 * added send-stylesheet CGI
279 * Revision 1.26 2002/04/04 00:36:36 gliptak
280 * always use pcre for matching
282 * Revision 1.25 2002/04/03 22:28:03 gliptak
283 * Removed references to gnu_regex
285 * Revision 1.24 2002/04/02 16:12:47 oes
286 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
288 * Revision 1.23 2002/03/26 22:29:54 swa
289 * we have a new homepage!
291 * Revision 1.22 2002/03/24 16:18:15 jongfoster
294 * Revision 1.21 2002/03/24 15:23:33 jongfoster
297 * Revision 1.20 2002/03/24 13:25:43 swa
298 * name change related issues
300 * Revision 1.19 2002/03/16 23:54:06 jongfoster
301 * Adding graceful termination feature, to help look for memory leaks.
302 * If you enable this (which, by design, has to be done by hand
303 * editing config.h) and then go to http://i.j.b/die, then the program
304 * will exit cleanly after the *next* request. It should free all the
305 * memory that was used.
307 * Revision 1.18 2002/03/12 01:44:49 oes
308 * Changed default for "blocked" image from jb logo to checkboard pattern
310 * Revision 1.17 2002/03/08 16:43:18 oes
311 * Added choice beween GIF and PNG built-in images
313 * Revision 1.16 2002/03/07 03:48:38 oes
314 * - Changed built-in images from GIF to PNG
315 * (with regard to Unisys patent issue)
316 * - Added a 4x4 pattern PNG which is less intrusive
317 * than the logo but also clearly marks the deleted banners
319 * Revision 1.15 2002/03/06 22:54:35 jongfoster
320 * Automated function-comment nitpicking.
322 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
323 * Clean up a little CRLF unpleasantness that suddenly appeared
325 * Revision 1.13 2002/02/21 00:10:37 jongfoster
326 * Adding send-banner?type=auto option
328 * Revision 1.12 2002/01/23 01:03:32 jongfoster
329 * Fixing gcc [CygWin] compiler warnings
331 * Revision 1.11 2002/01/23 00:01:04 jongfoster
332 * Adding cgi_transparent_gif() for http://i.j.b/t
333 * Adding missing html_encode() to many CGI functions.
334 * Adding urlmatch.[ch] to http://i.j.b/show-version
336 * Revision 1.10 2002/01/17 21:10:37 jongfoster
337 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
338 * Also fixing a problem in the same function with improperly quoted URLs
339 * in output HTML, and adding code to handle https:// URLs correctly.
341 * Revision 1.9 2001/11/30 23:09:15 jongfoster
342 * Now reports on FEATURE_CGI_EDIT_ACTIONS
343 * Removing FEATURE_DENY_GZIP from template
345 * Revision 1.8 2001/11/13 00:14:07 jongfoster
346 * Fixing stupid bug now I've figured out what || means.
347 * (It always returns 0 or 1, not one of it's paramaters.)
349 * Revision 1.7 2001/10/23 21:48:19 jongfoster
350 * Cleaning up error handling in CGI functions - they now send back
351 * a HTML error page and should never cause a FATAL error. (Fixes one
352 * potential source of "denial of service" attacks).
354 * CGI actions file editor that works and is actually useful.
356 * Ability to toggle JunkBuster remotely using a CGI call.
358 * You can turn off both the above features in the main configuration
359 * file, e.g. if you are running a multi-user proxy.
361 * Revision 1.6 2001/10/14 22:00:32 jongfoster
362 * Adding support for a 404 error when an invalid CGI page is requested.
364 * Revision 1.5 2001/10/07 15:30:41 oes
365 * Removed FEATURE_DENY_GZIP
367 * Revision 1.4 2001/10/02 15:31:12 oes
368 * Introduced show-request cgi
370 * Revision 1.3 2001/09/22 16:34:44 jongfoster
371 * Removing unneeded #includes
373 * Revision 1.2 2001/09/19 18:01:11 oes
374 * Fixed comments; cosmetics
376 * Revision 1.1 2001/09/16 17:08:54 jongfoster
377 * Moving simple CGI functions from cgi.c to new file cgisimple.c
380 **********************************************************************/
386 #include <sys/types.h>
394 #endif /* def HAVE_ACCESS */
398 #include "cgisimple.h"
404 #include "miscutil.h"
407 #include "urlmatch.h"
410 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
412 static char *show_rcs(void);
413 static jb_err show_defines(struct map *exports);
414 static jb_err cgi_show_file(struct client_state *csp,
415 struct http_response *rsp,
416 const struct map *parameters);
417 static jb_err load_file(const char *filename, char **buffer, size_t *length);
419 /*********************************************************************
421 * Function : cgi_default
423 * Description : CGI function that is called for the CGI_SITE_1_HOST
424 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
425 * Boring - only exports the default exports.
428 * 1 : csp = Current client state (buffers, headers, etc...)
429 * 2 : rsp = http_response data structure for output
430 * 3 : parameters = map of cgi parameters
432 * CGI Parameters : none
434 * Returns : JB_ERR_OK on success
435 * JB_ERR_MEMORY on out-of-memory
437 *********************************************************************/
438 jb_err cgi_default(struct client_state *csp,
439 struct http_response *rsp,
440 const struct map *parameters)
447 if (NULL == (exports = default_exports(csp, "")))
449 return JB_ERR_MEMORY;
452 return template_fill_for_cgi(csp, "default", exports, rsp);
456 /*********************************************************************
458 * Function : cgi_error_404
460 * Description : CGI function that is called if an unknown action was
464 * 1 : csp = Current client state (buffers, headers, etc...)
465 * 2 : rsp = http_response data structure for output
466 * 3 : parameters = map of cgi parameters
468 * CGI Parameters : none
470 * Returns : JB_ERR_OK on success
471 * JB_ERR_MEMORY on out-of-memory error.
473 *********************************************************************/
474 jb_err cgi_error_404(struct client_state *csp,
475 struct http_response *rsp,
476 const struct map *parameters)
484 if (NULL == (exports = default_exports(csp, NULL)))
486 return JB_ERR_MEMORY;
489 rsp->status = strdup("404 Privoxy configuration page not found");
490 if (rsp->status == NULL)
493 return JB_ERR_MEMORY;
496 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
500 #ifdef FEATURE_GRACEFUL_TERMINATION
501 /*********************************************************************
505 * Description : CGI function to shut down Privoxy.
506 * NOTE: Turning this on in a production build
507 * would be a BAD idea. An EXTREMELY BAD idea.
508 * In short, don't do it.
511 * 1 : csp = Current client state (buffers, headers, etc...)
512 * 2 : rsp = http_response data structure for output
513 * 3 : parameters = map of cgi parameters
515 * CGI Parameters : none
517 * Returns : JB_ERR_OK on success
518 * JB_ERR_MEMORY on out-of-memory error.
520 *********************************************************************/
521 jb_err cgi_die (struct client_state *csp,
522 struct http_response *rsp,
523 const struct map *parameters)
533 * I don't really care what gets sent back to the browser.
534 * Take the easy option - "out of memory" page.
537 return JB_ERR_MEMORY;
539 #endif /* def FEATURE_GRACEFUL_TERMINATION */
542 /*********************************************************************
544 * Function : cgi_show_request
546 * Description : Show the client's request and what sed() would have
550 * 1 : csp = Current client state (buffers, headers, etc...)
551 * 2 : rsp = http_response data structure for output
552 * 3 : parameters = map of cgi parameters
554 * CGI Parameters : none
556 * Returns : JB_ERR_OK on success
557 * JB_ERR_MEMORY on out-of-memory error.
559 *********************************************************************/
560 jb_err cgi_show_request(struct client_state *csp,
561 struct http_response *rsp,
562 const struct map *parameters)
571 if (NULL == (exports = default_exports(csp, "show-request")))
573 return JB_ERR_MEMORY;
577 * Repair the damage done to the IOB by get_header()
579 for (p = csp->iob->buf; p < csp->iob->eod; p++)
581 if (*p == '\0') *p = '\n';
585 * Export the original client's request and the one we would
586 * be sending to the server if this wasn't a CGI call
589 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
592 return JB_ERR_MEMORY;
595 if (map(exports, "processed-request", 1,
596 html_encode_and_free_original(list_to_text(csp->headers)), 0))
599 return JB_ERR_MEMORY;
602 return template_fill_for_cgi(csp, "show-request", exports, rsp);
606 /*********************************************************************
608 * Function : cgi_send_banner
610 * Description : CGI function that returns a banner.
613 * 1 : csp = Current client state (buffers, headers, etc...)
614 * 2 : rsp = http_response data structure for output
615 * 3 : parameters = map of cgi parameters
618 * type : Selects the type of banner between "trans", "logo",
619 * and "auto". Defaults to "logo" if absent or invalid.
620 * "auto" means to select as if we were image-blocking.
621 * (Only the first character really counts; b and t are
624 * Returns : JB_ERR_OK on success
625 * JB_ERR_MEMORY on out-of-memory error.
627 *********************************************************************/
628 jb_err cgi_send_banner(struct client_state *csp,
629 struct http_response *rsp,
630 const struct map *parameters)
632 char imagetype = lookup(parameters, "type")[0];
635 * If type is auto, then determine the right thing
636 * to do from the set-image-blocker action
638 if (imagetype == 'a')
645 #ifdef FEATURE_IMAGE_BLOCKING
646 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
648 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
649 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
650 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
654 /* Use default - nothing to do here. */
656 else if (0 == strcmpic(p, "blank"))
660 else if (0 == strcmpic(p, "pattern"))
666 * If the action is to call this CGI, determine
669 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
671 imagetype = p[sizeof(prefix1) - 1];
673 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
675 imagetype = p[sizeof(prefix2) - 1];
679 * Everything else must (should) be a URL to
687 #endif /* def FEATURE_IMAGE_BLOCKING */
691 * Now imagetype is either the non-auto type we were called with,
692 * or it was auto and has since been determined. In any case, we
693 * can proceed to actually answering the request by sending a redirect
694 * or an image as appropriate:
696 if (imagetype == 'r')
698 rsp->status = strdup("302 Local Redirect from Privoxy");
699 if (rsp->status == NULL)
701 return JB_ERR_MEMORY;
703 if (enlist_unique_header(rsp->headers, "Location",
704 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
706 return JB_ERR_MEMORY;
711 if ((imagetype == 'b') || (imagetype == 't'))
713 rsp->body = bindup(image_blank_data, image_blank_length);
714 rsp->content_length = image_blank_length;
718 rsp->body = bindup(image_pattern_data, image_pattern_length);
719 rsp->content_length = image_pattern_length;
722 if (rsp->body == NULL)
724 return JB_ERR_MEMORY;
726 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
728 return JB_ERR_MEMORY;
739 /*********************************************************************
741 * Function : cgi_transparent_image
743 * Description : CGI function that sends a 1x1 transparent image.
746 * 1 : csp = Current client state (buffers, headers, etc...)
747 * 2 : rsp = http_response data structure for output
748 * 3 : parameters = map of cgi parameters
750 * CGI Parameters : None
752 * Returns : JB_ERR_OK on success
753 * JB_ERR_MEMORY on out-of-memory error.
755 *********************************************************************/
756 jb_err cgi_transparent_image(struct client_state *csp,
757 struct http_response *rsp,
758 const struct map *parameters)
760 rsp->body = bindup(image_blank_data, image_blank_length);
761 rsp->content_length = image_blank_length;
763 if (rsp->body == NULL)
765 return JB_ERR_MEMORY;
768 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
770 return JB_ERR_MEMORY;
780 /*********************************************************************
782 * Function : cgi_send_default_favicon
784 * Description : CGI function that sends the standard favicon.
787 * 1 : csp = Current client state (buffers, headers, etc...)
788 * 2 : rsp = http_response data structure for output
789 * 3 : parameters = map of cgi parameters
791 * CGI Parameters : None
793 * Returns : JB_ERR_OK on success
794 * JB_ERR_MEMORY on out-of-memory error.
796 *********************************************************************/
797 jb_err cgi_send_default_favicon(struct client_state *csp,
798 struct http_response *rsp,
799 const struct map *parameters)
801 static const char default_favicon_data[] =
802 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
803 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
804 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
805 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
806 "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
807 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
808 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
809 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
810 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
811 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
812 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
813 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
814 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
816 static const size_t favicon_length = sizeof(default_favicon_data) - 1;
818 rsp->body = bindup(default_favicon_data, favicon_length);
819 rsp->content_length = favicon_length;
821 if (rsp->body == NULL)
823 return JB_ERR_MEMORY;
826 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
828 return JB_ERR_MEMORY;
838 /*********************************************************************
840 * Function : cgi_send_error_favicon
842 * Description : CGI function that sends the favicon for error pages.
845 * 1 : csp = Current client state (buffers, headers, etc...)
846 * 2 : rsp = http_response data structure for output
847 * 3 : parameters = map of cgi parameters
849 * CGI Parameters : None
851 * Returns : JB_ERR_OK on success
852 * JB_ERR_MEMORY on out-of-memory error.
854 *********************************************************************/
855 jb_err cgi_send_error_favicon(struct client_state *csp,
856 struct http_response *rsp,
857 const struct map *parameters)
859 static const char error_favicon_data[] =
860 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
861 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
862 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
863 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
864 "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
865 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
866 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
867 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
868 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
869 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
870 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
871 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
872 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
874 static const size_t favicon_length = sizeof(error_favicon_data) - 1;
876 rsp->body = bindup(error_favicon_data, favicon_length);
877 rsp->content_length = favicon_length;
879 if (rsp->body == NULL)
881 return JB_ERR_MEMORY;
884 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
886 return JB_ERR_MEMORY;
896 /*********************************************************************
898 * Function : cgi_send_stylesheet
900 * Description : CGI function that sends a css stylesheet found
901 * in the cgi-style.css template
904 * 1 : csp = Current client state (buffers, headers, etc...)
905 * 2 : rsp = http_response data structure for output
906 * 3 : parameters = map of cgi parameters
908 * CGI Parameters : None
910 * Returns : JB_ERR_OK on success
911 * JB_ERR_MEMORY on out-of-memory error.
913 *********************************************************************/
914 jb_err cgi_send_stylesheet(struct client_state *csp,
915 struct http_response *rsp,
916 const struct map *parameters)
923 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
925 if (err == JB_ERR_FILE)
928 * No way to tell user; send empty stylesheet
930 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
934 return err; /* JB_ERR_MEMORY */
937 if (enlist(rsp->headers, "Content-Type: text/css"))
939 return JB_ERR_MEMORY;
945 /*********************************************************************
947 * Function : cgi_send_user_manual
949 * Description : CGI function that sends a file in the user
953 * 1 : csp = Current client state (buffers, headers, etc...)
954 * 2 : rsp = http_response data structure for output
955 * 3 : parameters = map of cgi parameters
957 * CGI Parameters : file=name.html, the name of the HTML file
958 * (relative to user-manual from config)
960 * Returns : JB_ERR_OK on success
961 * JB_ERR_MEMORY on out-of-memory error.
963 *********************************************************************/
964 jb_err cgi_send_user_manual(struct client_state *csp,
965 struct http_response *rsp,
966 const struct map *parameters)
968 const char * filename;
970 jb_err err = JB_ERR_OK;
977 if (!parameters->first)
979 /* requested http://p.p/user-manual (without trailing slash) */
980 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
983 get_string_param(parameters, "file", &filename);
984 /* Check paramter for hack attempts */
985 if (filename && strchr(filename, '/'))
987 return JB_ERR_CGI_PARAMS;
989 if (filename && strstr(filename, ".."))
991 return JB_ERR_CGI_PARAMS;
994 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
995 if (full_path == NULL)
997 return JB_ERR_MEMORY;
1000 err = load_file(full_path, &rsp->body, &rsp->content_length);
1001 if (JB_ERR_OK != err)
1003 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1004 if (JB_ERR_FILE == err)
1006 err = cgi_error_no_template(csp, rsp, full_path);
1013 /* Guess correct Content-Type based on the filename's ending */
1016 length = strlen(filename);
1022 if((length>=4) && !strcmp(&filename[length-4], ".css"))
1024 err = enlist(rsp->headers, "Content-Type: text/css");
1026 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
1028 err = enlist(rsp->headers, "Content-Type: image/jpeg");
1032 err = enlist(rsp->headers, "Content-Type: text/html");
1039 /*********************************************************************
1041 * Function : cgi_show_version
1043 * Description : CGI function that returns a a web page describing the
1044 * file versions of Privoxy.
1047 * 1 : csp = Current client state (buffers, headers, etc...)
1048 * 2 : rsp = http_response data structure for output
1049 * 3 : parameters = map of cgi parameters
1051 * CGI Parameters : none
1053 * Returns : JB_ERR_OK on success
1054 * JB_ERR_MEMORY on out-of-memory error.
1056 *********************************************************************/
1057 jb_err cgi_show_version(struct client_state *csp,
1058 struct http_response *rsp,
1059 const struct map *parameters)
1061 struct map *exports;
1067 if (NULL == (exports = default_exports(csp, "show-version")))
1069 return JB_ERR_MEMORY;
1072 if (map(exports, "sourceversions", 1, show_rcs(), 0))
1075 return JB_ERR_MEMORY;
1078 return template_fill_for_cgi(csp, "show-version", exports, rsp);
1082 /*********************************************************************
1084 * Function : cgi_show_status
1086 * Description : CGI function that returns a web page describing the
1087 * current status of Privoxy.
1090 * 1 : csp = Current client state (buffers, headers, etc...)
1091 * 2 : rsp = http_response data structure for output
1092 * 3 : parameters = map of cgi parameters
1095 * file : Which file to show. Only first letter is checked,
1100 * Default is to show menu and other information.
1102 * Returns : JB_ERR_OK on success
1103 * JB_ERR_MEMORY on out-of-memory error.
1105 *********************************************************************/
1106 jb_err cgi_show_status(struct client_state *csp,
1107 struct http_response *rsp,
1108 const struct map *parameters)
1114 char buf[BUFFER_SIZE];
1115 #ifdef FEATURE_STATISTICS
1116 float perc_rej; /* Percentage of http requests rejected */
1117 int local_urls_read;
1118 int local_urls_rejected;
1119 #endif /* ndef FEATURE_STATISTICS */
1120 jb_err err = JB_ERR_OK;
1122 struct map *exports;
1128 if ('\0' != *(lookup(parameters, "file")))
1130 return cgi_show_file(csp, rsp, parameters);
1133 if (NULL == (exports = default_exports(csp, "show-status")))
1135 return JB_ERR_MEMORY;
1139 for (j = 0; (s != NULL) && (j < Argc); j++)
1141 if (!err) err = string_join (&s, html_encode(Argv[j]));
1142 if (!err) err = string_append(&s, " ");
1144 if (!err) err = map(exports, "invocation", 1, s, 0);
1146 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1147 if (!err) err = show_defines(exports);
1152 return JB_ERR_MEMORY;
1155 #ifdef FEATURE_STATISTICS
1156 local_urls_read = urls_read;
1157 local_urls_rejected = urls_rejected;
1160 * Need to alter the stats not to include the fetch of this
1163 * Can't do following thread safely! doh!
1166 * urls_rejected--; * This will be incremented subsequently *
1169 if (local_urls_read == 0)
1171 if (!err) err = map_block_killer(exports, "have-stats");
1175 if (!err) err = map_block_killer(exports, "have-no-stats");
1177 perc_rej = (float)local_urls_rejected * 100.0F /
1178 (float)local_urls_read;
1180 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1181 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1183 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1184 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1186 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1187 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1190 #else /* ndef FEATURE_STATISTICS */
1191 err = err || map_block_killer(exports, "statistics");
1192 #endif /* ndef FEATURE_STATISTICS */
1195 * List all action files in use, together with view and edit links,
1196 * except for standard.action, which should only be viewable. (Not
1197 * enforced in the editor itself)
1198 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1201 for (i = 0; i < MAX_AF_FILES; i++)
1203 if (csp->actions_list[i] != NULL)
1205 if (!err) err = string_append(&s, "<tr><td>");
1206 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1207 snprintf(buf, sizeof(buf),
1208 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1209 if (!err) err = string_append(&s, buf);
1211 #ifdef FEATURE_CGI_EDIT_ACTIONS
1212 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1213 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
1214 && (NULL != csp->config->actions_file_short[i]))
1217 if (access(csp->config->actions_file[i], W_OK) == 0)
1219 #endif /* def HAVE_ACCESS */
1220 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%d\">Edit</a>", i);
1221 if (!err) err = string_append(&s, buf);
1226 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
1228 #endif /* def HAVE_ACCESS */
1232 if (!err) err = string_append(&s, "</td></tr>\n");
1237 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1241 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1245 * List all re_filterfiles in use, together with view options.
1246 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1249 for (i = 0; i < MAX_AF_FILES; i++)
1251 if (csp->rlist[i] != NULL)
1253 if (!err) err = string_append(&s, "<tr><td>");
1254 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1256 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1257 if (!err) err = string_append(&s, buf);
1258 if (!err) err = string_append(&s, "</td></tr>\n");
1263 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1267 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1268 if (!err) err = map_block_killer(exports, "have-filterfile");
1271 #ifdef FEATURE_TRUST
1274 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1278 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1279 if (!err) err = map_block_killer(exports, "have-trustfile");
1282 if (!err) err = map_block_killer(exports, "trust-support");
1283 #endif /* ndef FEATURE_TRUST */
1285 #ifdef FEATURE_CGI_EDIT_ACTIONS
1286 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1288 err = map_block_killer(exports, "cgi-editor-is-disabled");
1290 #endif /* ndef CGI_EDIT_ACTIONS */
1295 return JB_ERR_MEMORY;
1298 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1302 /*********************************************************************
1304 * Function : cgi_show_url_info
1306 * Description : CGI function that determines and shows which actions
1307 * Privoxy will perform for a given url, and which
1308 * matches starting from the defaults have lead to that.
1311 * 1 : csp = Current client state (buffers, headers, etc...)
1312 * 2 : rsp = http_response data structure for output
1313 * 3 : parameters = map of cgi parameters
1316 * url : The url whose actions are to be determined.
1317 * If url is unset, the url-given conditional will be
1318 * set, so that all but the form can be suppressed in
1321 * Returns : JB_ERR_OK on success
1322 * JB_ERR_MEMORY on out-of-memory error.
1324 *********************************************************************/
1325 jb_err cgi_show_url_info(struct client_state *csp,
1326 struct http_response *rsp,
1327 const struct map *parameters)
1330 struct map *exports;
1337 if (NULL == (exports = default_exports(csp, "show-url-info")))
1339 return JB_ERR_MEMORY;
1343 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1345 url_param = strdup(lookup(parameters, "url"));
1346 if (url_param == NULL)
1349 return JB_ERR_MEMORY;
1354 * Handle prefixes. 4 possibilities:
1355 * 1) "http://" or "https://" prefix present and followed by URL - OK
1356 * 2) Only the "http://" or "https://" part is present, no URL - change
1357 * to empty string so it will be detected later as "no URL".
1358 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1360 * 4) Parameter not specified or is empty string - let this fall through
1361 * for now, next block of code will handle it.
1363 if (0 == strncmp(url_param, "http://", 7))
1365 if (url_param[7] == '\0')
1368 * Empty URL (just prefix).
1369 * Make it totally empty so it's caught by the next if()
1371 url_param[0] = '\0';
1374 else if (0 == strncmp(url_param, "https://", 8))
1376 if (url_param[8] == '\0')
1379 * Empty URL (just prefix).
1380 * Make it totally empty so it's caught by the next if()
1382 url_param[0] = '\0';
1385 else if (url_param[0] != '\0')
1388 * Unknown prefix - assume http://
1390 const size_t url_param_prefixed_size = 7 + 1 + strlen(url_param);
1391 char * url_param_prefixed = malloc(url_param_prefixed_size);
1392 if (NULL == url_param_prefixed)
1396 return JB_ERR_MEMORY;
1398 strlcpy(url_param_prefixed, "http://", url_param_prefixed_size);
1399 strlcat(url_param_prefixed, url_param, url_param_prefixed_size);
1401 url_param = url_param_prefixed;
1405 * Hide "toggle off" warning if Privoxy is toggled on.
1408 #ifdef FEATURE_TOGGLE
1409 (global_toggle_state == 1) &&
1410 #endif /* def FEATURE_TOGGLE */
1411 map_block_killer(exports, "privoxy-is-toggled-off")
1415 return JB_ERR_MEMORY;
1418 if (url_param[0] == '\0')
1420 /* URL paramater not specified, display query form only. */
1422 if (map_block_killer(exports, "url-given")
1423 || map(exports, "url", 1, "", 1))
1426 return JB_ERR_MEMORY;
1431 /* Given a URL, so query it. */
1436 struct file_list *fl;
1437 struct url_actions *b;
1438 struct http_request url_to_query[1];
1439 struct current_action_spec action[1];
1442 if (map(exports, "url", 1, html_encode(url_param), 0))
1446 return JB_ERR_MEMORY;
1449 init_current_action(action);
1451 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1453 free_current_action(action);
1456 return JB_ERR_MEMORY;
1459 err = parse_http_url(url_param, url_to_query, csp);
1463 if (err == JB_ERR_MEMORY)
1465 free_http_request(url_to_query);
1466 free_current_action(action);
1468 return JB_ERR_MEMORY;
1474 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1475 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1476 if (!err) err = map_block_killer(exports, "valid-url");
1478 free_current_action(action);
1479 free_http_request(url_to_query);
1484 return JB_ERR_MEMORY;
1487 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1491 * We have a warning about SSL paths. Hide it for unencrypted sites.
1493 if (!url_to_query->ssl)
1495 if (map_block_killer(exports, "https"))
1497 free_current_action(action);
1499 free_http_request(url_to_query);
1500 return JB_ERR_MEMORY;
1504 matches = strdup("<table summary=\"\" class=\"transparent\">");
1506 for (i = 0; i < MAX_AF_FILES; i++)
1508 if (NULL == csp->config->actions_file_short[i]
1509 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1513 if ((fl = csp->actions_list[i]) != NULL)
1515 if ((b = fl->f) != NULL)
1517 /* FIXME: Hardcoded HTML! */
1518 string_append(&matches, "<tr><th>In file: ");
1519 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1520 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1521 string_append(&matches, buf);
1522 string_append(&matches, "View</a>");
1523 #ifdef FEATURE_CGI_EDIT_ACTIONS
1524 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1527 if (access(csp->config->actions_file[i], W_OK) == 0)
1529 #endif /* def HAVE_ACCESS */
1530 snprintf(buf, sizeof(buf),
1531 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1532 string_append(&matches, buf);
1533 string_append(&matches, "Edit</a>");
1538 string_append(&matches, " <strong>No write access.</strong>");
1540 #endif /* def HAVE_ACCESS */
1542 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1544 string_append(&matches, "</th></tr>\n");
1551 for (; (b != NULL) && (matches != NULL); b = b->next)
1553 if (url_match(b->url, url_to_query))
1555 string_append(&matches, "<tr><td>{");
1556 string_join (&matches, actions_to_html(csp, b->action));
1557 string_append(&matches, " }<br>\n<code>");
1558 string_join (&matches, html_encode(b->url->spec));
1559 string_append(&matches, "</code></td></tr>\n");
1561 if (merge_current_action(action, b->action))
1564 free_http_request(url_to_query);
1565 free_current_action(action);
1567 return JB_ERR_MEMORY;
1575 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1578 string_append(&matches, "</table>\n");
1581 * XXX: Kludge to make sure the "Forward settings" section
1582 * shows what forward-override{} would do with the requested URL.
1583 * No one really cares how the CGI request would be forwarded
1584 * if it wasn't intercepted as CGI request in the first place.
1586 * From here on the action bitmask will no longer reflect
1587 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1588 * but luckily it's no longer required later on anyway.
1590 free_current_action(csp->action);
1591 get_url_actions(csp, url_to_query);
1594 * Fill in forwarding settings.
1596 * The possibilities are:
1598 * - http forwarding only
1599 * - socks4(a) forwarding only
1600 * - socks4(a) and http forwarding.
1602 * XXX: Parts of this code could be reused for the
1603 * "forwarding-failed" template which currently doesn't
1604 * display the proxy port and an eventual second forwarder.
1607 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1609 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1611 if (!err) err = map_block_killer(exports, "socks-forwarder");
1612 if (!err) err = map_block_killer(exports, "http-forwarder");
1616 char port[10]; /* We save proxy ports as int but need a string here */
1618 if (!err) err = map_block_killer(exports, "no-forwarder");
1620 if (fwd->gateway_host != NULL)
1622 char *socks_type = NULL;
1627 socks_type = "socks4";
1630 socks_type = "socks4a";
1633 socks_type = "socks5";
1636 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1639 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1640 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1641 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1642 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1646 if (!err) err = map_block_killer(exports, "socks-forwarder");
1649 if (fwd->forward_host != NULL)
1651 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1652 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1653 if (!err) err = map(exports, "forward-port", 1, port, 1);
1657 if (!err) err = map_block_killer(exports, "http-forwarder");
1662 free_http_request(url_to_query);
1664 if (err || matches == NULL)
1666 free_current_action(action);
1668 return JB_ERR_MEMORY;
1671 #ifdef FEATURE_CGI_EDIT_ACTIONS
1672 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1674 err = map_block_killer(exports, "cgi-editor-is-disabled");
1676 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1679 * If zlib support is available, if no content filters
1680 * are enabled or if the prevent-compression action is enabled,
1681 * suppress the "compression could prevent filtering" warning.
1683 * XXX: Change content_filters_enabled()'s prototype so we can
1686 #ifndef FEATURE_ZLIB
1687 if ((list_is_empty(action->multi[ACTION_MULTI_FILTER])
1688 && !(action->flags & ACTION_DEANIMATE))
1689 || (action->flags & ACTION_NO_COMPRESSION))
1692 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1695 if (err || map(exports, "matches", 1, matches , 0))
1697 free_current_action(action);
1699 return JB_ERR_MEMORY;
1702 s = current_action_to_html(csp, action);
1704 free_current_action(action);
1706 if (map(exports, "final", 1, s, 0))
1709 return JB_ERR_MEMORY;
1713 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1717 /*********************************************************************
1719 * Function : cgi_robots_txt
1721 * Description : CGI function to return "/robots.txt".
1724 * 1 : csp = Current client state (buffers, headers, etc...)
1725 * 2 : rsp = http_response data structure for output
1726 * 3 : parameters = map of cgi parameters
1728 * CGI Parameters : None
1730 * Returns : JB_ERR_OK on success
1731 * JB_ERR_MEMORY on out-of-memory error.
1733 *********************************************************************/
1734 jb_err cgi_robots_txt(struct client_state *csp,
1735 struct http_response *rsp,
1736 const struct map *parameters)
1742 "# This is the Privoxy control interface.\n"
1743 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1749 if (rsp->body == NULL)
1751 return JB_ERR_MEMORY;
1754 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1758 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1759 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1761 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1765 /*********************************************************************
1767 * Function : show_defines
1769 * Description : Add to a map the state od all conditional #defines
1770 * used when building
1773 * 1 : exports = map to extend
1775 * Returns : JB_ERR_OK on success
1776 * JB_ERR_MEMORY on out-of-memory error.
1778 *********************************************************************/
1779 static jb_err show_defines(struct map *exports)
1781 jb_err err = JB_ERR_OK;
1784 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1785 #else /* ifndef FEATURE_ACL */
1786 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1787 #endif /* ndef FEATURE_ACL */
1789 #ifdef FEATURE_CGI_EDIT_ACTIONS
1790 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1791 #else /* ifndef FEATURE_COOKIE_JAR */
1792 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1793 #endif /* ndef FEATURE_COOKIE_JAR */
1795 #ifdef FEATURE_COOKIE_JAR
1796 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1797 #else /* ifndef FEATURE_COOKIE_JAR */
1798 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1799 #endif /* ndef FEATURE_COOKIE_JAR */
1801 #ifdef FEATURE_FAST_REDIRECTS
1802 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1803 #else /* ifndef FEATURE_FAST_REDIRECTS */
1804 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1805 #endif /* ndef FEATURE_FAST_REDIRECTS */
1807 #ifdef FEATURE_FORCE_LOAD
1808 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1809 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1810 #else /* ifndef FEATURE_FORCE_LOAD */
1811 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1812 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1813 #endif /* ndef FEATURE_FORCE_LOAD */
1815 #ifdef FEATURE_GRACEFUL_TERMINATION
1816 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1817 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1818 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1819 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1821 #ifdef FEATURE_IMAGE_BLOCKING
1822 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1823 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1824 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1825 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1827 #ifdef FEATURE_IMAGE_DETECT_MSIE
1828 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1829 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1830 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1831 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1833 #ifdef FEATURE_NO_GIFS
1834 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1835 #else /* ifndef FEATURE_NO_GIFS */
1836 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1837 #endif /* ndef FEATURE_NO_GIFS */
1839 #ifdef FEATURE_PTHREAD
1840 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1841 #else /* ifndef FEATURE_PTHREAD */
1842 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1843 #endif /* ndef FEATURE_PTHREAD */
1845 #ifdef FEATURE_STATISTICS
1846 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1847 #else /* ifndef FEATURE_STATISTICS */
1848 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1849 #endif /* ndef FEATURE_STATISTICS */
1851 #ifdef FEATURE_TOGGLE
1852 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1853 #else /* ifndef FEATURE_TOGGLE */
1854 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1855 #endif /* ndef FEATURE_TOGGLE */
1857 #ifdef FEATURE_TRUST
1858 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1859 #else /* ifndef FEATURE_TRUST */
1860 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1861 #endif /* ndef FEATURE_TRUST */
1864 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1865 #else /* ifndef FEATURE_ZLIB */
1866 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1867 #endif /* ndef FEATURE_ZLIB */
1870 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1871 #else /* ifndef STATIC_PCRE */
1872 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1873 #endif /* ndef STATIC_PCRE */
1876 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1877 #else /* ifndef STATIC_PCRS */
1878 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1879 #endif /* ndef STATIC_PCRS */
1885 /*********************************************************************
1887 * Function : show_rcs
1889 * Description : Create a string with the rcs info for all sourcefiles
1893 * Returns : A string, or NULL on out-of-memory.
1895 *********************************************************************/
1896 static char *show_rcs(void)
1898 char *result = strdup("");
1899 char buf[BUFFER_SIZE];
1901 /* Instead of including *all* dot h's in the project (thus creating a
1902 * tremendous amount of dependencies), I will concede to declaring them
1903 * as extern's. This forces the developer to add to this list, but oh well.
1906 #define SHOW_RCS(__x) \
1908 extern const char __x[]; \
1909 snprintf(buf, sizeof(buf), " %s\n", __x); \
1910 string_append(&result, buf); \
1913 /* In alphabetical order */
1914 SHOW_RCS(actions_h_rcs)
1915 SHOW_RCS(actions_rcs)
1917 SHOW_RCS(amiga_h_rcs)
1919 #endif /* def AMIGA */
1922 #ifdef FEATURE_CGI_EDIT_ACTIONS
1923 SHOW_RCS(cgiedit_h_rcs)
1924 SHOW_RCS(cgiedit_rcs)
1925 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1926 SHOW_RCS(cgisimple_h_rcs)
1927 SHOW_RCS(cgisimple_rcs)
1929 SHOW_RCS(cygwin_h_rcs)
1931 SHOW_RCS(deanimate_h_rcs)
1932 SHOW_RCS(deanimate_rcs)
1933 SHOW_RCS(encode_h_rcs)
1934 SHOW_RCS(encode_rcs)
1935 SHOW_RCS(errlog_h_rcs)
1936 SHOW_RCS(errlog_rcs)
1937 SHOW_RCS(filters_h_rcs)
1938 SHOW_RCS(filters_rcs)
1939 SHOW_RCS(gateway_h_rcs)
1940 SHOW_RCS(gateway_rcs)
1941 SHOW_RCS(jbsockets_h_rcs)
1942 SHOW_RCS(jbsockets_rcs)
1945 SHOW_RCS(list_h_rcs)
1947 SHOW_RCS(loadcfg_h_rcs)
1948 SHOW_RCS(loadcfg_rcs)
1949 SHOW_RCS(loaders_h_rcs)
1950 SHOW_RCS(loaders_rcs)
1951 SHOW_RCS(miscutil_h_rcs)
1952 SHOW_RCS(miscutil_rcs)
1953 SHOW_RCS(parsers_h_rcs)
1954 SHOW_RCS(parsers_rcs)
1956 SHOW_RCS(pcrs_h_rcs)
1957 SHOW_RCS(project_h_rcs)
1958 SHOW_RCS(ssplit_h_rcs)
1959 SHOW_RCS(ssplit_rcs)
1960 SHOW_RCS(urlmatch_h_rcs)
1961 SHOW_RCS(urlmatch_rcs)
1963 #ifndef _WIN_CONSOLE
1964 SHOW_RCS(w32log_h_rcs)
1965 SHOW_RCS(w32log_rcs)
1966 SHOW_RCS(w32res_h_rcs)
1967 SHOW_RCS(w32taskbar_h_rcs)
1968 SHOW_RCS(w32taskbar_rcs)
1969 #endif /* ndef _WIN_CONSOLE */
1970 SHOW_RCS(win32_h_rcs)
1972 #endif /* def _WIN32 */
1981 /*********************************************************************
1983 * Function : cgi_show_file
1985 * Description : CGI function that shows the content of a
1986 * configuration file.
1989 * 1 : csp = Current client state (buffers, headers, etc...)
1990 * 2 : rsp = http_response data structure for output
1991 * 3 : parameters = map of cgi parameters
1994 * file : Which file to show. Only first letter is checked,
1999 * Default is to show menu and other information.
2001 * Returns : JB_ERR_OK on success
2002 * JB_ERR_MEMORY on out-of-memory error.
2004 *********************************************************************/
2005 static jb_err cgi_show_file(struct client_state *csp,
2006 struct http_response *rsp,
2007 const struct map *parameters)
2010 const char * filename = NULL;
2011 char * file_description = NULL;
2017 switch (*(lookup(parameters, "file")))
2020 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2022 filename = csp->actions_list[i]->filename;
2023 file_description = "Actions File";
2028 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2030 filename = csp->rlist[i]->filename;
2031 file_description = "Filter File";
2035 #ifdef FEATURE_TRUST
2039 filename = csp->tlist->filename;
2040 file_description = "Trust File";
2043 #endif /* def FEATURE_TRUST */
2046 if (NULL != filename)
2048 struct map *exports;
2053 exports = default_exports(csp, "show-status");
2054 if (NULL == exports)
2056 return JB_ERR_MEMORY;
2059 if ( map(exports, "file-description", 1, file_description, 1)
2060 || map(exports, "filepath", 1, html_encode(filename), 0) )
2063 return JB_ERR_MEMORY;
2066 err = load_file(filename, &s, &length);
2067 if (JB_ERR_OK != err)
2069 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2072 return JB_ERR_MEMORY;
2077 s = html_encode_and_free_original(s);
2080 return JB_ERR_MEMORY;
2083 if (map(exports, "contents", 1, s, 0))
2086 return JB_ERR_MEMORY;
2090 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2093 return JB_ERR_CGI_PARAMS;
2097 /*********************************************************************
2099 * Function : load_file
2101 * Description : Loads a file into a buffer.
2104 * 1 : filename = Name of the file to be loaded.
2105 * 2 : buffer = Used to return the file's content.
2106 * 3 : length = Used to return the size of the file.
2108 * Returns : JB_ERR_OK in case of success,
2109 * JB_ERR_FILE in case of ordinary file loading errors
2110 * (fseek() and ftell() errors are fatal)
2111 * JB_ERR_MEMORY in case of out-of-memory.
2113 *********************************************************************/
2114 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2119 fp = fopen(filename, "rb");
2125 /* Get file length */
2126 if (fseek(fp, 0, SEEK_END))
2128 log_error(LOG_LEVEL_FATAL,
2129 "Unexpected erro while fseek()ing to the end of %s: %E",
2135 log_error(LOG_LEVEL_FATAL,
2136 "Unexpected ftell() error while loading %s: %E",
2139 *length = (size_t)ret;
2141 /* Go back to the beginning. */
2142 if (fseek(fp, 0, SEEK_SET))
2144 log_error(LOG_LEVEL_FATAL,
2145 "Unexpected error while fseek()ing to the beginning of %s: %E",
2149 *buffer = (char *)zalloc(*length + 1);
2150 if (NULL == *buffer)
2153 return JB_ERR_MEMORY;
2156 if (!fread(*buffer, *length, 1, fp))
2159 * May happen if the file size changes between fseek() and
2160 * fread(). If it does, we just log it and serve what we got.
2162 log_error(LOG_LEVEL_ERROR,
2163 "Couldn't completely read file %s.", filename);