1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.82 2008/05/10 20:01:47 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.82 2008/05/10 20:01:47 fabiankeil
40 * Fix an assertion that could erroneously
41 * trigger in case of memory shortage.
43 * Revision 1.81 2008/05/05 09:54:39 fabiankeil
44 * In cgi_show_url_info(), make sure ftp URLs are
45 * declared invalid. Also simplify the code that adds
46 * "http://" if no protocol has been specified.
48 * Revision 1.80 2008/05/04 16:18:32 fabiankeil
49 * Provide parse_http_url() with a third parameter to specify
50 * whether or not URLs without protocol are acceptable.
52 * Revision 1.79 2008/05/04 13:30:56 fabiankeil
53 * Streamline parse_http_url()'s prototype.
55 * Revision 1.78 2008/05/03 16:50:11 fabiankeil
56 * Leverage content_filters_enabled() in cgi_show_url_info().
58 * Revision 1.77 2008/05/02 09:47:48 fabiankeil
59 * In cgi_show_url_info, pass an initialized http structure
60 * to parse_http_url() as that will be required soonish and
61 * assert that https URLs are recognized correctly.
63 * Revision 1.76 2008/04/28 09:13:30 fabiankeil
64 * In load_file(), remember the error reason and fclose()
65 * and return later on instead of right away.
67 * Revision 1.75 2008/04/27 13:52:52 fabiankeil
68 * Move CGI file loading code into load_file() and
69 * add checks for unexpected errors.
71 * Revision 1.74 2008/04/26 15:50:56 fabiankeil
72 * Fix macro name in cgi_show_file() error path.
74 * Revision 1.73 2008/04/26 12:21:55 fabiankeil
75 * Forget about JB_ERR_PARSE. JB_ERR_CGI_PARAMS to the rescue.
77 * Revision 1.72 2008/04/26 10:34:15 fabiankeil
78 * If zlib support is unavailable and there are content filters active
79 * but the prevent-compression action is disabled, include a warning
80 * on the show-url-info page that compression might prevent filtering.
82 * Revision 1.71 2008/04/25 13:33:56 fabiankeil
83 * - Factor cgi_show_file() out of cgi_show_status().
84 * - Adjust cgi_show_status()'s parameter description to match reality.
86 * Revision 1.70 2008/04/24 16:12:38 fabiankeil
87 * In cgi_show_status(), load the requested file at once.
88 * Using string_join() for every line really doesn't scale.
90 * Revision 1.69 2008/04/17 14:40:48 fabiankeil
91 * Provide get_http_time() with the buffer size so it doesn't
92 * have to blindly assume that the buffer is big enough.
94 * Revision 1.68 2008/03/27 18:27:21 fabiankeil
95 * Remove kill-popups action.
97 * Revision 1.67 2008/03/27 17:00:05 fabiankeil
98 * Turn the favicon blobs into locals.
100 * Revision 1.66 2008/02/23 16:57:12 fabiankeil
101 * Rename url_actions() to get_url_actions() and let it
102 * use the standard parameter ordering.
104 * Revision 1.65 2008/02/23 16:33:43 fabiankeil
105 * Let forward_url() use the standard parameter ordering
106 * and mark its second parameter immutable.
108 * Revision 1.64 2008/02/03 13:56:07 fabiankeil
109 * Add SOCKS5 support for show-url-info CGI page.
111 * Revision 1.63 2008/02/01 06:04:31 fabiankeil
112 * If edit buttons on the show-url-info CGI page are hidden, explain why.
114 * Revision 1.62 2008/02/01 05:52:40 fabiankeil
115 * Hide edit buttons on the show-url-info CGI page if enable-edit-action
116 * is disabled. Patch by Lee with additional white space adjustments.
118 * Revision 1.61 2008/01/26 11:13:25 fabiankeil
119 * If enable-edit-actions is disabled, hide the edit buttons and explain why.
121 * Revision 1.60 2007/10/27 13:12:13 fabiankeil
122 * Finish 1.49 and check write access before
123 * showing edit buttons on show-url-info page.
125 * Revision 1.59 2007/10/19 16:42:36 fabiankeil
126 * Plug memory leak I introduced five months ago.
127 * Yay Valgrind and Privoxy-Regression-Test.
129 * Revision 1.58 2007/07/21 12:19:50 fabiankeil
130 * If show-url-info is called with an URL that Privoxy
131 * would reject as invalid, don't show unresolved forwarding
132 * variables, "final matches" or claim the site's secure.
134 * Revision 1.57 2007/06/01 16:53:05 fabiankeil
135 * Adjust cgi_show_url_info() to show what forward-override{}
136 * would do with the requested URL (instead of showing how the
137 * request for the CGI page would be forwarded if it wasn't a
140 * Revision 1.56 2007/05/21 10:50:35 fabiankeil
141 * - Use strlcpy() instead of strcpy().
142 * - Stop treating actions files special. Expect a complete file name
143 * (with or without path) like it's done for the rest of the files.
145 * - Don't rerun sed() in cgi_show_request().
147 * Revision 1.55 2007/04/13 13:36:46 fabiankeil
148 * Reference action files in CGI URLs by id instead
149 * of using the first part of the file name.
150 * Fixes BR 1694250 and BR 1590556.
152 * Revision 1.54 2007/04/09 18:11:35 fabiankeil
153 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
155 * Revision 1.53 2007/04/08 13:21:04 fabiankeil
156 * Reference action files in CGI URLs by id instead
157 * of using the first part of the file name.
158 * Fixes BR 1694250 and BR 1590556.
160 * Revision 1.52 2007/02/13 15:10:26 fabiankeil
161 * Apparently fopen()ing in "binary" mode doesn't require
162 * #ifdefs, it's already done without them in cgiedit.c.
164 * Revision 1.51 2007/02/10 16:55:22 fabiankeil
165 * - Show forwarding settings on the show-url-info page
166 * - Fix some HTML syntax errors.
168 * Revision 1.50 2007/01/23 15:51:17 fabiankeil
169 * Add favicon delivery functions.
171 * Revision 1.49 2007/01/20 16:29:38 fabiankeil
172 * Suppress edit buttons for action files if Privoxy has
173 * no write access. Suggested by Roland in PR 1564026.
175 * Revision 1.48 2007/01/20 15:31:31 fabiankeil
176 * Display warning if show-url-info CGI page
177 * is used while Privoxy is toggled off.
179 * Revision 1.47 2007/01/12 15:07:10 fabiankeil
180 * Use zalloc in cgi_send_user_manual.
182 * Revision 1.46 2007/01/02 12:49:46 fabiankeil
183 * Add FEATURE_ZLIB to the list of conditional
184 * defines at the show-status page.
186 * Revision 1.45 2006/12/28 18:16:41 fabiankeil
187 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
188 * body memory before using it, replaced sprintf calls with snprintf.
190 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
191 * Removed checks whether or not AF_FILES have
192 * data structures associated with them in cgi_show_status.
193 * It doesn't matter as we're only interested in the file names.
195 * For the action files the checks were always true,
196 * but they prevented empty filter files from being
197 * listed. Fixes parts of BR 1619208.
199 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
200 * - Added FEATURE_GRACEFUL_TERMINATION to the
201 * "conditional #defines" section
202 * - Escaped ampersands in generated HTML.
203 * - Renamed re-filter-filename to re-filter-filenames
205 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
206 * Add special treatment for WIN32 to make sure
207 * cgi_send_user_manual opens the files in binary mode.
208 * Fixes BR 1600411 and unbreaks image delivery.
210 * Remove outdated comment.
212 * Revision 1.41 2006/10/09 19:18:28 roro
213 * Redirect http://p.p/user-manual (without trailing slash) to
214 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
216 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
217 * Modified cgi_send_user_manual to serve binary
218 * content without destroying it first. Should also be
219 * faster now. Added ".jpg" check for Content-Type guessing.
221 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
222 * Deliver documents in the user-manual directory
223 * with "Content-Type text/css" if their filename
226 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
227 * Incorporate modified version of Roland Rosenfeld's patch to
228 * optionally access the user-manual via Privoxy. Closes patch 679075.
230 * Formatting changed to Privoxy style, added call to
231 * cgi_error_no_template if the requested file doesn't
232 * exist and modified check whether or not Privoxy itself
233 * should serve the manual. Should work cross-platform now.
235 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
236 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
237 * with what was really the latest development (the v_3_0_branch branch)
239 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
240 * Multiple filter file support
242 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
243 * Undo some damaging memory leak patches
245 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
246 * A few memory leaks plugged (mostly on error paths)
248 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
249 * Another instance of:
250 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
251 * Thanks to Magnus Holmgren for the patch
253 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
254 * - Prevent line wrap beween "View/Edit" link buttons on status page
255 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
257 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
258 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
260 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
261 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
263 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
264 * Applying patch from Andreas as provided by Hal on the list.
265 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
267 * Revision 1.35 2002/05/12 21:44:44 jongfoster
268 * Adding amiga.[ch] revision information, if on an amiga.
270 * Revision 1.34 2002/04/30 12:06:12 oes
271 * Deleted unused code from default_cgi
273 * Revision 1.33 2002/04/30 11:14:52 oes
274 * Made csp the first parameter in *action_to_html
276 * Revision 1.32 2002/04/26 18:29:13 jongfoster
277 * Fixing this Visual C++ warning:
278 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
280 * Revision 1.31 2002/04/26 12:54:36 oes
281 * - Kill obsolete REDIRECT_URL code
282 * - Error handling fixes
283 * - Style sheet related HTML snipplet changes
284 * - cgi_show_url_info:
285 * - Matches now in table, actions on single lines,
287 * - standard.action suppressed
288 * - Buttons to View and Edit AFs
290 * Revision 1.30 2002/04/24 02:18:08 oes
291 * - show-status is now the starting point for editing
292 * the actions files, generate list of all AFs with buttons
293 * for viewing and editing, new look for file list (Jon:
294 * buttons now aligned ;-P ), view mode now supports multiple
295 * AFs, name changes, no view links for unspecified files,
296 * no edit link for standard.action.
298 * - Jon's multiple AF patch: cgi_show_url_info now uses all
299 * AFs and marks the output accordingly
301 * Revision 1.29 2002/04/10 13:38:35 oes
302 * load_template signature changed
304 * Revision 1.28 2002/04/07 15:42:12 jongfoster
305 * Fixing send-banner?type=auto when the image-blocker is
306 * a redirect to send-banner
308 * Revision 1.27 2002/04/05 15:50:48 oes
309 * added send-stylesheet CGI
311 * Revision 1.26 2002/04/04 00:36:36 gliptak
312 * always use pcre for matching
314 * Revision 1.25 2002/04/03 22:28:03 gliptak
315 * Removed references to gnu_regex
317 * Revision 1.24 2002/04/02 16:12:47 oes
318 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
320 * Revision 1.23 2002/03/26 22:29:54 swa
321 * we have a new homepage!
323 * Revision 1.22 2002/03/24 16:18:15 jongfoster
326 * Revision 1.21 2002/03/24 15:23:33 jongfoster
329 * Revision 1.20 2002/03/24 13:25:43 swa
330 * name change related issues
332 * Revision 1.19 2002/03/16 23:54:06 jongfoster
333 * Adding graceful termination feature, to help look for memory leaks.
334 * If you enable this (which, by design, has to be done by hand
335 * editing config.h) and then go to http://i.j.b/die, then the program
336 * will exit cleanly after the *next* request. It should free all the
337 * memory that was used.
339 * Revision 1.18 2002/03/12 01:44:49 oes
340 * Changed default for "blocked" image from jb logo to checkboard pattern
342 * Revision 1.17 2002/03/08 16:43:18 oes
343 * Added choice beween GIF and PNG built-in images
345 * Revision 1.16 2002/03/07 03:48:38 oes
346 * - Changed built-in images from GIF to PNG
347 * (with regard to Unisys patent issue)
348 * - Added a 4x4 pattern PNG which is less intrusive
349 * than the logo but also clearly marks the deleted banners
351 * Revision 1.15 2002/03/06 22:54:35 jongfoster
352 * Automated function-comment nitpicking.
354 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
355 * Clean up a little CRLF unpleasantness that suddenly appeared
357 * Revision 1.13 2002/02/21 00:10:37 jongfoster
358 * Adding send-banner?type=auto option
360 * Revision 1.12 2002/01/23 01:03:32 jongfoster
361 * Fixing gcc [CygWin] compiler warnings
363 * Revision 1.11 2002/01/23 00:01:04 jongfoster
364 * Adding cgi_transparent_gif() for http://i.j.b/t
365 * Adding missing html_encode() to many CGI functions.
366 * Adding urlmatch.[ch] to http://i.j.b/show-version
368 * Revision 1.10 2002/01/17 21:10:37 jongfoster
369 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
370 * Also fixing a problem in the same function with improperly quoted URLs
371 * in output HTML, and adding code to handle https:// URLs correctly.
373 * Revision 1.9 2001/11/30 23:09:15 jongfoster
374 * Now reports on FEATURE_CGI_EDIT_ACTIONS
375 * Removing FEATURE_DENY_GZIP from template
377 * Revision 1.8 2001/11/13 00:14:07 jongfoster
378 * Fixing stupid bug now I've figured out what || means.
379 * (It always returns 0 or 1, not one of it's paramaters.)
381 * Revision 1.7 2001/10/23 21:48:19 jongfoster
382 * Cleaning up error handling in CGI functions - they now send back
383 * a HTML error page and should never cause a FATAL error. (Fixes one
384 * potential source of "denial of service" attacks).
386 * CGI actions file editor that works and is actually useful.
388 * Ability to toggle JunkBuster remotely using a CGI call.
390 * You can turn off both the above features in the main configuration
391 * file, e.g. if you are running a multi-user proxy.
393 * Revision 1.6 2001/10/14 22:00:32 jongfoster
394 * Adding support for a 404 error when an invalid CGI page is requested.
396 * Revision 1.5 2001/10/07 15:30:41 oes
397 * Removed FEATURE_DENY_GZIP
399 * Revision 1.4 2001/10/02 15:31:12 oes
400 * Introduced show-request cgi
402 * Revision 1.3 2001/09/22 16:34:44 jongfoster
403 * Removing unneeded #includes
405 * Revision 1.2 2001/09/19 18:01:11 oes
406 * Fixed comments; cosmetics
408 * Revision 1.1 2001/09/16 17:08:54 jongfoster
409 * Moving simple CGI functions from cgi.c to new file cgisimple.c
412 **********************************************************************/
418 #include <sys/types.h>
426 #endif /* def HAVE_ACCESS */
430 #include "cgisimple.h"
436 #include "miscutil.h"
439 #include "urlmatch.h"
442 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
444 static char *show_rcs(void);
445 static jb_err show_defines(struct map *exports);
446 static jb_err cgi_show_file(struct client_state *csp,
447 struct http_response *rsp,
448 const struct map *parameters);
449 static jb_err load_file(const char *filename, char **buffer, size_t *length);
451 /*********************************************************************
453 * Function : cgi_default
455 * Description : CGI function that is called for the CGI_SITE_1_HOST
456 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
457 * Boring - only exports the default exports.
460 * 1 : csp = Current client state (buffers, headers, etc...)
461 * 2 : rsp = http_response data structure for output
462 * 3 : parameters = map of cgi parameters
464 * CGI Parameters : none
466 * Returns : JB_ERR_OK on success
467 * JB_ERR_MEMORY on out-of-memory
469 *********************************************************************/
470 jb_err cgi_default(struct client_state *csp,
471 struct http_response *rsp,
472 const struct map *parameters)
479 if (NULL == (exports = default_exports(csp, "")))
481 return JB_ERR_MEMORY;
484 return template_fill_for_cgi(csp, "default", exports, rsp);
488 /*********************************************************************
490 * Function : cgi_error_404
492 * Description : CGI function that is called if an unknown action was
496 * 1 : csp = Current client state (buffers, headers, etc...)
497 * 2 : rsp = http_response data structure for output
498 * 3 : parameters = map of cgi parameters
500 * CGI Parameters : none
502 * Returns : JB_ERR_OK on success
503 * JB_ERR_MEMORY on out-of-memory error.
505 *********************************************************************/
506 jb_err cgi_error_404(struct client_state *csp,
507 struct http_response *rsp,
508 const struct map *parameters)
516 if (NULL == (exports = default_exports(csp, NULL)))
518 return JB_ERR_MEMORY;
521 rsp->status = strdup("404 Privoxy configuration page not found");
522 if (rsp->status == NULL)
525 return JB_ERR_MEMORY;
528 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
532 #ifdef FEATURE_GRACEFUL_TERMINATION
533 /*********************************************************************
537 * Description : CGI function to shut down Privoxy.
538 * NOTE: Turning this on in a production build
539 * would be a BAD idea. An EXTREMELY BAD idea.
540 * In short, don't do it.
543 * 1 : csp = Current client state (buffers, headers, etc...)
544 * 2 : rsp = http_response data structure for output
545 * 3 : parameters = map of cgi parameters
547 * CGI Parameters : none
549 * Returns : JB_ERR_OK on success
550 * JB_ERR_MEMORY on out-of-memory error.
552 *********************************************************************/
553 jb_err cgi_die (struct client_state *csp,
554 struct http_response *rsp,
555 const struct map *parameters)
565 * I don't really care what gets sent back to the browser.
566 * Take the easy option - "out of memory" page.
569 return JB_ERR_MEMORY;
571 #endif /* def FEATURE_GRACEFUL_TERMINATION */
574 /*********************************************************************
576 * Function : cgi_show_request
578 * Description : Show the client's request and what sed() would have
582 * 1 : csp = Current client state (buffers, headers, etc...)
583 * 2 : rsp = http_response data structure for output
584 * 3 : parameters = map of cgi parameters
586 * CGI Parameters : none
588 * Returns : JB_ERR_OK on success
589 * JB_ERR_MEMORY on out-of-memory error.
591 *********************************************************************/
592 jb_err cgi_show_request(struct client_state *csp,
593 struct http_response *rsp,
594 const struct map *parameters)
603 if (NULL == (exports = default_exports(csp, "show-request")))
605 return JB_ERR_MEMORY;
609 * Repair the damage done to the IOB by get_header()
611 for (p = csp->iob->buf; p < csp->iob->eod; p++)
613 if (*p == '\0') *p = '\n';
617 * Export the original client's request and the one we would
618 * be sending to the server if this wasn't a CGI call
621 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
624 return JB_ERR_MEMORY;
627 if (map(exports, "processed-request", 1,
628 html_encode_and_free_original(list_to_text(csp->headers)), 0))
631 return JB_ERR_MEMORY;
634 return template_fill_for_cgi(csp, "show-request", exports, rsp);
638 /*********************************************************************
640 * Function : cgi_send_banner
642 * Description : CGI function that returns a banner.
645 * 1 : csp = Current client state (buffers, headers, etc...)
646 * 2 : rsp = http_response data structure for output
647 * 3 : parameters = map of cgi parameters
650 * type : Selects the type of banner between "trans", "logo",
651 * and "auto". Defaults to "logo" if absent or invalid.
652 * "auto" means to select as if we were image-blocking.
653 * (Only the first character really counts; b and t are
656 * Returns : JB_ERR_OK on success
657 * JB_ERR_MEMORY on out-of-memory error.
659 *********************************************************************/
660 jb_err cgi_send_banner(struct client_state *csp,
661 struct http_response *rsp,
662 const struct map *parameters)
664 char imagetype = lookup(parameters, "type")[0];
667 * If type is auto, then determine the right thing
668 * to do from the set-image-blocker action
670 if (imagetype == 'a')
677 #ifdef FEATURE_IMAGE_BLOCKING
678 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
680 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
681 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
682 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
686 /* Use default - nothing to do here. */
688 else if (0 == strcmpic(p, "blank"))
692 else if (0 == strcmpic(p, "pattern"))
698 * If the action is to call this CGI, determine
701 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
703 imagetype = p[sizeof(prefix1) - 1];
705 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
707 imagetype = p[sizeof(prefix2) - 1];
711 * Everything else must (should) be a URL to
719 #endif /* def FEATURE_IMAGE_BLOCKING */
723 * Now imagetype is either the non-auto type we were called with,
724 * or it was auto and has since been determined. In any case, we
725 * can proceed to actually answering the request by sending a redirect
726 * or an image as appropriate:
728 if (imagetype == 'r')
730 rsp->status = strdup("302 Local Redirect from Privoxy");
731 if (rsp->status == NULL)
733 return JB_ERR_MEMORY;
735 if (enlist_unique_header(rsp->headers, "Location",
736 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
738 return JB_ERR_MEMORY;
743 if ((imagetype == 'b') || (imagetype == 't'))
745 rsp->body = bindup(image_blank_data, image_blank_length);
746 rsp->content_length = image_blank_length;
750 rsp->body = bindup(image_pattern_data, image_pattern_length);
751 rsp->content_length = image_pattern_length;
754 if (rsp->body == NULL)
756 return JB_ERR_MEMORY;
758 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
760 return JB_ERR_MEMORY;
771 /*********************************************************************
773 * Function : cgi_transparent_image
775 * Description : CGI function that sends a 1x1 transparent image.
778 * 1 : csp = Current client state (buffers, headers, etc...)
779 * 2 : rsp = http_response data structure for output
780 * 3 : parameters = map of cgi parameters
782 * CGI Parameters : None
784 * Returns : JB_ERR_OK on success
785 * JB_ERR_MEMORY on out-of-memory error.
787 *********************************************************************/
788 jb_err cgi_transparent_image(struct client_state *csp,
789 struct http_response *rsp,
790 const struct map *parameters)
792 rsp->body = bindup(image_blank_data, image_blank_length);
793 rsp->content_length = image_blank_length;
795 if (rsp->body == NULL)
797 return JB_ERR_MEMORY;
800 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
802 return JB_ERR_MEMORY;
812 /*********************************************************************
814 * Function : cgi_send_default_favicon
816 * Description : CGI function that sends the standard favicon.
819 * 1 : csp = Current client state (buffers, headers, etc...)
820 * 2 : rsp = http_response data structure for output
821 * 3 : parameters = map of cgi parameters
823 * CGI Parameters : None
825 * Returns : JB_ERR_OK on success
826 * JB_ERR_MEMORY on out-of-memory error.
828 *********************************************************************/
829 jb_err cgi_send_default_favicon(struct client_state *csp,
830 struct http_response *rsp,
831 const struct map *parameters)
833 static const char default_favicon_data[] =
834 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
835 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
836 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
837 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
838 "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
839 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
840 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
841 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
842 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
843 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
844 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
845 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
846 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
848 static const size_t favicon_length = sizeof(default_favicon_data) - 1;
850 rsp->body = bindup(default_favicon_data, favicon_length);
851 rsp->content_length = favicon_length;
853 if (rsp->body == NULL)
855 return JB_ERR_MEMORY;
858 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
860 return JB_ERR_MEMORY;
870 /*********************************************************************
872 * Function : cgi_send_error_favicon
874 * Description : CGI function that sends the favicon for error pages.
877 * 1 : csp = Current client state (buffers, headers, etc...)
878 * 2 : rsp = http_response data structure for output
879 * 3 : parameters = map of cgi parameters
881 * CGI Parameters : None
883 * Returns : JB_ERR_OK on success
884 * JB_ERR_MEMORY on out-of-memory error.
886 *********************************************************************/
887 jb_err cgi_send_error_favicon(struct client_state *csp,
888 struct http_response *rsp,
889 const struct map *parameters)
891 static const char error_favicon_data[] =
892 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
893 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
894 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
895 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
896 "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
897 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
898 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
899 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
900 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
901 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
902 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
903 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
904 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
906 static const size_t favicon_length = sizeof(error_favicon_data) - 1;
908 rsp->body = bindup(error_favicon_data, favicon_length);
909 rsp->content_length = favicon_length;
911 if (rsp->body == NULL)
913 return JB_ERR_MEMORY;
916 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
918 return JB_ERR_MEMORY;
928 /*********************************************************************
930 * Function : cgi_send_stylesheet
932 * Description : CGI function that sends a css stylesheet found
933 * in the cgi-style.css template
936 * 1 : csp = Current client state (buffers, headers, etc...)
937 * 2 : rsp = http_response data structure for output
938 * 3 : parameters = map of cgi parameters
940 * CGI Parameters : None
942 * Returns : JB_ERR_OK on success
943 * JB_ERR_MEMORY on out-of-memory error.
945 *********************************************************************/
946 jb_err cgi_send_stylesheet(struct client_state *csp,
947 struct http_response *rsp,
948 const struct map *parameters)
955 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
957 if (err == JB_ERR_FILE)
960 * No way to tell user; send empty stylesheet
962 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
966 return err; /* JB_ERR_MEMORY */
969 if (enlist(rsp->headers, "Content-Type: text/css"))
971 return JB_ERR_MEMORY;
977 /*********************************************************************
979 * Function : cgi_send_user_manual
981 * Description : CGI function that sends a file in the user
985 * 1 : csp = Current client state (buffers, headers, etc...)
986 * 2 : rsp = http_response data structure for output
987 * 3 : parameters = map of cgi parameters
989 * CGI Parameters : file=name.html, the name of the HTML file
990 * (relative to user-manual from config)
992 * Returns : JB_ERR_OK on success
993 * JB_ERR_MEMORY on out-of-memory error.
995 *********************************************************************/
996 jb_err cgi_send_user_manual(struct client_state *csp,
997 struct http_response *rsp,
998 const struct map *parameters)
1000 const char * filename;
1002 jb_err err = JB_ERR_OK;
1009 if (!parameters->first)
1011 /* requested http://p.p/user-manual (without trailing slash) */
1012 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
1015 get_string_param(parameters, "file", &filename);
1016 /* Check paramter for hack attempts */
1017 if (filename && strchr(filename, '/'))
1019 return JB_ERR_CGI_PARAMS;
1021 if (filename && strstr(filename, ".."))
1023 return JB_ERR_CGI_PARAMS;
1026 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
1027 if (full_path == NULL)
1029 return JB_ERR_MEMORY;
1032 err = load_file(full_path, &rsp->body, &rsp->content_length);
1033 if (JB_ERR_OK != err)
1035 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1036 if (JB_ERR_FILE == err)
1038 err = cgi_error_no_template(csp, rsp, full_path);
1045 /* Guess correct Content-Type based on the filename's ending */
1048 length = strlen(filename);
1054 if((length>=4) && !strcmp(&filename[length-4], ".css"))
1056 err = enlist(rsp->headers, "Content-Type: text/css");
1058 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
1060 err = enlist(rsp->headers, "Content-Type: image/jpeg");
1064 err = enlist(rsp->headers, "Content-Type: text/html");
1071 /*********************************************************************
1073 * Function : cgi_show_version
1075 * Description : CGI function that returns a a web page describing the
1076 * file versions of Privoxy.
1079 * 1 : csp = Current client state (buffers, headers, etc...)
1080 * 2 : rsp = http_response data structure for output
1081 * 3 : parameters = map of cgi parameters
1083 * CGI Parameters : none
1085 * Returns : JB_ERR_OK on success
1086 * JB_ERR_MEMORY on out-of-memory error.
1088 *********************************************************************/
1089 jb_err cgi_show_version(struct client_state *csp,
1090 struct http_response *rsp,
1091 const struct map *parameters)
1093 struct map *exports;
1099 if (NULL == (exports = default_exports(csp, "show-version")))
1101 return JB_ERR_MEMORY;
1104 if (map(exports, "sourceversions", 1, show_rcs(), 0))
1107 return JB_ERR_MEMORY;
1110 return template_fill_for_cgi(csp, "show-version", exports, rsp);
1114 /*********************************************************************
1116 * Function : cgi_show_status
1118 * Description : CGI function that returns a web page describing the
1119 * current status of Privoxy.
1122 * 1 : csp = Current client state (buffers, headers, etc...)
1123 * 2 : rsp = http_response data structure for output
1124 * 3 : parameters = map of cgi parameters
1127 * file : Which file to show. Only first letter is checked,
1132 * Default is to show menu and other information.
1134 * Returns : JB_ERR_OK on success
1135 * JB_ERR_MEMORY on out-of-memory error.
1137 *********************************************************************/
1138 jb_err cgi_show_status(struct client_state *csp,
1139 struct http_response *rsp,
1140 const struct map *parameters)
1146 char buf[BUFFER_SIZE];
1147 #ifdef FEATURE_STATISTICS
1148 float perc_rej; /* Percentage of http requests rejected */
1149 int local_urls_read;
1150 int local_urls_rejected;
1151 #endif /* ndef FEATURE_STATISTICS */
1152 jb_err err = JB_ERR_OK;
1154 struct map *exports;
1160 if ('\0' != *(lookup(parameters, "file")))
1162 return cgi_show_file(csp, rsp, parameters);
1165 if (NULL == (exports = default_exports(csp, "show-status")))
1167 return JB_ERR_MEMORY;
1171 for (j = 0; (s != NULL) && (j < Argc); j++)
1173 if (!err) err = string_join (&s, html_encode(Argv[j]));
1174 if (!err) err = string_append(&s, " ");
1176 if (!err) err = map(exports, "invocation", 1, s, 0);
1178 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1179 if (!err) err = show_defines(exports);
1184 return JB_ERR_MEMORY;
1187 #ifdef FEATURE_STATISTICS
1188 local_urls_read = urls_read;
1189 local_urls_rejected = urls_rejected;
1192 * Need to alter the stats not to include the fetch of this
1195 * Can't do following thread safely! doh!
1198 * urls_rejected--; * This will be incremented subsequently *
1201 if (local_urls_read == 0)
1203 if (!err) err = map_block_killer(exports, "have-stats");
1207 if (!err) err = map_block_killer(exports, "have-no-stats");
1209 perc_rej = (float)local_urls_rejected * 100.0F /
1210 (float)local_urls_read;
1212 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1213 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1215 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1216 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1218 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1219 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1222 #else /* ndef FEATURE_STATISTICS */
1223 err = err || map_block_killer(exports, "statistics");
1224 #endif /* ndef FEATURE_STATISTICS */
1227 * List all action files in use, together with view and edit links,
1228 * except for standard.action, which should only be viewable. (Not
1229 * enforced in the editor itself)
1230 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1233 for (i = 0; i < MAX_AF_FILES; i++)
1235 if (csp->actions_list[i] != NULL)
1237 if (!err) err = string_append(&s, "<tr><td>");
1238 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1239 snprintf(buf, sizeof(buf),
1240 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1241 if (!err) err = string_append(&s, buf);
1243 #ifdef FEATURE_CGI_EDIT_ACTIONS
1244 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1245 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
1246 && (NULL != csp->config->actions_file_short[i]))
1249 if (access(csp->config->actions_file[i], W_OK) == 0)
1251 #endif /* def HAVE_ACCESS */
1252 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%d\">Edit</a>", i);
1253 if (!err) err = string_append(&s, buf);
1258 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
1260 #endif /* def HAVE_ACCESS */
1264 if (!err) err = string_append(&s, "</td></tr>\n");
1269 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1273 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1277 * List all re_filterfiles in use, together with view options.
1278 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1281 for (i = 0; i < MAX_AF_FILES; i++)
1283 if (csp->rlist[i] != NULL)
1285 if (!err) err = string_append(&s, "<tr><td>");
1286 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1288 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1289 if (!err) err = string_append(&s, buf);
1290 if (!err) err = string_append(&s, "</td></tr>\n");
1295 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1299 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1300 if (!err) err = map_block_killer(exports, "have-filterfile");
1303 #ifdef FEATURE_TRUST
1306 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1310 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1311 if (!err) err = map_block_killer(exports, "have-trustfile");
1314 if (!err) err = map_block_killer(exports, "trust-support");
1315 #endif /* ndef FEATURE_TRUST */
1317 #ifdef FEATURE_CGI_EDIT_ACTIONS
1318 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1320 err = map_block_killer(exports, "cgi-editor-is-disabled");
1322 #endif /* ndef CGI_EDIT_ACTIONS */
1327 return JB_ERR_MEMORY;
1330 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1334 /*********************************************************************
1336 * Function : cgi_show_url_info
1338 * Description : CGI function that determines and shows which actions
1339 * Privoxy will perform for a given url, and which
1340 * matches starting from the defaults have lead to that.
1343 * 1 : csp = Current client state (buffers, headers, etc...)
1344 * 2 : rsp = http_response data structure for output
1345 * 3 : parameters = map of cgi parameters
1348 * url : The url whose actions are to be determined.
1349 * If url is unset, the url-given conditional will be
1350 * set, so that all but the form can be suppressed in
1353 * Returns : JB_ERR_OK on success
1354 * JB_ERR_MEMORY on out-of-memory error.
1356 *********************************************************************/
1357 jb_err cgi_show_url_info(struct client_state *csp,
1358 struct http_response *rsp,
1359 const struct map *parameters)
1362 struct map *exports;
1369 if (NULL == (exports = default_exports(csp, "show-url-info")))
1371 return JB_ERR_MEMORY;
1375 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1377 url_param = strdup(lookup(parameters, "url"));
1378 if (url_param == NULL)
1381 return JB_ERR_MEMORY;
1386 * Handle prefixes. 4 possibilities:
1387 * 1) "http://" or "https://" prefix present and followed by URL - OK
1388 * 2) Only the "http://" or "https://" part is present, no URL - change
1389 * to empty string so it will be detected later as "no URL".
1390 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1392 * 4) Parameter not specified or is empty string - let this fall through
1393 * for now, next block of code will handle it.
1395 if (0 == strncmp(url_param, "http://", 7))
1397 if (url_param[7] == '\0')
1400 * Empty URL (just prefix).
1401 * Make it totally empty so it's caught by the next if()
1403 url_param[0] = '\0';
1406 else if (0 == strncmp(url_param, "https://", 8))
1408 if (url_param[8] == '\0')
1411 * Empty URL (just prefix).
1412 * Make it totally empty so it's caught by the next if()
1414 url_param[0] = '\0';
1417 else if ((url_param[0] != '\0') && (NULL == strstr(url_param, "://")))
1419 /* No prefix - assume http:// */
1420 char *url_param_prefixed = strdup("http://");
1422 if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1425 return JB_ERR_MEMORY;
1427 url_param = url_param_prefixed;
1431 * Hide "toggle off" warning if Privoxy is toggled on.
1434 #ifdef FEATURE_TOGGLE
1435 (global_toggle_state == 1) &&
1436 #endif /* def FEATURE_TOGGLE */
1437 map_block_killer(exports, "privoxy-is-toggled-off")
1441 return JB_ERR_MEMORY;
1444 if (url_param[0] == '\0')
1446 /* URL paramater not specified, display query form only. */
1448 if (map_block_killer(exports, "url-given")
1449 || map(exports, "url", 1, "", 1))
1452 return JB_ERR_MEMORY;
1457 /* Given a URL, so query it. */
1462 struct file_list *fl;
1463 struct url_actions *b;
1464 struct http_request url_to_query[1];
1465 struct current_action_spec action[1];
1468 if (map(exports, "url", 1, html_encode(url_param), 0))
1472 return JB_ERR_MEMORY;
1475 init_current_action(action);
1477 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1479 free_current_action(action);
1482 return JB_ERR_MEMORY;
1485 memset(url_to_query, '\0', sizeof(url_to_query));
1486 err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1487 assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmp(url_param, "https://", 8)));
1491 if (err == JB_ERR_MEMORY)
1493 free_http_request(url_to_query);
1494 free_current_action(action);
1496 return JB_ERR_MEMORY;
1502 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1503 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1504 if (!err) err = map_block_killer(exports, "valid-url");
1506 free_current_action(action);
1507 free_http_request(url_to_query);
1512 return JB_ERR_MEMORY;
1515 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1519 * We have a warning about SSL paths. Hide it for unencrypted sites.
1521 if (!url_to_query->ssl)
1523 if (map_block_killer(exports, "https"))
1525 free_current_action(action);
1527 free_http_request(url_to_query);
1528 return JB_ERR_MEMORY;
1532 matches = strdup("<table summary=\"\" class=\"transparent\">");
1534 for (i = 0; i < MAX_AF_FILES; i++)
1536 if (NULL == csp->config->actions_file_short[i]
1537 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1541 if ((fl = csp->actions_list[i]) != NULL)
1543 if ((b = fl->f) != NULL)
1545 /* FIXME: Hardcoded HTML! */
1546 string_append(&matches, "<tr><th>In file: ");
1547 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1548 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1549 string_append(&matches, buf);
1550 string_append(&matches, "View</a>");
1551 #ifdef FEATURE_CGI_EDIT_ACTIONS
1552 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1555 if (access(csp->config->actions_file[i], W_OK) == 0)
1557 #endif /* def HAVE_ACCESS */
1558 snprintf(buf, sizeof(buf),
1559 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1560 string_append(&matches, buf);
1561 string_append(&matches, "Edit</a>");
1566 string_append(&matches, " <strong>No write access.</strong>");
1568 #endif /* def HAVE_ACCESS */
1570 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1572 string_append(&matches, "</th></tr>\n");
1579 for (; (b != NULL) && (matches != NULL); b = b->next)
1581 if (url_match(b->url, url_to_query))
1583 string_append(&matches, "<tr><td>{");
1584 string_join (&matches, actions_to_html(csp, b->action));
1585 string_append(&matches, " }<br>\n<code>");
1586 string_join (&matches, html_encode(b->url->spec));
1587 string_append(&matches, "</code></td></tr>\n");
1589 if (merge_current_action(action, b->action))
1592 free_http_request(url_to_query);
1593 free_current_action(action);
1595 return JB_ERR_MEMORY;
1603 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1606 string_append(&matches, "</table>\n");
1609 * XXX: Kludge to make sure the "Forward settings" section
1610 * shows what forward-override{} would do with the requested URL.
1611 * No one really cares how the CGI request would be forwarded
1612 * if it wasn't intercepted as CGI request in the first place.
1614 * From here on the action bitmask will no longer reflect
1615 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1616 * but luckily it's no longer required later on anyway.
1618 free_current_action(csp->action);
1619 get_url_actions(csp, url_to_query);
1622 * Fill in forwarding settings.
1624 * The possibilities are:
1626 * - http forwarding only
1627 * - socks4(a) forwarding only
1628 * - socks4(a) and http forwarding.
1630 * XXX: Parts of this code could be reused for the
1631 * "forwarding-failed" template which currently doesn't
1632 * display the proxy port and an eventual second forwarder.
1635 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1637 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1639 if (!err) err = map_block_killer(exports, "socks-forwarder");
1640 if (!err) err = map_block_killer(exports, "http-forwarder");
1644 char port[10]; /* We save proxy ports as int but need a string here */
1646 if (!err) err = map_block_killer(exports, "no-forwarder");
1648 if (fwd->gateway_host != NULL)
1650 char *socks_type = NULL;
1655 socks_type = "socks4";
1658 socks_type = "socks4a";
1661 socks_type = "socks5";
1664 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1667 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1668 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1669 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1670 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1674 if (!err) err = map_block_killer(exports, "socks-forwarder");
1677 if (fwd->forward_host != NULL)
1679 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1680 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1681 if (!err) err = map(exports, "forward-port", 1, port, 1);
1685 if (!err) err = map_block_killer(exports, "http-forwarder");
1690 free_http_request(url_to_query);
1692 if (err || matches == NULL)
1694 free_current_action(action);
1696 return JB_ERR_MEMORY;
1699 #ifdef FEATURE_CGI_EDIT_ACTIONS
1700 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1702 err = map_block_killer(exports, "cgi-editor-is-disabled");
1704 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1707 * If zlib support is available, if no content filters
1708 * are enabled or if the prevent-compression action is enabled,
1709 * suppress the "compression could prevent filtering" warning.
1711 #ifndef FEATURE_ZLIB
1712 if (!content_filters_enabled(action) ||
1713 (action->flags & ACTION_NO_COMPRESSION))
1716 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1719 if (err || map(exports, "matches", 1, matches , 0))
1721 free_current_action(action);
1723 return JB_ERR_MEMORY;
1726 s = current_action_to_html(csp, action);
1728 free_current_action(action);
1730 if (map(exports, "final", 1, s, 0))
1733 return JB_ERR_MEMORY;
1737 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1741 /*********************************************************************
1743 * Function : cgi_robots_txt
1745 * Description : CGI function to return "/robots.txt".
1748 * 1 : csp = Current client state (buffers, headers, etc...)
1749 * 2 : rsp = http_response data structure for output
1750 * 3 : parameters = map of cgi parameters
1752 * CGI Parameters : None
1754 * Returns : JB_ERR_OK on success
1755 * JB_ERR_MEMORY on out-of-memory error.
1757 *********************************************************************/
1758 jb_err cgi_robots_txt(struct client_state *csp,
1759 struct http_response *rsp,
1760 const struct map *parameters)
1766 "# This is the Privoxy control interface.\n"
1767 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1773 if (rsp->body == NULL)
1775 return JB_ERR_MEMORY;
1778 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1782 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1783 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1785 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1789 /*********************************************************************
1791 * Function : show_defines
1793 * Description : Add to a map the state od all conditional #defines
1794 * used when building
1797 * 1 : exports = map to extend
1799 * Returns : JB_ERR_OK on success
1800 * JB_ERR_MEMORY on out-of-memory error.
1802 *********************************************************************/
1803 static jb_err show_defines(struct map *exports)
1805 jb_err err = JB_ERR_OK;
1808 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1809 #else /* ifndef FEATURE_ACL */
1810 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1811 #endif /* ndef FEATURE_ACL */
1813 #ifdef FEATURE_CGI_EDIT_ACTIONS
1814 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1815 #else /* ifndef FEATURE_COOKIE_JAR */
1816 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1817 #endif /* ndef FEATURE_COOKIE_JAR */
1819 #ifdef FEATURE_COOKIE_JAR
1820 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1821 #else /* ifndef FEATURE_COOKIE_JAR */
1822 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1823 #endif /* ndef FEATURE_COOKIE_JAR */
1825 #ifdef FEATURE_FAST_REDIRECTS
1826 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1827 #else /* ifndef FEATURE_FAST_REDIRECTS */
1828 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1829 #endif /* ndef FEATURE_FAST_REDIRECTS */
1831 #ifdef FEATURE_FORCE_LOAD
1832 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1833 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1834 #else /* ifndef FEATURE_FORCE_LOAD */
1835 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1836 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1837 #endif /* ndef FEATURE_FORCE_LOAD */
1839 #ifdef FEATURE_GRACEFUL_TERMINATION
1840 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1841 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1842 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1843 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1845 #ifdef FEATURE_IMAGE_BLOCKING
1846 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1847 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1848 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1849 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1851 #ifdef FEATURE_IMAGE_DETECT_MSIE
1852 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1853 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1854 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1855 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1857 #ifdef FEATURE_NO_GIFS
1858 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1859 #else /* ifndef FEATURE_NO_GIFS */
1860 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1861 #endif /* ndef FEATURE_NO_GIFS */
1863 #ifdef FEATURE_PTHREAD
1864 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1865 #else /* ifndef FEATURE_PTHREAD */
1866 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1867 #endif /* ndef FEATURE_PTHREAD */
1869 #ifdef FEATURE_STATISTICS
1870 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1871 #else /* ifndef FEATURE_STATISTICS */
1872 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1873 #endif /* ndef FEATURE_STATISTICS */
1875 #ifdef FEATURE_TOGGLE
1876 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1877 #else /* ifndef FEATURE_TOGGLE */
1878 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1879 #endif /* ndef FEATURE_TOGGLE */
1881 #ifdef FEATURE_TRUST
1882 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1883 #else /* ifndef FEATURE_TRUST */
1884 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1885 #endif /* ndef FEATURE_TRUST */
1888 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1889 #else /* ifndef FEATURE_ZLIB */
1890 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1891 #endif /* ndef FEATURE_ZLIB */
1894 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1895 #else /* ifndef STATIC_PCRE */
1896 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1897 #endif /* ndef STATIC_PCRE */
1900 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1901 #else /* ifndef STATIC_PCRS */
1902 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1903 #endif /* ndef STATIC_PCRS */
1909 /*********************************************************************
1911 * Function : show_rcs
1913 * Description : Create a string with the rcs info for all sourcefiles
1917 * Returns : A string, or NULL on out-of-memory.
1919 *********************************************************************/
1920 static char *show_rcs(void)
1922 char *result = strdup("");
1923 char buf[BUFFER_SIZE];
1925 /* Instead of including *all* dot h's in the project (thus creating a
1926 * tremendous amount of dependencies), I will concede to declaring them
1927 * as extern's. This forces the developer to add to this list, but oh well.
1930 #define SHOW_RCS(__x) \
1932 extern const char __x[]; \
1933 snprintf(buf, sizeof(buf), " %s\n", __x); \
1934 string_append(&result, buf); \
1937 /* In alphabetical order */
1938 SHOW_RCS(actions_h_rcs)
1939 SHOW_RCS(actions_rcs)
1941 SHOW_RCS(amiga_h_rcs)
1943 #endif /* def AMIGA */
1946 #ifdef FEATURE_CGI_EDIT_ACTIONS
1947 SHOW_RCS(cgiedit_h_rcs)
1948 SHOW_RCS(cgiedit_rcs)
1949 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1950 SHOW_RCS(cgisimple_h_rcs)
1951 SHOW_RCS(cgisimple_rcs)
1953 SHOW_RCS(cygwin_h_rcs)
1955 SHOW_RCS(deanimate_h_rcs)
1956 SHOW_RCS(deanimate_rcs)
1957 SHOW_RCS(encode_h_rcs)
1958 SHOW_RCS(encode_rcs)
1959 SHOW_RCS(errlog_h_rcs)
1960 SHOW_RCS(errlog_rcs)
1961 SHOW_RCS(filters_h_rcs)
1962 SHOW_RCS(filters_rcs)
1963 SHOW_RCS(gateway_h_rcs)
1964 SHOW_RCS(gateway_rcs)
1965 SHOW_RCS(jbsockets_h_rcs)
1966 SHOW_RCS(jbsockets_rcs)
1969 SHOW_RCS(list_h_rcs)
1971 SHOW_RCS(loadcfg_h_rcs)
1972 SHOW_RCS(loadcfg_rcs)
1973 SHOW_RCS(loaders_h_rcs)
1974 SHOW_RCS(loaders_rcs)
1975 SHOW_RCS(miscutil_h_rcs)
1976 SHOW_RCS(miscutil_rcs)
1977 SHOW_RCS(parsers_h_rcs)
1978 SHOW_RCS(parsers_rcs)
1980 SHOW_RCS(pcrs_h_rcs)
1981 SHOW_RCS(project_h_rcs)
1982 SHOW_RCS(ssplit_h_rcs)
1983 SHOW_RCS(ssplit_rcs)
1984 SHOW_RCS(urlmatch_h_rcs)
1985 SHOW_RCS(urlmatch_rcs)
1987 #ifndef _WIN_CONSOLE
1988 SHOW_RCS(w32log_h_rcs)
1989 SHOW_RCS(w32log_rcs)
1990 SHOW_RCS(w32res_h_rcs)
1991 SHOW_RCS(w32taskbar_h_rcs)
1992 SHOW_RCS(w32taskbar_rcs)
1993 #endif /* ndef _WIN_CONSOLE */
1994 SHOW_RCS(win32_h_rcs)
1996 #endif /* def _WIN32 */
2005 /*********************************************************************
2007 * Function : cgi_show_file
2009 * Description : CGI function that shows the content of a
2010 * configuration file.
2013 * 1 : csp = Current client state (buffers, headers, etc...)
2014 * 2 : rsp = http_response data structure for output
2015 * 3 : parameters = map of cgi parameters
2018 * file : Which file to show. Only first letter is checked,
2023 * Default is to show menu and other information.
2025 * Returns : JB_ERR_OK on success
2026 * JB_ERR_MEMORY on out-of-memory error.
2028 *********************************************************************/
2029 static jb_err cgi_show_file(struct client_state *csp,
2030 struct http_response *rsp,
2031 const struct map *parameters)
2034 const char * filename = NULL;
2035 char * file_description = NULL;
2041 switch (*(lookup(parameters, "file")))
2044 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2046 filename = csp->actions_list[i]->filename;
2047 file_description = "Actions File";
2052 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2054 filename = csp->rlist[i]->filename;
2055 file_description = "Filter File";
2059 #ifdef FEATURE_TRUST
2063 filename = csp->tlist->filename;
2064 file_description = "Trust File";
2067 #endif /* def FEATURE_TRUST */
2070 if (NULL != filename)
2072 struct map *exports;
2077 exports = default_exports(csp, "show-status");
2078 if (NULL == exports)
2080 return JB_ERR_MEMORY;
2083 if ( map(exports, "file-description", 1, file_description, 1)
2084 || map(exports, "filepath", 1, html_encode(filename), 0) )
2087 return JB_ERR_MEMORY;
2090 err = load_file(filename, &s, &length);
2091 if (JB_ERR_OK != err)
2093 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2096 return JB_ERR_MEMORY;
2101 s = html_encode_and_free_original(s);
2104 return JB_ERR_MEMORY;
2107 if (map(exports, "contents", 1, s, 0))
2110 return JB_ERR_MEMORY;
2114 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2117 return JB_ERR_CGI_PARAMS;
2121 /*********************************************************************
2123 * Function : load_file
2125 * Description : Loads a file into a buffer.
2128 * 1 : filename = Name of the file to be loaded.
2129 * 2 : buffer = Used to return the file's content.
2130 * 3 : length = Used to return the size of the file.
2132 * Returns : JB_ERR_OK in case of success,
2133 * JB_ERR_FILE in case of ordinary file loading errors
2134 * (fseek() and ftell() errors are fatal)
2135 * JB_ERR_MEMORY in case of out-of-memory.
2137 *********************************************************************/
2138 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2142 jb_err err = JB_ERR_OK;
2144 fp = fopen(filename, "rb");
2150 /* Get file length */
2151 if (fseek(fp, 0, SEEK_END))
2153 log_error(LOG_LEVEL_FATAL,
2154 "Unexpected erro while fseek()ing to the end of %s: %E",
2160 log_error(LOG_LEVEL_FATAL,
2161 "Unexpected ftell() error while loading %s: %E",
2164 *length = (size_t)ret;
2166 /* Go back to the beginning. */
2167 if (fseek(fp, 0, SEEK_SET))
2169 log_error(LOG_LEVEL_FATAL,
2170 "Unexpected error while fseek()ing to the beginning of %s: %E",
2174 *buffer = (char *)zalloc(*length + 1);
2175 if (NULL == *buffer)
2177 err = JB_ERR_MEMORY;
2179 else if (!fread(*buffer, *length, 1, fp))
2182 * May happen if the file size changes between fseek() and
2183 * fread(). If it does, we just log it and serve what we got.
2185 log_error(LOG_LEVEL_ERROR,
2186 "Couldn't completely read file %s.", filename);