1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.62 2008/02/01 05:52:40 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-2007 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.62 2008/02/01 05:52:40 fabiankeil
40 * Hide edit buttons on the show-url-info CGI page if enable-edit-action
41 * is disabled. Patch by Lee with additional white space adjustments.
43 * Revision 1.61 2008/01/26 11:13:25 fabiankeil
44 * If enable-edit-actions is disabled, hide the edit buttons and explain why.
46 * Revision 1.60 2007/10/27 13:12:13 fabiankeil
47 * Finish 1.49 and check write access before
48 * showing edit buttons on show-url-info page.
50 * Revision 1.59 2007/10/19 16:42:36 fabiankeil
51 * Plug memory leak I introduced five months ago.
52 * Yay Valgrind and Privoxy-Regression-Test.
54 * Revision 1.58 2007/07/21 12:19:50 fabiankeil
55 * If show-url-info is called with an URL that Privoxy
56 * would reject as invalid, don't show unresolved forwarding
57 * variables, "final matches" or claim the site's secure.
59 * Revision 1.57 2007/06/01 16:53:05 fabiankeil
60 * Adjust cgi_show_url_info() to show what forward-override{}
61 * would do with the requested URL (instead of showing how the
62 * request for the CGI page would be forwarded if it wasn't a
65 * Revision 1.56 2007/05/21 10:50:35 fabiankeil
66 * - Use strlcpy() instead of strcpy().
67 * - Stop treating actions files special. Expect a complete file name
68 * (with or without path) like it's done for the rest of the files.
70 * - Don't rerun sed() in cgi_show_request().
72 * Revision 1.55 2007/04/13 13:36:46 fabiankeil
73 * Reference action files in CGI URLs by id instead
74 * of using the first part of the file name.
75 * Fixes BR 1694250 and BR 1590556.
77 * Revision 1.54 2007/04/09 18:11:35 fabiankeil
78 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
80 * Revision 1.53 2007/04/08 13:21:04 fabiankeil
81 * Reference action files in CGI URLs by id instead
82 * of using the first part of the file name.
83 * Fixes BR 1694250 and BR 1590556.
85 * Revision 1.52 2007/02/13 15:10:26 fabiankeil
86 * Apparently fopen()ing in "binary" mode doesn't require
87 * #ifdefs, it's already done without them in cgiedit.c.
89 * Revision 1.51 2007/02/10 16:55:22 fabiankeil
90 * - Show forwarding settings on the show-url-info page
91 * - Fix some HTML syntax errors.
93 * Revision 1.50 2007/01/23 15:51:17 fabiankeil
94 * Add favicon delivery functions.
96 * Revision 1.49 2007/01/20 16:29:38 fabiankeil
97 * Suppress edit buttons for action files if Privoxy has
98 * no write access. Suggested by Roland in PR 1564026.
100 * Revision 1.48 2007/01/20 15:31:31 fabiankeil
101 * Display warning if show-url-info CGI page
102 * is used while Privoxy is toggled off.
104 * Revision 1.47 2007/01/12 15:07:10 fabiankeil
105 * Use zalloc in cgi_send_user_manual.
107 * Revision 1.46 2007/01/02 12:49:46 fabiankeil
108 * Add FEATURE_ZLIB to the list of conditional
109 * defines at the show-status page.
111 * Revision 1.45 2006/12/28 18:16:41 fabiankeil
112 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
113 * body memory before using it, replaced sprintf calls with snprintf.
115 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
116 * Removed checks whether or not AF_FILES have
117 * data structures associated with them in cgi_show_status.
118 * It doesn't matter as we're only interested in the file names.
120 * For the action files the checks were always true,
121 * but they prevented empty filter files from being
122 * listed. Fixes parts of BR 1619208.
124 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
125 * - Added FEATURE_GRACEFUL_TERMINATION to the
126 * "conditional #defines" section
127 * - Escaped ampersands in generated HTML.
128 * - Renamed re-filter-filename to re-filter-filenames
130 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
131 * Add special treatment for WIN32 to make sure
132 * cgi_send_user_manual opens the files in binary mode.
133 * Fixes BR 1600411 and unbreaks image delivery.
135 * Remove outdated comment.
137 * Revision 1.41 2006/10/09 19:18:28 roro
138 * Redirect http://p.p/user-manual (without trailing slash) to
139 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
141 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
142 * Modified cgi_send_user_manual to serve binary
143 * content without destroying it first. Should also be
144 * faster now. Added ".jpg" check for Content-Type guessing.
146 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
147 * Deliver documents in the user-manual directory
148 * with "Content-Type text/css" if their filename
151 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
152 * Incorporate modified version of Roland Rosenfeld's patch to
153 * optionally access the user-manual via Privoxy. Closes patch 679075.
155 * Formatting changed to Privoxy style, added call to
156 * cgi_error_no_template if the requested file doesn't
157 * exist and modified check whether or not Privoxy itself
158 * should serve the manual. Should work cross-platform now.
160 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
161 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
162 * with what was really the latest development (the v_3_0_branch branch)
164 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
165 * Multiple filter file support
167 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
168 * Undo some damaging memory leak patches
170 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
171 * A few memory leaks plugged (mostly on error paths)
173 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
174 * Another instance of:
175 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
176 * Thanks to Magnus Holmgren for the patch
178 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
179 * - Prevent line wrap beween "View/Edit" link buttons on status page
180 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
182 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
183 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
185 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
186 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
188 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
189 * Applying patch from Andreas as provided by Hal on the list.
190 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
192 * Revision 1.35 2002/05/12 21:44:44 jongfoster
193 * Adding amiga.[ch] revision information, if on an amiga.
195 * Revision 1.34 2002/04/30 12:06:12 oes
196 * Deleted unused code from default_cgi
198 * Revision 1.33 2002/04/30 11:14:52 oes
199 * Made csp the first parameter in *action_to_html
201 * Revision 1.32 2002/04/26 18:29:13 jongfoster
202 * Fixing this Visual C++ warning:
203 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
205 * Revision 1.31 2002/04/26 12:54:36 oes
206 * - Kill obsolete REDIRECT_URL code
207 * - Error handling fixes
208 * - Style sheet related HTML snipplet changes
209 * - cgi_show_url_info:
210 * - Matches now in table, actions on single lines,
212 * - standard.action suppressed
213 * - Buttons to View and Edit AFs
215 * Revision 1.30 2002/04/24 02:18:08 oes
216 * - show-status is now the starting point for editing
217 * the actions files, generate list of all AFs with buttons
218 * for viewing and editing, new look for file list (Jon:
219 * buttons now aligned ;-P ), view mode now supports multiple
220 * AFs, name changes, no view links for unspecified files,
221 * no edit link for standard.action.
223 * - Jon's multiple AF patch: cgi_show_url_info now uses all
224 * AFs and marks the output accordingly
226 * Revision 1.29 2002/04/10 13:38:35 oes
227 * load_template signature changed
229 * Revision 1.28 2002/04/07 15:42:12 jongfoster
230 * Fixing send-banner?type=auto when the image-blocker is
231 * a redirect to send-banner
233 * Revision 1.27 2002/04/05 15:50:48 oes
234 * added send-stylesheet CGI
236 * Revision 1.26 2002/04/04 00:36:36 gliptak
237 * always use pcre for matching
239 * Revision 1.25 2002/04/03 22:28:03 gliptak
240 * Removed references to gnu_regex
242 * Revision 1.24 2002/04/02 16:12:47 oes
243 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
245 * Revision 1.23 2002/03/26 22:29:54 swa
246 * we have a new homepage!
248 * Revision 1.22 2002/03/24 16:18:15 jongfoster
251 * Revision 1.21 2002/03/24 15:23:33 jongfoster
254 * Revision 1.20 2002/03/24 13:25:43 swa
255 * name change related issues
257 * Revision 1.19 2002/03/16 23:54:06 jongfoster
258 * Adding graceful termination feature, to help look for memory leaks.
259 * If you enable this (which, by design, has to be done by hand
260 * editing config.h) and then go to http://i.j.b/die, then the program
261 * will exit cleanly after the *next* request. It should free all the
262 * memory that was used.
264 * Revision 1.18 2002/03/12 01:44:49 oes
265 * Changed default for "blocked" image from jb logo to checkboard pattern
267 * Revision 1.17 2002/03/08 16:43:18 oes
268 * Added choice beween GIF and PNG built-in images
270 * Revision 1.16 2002/03/07 03:48:38 oes
271 * - Changed built-in images from GIF to PNG
272 * (with regard to Unisys patent issue)
273 * - Added a 4x4 pattern PNG which is less intrusive
274 * than the logo but also clearly marks the deleted banners
276 * Revision 1.15 2002/03/06 22:54:35 jongfoster
277 * Automated function-comment nitpicking.
279 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
280 * Clean up a little CRLF unpleasantness that suddenly appeared
282 * Revision 1.13 2002/02/21 00:10:37 jongfoster
283 * Adding send-banner?type=auto option
285 * Revision 1.12 2002/01/23 01:03:32 jongfoster
286 * Fixing gcc [CygWin] compiler warnings
288 * Revision 1.11 2002/01/23 00:01:04 jongfoster
289 * Adding cgi_transparent_gif() for http://i.j.b/t
290 * Adding missing html_encode() to many CGI functions.
291 * Adding urlmatch.[ch] to http://i.j.b/show-version
293 * Revision 1.10 2002/01/17 21:10:37 jongfoster
294 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
295 * Also fixing a problem in the same function with improperly quoted URLs
296 * in output HTML, and adding code to handle https:// URLs correctly.
298 * Revision 1.9 2001/11/30 23:09:15 jongfoster
299 * Now reports on FEATURE_CGI_EDIT_ACTIONS
300 * Removing FEATURE_DENY_GZIP from template
302 * Revision 1.8 2001/11/13 00:14:07 jongfoster
303 * Fixing stupid bug now I've figured out what || means.
304 * (It always returns 0 or 1, not one of it's paramaters.)
306 * Revision 1.7 2001/10/23 21:48:19 jongfoster
307 * Cleaning up error handling in CGI functions - they now send back
308 * a HTML error page and should never cause a FATAL error. (Fixes one
309 * potential source of "denial of service" attacks).
311 * CGI actions file editor that works and is actually useful.
313 * Ability to toggle JunkBuster remotely using a CGI call.
315 * You can turn off both the above features in the main configuration
316 * file, e.g. if you are running a multi-user proxy.
318 * Revision 1.6 2001/10/14 22:00:32 jongfoster
319 * Adding support for a 404 error when an invalid CGI page is requested.
321 * Revision 1.5 2001/10/07 15:30:41 oes
322 * Removed FEATURE_DENY_GZIP
324 * Revision 1.4 2001/10/02 15:31:12 oes
325 * Introduced show-request cgi
327 * Revision 1.3 2001/09/22 16:34:44 jongfoster
328 * Removing unneeded #includes
330 * Revision 1.2 2001/09/19 18:01:11 oes
331 * Fixed comments; cosmetics
333 * Revision 1.1 2001/09/16 17:08:54 jongfoster
334 * Moving simple CGI functions from cgi.c to new file cgisimple.c
337 **********************************************************************/
343 #include <sys/types.h>
351 #endif /* def HAVE_ACCESS */
355 #include "cgisimple.h"
361 #include "miscutil.h"
364 #include "urlmatch.h"
367 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
370 static char *show_rcs(void);
371 static jb_err show_defines(struct map *exports);
374 * 16x16 ico blobs for favicon delivery functions.
376 const char default_favicon_data[] =
377 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
378 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
379 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
380 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
381 "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
382 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
383 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
384 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
385 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
386 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
387 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
388 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
389 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
391 const char error_favicon_data[] =
392 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
393 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
394 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
395 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
396 "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
397 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
398 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
399 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
400 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
401 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
402 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
403 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
404 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
406 const size_t default_favicon_length = sizeof(default_favicon_data) - 1;
407 const size_t error_favicon_length = sizeof(error_favicon_data) - 1;
409 /*********************************************************************
411 * Function : cgi_default
413 * Description : CGI function that is called for the CGI_SITE_1_HOST
414 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
415 * Boring - only exports the default exports.
418 * 1 : csp = Current client state (buffers, headers, etc...)
419 * 2 : rsp = http_response data structure for output
420 * 3 : parameters = map of cgi parameters
422 * CGI Parameters : none
424 * Returns : JB_ERR_OK on success
425 * JB_ERR_MEMORY on out-of-memory
427 *********************************************************************/
428 jb_err cgi_default(struct client_state *csp,
429 struct http_response *rsp,
430 const struct map *parameters)
437 if (NULL == (exports = default_exports(csp, "")))
439 return JB_ERR_MEMORY;
442 return template_fill_for_cgi(csp, "default", exports, rsp);
446 /*********************************************************************
448 * Function : cgi_error_404
450 * Description : CGI function that is called if an unknown action was
454 * 1 : csp = Current client state (buffers, headers, etc...)
455 * 2 : rsp = http_response data structure for output
456 * 3 : parameters = map of cgi parameters
458 * CGI Parameters : none
460 * Returns : JB_ERR_OK on success
461 * JB_ERR_MEMORY on out-of-memory error.
463 *********************************************************************/
464 jb_err cgi_error_404(struct client_state *csp,
465 struct http_response *rsp,
466 const struct map *parameters)
474 if (NULL == (exports = default_exports(csp, NULL)))
476 return JB_ERR_MEMORY;
479 rsp->status = strdup("404 Privoxy configuration page not found");
480 if (rsp->status == NULL)
483 return JB_ERR_MEMORY;
486 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
490 #ifdef FEATURE_GRACEFUL_TERMINATION
491 /*********************************************************************
495 * Description : CGI function to shut down Privoxy.
496 * NOTE: Turning this on in a production build
497 * would be a BAD idea. An EXTREMELY BAD idea.
498 * In short, don't do it.
501 * 1 : csp = Current client state (buffers, headers, etc...)
502 * 2 : rsp = http_response data structure for output
503 * 3 : parameters = map of cgi parameters
505 * CGI Parameters : none
507 * Returns : JB_ERR_OK on success
508 * JB_ERR_MEMORY on out-of-memory error.
510 *********************************************************************/
511 jb_err cgi_die (struct client_state *csp,
512 struct http_response *rsp,
513 const struct map *parameters)
523 * I don't really care what gets sent back to the browser.
524 * Take the easy option - "out of memory" page.
527 return JB_ERR_MEMORY;
529 #endif /* def FEATURE_GRACEFUL_TERMINATION */
532 /*********************************************************************
534 * Function : cgi_show_request
536 * Description : Show the client's request and what sed() would have
540 * 1 : csp = Current client state (buffers, headers, etc...)
541 * 2 : rsp = http_response data structure for output
542 * 3 : parameters = map of cgi parameters
544 * CGI Parameters : none
546 * Returns : JB_ERR_OK on success
547 * JB_ERR_MEMORY on out-of-memory error.
549 *********************************************************************/
550 jb_err cgi_show_request(struct client_state *csp,
551 struct http_response *rsp,
552 const struct map *parameters)
561 if (NULL == (exports = default_exports(csp, "show-request")))
563 return JB_ERR_MEMORY;
567 * Repair the damage done to the IOB by get_header()
569 for (p = csp->iob->buf; p < csp->iob->eod; p++)
571 if (*p == '\0') *p = '\n';
575 * Export the original client's request and the one we would
576 * be sending to the server if this wasn't a CGI call
579 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
582 return JB_ERR_MEMORY;
585 if (map(exports, "processed-request", 1,
586 html_encode_and_free_original(list_to_text(csp->headers)), 0))
589 return JB_ERR_MEMORY;
592 return template_fill_for_cgi(csp, "show-request", exports, rsp);
596 /*********************************************************************
598 * Function : cgi_send_banner
600 * Description : CGI function that returns a banner.
603 * 1 : csp = Current client state (buffers, headers, etc...)
604 * 2 : rsp = http_response data structure for output
605 * 3 : parameters = map of cgi parameters
608 * type : Selects the type of banner between "trans", "logo",
609 * and "auto". Defaults to "logo" if absent or invalid.
610 * "auto" means to select as if we were image-blocking.
611 * (Only the first character really counts; b and t are
614 * Returns : JB_ERR_OK on success
615 * JB_ERR_MEMORY on out-of-memory error.
617 *********************************************************************/
618 jb_err cgi_send_banner(struct client_state *csp,
619 struct http_response *rsp,
620 const struct map *parameters)
622 char imagetype = lookup(parameters, "type")[0];
625 * If type is auto, then determine the right thing
626 * to do from the set-image-blocker action
628 if (imagetype == 'a')
635 #ifdef FEATURE_IMAGE_BLOCKING
636 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
638 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
639 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
640 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
644 /* Use default - nothing to do here. */
646 else if (0 == strcmpic(p, "blank"))
650 else if (0 == strcmpic(p, "pattern"))
656 * If the action is to call this CGI, determine
659 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
661 imagetype = p[sizeof(prefix1) - 1];
663 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
665 imagetype = p[sizeof(prefix2) - 1];
669 * Everything else must (should) be a URL to
677 #endif /* def FEATURE_IMAGE_BLOCKING */
681 * Now imagetype is either the non-auto type we were called with,
682 * or it was auto and has since been determined. In any case, we
683 * can proceed to actually answering the request by sending a redirect
684 * or an image as appropriate:
686 if (imagetype == 'r')
688 rsp->status = strdup("302 Local Redirect from Privoxy");
689 if (rsp->status == NULL)
691 return JB_ERR_MEMORY;
693 if (enlist_unique_header(rsp->headers, "Location",
694 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
696 return JB_ERR_MEMORY;
701 if ((imagetype == 'b') || (imagetype == 't'))
703 rsp->body = bindup(image_blank_data, image_blank_length);
704 rsp->content_length = image_blank_length;
708 rsp->body = bindup(image_pattern_data, image_pattern_length);
709 rsp->content_length = image_pattern_length;
712 if (rsp->body == NULL)
714 return JB_ERR_MEMORY;
716 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
718 return JB_ERR_MEMORY;
729 /*********************************************************************
731 * Function : cgi_transparent_image
733 * Description : CGI function that sends a 1x1 transparent image.
736 * 1 : csp = Current client state (buffers, headers, etc...)
737 * 2 : rsp = http_response data structure for output
738 * 3 : parameters = map of cgi parameters
740 * CGI Parameters : None
742 * Returns : JB_ERR_OK on success
743 * JB_ERR_MEMORY on out-of-memory error.
745 *********************************************************************/
746 jb_err cgi_transparent_image(struct client_state *csp,
747 struct http_response *rsp,
748 const struct map *parameters)
750 rsp->body = bindup(image_blank_data, image_blank_length);
751 rsp->content_length = image_blank_length;
753 if (rsp->body == NULL)
755 return JB_ERR_MEMORY;
758 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
760 return JB_ERR_MEMORY;
770 /*********************************************************************
772 * Function : cgi_send_default_favicon
774 * Description : CGI function that sends the standard favicon.
777 * 1 : csp = Current client state (buffers, headers, etc...)
778 * 2 : rsp = http_response data structure for output
779 * 3 : parameters = map of cgi parameters
781 * CGI Parameters : None
783 * Returns : JB_ERR_OK on success
784 * JB_ERR_MEMORY on out-of-memory error.
786 *********************************************************************/
787 jb_err cgi_send_default_favicon(struct client_state *csp,
788 struct http_response *rsp,
789 const struct map *parameters)
791 rsp->body = bindup(default_favicon_data, default_favicon_length);
792 rsp->content_length = default_favicon_length;
794 if (rsp->body == NULL)
796 return JB_ERR_MEMORY;
799 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
801 return JB_ERR_MEMORY;
811 /*********************************************************************
813 * Function : cgi_send_error_favicon
815 * Description : CGI function that sends the favicon for error pages.
818 * 1 : csp = Current client state (buffers, headers, etc...)
819 * 2 : rsp = http_response data structure for output
820 * 3 : parameters = map of cgi parameters
822 * CGI Parameters : None
824 * Returns : JB_ERR_OK on success
825 * JB_ERR_MEMORY on out-of-memory error.
827 *********************************************************************/
828 jb_err cgi_send_error_favicon(struct client_state *csp,
829 struct http_response *rsp,
830 const struct map *parameters)
832 rsp->body = bindup(error_favicon_data, error_favicon_length);
833 rsp->content_length = error_favicon_length;
835 if (rsp->body == NULL)
837 return JB_ERR_MEMORY;
840 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
842 return JB_ERR_MEMORY;
852 /*********************************************************************
854 * Function : cgi_send_stylesheet
856 * Description : CGI function that sends a css stylesheet found
857 * in the cgi-style.css template
860 * 1 : csp = Current client state (buffers, headers, etc...)
861 * 2 : rsp = http_response data structure for output
862 * 3 : parameters = map of cgi parameters
864 * CGI Parameters : None
866 * Returns : JB_ERR_OK on success
867 * JB_ERR_MEMORY on out-of-memory error.
869 *********************************************************************/
870 jb_err cgi_send_stylesheet(struct client_state *csp,
871 struct http_response *rsp,
872 const struct map *parameters)
879 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
881 if (err == JB_ERR_FILE)
884 * No way to tell user; send empty stylesheet
886 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
890 return err; /* JB_ERR_MEMORY */
893 if (enlist(rsp->headers, "Content-Type: text/css"))
895 return JB_ERR_MEMORY;
901 /*********************************************************************
903 * Function : cgi_send_user_manual
905 * Description : CGI function that sends a file in the user
909 * 1 : csp = Current client state (buffers, headers, etc...)
910 * 2 : rsp = http_response data structure for output
911 * 3 : parameters = map of cgi parameters
913 * CGI Parameters : file=name.html, the name of the HTML file
914 * (relative to user-manual from config)
916 * Returns : JB_ERR_OK on success
917 * JB_ERR_MEMORY on out-of-memory error.
919 *********************************************************************/
920 jb_err cgi_send_user_manual(struct client_state *csp,
921 struct http_response *rsp,
922 const struct map *parameters)
924 const char * filename;
927 jb_err err = JB_ERR_OK;
934 if (!parameters->first)
936 /* requested http://p.p/user-manual (without trailing slash) */
937 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
940 get_string_param(parameters, "file", &filename);
941 /* Check paramter for hack attempts */
942 if (filename && strchr(filename, '/'))
944 return JB_ERR_CGI_PARAMS;
946 if (filename && strstr(filename, ".."))
948 return JB_ERR_CGI_PARAMS;
951 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
952 if (full_path == NULL)
954 return JB_ERR_MEMORY;
957 /* Open user-manual file */
958 if (NULL == (fp = fopen(full_path, "rb")))
960 log_error(LOG_LEVEL_ERROR, "Cannot open user-manual file %s: %E", full_path);
961 err = cgi_error_no_template(csp, rsp, full_path);
966 /* Get file length */
967 fseek(fp, 0, SEEK_END);
968 length = (size_t)ftell(fp);
969 fseek(fp, 0, SEEK_SET);
971 /* Allocate memory and load the file directly into the body */
972 rsp->body = (char *)zalloc(length+1);
977 return JB_ERR_MEMORY;
979 if (!fread(rsp->body, length, 1, fp))
982 * May happen if the file size changes between fseek() and fread().
983 * If it does, we just log it and serve what we got.
985 log_error(LOG_LEVEL_ERROR, "Couldn't completely read user-manual file %s.", full_path);
990 rsp->content_length = length;
992 /* Guess correct Content-Type based on the filename's ending */
995 length = strlen(filename);
1001 if((length>=4) && !strcmp(&filename[length-4], ".css"))
1003 err = enlist(rsp->headers, "Content-Type: text/css");
1005 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
1007 err = enlist(rsp->headers, "Content-Type: image/jpeg");
1011 err = enlist(rsp->headers, "Content-Type: text/html");
1018 /*********************************************************************
1020 * Function : cgi_show_version
1022 * Description : CGI function that returns a a web page describing the
1023 * file versions of Privoxy.
1026 * 1 : csp = Current client state (buffers, headers, etc...)
1027 * 2 : rsp = http_response data structure for output
1028 * 3 : parameters = map of cgi parameters
1030 * CGI Parameters : none
1032 * Returns : JB_ERR_OK on success
1033 * JB_ERR_MEMORY on out-of-memory error.
1035 *********************************************************************/
1036 jb_err cgi_show_version(struct client_state *csp,
1037 struct http_response *rsp,
1038 const struct map *parameters)
1040 struct map *exports;
1046 if (NULL == (exports = default_exports(csp, "show-version")))
1048 return JB_ERR_MEMORY;
1051 if (map(exports, "sourceversions", 1, show_rcs(), 0))
1054 return JB_ERR_MEMORY;
1057 return template_fill_for_cgi(csp, "show-version", exports, rsp);
1061 /*********************************************************************
1063 * Function : cgi_show_status
1065 * Description : CGI function that returns a web page describing the
1066 * current status of Privoxy.
1069 * 1 : csp = Current client state (buffers, headers, etc...)
1070 * 2 : rsp = http_response data structure for output
1071 * 3 : parameters = map of cgi parameters
1074 * file : Which file to show. Only first letter is checked,
1076 * - "p"ermissions (actions) file
1079 * Default is to show menu and other information.
1081 * Returns : JB_ERR_OK on success
1082 * JB_ERR_MEMORY on out-of-memory error.
1084 *********************************************************************/
1085 jb_err cgi_show_status(struct client_state *csp,
1086 struct http_response *rsp,
1087 const struct map *parameters)
1094 char buf[BUFFER_SIZE];
1095 const char * filename = NULL;
1096 char * file_description = NULL;
1097 #ifdef FEATURE_STATISTICS
1098 float perc_rej; /* Percentage of http requests rejected */
1099 int local_urls_read;
1100 int local_urls_rejected;
1101 #endif /* ndef FEATURE_STATISTICS */
1102 jb_err err = JB_ERR_OK;
1104 struct map *exports;
1110 if (NULL == (exports = default_exports(csp, "show-status")))
1112 return JB_ERR_MEMORY;
1115 switch (*(lookup(parameters, "file")))
1118 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
1120 filename = csp->actions_list[i]->filename;
1121 file_description = "Actions File";
1126 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
1128 filename = csp->rlist[i]->filename;
1129 file_description = "Filter File";
1133 #ifdef FEATURE_TRUST
1137 filename = csp->tlist->filename;
1138 file_description = "Trust File";
1141 #endif /* def FEATURE_TRUST */
1144 if (NULL != filename)
1146 if ( map(exports, "file-description", 1, file_description, 1)
1147 || map(exports, "filepath", 1, html_encode(filename), 0) )
1150 return JB_ERR_MEMORY;
1153 if ((fp = fopen(filename, "r")) == NULL)
1155 if (map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
1158 return JB_ERR_MEMORY;
1164 while ((s != NULL) && fgets(buf, sizeof(buf), fp))
1166 string_join (&s, html_encode(buf));
1170 if (map(exports, "contents", 1, s, 0))
1173 return JB_ERR_MEMORY;
1177 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
1181 for (j = 0; (s != NULL) && (j < Argc); j++)
1183 if (!err) err = string_join (&s, html_encode(Argv[j]));
1184 if (!err) err = string_append(&s, " ");
1186 if (!err) err = map(exports, "invocation", 1, s, 0);
1188 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1189 if (!err) err = show_defines(exports);
1194 return JB_ERR_MEMORY;
1197 #ifdef FEATURE_STATISTICS
1198 local_urls_read = urls_read;
1199 local_urls_rejected = urls_rejected;
1202 * Need to alter the stats not to include the fetch of this
1205 * Can't do following thread safely! doh!
1208 * urls_rejected--; * This will be incremented subsequently *
1211 if (local_urls_read == 0)
1213 if (!err) err = map_block_killer(exports, "have-stats");
1217 if (!err) err = map_block_killer(exports, "have-no-stats");
1219 perc_rej = (float)local_urls_rejected * 100.0F /
1220 (float)local_urls_read;
1222 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1223 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1225 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1226 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1228 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1229 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1232 #else /* ndef FEATURE_STATISTICS */
1233 err = err || map_block_killer(exports, "statistics");
1234 #endif /* ndef FEATURE_STATISTICS */
1237 * List all action files in use, together with view and edit links,
1238 * except for standard.action, which should only be viewable. (Not
1239 * enforced in the editor itself)
1240 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1243 for (i = 0; i < MAX_AF_FILES; i++)
1245 if (csp->actions_list[i] != NULL)
1247 if (!err) err = string_append(&s, "<tr><td>");
1248 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1249 snprintf(buf, sizeof(buf),
1250 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1251 if (!err) err = string_append(&s, buf);
1253 #ifdef FEATURE_CGI_EDIT_ACTIONS
1254 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1255 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
1256 && (NULL != csp->config->actions_file_short[i]))
1259 if (access(csp->config->actions_file[i], W_OK) == 0)
1261 #endif /* def HAVE_ACCESS */
1262 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%d\">Edit</a>", i);
1263 if (!err) err = string_append(&s, buf);
1268 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
1270 #endif /* def HAVE_ACCESS */
1274 if (!err) err = string_append(&s, "</td></tr>\n");
1279 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1283 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1287 * List all re_filterfiles in use, together with view options.
1288 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1291 for (i = 0; i < MAX_AF_FILES; i++)
1293 if (csp->rlist[i] != NULL)
1295 if (!err) err = string_append(&s, "<tr><td>");
1296 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1298 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1299 if (!err) err = string_append(&s, buf);
1300 if (!err) err = string_append(&s, "</td></tr>\n");
1305 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1309 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1310 if (!err) err = map_block_killer(exports, "have-filterfile");
1313 #ifdef FEATURE_TRUST
1316 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1320 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1321 if (!err) err = map_block_killer(exports, "have-trustfile");
1324 if (!err) err = map_block_killer(exports, "trust-support");
1325 #endif /* ndef FEATURE_TRUST */
1327 #ifdef FEATURE_CGI_EDIT_ACTIONS
1328 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1330 err = map_block_killer(exports, "cgi-editor-is-disabled");
1332 #endif /* ndef CGI_EDIT_ACTIONS */
1337 return JB_ERR_MEMORY;
1340 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1344 /*********************************************************************
1346 * Function : cgi_show_url_info
1348 * Description : CGI function that determines and shows which actions
1349 * Privoxy will perform for a given url, and which
1350 * matches starting from the defaults have lead to that.
1353 * 1 : csp = Current client state (buffers, headers, etc...)
1354 * 2 : rsp = http_response data structure for output
1355 * 3 : parameters = map of cgi parameters
1358 * url : The url whose actions are to be determined.
1359 * If url is unset, the url-given conditional will be
1360 * set, so that all but the form can be suppressed in
1363 * Returns : JB_ERR_OK on success
1364 * JB_ERR_MEMORY on out-of-memory error.
1366 *********************************************************************/
1367 jb_err cgi_show_url_info(struct client_state *csp,
1368 struct http_response *rsp,
1369 const struct map *parameters)
1372 struct map *exports;
1379 if (NULL == (exports = default_exports(csp, "show-url-info")))
1381 return JB_ERR_MEMORY;
1385 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1387 url_param = strdup(lookup(parameters, "url"));
1388 if (url_param == NULL)
1391 return JB_ERR_MEMORY;
1396 * Handle prefixes. 4 possibilities:
1397 * 1) "http://" or "https://" prefix present and followed by URL - OK
1398 * 2) Only the "http://" or "https://" part is present, no URL - change
1399 * to empty string so it will be detected later as "no URL".
1400 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1402 * 4) Parameter not specified or is empty string - let this fall through
1403 * for now, next block of code will handle it.
1405 if (0 == strncmp(url_param, "http://", 7))
1407 if (url_param[7] == '\0')
1410 * Empty URL (just prefix).
1411 * Make it totally empty so it's caught by the next if()
1413 url_param[0] = '\0';
1416 else if (0 == strncmp(url_param, "https://", 8))
1418 if (url_param[8] == '\0')
1421 * Empty URL (just prefix).
1422 * Make it totally empty so it's caught by the next if()
1424 url_param[0] = '\0';
1427 else if (url_param[0] != '\0')
1430 * Unknown prefix - assume http://
1432 const size_t url_param_prefixed_size = 7 + 1 + strlen(url_param);
1433 char * url_param_prefixed = malloc(url_param_prefixed_size);
1434 if (NULL == url_param_prefixed)
1438 return JB_ERR_MEMORY;
1440 strlcpy(url_param_prefixed, "http://", url_param_prefixed_size);
1441 strlcat(url_param_prefixed, url_param, url_param_prefixed_size);
1443 url_param = url_param_prefixed;
1447 * Hide "toggle off" warning if Privoxy is toggled on.
1450 #ifdef FEATURE_TOGGLE
1451 (global_toggle_state == 1) &&
1452 #endif /* def FEATURE_TOGGLE */
1453 map_block_killer(exports, "privoxy-is-toggled-off")
1457 return JB_ERR_MEMORY;
1460 if (url_param[0] == '\0')
1462 /* URL paramater not specified, display query form only. */
1464 if (map_block_killer(exports, "url-given")
1465 || map(exports, "url", 1, "", 1))
1468 return JB_ERR_MEMORY;
1473 /* Given a URL, so query it. */
1478 struct file_list *fl;
1479 struct url_actions *b;
1480 struct http_request url_to_query[1];
1481 struct current_action_spec action[1];
1484 if (map(exports, "url", 1, html_encode(url_param), 0))
1488 return JB_ERR_MEMORY;
1491 init_current_action(action);
1493 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1495 free_current_action(action);
1498 return JB_ERR_MEMORY;
1501 err = parse_http_url(url_param, url_to_query, csp);
1505 if (err == JB_ERR_MEMORY)
1507 free_http_request(url_to_query);
1508 free_current_action(action);
1510 return JB_ERR_MEMORY;
1516 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1517 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1518 if (!err) err = map_block_killer(exports, "valid-url");
1520 free_current_action(action);
1521 free_http_request(url_to_query);
1526 return JB_ERR_MEMORY;
1529 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1533 * We have a warning about SSL paths. Hide it for unencrypted sites.
1535 if (!url_to_query->ssl)
1537 if (map_block_killer(exports, "https"))
1539 free_current_action(action);
1541 free_http_request(url_to_query);
1542 return JB_ERR_MEMORY;
1546 matches = strdup("<table summary=\"\" class=\"transparent\">");
1548 for (i = 0; i < MAX_AF_FILES; i++)
1550 if (NULL == csp->config->actions_file_short[i]
1551 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1555 if ((fl = csp->actions_list[i]) != NULL)
1557 if ((b = fl->f) != NULL)
1559 /* FIXME: Hardcoded HTML! */
1560 string_append(&matches, "<tr><th>In file: ");
1561 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1562 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1563 string_append(&matches, buf);
1564 string_append(&matches, "View</a>");
1565 #ifdef FEATURE_CGI_EDIT_ACTIONS
1566 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1569 if (access(csp->config->actions_file[i], W_OK) == 0)
1571 #endif /* def HAVE_ACCESS */
1572 snprintf(buf, sizeof(buf),
1573 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1574 string_append(&matches, buf);
1575 string_append(&matches, "Edit</a>");
1580 string_append(&matches, " <strong>No write access.</strong>");
1582 #endif /* def HAVE_ACCESS */
1584 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1586 string_append(&matches, "</th></tr>\n");
1593 for (; (b != NULL) && (matches != NULL); b = b->next)
1595 if (url_match(b->url, url_to_query))
1597 string_append(&matches, "<tr><td>{");
1598 string_join (&matches, actions_to_html(csp, b->action));
1599 string_append(&matches, " }<br>\n<code>");
1600 string_join (&matches, html_encode(b->url->spec));
1601 string_append(&matches, "</code></td></tr>\n");
1603 if (merge_current_action(action, b->action))
1606 free_http_request(url_to_query);
1607 free_current_action(action);
1609 return JB_ERR_MEMORY;
1617 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1620 string_append(&matches, "</table>\n");
1623 * XXX: Kludge to make sure the "Forward settings" section
1624 * shows what forward-override{} would do with the requested URL.
1625 * No one really cares how the CGI request would be forwarded
1626 * if it wasn't intercepted as CGI request in the first place.
1628 * From here on the action bitmask will no longer reflect
1629 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1630 * but luckily it's no longer required later on anyway.
1632 free_current_action(csp->action);
1633 url_actions(url_to_query, csp);
1636 * Fill in forwarding settings.
1638 * The possibilities are:
1640 * - http forwarding only
1641 * - socks4(a) forwarding only
1642 * - socks4(a) and http forwarding.
1644 * XXX: Parts of this code could be reused for the
1645 * "forwarding-failed" template which currently doesn't
1646 * display the proxy port and an eventual second forwarder.
1649 const struct forward_spec * fwd = forward_url(url_to_query, csp);
1651 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1653 if (!err) err = map_block_killer(exports, "socks-forwarder");
1654 if (!err) err = map_block_killer(exports, "http-forwarder");
1658 char port[10]; /* We save proxy ports as int but need a string here */
1660 if (!err) err = map_block_killer(exports, "no-forwarder");
1662 if (fwd->gateway_host != NULL)
1664 if (!err) err = map(exports, "socks-type", 1, (fwd->type == SOCKS_4) ?
1665 "socks4" : "socks4a", 1);
1666 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1667 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1668 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1672 if (!err) err = map_block_killer(exports, "socks-forwarder");
1675 if (fwd->forward_host != NULL)
1677 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1678 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1679 if (!err) err = map(exports, "forward-port", 1, port, 1);
1683 if (!err) err = map_block_killer(exports, "http-forwarder");
1688 free_http_request(url_to_query);
1690 if (err || matches == NULL)
1692 free_current_action(action);
1694 return JB_ERR_MEMORY;
1697 #ifdef FEATURE_CGI_EDIT_ACTIONS
1698 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1700 err = map_block_killer(exports, "cgi-editor-is-disabled");
1702 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1704 if (err || map(exports, "matches", 1, matches , 0))
1706 free_current_action(action);
1708 return JB_ERR_MEMORY;
1711 s = current_action_to_html(csp, action);
1713 free_current_action(action);
1715 if (map(exports, "final", 1, s, 0))
1718 return JB_ERR_MEMORY;
1722 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1726 /*********************************************************************
1728 * Function : cgi_robots_txt
1730 * Description : CGI function to return "/robots.txt".
1733 * 1 : csp = Current client state (buffers, headers, etc...)
1734 * 2 : rsp = http_response data structure for output
1735 * 3 : parameters = map of cgi parameters
1737 * CGI Parameters : None
1739 * Returns : JB_ERR_OK on success
1740 * JB_ERR_MEMORY on out-of-memory error.
1742 *********************************************************************/
1743 jb_err cgi_robots_txt(struct client_state *csp,
1744 struct http_response *rsp,
1745 const struct map *parameters)
1751 "# This is the Privoxy control interface.\n"
1752 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1758 if (rsp->body == NULL)
1760 return JB_ERR_MEMORY;
1763 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1767 get_http_time(7 * 24 * 60 * 60, buf); /* 7 days into future */
1768 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1770 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1774 /*********************************************************************
1776 * Function : show_defines
1778 * Description : Add to a map the state od all conditional #defines
1779 * used when building
1782 * 1 : exports = map to extend
1784 * Returns : JB_ERR_OK on success
1785 * JB_ERR_MEMORY on out-of-memory error.
1787 *********************************************************************/
1788 static jb_err show_defines(struct map *exports)
1790 jb_err err = JB_ERR_OK;
1793 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1794 #else /* ifndef FEATURE_ACL */
1795 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1796 #endif /* ndef FEATURE_ACL */
1798 #ifdef FEATURE_CGI_EDIT_ACTIONS
1799 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1800 #else /* ifndef FEATURE_COOKIE_JAR */
1801 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1802 #endif /* ndef FEATURE_COOKIE_JAR */
1804 #ifdef FEATURE_COOKIE_JAR
1805 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1806 #else /* ifndef FEATURE_COOKIE_JAR */
1807 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1808 #endif /* ndef FEATURE_COOKIE_JAR */
1810 #ifdef FEATURE_FAST_REDIRECTS
1811 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1812 #else /* ifndef FEATURE_FAST_REDIRECTS */
1813 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1814 #endif /* ndef FEATURE_FAST_REDIRECTS */
1816 #ifdef FEATURE_FORCE_LOAD
1817 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1818 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1819 #else /* ifndef FEATURE_FORCE_LOAD */
1820 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1821 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1822 #endif /* ndef FEATURE_FORCE_LOAD */
1824 #ifdef FEATURE_GRACEFUL_TERMINATION
1825 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1826 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1827 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1828 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1830 #ifdef FEATURE_IMAGE_BLOCKING
1831 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1832 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1833 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1834 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1836 #ifdef FEATURE_IMAGE_DETECT_MSIE
1837 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1838 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1839 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1840 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1842 #ifdef FEATURE_KILL_POPUPS
1843 if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 1);
1844 #else /* ifndef FEATURE_KILL_POPUPS */
1845 if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 0);
1846 #endif /* ndef FEATURE_KILL_POPUPS */
1848 #ifdef FEATURE_NO_GIFS
1849 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1850 #else /* ifndef FEATURE_NO_GIFS */
1851 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1852 #endif /* ndef FEATURE_NO_GIFS */
1854 #ifdef FEATURE_PTHREAD
1855 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1856 #else /* ifndef FEATURE_PTHREAD */
1857 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1858 #endif /* ndef FEATURE_PTHREAD */
1860 #ifdef FEATURE_STATISTICS
1861 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1862 #else /* ifndef FEATURE_STATISTICS */
1863 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1864 #endif /* ndef FEATURE_STATISTICS */
1866 #ifdef FEATURE_TOGGLE
1867 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1868 #else /* ifndef FEATURE_TOGGLE */
1869 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1870 #endif /* ndef FEATURE_TOGGLE */
1872 #ifdef FEATURE_TRUST
1873 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1874 #else /* ifndef FEATURE_TRUST */
1875 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1876 #endif /* ndef FEATURE_TRUST */
1879 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1880 #else /* ifndef FEATURE_ZLIB */
1881 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1882 #endif /* ndef FEATURE_ZLIB */
1885 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1886 #else /* ifndef STATIC_PCRE */
1887 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1888 #endif /* ndef STATIC_PCRE */
1891 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1892 #else /* ifndef STATIC_PCRS */
1893 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1894 #endif /* ndef STATIC_PCRS */
1900 /*********************************************************************
1902 * Function : show_rcs
1904 * Description : Create a string with the rcs info for all sourcefiles
1908 * Returns : A string, or NULL on out-of-memory.
1910 *********************************************************************/
1911 static char *show_rcs(void)
1913 char *result = strdup("");
1914 char buf[BUFFER_SIZE];
1916 /* Instead of including *all* dot h's in the project (thus creating a
1917 * tremendous amount of dependencies), I will concede to declaring them
1918 * as extern's. This forces the developer to add to this list, but oh well.
1921 #define SHOW_RCS(__x) \
1923 extern const char __x[]; \
1924 snprintf(buf, sizeof(buf), " %s\n", __x); \
1925 string_append(&result, buf); \
1928 /* In alphabetical order */
1929 SHOW_RCS(actions_h_rcs)
1930 SHOW_RCS(actions_rcs)
1932 SHOW_RCS(amiga_h_rcs)
1934 #endif /* def AMIGA */
1937 #ifdef FEATURE_CGI_EDIT_ACTIONS
1938 SHOW_RCS(cgiedit_h_rcs)
1939 SHOW_RCS(cgiedit_rcs)
1940 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1941 SHOW_RCS(cgisimple_h_rcs)
1942 SHOW_RCS(cgisimple_rcs)
1944 SHOW_RCS(cygwin_h_rcs)
1946 SHOW_RCS(deanimate_h_rcs)
1947 SHOW_RCS(deanimate_rcs)
1948 SHOW_RCS(encode_h_rcs)
1949 SHOW_RCS(encode_rcs)
1950 SHOW_RCS(errlog_h_rcs)
1951 SHOW_RCS(errlog_rcs)
1952 SHOW_RCS(filters_h_rcs)
1953 SHOW_RCS(filters_rcs)
1954 SHOW_RCS(gateway_h_rcs)
1955 SHOW_RCS(gateway_rcs)
1956 SHOW_RCS(jbsockets_h_rcs)
1957 SHOW_RCS(jbsockets_rcs)
1960 #ifdef FEATURE_KILL_POPUPS
1961 SHOW_RCS(killpopup_h_rcs)
1962 SHOW_RCS(killpopup_rcs)
1963 #endif /* def FEATURE_KILL_POPUPS */
1964 SHOW_RCS(list_h_rcs)
1966 SHOW_RCS(loadcfg_h_rcs)
1967 SHOW_RCS(loadcfg_rcs)
1968 SHOW_RCS(loaders_h_rcs)
1969 SHOW_RCS(loaders_rcs)
1970 SHOW_RCS(miscutil_h_rcs)
1971 SHOW_RCS(miscutil_rcs)
1972 SHOW_RCS(parsers_h_rcs)
1973 SHOW_RCS(parsers_rcs)
1975 SHOW_RCS(pcrs_h_rcs)
1976 SHOW_RCS(project_h_rcs)
1977 SHOW_RCS(ssplit_h_rcs)
1978 SHOW_RCS(ssplit_rcs)
1979 SHOW_RCS(urlmatch_h_rcs)
1980 SHOW_RCS(urlmatch_rcs)
1982 #ifndef _WIN_CONSOLE
1983 SHOW_RCS(w32log_h_rcs)
1984 SHOW_RCS(w32log_rcs)
1985 SHOW_RCS(w32res_h_rcs)
1986 SHOW_RCS(w32taskbar_h_rcs)
1987 SHOW_RCS(w32taskbar_rcs)
1988 #endif /* ndef _WIN_CONSOLE */
1989 SHOW_RCS(win32_h_rcs)
1991 #endif /* def _WIN32 */