1 const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.45 2006/12/28 18:16:41 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-2006 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.45 2006/12/28 18:16:41 fabiankeil
40 * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's
41 * body memory before using it, replaced sprintf calls with snprintf.
43 * Revision 1.44 2006/12/22 14:19:27 fabiankeil
44 * Removed checks whether or not AF_FILES have
45 * data structures associated with them in cgi_show_status.
46 * It doesn't matter as we're only interested in the file names.
48 * For the action files the checks were always true,
49 * but they prevented empty filter files from being
50 * listed. Fixes parts of BR 1619208.
52 * Revision 1.43 2006/12/17 17:57:56 fabiankeil
53 * - Added FEATURE_GRACEFUL_TERMINATION to the
54 * "conditional #defines" section
55 * - Escaped ampersands in generated HTML.
56 * - Renamed re-filter-filename to re-filter-filenames
58 * Revision 1.42 2006/11/21 15:43:12 fabiankeil
59 * Add special treatment for WIN32 to make sure
60 * cgi_send_user_manual opens the files in binary mode.
61 * Fixes BR 1600411 and unbreaks image delivery.
63 * Remove outdated comment.
65 * Revision 1.41 2006/10/09 19:18:28 roro
66 * Redirect http://p.p/user-manual (without trailing slash) to
67 * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken.
69 * Revision 1.40 2006/09/09 13:05:33 fabiankeil
70 * Modified cgi_send_user_manual to serve binary
71 * content without destroying it first. Should also be
72 * faster now. Added ".jpg" check for Content-Type guessing.
74 * Revision 1.39 2006/09/08 09:49:23 fabiankeil
75 * Deliver documents in the user-manual directory
76 * with "Content-Type text/css" if their filename
79 * Revision 1.38 2006/09/06 18:45:03 fabiankeil
80 * Incorporate modified version of Roland Rosenfeld's patch to
81 * optionally access the user-manual via Privoxy. Closes patch 679075.
83 * Formatting changed to Privoxy style, added call to
84 * cgi_error_no_template if the requested file doesn't
85 * exist and modified check whether or not Privoxy itself
86 * should serve the manual. Should work cross-platform now.
88 * Revision 1.37 2006/07/18 14:48:45 david__schmidt
89 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
90 * with what was really the latest development (the v_3_0_branch branch)
92 * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt
93 * Multiple filter file support
95 * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt
96 * Undo some damaging memory leak patches
98 * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt
99 * A few memory leaks plugged (mostly on error paths)
101 * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt
102 * Another instance of:
103 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
104 * Thanks to Magnus Holmgren for the patch
106 * Revision 1.35.2.3 2003/12/17 16:34:15 oes
107 * - Prevent line wrap beween "View/Edit" link buttons on status page
108 * - Some (mostly irrelevant) fixes for Out-of-mem-case handling
110 * Revision 1.35.2.2 2003/04/03 13:48:28 oes
111 * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS
113 * Revision 1.35.2.1 2002/07/04 15:02:38 oes
114 * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto
116 * Revision 1.35.2.1 2002/07/01 17:32:04 morcego
117 * Applying patch from Andreas as provided by Hal on the list.
118 * Message-ID: <20020701121218.V1606@feenix.burgiss.net>
120 * Revision 1.35 2002/05/12 21:44:44 jongfoster
121 * Adding amiga.[ch] revision information, if on an amiga.
123 * Revision 1.34 2002/04/30 12:06:12 oes
124 * Deleted unused code from default_cgi
126 * Revision 1.33 2002/04/30 11:14:52 oes
127 * Made csp the first parameter in *action_to_html
129 * Revision 1.32 2002/04/26 18:29:13 jongfoster
130 * Fixing this Visual C++ warning:
131 * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch
133 * Revision 1.31 2002/04/26 12:54:36 oes
134 * - Kill obsolete REDIRECT_URL code
135 * - Error handling fixes
136 * - Style sheet related HTML snipplet changes
137 * - cgi_show_url_info:
138 * - Matches now in table, actions on single lines,
140 * - standard.action suppressed
141 * - Buttons to View and Edit AFs
143 * Revision 1.30 2002/04/24 02:18:08 oes
144 * - show-status is now the starting point for editing
145 * the actions files, generate list of all AFs with buttons
146 * for viewing and editing, new look for file list (Jon:
147 * buttons now aligned ;-P ), view mode now supports multiple
148 * AFs, name changes, no view links for unspecified files,
149 * no edit link for standard.action.
151 * - Jon's multiple AF patch: cgi_show_url_info now uses all
152 * AFs and marks the output accordingly
154 * Revision 1.29 2002/04/10 13:38:35 oes
155 * load_template signature changed
157 * Revision 1.28 2002/04/07 15:42:12 jongfoster
158 * Fixing send-banner?type=auto when the image-blocker is
159 * a redirect to send-banner
161 * Revision 1.27 2002/04/05 15:50:48 oes
162 * added send-stylesheet CGI
164 * Revision 1.26 2002/04/04 00:36:36 gliptak
165 * always use pcre for matching
167 * Revision 1.25 2002/04/03 22:28:03 gliptak
168 * Removed references to gnu_regex
170 * Revision 1.24 2002/04/02 16:12:47 oes
171 * Fix: moving misplaced lines into #ifdef FEATURE_FORCE
173 * Revision 1.23 2002/03/26 22:29:54 swa
174 * we have a new homepage!
176 * Revision 1.22 2002/03/24 16:18:15 jongfoster
179 * Revision 1.21 2002/03/24 15:23:33 jongfoster
182 * Revision 1.20 2002/03/24 13:25:43 swa
183 * name change related issues
185 * Revision 1.19 2002/03/16 23:54:06 jongfoster
186 * Adding graceful termination feature, to help look for memory leaks.
187 * If you enable this (which, by design, has to be done by hand
188 * editing config.h) and then go to http://i.j.b/die, then the program
189 * will exit cleanly after the *next* request. It should free all the
190 * memory that was used.
192 * Revision 1.18 2002/03/12 01:44:49 oes
193 * Changed default for "blocked" image from jb logo to checkboard pattern
195 * Revision 1.17 2002/03/08 16:43:18 oes
196 * Added choice beween GIF and PNG built-in images
198 * Revision 1.16 2002/03/07 03:48:38 oes
199 * - Changed built-in images from GIF to PNG
200 * (with regard to Unisys patent issue)
201 * - Added a 4x4 pattern PNG which is less intrusive
202 * than the logo but also clearly marks the deleted banners
204 * Revision 1.15 2002/03/06 22:54:35 jongfoster
205 * Automated function-comment nitpicking.
207 * Revision 1.14 2002/03/02 04:14:50 david__schmidt
208 * Clean up a little CRLF unpleasantness that suddenly appeared
210 * Revision 1.13 2002/02/21 00:10:37 jongfoster
211 * Adding send-banner?type=auto option
213 * Revision 1.12 2002/01/23 01:03:32 jongfoster
214 * Fixing gcc [CygWin] compiler warnings
216 * Revision 1.11 2002/01/23 00:01:04 jongfoster
217 * Adding cgi_transparent_gif() for http://i.j.b/t
218 * Adding missing html_encode() to many CGI functions.
219 * Adding urlmatch.[ch] to http://i.j.b/show-version
221 * Revision 1.10 2002/01/17 21:10:37 jongfoster
222 * Changes to cgi_show_url_info to use new matching code from urlmatch.c.
223 * Also fixing a problem in the same function with improperly quoted URLs
224 * in output HTML, and adding code to handle https:// URLs correctly.
226 * Revision 1.9 2001/11/30 23:09:15 jongfoster
227 * Now reports on FEATURE_CGI_EDIT_ACTIONS
228 * Removing FEATURE_DENY_GZIP from template
230 * Revision 1.8 2001/11/13 00:14:07 jongfoster
231 * Fixing stupid bug now I've figured out what || means.
232 * (It always returns 0 or 1, not one of it's paramaters.)
234 * Revision 1.7 2001/10/23 21:48:19 jongfoster
235 * Cleaning up error handling in CGI functions - they now send back
236 * a HTML error page and should never cause a FATAL error. (Fixes one
237 * potential source of "denial of service" attacks).
239 * CGI actions file editor that works and is actually useful.
241 * Ability to toggle JunkBuster remotely using a CGI call.
243 * You can turn off both the above features in the main configuration
244 * file, e.g. if you are running a multi-user proxy.
246 * Revision 1.6 2001/10/14 22:00:32 jongfoster
247 * Adding support for a 404 error when an invalid CGI page is requested.
249 * Revision 1.5 2001/10/07 15:30:41 oes
250 * Removed FEATURE_DENY_GZIP
252 * Revision 1.4 2001/10/02 15:31:12 oes
253 * Introduced show-request cgi
255 * Revision 1.3 2001/09/22 16:34:44 jongfoster
256 * Removing unneeded #includes
258 * Revision 1.2 2001/09/19 18:01:11 oes
259 * Fixed comments; cosmetics
261 * Revision 1.1 2001/09/16 17:08:54 jongfoster
262 * Moving simple CGI functions from cgi.c to new file cgisimple.c
265 **********************************************************************/
271 #include <sys/types.h>
278 #define snprintf _snprintf
279 #endif /* def _WIN32 */
283 #include "cgisimple.h"
289 #include "miscutil.h"
292 #include "urlmatch.h"
295 const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION;
298 static char *show_rcs(void);
299 static jb_err show_defines(struct map *exports);
302 /*********************************************************************
304 * Function : cgi_default
306 * Description : CGI function that is called for the CGI_SITE_1_HOST
307 * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs.
308 * Boring - only exports the default exports.
311 * 1 : csp = Current client state (buffers, headers, etc...)
312 * 2 : rsp = http_response data structure for output
313 * 3 : parameters = map of cgi parameters
315 * CGI Parameters : none
317 * Returns : JB_ERR_OK on success
318 * JB_ERR_MEMORY on out-of-memory
320 *********************************************************************/
321 jb_err cgi_default(struct client_state *csp,
322 struct http_response *rsp,
323 const struct map *parameters)
330 if (NULL == (exports = default_exports(csp, "")))
332 return JB_ERR_MEMORY;
335 return template_fill_for_cgi(csp, "default", exports, rsp);
339 /*********************************************************************
341 * Function : cgi_error_404
343 * Description : CGI function that is called if an unknown action was
347 * 1 : csp = Current client state (buffers, headers, etc...)
348 * 2 : rsp = http_response data structure for output
349 * 3 : parameters = map of cgi parameters
351 * CGI Parameters : none
353 * Returns : JB_ERR_OK on success
354 * JB_ERR_MEMORY on out-of-memory error.
356 *********************************************************************/
357 jb_err cgi_error_404(struct client_state *csp,
358 struct http_response *rsp,
359 const struct map *parameters)
367 if (NULL == (exports = default_exports(csp, NULL)))
369 return JB_ERR_MEMORY;
372 rsp->status = strdup("404 Privoxy configuration page not found");
373 if (rsp->status == NULL)
376 return JB_ERR_MEMORY;
379 return template_fill_for_cgi(csp, "cgi-error-404", exports, rsp);
383 #ifdef FEATURE_GRACEFUL_TERMINATION
384 /*********************************************************************
388 * Description : CGI function to shut down Privoxy.
389 * NOTE: Turning this on in a production build
390 * would be a BAD idea. An EXTREMELY BAD idea.
391 * In short, don't do it.
394 * 1 : csp = Current client state (buffers, headers, etc...)
395 * 2 : rsp = http_response data structure for output
396 * 3 : parameters = map of cgi parameters
398 * CGI Parameters : none
400 * Returns : JB_ERR_OK on success
401 * JB_ERR_MEMORY on out-of-memory error.
403 *********************************************************************/
404 jb_err cgi_die (struct client_state *csp,
405 struct http_response *rsp,
406 const struct map *parameters)
416 * I don't really care what gets sent back to the browser.
417 * Take the easy option - "out of memory" page.
420 return JB_ERR_MEMORY;
422 #endif /* def FEATURE_GRACEFUL_TERMINATION */
425 /*********************************************************************
427 * Function : cgi_show_request
429 * Description : Show the client's request and what sed() would have
433 * 1 : csp = Current client state (buffers, headers, etc...)
434 * 2 : rsp = http_response data structure for output
435 * 3 : parameters = map of cgi parameters
437 * CGI Parameters : none
439 * Returns : JB_ERR_OK on success
440 * JB_ERR_MEMORY on out-of-memory error.
442 *********************************************************************/
443 jb_err cgi_show_request(struct client_state *csp,
444 struct http_response *rsp,
445 const struct map *parameters)
454 if (NULL == (exports = default_exports(csp, "show-request")))
456 return JB_ERR_MEMORY;
460 * Repair the damage done to the IOB by get_header()
462 for (p = csp->iob->buf; p < csp->iob->eod; p++)
464 if (*p == '\0') *p = '\n';
468 * Export the original client's request and the one we would
469 * be sending to the server if this wasn't a CGI call
472 if (map(exports, "client-request", 1, html_encode(csp->iob->buf), 0))
475 return JB_ERR_MEMORY;
478 if (map(exports, "processed-request", 1, html_encode_and_free_original(
479 sed(client_patterns, add_client_headers, csp)), 0))
482 return JB_ERR_MEMORY;
485 return template_fill_for_cgi(csp, "show-request", exports, rsp);
489 /*********************************************************************
491 * Function : cgi_send_banner
493 * Description : CGI function that returns a banner.
496 * 1 : csp = Current client state (buffers, headers, etc...)
497 * 2 : rsp = http_response data structure for output
498 * 3 : parameters = map of cgi parameters
501 * type : Selects the type of banner between "trans", "logo",
502 * and "auto". Defaults to "logo" if absent or invalid.
503 * "auto" means to select as if we were image-blocking.
504 * (Only the first character really counts; b and t are
507 * Returns : JB_ERR_OK on success
508 * JB_ERR_MEMORY on out-of-memory error.
510 *********************************************************************/
511 jb_err cgi_send_banner(struct client_state *csp,
512 struct http_response *rsp,
513 const struct map *parameters)
515 char imagetype = lookup(parameters, "type")[0];
518 * If type is auto, then determine the right thing
519 * to do from the set-image-blocker action
521 if (imagetype == 'a')
528 #ifdef FEATURE_IMAGE_BLOCKING
529 if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
531 static const char prefix1[] = CGI_PREFIX "send-banner?type=";
532 static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type=";
533 const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
537 /* Use default - nothing to do here. */
539 else if (0 == strcmpic(p, "blank"))
543 else if (0 == strcmpic(p, "pattern"))
549 * If the action is to call this CGI, determine
552 else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1))
554 imagetype = p[sizeof(prefix1) - 1];
556 else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1))
558 imagetype = p[sizeof(prefix2) - 1];
562 * Everything else must (should) be a URL to
570 #endif /* def FEATURE_IMAGE_BLOCKING */
574 * Now imagetype is either the non-auto type we were called with,
575 * or it was auto and has since been determined. In any case, we
576 * can proceed to actually answering the request by sending a redirect
577 * or an image as appropriate:
579 if (imagetype == 'r')
581 rsp->status = strdup("302 Local Redirect from Privoxy");
582 if (rsp->status == NULL)
584 return JB_ERR_MEMORY;
586 if (enlist_unique_header(rsp->headers, "Location",
587 csp->action->string[ACTION_STRING_IMAGE_BLOCKER]))
589 return JB_ERR_MEMORY;
594 if ((imagetype == 'b') || (imagetype == 't'))
596 rsp->body = bindup(image_blank_data, image_blank_length);
597 rsp->content_length = image_blank_length;
601 rsp->body = bindup(image_pattern_data, image_pattern_length);
602 rsp->content_length = image_pattern_length;
605 if (rsp->body == NULL)
607 return JB_ERR_MEMORY;
609 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
611 return JB_ERR_MEMORY;
622 /*********************************************************************
624 * Function : cgi_transparent_image
626 * Description : CGI function that sends a 1x1 transparent image.
629 * 1 : csp = Current client state (buffers, headers, etc...)
630 * 2 : rsp = http_response data structure for output
631 * 3 : parameters = map of cgi parameters
633 * CGI Parameters : None
635 * Returns : JB_ERR_OK on success
636 * JB_ERR_MEMORY on out-of-memory error.
638 *********************************************************************/
639 jb_err cgi_transparent_image(struct client_state *csp,
640 struct http_response *rsp,
641 const struct map *parameters)
643 rsp->body = bindup(image_blank_data, image_blank_length);
644 rsp->content_length = image_blank_length;
646 if (rsp->body == NULL)
648 return JB_ERR_MEMORY;
651 if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE))
653 return JB_ERR_MEMORY;
663 /*********************************************************************
665 * Function : cgi_send_stylesheet
667 * Description : CGI function that sends a css stylesheet found
668 * in the cgi-style.css template
671 * 1 : csp = Current client state (buffers, headers, etc...)
672 * 2 : rsp = http_response data structure for output
673 * 3 : parameters = map of cgi parameters
675 * CGI Parameters : None
677 * Returns : JB_ERR_OK on success
678 * JB_ERR_MEMORY on out-of-memory error.
680 *********************************************************************/
681 jb_err cgi_send_stylesheet(struct client_state *csp,
682 struct http_response *rsp,
683 const struct map *parameters)
690 err = template_load(csp, &rsp->body, "cgi-style.css", 0);
692 if (err == JB_ERR_FILE)
695 * No way to tell user; send empty stylesheet
697 log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template");
701 return err; /* JB_ERR_MEMORY */
704 if (enlist(rsp->headers, "Content-Type: text/css"))
706 return JB_ERR_MEMORY;
712 /*********************************************************************
714 * Function : cgi_send_user_manual
716 * Description : CGI function that sends a file in the user
720 * 1 : csp = Current client state (buffers, headers, etc...)
721 * 2 : rsp = http_response data structure for output
722 * 3 : parameters = map of cgi parameters
724 * CGI Parameters : file=name.html, the name of the HTML file
725 * (relative to user-manual from config)
727 * Returns : JB_ERR_OK on success
728 * JB_ERR_MEMORY on out-of-memory error.
730 *********************************************************************/
731 jb_err cgi_send_user_manual(struct client_state *csp,
732 struct http_response *rsp,
733 const struct map *parameters)
735 const char * filename;
738 jb_err err = JB_ERR_OK;
745 if (!parameters->first)
747 /* requested http://p.p/user-manual (without trailing slash) */
748 return cgi_redirect(rsp, CGI_PREFIX "user-manual/");
751 get_string_param(parameters, "file", &filename);
752 /* Check paramter for hack attempts */
753 if (filename && strchr(filename, '/'))
755 return JB_ERR_CGI_PARAMS;
757 if (filename && strstr(filename, ".."))
759 return JB_ERR_CGI_PARAMS;
762 full_path = make_path(csp->config->usermanual, filename ? filename : "index.html");
763 if (full_path == NULL)
765 return JB_ERR_MEMORY;
768 /* Open user-manual file */
771 * XXX: Do we support other operating systems that
772 * require special treatment to fopen in binary mode?
774 if (NULL == (fp = fopen(full_path, "rb")))
776 if (NULL == (fp = fopen(full_path, "r")))
777 #endif /* def WIN32 */
779 log_error(LOG_LEVEL_ERROR, "Cannot open user-manual file %s: %E", full_path);
780 err = cgi_error_no_template(csp, rsp, full_path);
785 /* Get file length */
786 fseek(fp, 0, SEEK_END);
787 length = (size_t)ftell(fp);
788 fseek(fp, 0, SEEK_SET);
790 /* Allocate memory and load the file directly into the body */
791 rsp->body = (char *)malloc(length+1);
796 return JB_ERR_MEMORY;
798 memset(rsp->body, '\0', length+1);
799 if (!fread(rsp->body, length, 1, fp))
802 * This happens if we didn't fopen in binary mode.
803 * If it does, we just log it and serve what we got.
805 log_error(LOG_LEVEL_ERROR, "Couldn't completely read user-manual file %s.", full_path);
810 rsp->content_length = length;
812 /* Guess correct Content-Type based on the filename's ending */
815 length = strlen(filename);
821 if((length>=4) && !strcmp(&filename[length-4], ".css"))
823 err = enlist(rsp->headers, "Content-Type: text/css");
825 else if((length>=4) && !strcmp(&filename[length-4], ".jpg"))
827 err = enlist(rsp->headers, "Content-Type: image/jpeg");
831 err = enlist(rsp->headers, "Content-Type: text/html");
838 /*********************************************************************
840 * Function : cgi_show_version
842 * Description : CGI function that returns a a web page describing the
843 * file versions of Privoxy.
846 * 1 : csp = Current client state (buffers, headers, etc...)
847 * 2 : rsp = http_response data structure for output
848 * 3 : parameters = map of cgi parameters
850 * CGI Parameters : none
852 * Returns : JB_ERR_OK on success
853 * JB_ERR_MEMORY on out-of-memory error.
855 *********************************************************************/
856 jb_err cgi_show_version(struct client_state *csp,
857 struct http_response *rsp,
858 const struct map *parameters)
866 if (NULL == (exports = default_exports(csp, "show-version")))
868 return JB_ERR_MEMORY;
871 if (map(exports, "sourceversions", 1, show_rcs(), 0))
874 return JB_ERR_MEMORY;
877 return template_fill_for_cgi(csp, "show-version", exports, rsp);
881 /*********************************************************************
883 * Function : cgi_show_status
885 * Description : CGI function that returns a web page describing the
886 * current status of Privoxy.
889 * 1 : csp = Current client state (buffers, headers, etc...)
890 * 2 : rsp = http_response data structure for output
891 * 3 : parameters = map of cgi parameters
894 * file : Which file to show. Only first letter is checked,
896 * - "p"ermissions (actions) file
899 * Default is to show menu and other information.
901 * Returns : JB_ERR_OK on success
902 * JB_ERR_MEMORY on out-of-memory error.
904 *********************************************************************/
905 jb_err cgi_show_status(struct client_state *csp,
906 struct http_response *rsp,
907 const struct map *parameters)
914 char buf[BUFFER_SIZE];
915 const char * filename = NULL;
916 char * file_description = NULL;
917 #ifdef FEATURE_STATISTICS
918 float perc_rej; /* Percentage of http requests rejected */
920 int local_urls_rejected;
921 #endif /* ndef FEATURE_STATISTICS */
922 jb_err err = JB_ERR_OK;
930 if (NULL == (exports = default_exports(csp, "show-status")))
932 return JB_ERR_MEMORY;
935 switch (*(lookup(parameters, "file")))
938 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i])
940 filename = csp->actions_list[i]->filename;
941 file_description = "Actions File";
946 if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i])
948 filename = csp->rlist[i]->filename;
949 file_description = "Filter File";
957 filename = csp->tlist->filename;
958 file_description = "Trust File";
961 #endif /* def FEATURE_TRUST */
964 if (NULL != filename)
966 if ( map(exports, "file-description", 1, file_description, 1)
967 || map(exports, "filepath", 1, html_encode(filename), 0) )
970 return JB_ERR_MEMORY;
973 if ((fp = fopen(filename, "r")) == NULL)
975 if (map(exports, "content", 1, "<h1>ERROR OPENING FILE!</h1>", 1))
978 return JB_ERR_MEMORY;
984 while ((s != NULL) && fgets(buf, sizeof(buf), fp))
986 string_join (&s, html_encode(buf));
990 if (map(exports, "contents", 1, s, 0))
993 return JB_ERR_MEMORY;
997 return template_fill_for_cgi(csp, "show-status-file", exports, rsp);
1001 for (j = 0; (s != NULL) && (j < Argc); j++)
1003 if (!err) err = string_join (&s, html_encode(Argv[j]));
1004 if (!err) err = string_append(&s, " ");
1006 if (!err) err = map(exports, "invocation", 1, s, 0);
1008 if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1);
1009 if (!err) err = show_defines(exports);
1014 return JB_ERR_MEMORY;
1017 #ifdef FEATURE_STATISTICS
1018 local_urls_read = urls_read;
1019 local_urls_rejected = urls_rejected;
1022 * Need to alter the stats not to include the fetch of this
1025 * Can't do following thread safely! doh!
1028 * urls_rejected--; * This will be incremented subsequently *
1031 if (local_urls_read == 0)
1033 if (!err) err = map_block_killer(exports, "have-stats");
1037 if (!err) err = map_block_killer(exports, "have-no-stats");
1039 perc_rej = (float)local_urls_rejected * 100.0F /
1040 (float)local_urls_read;
1042 snprintf(buf, sizeof(buf), "%d", local_urls_read);
1043 if (!err) err = map(exports, "requests-received", 1, buf, 1);
1045 snprintf(buf, sizeof(buf), "%d", local_urls_rejected);
1046 if (!err) err = map(exports, "requests-blocked", 1, buf, 1);
1048 snprintf(buf, sizeof(buf), "%6.2f", perc_rej);
1049 if (!err) err = map(exports, "percent-blocked", 1, buf, 1);
1052 #else /* ndef FEATURE_STATISTICS */
1053 err = err || map_block_killer(exports, "statistics");
1054 #endif /* ndef FEATURE_STATISTICS */
1057 * List all action files in use, together with view and edit links,
1058 * except for standard.action, which should only be viewable. (Not
1059 * enforced in the editor itself)
1060 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1063 for (i = 0; i < MAX_AF_FILES; i++)
1065 if (csp->actions_list[i] != NULL)
1067 if (!err) err = string_append(&s, "<tr><td>");
1068 if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
1069 snprintf(buf, 100, "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
1070 if (!err) err = string_append(&s, buf);
1072 #ifdef FEATURE_CGI_EDIT_ACTIONS
1073 if (NULL == strstr(csp->actions_list[i]->filename, "standard.action") && NULL != csp->config->actions_file_short[i])
1075 snprintf(buf, 100, " <a href=\"/edit-actions-list?f=%s\">Edit</a>", csp->config->actions_file_short[i]);
1076 if (!err) err = string_append(&s, buf);
1080 if (!err) err = string_append(&s, "</td></tr>\n");
1085 if (!err) err = map(exports, "actions-filenames", 1, s, 0);
1089 if (!err) err = map(exports, "actions-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1093 * List all re_filterfiles in use, together with view options.
1094 * FIXME: Shouldn't include hardwired HTML here, use line template instead!
1097 for (i = 0; i < MAX_AF_FILES; i++)
1099 if (csp->rlist[i] != NULL)
1101 if (!err) err = string_append(&s, "<tr><td>");
1102 if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
1104 "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
1105 if (!err) err = string_append(&s, buf);
1106 if (!err) err = string_append(&s, "</td></tr>\n");
1111 if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
1115 if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
1116 if (!err) err = map_block_killer(exports, "have-filterfile");
1119 #ifdef FEATURE_TRUST
1122 if (!err) err = map(exports, "trust-filename", 1, html_encode(csp->tlist->filename), 0);
1126 if (!err) err = map(exports, "trust-filename", 1, "None specified", 1);
1127 if (!err) err = map_block_killer(exports, "have-trustfile");
1130 if (!err) err = map_block_killer(exports, "trust-support");
1131 #endif /* ndef FEATURE_TRUST */
1136 return JB_ERR_MEMORY;
1139 return template_fill_for_cgi(csp, "show-status", exports, rsp);
1143 /*********************************************************************
1145 * Function : cgi_show_url_info
1147 * Description : CGI function that determines and shows which actions
1148 * Privoxy will perform for a given url, and which
1149 * matches starting from the defaults have lead to that.
1152 * 1 : csp = Current client state (buffers, headers, etc...)
1153 * 2 : rsp = http_response data structure for output
1154 * 3 : parameters = map of cgi parameters
1157 * url : The url whose actions are to be determined.
1158 * If url is unset, the url-given conditional will be
1159 * set, so that all but the form can be suppressed in
1162 * Returns : JB_ERR_OK on success
1163 * JB_ERR_MEMORY on out-of-memory error.
1165 *********************************************************************/
1166 jb_err cgi_show_url_info(struct client_state *csp,
1167 struct http_response *rsp,
1168 const struct map *parameters)
1171 struct map *exports;
1178 if (NULL == (exports = default_exports(csp, "show-url-info")))
1180 return JB_ERR_MEMORY;
1184 * Get the url= parameter (if present) and remove any leading/trailing spaces.
1186 url_param = strdup(lookup(parameters, "url"));
1187 if (url_param == NULL)
1190 return JB_ERR_MEMORY;
1195 * Handle prefixes. 4 possibilities:
1196 * 1) "http://" or "https://" prefix present and followed by URL - OK
1197 * 2) Only the "http://" or "https://" part is present, no URL - change
1198 * to empty string so it will be detected later as "no URL".
1199 * 3) Parameter specified but doesn't contain "http(s?)://" - add a
1201 * 4) Parameter not specified or is empty string - let this fall through
1202 * for now, next block of code will handle it.
1204 if (0 == strncmp(url_param, "http://", 7))
1206 if (url_param[7] == '\0')
1209 * Empty URL (just prefix).
1210 * Make it totally empty so it's caught by the next if()
1212 url_param[0] = '\0';
1215 else if (0 == strncmp(url_param, "https://", 8))
1217 if (url_param[8] == '\0')
1220 * Empty URL (just prefix).
1221 * Make it totally empty so it's caught by the next if()
1223 url_param[0] = '\0';
1226 else if (url_param[0] != '\0')
1229 * Unknown prefix - assume http://
1231 char * url_param_prefixed = malloc(7 + 1 + strlen(url_param));
1232 if (NULL == url_param_prefixed)
1236 return JB_ERR_MEMORY;
1238 strcpy(url_param_prefixed, "http://");
1239 strcpy(url_param_prefixed + 7, url_param);
1241 url_param = url_param_prefixed;
1245 if (url_param[0] == '\0')
1247 /* URL paramater not specified, display query form only. */
1249 if (map_block_killer(exports, "url-given")
1250 || map(exports, "url", 1, "", 1))
1253 return JB_ERR_MEMORY;
1258 /* Given a URL, so query it. */
1263 struct file_list *fl;
1264 struct url_actions *b;
1265 struct http_request url_to_query[1];
1266 struct current_action_spec action[1];
1269 if (map(exports, "url", 1, html_encode(url_param), 0))
1273 return JB_ERR_MEMORY;
1276 init_current_action(action);
1278 if (map(exports, "default", 1, current_action_to_html(csp, action), 0))
1280 free_current_action(action);
1283 return JB_ERR_MEMORY;
1286 err = parse_http_url(url_param, url_to_query, csp);
1290 if (err == JB_ERR_MEMORY)
1292 free_http_request(url_to_query);
1293 free_current_action(action);
1295 return JB_ERR_MEMORY;
1301 err = map(exports, "matches", 1, "<b>[Invalid URL specified!]</b>" , 1);
1302 if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1);
1304 free_current_action(action);
1305 free_http_request(url_to_query);
1310 return JB_ERR_MEMORY;
1313 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1317 * We have a warning about SSL paths. Hide it for insecure sites.
1319 if (!url_to_query->ssl)
1321 if (map_block_killer(exports, "https"))
1323 free_current_action(action);
1325 free_http_request(url_to_query);
1326 return JB_ERR_MEMORY;
1330 matches = strdup("<table class=\"transparent\">");
1332 for (i = 0; i < MAX_AF_FILES; i++)
1334 if (NULL == csp->config->actions_file_short[i]
1335 || !strcmp(csp->config->actions_file_short[i], "standard")) continue;
1339 if ((fl = csp->actions_list[i]) != NULL)
1341 if ((b = fl->f) != NULL)
1343 /* FIXME: Hardcoded HTML! */
1344 string_append(&matches, "<tr><th>In file: ");
1345 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1346 snprintf(buf, 150, ".action <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
1347 string_append(&matches, buf);
1348 string_append(&matches, "View</a>");
1349 #ifdef FEATURE_CGI_EDIT_ACTIONS
1350 string_append(&matches, " <a class=\"cmd\" href=\"/edit-actions-list?f=");
1351 string_join (&matches, html_encode(csp->config->actions_file_short[i]));
1352 string_append(&matches, "\">Edit</a>");
1354 string_append(&matches, "</th></tr>\n");
1361 for (; (b != NULL) && (matches != NULL); b = b->next)
1363 if (url_match(b->url, url_to_query))
1365 string_append(&matches, "<tr><td>{");
1366 string_join (&matches, actions_to_html(csp, b->action));
1367 string_append(&matches, " }</b><br>\n<code>");
1368 string_join (&matches, html_encode(b->url->spec));
1369 string_append(&matches, "</code></td></tr>\n");
1371 if (merge_current_action(action, b->action))
1374 free_http_request(url_to_query);
1375 free_current_action(action);
1377 return JB_ERR_MEMORY;
1385 string_append(&matches, "<tr><td>(no matches in this file)</td></tr>\n");
1388 string_append(&matches, "</table>\n");
1390 free_http_request(url_to_query);
1392 if (matches == NULL)
1394 free_current_action(action);
1396 return JB_ERR_MEMORY;
1399 if (map(exports, "matches", 1, matches , 0))
1401 free_current_action(action);
1403 return JB_ERR_MEMORY;
1406 s = current_action_to_html(csp, action);
1408 free_current_action(action);
1410 if (map(exports, "final", 1, s, 0))
1413 return JB_ERR_MEMORY;
1417 return template_fill_for_cgi(csp, "show-url-info", exports, rsp);
1421 /*********************************************************************
1423 * Function : cgi_robots_txt
1425 * Description : CGI function to return "/robots.txt".
1428 * 1 : csp = Current client state (buffers, headers, etc...)
1429 * 2 : rsp = http_response data structure for output
1430 * 3 : parameters = map of cgi parameters
1432 * CGI Parameters : None
1434 * Returns : JB_ERR_OK on success
1435 * JB_ERR_MEMORY on out-of-memory error.
1437 *********************************************************************/
1438 jb_err cgi_robots_txt(struct client_state *csp,
1439 struct http_response *rsp,
1440 const struct map *parameters)
1446 "# This is the Privoxy control interface.\n"
1447 "# It isn't very useful to index it, and you're likely to break stuff.\n"
1453 if (rsp->body == NULL)
1455 return JB_ERR_MEMORY;
1458 err = enlist_unique(rsp->headers, "Content-Type: text/plain", 13);
1462 get_http_time(7 * 24 * 60 * 60, buf); /* 7 days into future */
1463 if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf);
1465 return (err ? JB_ERR_MEMORY : JB_ERR_OK);
1469 /*********************************************************************
1471 * Function : show_defines
1473 * Description : Add to a map the state od all conditional #defines
1474 * used when building
1477 * 1 : exports = map to extend
1479 * Returns : JB_ERR_OK on success
1480 * JB_ERR_MEMORY on out-of-memory error.
1482 *********************************************************************/
1483 static jb_err show_defines(struct map *exports)
1485 jb_err err = JB_ERR_OK;
1488 if (!err) err = map_conditional(exports, "FEATURE_ACL", 1);
1489 #else /* ifndef FEATURE_ACL */
1490 if (!err) err = map_conditional(exports, "FEATURE_ACL", 0);
1491 #endif /* ndef FEATURE_ACL */
1493 #ifdef FEATURE_CGI_EDIT_ACTIONS
1494 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 1);
1495 #else /* ifndef FEATURE_COOKIE_JAR */
1496 if (!err) err = map_conditional(exports, "FEATURE_CGI_EDIT_ACTIONS", 0);
1497 #endif /* ndef FEATURE_COOKIE_JAR */
1499 #ifdef FEATURE_COOKIE_JAR
1500 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 1);
1501 #else /* ifndef FEATURE_COOKIE_JAR */
1502 if (!err) err = map_conditional(exports, "FEATURE_COOKIE_JAR", 0);
1503 #endif /* ndef FEATURE_COOKIE_JAR */
1505 #ifdef FEATURE_FAST_REDIRECTS
1506 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 1);
1507 #else /* ifndef FEATURE_FAST_REDIRECTS */
1508 if (!err) err = map_conditional(exports, "FEATURE_FAST_REDIRECTS", 0);
1509 #endif /* ndef FEATURE_FAST_REDIRECTS */
1511 #ifdef FEATURE_FORCE_LOAD
1512 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 1);
1513 if (!err) err = map(exports, "FORCE_PREFIX", 1, FORCE_PREFIX, 1);
1514 #else /* ifndef FEATURE_FORCE_LOAD */
1515 if (!err) err = map_conditional(exports, "FEATURE_FORCE_LOAD", 0);
1516 if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1);
1517 #endif /* ndef FEATURE_FORCE_LOAD */
1519 #ifdef FEATURE_GRACEFUL_TERMINATION
1520 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1);
1521 #else /* ifndef FEATURE_GRACEFUL_TERMINATION */
1522 if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0);
1523 #endif /* ndef FEATURE_GRACEFUL_TERMINATION */
1525 #ifdef FEATURE_IMAGE_BLOCKING
1526 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1);
1527 #else /* ifndef FEATURE_IMAGE_BLOCKING */
1528 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 0);
1529 #endif /* ndef FEATURE_IMAGE_BLOCKING */
1531 #ifdef FEATURE_IMAGE_DETECT_MSIE
1532 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 1);
1533 #else /* ifndef FEATURE_IMAGE_DETECT_MSIE */
1534 if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0);
1535 #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */
1537 #ifdef FEATURE_KILL_POPUPS
1538 if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 1);
1539 #else /* ifndef FEATURE_KILL_POPUPS */
1540 if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 0);
1541 #endif /* ndef FEATURE_KILL_POPUPS */
1543 #ifdef FEATURE_NO_GIFS
1544 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1);
1545 #else /* ifndef FEATURE_NO_GIFS */
1546 if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 0);
1547 #endif /* ndef FEATURE_NO_GIFS */
1549 #ifdef FEATURE_PTHREAD
1550 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 1);
1551 #else /* ifndef FEATURE_PTHREAD */
1552 if (!err) err = map_conditional(exports, "FEATURE_PTHREAD", 0);
1553 #endif /* ndef FEATURE_PTHREAD */
1555 #ifdef FEATURE_STATISTICS
1556 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 1);
1557 #else /* ifndef FEATURE_STATISTICS */
1558 if (!err) err = map_conditional(exports, "FEATURE_STATISTICS", 0);
1559 #endif /* ndef FEATURE_STATISTICS */
1561 #ifdef FEATURE_TOGGLE
1562 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 1);
1563 #else /* ifndef FEATURE_TOGGLE */
1564 if (!err) err = map_conditional(exports, "FEATURE_TOGGLE", 0);
1565 #endif /* ndef FEATURE_TOGGLE */
1567 #ifdef FEATURE_TRUST
1568 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 1);
1569 #else /* ifndef FEATURE_TRUST */
1570 if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0);
1571 #endif /* ndef FEATURE_TRUST */
1574 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1);
1575 #else /* ifndef FEATURE_ZLIB */
1576 if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0);
1577 #endif /* ndef FEATURE_ZLIB */
1580 if (!err) err = map_conditional(exports, "STATIC_PCRE", 1);
1581 #else /* ifndef STATIC_PCRE */
1582 if (!err) err = map_conditional(exports, "STATIC_PCRE", 0);
1583 #endif /* ndef STATIC_PCRE */
1586 if (!err) err = map_conditional(exports, "STATIC_PCRS", 1);
1587 #else /* ifndef STATIC_PCRS */
1588 if (!err) err = map_conditional(exports, "STATIC_PCRS", 0);
1589 #endif /* ndef STATIC_PCRS */
1595 /*********************************************************************
1597 * Function : show_rcs
1599 * Description : Create a string with the rcs info for all sourcefiles
1603 * Returns : A string, or NULL on out-of-memory.
1605 *********************************************************************/
1606 static char *show_rcs(void)
1608 char *result = strdup("");
1609 char buf[BUFFER_SIZE];
1611 /* Instead of including *all* dot h's in the project (thus creating a
1612 * tremendous amount of dependencies), I will concede to declaring them
1613 * as extern's. This forces the developer to add to this list, but oh well.
1616 #define SHOW_RCS(__x) \
1618 extern const char __x[]; \
1619 snprintf(buf, sizeof(buf), " %s\n", __x); \
1620 string_append(&result, buf); \
1623 /* In alphabetical order */
1624 SHOW_RCS(actions_h_rcs)
1625 SHOW_RCS(actions_rcs)
1627 SHOW_RCS(amiga_h_rcs)
1629 #endif /* def AMIGA */
1632 #ifdef FEATURE_CGI_EDIT_ACTIONS
1633 SHOW_RCS(cgiedit_h_rcs)
1634 SHOW_RCS(cgiedit_rcs)
1635 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
1636 SHOW_RCS(cgisimple_h_rcs)
1637 SHOW_RCS(cgisimple_rcs)
1639 SHOW_RCS(cygwin_h_rcs)
1641 SHOW_RCS(deanimate_h_rcs)
1642 SHOW_RCS(deanimate_rcs)
1643 SHOW_RCS(encode_h_rcs)
1644 SHOW_RCS(encode_rcs)
1645 SHOW_RCS(errlog_h_rcs)
1646 SHOW_RCS(errlog_rcs)
1647 SHOW_RCS(filters_h_rcs)
1648 SHOW_RCS(filters_rcs)
1649 SHOW_RCS(gateway_h_rcs)
1650 SHOW_RCS(gateway_rcs)
1651 SHOW_RCS(jbsockets_h_rcs)
1652 SHOW_RCS(jbsockets_rcs)
1655 #ifdef FEATURE_KILL_POPUPS
1656 SHOW_RCS(killpopup_h_rcs)
1657 SHOW_RCS(killpopup_rcs)
1658 #endif /* def FEATURE_KILL_POPUPS */
1659 SHOW_RCS(list_h_rcs)
1661 SHOW_RCS(loadcfg_h_rcs)
1662 SHOW_RCS(loadcfg_rcs)
1663 SHOW_RCS(loaders_h_rcs)
1664 SHOW_RCS(loaders_rcs)
1665 SHOW_RCS(miscutil_h_rcs)
1666 SHOW_RCS(miscutil_rcs)
1667 SHOW_RCS(parsers_h_rcs)
1668 SHOW_RCS(parsers_rcs)
1670 SHOW_RCS(pcrs_h_rcs)
1671 SHOW_RCS(project_h_rcs)
1672 SHOW_RCS(ssplit_h_rcs)
1673 SHOW_RCS(ssplit_rcs)
1674 SHOW_RCS(urlmatch_h_rcs)
1675 SHOW_RCS(urlmatch_rcs)
1677 #ifndef _WIN_CONSOLE
1678 SHOW_RCS(w32log_h_rcs)
1679 SHOW_RCS(w32log_rcs)
1680 SHOW_RCS(w32res_h_rcs)
1681 SHOW_RCS(w32taskbar_h_rcs)
1682 SHOW_RCS(w32taskbar_rcs)
1683 #endif /* ndef _WIN_CONSOLE */
1684 SHOW_RCS(win32_h_rcs)
1686 #endif /* def _WIN32 */