1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.47 2007/01/12 15:07:10 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
6 * Purpose : Simple CGIs to get information about Privoxy's
9 * Functions declared include:
12 * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
13 * Privoxy team. http://www.privoxy.org/
15 * Based on the Internet Junkbuster originally written
16 * by and Copyright (C) 1997 Anonymous Coders and
17 * Junkbusters Corporation. http://www.junkbusters.com
19 * This program is free software; you can redistribute it
20 * and/or modify it under the terms of the GNU General
21 * Public License as published by the Free Software
22 * Foundation; either version 2 of the License, or (at
23 * your option) any later version.
25 * This program is distributed in the hope that it will
26 * be useful, but WITHOUT ANY WARRANTY; without even the
27 * implied warranty of MERCHANTABILITY or FITNESS FOR A
28 * PARTICULAR PURPOSE. See the GNU General Public
29 * License for more details.
31 * The GNU General Public License should be included with
32 * this file. If not, you can view it at
33 * http://www.gnu.org/copyleft/gpl.html
34 * or write to the Free Software Foundation, Inc., 59
35 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
38 * $Log: cgisimple.c,v $
39 * Revision 1.47 2007/01/12 15:07:10 fabiankeil
40 * Use zalloc in cgi_send_user_manual.
42 * Revision 1.46 2007/01/02 12:49:46 fabiankeil
43 * Add FEATURE_ZLIB to the list of conditional
44 * defines at the show-status page.
46 * Revision 1.45 2006/12/28 18:16:41 fabiankeil
47 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
48 * body memory before using it, replaced sprintf calls with snprintf.
50 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
51 * Removed checks whether or not AF_FILES have
52 * data structures associated with them in cgi_show_status.
53 * It doesn't matter as we're only interested in the file names.
55 * For the action files the checks were always true,
56 * but they prevented empty filter files from being
57 * listed. Fixes parts of BR 1619208.
59 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
60 * - Added FEATURE_GRACEFUL_TERMINATION to the
61 * "conditional #defines" section
62 * - Escaped ampersands in generated HTML.
63 * - Renamed re-filter-filename to re-filter-filenames
65 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
66 * Add special treatment for WIN32 to make sure
67 * cgi_send_user_manual opens the files in binary mode.
68 * Fixes BR 1600411 and unbreaks image delivery.
70 * Remove outdated comment.
72 * Revision 1.41 2006/10/09 19:18:28 roro
73 * Redirect http://p.p/user-manual (without trailing slash) to
74 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
76 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
77 * Modified cgi_send_user_manual to serve binary
78 * content without destroying it first. Should also be
79 * faster now. Added ".jpg" check for Content-Type guessing.
81 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
82 * Deliver documents in the user-manual directory
83 * with "Content-Type text/css" if their filename
86 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
87 * Incorporate modified version of Roland Rosenfeld's patch to
88 * optionally access the user-manual via Privoxy. Closes patch 679075.
90 * Formatting changed to Privoxy style, added call to
91 * cgi_error_no_template if the requested file doesn't
92 * exist and modified check whether or not Privoxy itself
93 * should serve the manual. Should work cross-platform now.
95 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
96 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
97 * with what was really the latest development (the v_3_0_branch branch)
99 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
100 * Multiple filter file support
102 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
103 * Undo some damaging memory leak patches
105 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
106 * A few memory leaks plugged (mostly on error paths)
108 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
109 * Another instance of:
110 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
111 * Thanks to Magnus Holmgren for the patch
113 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
114 * - Prevent line wrap beween "View/Edit" link buttons on status page
115 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
117 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
118 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
120 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
121 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
123 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
124 * Applying patch from Andreas as provided by Hal on the list.
125 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
127 * Revision 1.35 2002/05/12 21:44:44 jongfoster
128 * Adding amiga.[ch] revision information, if on an amiga.
130 * Revision 1.34 2002/04/30 12:06:12 oes
131 * Deleted unused code from default_cgi
133 * Revision 1.33 2002/04/30 11:14:52 oes
134 * Made csp the first parameter in *action_to_html
136 * Revision 1.32 2002/04/26 18:29:13 jongfoster
137 * Fixing this Visual C++ warning:
138 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
140 * Revision 1.31 2002/04/26 12:54:36 oes
141 * - Kill obsolete REDIRECT_URL code
142 * - Error handling fixes
143 * - Style sheet related HTML snipplet changes
144 * - cgi_show_url_info:
145 * - Matches now in table, actions on single lines,
147 * - standard.action suppressed
148 * - Buttons to View and Edit AFs
150 * Revision 1.30 2002/04/24 02:18:08 oes
151 * - show-status is now the starting point for editing
152 * the actions files, generate list of all AFs with buttons
153 * for viewing and editing, new look for file list (Jon:
154 * buttons now aligned ;-P ), view mode now supports multiple
155 * AFs, name changes, no view links for unspecified files,
156 * no edit link for standard.action.
158 * - Jon's multiple AF patch: cgi_show_url_info now uses all
159 * AFs and marks the output accordingly
161 * Revision 1.29 2002/04/10 13:38:35 oes
162 * load_template signature changed
164 * Revision 1.28 2002/04/07 15:42:12 jongfoster
165 * Fixing send-banner?type=auto when the image-blocker is
166 * a redirect to send-banner
168 * Revision 1.27 2002/04/05 15:50:48 oes
169 * added send-stylesheet CGI
171 * Revision 1.26 2002/04/04 00:36:36 gliptak
172 * always use pcre for matching
174 * Revision 1.25 2002/04/03 22:28:03 gliptak
175 * Removed references to gnu_regex
177 * Revision 1.24 2002/04/02 16:12:47 oes
178 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
180 * Revision 1.23 2002/03/26 22:29:54 swa
181 * we have a new homepage!
183 * Revision 1.22 2002/03/24 16:18:15 jongfoster
186 * Revision 1.21 2002/03/24 15:23:33 jongfoster
189 * Revision 1.20 2002/03/24 13:25:43 swa
190 * name change related issues
192 * Revision 1.19 2002/03/16 23:54:06 jongfoster
193 * Adding graceful termination feature, to help look for memory leaks.
194 * If you enable this (which, by design, has to be done by hand
195 * editing config.h) and then go to http://i.j.b/die, then the program
196 * will exit cleanly after the *next* request. It should free all the
197 * memory that was used.
199 * Revision 1.18 2002/03/12 01:44:49 oes
200 * Changed default for "blocked" image from jb logo to checkboard pattern
202 * Revision 1.17 2002/03/08 16:43:18 oes
203 * Added choice beween GIF and PNG built-in images
205 * Revision 1.16 2002/03/07 03:48:38 oes
206 * - Changed built-in images from GIF to PNG
207 * (with regard to Unisys patent issue)
208 * - Added a 4x4 pattern PNG which is less intrusive
209 * than the logo but also clearly marks the deleted banners
211 * Revision 1.15 2002/03/06 22:54:35 jongfoster
212 * Automated function-comment nitpicking.
214 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
215 * Clean up a little CRLF unpleasantness that suddenly appeared
217 * Revision 1.13 2002/02/21 00:10:37 jongfoster
218 * Adding send-banner?type=auto option
220 * Revision 1.12 2002/01/23 01:03:32 jongfoster
221 * Fixing gcc [CygWin] compiler warnings
223 * Revision 1.11 2002/01/23 00:01:04 jongfoster
224 * Adding cgi_transparent_gif() for http://i.j.b/t
225 * Adding missing html_encode() to many CGI functions.
226 * Adding urlmatch.[ch] to http://i.j.b/show-version
228 * Revision 1.10 2002/01/17 21:10:37 jongfoster
229 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
230 * Also fixing a problem in the same function with improperly quoted URLs
231 * in output HTML, and adding code to handle https:// URLs correctly.
233 * Revision 1.9 2001/11/30 23:09:15 jongfoster
234 * Now reports on FEATURE_CGI_EDIT_ACTIONS
235 * Removing FEATURE_DENY_GZIP from template
237 * Revision 1.8 2001/11/13 00:14:07 jongfoster
238 * Fixing stupid bug now I've figured out what || means.
239 * (It always returns 0 or 1, not one of it's paramaters.)
241 * Revision 1.7 2001/10/23 21:48:19 jongfoster
242 * Cleaning up error handling in CGI functions - they now send back
243 * a HTML error page and should never cause a FATAL error. (Fixes one
244 * potential source of "denial of service" attacks).
246 * CGI actions file editor that works and is actually useful.
248 * Ability to toggle JunkBuster remotely using a CGI call.
250 * You can turn off both the above features in the main configuration
251 * file, e.g. if you are running a multi-user proxy.
253 * Revision 1.6 2001/10/14 22:00:32 jongfoster
254 * Adding support for a 404 error when an invalid CGI page is requested.
256 * Revision 1.5 2001/10/07 15:30:41 oes
257 * Removed FEATURE_DENY_GZIP
259 * Revision 1.4 2001/10/02 15:31:12 oes
260 * Introduced show-request cgi
262 * Revision 1.3 2001/09/22 16:34:44 jongfoster
263 * Removing unneeded #includes
265 * Revision 1.2 2001/09/19 18:01:11 oes
266 * Fixed comments; cosmetics
268 * Revision 1.1 2001/09/16 17:08:54 jongfoster
269 * Moving simple CGI functions from cgi.c to new file cgisimple.c
272 **********************************************************************/
278 #include <sys/types.h>
285 #define snprintf _snprintf
286 #endif /* def _WIN32 */
290 #include "cgisimple.h"
296 #include "miscutil.h"
299 #include "urlmatch.h"
302 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
305 static char *show_rcs(void);
306 static jb_err show_defines(struct map *exports);
309 /*********************************************************************
311 * Function : cgi_default
313 * Description : CGI function that is called for the CGI_SITE_1_HOST
314 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
315 * Boring - only exports the default exports.
318 * 1 : csp = Current client state (buffers, headers, etc...)
319 * 2 : rsp = http_response data structure for output
320 * 3 : parameters = map of cgi parameters
322 * CGI Parameters : none
324 * Returns : JB_ERR_OK on success
325 * JB_ERR_MEMORY on out-of-memory
327 *********************************************************************/
328 jb_err cgi_default(struct client_state *csp,
329 struct http_response *rsp,
330 const struct map *parameters)
337 if (NULL == (exports = default_exports(csp, "")))
339 return JB_ERR_MEMORY;
342 return template_fill_for_cgi(csp, "default", exports, rsp);
346 /*********************************************************************
348 * Function : cgi_error_404
350 * Description : CGI function that is called if an unknown action was
354 * 1 : csp = Current client state (buffers, headers, etc...)
355 * 2 : rsp = http_response data structure for output
356 * 3 : parameters = map of cgi parameters
358 * CGI Parameters : none
360 * Returns : JB_ERR_OK on success
361 * JB_ERR_MEMORY on out-of-memory error.
363 *********************************************************************/
364 jb_err cgi_error_404(struct client_state *csp,
365 struct http_response *rsp,
366 const struct map *parameters)
374 if (NULL == (exports = default_exports(csp, NULL)))
376 return JB_ERR_MEMORY;
379 rsp->status = strdup("404 Privoxy configuration page not found");
380 if (rsp->status == NULL)
383 return JB_ERR_MEMORY;
386 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
390 #ifdef FEATURE_GRACEFUL_TERMINATION
391 /*********************************************************************
395 * Description : CGI function to shut down Privoxy.
396 * NOTE: Turning this on in a production build
397 * would be a BAD idea. An EXTREMELY BAD idea.
398 * In short, don't do it.
401 * 1 : csp = Current client state (buffers, headers, etc...)
402 * 2 : rsp = http_response data structure for output
403 * 3 : parameters = map of cgi parameters
405 * CGI Parameters : none
407 * Returns : JB_ERR_OK on success
408 * JB_ERR_MEMORY on out-of-memory error.
410 *********************************************************************/
411 jb_err cgi_die (struct client_state *csp,
412 struct http_response *rsp,
413 const struct map *parameters)
423 * I don't really care what gets sent back to the browser.
424 * Take the easy option - "out of memory" page.
427 return JB_ERR_MEMORY;
429 #endif /* def FEATURE_GRACEFUL_TERMINATION */
432 /*********************************************************************
434 * Function : cgi_show_request
436 * Description : Show the client's request and what sed() would have
440 * 1 : csp = Current client state (buffers, headers, etc...)
441 * 2 : rsp = http_response data structure for output
442 * 3 : parameters = map of cgi parameters
444 * CGI Parameters : none
446 * Returns : JB_ERR_OK on success
447 * JB_ERR_MEMORY on out-of-memory error.
449 *********************************************************************/
450 jb_err cgi_show_request(struct client_state *csp,
451 struct http_response *rsp,
452 const struct map *parameters)
461 if (NULL == (exports = default_exports(csp, "show-request")))
463 return JB_ERR_MEMORY;
467 * Repair the damage done to the IOB by get_header()
469 for (p = csp->iob->buf; p < csp->iob->eod; p++)
471 if (*p == '\0') *p = '\n';
475 * Export the original client's request and the one we would
476 * be sending to the server if this wasn't a CGI call
479 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
482 return JB_ERR_MEMORY;
485 if (map(exports, "processed-request", 1, html_encode_and_free_original(
486 sed(client_patterns, add_client_headers, csp)), 0))
489 return JB_ERR_MEMORY;
492 return template_fill_for_cgi(csp, "show-request", exports, rsp);
496 /*********************************************************************
498 * Function : cgi_send_banner
500 * Description : CGI function that returns a banner.
503 * 1 : csp = Current client state (buffers, headers, etc...)
504 * 2 : rsp = http_response data structure for output
505 * 3 : parameters = map of cgi parameters
508 * type : Selects the type of banner between "trans", "logo",
509 * and "auto". Defaults to "logo" if absent or invalid.
510 * "auto" means to select as if we were image-blocking.
511 * (Only the first character really counts; b and t are
514 * Returns : JB_ERR_OK on success
515 * JB_ERR_MEMORY on out-of-memory error.
517 *********************************************************************/
518 jb_err cgi_send_banner(struct client_state *csp,
519 struct http_response *rsp,
520 const struct map *parameters)
522 char imagetype = lookup(parameters, "type")[0];
525 * If type is auto, then determine the right thing
526 * to do from the set-image-blocker action
528 if (imagetype == 'a')
535 #ifdef FEATURE_IMAGE_BLOCKING
536 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
538 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
539 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
540 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
544 /* Use default - nothing to do here. */
546 else if (0 == strcmpic(p, "blank"))
550 else if (0 == strcmpic(p, "pattern"))
556 * If the action is to call this CGI, determine
559 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
561 imagetype = p[sizeof(prefix1) - 1];
563 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
565 imagetype = p[sizeof(prefix2) - 1];
569 * Everything else must (should) be a URL to
577 #endif /* def FEATURE_IMAGE_BLOCKING */
581 * Now imagetype is either the non-auto type we were called with,
582 * or it was auto and has since been determined. In any case, we
583 * can proceed to actually answering the request by sending a redirect
584 * or an image as appropriate:
586 if (imagetype == 'r')
588 rsp->status = strdup("302 Local Redirect from Privoxy");
589 if (rsp->status == NULL)
591 return JB_ERR_MEMORY;
593 if (enlist_unique_header(rsp->headers, "Location",
594 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
596 return JB_ERR_MEMORY;
601 if ((imagetype == 'b') || (imagetype == 't'))
603 rsp->body = bindup(image_blank_data, image_blank_length);
604 rsp->content_length = image_blank_length;
608 rsp->body = bindup(image_pattern_data, image_pattern_length);
609 rsp->content_length = image_pattern_length;
612 if (rsp->body == NULL)
614 return JB_ERR_MEMORY;
616 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
618 return JB_ERR_MEMORY;
629 /*********************************************************************
631 * Function : cgi_transparent_image
633 * Description : CGI function that sends a 1x1 transparent image.
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
640 * CGI Parameters : None
642 * Returns : JB_ERR_OK on success
643 * JB_ERR_MEMORY on out-of-memory error.
645 *********************************************************************/
646 jb_err cgi_transparent_image(struct client_state *csp,
647 struct http_response *rsp,
648 const struct map *parameters)
650 rsp->body = bindup(image_blank_data, image_blank_length);
651 rsp->content_length = image_blank_length;
653 if (rsp->body == NULL)
655 return JB_ERR_MEMORY;
658 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
660 return JB_ERR_MEMORY;
670 /*********************************************************************
672 * Function : cgi_send_stylesheet
674 * Description : CGI function that sends a css stylesheet found
675 * in the cgi-style.css template
678 * 1 : csp = Current client state (buffers, headers, etc...)
679 * 2 : rsp = http_response data structure for output
680 * 3 : parameters = map of cgi parameters
682 * CGI Parameters : None
684 * Returns : JB_ERR_OK on success
685 * JB_ERR_MEMORY on out-of-memory error.
687 *********************************************************************/
688 jb_err cgi_send_stylesheet(struct client_state *csp,
689 struct http_response *rsp,
690 const struct map *parameters)
697 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
699 if (err == JB_ERR_FILE)
702 * No way to tell user; send empty stylesheet
704 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
708 return err; /* JB_ERR_MEMORY */
711 if (enlist(rsp->headers, "Content-Type: text/css"))
713 return JB_ERR_MEMORY;
719 /*********************************************************************
721 * Function : cgi_send_user_manual
723 * Description : CGI function that sends a file in the user
727 * 1 : csp = Current client state (buffers, headers, etc...)
728 * 2 : rsp = http_response data structure for output
729 * 3 : parameters = map of cgi parameters
731 * CGI Parameters : file=name.html, the name of the HTML file
732 * (relative to user-manual from config)
734 * Returns : JB_ERR_OK on success
735 * JB_ERR_MEMORY on out-of-memory error.
737 *********************************************************************/
738 jb_err cgi_send_user_manual(struct client_state *csp,
739 struct http_response *rsp,
740 const struct map *parameters)
742 const char * filename;
745 jb_err err = JB_ERR_OK;
752 if (!parameters->first)
754 /* requested http://p.p/user-manual (without trailing slash) */
755 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
758 get_string_param(parameters, "file", &filename);
759 /* Check paramter for hack attempts */
760 if (filename && strchr(filename, '/'))
762 return JB_ERR_CGI_PARAMS;
764 if (filename && strstr(filename, ".."))
766 return JB_ERR_CGI_PARAMS;
769 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
770 if (full_path == NULL)
772 return JB_ERR_MEMORY;
775 /* Open user-manual file */
778 * XXX: Do we support other operating systems that
779 * require special treatment to fopen in binary mode?
781 if (NULL == (fp = fopen(full_path, "rb")))
783 if (NULL == (fp = fopen(full_path, "r")))
784 #endif /* def WIN32 */
786 log_error(LOG_LEVEL_ERROR, "Cannot open user-manual file %s: %E", full_path);
787 err = cgi_error_no_template(csp, rsp, full_path);
792 /* Get file length */
793 fseek(fp, 0, SEEK_END);
794 length = (size_t)ftell(fp);
795 fseek(fp, 0, SEEK_SET);
797 /* Allocate memory and load the file directly into the body */
798 rsp->body = (char *)zalloc(length+1);
803 return JB_ERR_MEMORY;
805 if (!fread(rsp->body, length, 1, fp))
808 * This happens if we didn't fopen in binary mode.
809 * If it does, we just log it and serve what we got.
811 log_error(LOG_LEVEL_ERROR, "Couldn't completely read user-manual file %s.", full_path);
816 rsp->content_length = length;
818 /* Guess correct Content-Type based on the filename's ending */
821 length = strlen(filename);
827 if((length>=4) && !strcmp(&filename[length-4], ".css"))
829 err = enlist(rsp->headers, "Content-Type: text/css");
831 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
833 err = enlist(rsp->headers, "Content-Type: image/jpeg");
837 err = enlist(rsp->headers, "Content-Type: text/html");
844 /*********************************************************************
846 * Function : cgi_show_version
848 * Description : CGI function that returns a a web page describing the
849 * file versions of Privoxy.
852 * 1 : csp = Current client state (buffers, headers, etc...)
853 * 2 : rsp = http_response data structure for output
854 * 3 : parameters = map of cgi parameters
856 * CGI Parameters : none
858 * Returns : JB_ERR_OK on success
859 * JB_ERR_MEMORY on out-of-memory error.
861 *********************************************************************/
862 jb_err cgi_show_version(struct client_state *csp,
863 struct http_response *rsp,
864 const struct map *parameters)
872 if (NULL == (exports = default_exports(csp, "show-version")))
874 return JB_ERR_MEMORY;
877 if (map(exports, "sourceversions", 1, show_rcs(), 0))
880 return JB_ERR_MEMORY;
883 return template_fill_for_cgi(csp, "show-version", exports, rsp);
887 /*********************************************************************
889 * Function : cgi_show_status
891 * Description : CGI function that returns a web page describing the
892 * current status of Privoxy.
895 * 1 : csp = Current client state (buffers, headers, etc...)
896 * 2 : rsp = http_response data structure for output
897 * 3 : parameters = map of cgi parameters
900 * file : Which file to show. Only first letter is checked,
902 * - "p"ermissions (actions) file
905 * Default is to show menu and other information.
907 * Returns : JB_ERR_OK on success
908 * JB_ERR_MEMORY on out-of-memory error.
910 *********************************************************************/
911 jb_err cgi_show_status(struct client_state *csp,
912 struct http_response *rsp,
913 const struct map *parameters)
920 char buf[BUFFER_SIZE];
921 const char * filename = NULL;
922 char * file_description = NULL;
923 #ifdef FEATURE_STATISTICS
924 float perc_rej; /* Percentage of http requests rejected */
926 int local_urls_rejected;
927 #endif /* ndef FEATURE_STATISTICS */
928 jb_err err = JB_ERR_OK;
936 if (NULL == (exports = default_exports(csp, "show-status")))
938 return JB_ERR_MEMORY;
941 switch (*(lookup(parameters, "file")))
944 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
946 filename = csp->actions_list[i]->filename;
947 file_description = "Actions File";
952 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
954 filename = csp->rlist[i]->filename;
955 file_description = "Filter File";
963 filename = csp->tlist->filename;
964 file_description = "Trust File";
967 #endif /* def FEATURE_TRUST */
970 if (NULL != filename)
972 if ( map(exports, "file-description", 1, file_description, 1)
973 || map(exports, "filepath", 1, html_encode(filename), 0) )
976 return JB_ERR_MEMORY;
979 if ((fp = fopen(filename, "r")) == NULL)
981 if (map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
984 return JB_ERR_MEMORY;
990 while ((s != NULL) && fgets(buf, sizeof(buf), fp))
992 string_join (&s, html_encode(buf));
996 if (map(exports, "contents", 1, s, 0))
999 return JB_ERR_MEMORY;
1003 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
1007 for (j = 0; (s != NULL) && (j < Argc); j++)
1009 if (!err) err = string_join (&s, html_encode(Argv[j]));
1010 if (!err) err = string_append(&s, " ");
1012 if (!err) err = map(exports, "invocation", 1, s, 0);
1014 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1015 if (!err) err = show_defines(exports);
1020 return JB_ERR_MEMORY;
1023 #ifdef FEATURE_STATISTICS
1024 local_urls_read = urls_read;
1025 local_urls_rejected = urls_rejected;
1028 * Need to alter the stats not to include the fetch of this
1031 * Can't do following thread safely! doh!
1034 * urls_rejected--; * This will be incremented subsequently *
1037 if (local_urls_read == 0)
1039 if (!err) err = map_block_killer(exports, "have-stats");
1043 if (!err) err = map_block_killer(exports, "have-no-stats");
1045 perc_rej = (float)local_urls_rejected * 100.0F /
1046 (float)local_urls_read;
1048 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1049 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1051 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1052 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1054 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1055 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1058 #else /* ndef FEATURE_STATISTICS */
1059 err = err || map_block_killer(exports, "statistics");
1060 #endif /* ndef FEATURE_STATISTICS */
1063 * List all action files in use, together with view and edit links,
1064 * except for standard.action, which should only be viewable. (Not
1065 * enforced in the editor itself)
1066 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1069 for (i = 0; i < MAX_AF_FILES; i++)
1071 if (csp->actions_list[i] != NULL)
1073 if (!err) err = string_append(&s, "<tr><td>");
1074 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1075 snprintf(buf, 100, "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1076 if (!err) err = string_append(&s, buf);
1078 #ifdef FEATURE_CGI_EDIT_ACTIONS
1079 if (NULL == strstr(csp->actions_list[i]->filename, "standard.action") && NULL != csp->config->actions_file_short[i])
1081 snprintf(buf, 100, " <a href=\"/edit-actions-list?f=%s\">Edit</a>", csp->config->actions_file_short[i]);
1082 if (!err) err = string_append(&s, buf);
1086 if (!err) err = string_append(&s, "</td></tr>\n");
1091 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1095 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1099 * List all re_filterfiles in use, together with view options.
1100 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1103 for (i = 0; i < MAX_AF_FILES; i++)
1105 if (csp->rlist[i] != NULL)
1107 if (!err) err = string_append(&s, "<tr><td>");
1108 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1110 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1111 if (!err) err = string_append(&s, buf);
1112 if (!err) err = string_append(&s, "</td></tr>\n");
1117 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1121 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1122 if (!err) err = map_block_killer(exports, "have-filterfile");
1125 #ifdef FEATURE_TRUST
1128 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1132 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1133 if (!err) err = map_block_killer(exports, "have-trustfile");
1136 if (!err) err = map_block_killer(exports, "trust-support");
1137 #endif /* ndef FEATURE_TRUST */
1142 return JB_ERR_MEMORY;
1145 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1149 /*********************************************************************
1151 * Function : cgi_show_url_info
1153 * Description : CGI function that determines and shows which actions
1154 * Privoxy will perform for a given url, and which
1155 * matches starting from the defaults have lead to that.
1158 * 1 : csp = Current client state (buffers, headers, etc...)
1159 * 2 : rsp = http_response data structure for output
1160 * 3 : parameters = map of cgi parameters
1163 * url : The url whose actions are to be determined.
1164 * If url is unset, the url-given conditional will be
1165 * set, so that all but the form can be suppressed in
1168 * Returns : JB_ERR_OK on success
1169 * JB_ERR_MEMORY on out-of-memory error.
1171 *********************************************************************/
1172 jb_err cgi_show_url_info(struct client_state *csp,
1173 struct http_response *rsp,
1174 const struct map *parameters)
1177 struct map *exports;
1184 if (NULL == (exports = default_exports(csp, "show-url-info")))
1186 return JB_ERR_MEMORY;
1190 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1192 url_param = strdup(lookup(parameters, "url"));
1193 if (url_param == NULL)
1196 return JB_ERR_MEMORY;
1201 * Handle prefixes. 4 possibilities:
1202 * 1) "http://" or "https://" prefix present and followed by URL - OK
1203 * 2) Only the "http://" or "https://" part is present, no URL - change
1204 * to empty string so it will be detected later as "no URL".
1205 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1207 * 4) Parameter not specified or is empty string - let this fall through
1208 * for now, next block of code will handle it.
1210 if (0 == strncmp(url_param, "http://", 7))
1212 if (url_param[7] == '\0')
1215 * Empty URL (just prefix).
1216 * Make it totally empty so it's caught by the next if()
1218 url_param[0] = '\0';
1221 else if (0 == strncmp(url_param, "https://", 8))
1223 if (url_param[8] == '\0')
1226 * Empty URL (just prefix).
1227 * Make it totally empty so it's caught by the next if()
1229 url_param[0] = '\0';
1232 else if (url_param[0] != '\0')
1235 * Unknown prefix - assume http://
1237 char * url_param_prefixed = malloc(7 + 1 + strlen(url_param));
1238 if (NULL == url_param_prefixed)
1242 return JB_ERR_MEMORY;
1244 strcpy(url_param_prefixed, "http://");
1245 strcpy(url_param_prefixed + 7, url_param);
1247 url_param = url_param_prefixed;
1251 * Hide "toggle off" warning if Privoxy is toggled on.
1254 #ifdef FEATURE_TOGGLE
1255 (global_toggle_state == 1) &&
1256 #endif /* def FEATURE_TOGGLE */
1257 map_block_killer(exports, "privoxy-is-toggled-off")
1261 return JB_ERR_MEMORY;
1264 if (url_param[0] == '\0')
1266 /* URL paramater not specified, display query form only. */
1268 if (map_block_killer(exports, "url-given")
1269 || map(exports, "url", 1, "", 1))
1272 return JB_ERR_MEMORY;
1277 /* Given a URL, so query it. */
1282 struct file_list *fl;
1283 struct url_actions *b;
1284 struct http_request url_to_query[1];
1285 struct current_action_spec action[1];
1288 if (map(exports, "url", 1, html_encode(url_param), 0))
1292 return JB_ERR_MEMORY;
1295 init_current_action(action);
1297 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1299 free_current_action(action);
1302 return JB_ERR_MEMORY;
1305 err = parse_http_url(url_param, url_to_query, csp);
1309 if (err == JB_ERR_MEMORY)
1311 free_http_request(url_to_query);
1312 free_current_action(action);
1314 return JB_ERR_MEMORY;
1320 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1321 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1323 free_current_action(action);
1324 free_http_request(url_to_query);
1329 return JB_ERR_MEMORY;
1332 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1336 * We have a warning about SSL paths. Hide it for insecure sites.
1338 if (!url_to_query->ssl)
1340 if (map_block_killer(exports, "https"))
1342 free_current_action(action);
1344 free_http_request(url_to_query);
1345 return JB_ERR_MEMORY;
1349 matches = strdup("<table class=\"transparent\">");
1351 for (i = 0; i < MAX_AF_FILES; i++)
1353 if (NULL == csp->config->actions_file_short[i]
1354 || !strcmp(csp->config->actions_file_short[i], "standard")) continue;
1358 if ((fl = csp->actions_list[i]) != NULL)
1360 if ((b = fl->f) != NULL)
1362 /* FIXME: Hardcoded HTML! */
1363 string_append(&matches, "<tr><th>In file: ");
1364 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1365 snprintf(buf, 150, ".action <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1366 string_append(&matches, buf);
1367 string_append(&matches, "View</a>");
1368 #ifdef FEATURE_CGI_EDIT_ACTIONS
1369 string_append(&matches, " <a class=\"cmd\" href=\"/edit-actions-list?f=");
1370 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1371 string_append(&matches, "\">Edit</a>");
1373 string_append(&matches, "</th></tr>\n");
1380 for (; (b != NULL) && (matches != NULL); b = b->next)
1382 if (url_match(b->url, url_to_query))
1384 string_append(&matches, "<tr><td>{");
1385 string_join (&matches, actions_to_html(csp, b->action));
1386 string_append(&matches, " }</b><br>\n<code>");
1387 string_join (&matches, html_encode(b->url->spec));
1388 string_append(&matches, "</code></td></tr>\n");
1390 if (merge_current_action(action, b->action))
1393 free_http_request(url_to_query);
1394 free_current_action(action);
1396 return JB_ERR_MEMORY;
1404 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1407 string_append(&matches, "</table>\n");
1409 free_http_request(url_to_query);
1411 if (matches == NULL)
1413 free_current_action(action);
1415 return JB_ERR_MEMORY;
1418 if (map(exports, "matches", 1, matches , 0))
1420 free_current_action(action);
1422 return JB_ERR_MEMORY;
1425 s = current_action_to_html(csp, action);
1427 free_current_action(action);
1429 if (map(exports, "final", 1, s, 0))
1432 return JB_ERR_MEMORY;
1436 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1440 /*********************************************************************
1442 * Function : cgi_robots_txt
1444 * Description : CGI function to return "/robots.txt".
1447 * 1 : csp = Current client state (buffers, headers, etc...)
1448 * 2 : rsp = http_response data structure for output
1449 * 3 : parameters = map of cgi parameters
1451 * CGI Parameters : None
1453 * Returns : JB_ERR_OK on success
1454 * JB_ERR_MEMORY on out-of-memory error.
1456 *********************************************************************/
1457 jb_err cgi_robots_txt(struct client_state *csp,
1458 struct http_response *rsp,
1459 const struct map *parameters)
1465 "# This is the Privoxy control interface.\n"
1466 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1472 if (rsp->body == NULL)
1474 return JB_ERR_MEMORY;
1477 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1481 get_http_time(7 * 24 * 60 * 60, buf); /* 7 days into future */
1482 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1484 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1488 /*********************************************************************
1490 * Function : show_defines
1492 * Description : Add to a map the state od all conditional #defines
1493 * used when building
1496 * 1 : exports = map to extend
1498 * Returns : JB_ERR_OK on success
1499 * JB_ERR_MEMORY on out-of-memory error.
1501 *********************************************************************/
1502 static jb_err show_defines(struct map *exports)
1504 jb_err err = JB_ERR_OK;
1507 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1508 #else /* ifndef FEATURE_ACL */
1509 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1510 #endif /* ndef FEATURE_ACL */
1512 #ifdef FEATURE_CGI_EDIT_ACTIONS
1513 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1514 #else /* ifndef FEATURE_COOKIE_JAR */
1515 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1516 #endif /* ndef FEATURE_COOKIE_JAR */
1518 #ifdef FEATURE_COOKIE_JAR
1519 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1520 #else /* ifndef FEATURE_COOKIE_JAR */
1521 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1522 #endif /* ndef FEATURE_COOKIE_JAR */
1524 #ifdef FEATURE_FAST_REDIRECTS
1525 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1526 #else /* ifndef FEATURE_FAST_REDIRECTS */
1527 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1528 #endif /* ndef FEATURE_FAST_REDIRECTS */
1530 #ifdef FEATURE_FORCE_LOAD
1531 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1532 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1533 #else /* ifndef FEATURE_FORCE_LOAD */
1534 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1535 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1536 #endif /* ndef FEATURE_FORCE_LOAD */
1538 #ifdef FEATURE_GRACEFUL_TERMINATION
1539 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1540 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1541 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1542 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1544 #ifdef FEATURE_IMAGE_BLOCKING
1545 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1546 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1547 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1548 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1550 #ifdef FEATURE_IMAGE_DETECT_MSIE
1551 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1552 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1553 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1554 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1556 #ifdef FEATURE_KILL_POPUPS
1557 if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 1);
1558 #else /* ifndef FEATURE_KILL_POPUPS */
1559 if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 0);
1560 #endif /* ndef FEATURE_KILL_POPUPS */
1562 #ifdef FEATURE_NO_GIFS
1563 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1564 #else /* ifndef FEATURE_NO_GIFS */
1565 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1566 #endif /* ndef FEATURE_NO_GIFS */
1568 #ifdef FEATURE_PTHREAD
1569 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1570 #else /* ifndef FEATURE_PTHREAD */
1571 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1572 #endif /* ndef FEATURE_PTHREAD */
1574 #ifdef FEATURE_STATISTICS
1575 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1576 #else /* ifndef FEATURE_STATISTICS */
1577 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1578 #endif /* ndef FEATURE_STATISTICS */
1580 #ifdef FEATURE_TOGGLE
1581 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1582 #else /* ifndef FEATURE_TOGGLE */
1583 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1584 #endif /* ndef FEATURE_TOGGLE */
1586 #ifdef FEATURE_TRUST
1587 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1588 #else /* ifndef FEATURE_TRUST */
1589 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1590 #endif /* ndef FEATURE_TRUST */
1593 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1594 #else /* ifndef FEATURE_ZLIB */
1595 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1596 #endif /* ndef FEATURE_ZLIB */
1599 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1600 #else /* ifndef STATIC_PCRE */
1601 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1602 #endif /* ndef STATIC_PCRE */
1605 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1606 #else /* ifndef STATIC_PCRS */
1607 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1608 #endif /* ndef STATIC_PCRS */
1614 /*********************************************************************
1616 * Function : show_rcs
1618 * Description : Create a string with the rcs info for all sourcefiles
1622 * Returns : A string, or NULL on out-of-memory.
1624 *********************************************************************/
1625 static char *show_rcs(void)
1627 char *result = strdup("");
1628 char buf[BUFFER_SIZE];
1630 /* Instead of including *all* dot h's in the project (thus creating a
1631 * tremendous amount of dependencies), I will concede to declaring them
1632 * as extern's. This forces the developer to add to this list, but oh well.
1635 #define SHOW_RCS(__x) \
1637 extern const char __x[]; \
1638 snprintf(buf, sizeof(buf), " %s\n", __x); \
1639 string_append(&result, buf); \
1642 /* In alphabetical order */
1643 SHOW_RCS(actions_h_rcs)
1644 SHOW_RCS(actions_rcs)
1646 SHOW_RCS(amiga_h_rcs)
1648 #endif /* def AMIGA */
1651 #ifdef FEATURE_CGI_EDIT_ACTIONS
1652 SHOW_RCS(cgiedit_h_rcs)
1653 SHOW_RCS(cgiedit_rcs)
1654 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1655 SHOW_RCS(cgisimple_h_rcs)
1656 SHOW_RCS(cgisimple_rcs)
1658 SHOW_RCS(cygwin_h_rcs)
1660 SHOW_RCS(deanimate_h_rcs)
1661 SHOW_RCS(deanimate_rcs)
1662 SHOW_RCS(encode_h_rcs)
1663 SHOW_RCS(encode_rcs)
1664 SHOW_RCS(errlog_h_rcs)
1665 SHOW_RCS(errlog_rcs)
1666 SHOW_RCS(filters_h_rcs)
1667 SHOW_RCS(filters_rcs)
1668 SHOW_RCS(gateway_h_rcs)
1669 SHOW_RCS(gateway_rcs)
1670 SHOW_RCS(jbsockets_h_rcs)
1671 SHOW_RCS(jbsockets_rcs)
1674 #ifdef FEATURE_KILL_POPUPS
1675 SHOW_RCS(killpopup_h_rcs)
1676 SHOW_RCS(killpopup_rcs)
1677 #endif /* def FEATURE_KILL_POPUPS */
1678 SHOW_RCS(list_h_rcs)
1680 SHOW_RCS(loadcfg_h_rcs)
1681 SHOW_RCS(loadcfg_rcs)
1682 SHOW_RCS(loaders_h_rcs)
1683 SHOW_RCS(loaders_rcs)
1684 SHOW_RCS(miscutil_h_rcs)
1685 SHOW_RCS(miscutil_rcs)
1686 SHOW_RCS(parsers_h_rcs)
1687 SHOW_RCS(parsers_rcs)
1689 SHOW_RCS(pcrs_h_rcs)
1690 SHOW_RCS(project_h_rcs)
1691 SHOW_RCS(ssplit_h_rcs)
1692 SHOW_RCS(ssplit_rcs)
1693 SHOW_RCS(urlmatch_h_rcs)
1694 SHOW_RCS(urlmatch_rcs)
1696 #ifndef _WIN_CONSOLE
1697 SHOW_RCS(w32log_h_rcs)
1698 SHOW_RCS(w32log_rcs)
1699 SHOW_RCS(w32res_h_rcs)
1700 SHOW_RCS(w32taskbar_h_rcs)
1701 SHOW_RCS(w32taskbar_rcs)
1702 #endif /* ndef _WIN_CONSOLE */
1703 SHOW_RCS(win32_h_rcs)
1705 #endif /* def _WIN32 */