1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.77 2008/05/02 09:47:48 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.77 2008/05/02 09:47:48 fabiankeil
40 * In cgi_show_url_info, pass an initialized http structure
41 * to parse_http_url() as that will be required soonish and
42 * assert that https URLs are recognized correctly.
44 * Revision 1.76 2008/04/28 09:13:30 fabiankeil
45 * In load_file(), remember the error reason and fclose()
46 * and return later on instead of right away.
48 * Revision 1.75 2008/04/27 13:52:52 fabiankeil
49 * Move CGI file loading code into load_file() and
50 * add checks for unexpected errors.
52 * Revision 1.74 2008/04/26 15:50:56 fabiankeil
53 * Fix macro name in cgi_show_file() error path.
55 * Revision 1.73 2008/04/26 12:21:55 fabiankeil
56 * Forget about JB_ERR_PARSE. JB_ERR_CGI_PARAMS to the rescue.
58 * Revision 1.72 2008/04/26 10:34:15 fabiankeil
59 * If zlib support is unavailable and there are content filters active
60 * but the prevent-compression action is disabled, include a warning
61 * on the show-url-info page that compression might prevent filtering.
63 * Revision 1.71 2008/04/25 13:33:56 fabiankeil
64 * - Factor cgi_show_file() out of cgi_show_status().
65 * - Adjust cgi_show_status()'s parameter description to match reality.
67 * Revision 1.70 2008/04/24 16:12:38 fabiankeil
68 * In cgi_show_status(), load the requested file at once.
69 * Using string_join() for every line really doesn't scale.
71 * Revision 1.69 2008/04/17 14:40:48 fabiankeil
72 * Provide get_http_time() with the buffer size so it doesn't
73 * have to blindly assume that the buffer is big enough.
75 * Revision 1.68 2008/03/27 18:27:21 fabiankeil
76 * Remove kill-popups action.
78 * Revision 1.67 2008/03/27 17:00:05 fabiankeil
79 * Turn the favicon blobs into locals.
81 * Revision 1.66 2008/02/23 16:57:12 fabiankeil
82 * Rename url_actions() to get_url_actions() and let it
83 * use the standard parameter ordering.
85 * Revision 1.65 2008/02/23 16:33:43 fabiankeil
86 * Let forward_url() use the standard parameter ordering
87 * and mark its second parameter immutable.
89 * Revision 1.64 2008/02/03 13:56:07 fabiankeil
90 * Add SOCKS5 support for show-url-info CGI page.
92 * Revision 1.63 2008/02/01 06:04:31 fabiankeil
93 * If edit buttons on the show-url-info CGI page are hidden, explain why.
95 * Revision 1.62 2008/02/01 05:52:40 fabiankeil
96 * Hide edit buttons on the show-url-info CGI page if enable-edit-action
97 * is disabled. Patch by Lee with additional white space adjustments.
99 * Revision 1.61 2008/01/26 11:13:25 fabiankeil
100 * If enable-edit-actions is disabled, hide the edit buttons and explain why.
102 * Revision 1.60 2007/10/27 13:12:13 fabiankeil
103 * Finish 1.49 and check write access before
104 * showing edit buttons on show-url-info page.
106 * Revision 1.59 2007/10/19 16:42:36 fabiankeil
107 * Plug memory leak I introduced five months ago.
108 * Yay Valgrind and Privoxy-Regression-Test.
110 * Revision 1.58 2007/07/21 12:19:50 fabiankeil
111 * If show-url-info is called with an URL that Privoxy
112 * would reject as invalid, don't show unresolved forwarding
113 * variables, "final matches" or claim the site's secure.
115 * Revision 1.57 2007/06/01 16:53:05 fabiankeil
116 * Adjust cgi_show_url_info() to show what forward-override{}
117 * would do with the requested URL (instead of showing how the
118 * request for the CGI page would be forwarded if it wasn't a
121 * Revision 1.56 2007/05/21 10:50:35 fabiankeil
122 * - Use strlcpy() instead of strcpy().
123 * - Stop treating actions files special. Expect a complete file name
124 * (with or without path) like it's done for the rest of the files.
126 * - Don't rerun sed() in cgi_show_request().
128 * Revision 1.55 2007/04/13 13:36:46 fabiankeil
129 * Reference action files in CGI URLs by id instead
130 * of using the first part of the file name.
131 * Fixes BR 1694250 and BR 1590556.
133 * Revision 1.54 2007/04/09 18:11:35 fabiankeil
134 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
136 * Revision 1.53 2007/04/08 13:21:04 fabiankeil
137 * Reference action files in CGI URLs by id instead
138 * of using the first part of the file name.
139 * Fixes BR 1694250 and BR 1590556.
141 * Revision 1.52 2007/02/13 15:10:26 fabiankeil
142 * Apparently fopen()ing in "binary" mode doesn't require
143 * #ifdefs, it's already done without them in cgiedit.c.
145 * Revision 1.51 2007/02/10 16:55:22 fabiankeil
146 * - Show forwarding settings on the show-url-info page
147 * - Fix some HTML syntax errors.
149 * Revision 1.50 2007/01/23 15:51:17 fabiankeil
150 * Add favicon delivery functions.
152 * Revision 1.49 2007/01/20 16:29:38 fabiankeil
153 * Suppress edit buttons for action files if Privoxy has
154 * no write access. Suggested by Roland in PR 1564026.
156 * Revision 1.48 2007/01/20 15:31:31 fabiankeil
157 * Display warning if show-url-info CGI page
158 * is used while Privoxy is toggled off.
160 * Revision 1.47 2007/01/12 15:07:10 fabiankeil
161 * Use zalloc in cgi_send_user_manual.
163 * Revision 1.46 2007/01/02 12:49:46 fabiankeil
164 * Add FEATURE_ZLIB to the list of conditional
165 * defines at the show-status page.
167 * Revision 1.45 2006/12/28 18:16:41 fabiankeil
168 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
169 * body memory before using it, replaced sprintf calls with snprintf.
171 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
172 * Removed checks whether or not AF_FILES have
173 * data structures associated with them in cgi_show_status.
174 * It doesn't matter as we're only interested in the file names.
176 * For the action files the checks were always true,
177 * but they prevented empty filter files from being
178 * listed. Fixes parts of BR 1619208.
180 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
181 * - Added FEATURE_GRACEFUL_TERMINATION to the
182 * "conditional #defines" section
183 * - Escaped ampersands in generated HTML.
184 * - Renamed re-filter-filename to re-filter-filenames
186 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
187 * Add special treatment for WIN32 to make sure
188 * cgi_send_user_manual opens the files in binary mode.
189 * Fixes BR 1600411 and unbreaks image delivery.
191 * Remove outdated comment.
193 * Revision 1.41 2006/10/09 19:18:28 roro
194 * Redirect http://p.p/user-manual (without trailing slash) to
195 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
197 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
198 * Modified cgi_send_user_manual to serve binary
199 * content without destroying it first. Should also be
200 * faster now. Added ".jpg" check for Content-Type guessing.
202 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
203 * Deliver documents in the user-manual directory
204 * with "Content-Type text/css" if their filename
207 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
208 * Incorporate modified version of Roland Rosenfeld's patch to
209 * optionally access the user-manual via Privoxy. Closes patch 679075.
211 * Formatting changed to Privoxy style, added call to
212 * cgi_error_no_template if the requested file doesn't
213 * exist and modified check whether or not Privoxy itself
214 * should serve the manual. Should work cross-platform now.
216 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
217 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
218 * with what was really the latest development (the v_3_0_branch branch)
220 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
221 * Multiple filter file support
223 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
224 * Undo some damaging memory leak patches
226 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
227 * A few memory leaks plugged (mostly on error paths)
229 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
230 * Another instance of:
231 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
232 * Thanks to Magnus Holmgren for the patch
234 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
235 * - Prevent line wrap beween "View/Edit" link buttons on status page
236 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
238 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
239 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
241 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
242 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
244 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
245 * Applying patch from Andreas as provided by Hal on the list.
246 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
248 * Revision 1.35 2002/05/12 21:44:44 jongfoster
249 * Adding amiga.[ch] revision information, if on an amiga.
251 * Revision 1.34 2002/04/30 12:06:12 oes
252 * Deleted unused code from default_cgi
254 * Revision 1.33 2002/04/30 11:14:52 oes
255 * Made csp the first parameter in *action_to_html
257 * Revision 1.32 2002/04/26 18:29:13 jongfoster
258 * Fixing this Visual C++ warning:
259 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
261 * Revision 1.31 2002/04/26 12:54:36 oes
262 * - Kill obsolete REDIRECT_URL code
263 * - Error handling fixes
264 * - Style sheet related HTML snipplet changes
265 * - cgi_show_url_info:
266 * - Matches now in table, actions on single lines,
268 * - standard.action suppressed
269 * - Buttons to View and Edit AFs
271 * Revision 1.30 2002/04/24 02:18:08 oes
272 * - show-status is now the starting point for editing
273 * the actions files, generate list of all AFs with buttons
274 * for viewing and editing, new look for file list (Jon:
275 * buttons now aligned ;-P ), view mode now supports multiple
276 * AFs, name changes, no view links for unspecified files,
277 * no edit link for standard.action.
279 * - Jon's multiple AF patch: cgi_show_url_info now uses all
280 * AFs and marks the output accordingly
282 * Revision 1.29 2002/04/10 13:38:35 oes
283 * load_template signature changed
285 * Revision 1.28 2002/04/07 15:42:12 jongfoster
286 * Fixing send-banner?type=auto when the image-blocker is
287 * a redirect to send-banner
289 * Revision 1.27 2002/04/05 15:50:48 oes
290 * added send-stylesheet CGI
292 * Revision 1.26 2002/04/04 00:36:36 gliptak
293 * always use pcre for matching
295 * Revision 1.25 2002/04/03 22:28:03 gliptak
296 * Removed references to gnu_regex
298 * Revision 1.24 2002/04/02 16:12:47 oes
299 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
301 * Revision 1.23 2002/03/26 22:29:54 swa
302 * we have a new homepage!
304 * Revision 1.22 2002/03/24 16:18:15 jongfoster
307 * Revision 1.21 2002/03/24 15:23:33 jongfoster
310 * Revision 1.20 2002/03/24 13:25:43 swa
311 * name change related issues
313 * Revision 1.19 2002/03/16 23:54:06 jongfoster
314 * Adding graceful termination feature, to help look for memory leaks.
315 * If you enable this (which, by design, has to be done by hand
316 * editing config.h) and then go to http://i.j.b/die, then the program
317 * will exit cleanly after the *next* request. It should free all the
318 * memory that was used.
320 * Revision 1.18 2002/03/12 01:44:49 oes
321 * Changed default for "blocked" image from jb logo to checkboard pattern
323 * Revision 1.17 2002/03/08 16:43:18 oes
324 * Added choice beween GIF and PNG built-in images
326 * Revision 1.16 2002/03/07 03:48:38 oes
327 * - Changed built-in images from GIF to PNG
328 * (with regard to Unisys patent issue)
329 * - Added a 4x4 pattern PNG which is less intrusive
330 * than the logo but also clearly marks the deleted banners
332 * Revision 1.15 2002/03/06 22:54:35 jongfoster
333 * Automated function-comment nitpicking.
335 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
336 * Clean up a little CRLF unpleasantness that suddenly appeared
338 * Revision 1.13 2002/02/21 00:10:37 jongfoster
339 * Adding send-banner?type=auto option
341 * Revision 1.12 2002/01/23 01:03:32 jongfoster
342 * Fixing gcc [CygWin] compiler warnings
344 * Revision 1.11 2002/01/23 00:01:04 jongfoster
345 * Adding cgi_transparent_gif() for http://i.j.b/t
346 * Adding missing html_encode() to many CGI functions.
347 * Adding urlmatch.[ch] to http://i.j.b/show-version
349 * Revision 1.10 2002/01/17 21:10:37 jongfoster
350 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
351 * Also fixing a problem in the same function with improperly quoted URLs
352 * in output HTML, and adding code to handle https:// URLs correctly.
354 * Revision 1.9 2001/11/30 23:09:15 jongfoster
355 * Now reports on FEATURE_CGI_EDIT_ACTIONS
356 * Removing FEATURE_DENY_GZIP from template
358 * Revision 1.8 2001/11/13 00:14:07 jongfoster
359 * Fixing stupid bug now I've figured out what || means.
360 * (It always returns 0 or 1, not one of it's paramaters.)
362 * Revision 1.7 2001/10/23 21:48:19 jongfoster
363 * Cleaning up error handling in CGI functions - they now send back
364 * a HTML error page and should never cause a FATAL error. (Fixes one
365 * potential source of "denial of service" attacks).
367 * CGI actions file editor that works and is actually useful.
369 * Ability to toggle JunkBuster remotely using a CGI call.
371 * You can turn off both the above features in the main configuration
372 * file, e.g. if you are running a multi-user proxy.
374 * Revision 1.6 2001/10/14 22:00:32 jongfoster
375 * Adding support for a 404 error when an invalid CGI page is requested.
377 * Revision 1.5 2001/10/07 15:30:41 oes
378 * Removed FEATURE_DENY_GZIP
380 * Revision 1.4 2001/10/02 15:31:12 oes
381 * Introduced show-request cgi
383 * Revision 1.3 2001/09/22 16:34:44 jongfoster
384 * Removing unneeded #includes
386 * Revision 1.2 2001/09/19 18:01:11 oes
387 * Fixed comments; cosmetics
389 * Revision 1.1 2001/09/16 17:08:54 jongfoster
390 * Moving simple CGI functions from cgi.c to new file cgisimple.c
393 **********************************************************************/
399 #include <sys/types.h>
407 #endif /* def HAVE_ACCESS */
411 #include "cgisimple.h"
417 #include "miscutil.h"
420 #include "urlmatch.h"
423 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
425 static char *show_rcs(void);
426 static jb_err show_defines(struct map *exports);
427 static jb_err cgi_show_file(struct client_state *csp,
428 struct http_response *rsp,
429 const struct map *parameters);
430 static jb_err load_file(const char *filename, char **buffer, size_t *length);
432 /*********************************************************************
434 * Function : cgi_default
436 * Description : CGI function that is called for the CGI_SITE_1_HOST
437 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
438 * Boring - only exports the default exports.
441 * 1 : csp = Current client state (buffers, headers, etc...)
442 * 2 : rsp = http_response data structure for output
443 * 3 : parameters = map of cgi parameters
445 * CGI Parameters : none
447 * Returns : JB_ERR_OK on success
448 * JB_ERR_MEMORY on out-of-memory
450 *********************************************************************/
451 jb_err cgi_default(struct client_state *csp,
452 struct http_response *rsp,
453 const struct map *parameters)
460 if (NULL == (exports = default_exports(csp, "")))
462 return JB_ERR_MEMORY;
465 return template_fill_for_cgi(csp, "default", exports, rsp);
469 /*********************************************************************
471 * Function : cgi_error_404
473 * Description : CGI function that is called if an unknown action was
477 * 1 : csp = Current client state (buffers, headers, etc...)
478 * 2 : rsp = http_response data structure for output
479 * 3 : parameters = map of cgi parameters
481 * CGI Parameters : none
483 * Returns : JB_ERR_OK on success
484 * JB_ERR_MEMORY on out-of-memory error.
486 *********************************************************************/
487 jb_err cgi_error_404(struct client_state *csp,
488 struct http_response *rsp,
489 const struct map *parameters)
497 if (NULL == (exports = default_exports(csp, NULL)))
499 return JB_ERR_MEMORY;
502 rsp->status = strdup("404 Privoxy configuration page not found");
503 if (rsp->status == NULL)
506 return JB_ERR_MEMORY;
509 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
513 #ifdef FEATURE_GRACEFUL_TERMINATION
514 /*********************************************************************
518 * Description : CGI function to shut down Privoxy.
519 * NOTE: Turning this on in a production build
520 * would be a BAD idea. An EXTREMELY BAD idea.
521 * In short, don't do it.
524 * 1 : csp = Current client state (buffers, headers, etc...)
525 * 2 : rsp = http_response data structure for output
526 * 3 : parameters = map of cgi parameters
528 * CGI Parameters : none
530 * Returns : JB_ERR_OK on success
531 * JB_ERR_MEMORY on out-of-memory error.
533 *********************************************************************/
534 jb_err cgi_die (struct client_state *csp,
535 struct http_response *rsp,
536 const struct map *parameters)
546 * I don't really care what gets sent back to the browser.
547 * Take the easy option - "out of memory" page.
550 return JB_ERR_MEMORY;
552 #endif /* def FEATURE_GRACEFUL_TERMINATION */
555 /*********************************************************************
557 * Function : cgi_show_request
559 * Description : Show the client's request and what sed() would have
563 * 1 : csp = Current client state (buffers, headers, etc...)
564 * 2 : rsp = http_response data structure for output
565 * 3 : parameters = map of cgi parameters
567 * CGI Parameters : none
569 * Returns : JB_ERR_OK on success
570 * JB_ERR_MEMORY on out-of-memory error.
572 *********************************************************************/
573 jb_err cgi_show_request(struct client_state *csp,
574 struct http_response *rsp,
575 const struct map *parameters)
584 if (NULL == (exports = default_exports(csp, "show-request")))
586 return JB_ERR_MEMORY;
590 * Repair the damage done to the IOB by get_header()
592 for (p = csp->iob->buf; p < csp->iob->eod; p++)
594 if (*p == '\0') *p = '\n';
598 * Export the original client's request and the one we would
599 * be sending to the server if this wasn't a CGI call
602 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
605 return JB_ERR_MEMORY;
608 if (map(exports, "processed-request", 1,
609 html_encode_and_free_original(list_to_text(csp->headers)), 0))
612 return JB_ERR_MEMORY;
615 return template_fill_for_cgi(csp, "show-request", exports, rsp);
619 /*********************************************************************
621 * Function : cgi_send_banner
623 * Description : CGI function that returns a banner.
626 * 1 : csp = Current client state (buffers, headers, etc...)
627 * 2 : rsp = http_response data structure for output
628 * 3 : parameters = map of cgi parameters
631 * type : Selects the type of banner between "trans", "logo",
632 * and "auto". Defaults to "logo" if absent or invalid.
633 * "auto" means to select as if we were image-blocking.
634 * (Only the first character really counts; b and t are
637 * Returns : JB_ERR_OK on success
638 * JB_ERR_MEMORY on out-of-memory error.
640 *********************************************************************/
641 jb_err cgi_send_banner(struct client_state *csp,
642 struct http_response *rsp,
643 const struct map *parameters)
645 char imagetype = lookup(parameters, "type")[0];
648 * If type is auto, then determine the right thing
649 * to do from the set-image-blocker action
651 if (imagetype == 'a')
658 #ifdef FEATURE_IMAGE_BLOCKING
659 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
661 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
662 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
663 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
667 /* Use default - nothing to do here. */
669 else if (0 == strcmpic(p, "blank"))
673 else if (0 == strcmpic(p, "pattern"))
679 * If the action is to call this CGI, determine
682 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
684 imagetype = p[sizeof(prefix1) - 1];
686 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
688 imagetype = p[sizeof(prefix2) - 1];
692 * Everything else must (should) be a URL to
700 #endif /* def FEATURE_IMAGE_BLOCKING */
704 * Now imagetype is either the non-auto type we were called with,
705 * or it was auto and has since been determined. In any case, we
706 * can proceed to actually answering the request by sending a redirect
707 * or an image as appropriate:
709 if (imagetype == 'r')
711 rsp->status = strdup("302 Local Redirect from Privoxy");
712 if (rsp->status == NULL)
714 return JB_ERR_MEMORY;
716 if (enlist_unique_header(rsp->headers, "Location",
717 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
719 return JB_ERR_MEMORY;
724 if ((imagetype == 'b') || (imagetype == 't'))
726 rsp->body = bindup(image_blank_data, image_blank_length);
727 rsp->content_length = image_blank_length;
731 rsp->body = bindup(image_pattern_data, image_pattern_length);
732 rsp->content_length = image_pattern_length;
735 if (rsp->body == NULL)
737 return JB_ERR_MEMORY;
739 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
741 return JB_ERR_MEMORY;
752 /*********************************************************************
754 * Function : cgi_transparent_image
756 * Description : CGI function that sends a 1x1 transparent image.
759 * 1 : csp = Current client state (buffers, headers, etc...)
760 * 2 : rsp = http_response data structure for output
761 * 3 : parameters = map of cgi parameters
763 * CGI Parameters : None
765 * Returns : JB_ERR_OK on success
766 * JB_ERR_MEMORY on out-of-memory error.
768 *********************************************************************/
769 jb_err cgi_transparent_image(struct client_state *csp,
770 struct http_response *rsp,
771 const struct map *parameters)
773 rsp->body = bindup(image_blank_data, image_blank_length);
774 rsp->content_length = image_blank_length;
776 if (rsp->body == NULL)
778 return JB_ERR_MEMORY;
781 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
783 return JB_ERR_MEMORY;
793 /*********************************************************************
795 * Function : cgi_send_default_favicon
797 * Description : CGI function that sends the standard favicon.
800 * 1 : csp = Current client state (buffers, headers, etc...)
801 * 2 : rsp = http_response data structure for output
802 * 3 : parameters = map of cgi parameters
804 * CGI Parameters : None
806 * Returns : JB_ERR_OK on success
807 * JB_ERR_MEMORY on out-of-memory error.
809 *********************************************************************/
810 jb_err cgi_send_default_favicon(struct client_state *csp,
811 struct http_response *rsp,
812 const struct map *parameters)
814 static const char default_favicon_data[] =
815 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
816 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
817 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
818 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
819 "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
820 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
821 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
822 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
823 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
824 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
825 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
826 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
827 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
829 static const size_t favicon_length = sizeof(default_favicon_data) - 1;
831 rsp->body = bindup(default_favicon_data, favicon_length);
832 rsp->content_length = favicon_length;
834 if (rsp->body == NULL)
836 return JB_ERR_MEMORY;
839 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
841 return JB_ERR_MEMORY;
851 /*********************************************************************
853 * Function : cgi_send_error_favicon
855 * Description : CGI function that sends the favicon for error pages.
858 * 1 : csp = Current client state (buffers, headers, etc...)
859 * 2 : rsp = http_response data structure for output
860 * 3 : parameters = map of cgi parameters
862 * CGI Parameters : None
864 * Returns : JB_ERR_OK on success
865 * JB_ERR_MEMORY on out-of-memory error.
867 *********************************************************************/
868 jb_err cgi_send_error_favicon(struct client_state *csp,
869 struct http_response *rsp,
870 const struct map *parameters)
872 static const char error_favicon_data[] =
873 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
874 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
875 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
876 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
877 "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
878 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
879 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
880 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
881 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
882 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
883 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
884 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
885 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
887 static const size_t favicon_length = sizeof(error_favicon_data) - 1;
889 rsp->body = bindup(error_favicon_data, favicon_length);
890 rsp->content_length = favicon_length;
892 if (rsp->body == NULL)
894 return JB_ERR_MEMORY;
897 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
899 return JB_ERR_MEMORY;
909 /*********************************************************************
911 * Function : cgi_send_stylesheet
913 * Description : CGI function that sends a css stylesheet found
914 * in the cgi-style.css template
917 * 1 : csp = Current client state (buffers, headers, etc...)
918 * 2 : rsp = http_response data structure for output
919 * 3 : parameters = map of cgi parameters
921 * CGI Parameters : None
923 * Returns : JB_ERR_OK on success
924 * JB_ERR_MEMORY on out-of-memory error.
926 *********************************************************************/
927 jb_err cgi_send_stylesheet(struct client_state *csp,
928 struct http_response *rsp,
929 const struct map *parameters)
936 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
938 if (err == JB_ERR_FILE)
941 * No way to tell user; send empty stylesheet
943 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
947 return err; /* JB_ERR_MEMORY */
950 if (enlist(rsp->headers, "Content-Type: text/css"))
952 return JB_ERR_MEMORY;
958 /*********************************************************************
960 * Function : cgi_send_user_manual
962 * Description : CGI function that sends a file in the user
966 * 1 : csp = Current client state (buffers, headers, etc...)
967 * 2 : rsp = http_response data structure for output
968 * 3 : parameters = map of cgi parameters
970 * CGI Parameters : file=name.html, the name of the HTML file
971 * (relative to user-manual from config)
973 * Returns : JB_ERR_OK on success
974 * JB_ERR_MEMORY on out-of-memory error.
976 *********************************************************************/
977 jb_err cgi_send_user_manual(struct client_state *csp,
978 struct http_response *rsp,
979 const struct map *parameters)
981 const char * filename;
983 jb_err err = JB_ERR_OK;
990 if (!parameters->first)
992 /* requested http://p.p/user-manual (without trailing slash) */
993 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
996 get_string_param(parameters, "file", &filename);
997 /* Check paramter for hack attempts */
998 if (filename && strchr(filename, '/'))
1000 return JB_ERR_CGI_PARAMS;
1002 if (filename && strstr(filename, ".."))
1004 return JB_ERR_CGI_PARAMS;
1007 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
1008 if (full_path == NULL)
1010 return JB_ERR_MEMORY;
1013 err = load_file(full_path, &rsp->body, &rsp->content_length);
1014 if (JB_ERR_OK != err)
1016 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1017 if (JB_ERR_FILE == err)
1019 err = cgi_error_no_template(csp, rsp, full_path);
1026 /* Guess correct Content-Type based on the filename's ending */
1029 length = strlen(filename);
1035 if((length>=4) && !strcmp(&filename[length-4], ".css"))
1037 err = enlist(rsp->headers, "Content-Type: text/css");
1039 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
1041 err = enlist(rsp->headers, "Content-Type: image/jpeg");
1045 err = enlist(rsp->headers, "Content-Type: text/html");
1052 /*********************************************************************
1054 * Function : cgi_show_version
1056 * Description : CGI function that returns a a web page describing the
1057 * file versions of Privoxy.
1060 * 1 : csp = Current client state (buffers, headers, etc...)
1061 * 2 : rsp = http_response data structure for output
1062 * 3 : parameters = map of cgi parameters
1064 * CGI Parameters : none
1066 * Returns : JB_ERR_OK on success
1067 * JB_ERR_MEMORY on out-of-memory error.
1069 *********************************************************************/
1070 jb_err cgi_show_version(struct client_state *csp,
1071 struct http_response *rsp,
1072 const struct map *parameters)
1074 struct map *exports;
1080 if (NULL == (exports = default_exports(csp, "show-version")))
1082 return JB_ERR_MEMORY;
1085 if (map(exports, "sourceversions", 1, show_rcs(), 0))
1088 return JB_ERR_MEMORY;
1091 return template_fill_for_cgi(csp, "show-version", exports, rsp);
1095 /*********************************************************************
1097 * Function : cgi_show_status
1099 * Description : CGI function that returns a web page describing the
1100 * current status of Privoxy.
1103 * 1 : csp = Current client state (buffers, headers, etc...)
1104 * 2 : rsp = http_response data structure for output
1105 * 3 : parameters = map of cgi parameters
1108 * file : Which file to show. Only first letter is checked,
1113 * Default is to show menu and other information.
1115 * Returns : JB_ERR_OK on success
1116 * JB_ERR_MEMORY on out-of-memory error.
1118 *********************************************************************/
1119 jb_err cgi_show_status(struct client_state *csp,
1120 struct http_response *rsp,
1121 const struct map *parameters)
1127 char buf[BUFFER_SIZE];
1128 #ifdef FEATURE_STATISTICS
1129 float perc_rej; /* Percentage of http requests rejected */
1130 int local_urls_read;
1131 int local_urls_rejected;
1132 #endif /* ndef FEATURE_STATISTICS */
1133 jb_err err = JB_ERR_OK;
1135 struct map *exports;
1141 if ('\0' != *(lookup(parameters, "file")))
1143 return cgi_show_file(csp, rsp, parameters);
1146 if (NULL == (exports = default_exports(csp, "show-status")))
1148 return JB_ERR_MEMORY;
1152 for (j = 0; (s != NULL) && (j < Argc); j++)
1154 if (!err) err = string_join (&s, html_encode(Argv[j]));
1155 if (!err) err = string_append(&s, " ");
1157 if (!err) err = map(exports, "invocation", 1, s, 0);
1159 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1160 if (!err) err = show_defines(exports);
1165 return JB_ERR_MEMORY;
1168 #ifdef FEATURE_STATISTICS
1169 local_urls_read = urls_read;
1170 local_urls_rejected = urls_rejected;
1173 * Need to alter the stats not to include the fetch of this
1176 * Can't do following thread safely! doh!
1179 * urls_rejected--; * This will be incremented subsequently *
1182 if (local_urls_read == 0)
1184 if (!err) err = map_block_killer(exports, "have-stats");
1188 if (!err) err = map_block_killer(exports, "have-no-stats");
1190 perc_rej = (float)local_urls_rejected * 100.0F /
1191 (float)local_urls_read;
1193 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1194 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1196 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1197 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1199 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1200 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1203 #else /* ndef FEATURE_STATISTICS */
1204 err = err || map_block_killer(exports, "statistics");
1205 #endif /* ndef FEATURE_STATISTICS */
1208 * List all action files in use, together with view and edit links,
1209 * except for standard.action, which should only be viewable. (Not
1210 * enforced in the editor itself)
1211 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1214 for (i = 0; i < MAX_AF_FILES; i++)
1216 if (csp->actions_list[i] != NULL)
1218 if (!err) err = string_append(&s, "<tr><td>");
1219 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1220 snprintf(buf, sizeof(buf),
1221 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1222 if (!err) err = string_append(&s, buf);
1224 #ifdef FEATURE_CGI_EDIT_ACTIONS
1225 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1226 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
1227 && (NULL != csp->config->actions_file_short[i]))
1230 if (access(csp->config->actions_file[i], W_OK) == 0)
1232 #endif /* def HAVE_ACCESS */
1233 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%d\">Edit</a>", i);
1234 if (!err) err = string_append(&s, buf);
1239 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
1241 #endif /* def HAVE_ACCESS */
1245 if (!err) err = string_append(&s, "</td></tr>\n");
1250 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1254 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1258 * List all re_filterfiles in use, together with view options.
1259 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1262 for (i = 0; i < MAX_AF_FILES; i++)
1264 if (csp->rlist[i] != NULL)
1266 if (!err) err = string_append(&s, "<tr><td>");
1267 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1269 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1270 if (!err) err = string_append(&s, buf);
1271 if (!err) err = string_append(&s, "</td></tr>\n");
1276 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1280 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1281 if (!err) err = map_block_killer(exports, "have-filterfile");
1284 #ifdef FEATURE_TRUST
1287 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1291 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1292 if (!err) err = map_block_killer(exports, "have-trustfile");
1295 if (!err) err = map_block_killer(exports, "trust-support");
1296 #endif /* ndef FEATURE_TRUST */
1298 #ifdef FEATURE_CGI_EDIT_ACTIONS
1299 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1301 err = map_block_killer(exports, "cgi-editor-is-disabled");
1303 #endif /* ndef CGI_EDIT_ACTIONS */
1308 return JB_ERR_MEMORY;
1311 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1315 /*********************************************************************
1317 * Function : cgi_show_url_info
1319 * Description : CGI function that determines and shows which actions
1320 * Privoxy will perform for a given url, and which
1321 * matches starting from the defaults have lead to that.
1324 * 1 : csp = Current client state (buffers, headers, etc...)
1325 * 2 : rsp = http_response data structure for output
1326 * 3 : parameters = map of cgi parameters
1329 * url : The url whose actions are to be determined.
1330 * If url is unset, the url-given conditional will be
1331 * set, so that all but the form can be suppressed in
1334 * Returns : JB_ERR_OK on success
1335 * JB_ERR_MEMORY on out-of-memory error.
1337 *********************************************************************/
1338 jb_err cgi_show_url_info(struct client_state *csp,
1339 struct http_response *rsp,
1340 const struct map *parameters)
1343 struct map *exports;
1350 if (NULL == (exports = default_exports(csp, "show-url-info")))
1352 return JB_ERR_MEMORY;
1356 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1358 url_param = strdup(lookup(parameters, "url"));
1359 if (url_param == NULL)
1362 return JB_ERR_MEMORY;
1367 * Handle prefixes. 4 possibilities:
1368 * 1) "http://" or "https://" prefix present and followed by URL - OK
1369 * 2) Only the "http://" or "https://" part is present, no URL - change
1370 * to empty string so it will be detected later as "no URL".
1371 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1373 * 4) Parameter not specified or is empty string - let this fall through
1374 * for now, next block of code will handle it.
1376 if (0 == strncmp(url_param, "http://", 7))
1378 if (url_param[7] == '\0')
1381 * Empty URL (just prefix).
1382 * Make it totally empty so it's caught by the next if()
1384 url_param[0] = '\0';
1387 else if (0 == strncmp(url_param, "https://", 8))
1389 if (url_param[8] == '\0')
1392 * Empty URL (just prefix).
1393 * Make it totally empty so it's caught by the next if()
1395 url_param[0] = '\0';
1398 else if (url_param[0] != '\0')
1401 * Unknown prefix - assume http://
1403 const size_t url_param_prefixed_size = 7 + 1 + strlen(url_param);
1404 char * url_param_prefixed = malloc(url_param_prefixed_size);
1405 if (NULL == url_param_prefixed)
1409 return JB_ERR_MEMORY;
1411 strlcpy(url_param_prefixed, "http://", url_param_prefixed_size);
1412 strlcat(url_param_prefixed, url_param, url_param_prefixed_size);
1414 url_param = url_param_prefixed;
1418 * Hide "toggle off" warning if Privoxy is toggled on.
1421 #ifdef FEATURE_TOGGLE
1422 (global_toggle_state == 1) &&
1423 #endif /* def FEATURE_TOGGLE */
1424 map_block_killer(exports, "privoxy-is-toggled-off")
1428 return JB_ERR_MEMORY;
1431 if (url_param[0] == '\0')
1433 /* URL paramater not specified, display query form only. */
1435 if (map_block_killer(exports, "url-given")
1436 || map(exports, "url", 1, "", 1))
1439 return JB_ERR_MEMORY;
1444 /* Given a URL, so query it. */
1449 struct file_list *fl;
1450 struct url_actions *b;
1451 struct http_request url_to_query[1];
1452 struct current_action_spec action[1];
1455 if (map(exports, "url", 1, html_encode(url_param), 0))
1459 return JB_ERR_MEMORY;
1462 init_current_action(action);
1464 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1466 free_current_action(action);
1469 return JB_ERR_MEMORY;
1472 memset(url_to_query, '\0', sizeof(url_to_query));
1473 err = parse_http_url(url_param, url_to_query, csp);
1474 assert(url_to_query->ssl == !strncmp(url_param, "https://", 8));
1478 if (err == JB_ERR_MEMORY)
1480 free_http_request(url_to_query);
1481 free_current_action(action);
1483 return JB_ERR_MEMORY;
1489 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1490 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1491 if (!err) err = map_block_killer(exports, "valid-url");
1493 free_current_action(action);
1494 free_http_request(url_to_query);
1499 return JB_ERR_MEMORY;
1502 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1506 * We have a warning about SSL paths. Hide it for unencrypted sites.
1508 if (!url_to_query->ssl)
1510 if (map_block_killer(exports, "https"))
1512 free_current_action(action);
1514 free_http_request(url_to_query);
1515 return JB_ERR_MEMORY;
1519 matches = strdup("<table summary=\"\" class=\"transparent\">");
1521 for (i = 0; i < MAX_AF_FILES; i++)
1523 if (NULL == csp->config->actions_file_short[i]
1524 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1528 if ((fl = csp->actions_list[i]) != NULL)
1530 if ((b = fl->f) != NULL)
1532 /* FIXME: Hardcoded HTML! */
1533 string_append(&matches, "<tr><th>In file: ");
1534 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1535 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1536 string_append(&matches, buf);
1537 string_append(&matches, "View</a>");
1538 #ifdef FEATURE_CGI_EDIT_ACTIONS
1539 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1542 if (access(csp->config->actions_file[i], W_OK) == 0)
1544 #endif /* def HAVE_ACCESS */
1545 snprintf(buf, sizeof(buf),
1546 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1547 string_append(&matches, buf);
1548 string_append(&matches, "Edit</a>");
1553 string_append(&matches, " <strong>No write access.</strong>");
1555 #endif /* def HAVE_ACCESS */
1557 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1559 string_append(&matches, "</th></tr>\n");
1566 for (; (b != NULL) && (matches != NULL); b = b->next)
1568 if (url_match(b->url, url_to_query))
1570 string_append(&matches, "<tr><td>{");
1571 string_join (&matches, actions_to_html(csp, b->action));
1572 string_append(&matches, " }<br>\n<code>");
1573 string_join (&matches, html_encode(b->url->spec));
1574 string_append(&matches, "</code></td></tr>\n");
1576 if (merge_current_action(action, b->action))
1579 free_http_request(url_to_query);
1580 free_current_action(action);
1582 return JB_ERR_MEMORY;
1590 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1593 string_append(&matches, "</table>\n");
1596 * XXX: Kludge to make sure the "Forward settings" section
1597 * shows what forward-override{} would do with the requested URL.
1598 * No one really cares how the CGI request would be forwarded
1599 * if it wasn't intercepted as CGI request in the first place.
1601 * From here on the action bitmask will no longer reflect
1602 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1603 * but luckily it's no longer required later on anyway.
1605 free_current_action(csp->action);
1606 get_url_actions(csp, url_to_query);
1609 * Fill in forwarding settings.
1611 * The possibilities are:
1613 * - http forwarding only
1614 * - socks4(a) forwarding only
1615 * - socks4(a) and http forwarding.
1617 * XXX: Parts of this code could be reused for the
1618 * "forwarding-failed" template which currently doesn't
1619 * display the proxy port and an eventual second forwarder.
1622 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1624 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1626 if (!err) err = map_block_killer(exports, "socks-forwarder");
1627 if (!err) err = map_block_killer(exports, "http-forwarder");
1631 char port[10]; /* We save proxy ports as int but need a string here */
1633 if (!err) err = map_block_killer(exports, "no-forwarder");
1635 if (fwd->gateway_host != NULL)
1637 char *socks_type = NULL;
1642 socks_type = "socks4";
1645 socks_type = "socks4a";
1648 socks_type = "socks5";
1651 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1654 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1655 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1656 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1657 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1661 if (!err) err = map_block_killer(exports, "socks-forwarder");
1664 if (fwd->forward_host != NULL)
1666 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1667 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1668 if (!err) err = map(exports, "forward-port", 1, port, 1);
1672 if (!err) err = map_block_killer(exports, "http-forwarder");
1677 free_http_request(url_to_query);
1679 if (err || matches == NULL)
1681 free_current_action(action);
1683 return JB_ERR_MEMORY;
1686 #ifdef FEATURE_CGI_EDIT_ACTIONS
1687 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1689 err = map_block_killer(exports, "cgi-editor-is-disabled");
1691 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1694 * If zlib support is available, if no content filters
1695 * are enabled or if the prevent-compression action is enabled,
1696 * suppress the "compression could prevent filtering" warning.
1698 #ifndef FEATURE_ZLIB
1699 if (!content_filters_enabled(action) ||
1700 (action->flags & ACTION_NO_COMPRESSION))
1703 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1706 if (err || map(exports, "matches", 1, matches , 0))
1708 free_current_action(action);
1710 return JB_ERR_MEMORY;
1713 s = current_action_to_html(csp, action);
1715 free_current_action(action);
1717 if (map(exports, "final", 1, s, 0))
1720 return JB_ERR_MEMORY;
1724 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1728 /*********************************************************************
1730 * Function : cgi_robots_txt
1732 * Description : CGI function to return "/robots.txt".
1735 * 1 : csp = Current client state (buffers, headers, etc...)
1736 * 2 : rsp = http_response data structure for output
1737 * 3 : parameters = map of cgi parameters
1739 * CGI Parameters : None
1741 * Returns : JB_ERR_OK on success
1742 * JB_ERR_MEMORY on out-of-memory error.
1744 *********************************************************************/
1745 jb_err cgi_robots_txt(struct client_state *csp,
1746 struct http_response *rsp,
1747 const struct map *parameters)
1753 "# This is the Privoxy control interface.\n"
1754 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1760 if (rsp->body == NULL)
1762 return JB_ERR_MEMORY;
1765 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1769 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1770 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1772 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1776 /*********************************************************************
1778 * Function : show_defines
1780 * Description : Add to a map the state od all conditional #defines
1781 * used when building
1784 * 1 : exports = map to extend
1786 * Returns : JB_ERR_OK on success
1787 * JB_ERR_MEMORY on out-of-memory error.
1789 *********************************************************************/
1790 static jb_err show_defines(struct map *exports)
1792 jb_err err = JB_ERR_OK;
1795 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1796 #else /* ifndef FEATURE_ACL */
1797 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1798 #endif /* ndef FEATURE_ACL */
1800 #ifdef FEATURE_CGI_EDIT_ACTIONS
1801 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1802 #else /* ifndef FEATURE_COOKIE_JAR */
1803 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1804 #endif /* ndef FEATURE_COOKIE_JAR */
1806 #ifdef FEATURE_COOKIE_JAR
1807 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1808 #else /* ifndef FEATURE_COOKIE_JAR */
1809 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1810 #endif /* ndef FEATURE_COOKIE_JAR */
1812 #ifdef FEATURE_FAST_REDIRECTS
1813 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1814 #else /* ifndef FEATURE_FAST_REDIRECTS */
1815 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1816 #endif /* ndef FEATURE_FAST_REDIRECTS */
1818 #ifdef FEATURE_FORCE_LOAD
1819 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1820 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1821 #else /* ifndef FEATURE_FORCE_LOAD */
1822 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1823 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1824 #endif /* ndef FEATURE_FORCE_LOAD */
1826 #ifdef FEATURE_GRACEFUL_TERMINATION
1827 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1828 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1829 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1830 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1832 #ifdef FEATURE_IMAGE_BLOCKING
1833 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1834 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1835 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1836 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1838 #ifdef FEATURE_IMAGE_DETECT_MSIE
1839 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1840 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1841 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1842 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1844 #ifdef FEATURE_NO_GIFS
1845 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1846 #else /* ifndef FEATURE_NO_GIFS */
1847 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1848 #endif /* ndef FEATURE_NO_GIFS */
1850 #ifdef FEATURE_PTHREAD
1851 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1852 #else /* ifndef FEATURE_PTHREAD */
1853 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1854 #endif /* ndef FEATURE_PTHREAD */
1856 #ifdef FEATURE_STATISTICS
1857 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1858 #else /* ifndef FEATURE_STATISTICS */
1859 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1860 #endif /* ndef FEATURE_STATISTICS */
1862 #ifdef FEATURE_TOGGLE
1863 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1864 #else /* ifndef FEATURE_TOGGLE */
1865 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1866 #endif /* ndef FEATURE_TOGGLE */
1868 #ifdef FEATURE_TRUST
1869 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1870 #else /* ifndef FEATURE_TRUST */
1871 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1872 #endif /* ndef FEATURE_TRUST */
1875 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1876 #else /* ifndef FEATURE_ZLIB */
1877 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1878 #endif /* ndef FEATURE_ZLIB */
1881 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1882 #else /* ifndef STATIC_PCRE */
1883 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1884 #endif /* ndef STATIC_PCRE */
1887 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1888 #else /* ifndef STATIC_PCRS */
1889 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1890 #endif /* ndef STATIC_PCRS */
1896 /*********************************************************************
1898 * Function : show_rcs
1900 * Description : Create a string with the rcs info for all sourcefiles
1904 * Returns : A string, or NULL on out-of-memory.
1906 *********************************************************************/
1907 static char *show_rcs(void)
1909 char *result = strdup("");
1910 char buf[BUFFER_SIZE];
1912 /* Instead of including *all* dot h's in the project (thus creating a
1913 * tremendous amount of dependencies), I will concede to declaring them
1914 * as extern's. This forces the developer to add to this list, but oh well.
1917 #define SHOW_RCS(__x) \
1919 extern const char __x[]; \
1920 snprintf(buf, sizeof(buf), " %s\n", __x); \
1921 string_append(&result, buf); \
1924 /* In alphabetical order */
1925 SHOW_RCS(actions_h_rcs)
1926 SHOW_RCS(actions_rcs)
1928 SHOW_RCS(amiga_h_rcs)
1930 #endif /* def AMIGA */
1933 #ifdef FEATURE_CGI_EDIT_ACTIONS
1934 SHOW_RCS(cgiedit_h_rcs)
1935 SHOW_RCS(cgiedit_rcs)
1936 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1937 SHOW_RCS(cgisimple_h_rcs)
1938 SHOW_RCS(cgisimple_rcs)
1940 SHOW_RCS(cygwin_h_rcs)
1942 SHOW_RCS(deanimate_h_rcs)
1943 SHOW_RCS(deanimate_rcs)
1944 SHOW_RCS(encode_h_rcs)
1945 SHOW_RCS(encode_rcs)
1946 SHOW_RCS(errlog_h_rcs)
1947 SHOW_RCS(errlog_rcs)
1948 SHOW_RCS(filters_h_rcs)
1949 SHOW_RCS(filters_rcs)
1950 SHOW_RCS(gateway_h_rcs)
1951 SHOW_RCS(gateway_rcs)
1952 SHOW_RCS(jbsockets_h_rcs)
1953 SHOW_RCS(jbsockets_rcs)
1956 SHOW_RCS(list_h_rcs)
1958 SHOW_RCS(loadcfg_h_rcs)
1959 SHOW_RCS(loadcfg_rcs)
1960 SHOW_RCS(loaders_h_rcs)
1961 SHOW_RCS(loaders_rcs)
1962 SHOW_RCS(miscutil_h_rcs)
1963 SHOW_RCS(miscutil_rcs)
1964 SHOW_RCS(parsers_h_rcs)
1965 SHOW_RCS(parsers_rcs)
1967 SHOW_RCS(pcrs_h_rcs)
1968 SHOW_RCS(project_h_rcs)
1969 SHOW_RCS(ssplit_h_rcs)
1970 SHOW_RCS(ssplit_rcs)
1971 SHOW_RCS(urlmatch_h_rcs)
1972 SHOW_RCS(urlmatch_rcs)
1974 #ifndef _WIN_CONSOLE
1975 SHOW_RCS(w32log_h_rcs)
1976 SHOW_RCS(w32log_rcs)
1977 SHOW_RCS(w32res_h_rcs)
1978 SHOW_RCS(w32taskbar_h_rcs)
1979 SHOW_RCS(w32taskbar_rcs)
1980 #endif /* ndef _WIN_CONSOLE */
1981 SHOW_RCS(win32_h_rcs)
1983 #endif /* def _WIN32 */
1992 /*********************************************************************
1994 * Function : cgi_show_file
1996 * Description : CGI function that shows the content of a
1997 * configuration file.
2000 * 1 : csp = Current client state (buffers, headers, etc...)
2001 * 2 : rsp = http_response data structure for output
2002 * 3 : parameters = map of cgi parameters
2005 * file : Which file to show. Only first letter is checked,
2010 * Default is to show menu and other information.
2012 * Returns : JB_ERR_OK on success
2013 * JB_ERR_MEMORY on out-of-memory error.
2015 *********************************************************************/
2016 static jb_err cgi_show_file(struct client_state *csp,
2017 struct http_response *rsp,
2018 const struct map *parameters)
2021 const char * filename = NULL;
2022 char * file_description = NULL;
2028 switch (*(lookup(parameters, "file")))
2031 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2033 filename = csp->actions_list[i]->filename;
2034 file_description = "Actions File";
2039 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2041 filename = csp->rlist[i]->filename;
2042 file_description = "Filter File";
2046 #ifdef FEATURE_TRUST
2050 filename = csp->tlist->filename;
2051 file_description = "Trust File";
2054 #endif /* def FEATURE_TRUST */
2057 if (NULL != filename)
2059 struct map *exports;
2064 exports = default_exports(csp, "show-status");
2065 if (NULL == exports)
2067 return JB_ERR_MEMORY;
2070 if ( map(exports, "file-description", 1, file_description, 1)
2071 || map(exports, "filepath", 1, html_encode(filename), 0) )
2074 return JB_ERR_MEMORY;
2077 err = load_file(filename, &s, &length);
2078 if (JB_ERR_OK != err)
2080 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2083 return JB_ERR_MEMORY;
2088 s = html_encode_and_free_original(s);
2091 return JB_ERR_MEMORY;
2094 if (map(exports, "contents", 1, s, 0))
2097 return JB_ERR_MEMORY;
2101 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2104 return JB_ERR_CGI_PARAMS;
2108 /*********************************************************************
2110 * Function : load_file
2112 * Description : Loads a file into a buffer.
2115 * 1 : filename = Name of the file to be loaded.
2116 * 2 : buffer = Used to return the file's content.
2117 * 3 : length = Used to return the size of the file.
2119 * Returns : JB_ERR_OK in case of success,
2120 * JB_ERR_FILE in case of ordinary file loading errors
2121 * (fseek() and ftell() errors are fatal)
2122 * JB_ERR_MEMORY in case of out-of-memory.
2124 *********************************************************************/
2125 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2129 jb_err err = JB_ERR_OK;
2131 fp = fopen(filename, "rb");
2137 /* Get file length */
2138 if (fseek(fp, 0, SEEK_END))
2140 log_error(LOG_LEVEL_FATAL,
2141 "Unexpected erro while fseek()ing to the end of %s: %E",
2147 log_error(LOG_LEVEL_FATAL,
2148 "Unexpected ftell() error while loading %s: %E",
2151 *length = (size_t)ret;
2153 /* Go back to the beginning. */
2154 if (fseek(fp, 0, SEEK_SET))
2156 log_error(LOG_LEVEL_FATAL,
2157 "Unexpected error while fseek()ing to the beginning of %s: %E",
2161 *buffer = (char *)zalloc(*length + 1);
2162 if (NULL == *buffer)
2164 err = JB_ERR_MEMORY;
2166 else if (!fread(*buffer, *length, 1, fp))
2169 * May happen if the file size changes between fseek() and
2170 * fread(). If it does, we just log it and serve what we got.
2172 log_error(LOG_LEVEL_ERROR,
2173 "Couldn't completely read file %s.", filename);