1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.86 2008/06/28 14:19:05 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.86 2008/06/28 14:19:05 fabiankeil
40 * Protocol detection is done case-insensitive, fix assertion
41 * to do the same. Yay for Privoxy-Regression-Test and zzuf.
43 * Revision 1.85 2008/05/26 17:30:55 fabiankeil
44 * Provide an OpenSearch Description to access the
45 * show-url-info page through "search engine plugins".
47 * Revision 1.84 2008/05/26 16:16:55 fabiankeil
48 * Spell error correctly.
50 * Revision 1.83 2008/05/12 14:51:30 fabiankeil
51 * Don't complain about an invalid URL if show-url-info is requested
52 * without parameters. Regression introduced in 1.81 by yours truly.
54 * Revision 1.82 2008/05/10 20:01:47 fabiankeil
55 * Fix an assertion that could erroneously
56 * trigger in case of memory shortage.
58 * Revision 1.81 2008/05/05 09:54:39 fabiankeil
59 * In cgi_show_url_info(), make sure ftp URLs are
60 * declared invalid. Also simplify the code that adds
61 * "http://" if no protocol has been specified.
63 * Revision 1.80 2008/05/04 16:18:32 fabiankeil
64 * Provide parse_http_url() with a third parameter to specify
65 * whether or not URLs without protocol are acceptable.
67 * Revision 1.79 2008/05/04 13:30:56 fabiankeil
68 * Streamline parse_http_url()'s prototype.
70 * Revision 1.78 2008/05/03 16:50:11 fabiankeil
71 * Leverage content_filters_enabled() in cgi_show_url_info().
73 * Revision 1.77 2008/05/02 09:47:48 fabiankeil
74 * In cgi_show_url_info, pass an initialized http structure
75 * to parse_http_url() as that will be required soonish and
76 * assert that https URLs are recognized correctly.
78 * Revision 1.76 2008/04/28 09:13:30 fabiankeil
79 * In load_file(), remember the error reason and fclose()
80 * and return later on instead of right away.
82 * Revision 1.75 2008/04/27 13:52:52 fabiankeil
83 * Move CGI file loading code into load_file() and
84 * add checks for unexpected errors.
86 * Revision 1.74 2008/04/26 15:50:56 fabiankeil
87 * Fix macro name in cgi_show_file() error path.
89 * Revision 1.73 2008/04/26 12:21:55 fabiankeil
90 * Forget about JB_ERR_PARSE. JB_ERR_CGI_PARAMS to the rescue.
92 * Revision 1.72 2008/04/26 10:34:15 fabiankeil
93 * If zlib support is unavailable and there are content filters active
94 * but the prevent-compression action is disabled, include a warning
95 * on the show-url-info page that compression might prevent filtering.
97 * Revision 1.71 2008/04/25 13:33:56 fabiankeil
98 * - Factor cgi_show_file() out of cgi_show_status().
99 * - Adjust cgi_show_status()'s parameter description to match reality.
101 * Revision 1.70 2008/04/24 16:12:38 fabiankeil
102 * In cgi_show_status(), load the requested file at once.
103 * Using string_join() for every line really doesn't scale.
105 * Revision 1.69 2008/04/17 14:40:48 fabiankeil
106 * Provide get_http_time() with the buffer size so it doesn't
107 * have to blindly assume that the buffer is big enough.
109 * Revision 1.68 2008/03/27 18:27:21 fabiankeil
110 * Remove kill-popups action.
112 * Revision 1.67 2008/03/27 17:00:05 fabiankeil
113 * Turn the favicon blobs into locals.
115 * Revision 1.66 2008/02/23 16:57:12 fabiankeil
116 * Rename url_actions() to get_url_actions() and let it
117 * use the standard parameter ordering.
119 * Revision 1.65 2008/02/23 16:33:43 fabiankeil
120 * Let forward_url() use the standard parameter ordering
121 * and mark its second parameter immutable.
123 * Revision 1.64 2008/02/03 13:56:07 fabiankeil
124 * Add SOCKS5 support for show-url-info CGI page.
126 * Revision 1.63 2008/02/01 06:04:31 fabiankeil
127 * If edit buttons on the show-url-info CGI page are hidden, explain why.
129 * Revision 1.62 2008/02/01 05:52:40 fabiankeil
130 * Hide edit buttons on the show-url-info CGI page if enable-edit-action
131 * is disabled. Patch by Lee with additional white space adjustments.
133 * Revision 1.61 2008/01/26 11:13:25 fabiankeil
134 * If enable-edit-actions is disabled, hide the edit buttons and explain why.
136 * Revision 1.60 2007/10/27 13:12:13 fabiankeil
137 * Finish 1.49 and check write access before
138 * showing edit buttons on show-url-info page.
140 * Revision 1.59 2007/10/19 16:42:36 fabiankeil
141 * Plug memory leak I introduced five months ago.
142 * Yay Valgrind and Privoxy-Regression-Test.
144 * Revision 1.58 2007/07/21 12:19:50 fabiankeil
145 * If show-url-info is called with an URL that Privoxy
146 * would reject as invalid, don't show unresolved forwarding
147 * variables, "final matches" or claim the site's secure.
149 * Revision 1.57 2007/06/01 16:53:05 fabiankeil
150 * Adjust cgi_show_url_info() to show what forward-override{}
151 * would do with the requested URL (instead of showing how the
152 * request for the CGI page would be forwarded if it wasn't a
155 * Revision 1.56 2007/05/21 10:50:35 fabiankeil
156 * - Use strlcpy() instead of strcpy().
157 * - Stop treating actions files special. Expect a complete file name
158 * (with or without path) like it's done for the rest of the files.
160 * - Don't rerun sed() in cgi_show_request().
162 * Revision 1.55 2007/04/13 13:36:46 fabiankeil
163 * Reference action files in CGI URLs by id instead
164 * of using the first part of the file name.
165 * Fixes BR 1694250 and BR 1590556.
167 * Revision 1.54 2007/04/09 18:11:35 fabiankeil
168 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
170 * Revision 1.53 2007/04/08 13:21:04 fabiankeil
171 * Reference action files in CGI URLs by id instead
172 * of using the first part of the file name.
173 * Fixes BR 1694250 and BR 1590556.
175 * Revision 1.52 2007/02/13 15:10:26 fabiankeil
176 * Apparently fopen()ing in "binary" mode doesn't require
177 * #ifdefs, it's already done without them in cgiedit.c.
179 * Revision 1.51 2007/02/10 16:55:22 fabiankeil
180 * - Show forwarding settings on the show-url-info page
181 * - Fix some HTML syntax errors.
183 * Revision 1.50 2007/01/23 15:51:17 fabiankeil
184 * Add favicon delivery functions.
186 * Revision 1.49 2007/01/20 16:29:38 fabiankeil
187 * Suppress edit buttons for action files if Privoxy has
188 * no write access. Suggested by Roland in PR 1564026.
190 * Revision 1.48 2007/01/20 15:31:31 fabiankeil
191 * Display warning if show-url-info CGI page
192 * is used while Privoxy is toggled off.
194 * Revision 1.47 2007/01/12 15:07:10 fabiankeil
195 * Use zalloc in cgi_send_user_manual.
197 * Revision 1.46 2007/01/02 12:49:46 fabiankeil
198 * Add FEATURE_ZLIB to the list of conditional
199 * defines at the show-status page.
201 * Revision 1.45 2006/12/28 18:16:41 fabiankeil
202 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
203 * body memory before using it, replaced sprintf calls with snprintf.
205 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
206 * Removed checks whether or not AF_FILES have
207 * data structures associated with them in cgi_show_status.
208 * It doesn't matter as we're only interested in the file names.
210 * For the action files the checks were always true,
211 * but they prevented empty filter files from being
212 * listed. Fixes parts of BR 1619208.
214 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
215 * - Added FEATURE_GRACEFUL_TERMINATION to the
216 * "conditional #defines" section
217 * - Escaped ampersands in generated HTML.
218 * - Renamed re-filter-filename to re-filter-filenames
220 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
221 * Add special treatment for WIN32 to make sure
222 * cgi_send_user_manual opens the files in binary mode.
223 * Fixes BR 1600411 and unbreaks image delivery.
225 * Remove outdated comment.
227 * Revision 1.41 2006/10/09 19:18:28 roro
228 * Redirect http://p.p/user-manual (without trailing slash) to
229 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
231 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
232 * Modified cgi_send_user_manual to serve binary
233 * content without destroying it first. Should also be
234 * faster now. Added ".jpg" check for Content-Type guessing.
236 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
237 * Deliver documents in the user-manual directory
238 * with "Content-Type text/css" if their filename
241 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
242 * Incorporate modified version of Roland Rosenfeld's patch to
243 * optionally access the user-manual via Privoxy. Closes patch 679075.
245 * Formatting changed to Privoxy style, added call to
246 * cgi_error_no_template if the requested file doesn't
247 * exist and modified check whether or not Privoxy itself
248 * should serve the manual. Should work cross-platform now.
250 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
251 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
252 * with what was really the latest development (the v_3_0_branch branch)
254 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
255 * Multiple filter file support
257 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
258 * Undo some damaging memory leak patches
260 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
261 * A few memory leaks plugged (mostly on error paths)
263 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
264 * Another instance of:
265 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
266 * Thanks to Magnus Holmgren for the patch
268 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
269 * - Prevent line wrap beween "View/Edit" link buttons on status page
270 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
272 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
273 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
275 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
276 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
278 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
279 * Applying patch from Andreas as provided by Hal on the list.
280 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
282 * Revision 1.35 2002/05/12 21:44:44 jongfoster
283 * Adding amiga.[ch] revision information, if on an amiga.
285 * Revision 1.34 2002/04/30 12:06:12 oes
286 * Deleted unused code from default_cgi
288 * Revision 1.33 2002/04/30 11:14:52 oes
289 * Made csp the first parameter in *action_to_html
291 * Revision 1.32 2002/04/26 18:29:13 jongfoster
292 * Fixing this Visual C++ warning:
293 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
295 * Revision 1.31 2002/04/26 12:54:36 oes
296 * - Kill obsolete REDIRECT_URL code
297 * - Error handling fixes
298 * - Style sheet related HTML snipplet changes
299 * - cgi_show_url_info:
300 * - Matches now in table, actions on single lines,
302 * - standard.action suppressed
303 * - Buttons to View and Edit AFs
305 * Revision 1.30 2002/04/24 02:18:08 oes
306 * - show-status is now the starting point for editing
307 * the actions files, generate list of all AFs with buttons
308 * for viewing and editing, new look for file list (Jon:
309 * buttons now aligned ;-P ), view mode now supports multiple
310 * AFs, name changes, no view links for unspecified files,
311 * no edit link for standard.action.
313 * - Jon's multiple AF patch: cgi_show_url_info now uses all
314 * AFs and marks the output accordingly
316 * Revision 1.29 2002/04/10 13:38:35 oes
317 * load_template signature changed
319 * Revision 1.28 2002/04/07 15:42:12 jongfoster
320 * Fixing send-banner?type=auto when the image-blocker is
321 * a redirect to send-banner
323 * Revision 1.27 2002/04/05 15:50:48 oes
324 * added send-stylesheet CGI
326 * Revision 1.26 2002/04/04 00:36:36 gliptak
327 * always use pcre for matching
329 * Revision 1.25 2002/04/03 22:28:03 gliptak
330 * Removed references to gnu_regex
332 * Revision 1.24 2002/04/02 16:12:47 oes
333 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
335 * Revision 1.23 2002/03/26 22:29:54 swa
336 * we have a new homepage!
338 * Revision 1.22 2002/03/24 16:18:15 jongfoster
341 * Revision 1.21 2002/03/24 15:23:33 jongfoster
344 * Revision 1.20 2002/03/24 13:25:43 swa
345 * name change related issues
347 * Revision 1.19 2002/03/16 23:54:06 jongfoster
348 * Adding graceful termination feature, to help look for memory leaks.
349 * If you enable this (which, by design, has to be done by hand
350 * editing config.h) and then go to http://i.j.b/die, then the program
351 * will exit cleanly after the *next* request. It should free all the
352 * memory that was used.
354 * Revision 1.18 2002/03/12 01:44:49 oes
355 * Changed default for "blocked" image from jb logo to checkboard pattern
357 * Revision 1.17 2002/03/08 16:43:18 oes
358 * Added choice beween GIF and PNG built-in images
360 * Revision 1.16 2002/03/07 03:48:38 oes
361 * - Changed built-in images from GIF to PNG
362 * (with regard to Unisys patent issue)
363 * - Added a 4x4 pattern PNG which is less intrusive
364 * than the logo but also clearly marks the deleted banners
366 * Revision 1.15 2002/03/06 22:54:35 jongfoster
367 * Automated function-comment nitpicking.
369 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
370 * Clean up a little CRLF unpleasantness that suddenly appeared
372 * Revision 1.13 2002/02/21 00:10:37 jongfoster
373 * Adding send-banner?type=auto option
375 * Revision 1.12 2002/01/23 01:03:32 jongfoster
376 * Fixing gcc [CygWin] compiler warnings
378 * Revision 1.11 2002/01/23 00:01:04 jongfoster
379 * Adding cgi_transparent_gif() for http://i.j.b/t
380 * Adding missing html_encode() to many CGI functions.
381 * Adding urlmatch.[ch] to http://i.j.b/show-version
383 * Revision 1.10 2002/01/17 21:10:37 jongfoster
384 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
385 * Also fixing a problem in the same function with improperly quoted URLs
386 * in output HTML, and adding code to handle https:// URLs correctly.
388 * Revision 1.9 2001/11/30 23:09:15 jongfoster
389 * Now reports on FEATURE_CGI_EDIT_ACTIONS
390 * Removing FEATURE_DENY_GZIP from template
392 * Revision 1.8 2001/11/13 00:14:07 jongfoster
393 * Fixing stupid bug now I've figured out what || means.
394 * (It always returns 0 or 1, not one of it's paramaters.)
396 * Revision 1.7 2001/10/23 21:48:19 jongfoster
397 * Cleaning up error handling in CGI functions - they now send back
398 * a HTML error page and should never cause a FATAL error. (Fixes one
399 * potential source of "denial of service" attacks).
401 * CGI actions file editor that works and is actually useful.
403 * Ability to toggle JunkBuster remotely using a CGI call.
405 * You can turn off both the above features in the main configuration
406 * file, e.g. if you are running a multi-user proxy.
408 * Revision 1.6 2001/10/14 22:00:32 jongfoster
409 * Adding support for a 404 error when an invalid CGI page is requested.
411 * Revision 1.5 2001/10/07 15:30:41 oes
412 * Removed FEATURE_DENY_GZIP
414 * Revision 1.4 2001/10/02 15:31:12 oes
415 * Introduced show-request cgi
417 * Revision 1.3 2001/09/22 16:34:44 jongfoster
418 * Removing unneeded #includes
420 * Revision 1.2 2001/09/19 18:01:11 oes
421 * Fixed comments; cosmetics
423 * Revision 1.1 2001/09/16 17:08:54 jongfoster
424 * Moving simple CGI functions from cgi.c to new file cgisimple.c
427 **********************************************************************/
433 #include <sys/types.h>
441 #endif /* def HAVE_ACCESS */
445 #include "cgisimple.h"
451 #include "miscutil.h"
454 #include "urlmatch.h"
457 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
459 static char *show_rcs(void);
460 static jb_err show_defines(struct map *exports);
461 static jb_err cgi_show_file(struct client_state *csp,
462 struct http_response *rsp,
463 const struct map *parameters);
464 static jb_err load_file(const char *filename, char **buffer, size_t *length);
466 /*********************************************************************
468 * Function : cgi_default
470 * Description : CGI function that is called for the CGI_SITE_1_HOST
471 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
472 * Boring - only exports the default exports.
475 * 1 : csp = Current client state (buffers, headers, etc...)
476 * 2 : rsp = http_response data structure for output
477 * 3 : parameters = map of cgi parameters
479 * CGI Parameters : none
481 * Returns : JB_ERR_OK on success
482 * JB_ERR_MEMORY on out-of-memory
484 *********************************************************************/
485 jb_err cgi_default(struct client_state *csp,
486 struct http_response *rsp,
487 const struct map *parameters)
494 if (NULL == (exports = default_exports(csp, "")))
496 return JB_ERR_MEMORY;
499 return template_fill_for_cgi(csp, "default", exports, rsp);
503 /*********************************************************************
505 * Function : cgi_error_404
507 * Description : CGI function that is called if an unknown action was
511 * 1 : csp = Current client state (buffers, headers, etc...)
512 * 2 : rsp = http_response data structure for output
513 * 3 : parameters = map of cgi parameters
515 * CGI Parameters : none
517 * Returns : JB_ERR_OK on success
518 * JB_ERR_MEMORY on out-of-memory error.
520 *********************************************************************/
521 jb_err cgi_error_404(struct client_state *csp,
522 struct http_response *rsp,
523 const struct map *parameters)
531 if (NULL == (exports = default_exports(csp, NULL)))
533 return JB_ERR_MEMORY;
536 rsp->status = strdup("404 Privoxy configuration page not found");
537 if (rsp->status == NULL)
540 return JB_ERR_MEMORY;
543 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
547 #ifdef FEATURE_GRACEFUL_TERMINATION
548 /*********************************************************************
552 * Description : CGI function to shut down Privoxy.
553 * NOTE: Turning this on in a production build
554 * would be a BAD idea. An EXTREMELY BAD idea.
555 * In short, don't do it.
558 * 1 : csp = Current client state (buffers, headers, etc...)
559 * 2 : rsp = http_response data structure for output
560 * 3 : parameters = map of cgi parameters
562 * CGI Parameters : none
564 * Returns : JB_ERR_OK on success
565 * JB_ERR_MEMORY on out-of-memory error.
567 *********************************************************************/
568 jb_err cgi_die (struct client_state *csp,
569 struct http_response *rsp,
570 const struct map *parameters)
580 * I don't really care what gets sent back to the browser.
581 * Take the easy option - "out of memory" page.
584 return JB_ERR_MEMORY;
586 #endif /* def FEATURE_GRACEFUL_TERMINATION */
589 /*********************************************************************
591 * Function : cgi_show_request
593 * Description : Show the client's request and what sed() would have
597 * 1 : csp = Current client state (buffers, headers, etc...)
598 * 2 : rsp = http_response data structure for output
599 * 3 : parameters = map of cgi parameters
601 * CGI Parameters : none
603 * Returns : JB_ERR_OK on success
604 * JB_ERR_MEMORY on out-of-memory error.
606 *********************************************************************/
607 jb_err cgi_show_request(struct client_state *csp,
608 struct http_response *rsp,
609 const struct map *parameters)
618 if (NULL == (exports = default_exports(csp, "show-request")))
620 return JB_ERR_MEMORY;
624 * Repair the damage done to the IOB by get_header()
626 for (p = csp->iob->buf; p < csp->iob->eod; p++)
628 if (*p == '\0') *p = '\n';
632 * Export the original client's request and the one we would
633 * be sending to the server if this wasn't a CGI call
636 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
639 return JB_ERR_MEMORY;
642 if (map(exports, "processed-request", 1,
643 html_encode_and_free_original(list_to_text(csp->headers)), 0))
646 return JB_ERR_MEMORY;
649 return template_fill_for_cgi(csp, "show-request", exports, rsp);
653 /*********************************************************************
655 * Function : cgi_send_banner
657 * Description : CGI function that returns a banner.
660 * 1 : csp = Current client state (buffers, headers, etc...)
661 * 2 : rsp = http_response data structure for output
662 * 3 : parameters = map of cgi parameters
665 * type : Selects the type of banner between "trans", "logo",
666 * and "auto". Defaults to "logo" if absent or invalid.
667 * "auto" means to select as if we were image-blocking.
668 * (Only the first character really counts; b and t are
671 * Returns : JB_ERR_OK on success
672 * JB_ERR_MEMORY on out-of-memory error.
674 *********************************************************************/
675 jb_err cgi_send_banner(struct client_state *csp,
676 struct http_response *rsp,
677 const struct map *parameters)
679 char imagetype = lookup(parameters, "type")[0];
682 * If type is auto, then determine the right thing
683 * to do from the set-image-blocker action
685 if (imagetype == 'a')
692 #ifdef FEATURE_IMAGE_BLOCKING
693 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
695 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
696 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
697 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
701 /* Use default - nothing to do here. */
703 else if (0 == strcmpic(p, "blank"))
707 else if (0 == strcmpic(p, "pattern"))
713 * If the action is to call this CGI, determine
716 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
718 imagetype = p[sizeof(prefix1) - 1];
720 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
722 imagetype = p[sizeof(prefix2) - 1];
726 * Everything else must (should) be a URL to
734 #endif /* def FEATURE_IMAGE_BLOCKING */
738 * Now imagetype is either the non-auto type we were called with,
739 * or it was auto and has since been determined. In any case, we
740 * can proceed to actually answering the request by sending a redirect
741 * or an image as appropriate:
743 if (imagetype == 'r')
745 rsp->status = strdup("302 Local Redirect from Privoxy");
746 if (rsp->status == NULL)
748 return JB_ERR_MEMORY;
750 if (enlist_unique_header(rsp->headers, "Location",
751 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
753 return JB_ERR_MEMORY;
758 if ((imagetype == 'b') || (imagetype == 't'))
760 rsp->body = bindup(image_blank_data, image_blank_length);
761 rsp->content_length = image_blank_length;
765 rsp->body = bindup(image_pattern_data, image_pattern_length);
766 rsp->content_length = image_pattern_length;
769 if (rsp->body == NULL)
771 return JB_ERR_MEMORY;
773 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
775 return JB_ERR_MEMORY;
786 /*********************************************************************
788 * Function : cgi_transparent_image
790 * Description : CGI function that sends a 1x1 transparent image.
793 * 1 : csp = Current client state (buffers, headers, etc...)
794 * 2 : rsp = http_response data structure for output
795 * 3 : parameters = map of cgi parameters
797 * CGI Parameters : None
799 * Returns : JB_ERR_OK on success
800 * JB_ERR_MEMORY on out-of-memory error.
802 *********************************************************************/
803 jb_err cgi_transparent_image(struct client_state *csp,
804 struct http_response *rsp,
805 const struct map *parameters)
807 rsp->body = bindup(image_blank_data, image_blank_length);
808 rsp->content_length = image_blank_length;
810 if (rsp->body == NULL)
812 return JB_ERR_MEMORY;
815 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
817 return JB_ERR_MEMORY;
827 /*********************************************************************
829 * Function : cgi_send_default_favicon
831 * Description : CGI function that sends the standard favicon.
834 * 1 : csp = Current client state (buffers, headers, etc...)
835 * 2 : rsp = http_response data structure for output
836 * 3 : parameters = map of cgi parameters
838 * CGI Parameters : None
840 * Returns : JB_ERR_OK on success
841 * JB_ERR_MEMORY on out-of-memory error.
843 *********************************************************************/
844 jb_err cgi_send_default_favicon(struct client_state *csp,
845 struct http_response *rsp,
846 const struct map *parameters)
848 static const char default_favicon_data[] =
849 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
850 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
851 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
852 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
853 "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
854 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
855 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
856 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
857 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
858 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
859 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
860 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
861 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
863 static const size_t favicon_length = sizeof(default_favicon_data) - 1;
865 rsp->body = bindup(default_favicon_data, favicon_length);
866 rsp->content_length = favicon_length;
868 if (rsp->body == NULL)
870 return JB_ERR_MEMORY;
873 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
875 return JB_ERR_MEMORY;
885 /*********************************************************************
887 * Function : cgi_send_error_favicon
889 * Description : CGI function that sends the favicon for error pages.
892 * 1 : csp = Current client state (buffers, headers, etc...)
893 * 2 : rsp = http_response data structure for output
894 * 3 : parameters = map of cgi parameters
896 * CGI Parameters : None
898 * Returns : JB_ERR_OK on success
899 * JB_ERR_MEMORY on out-of-memory error.
901 *********************************************************************/
902 jb_err cgi_send_error_favicon(struct client_state *csp,
903 struct http_response *rsp,
904 const struct map *parameters)
906 static const char error_favicon_data[] =
907 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
908 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
909 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
910 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
911 "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
912 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
913 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
914 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
915 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
916 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
917 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
918 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
919 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
921 static const size_t favicon_length = sizeof(error_favicon_data) - 1;
923 rsp->body = bindup(error_favicon_data, favicon_length);
924 rsp->content_length = favicon_length;
926 if (rsp->body == NULL)
928 return JB_ERR_MEMORY;
931 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
933 return JB_ERR_MEMORY;
943 /*********************************************************************
945 * Function : cgi_send_stylesheet
947 * Description : CGI function that sends a css stylesheet found
948 * in the cgi-style.css template
951 * 1 : csp = Current client state (buffers, headers, etc...)
952 * 2 : rsp = http_response data structure for output
953 * 3 : parameters = map of cgi parameters
955 * CGI Parameters : None
957 * Returns : JB_ERR_OK on success
958 * JB_ERR_MEMORY on out-of-memory error.
960 *********************************************************************/
961 jb_err cgi_send_stylesheet(struct client_state *csp,
962 struct http_response *rsp,
963 const struct map *parameters)
970 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
972 if (err == JB_ERR_FILE)
975 * No way to tell user; send empty stylesheet
977 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
981 return err; /* JB_ERR_MEMORY */
984 if (enlist(rsp->headers, "Content-Type: text/css"))
986 return JB_ERR_MEMORY;
994 /*********************************************************************
996 * Function : cgi_send_url_info_osd
998 * Description : CGI function that sends the OpenSearch Description
999 * template for the show-url-info page. It allows to
1000 * access the page through "search engine plugins".
1003 * 1 : csp = Current client state (buffers, headers, etc...)
1004 * 2 : rsp = http_response data structure for output
1005 * 3 : parameters = map of cgi parameters
1007 * CGI Parameters : None
1009 * Returns : JB_ERR_OK on success
1010 * JB_ERR_MEMORY on out-of-memory error.
1012 *********************************************************************/
1013 jb_err cgi_send_url_info_osd(struct client_state *csp,
1014 struct http_response *rsp,
1015 const struct map *parameters)
1017 jb_err err = JB_ERR_MEMORY;
1018 struct map *exports = default_exports(csp, NULL);
1020 if (NULL != exports)
1022 err = template_fill_for_cgi(csp, "url-info-osd.xml", exports, rsp);
1023 if (JB_ERR_OK == err)
1025 err = enlist(rsp->headers,
1026 "Content-Type: application/opensearchdescription+xml");
1035 /*********************************************************************
1037 * Function : cgi_send_user_manual
1039 * Description : CGI function that sends a file in the user
1043 * 1 : csp = Current client state (buffers, headers, etc...)
1044 * 2 : rsp = http_response data structure for output
1045 * 3 : parameters = map of cgi parameters
1047 * CGI Parameters : file=name.html, the name of the HTML file
1048 * (relative to user-manual from config)
1050 * Returns : JB_ERR_OK on success
1051 * JB_ERR_MEMORY on out-of-memory error.
1053 *********************************************************************/
1054 jb_err cgi_send_user_manual(struct client_state *csp,
1055 struct http_response *rsp,
1056 const struct map *parameters)
1058 const char * filename;
1060 jb_err err = JB_ERR_OK;
1067 if (!parameters->first)
1069 /* requested http://p.p/user-manual (without trailing slash) */
1070 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
1073 get_string_param(parameters, "file", &filename);
1074 /* Check paramter for hack attempts */
1075 if (filename && strchr(filename, '/'))
1077 return JB_ERR_CGI_PARAMS;
1079 if (filename && strstr(filename, ".."))
1081 return JB_ERR_CGI_PARAMS;
1084 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
1085 if (full_path == NULL)
1087 return JB_ERR_MEMORY;
1090 err = load_file(full_path, &rsp->body, &rsp->content_length);
1091 if (JB_ERR_OK != err)
1093 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1094 if (JB_ERR_FILE == err)
1096 err = cgi_error_no_template(csp, rsp, full_path);
1103 /* Guess correct Content-Type based on the filename's ending */
1106 length = strlen(filename);
1112 if((length>=4) && !strcmp(&filename[length-4], ".css"))
1114 err = enlist(rsp->headers, "Content-Type: text/css");
1116 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
1118 err = enlist(rsp->headers, "Content-Type: image/jpeg");
1122 err = enlist(rsp->headers, "Content-Type: text/html");
1129 /*********************************************************************
1131 * Function : cgi_show_version
1133 * Description : CGI function that returns a a web page describing the
1134 * file versions of Privoxy.
1137 * 1 : csp = Current client state (buffers, headers, etc...)
1138 * 2 : rsp = http_response data structure for output
1139 * 3 : parameters = map of cgi parameters
1141 * CGI Parameters : none
1143 * Returns : JB_ERR_OK on success
1144 * JB_ERR_MEMORY on out-of-memory error.
1146 *********************************************************************/
1147 jb_err cgi_show_version(struct client_state *csp,
1148 struct http_response *rsp,
1149 const struct map *parameters)
1151 struct map *exports;
1157 if (NULL == (exports = default_exports(csp, "show-version")))
1159 return JB_ERR_MEMORY;
1162 if (map(exports, "sourceversions", 1, show_rcs(), 0))
1165 return JB_ERR_MEMORY;
1168 return template_fill_for_cgi(csp, "show-version", exports, rsp);
1172 /*********************************************************************
1174 * Function : cgi_show_status
1176 * Description : CGI function that returns a web page describing the
1177 * current status of Privoxy.
1180 * 1 : csp = Current client state (buffers, headers, etc...)
1181 * 2 : rsp = http_response data structure for output
1182 * 3 : parameters = map of cgi parameters
1185 * file : Which file to show. Only first letter is checked,
1190 * Default is to show menu and other information.
1192 * Returns : JB_ERR_OK on success
1193 * JB_ERR_MEMORY on out-of-memory error.
1195 *********************************************************************/
1196 jb_err cgi_show_status(struct client_state *csp,
1197 struct http_response *rsp,
1198 const struct map *parameters)
1204 char buf[BUFFER_SIZE];
1205 #ifdef FEATURE_STATISTICS
1206 float perc_rej; /* Percentage of http requests rejected */
1207 int local_urls_read;
1208 int local_urls_rejected;
1209 #endif /* ndef FEATURE_STATISTICS */
1210 jb_err err = JB_ERR_OK;
1212 struct map *exports;
1218 if ('\0' != *(lookup(parameters, "file")))
1220 return cgi_show_file(csp, rsp, parameters);
1223 if (NULL == (exports = default_exports(csp, "show-status")))
1225 return JB_ERR_MEMORY;
1229 for (j = 0; (s != NULL) && (j < Argc); j++)
1231 if (!err) err = string_join (&s, html_encode(Argv[j]));
1232 if (!err) err = string_append(&s, " ");
1234 if (!err) err = map(exports, "invocation", 1, s, 0);
1236 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1237 if (!err) err = show_defines(exports);
1242 return JB_ERR_MEMORY;
1245 #ifdef FEATURE_STATISTICS
1246 local_urls_read = urls_read;
1247 local_urls_rejected = urls_rejected;
1250 * Need to alter the stats not to include the fetch of this
1253 * Can't do following thread safely! doh!
1256 * urls_rejected--; * This will be incremented subsequently *
1259 if (local_urls_read == 0)
1261 if (!err) err = map_block_killer(exports, "have-stats");
1265 if (!err) err = map_block_killer(exports, "have-no-stats");
1267 perc_rej = (float)local_urls_rejected * 100.0F /
1268 (float)local_urls_read;
1270 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1271 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1273 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1274 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1276 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1277 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1280 #else /* ndef FEATURE_STATISTICS */
1281 err = err || map_block_killer(exports, "statistics");
1282 #endif /* ndef FEATURE_STATISTICS */
1285 * List all action files in use, together with view and edit links,
1286 * except for standard.action, which should only be viewable. (Not
1287 * enforced in the editor itself)
1288 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1291 for (i = 0; i < MAX_AF_FILES; i++)
1293 if (csp->actions_list[i] != NULL)
1295 if (!err) err = string_append(&s, "<tr><td>");
1296 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1297 snprintf(buf, sizeof(buf),
1298 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1299 if (!err) err = string_append(&s, buf);
1301 #ifdef FEATURE_CGI_EDIT_ACTIONS
1302 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1303 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
1304 && (NULL != csp->config->actions_file_short[i]))
1307 if (access(csp->config->actions_file[i], W_OK) == 0)
1309 #endif /* def HAVE_ACCESS */
1310 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%d\">Edit</a>", i);
1311 if (!err) err = string_append(&s, buf);
1316 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
1318 #endif /* def HAVE_ACCESS */
1322 if (!err) err = string_append(&s, "</td></tr>\n");
1327 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1331 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1335 * List all re_filterfiles in use, together with view options.
1336 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1339 for (i = 0; i < MAX_AF_FILES; i++)
1341 if (csp->rlist[i] != NULL)
1343 if (!err) err = string_append(&s, "<tr><td>");
1344 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1346 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1347 if (!err) err = string_append(&s, buf);
1348 if (!err) err = string_append(&s, "</td></tr>\n");
1353 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1357 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1358 if (!err) err = map_block_killer(exports, "have-filterfile");
1361 #ifdef FEATURE_TRUST
1364 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1368 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1369 if (!err) err = map_block_killer(exports, "have-trustfile");
1372 if (!err) err = map_block_killer(exports, "trust-support");
1373 #endif /* ndef FEATURE_TRUST */
1375 #ifdef FEATURE_CGI_EDIT_ACTIONS
1376 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1378 err = map_block_killer(exports, "cgi-editor-is-disabled");
1380 #endif /* ndef CGI_EDIT_ACTIONS */
1385 return JB_ERR_MEMORY;
1388 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1392 /*********************************************************************
1394 * Function : cgi_show_url_info
1396 * Description : CGI function that determines and shows which actions
1397 * Privoxy will perform for a given url, and which
1398 * matches starting from the defaults have lead to that.
1401 * 1 : csp = Current client state (buffers, headers, etc...)
1402 * 2 : rsp = http_response data structure for output
1403 * 3 : parameters = map of cgi parameters
1406 * url : The url whose actions are to be determined.
1407 * If url is unset, the url-given conditional will be
1408 * set, so that all but the form can be suppressed in
1411 * Returns : JB_ERR_OK on success
1412 * JB_ERR_MEMORY on out-of-memory error.
1414 *********************************************************************/
1415 jb_err cgi_show_url_info(struct client_state *csp,
1416 struct http_response *rsp,
1417 const struct map *parameters)
1420 struct map *exports;
1427 if (NULL == (exports = default_exports(csp, "show-url-info")))
1429 return JB_ERR_MEMORY;
1433 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1435 url_param = strdup(lookup(parameters, "url"));
1436 if (url_param == NULL)
1439 return JB_ERR_MEMORY;
1444 * Handle prefixes. 4 possibilities:
1445 * 1) "http://" or "https://" prefix present and followed by URL - OK
1446 * 2) Only the "http://" or "https://" part is present, no URL - change
1447 * to empty string so it will be detected later as "no URL".
1448 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1450 * 4) Parameter not specified or is empty string - let this fall through
1451 * for now, next block of code will handle it.
1453 if (0 == strncmp(url_param, "http://", 7))
1455 if (url_param[7] == '\0')
1458 * Empty URL (just prefix).
1459 * Make it totally empty so it's caught by the next if()
1461 url_param[0] = '\0';
1464 else if (0 == strncmp(url_param, "https://", 8))
1466 if (url_param[8] == '\0')
1469 * Empty URL (just prefix).
1470 * Make it totally empty so it's caught by the next if()
1472 url_param[0] = '\0';
1475 else if ((url_param[0] != '\0') && (NULL == strstr(url_param, "://")))
1477 /* No prefix - assume http:// */
1478 char *url_param_prefixed = strdup("http://");
1480 if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1483 return JB_ERR_MEMORY;
1485 url_param = url_param_prefixed;
1489 * Hide "toggle off" warning if Privoxy is toggled on.
1492 #ifdef FEATURE_TOGGLE
1493 (global_toggle_state == 1) &&
1494 #endif /* def FEATURE_TOGGLE */
1495 map_block_killer(exports, "privoxy-is-toggled-off")
1499 return JB_ERR_MEMORY;
1502 if (url_param[0] == '\0')
1504 /* URL paramater not specified, display query form only. */
1506 if (map_block_killer(exports, "url-given")
1507 || map(exports, "url", 1, "", 1))
1510 return JB_ERR_MEMORY;
1515 /* Given a URL, so query it. */
1520 struct file_list *fl;
1521 struct url_actions *b;
1522 struct http_request url_to_query[1];
1523 struct current_action_spec action[1];
1526 if (map(exports, "url", 1, html_encode(url_param), 0))
1530 return JB_ERR_MEMORY;
1533 init_current_action(action);
1535 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1537 free_current_action(action);
1540 return JB_ERR_MEMORY;
1543 memset(url_to_query, '\0', sizeof(url_to_query));
1544 err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1545 assert((err != JB_ERR_OK) || (url_to_query->ssl == !strncmpic(url_param, "https://", 8)));
1549 if (err == JB_ERR_MEMORY)
1551 free_http_request(url_to_query);
1552 free_current_action(action);
1554 return JB_ERR_MEMORY;
1560 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1561 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1562 if (!err) err = map_block_killer(exports, "valid-url");
1564 free_current_action(action);
1565 free_http_request(url_to_query);
1570 return JB_ERR_MEMORY;
1573 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1577 * We have a warning about SSL paths. Hide it for unencrypted sites.
1579 if (!url_to_query->ssl)
1581 if (map_block_killer(exports, "https"))
1583 free_current_action(action);
1585 free_http_request(url_to_query);
1586 return JB_ERR_MEMORY;
1590 matches = strdup("<table summary=\"\" class=\"transparent\">");
1592 for (i = 0; i < MAX_AF_FILES; i++)
1594 if (NULL == csp->config->actions_file_short[i]
1595 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1599 if ((fl = csp->actions_list[i]) != NULL)
1601 if ((b = fl->f) != NULL)
1603 /* FIXME: Hardcoded HTML! */
1604 string_append(&matches, "<tr><th>In file: ");
1605 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1606 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1607 string_append(&matches, buf);
1608 string_append(&matches, "View</a>");
1609 #ifdef FEATURE_CGI_EDIT_ACTIONS
1610 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1613 if (access(csp->config->actions_file[i], W_OK) == 0)
1615 #endif /* def HAVE_ACCESS */
1616 snprintf(buf, sizeof(buf),
1617 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1618 string_append(&matches, buf);
1619 string_append(&matches, "Edit</a>");
1624 string_append(&matches, " <strong>No write access.</strong>");
1626 #endif /* def HAVE_ACCESS */
1628 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1630 string_append(&matches, "</th></tr>\n");
1637 for (; (b != NULL) && (matches != NULL); b = b->next)
1639 if (url_match(b->url, url_to_query))
1641 string_append(&matches, "<tr><td>{");
1642 string_join (&matches, actions_to_html(csp, b->action));
1643 string_append(&matches, " }<br>\n<code>");
1644 string_join (&matches, html_encode(b->url->spec));
1645 string_append(&matches, "</code></td></tr>\n");
1647 if (merge_current_action(action, b->action))
1650 free_http_request(url_to_query);
1651 free_current_action(action);
1653 return JB_ERR_MEMORY;
1661 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1664 string_append(&matches, "</table>\n");
1667 * XXX: Kludge to make sure the "Forward settings" section
1668 * shows what forward-override{} would do with the requested URL.
1669 * No one really cares how the CGI request would be forwarded
1670 * if it wasn't intercepted as CGI request in the first place.
1672 * From here on the action bitmask will no longer reflect
1673 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1674 * but luckily it's no longer required later on anyway.
1676 free_current_action(csp->action);
1677 get_url_actions(csp, url_to_query);
1680 * Fill in forwarding settings.
1682 * The possibilities are:
1684 * - http forwarding only
1685 * - socks4(a) forwarding only
1686 * - socks4(a) and http forwarding.
1688 * XXX: Parts of this code could be reused for the
1689 * "forwarding-failed" template which currently doesn't
1690 * display the proxy port and an eventual second forwarder.
1693 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1695 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1697 if (!err) err = map_block_killer(exports, "socks-forwarder");
1698 if (!err) err = map_block_killer(exports, "http-forwarder");
1702 char port[10]; /* We save proxy ports as int but need a string here */
1704 if (!err) err = map_block_killer(exports, "no-forwarder");
1706 if (fwd->gateway_host != NULL)
1708 char *socks_type = NULL;
1713 socks_type = "socks4";
1716 socks_type = "socks4a";
1719 socks_type = "socks5";
1722 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1725 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1726 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1727 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1728 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1732 if (!err) err = map_block_killer(exports, "socks-forwarder");
1735 if (fwd->forward_host != NULL)
1737 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1738 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1739 if (!err) err = map(exports, "forward-port", 1, port, 1);
1743 if (!err) err = map_block_killer(exports, "http-forwarder");
1748 free_http_request(url_to_query);
1750 if (err || matches == NULL)
1752 free_current_action(action);
1754 return JB_ERR_MEMORY;
1757 #ifdef FEATURE_CGI_EDIT_ACTIONS
1758 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1760 err = map_block_killer(exports, "cgi-editor-is-disabled");
1762 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1765 * If zlib support is available, if no content filters
1766 * are enabled or if the prevent-compression action is enabled,
1767 * suppress the "compression could prevent filtering" warning.
1769 #ifndef FEATURE_ZLIB
1770 if (!content_filters_enabled(action) ||
1771 (action->flags & ACTION_NO_COMPRESSION))
1774 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1777 if (err || map(exports, "matches", 1, matches , 0))
1779 free_current_action(action);
1781 return JB_ERR_MEMORY;
1784 s = current_action_to_html(csp, action);
1786 free_current_action(action);
1788 if (map(exports, "final", 1, s, 0))
1791 return JB_ERR_MEMORY;
1795 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1799 /*********************************************************************
1801 * Function : cgi_robots_txt
1803 * Description : CGI function to return "/robots.txt".
1806 * 1 : csp = Current client state (buffers, headers, etc...)
1807 * 2 : rsp = http_response data structure for output
1808 * 3 : parameters = map of cgi parameters
1810 * CGI Parameters : None
1812 * Returns : JB_ERR_OK on success
1813 * JB_ERR_MEMORY on out-of-memory error.
1815 *********************************************************************/
1816 jb_err cgi_robots_txt(struct client_state *csp,
1817 struct http_response *rsp,
1818 const struct map *parameters)
1824 "# This is the Privoxy control interface.\n"
1825 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1831 if (rsp->body == NULL)
1833 return JB_ERR_MEMORY;
1836 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1840 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1841 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1843 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1847 /*********************************************************************
1849 * Function : show_defines
1851 * Description : Add to a map the state od all conditional #defines
1852 * used when building
1855 * 1 : exports = map to extend
1857 * Returns : JB_ERR_OK on success
1858 * JB_ERR_MEMORY on out-of-memory error.
1860 *********************************************************************/
1861 static jb_err show_defines(struct map *exports)
1863 jb_err err = JB_ERR_OK;
1866 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1867 #else /* ifndef FEATURE_ACL */
1868 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1869 #endif /* ndef FEATURE_ACL */
1871 #ifdef FEATURE_CGI_EDIT_ACTIONS
1872 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1873 #else /* ifndef FEATURE_CGI_EDIT_ACTIONS */
1874 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1875 #endif /* ndef FEATURE_CGI_EDIT_ACTIONS */
1877 #ifdef FEATURE_COOKIE_JAR
1878 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1879 #else /* ifndef FEATURE_COOKIE_JAR */
1880 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1881 #endif /* ndef FEATURE_COOKIE_JAR */
1883 #ifdef FEATURE_FAST_REDIRECTS
1884 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1885 #else /* ifndef FEATURE_FAST_REDIRECTS */
1886 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1887 #endif /* ndef FEATURE_FAST_REDIRECTS */
1889 #ifdef FEATURE_FORCE_LOAD
1890 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1891 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1892 #else /* ifndef FEATURE_FORCE_LOAD */
1893 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1894 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1895 #endif /* ndef FEATURE_FORCE_LOAD */
1897 #ifdef FEATURE_GRACEFUL_TERMINATION
1898 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1899 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1900 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1901 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1903 #ifdef FEATURE_IMAGE_BLOCKING
1904 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1905 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1906 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1907 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1909 #ifdef FEATURE_IMAGE_DETECT_MSIE
1910 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1911 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1912 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1913 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1915 #ifdef FEATURE_NO_GIFS
1916 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1917 #else /* ifndef FEATURE_NO_GIFS */
1918 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1919 #endif /* ndef FEATURE_NO_GIFS */
1921 #ifdef FEATURE_PTHREAD
1922 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1923 #else /* ifndef FEATURE_PTHREAD */
1924 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1925 #endif /* ndef FEATURE_PTHREAD */
1927 #ifdef FEATURE_STATISTICS
1928 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1929 #else /* ifndef FEATURE_STATISTICS */
1930 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1931 #endif /* ndef FEATURE_STATISTICS */
1933 #ifdef FEATURE_TOGGLE
1934 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1935 #else /* ifndef FEATURE_TOGGLE */
1936 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1937 #endif /* ndef FEATURE_TOGGLE */
1939 #ifdef FEATURE_TRUST
1940 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1941 #else /* ifndef FEATURE_TRUST */
1942 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1943 #endif /* ndef FEATURE_TRUST */
1946 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1947 #else /* ifndef FEATURE_ZLIB */
1948 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1949 #endif /* ndef FEATURE_ZLIB */
1952 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1953 #else /* ifndef STATIC_PCRE */
1954 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1955 #endif /* ndef STATIC_PCRE */
1958 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1959 #else /* ifndef STATIC_PCRS */
1960 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1961 #endif /* ndef STATIC_PCRS */
1967 /*********************************************************************
1969 * Function : show_rcs
1971 * Description : Create a string with the rcs info for all sourcefiles
1975 * Returns : A string, or NULL on out-of-memory.
1977 *********************************************************************/
1978 static char *show_rcs(void)
1980 char *result = strdup("");
1981 char buf[BUFFER_SIZE];
1983 /* Instead of including *all* dot h's in the project (thus creating a
1984 * tremendous amount of dependencies), I will concede to declaring them
1985 * as extern's. This forces the developer to add to this list, but oh well.
1988 #define SHOW_RCS(__x) \
1990 extern const char __x[]; \
1991 snprintf(buf, sizeof(buf), " %s\n", __x); \
1992 string_append(&result, buf); \
1995 /* In alphabetical order */
1996 SHOW_RCS(actions_h_rcs)
1997 SHOW_RCS(actions_rcs)
1999 SHOW_RCS(amiga_h_rcs)
2001 #endif /* def AMIGA */
2004 #ifdef FEATURE_CGI_EDIT_ACTIONS
2005 SHOW_RCS(cgiedit_h_rcs)
2006 SHOW_RCS(cgiedit_rcs)
2007 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
2008 SHOW_RCS(cgisimple_h_rcs)
2009 SHOW_RCS(cgisimple_rcs)
2011 SHOW_RCS(cygwin_h_rcs)
2013 SHOW_RCS(deanimate_h_rcs)
2014 SHOW_RCS(deanimate_rcs)
2015 SHOW_RCS(encode_h_rcs)
2016 SHOW_RCS(encode_rcs)
2017 SHOW_RCS(errlog_h_rcs)
2018 SHOW_RCS(errlog_rcs)
2019 SHOW_RCS(filters_h_rcs)
2020 SHOW_RCS(filters_rcs)
2021 SHOW_RCS(gateway_h_rcs)
2022 SHOW_RCS(gateway_rcs)
2023 SHOW_RCS(jbsockets_h_rcs)
2024 SHOW_RCS(jbsockets_rcs)
2027 SHOW_RCS(list_h_rcs)
2029 SHOW_RCS(loadcfg_h_rcs)
2030 SHOW_RCS(loadcfg_rcs)
2031 SHOW_RCS(loaders_h_rcs)
2032 SHOW_RCS(loaders_rcs)
2033 SHOW_RCS(miscutil_h_rcs)
2034 SHOW_RCS(miscutil_rcs)
2035 SHOW_RCS(parsers_h_rcs)
2036 SHOW_RCS(parsers_rcs)
2038 SHOW_RCS(pcrs_h_rcs)
2039 SHOW_RCS(project_h_rcs)
2040 SHOW_RCS(ssplit_h_rcs)
2041 SHOW_RCS(ssplit_rcs)
2042 SHOW_RCS(urlmatch_h_rcs)
2043 SHOW_RCS(urlmatch_rcs)
2045 #ifndef _WIN_CONSOLE
2046 SHOW_RCS(w32log_h_rcs)
2047 SHOW_RCS(w32log_rcs)
2048 SHOW_RCS(w32res_h_rcs)
2049 SHOW_RCS(w32taskbar_h_rcs)
2050 SHOW_RCS(w32taskbar_rcs)
2051 #endif /* ndef _WIN_CONSOLE */
2052 SHOW_RCS(win32_h_rcs)
2054 #endif /* def _WIN32 */
2063 /*********************************************************************
2065 * Function : cgi_show_file
2067 * Description : CGI function that shows the content of a
2068 * configuration file.
2071 * 1 : csp = Current client state (buffers, headers, etc...)
2072 * 2 : rsp = http_response data structure for output
2073 * 3 : parameters = map of cgi parameters
2076 * file : Which file to show. Only first letter is checked,
2081 * Default is to show menu and other information.
2083 * Returns : JB_ERR_OK on success
2084 * JB_ERR_MEMORY on out-of-memory error.
2086 *********************************************************************/
2087 static jb_err cgi_show_file(struct client_state *csp,
2088 struct http_response *rsp,
2089 const struct map *parameters)
2092 const char * filename = NULL;
2093 char * file_description = NULL;
2099 switch (*(lookup(parameters, "file")))
2102 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2104 filename = csp->actions_list[i]->filename;
2105 file_description = "Actions File";
2110 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2112 filename = csp->rlist[i]->filename;
2113 file_description = "Filter File";
2117 #ifdef FEATURE_TRUST
2121 filename = csp->tlist->filename;
2122 file_description = "Trust File";
2125 #endif /* def FEATURE_TRUST */
2128 if (NULL != filename)
2130 struct map *exports;
2135 exports = default_exports(csp, "show-status");
2136 if (NULL == exports)
2138 return JB_ERR_MEMORY;
2141 if ( map(exports, "file-description", 1, file_description, 1)
2142 || map(exports, "filepath", 1, html_encode(filename), 0) )
2145 return JB_ERR_MEMORY;
2148 err = load_file(filename, &s, &length);
2149 if (JB_ERR_OK != err)
2151 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2154 return JB_ERR_MEMORY;
2159 s = html_encode_and_free_original(s);
2162 return JB_ERR_MEMORY;
2165 if (map(exports, "contents", 1, s, 0))
2168 return JB_ERR_MEMORY;
2172 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2175 return JB_ERR_CGI_PARAMS;
2179 /*********************************************************************
2181 * Function : load_file
2183 * Description : Loads a file into a buffer.
2186 * 1 : filename = Name of the file to be loaded.
2187 * 2 : buffer = Used to return the file's content.
2188 * 3 : length = Used to return the size of the file.
2190 * Returns : JB_ERR_OK in case of success,
2191 * JB_ERR_FILE in case of ordinary file loading errors
2192 * (fseek() and ftell() errors are fatal)
2193 * JB_ERR_MEMORY in case of out-of-memory.
2195 *********************************************************************/
2196 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2200 jb_err err = JB_ERR_OK;
2202 fp = fopen(filename, "rb");
2208 /* Get file length */
2209 if (fseek(fp, 0, SEEK_END))
2211 log_error(LOG_LEVEL_FATAL,
2212 "Unexpected error while fseek()ing to the end of %s: %E",
2218 log_error(LOG_LEVEL_FATAL,
2219 "Unexpected ftell() error while loading %s: %E",
2222 *length = (size_t)ret;
2224 /* Go back to the beginning. */
2225 if (fseek(fp, 0, SEEK_SET))
2227 log_error(LOG_LEVEL_FATAL,
2228 "Unexpected error while fseek()ing to the beginning of %s: %E",
2232 *buffer = (char *)zalloc(*length + 1);
2233 if (NULL == *buffer)
2235 err = JB_ERR_MEMORY;
2237 else if (!fread(*buffer, *length, 1, fp))
2240 * May happen if the file size changes between fseek() and
2241 * fread(). If it does, we just log it and serve what we got.
2243 log_error(LOG_LEVEL_ERROR,
2244 "Couldn't completely read file %s.", filename);