1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.80 2008/05/04 16:18:32 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.80 2008/05/04 16:18:32 fabiankeil
40 * Provide parse_http_url() with a third parameter to specify
41 * whether or not URLs without protocol are acceptable.
43 * Revision 1.79 2008/05/04 13:30:56 fabiankeil
44 * Streamline parse_http_url()'s prototype.
46 * Revision 1.78 2008/05/03 16:50:11 fabiankeil
47 * Leverage content_filters_enabled() in cgi_show_url_info().
49 * Revision 1.77 2008/05/02 09:47:48 fabiankeil
50 * In cgi_show_url_info, pass an initialized http structure
51 * to parse_http_url() as that will be required soonish and
52 * assert that https URLs are recognized correctly.
54 * Revision 1.76 2008/04/28 09:13:30 fabiankeil
55 * In load_file(), remember the error reason and fclose()
56 * and return later on instead of right away.
58 * Revision 1.75 2008/04/27 13:52:52 fabiankeil
59 * Move CGI file loading code into load_file() and
60 * add checks for unexpected errors.
62 * Revision 1.74 2008/04/26 15:50:56 fabiankeil
63 * Fix macro name in cgi_show_file() error path.
65 * Revision 1.73 2008/04/26 12:21:55 fabiankeil
66 * Forget about JB_ERR_PARSE. JB_ERR_CGI_PARAMS to the rescue.
68 * Revision 1.72 2008/04/26 10:34:15 fabiankeil
69 * If zlib support is unavailable and there are content filters active
70 * but the prevent-compression action is disabled, include a warning
71 * on the show-url-info page that compression might prevent filtering.
73 * Revision 1.71 2008/04/25 13:33:56 fabiankeil
74 * - Factor cgi_show_file() out of cgi_show_status().
75 * - Adjust cgi_show_status()'s parameter description to match reality.
77 * Revision 1.70 2008/04/24 16:12:38 fabiankeil
78 * In cgi_show_status(), load the requested file at once.
79 * Using string_join() for every line really doesn't scale.
81 * Revision 1.69 2008/04/17 14:40:48 fabiankeil
82 * Provide get_http_time() with the buffer size so it doesn't
83 * have to blindly assume that the buffer is big enough.
85 * Revision 1.68 2008/03/27 18:27:21 fabiankeil
86 * Remove kill-popups action.
88 * Revision 1.67 2008/03/27 17:00:05 fabiankeil
89 * Turn the favicon blobs into locals.
91 * Revision 1.66 2008/02/23 16:57:12 fabiankeil
92 * Rename url_actions() to get_url_actions() and let it
93 * use the standard parameter ordering.
95 * Revision 1.65 2008/02/23 16:33:43 fabiankeil
96 * Let forward_url() use the standard parameter ordering
97 * and mark its second parameter immutable.
99 * Revision 1.64 2008/02/03 13:56:07 fabiankeil
100 * Add SOCKS5 support for show-url-info CGI page.
102 * Revision 1.63 2008/02/01 06:04:31 fabiankeil
103 * If edit buttons on the show-url-info CGI page are hidden, explain why.
105 * Revision 1.62 2008/02/01 05:52:40 fabiankeil
106 * Hide edit buttons on the show-url-info CGI page if enable-edit-action
107 * is disabled. Patch by Lee with additional white space adjustments.
109 * Revision 1.61 2008/01/26 11:13:25 fabiankeil
110 * If enable-edit-actions is disabled, hide the edit buttons and explain why.
112 * Revision 1.60 2007/10/27 13:12:13 fabiankeil
113 * Finish 1.49 and check write access before
114 * showing edit buttons on show-url-info page.
116 * Revision 1.59 2007/10/19 16:42:36 fabiankeil
117 * Plug memory leak I introduced five months ago.
118 * Yay Valgrind and Privoxy-Regression-Test.
120 * Revision 1.58 2007/07/21 12:19:50 fabiankeil
121 * If show-url-info is called with an URL that Privoxy
122 * would reject as invalid, don't show unresolved forwarding
123 * variables, "final matches" or claim the site's secure.
125 * Revision 1.57 2007/06/01 16:53:05 fabiankeil
126 * Adjust cgi_show_url_info() to show what forward-override{}
127 * would do with the requested URL (instead of showing how the
128 * request for the CGI page would be forwarded if it wasn't a
131 * Revision 1.56 2007/05/21 10:50:35 fabiankeil
132 * - Use strlcpy() instead of strcpy().
133 * - Stop treating actions files special. Expect a complete file name
134 * (with or without path) like it's done for the rest of the files.
136 * - Don't rerun sed() in cgi_show_request().
138 * Revision 1.55 2007/04/13 13:36:46 fabiankeil
139 * Reference action files in CGI URLs by id instead
140 * of using the first part of the file name.
141 * Fixes BR 1694250 and BR 1590556.
143 * Revision 1.54 2007/04/09 18:11:35 fabiankeil
144 * Don't mistake VC++'s _snprintf() for a snprintf() replacement.
146 * Revision 1.53 2007/04/08 13:21:04 fabiankeil
147 * Reference action files in CGI URLs by id instead
148 * of using the first part of the file name.
149 * Fixes BR 1694250 and BR 1590556.
151 * Revision 1.52 2007/02/13 15:10:26 fabiankeil
152 * Apparently fopen()ing in "binary" mode doesn't require
153 * #ifdefs, it's already done without them in cgiedit.c.
155 * Revision 1.51 2007/02/10 16:55:22 fabiankeil
156 * - Show forwarding settings on the show-url-info page
157 * - Fix some HTML syntax errors.
159 * Revision 1.50 2007/01/23 15:51:17 fabiankeil
160 * Add favicon delivery functions.
162 * Revision 1.49 2007/01/20 16:29:38 fabiankeil
163 * Suppress edit buttons for action files if Privoxy has
164 * no write access. Suggested by Roland in PR 1564026.
166 * Revision 1.48 2007/01/20 15:31:31 fabiankeil
167 * Display warning if show-url-info CGI page
168 * is used while Privoxy is toggled off.
170 * Revision 1.47 2007/01/12 15:07:10 fabiankeil
171 * Use zalloc in cgi_send_user_manual.
173 * Revision 1.46 2007/01/02 12:49:46 fabiankeil
174 * Add FEATURE_ZLIB to the list of conditional
175 * defines at the show-status page.
177 * Revision 1.45 2006/12/28 18:16:41 fabiankeil
178 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
179 * body memory before using it, replaced sprintf calls with snprintf.
181 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
182 * Removed checks whether or not AF_FILES have
183 * data structures associated with them in cgi_show_status.
184 * It doesn't matter as we're only interested in the file names.
186 * For the action files the checks were always true,
187 * but they prevented empty filter files from being
188 * listed. Fixes parts of BR 1619208.
190 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
191 * - Added FEATURE_GRACEFUL_TERMINATION to the
192 * "conditional #defines" section
193 * - Escaped ampersands in generated HTML.
194 * - Renamed re-filter-filename to re-filter-filenames
196 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
197 * Add special treatment for WIN32 to make sure
198 * cgi_send_user_manual opens the files in binary mode.
199 * Fixes BR 1600411 and unbreaks image delivery.
201 * Remove outdated comment.
203 * Revision 1.41 2006/10/09 19:18:28 roro
204 * Redirect http://p.p/user-manual (without trailing slash) to
205 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
207 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
208 * Modified cgi_send_user_manual to serve binary
209 * content without destroying it first. Should also be
210 * faster now. Added ".jpg" check for Content-Type guessing.
212 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
213 * Deliver documents in the user-manual directory
214 * with "Content-Type text/css" if their filename
217 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
218 * Incorporate modified version of Roland Rosenfeld's patch to
219 * optionally access the user-manual via Privoxy. Closes patch 679075.
221 * Formatting changed to Privoxy style, added call to
222 * cgi_error_no_template if the requested file doesn't
223 * exist and modified check whether or not Privoxy itself
224 * should serve the manual. Should work cross-platform now.
226 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
227 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
228 * with what was really the latest development (the v_3_0_branch branch)
230 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
231 * Multiple filter file support
233 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
234 * Undo some damaging memory leak patches
236 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
237 * A few memory leaks plugged (mostly on error paths)
239 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
240 * Another instance of:
241 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
242 * Thanks to Magnus Holmgren for the patch
244 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
245 * - Prevent line wrap beween "View/Edit" link buttons on status page
246 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
248 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
249 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
251 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
252 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
254 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
255 * Applying patch from Andreas as provided by Hal on the list.
256 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
258 * Revision 1.35 2002/05/12 21:44:44 jongfoster
259 * Adding amiga.[ch] revision information, if on an amiga.
261 * Revision 1.34 2002/04/30 12:06:12 oes
262 * Deleted unused code from default_cgi
264 * Revision 1.33 2002/04/30 11:14:52 oes
265 * Made csp the first parameter in *action_to_html
267 * Revision 1.32 2002/04/26 18:29:13 jongfoster
268 * Fixing this Visual C++ warning:
269 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
271 * Revision 1.31 2002/04/26 12:54:36 oes
272 * - Kill obsolete REDIRECT_URL code
273 * - Error handling fixes
274 * - Style sheet related HTML snipplet changes
275 * - cgi_show_url_info:
276 * - Matches now in table, actions on single lines,
278 * - standard.action suppressed
279 * - Buttons to View and Edit AFs
281 * Revision 1.30 2002/04/24 02:18:08 oes
282 * - show-status is now the starting point for editing
283 * the actions files, generate list of all AFs with buttons
284 * for viewing and editing, new look for file list (Jon:
285 * buttons now aligned ;-P ), view mode now supports multiple
286 * AFs, name changes, no view links for unspecified files,
287 * no edit link for standard.action.
289 * - Jon's multiple AF patch: cgi_show_url_info now uses all
290 * AFs and marks the output accordingly
292 * Revision 1.29 2002/04/10 13:38:35 oes
293 * load_template signature changed
295 * Revision 1.28 2002/04/07 15:42:12 jongfoster
296 * Fixing send-banner?type=auto when the image-blocker is
297 * a redirect to send-banner
299 * Revision 1.27 2002/04/05 15:50:48 oes
300 * added send-stylesheet CGI
302 * Revision 1.26 2002/04/04 00:36:36 gliptak
303 * always use pcre for matching
305 * Revision 1.25 2002/04/03 22:28:03 gliptak
306 * Removed references to gnu_regex
308 * Revision 1.24 2002/04/02 16:12:47 oes
309 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
311 * Revision 1.23 2002/03/26 22:29:54 swa
312 * we have a new homepage!
314 * Revision 1.22 2002/03/24 16:18:15 jongfoster
317 * Revision 1.21 2002/03/24 15:23:33 jongfoster
320 * Revision 1.20 2002/03/24 13:25:43 swa
321 * name change related issues
323 * Revision 1.19 2002/03/16 23:54:06 jongfoster
324 * Adding graceful termination feature, to help look for memory leaks.
325 * If you enable this (which, by design, has to be done by hand
326 * editing config.h) and then go to http://i.j.b/die, then the program
327 * will exit cleanly after the *next* request. It should free all the
328 * memory that was used.
330 * Revision 1.18 2002/03/12 01:44:49 oes
331 * Changed default for "blocked" image from jb logo to checkboard pattern
333 * Revision 1.17 2002/03/08 16:43:18 oes
334 * Added choice beween GIF and PNG built-in images
336 * Revision 1.16 2002/03/07 03:48:38 oes
337 * - Changed built-in images from GIF to PNG
338 * (with regard to Unisys patent issue)
339 * - Added a 4x4 pattern PNG which is less intrusive
340 * than the logo but also clearly marks the deleted banners
342 * Revision 1.15 2002/03/06 22:54:35 jongfoster
343 * Automated function-comment nitpicking.
345 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
346 * Clean up a little CRLF unpleasantness that suddenly appeared
348 * Revision 1.13 2002/02/21 00:10:37 jongfoster
349 * Adding send-banner?type=auto option
351 * Revision 1.12 2002/01/23 01:03:32 jongfoster
352 * Fixing gcc [CygWin] compiler warnings
354 * Revision 1.11 2002/01/23 00:01:04 jongfoster
355 * Adding cgi_transparent_gif() for http://i.j.b/t
356 * Adding missing html_encode() to many CGI functions.
357 * Adding urlmatch.[ch] to http://i.j.b/show-version
359 * Revision 1.10 2002/01/17 21:10:37 jongfoster
360 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
361 * Also fixing a problem in the same function with improperly quoted URLs
362 * in output HTML, and adding code to handle https:// URLs correctly.
364 * Revision 1.9 2001/11/30 23:09:15 jongfoster
365 * Now reports on FEATURE_CGI_EDIT_ACTIONS
366 * Removing FEATURE_DENY_GZIP from template
368 * Revision 1.8 2001/11/13 00:14:07 jongfoster
369 * Fixing stupid bug now I've figured out what || means.
370 * (It always returns 0 or 1, not one of it's paramaters.)
372 * Revision 1.7 2001/10/23 21:48:19 jongfoster
373 * Cleaning up error handling in CGI functions - they now send back
374 * a HTML error page and should never cause a FATAL error. (Fixes one
375 * potential source of "denial of service" attacks).
377 * CGI actions file editor that works and is actually useful.
379 * Ability to toggle JunkBuster remotely using a CGI call.
381 * You can turn off both the above features in the main configuration
382 * file, e.g. if you are running a multi-user proxy.
384 * Revision 1.6 2001/10/14 22:00:32 jongfoster
385 * Adding support for a 404 error when an invalid CGI page is requested.
387 * Revision 1.5 2001/10/07 15:30:41 oes
388 * Removed FEATURE_DENY_GZIP
390 * Revision 1.4 2001/10/02 15:31:12 oes
391 * Introduced show-request cgi
393 * Revision 1.3 2001/09/22 16:34:44 jongfoster
394 * Removing unneeded #includes
396 * Revision 1.2 2001/09/19 18:01:11 oes
397 * Fixed comments; cosmetics
399 * Revision 1.1 2001/09/16 17:08:54 jongfoster
400 * Moving simple CGI functions from cgi.c to new file cgisimple.c
403 **********************************************************************/
409 #include <sys/types.h>
417 #endif /* def HAVE_ACCESS */
421 #include "cgisimple.h"
427 #include "miscutil.h"
430 #include "urlmatch.h"
433 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
435 static char *show_rcs(void);
436 static jb_err show_defines(struct map *exports);
437 static jb_err cgi_show_file(struct client_state *csp,
438 struct http_response *rsp,
439 const struct map *parameters);
440 static jb_err load_file(const char *filename, char **buffer, size_t *length);
442 /*********************************************************************
444 * Function : cgi_default
446 * Description : CGI function that is called for the CGI_SITE_1_HOST
447 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
448 * Boring - only exports the default exports.
451 * 1 : csp = Current client state (buffers, headers, etc...)
452 * 2 : rsp = http_response data structure for output
453 * 3 : parameters = map of cgi parameters
455 * CGI Parameters : none
457 * Returns : JB_ERR_OK on success
458 * JB_ERR_MEMORY on out-of-memory
460 *********************************************************************/
461 jb_err cgi_default(struct client_state *csp,
462 struct http_response *rsp,
463 const struct map *parameters)
470 if (NULL == (exports = default_exports(csp, "")))
472 return JB_ERR_MEMORY;
475 return template_fill_for_cgi(csp, "default", exports, rsp);
479 /*********************************************************************
481 * Function : cgi_error_404
483 * Description : CGI function that is called if an unknown action was
487 * 1 : csp = Current client state (buffers, headers, etc...)
488 * 2 : rsp = http_response data structure for output
489 * 3 : parameters = map of cgi parameters
491 * CGI Parameters : none
493 * Returns : JB_ERR_OK on success
494 * JB_ERR_MEMORY on out-of-memory error.
496 *********************************************************************/
497 jb_err cgi_error_404(struct client_state *csp,
498 struct http_response *rsp,
499 const struct map *parameters)
507 if (NULL == (exports = default_exports(csp, NULL)))
509 return JB_ERR_MEMORY;
512 rsp->status = strdup("404 Privoxy configuration page not found");
513 if (rsp->status == NULL)
516 return JB_ERR_MEMORY;
519 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
523 #ifdef FEATURE_GRACEFUL_TERMINATION
524 /*********************************************************************
528 * Description : CGI function to shut down Privoxy.
529 * NOTE: Turning this on in a production build
530 * would be a BAD idea. An EXTREMELY BAD idea.
531 * In short, don't do it.
534 * 1 : csp = Current client state (buffers, headers, etc...)
535 * 2 : rsp = http_response data structure for output
536 * 3 : parameters = map of cgi parameters
538 * CGI Parameters : none
540 * Returns : JB_ERR_OK on success
541 * JB_ERR_MEMORY on out-of-memory error.
543 *********************************************************************/
544 jb_err cgi_die (struct client_state *csp,
545 struct http_response *rsp,
546 const struct map *parameters)
556 * I don't really care what gets sent back to the browser.
557 * Take the easy option - "out of memory" page.
560 return JB_ERR_MEMORY;
562 #endif /* def FEATURE_GRACEFUL_TERMINATION */
565 /*********************************************************************
567 * Function : cgi_show_request
569 * Description : Show the client's request and what sed() would have
573 * 1 : csp = Current client state (buffers, headers, etc...)
574 * 2 : rsp = http_response data structure for output
575 * 3 : parameters = map of cgi parameters
577 * CGI Parameters : none
579 * Returns : JB_ERR_OK on success
580 * JB_ERR_MEMORY on out-of-memory error.
582 *********************************************************************/
583 jb_err cgi_show_request(struct client_state *csp,
584 struct http_response *rsp,
585 const struct map *parameters)
594 if (NULL == (exports = default_exports(csp, "show-request")))
596 return JB_ERR_MEMORY;
600 * Repair the damage done to the IOB by get_header()
602 for (p = csp->iob->buf; p < csp->iob->eod; p++)
604 if (*p == '\0') *p = '\n';
608 * Export the original client's request and the one we would
609 * be sending to the server if this wasn't a CGI call
612 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
615 return JB_ERR_MEMORY;
618 if (map(exports, "processed-request", 1,
619 html_encode_and_free_original(list_to_text(csp->headers)), 0))
622 return JB_ERR_MEMORY;
625 return template_fill_for_cgi(csp, "show-request", exports, rsp);
629 /*********************************************************************
631 * Function : cgi_send_banner
633 * Description : CGI function that returns a banner.
636 * 1 : csp = Current client state (buffers, headers, etc...)
637 * 2 : rsp = http_response data structure for output
638 * 3 : parameters = map of cgi parameters
641 * type : Selects the type of banner between "trans", "logo",
642 * and "auto". Defaults to "logo" if absent or invalid.
643 * "auto" means to select as if we were image-blocking.
644 * (Only the first character really counts; b and t are
647 * Returns : JB_ERR_OK on success
648 * JB_ERR_MEMORY on out-of-memory error.
650 *********************************************************************/
651 jb_err cgi_send_banner(struct client_state *csp,
652 struct http_response *rsp,
653 const struct map *parameters)
655 char imagetype = lookup(parameters, "type")[0];
658 * If type is auto, then determine the right thing
659 * to do from the set-image-blocker action
661 if (imagetype == 'a')
668 #ifdef FEATURE_IMAGE_BLOCKING
669 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
671 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
672 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
673 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
677 /* Use default - nothing to do here. */
679 else if (0 == strcmpic(p, "blank"))
683 else if (0 == strcmpic(p, "pattern"))
689 * If the action is to call this CGI, determine
692 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
694 imagetype = p[sizeof(prefix1) - 1];
696 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
698 imagetype = p[sizeof(prefix2) - 1];
702 * Everything else must (should) be a URL to
710 #endif /* def FEATURE_IMAGE_BLOCKING */
714 * Now imagetype is either the non-auto type we were called with,
715 * or it was auto and has since been determined. In any case, we
716 * can proceed to actually answering the request by sending a redirect
717 * or an image as appropriate:
719 if (imagetype == 'r')
721 rsp->status = strdup("302 Local Redirect from Privoxy");
722 if (rsp->status == NULL)
724 return JB_ERR_MEMORY;
726 if (enlist_unique_header(rsp->headers, "Location",
727 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
729 return JB_ERR_MEMORY;
734 if ((imagetype == 'b') || (imagetype == 't'))
736 rsp->body = bindup(image_blank_data, image_blank_length);
737 rsp->content_length = image_blank_length;
741 rsp->body = bindup(image_pattern_data, image_pattern_length);
742 rsp->content_length = image_pattern_length;
745 if (rsp->body == NULL)
747 return JB_ERR_MEMORY;
749 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
751 return JB_ERR_MEMORY;
762 /*********************************************************************
764 * Function : cgi_transparent_image
766 * Description : CGI function that sends a 1x1 transparent image.
769 * 1 : csp = Current client state (buffers, headers, etc...)
770 * 2 : rsp = http_response data structure for output
771 * 3 : parameters = map of cgi parameters
773 * CGI Parameters : None
775 * Returns : JB_ERR_OK on success
776 * JB_ERR_MEMORY on out-of-memory error.
778 *********************************************************************/
779 jb_err cgi_transparent_image(struct client_state *csp,
780 struct http_response *rsp,
781 const struct map *parameters)
783 rsp->body = bindup(image_blank_data, image_blank_length);
784 rsp->content_length = image_blank_length;
786 if (rsp->body == NULL)
788 return JB_ERR_MEMORY;
791 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
793 return JB_ERR_MEMORY;
803 /*********************************************************************
805 * Function : cgi_send_default_favicon
807 * Description : CGI function that sends the standard favicon.
810 * 1 : csp = Current client state (buffers, headers, etc...)
811 * 2 : rsp = http_response data structure for output
812 * 3 : parameters = map of cgi parameters
814 * CGI Parameters : None
816 * Returns : JB_ERR_OK on success
817 * JB_ERR_MEMORY on out-of-memory error.
819 *********************************************************************/
820 jb_err cgi_send_default_favicon(struct client_state *csp,
821 struct http_response *rsp,
822 const struct map *parameters)
824 static const char default_favicon_data[] =
825 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
826 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
827 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
828 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
829 "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077"
830 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
831 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
832 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
833 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
834 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
835 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
836 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
837 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
839 static const size_t favicon_length = sizeof(default_favicon_data) - 1;
841 rsp->body = bindup(default_favicon_data, favicon_length);
842 rsp->content_length = favicon_length;
844 if (rsp->body == NULL)
846 return JB_ERR_MEMORY;
849 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
851 return JB_ERR_MEMORY;
861 /*********************************************************************
863 * Function : cgi_send_error_favicon
865 * Description : CGI function that sends the favicon for error pages.
868 * 1 : csp = Current client state (buffers, headers, etc...)
869 * 2 : rsp = http_response data structure for output
870 * 3 : parameters = map of cgi parameters
872 * CGI Parameters : None
874 * Returns : JB_ERR_OK on success
875 * JB_ERR_MEMORY on out-of-memory error.
877 *********************************************************************/
878 jb_err cgi_send_error_favicon(struct client_state *csp,
879 struct http_response *rsp,
880 const struct map *parameters)
882 static const char error_favicon_data[] =
883 "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260"
884 "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000"
885 "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000"
886 "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000"
887 "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077"
888 "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000"
889 "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000"
890 "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036"
891 "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360"
892 "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000"
893 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
894 "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
895 "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360"
897 static const size_t favicon_length = sizeof(error_favicon_data) - 1;
899 rsp->body = bindup(error_favicon_data, favicon_length);
900 rsp->content_length = favicon_length;
902 if (rsp->body == NULL)
904 return JB_ERR_MEMORY;
907 if (enlist(rsp->headers, "Content-Type: image/x-icon"))
909 return JB_ERR_MEMORY;
919 /*********************************************************************
921 * Function : cgi_send_stylesheet
923 * Description : CGI function that sends a css stylesheet found
924 * in the cgi-style.css template
927 * 1 : csp = Current client state (buffers, headers, etc...)
928 * 2 : rsp = http_response data structure for output
929 * 3 : parameters = map of cgi parameters
931 * CGI Parameters : None
933 * Returns : JB_ERR_OK on success
934 * JB_ERR_MEMORY on out-of-memory error.
936 *********************************************************************/
937 jb_err cgi_send_stylesheet(struct client_state *csp,
938 struct http_response *rsp,
939 const struct map *parameters)
946 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
948 if (err == JB_ERR_FILE)
951 * No way to tell user; send empty stylesheet
953 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
957 return err; /* JB_ERR_MEMORY */
960 if (enlist(rsp->headers, "Content-Type: text/css"))
962 return JB_ERR_MEMORY;
968 /*********************************************************************
970 * Function : cgi_send_user_manual
972 * Description : CGI function that sends a file in the user
976 * 1 : csp = Current client state (buffers, headers, etc...)
977 * 2 : rsp = http_response data structure for output
978 * 3 : parameters = map of cgi parameters
980 * CGI Parameters : file=name.html, the name of the HTML file
981 * (relative to user-manual from config)
983 * Returns : JB_ERR_OK on success
984 * JB_ERR_MEMORY on out-of-memory error.
986 *********************************************************************/
987 jb_err cgi_send_user_manual(struct client_state *csp,
988 struct http_response *rsp,
989 const struct map *parameters)
991 const char * filename;
993 jb_err err = JB_ERR_OK;
1000 if (!parameters->first)
1002 /* requested http://p.p/user-manual (without trailing slash) */
1003 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
1006 get_string_param(parameters, "file", &filename);
1007 /* Check paramter for hack attempts */
1008 if (filename && strchr(filename, '/'))
1010 return JB_ERR_CGI_PARAMS;
1012 if (filename && strstr(filename, ".."))
1014 return JB_ERR_CGI_PARAMS;
1017 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
1018 if (full_path == NULL)
1020 return JB_ERR_MEMORY;
1023 err = load_file(full_path, &rsp->body, &rsp->content_length);
1024 if (JB_ERR_OK != err)
1026 assert((JB_ERR_FILE == err) || (JB_ERR_MEMORY == err));
1027 if (JB_ERR_FILE == err)
1029 err = cgi_error_no_template(csp, rsp, full_path);
1036 /* Guess correct Content-Type based on the filename's ending */
1039 length = strlen(filename);
1045 if((length>=4) && !strcmp(&filename[length-4], ".css"))
1047 err = enlist(rsp->headers, "Content-Type: text/css");
1049 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
1051 err = enlist(rsp->headers, "Content-Type: image/jpeg");
1055 err = enlist(rsp->headers, "Content-Type: text/html");
1062 /*********************************************************************
1064 * Function : cgi_show_version
1066 * Description : CGI function that returns a a web page describing the
1067 * file versions of Privoxy.
1070 * 1 : csp = Current client state (buffers, headers, etc...)
1071 * 2 : rsp = http_response data structure for output
1072 * 3 : parameters = map of cgi parameters
1074 * CGI Parameters : none
1076 * Returns : JB_ERR_OK on success
1077 * JB_ERR_MEMORY on out-of-memory error.
1079 *********************************************************************/
1080 jb_err cgi_show_version(struct client_state *csp,
1081 struct http_response *rsp,
1082 const struct map *parameters)
1084 struct map *exports;
1090 if (NULL == (exports = default_exports(csp, "show-version")))
1092 return JB_ERR_MEMORY;
1095 if (map(exports, "sourceversions", 1, show_rcs(), 0))
1098 return JB_ERR_MEMORY;
1101 return template_fill_for_cgi(csp, "show-version", exports, rsp);
1105 /*********************************************************************
1107 * Function : cgi_show_status
1109 * Description : CGI function that returns a web page describing the
1110 * current status of Privoxy.
1113 * 1 : csp = Current client state (buffers, headers, etc...)
1114 * 2 : rsp = http_response data structure for output
1115 * 3 : parameters = map of cgi parameters
1118 * file : Which file to show. Only first letter is checked,
1123 * Default is to show menu and other information.
1125 * Returns : JB_ERR_OK on success
1126 * JB_ERR_MEMORY on out-of-memory error.
1128 *********************************************************************/
1129 jb_err cgi_show_status(struct client_state *csp,
1130 struct http_response *rsp,
1131 const struct map *parameters)
1137 char buf[BUFFER_SIZE];
1138 #ifdef FEATURE_STATISTICS
1139 float perc_rej; /* Percentage of http requests rejected */
1140 int local_urls_read;
1141 int local_urls_rejected;
1142 #endif /* ndef FEATURE_STATISTICS */
1143 jb_err err = JB_ERR_OK;
1145 struct map *exports;
1151 if ('\0' != *(lookup(parameters, "file")))
1153 return cgi_show_file(csp, rsp, parameters);
1156 if (NULL == (exports = default_exports(csp, "show-status")))
1158 return JB_ERR_MEMORY;
1162 for (j = 0; (s != NULL) && (j < Argc); j++)
1164 if (!err) err = string_join (&s, html_encode(Argv[j]));
1165 if (!err) err = string_append(&s, " ");
1167 if (!err) err = map(exports, "invocation", 1, s, 0);
1169 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1170 if (!err) err = show_defines(exports);
1175 return JB_ERR_MEMORY;
1178 #ifdef FEATURE_STATISTICS
1179 local_urls_read = urls_read;
1180 local_urls_rejected = urls_rejected;
1183 * Need to alter the stats not to include the fetch of this
1186 * Can't do following thread safely! doh!
1189 * urls_rejected--; * This will be incremented subsequently *
1192 if (local_urls_read == 0)
1194 if (!err) err = map_block_killer(exports, "have-stats");
1198 if (!err) err = map_block_killer(exports, "have-no-stats");
1200 perc_rej = (float)local_urls_rejected * 100.0F /
1201 (float)local_urls_read;
1203 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1204 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1206 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1207 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1209 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1210 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1213 #else /* ndef FEATURE_STATISTICS */
1214 err = err || map_block_killer(exports, "statistics");
1215 #endif /* ndef FEATURE_STATISTICS */
1218 * List all action files in use, together with view and edit links,
1219 * except for standard.action, which should only be viewable. (Not
1220 * enforced in the editor itself)
1221 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1224 for (i = 0; i < MAX_AF_FILES; i++)
1226 if (csp->actions_list[i] != NULL)
1228 if (!err) err = string_append(&s, "<tr><td>");
1229 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1230 snprintf(buf, sizeof(buf),
1231 "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1232 if (!err) err = string_append(&s, buf);
1234 #ifdef FEATURE_CGI_EDIT_ACTIONS
1235 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1236 && (NULL == strstr(csp->actions_list[i]->filename, "standard.action"))
1237 && (NULL != csp->config->actions_file_short[i]))
1240 if (access(csp->config->actions_file[i], W_OK) == 0)
1242 #endif /* def HAVE_ACCESS */
1243 snprintf(buf, sizeof(buf), " <a href=\"/edit-actions-list?f=%d\">Edit</a>", i);
1244 if (!err) err = string_append(&s, buf);
1249 if (!err) err = string_append(&s, " <strong>No write access.</strong>");
1251 #endif /* def HAVE_ACCESS */
1255 if (!err) err = string_append(&s, "</td></tr>\n");
1260 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1264 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1268 * List all re_filterfiles in use, together with view options.
1269 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1272 for (i = 0; i < MAX_AF_FILES; i++)
1274 if (csp->rlist[i] != NULL)
1276 if (!err) err = string_append(&s, "<tr><td>");
1277 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1279 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1280 if (!err) err = string_append(&s, buf);
1281 if (!err) err = string_append(&s, "</td></tr>\n");
1286 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1290 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1291 if (!err) err = map_block_killer(exports, "have-filterfile");
1294 #ifdef FEATURE_TRUST
1297 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1301 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1302 if (!err) err = map_block_killer(exports, "have-trustfile");
1305 if (!err) err = map_block_killer(exports, "trust-support");
1306 #endif /* ndef FEATURE_TRUST */
1308 #ifdef FEATURE_CGI_EDIT_ACTIONS
1309 if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1311 err = map_block_killer(exports, "cgi-editor-is-disabled");
1313 #endif /* ndef CGI_EDIT_ACTIONS */
1318 return JB_ERR_MEMORY;
1321 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1325 /*********************************************************************
1327 * Function : cgi_show_url_info
1329 * Description : CGI function that determines and shows which actions
1330 * Privoxy will perform for a given url, and which
1331 * matches starting from the defaults have lead to that.
1334 * 1 : csp = Current client state (buffers, headers, etc...)
1335 * 2 : rsp = http_response data structure for output
1336 * 3 : parameters = map of cgi parameters
1339 * url : The url whose actions are to be determined.
1340 * If url is unset, the url-given conditional will be
1341 * set, so that all but the form can be suppressed in
1344 * Returns : JB_ERR_OK on success
1345 * JB_ERR_MEMORY on out-of-memory error.
1347 *********************************************************************/
1348 jb_err cgi_show_url_info(struct client_state *csp,
1349 struct http_response *rsp,
1350 const struct map *parameters)
1353 struct map *exports;
1360 if (NULL == (exports = default_exports(csp, "show-url-info")))
1362 return JB_ERR_MEMORY;
1366 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1368 url_param = strdup(lookup(parameters, "url"));
1369 if (url_param == NULL)
1372 return JB_ERR_MEMORY;
1377 * Handle prefixes. 4 possibilities:
1378 * 1) "http://" or "https://" prefix present and followed by URL - OK
1379 * 2) Only the "http://" or "https://" part is present, no URL - change
1380 * to empty string so it will be detected later as "no URL".
1381 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1383 * 4) Parameter not specified or is empty string - let this fall through
1384 * for now, next block of code will handle it.
1386 if (0 == strncmp(url_param, "http://", 7))
1388 if (url_param[7] == '\0')
1391 * Empty URL (just prefix).
1392 * Make it totally empty so it's caught by the next if()
1394 url_param[0] = '\0';
1397 else if (0 == strncmp(url_param, "https://", 8))
1399 if (url_param[8] == '\0')
1402 * Empty URL (just prefix).
1403 * Make it totally empty so it's caught by the next if()
1405 url_param[0] = '\0';
1408 else if (NULL == strstr(url_param, "://"))
1410 /* No prefix - assume http:// */
1411 char *url_param_prefixed = strdup("http://");
1413 if (JB_ERR_OK != string_join(&url_param_prefixed, url_param))
1416 return JB_ERR_MEMORY;
1418 url_param = url_param_prefixed;
1422 * Hide "toggle off" warning if Privoxy is toggled on.
1425 #ifdef FEATURE_TOGGLE
1426 (global_toggle_state == 1) &&
1427 #endif /* def FEATURE_TOGGLE */
1428 map_block_killer(exports, "privoxy-is-toggled-off")
1432 return JB_ERR_MEMORY;
1435 if (url_param[0] == '\0')
1437 /* URL paramater not specified, display query form only. */
1439 if (map_block_killer(exports, "url-given")
1440 || map(exports, "url", 1, "", 1))
1443 return JB_ERR_MEMORY;
1448 /* Given a URL, so query it. */
1453 struct file_list *fl;
1454 struct url_actions *b;
1455 struct http_request url_to_query[1];
1456 struct current_action_spec action[1];
1459 if (map(exports, "url", 1, html_encode(url_param), 0))
1463 return JB_ERR_MEMORY;
1466 init_current_action(action);
1468 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1470 free_current_action(action);
1473 return JB_ERR_MEMORY;
1476 memset(url_to_query, '\0', sizeof(url_to_query));
1477 err = parse_http_url(url_param, url_to_query, REQUIRE_PROTOCOL);
1478 assert(url_to_query->ssl == !strncmp(url_param, "https://", 8));
1482 if (err == JB_ERR_MEMORY)
1484 free_http_request(url_to_query);
1485 free_current_action(action);
1487 return JB_ERR_MEMORY;
1493 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1494 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1495 if (!err) err = map_block_killer(exports, "valid-url");
1497 free_current_action(action);
1498 free_http_request(url_to_query);
1503 return JB_ERR_MEMORY;
1506 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1510 * We have a warning about SSL paths. Hide it for unencrypted sites.
1512 if (!url_to_query->ssl)
1514 if (map_block_killer(exports, "https"))
1516 free_current_action(action);
1518 free_http_request(url_to_query);
1519 return JB_ERR_MEMORY;
1523 matches = strdup("<table summary=\"\" class=\"transparent\">");
1525 for (i = 0; i < MAX_AF_FILES; i++)
1527 if (NULL == csp->config->actions_file_short[i]
1528 || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue;
1532 if ((fl = csp->actions_list[i]) != NULL)
1534 if ((b = fl->f) != NULL)
1536 /* FIXME: Hardcoded HTML! */
1537 string_append(&matches, "<tr><th>In file: ");
1538 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1539 snprintf(buf, sizeof(buf), " <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1540 string_append(&matches, buf);
1541 string_append(&matches, "View</a>");
1542 #ifdef FEATURE_CGI_EDIT_ACTIONS
1543 if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)
1546 if (access(csp->config->actions_file[i], W_OK) == 0)
1548 #endif /* def HAVE_ACCESS */
1549 snprintf(buf, sizeof(buf),
1550 " <a class=\"cmd\" href=\"/edit-actions-list?f=%d\">", i);
1551 string_append(&matches, buf);
1552 string_append(&matches, "Edit</a>");
1557 string_append(&matches, " <strong>No write access.</strong>");
1559 #endif /* def HAVE_ACCESS */
1561 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1563 string_append(&matches, "</th></tr>\n");
1570 for (; (b != NULL) && (matches != NULL); b = b->next)
1572 if (url_match(b->url, url_to_query))
1574 string_append(&matches, "<tr><td>{");
1575 string_join (&matches, actions_to_html(csp, b->action));
1576 string_append(&matches, " }<br>\n<code>");
1577 string_join (&matches, html_encode(b->url->spec));
1578 string_append(&matches, "</code></td></tr>\n");
1580 if (merge_current_action(action, b->action))
1583 free_http_request(url_to_query);
1584 free_current_action(action);
1586 return JB_ERR_MEMORY;
1594 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1597 string_append(&matches, "</table>\n");
1600 * XXX: Kludge to make sure the "Forward settings" section
1601 * shows what forward-override{} would do with the requested URL.
1602 * No one really cares how the CGI request would be forwarded
1603 * if it wasn't intercepted as CGI request in the first place.
1605 * From here on the action bitmask will no longer reflect
1606 * the real url (http://config.privoxy.org/show-url-info?url=.*),
1607 * but luckily it's no longer required later on anyway.
1609 free_current_action(csp->action);
1610 get_url_actions(csp, url_to_query);
1613 * Fill in forwarding settings.
1615 * The possibilities are:
1617 * - http forwarding only
1618 * - socks4(a) forwarding only
1619 * - socks4(a) and http forwarding.
1621 * XXX: Parts of this code could be reused for the
1622 * "forwarding-failed" template which currently doesn't
1623 * display the proxy port and an eventual second forwarder.
1626 const struct forward_spec *fwd = forward_url(csp, url_to_query);
1628 if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL))
1630 if (!err) err = map_block_killer(exports, "socks-forwarder");
1631 if (!err) err = map_block_killer(exports, "http-forwarder");
1635 char port[10]; /* We save proxy ports as int but need a string here */
1637 if (!err) err = map_block_killer(exports, "no-forwarder");
1639 if (fwd->gateway_host != NULL)
1641 char *socks_type = NULL;
1646 socks_type = "socks4";
1649 socks_type = "socks4a";
1652 socks_type = "socks5";
1655 log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
1658 if (!err) err = map(exports, "socks-type", 1, socks_type, 1);
1659 if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1);
1660 snprintf(port, sizeof(port), "%d", fwd->gateway_port);
1661 if (!err) err = map(exports, "gateway-port", 1, port, 1);
1665 if (!err) err = map_block_killer(exports, "socks-forwarder");
1668 if (fwd->forward_host != NULL)
1670 if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1);
1671 snprintf(port, sizeof(port), "%d", fwd->forward_port);
1672 if (!err) err = map(exports, "forward-port", 1, port, 1);
1676 if (!err) err = map_block_killer(exports, "http-forwarder");
1681 free_http_request(url_to_query);
1683 if (err || matches == NULL)
1685 free_current_action(action);
1687 return JB_ERR_MEMORY;
1690 #ifdef FEATURE_CGI_EDIT_ACTIONS
1691 if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS))
1693 err = map_block_killer(exports, "cgi-editor-is-disabled");
1695 #endif /* FEATURE_CGI_EDIT_ACTIONS */
1698 * If zlib support is available, if no content filters
1699 * are enabled or if the prevent-compression action is enabled,
1700 * suppress the "compression could prevent filtering" warning.
1702 #ifndef FEATURE_ZLIB
1703 if (!content_filters_enabled(action) ||
1704 (action->flags & ACTION_NO_COMPRESSION))
1707 if (!err) err = map_block_killer(exports, "filters-might-be-ineffective");
1710 if (err || map(exports, "matches", 1, matches , 0))
1712 free_current_action(action);
1714 return JB_ERR_MEMORY;
1717 s = current_action_to_html(csp, action);
1719 free_current_action(action);
1721 if (map(exports, "final", 1, s, 0))
1724 return JB_ERR_MEMORY;
1728 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1732 /*********************************************************************
1734 * Function : cgi_robots_txt
1736 * Description : CGI function to return "/robots.txt".
1739 * 1 : csp = Current client state (buffers, headers, etc...)
1740 * 2 : rsp = http_response data structure for output
1741 * 3 : parameters = map of cgi parameters
1743 * CGI Parameters : None
1745 * Returns : JB_ERR_OK on success
1746 * JB_ERR_MEMORY on out-of-memory error.
1748 *********************************************************************/
1749 jb_err cgi_robots_txt(struct client_state *csp,
1750 struct http_response *rsp,
1751 const struct map *parameters)
1757 "# This is the Privoxy control interface.\n"
1758 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1764 if (rsp->body == NULL)
1766 return JB_ERR_MEMORY;
1769 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1773 get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */
1774 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1776 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1780 /*********************************************************************
1782 * Function : show_defines
1784 * Description : Add to a map the state od all conditional #defines
1785 * used when building
1788 * 1 : exports = map to extend
1790 * Returns : JB_ERR_OK on success
1791 * JB_ERR_MEMORY on out-of-memory error.
1793 *********************************************************************/
1794 static jb_err show_defines(struct map *exports)
1796 jb_err err = JB_ERR_OK;
1799 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1800 #else /* ifndef FEATURE_ACL */
1801 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1802 #endif /* ndef FEATURE_ACL */
1804 #ifdef FEATURE_CGI_EDIT_ACTIONS
1805 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1806 #else /* ifndef FEATURE_COOKIE_JAR */
1807 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1808 #endif /* ndef FEATURE_COOKIE_JAR */
1810 #ifdef FEATURE_COOKIE_JAR
1811 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1812 #else /* ifndef FEATURE_COOKIE_JAR */
1813 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1814 #endif /* ndef FEATURE_COOKIE_JAR */
1816 #ifdef FEATURE_FAST_REDIRECTS
1817 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1818 #else /* ifndef FEATURE_FAST_REDIRECTS */
1819 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1820 #endif /* ndef FEATURE_FAST_REDIRECTS */
1822 #ifdef FEATURE_FORCE_LOAD
1823 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1824 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1825 #else /* ifndef FEATURE_FORCE_LOAD */
1826 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1827 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1828 #endif /* ndef FEATURE_FORCE_LOAD */
1830 #ifdef FEATURE_GRACEFUL_TERMINATION
1831 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1832 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1833 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1834 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1836 #ifdef FEATURE_IMAGE_BLOCKING
1837 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1838 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1839 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1840 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1842 #ifdef FEATURE_IMAGE_DETECT_MSIE
1843 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1844 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1845 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1846 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1848 #ifdef FEATURE_NO_GIFS
1849 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1850 #else /* ifndef FEATURE_NO_GIFS */
1851 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1852 #endif /* ndef FEATURE_NO_GIFS */
1854 #ifdef FEATURE_PTHREAD
1855 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1856 #else /* ifndef FEATURE_PTHREAD */
1857 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1858 #endif /* ndef FEATURE_PTHREAD */
1860 #ifdef FEATURE_STATISTICS
1861 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1862 #else /* ifndef FEATURE_STATISTICS */
1863 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1864 #endif /* ndef FEATURE_STATISTICS */
1866 #ifdef FEATURE_TOGGLE
1867 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1868 #else /* ifndef FEATURE_TOGGLE */
1869 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1870 #endif /* ndef FEATURE_TOGGLE */
1872 #ifdef FEATURE_TRUST
1873 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1874 #else /* ifndef FEATURE_TRUST */
1875 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1876 #endif /* ndef FEATURE_TRUST */
1879 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1880 #else /* ifndef FEATURE_ZLIB */
1881 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1882 #endif /* ndef FEATURE_ZLIB */
1885 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1886 #else /* ifndef STATIC_PCRE */
1887 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1888 #endif /* ndef STATIC_PCRE */
1891 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1892 #else /* ifndef STATIC_PCRS */
1893 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1894 #endif /* ndef STATIC_PCRS */
1900 /*********************************************************************
1902 * Function : show_rcs
1904 * Description : Create a string with the rcs info for all sourcefiles
1908 * Returns : A string, or NULL on out-of-memory.
1910 *********************************************************************/
1911 static char *show_rcs(void)
1913 char *result = strdup("");
1914 char buf[BUFFER_SIZE];
1916 /* Instead of including *all* dot h's in the project (thus creating a
1917 * tremendous amount of dependencies), I will concede to declaring them
1918 * as extern's. This forces the developer to add to this list, but oh well.
1921 #define SHOW_RCS(__x) \
1923 extern const char __x[]; \
1924 snprintf(buf, sizeof(buf), " %s\n", __x); \
1925 string_append(&result, buf); \
1928 /* In alphabetical order */
1929 SHOW_RCS(actions_h_rcs)
1930 SHOW_RCS(actions_rcs)
1932 SHOW_RCS(amiga_h_rcs)
1934 #endif /* def AMIGA */
1937 #ifdef FEATURE_CGI_EDIT_ACTIONS
1938 SHOW_RCS(cgiedit_h_rcs)
1939 SHOW_RCS(cgiedit_rcs)
1940 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1941 SHOW_RCS(cgisimple_h_rcs)
1942 SHOW_RCS(cgisimple_rcs)
1944 SHOW_RCS(cygwin_h_rcs)
1946 SHOW_RCS(deanimate_h_rcs)
1947 SHOW_RCS(deanimate_rcs)
1948 SHOW_RCS(encode_h_rcs)
1949 SHOW_RCS(encode_rcs)
1950 SHOW_RCS(errlog_h_rcs)
1951 SHOW_RCS(errlog_rcs)
1952 SHOW_RCS(filters_h_rcs)
1953 SHOW_RCS(filters_rcs)
1954 SHOW_RCS(gateway_h_rcs)
1955 SHOW_RCS(gateway_rcs)
1956 SHOW_RCS(jbsockets_h_rcs)
1957 SHOW_RCS(jbsockets_rcs)
1960 SHOW_RCS(list_h_rcs)
1962 SHOW_RCS(loadcfg_h_rcs)
1963 SHOW_RCS(loadcfg_rcs)
1964 SHOW_RCS(loaders_h_rcs)
1965 SHOW_RCS(loaders_rcs)
1966 SHOW_RCS(miscutil_h_rcs)
1967 SHOW_RCS(miscutil_rcs)
1968 SHOW_RCS(parsers_h_rcs)
1969 SHOW_RCS(parsers_rcs)
1971 SHOW_RCS(pcrs_h_rcs)
1972 SHOW_RCS(project_h_rcs)
1973 SHOW_RCS(ssplit_h_rcs)
1974 SHOW_RCS(ssplit_rcs)
1975 SHOW_RCS(urlmatch_h_rcs)
1976 SHOW_RCS(urlmatch_rcs)
1978 #ifndef _WIN_CONSOLE
1979 SHOW_RCS(w32log_h_rcs)
1980 SHOW_RCS(w32log_rcs)
1981 SHOW_RCS(w32res_h_rcs)
1982 SHOW_RCS(w32taskbar_h_rcs)
1983 SHOW_RCS(w32taskbar_rcs)
1984 #endif /* ndef _WIN_CONSOLE */
1985 SHOW_RCS(win32_h_rcs)
1987 #endif /* def _WIN32 */
1996 /*********************************************************************
1998 * Function : cgi_show_file
2000 * Description : CGI function that shows the content of a
2001 * configuration file.
2004 * 1 : csp = Current client state (buffers, headers, etc...)
2005 * 2 : rsp = http_response data structure for output
2006 * 3 : parameters = map of cgi parameters
2009 * file : Which file to show. Only first letter is checked,
2014 * Default is to show menu and other information.
2016 * Returns : JB_ERR_OK on success
2017 * JB_ERR_MEMORY on out-of-memory error.
2019 *********************************************************************/
2020 static jb_err cgi_show_file(struct client_state *csp,
2021 struct http_response *rsp,
2022 const struct map *parameters)
2025 const char * filename = NULL;
2026 char * file_description = NULL;
2032 switch (*(lookup(parameters, "file")))
2035 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
2037 filename = csp->actions_list[i]->filename;
2038 file_description = "Actions File";
2043 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
2045 filename = csp->rlist[i]->filename;
2046 file_description = "Filter File";
2050 #ifdef FEATURE_TRUST
2054 filename = csp->tlist->filename;
2055 file_description = "Trust File";
2058 #endif /* def FEATURE_TRUST */
2061 if (NULL != filename)
2063 struct map *exports;
2068 exports = default_exports(csp, "show-status");
2069 if (NULL == exports)
2071 return JB_ERR_MEMORY;
2074 if ( map(exports, "file-description", 1, file_description, 1)
2075 || map(exports, "filepath", 1, html_encode(filename), 0) )
2078 return JB_ERR_MEMORY;
2081 err = load_file(filename, &s, &length);
2082 if (JB_ERR_OK != err)
2084 if (map(exports, "contents", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
2087 return JB_ERR_MEMORY;
2092 s = html_encode_and_free_original(s);
2095 return JB_ERR_MEMORY;
2098 if (map(exports, "contents", 1, s, 0))
2101 return JB_ERR_MEMORY;
2105 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
2108 return JB_ERR_CGI_PARAMS;
2112 /*********************************************************************
2114 * Function : load_file
2116 * Description : Loads a file into a buffer.
2119 * 1 : filename = Name of the file to be loaded.
2120 * 2 : buffer = Used to return the file's content.
2121 * 3 : length = Used to return the size of the file.
2123 * Returns : JB_ERR_OK in case of success,
2124 * JB_ERR_FILE in case of ordinary file loading errors
2125 * (fseek() and ftell() errors are fatal)
2126 * JB_ERR_MEMORY in case of out-of-memory.
2128 *********************************************************************/
2129 static jb_err load_file(const char *filename, char **buffer, size_t *length)
2133 jb_err err = JB_ERR_OK;
2135 fp = fopen(filename, "rb");
2141 /* Get file length */
2142 if (fseek(fp, 0, SEEK_END))
2144 log_error(LOG_LEVEL_FATAL,
2145 "Unexpected erro while fseek()ing to the end of %s: %E",
2151 log_error(LOG_LEVEL_FATAL,
2152 "Unexpected ftell() error while loading %s: %E",
2155 *length = (size_t)ret;
2157 /* Go back to the beginning. */
2158 if (fseek(fp, 0, SEEK_SET))
2160 log_error(LOG_LEVEL_FATAL,
2161 "Unexpected error while fseek()ing to the beginning of %s: %E",
2165 *buffer = (char *)zalloc(*length + 1);
2166 if (NULL == *buffer)
2168 err = JB_ERR_MEMORY;
2170 else if (!fread(*buffer, *length, 1, fp))
2173 * May happen if the file size changes between fseek() and
2174 * fread(). If it does, we just log it and serve what we got.
2176 log_error(LOG_LEVEL_ERROR,
2177 "Couldn't completely read file %s.", filename);