X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=cgisimple.c;h=373cb978c326893e96c706c7339aa7c2316dd447;hp=c230054bf03ba0dd77b72a0526164548b1ad67c1;hb=bad55634165b116a64244e1ecd91bcdda5a2d2b2;hpb=9cab80b40992aa50dcbc2560129e89123a9e93fd diff --git a/cgisimple.c b/cgisimple.c index c230054b..373cb978 100644 --- a/cgisimple.c +++ b/cgisimple.c @@ -1,4 +1,4 @@ -const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.23 2002/03/26 22:29:54 swa Exp $"; +const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.68 2008/03/27 18:27:21 fabiankeil Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $ @@ -9,7 +9,7 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.23 2002/03/26 22:29:54 swa Ex * Functions declared include: * * - * Copyright : Written by and Copyright (C) 2001 the SourceForge + * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -36,6 +36,232 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.23 2002/03/26 22:29:54 swa Ex * * Revisions : * $Log: cgisimple.c,v $ + * Revision 1.68 2008/03/27 18:27:21 fabiankeil + * Remove kill-popups action. + * + * Revision 1.67 2008/03/27 17:00:05 fabiankeil + * Turn the favicon blobs into locals. + * + * Revision 1.66 2008/02/23 16:57:12 fabiankeil + * Rename url_actions() to get_url_actions() and let it + * use the standard parameter ordering. + * + * Revision 1.65 2008/02/23 16:33:43 fabiankeil + * Let forward_url() use the standard parameter ordering + * and mark its second parameter immutable. + * + * Revision 1.64 2008/02/03 13:56:07 fabiankeil + * Add SOCKS5 support for show-url-info CGI page. + * + * Revision 1.63 2008/02/01 06:04:31 fabiankeil + * If edit buttons on the show-url-info CGI page are hidden, explain why. + * + * Revision 1.62 2008/02/01 05:52:40 fabiankeil + * Hide edit buttons on the show-url-info CGI page if enable-edit-action + * is disabled. Patch by Lee with additional white space adjustments. + * + * Revision 1.61 2008/01/26 11:13:25 fabiankeil + * If enable-edit-actions is disabled, hide the edit buttons and explain why. + * + * Revision 1.60 2007/10/27 13:12:13 fabiankeil + * Finish 1.49 and check write access before + * showing edit buttons on show-url-info page. + * + * Revision 1.59 2007/10/19 16:42:36 fabiankeil + * Plug memory leak I introduced five months ago. + * Yay Valgrind and Privoxy-Regression-Test. + * + * Revision 1.58 2007/07/21 12:19:50 fabiankeil + * If show-url-info is called with an URL that Privoxy + * would reject as invalid, don't show unresolved forwarding + * variables, "final matches" or claim the site's secure. + * + * Revision 1.57 2007/06/01 16:53:05 fabiankeil + * Adjust cgi_show_url_info() to show what forward-override{} + * would do with the requested URL (instead of showing how the + * request for the CGI page would be forwarded if it wasn't a + * CGI request). + * + * Revision 1.56 2007/05/21 10:50:35 fabiankeil + * - Use strlcpy() instead of strcpy(). + * - Stop treating actions files special. Expect a complete file name + * (with or without path) like it's done for the rest of the files. + * Closes FR#588084. + * - Don't rerun sed() in cgi_show_request(). + * + * Revision 1.55 2007/04/13 13:36:46 fabiankeil + * Reference action files in CGI URLs by id instead + * of using the first part of the file name. + * Fixes BR 1694250 and BR 1590556. + * + * Revision 1.54 2007/04/09 18:11:35 fabiankeil + * Don't mistake VC++'s _snprintf() for a snprintf() replacement. + * + * Revision 1.53 2007/04/08 13:21:04 fabiankeil + * Reference action files in CGI URLs by id instead + * of using the first part of the file name. + * Fixes BR 1694250 and BR 1590556. + * + * Revision 1.52 2007/02/13 15:10:26 fabiankeil + * Apparently fopen()ing in "binary" mode doesn't require + * #ifdefs, it's already done without them in cgiedit.c. + * + * Revision 1.51 2007/02/10 16:55:22 fabiankeil + * - Show forwarding settings on the show-url-info page + * - Fix some HTML syntax errors. + * + * Revision 1.50 2007/01/23 15:51:17 fabiankeil + * Add favicon delivery functions. + * + * Revision 1.49 2007/01/20 16:29:38 fabiankeil + * Suppress edit buttons for action files if Privoxy has + * no write access. Suggested by Roland in PR 1564026. + * + * Revision 1.48 2007/01/20 15:31:31 fabiankeil + * Display warning if show-url-info CGI page + * is used while Privoxy is toggled off. + * + * Revision 1.47 2007/01/12 15:07:10 fabiankeil + * Use zalloc in cgi_send_user_manual. + * + * Revision 1.46 2007/01/02 12:49:46 fabiankeil + * Add FEATURE_ZLIB to the list of conditional + * defines at the show-status page. + * + * Revision 1.45 2006/12/28 18:16:41 fabiankeil + * Fixed gcc43 compiler warnings, zero out cgi_send_user_manual's + * body memory before using it, replaced sprintf calls with snprintf. + * + * Revision 1.44 2006/12/22 14:19:27 fabiankeil + * Removed checks whether or not AF_FILES have + * data structures associated with them in cgi_show_status. + * It doesn't matter as we're only interested in the file names. + * + * For the action files the checks were always true, + * but they prevented empty filter files from being + * listed. Fixes parts of BR 1619208. + * + * Revision 1.43 2006/12/17 17:57:56 fabiankeil + * - Added FEATURE_GRACEFUL_TERMINATION to the + * "conditional #defines" section + * - Escaped ampersands in generated HTML. + * - Renamed re-filter-filename to re-filter-filenames + * + * Revision 1.42 2006/11/21 15:43:12 fabiankeil + * Add special treatment for WIN32 to make sure + * cgi_send_user_manual opens the files in binary mode. + * Fixes BR 1600411 and unbreaks image delivery. + * + * Remove outdated comment. + * + * Revision 1.41 2006/10/09 19:18:28 roro + * Redirect http://p.p/user-manual (without trailing slash) to + * http://p.p/user-manual/ (with trailing slash), otherwise links will be broken. + * + * Revision 1.40 2006/09/09 13:05:33 fabiankeil + * Modified cgi_send_user_manual to serve binary + * content without destroying it first. Should also be + * faster now. Added ".jpg" check for Content-Type guessing. + * + * Revision 1.39 2006/09/08 09:49:23 fabiankeil + * Deliver documents in the user-manual directory + * with "Content-Type text/css" if their filename + * ends with ".css". + * + * Revision 1.38 2006/09/06 18:45:03 fabiankeil + * Incorporate modified version of Roland Rosenfeld's patch to + * optionally access the user-manual via Privoxy. Closes patch 679075. + * + * Formatting changed to Privoxy style, added call to + * cgi_error_no_template if the requested file doesn't + * exist and modified check whether or not Privoxy itself + * should serve the manual. Should work cross-platform now. + * + * Revision 1.37 2006/07/18 14:48:45 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.35.2.7 2006/01/29 23:10:56 david__schmidt + * Multiple filter file support + * + * Revision 1.35.2.6 2005/07/04 03:13:43 david__schmidt + * Undo some damaging memory leak patches + * + * Revision 1.35.2.5 2005/05/07 21:50:55 david__schmidt + * A few memory leaks plugged (mostly on error paths) + * + * Revision 1.35.2.4 2005/04/04 02:21:24 david__schmidt + * Another instance of: + * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS + * Thanks to Magnus Holmgren for the patch + * + * Revision 1.35.2.3 2003/12/17 16:34:15 oes + * - Prevent line wrap beween "View/Edit" link buttons on status page + * - Some (mostly irrelevant) fixes for Out-of-mem-case handling + * + * Revision 1.35.2.2 2003/04/03 13:48:28 oes + * Don't show "Edit" buttons #ifndef FEATURE_CGI_EDIT_ACTIONS + * + * Revision 1.35.2.1 2002/07/04 15:02:38 oes + * Added ability to send redirects to send-banner CGI, so that it can completely mimic the image blocking action if called with type=auto + * + * Revision 1.35.2.1 2002/07/01 17:32:04 morcego + * Applying patch from Andreas as provided by Hal on the list. + * Message-ID: <20020701121218.V1606@feenix.burgiss.net> + * + * Revision 1.35 2002/05/12 21:44:44 jongfoster + * Adding amiga.[ch] revision information, if on an amiga. + * + * Revision 1.34 2002/04/30 12:06:12 oes + * Deleted unused code from default_cgi + * + * Revision 1.33 2002/04/30 11:14:52 oes + * Made csp the first parameter in *action_to_html + * + * Revision 1.32 2002/04/26 18:29:13 jongfoster + * Fixing this Visual C++ warning: + * cgisimple.c(775) : warning C4018: '<' : signed/unsigned mismatch + * + * Revision 1.31 2002/04/26 12:54:36 oes + * - Kill obsolete REDIRECT_URL code + * - Error handling fixes + * - Style sheet related HTML snipplet changes + * - cgi_show_url_info: + * - Matches now in table, actions on single lines, + * linked to help + * - standard.action suppressed + * - Buttons to View and Edit AFs + * + * Revision 1.30 2002/04/24 02:18:08 oes + * - show-status is now the starting point for editing + * the actions files, generate list of all AFs with buttons + * for viewing and editing, new look for file list (Jon: + * buttons now aligned ;-P ), view mode now supports multiple + * AFs, name changes, no view links for unspecified files, + * no edit link for standard.action. + * + * - Jon's multiple AF patch: cgi_show_url_info now uses all + * AFs and marks the output accordingly + * + * Revision 1.29 2002/04/10 13:38:35 oes + * load_template signature changed + * + * Revision 1.28 2002/04/07 15:42:12 jongfoster + * Fixing send-banner?type=auto when the image-blocker is + * a redirect to send-banner + * + * Revision 1.27 2002/04/05 15:50:48 oes + * added send-stylesheet CGI + * + * Revision 1.26 2002/04/04 00:36:36 gliptak + * always use pcre for matching + * + * Revision 1.25 2002/04/03 22:28:03 gliptak + * Removed references to gnu_regex + * + * Revision 1.24 2002/04/02 16:12:47 oes + * Fix: moving misplaced lines into #ifdef FEATURE_FORCE + * * Revision 1.23 2002/03/26 22:29:54 swa * we have a new homepage! * @@ -140,9 +366,9 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.23 2002/03/26 22:29:54 swa Ex #include #include -#ifdef _WIN32 -#define snprintf _snprintf -#endif /* def _WIN32 */ +#ifdef HAVE_ACCESS +#include +#endif /* def HAVE_ACCESS */ #include "project.h" #include "cgi.h" @@ -156,6 +382,7 @@ const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.23 2002/03/26 22:29:54 swa Ex #include "loadcfg.h" #include "parsers.h" #include "urlmatch.h" +#include "errlog.h" const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION; @@ -163,13 +390,13 @@ const char cgisimple_h_rcs[] = CGISIMPLE_H_VERSION; static char *show_rcs(void); static jb_err show_defines(struct map *exports); - /********************************************************************* * * Function : cgi_default * - * Description : CGI function that is called if no action was given. - * Lists menu of available unhidden CGIs. + * Description : CGI function that is called for the CGI_SITE_1_HOST + * and CGI_SITE_2_HOST/CGI_SITE_2_PATH base URLs. + * Boring - only exports the default exports. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) @@ -180,57 +407,26 @@ static jb_err show_defines(struct map *exports); * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory - * (Problems other than out-of-memory should be - * handled by this routine - it should set the - * rsp appropriately and return "success") * *********************************************************************/ jb_err cgi_default(struct client_state *csp, struct http_response *rsp, const struct map *parameters) { - char *tmp; struct map *exports; assert(csp); assert(rsp); - assert(parameters); if (NULL == (exports = default_exports(csp, ""))) { return JB_ERR_MEMORY; } - /* If there were other parameters, export a dump as "cgi-parameters" */ - if (parameters->first) - { - tmp = strdup("

What made you think this cgi takes parameters?\n" - "Anyway, here they are, in case you're interested:

\n"); - string_join(&tmp, dump_map(parameters)); - if (tmp == NULL) - { - free_map(exports); - return JB_ERR_MEMORY; - } - if (map(exports, "cgi-parameters", 1, tmp, 0)) - { - return JB_ERR_MEMORY; - } - } - else - { - if (map(exports, "cgi-parameters", 1, "", 1)) - { - return JB_ERR_MEMORY; - } - } - return template_fill_for_cgi(csp, "default", exports, rsp); } - - /********************************************************************* * * Function : cgi_error_404 @@ -370,8 +566,8 @@ jb_err cgi_show_request(struct client_state *csp, return JB_ERR_MEMORY; } - if (map(exports, "processed-request", 1, html_encode_and_free_original( - sed(client_patterns, add_client_headers, csp)), 0)) + if (map(exports, "processed-request", 1, + html_encode_and_free_original(list_to_text(csp->headers)), 0)) { free_map(exports); return JB_ERR_MEMORY; @@ -396,7 +592,8 @@ jb_err cgi_show_request(struct client_state *csp, * type : Selects the type of banner between "trans", "logo", * and "auto". Defaults to "logo" if absent or invalid. * "auto" means to select as if we were image-blocking. - * (Only the first character really counts). + * (Only the first character really counts; b and t are + * equivalent). * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory error. @@ -408,40 +605,134 @@ jb_err cgi_send_banner(struct client_state *csp, { char imagetype = lookup(parameters, "type")[0]; - if (imagetype == 'a') /* auto */ + /* + * If type is auto, then determine the right thing + * to do from the set-image-blocker action + */ + if (imagetype == 'a') { - /* Default to pattern */ + /* + * Default to pattern + */ imagetype = 'p'; + #ifdef FEATURE_IMAGE_BLOCKING if ((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0) { - /* determine HOW images should be blocked */ - const char * p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER]; + static const char prefix1[] = CGI_PREFIX "send-banner?type="; + static const char prefix2[] = "http://" CGI_SITE_1_HOST "/send-banner?type="; + const char *p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER]; - /* and handle accordingly: */ - if ((p != NULL) && (0 == strcmpic(p, "blank"))) + if (p == NULL) + { + /* Use default - nothing to do here. */ + } + else if (0 == strcmpic(p, "blank")) { imagetype = 'b'; } - else if ((p != NULL) && (0 == strcmpic(p, "pattern"))) + else if (0 == strcmpic(p, "pattern")) { imagetype = 'p'; } + + /* + * If the action is to call this CGI, determine + * the argument: + */ + else if (0 == strncmpic(p, prefix1, sizeof(prefix1) - 1)) + { + imagetype = p[sizeof(prefix1) - 1]; + } + else if (0 == strncmpic(p, prefix2, sizeof(prefix2) - 1)) + { + imagetype = p[sizeof(prefix2) - 1]; + } + + /* + * Everything else must (should) be a URL to + * redirect to. + */ + else + { + imagetype = 'r'; + } } #endif /* def FEATURE_IMAGE_BLOCKING */ } - if ((imagetype == 'b') || (imagetype == 't')) /* blank / transparent */ + /* + * Now imagetype is either the non-auto type we were called with, + * or it was auto and has since been determined. In any case, we + * can proceed to actually answering the request by sending a redirect + * or an image as appropriate: + */ + if (imagetype == 'r') { - rsp->body = bindup(image_blank_data, image_blank_length); - rsp->content_length = image_blank_length; - + rsp->status = strdup("302 Local Redirect from Privoxy"); + if (rsp->status == NULL) + { + return JB_ERR_MEMORY; + } + if (enlist_unique_header(rsp->headers, "Location", + csp->action->string[ACTION_STRING_IMAGE_BLOCKER])) + { + return JB_ERR_MEMORY; + } } - else /* pattern */ + else { - rsp->body = bindup(image_pattern_data, image_pattern_length); - rsp->content_length = image_pattern_length; - } + if ((imagetype == 'b') || (imagetype == 't')) + { + rsp->body = bindup(image_blank_data, image_blank_length); + rsp->content_length = image_blank_length; + } + else + { + rsp->body = bindup(image_pattern_data, image_pattern_length); + rsp->content_length = image_pattern_length; + } + + if (rsp->body == NULL) + { + return JB_ERR_MEMORY; + } + if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE)) + { + return JB_ERR_MEMORY; + } + + rsp->is_static = 1; + } + + return JB_ERR_OK; + +} + + +/********************************************************************* + * + * Function : cgi_transparent_image + * + * Description : CGI function that sends a 1x1 transparent image. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters + * + * CGI Parameters : None + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_transparent_image(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + rsp->body = bindup(image_blank_data, image_blank_length); + rsp->content_length = image_blank_length; if (rsp->body == NULL) { @@ -462,9 +753,9 @@ jb_err cgi_send_banner(struct client_state *csp, /********************************************************************* * - * Function : cgi_transparent_image + * Function : cgi_send_default_favicon * - * Description : CGI function that sends a 1x1 transparent image. + * Description : CGI function that sends the standard favicon. * * Parameters : * 1 : csp = Current client state (buffers, headers, etc...) @@ -477,19 +768,36 @@ jb_err cgi_send_banner(struct client_state *csp, * JB_ERR_MEMORY on out-of-memory error. * *********************************************************************/ -jb_err cgi_transparent_image(struct client_state *csp, - struct http_response *rsp, - const struct map *parameters) +jb_err cgi_send_default_favicon(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) { - rsp->body = bindup(image_blank_data, image_blank_length); - rsp->content_length = image_blank_length; + static const char default_favicon_data[] = + "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260" + "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000" + "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000" + "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000" + "\000\000\377\377\377\000\377\000\052\000\017\360\000\000\077" + "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000" + "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000" + "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036" + "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360" + "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000" + "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000" + "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000" + "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360" + "\017\000\000"; + static const size_t favicon_length = sizeof(default_favicon_data) - 1; + + rsp->body = bindup(default_favicon_data, favicon_length); + rsp->content_length = favicon_length; if (rsp->body == NULL) { return JB_ERR_MEMORY; } - if (enlist(rsp->headers, "Content-Type: " BUILTIN_IMAGE_MIMETYPE)) + if (enlist(rsp->headers, "Content-Type: image/x-icon")) { return JB_ERR_MEMORY; } @@ -501,6 +809,230 @@ jb_err cgi_transparent_image(struct client_state *csp, } +/********************************************************************* + * + * Function : cgi_send_error_favicon + * + * Description : CGI function that sends the favicon for error pages. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters + * + * CGI Parameters : None + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_send_error_favicon(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + static const char error_favicon_data[] = + "\000\000\001\000\001\000\020\020\002\000\000\000\000\000\260" + "\000\000\000\026\000\000\000\050\000\000\000\020\000\000\000" + "\040\000\000\000\001\000\001\000\000\000\000\000\100\000\000" + "\000\000\000\000\000\000\000\000\000\002\000\000\000\000\000" + "\000\000\377\377\377\000\000\000\377\000\017\360\000\000\077" + "\374\000\000\161\376\000\000\161\376\000\000\361\377\000\000" + "\361\377\000\000\360\017\000\000\360\007\000\000\361\307\000" + "\000\361\307\000\000\361\307\000\000\360\007\000\000\160\036" + "\000\000\177\376\000\000\077\374\000\000\017\360\000\000\360" + "\017\000\000\300\003\000\000\200\001\000\000\200\001\000\000" + "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000" + "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000" + "\000\000\200\001\000\000\200\001\000\000\300\003\000\000\360" + "\017\000\000"; + static const size_t favicon_length = sizeof(error_favicon_data) - 1; + + rsp->body = bindup(error_favicon_data, favicon_length); + rsp->content_length = favicon_length; + + if (rsp->body == NULL) + { + return JB_ERR_MEMORY; + } + + if (enlist(rsp->headers, "Content-Type: image/x-icon")) + { + return JB_ERR_MEMORY; + } + + rsp->is_static = 1; + + return JB_ERR_OK; + +} + + +/********************************************************************* + * + * Function : cgi_send_stylesheet + * + * Description : CGI function that sends a css stylesheet found + * in the cgi-style.css template + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters + * + * CGI Parameters : None + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_send_stylesheet(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + jb_err err; + + assert(csp); + assert(rsp); + + err = template_load(csp, &rsp->body, "cgi-style.css", 0); + + if (err == JB_ERR_FILE) + { + /* + * No way to tell user; send empty stylesheet + */ + log_error(LOG_LEVEL_ERROR, "Could not find cgi-style.css template"); + } + else if (err) + { + return err; /* JB_ERR_MEMORY */ + } + + if (enlist(rsp->headers, "Content-Type: text/css")) + { + return JB_ERR_MEMORY; + } + + return JB_ERR_OK; + +} +/********************************************************************* + * + * Function : cgi_send_user_manual + * + * Description : CGI function that sends a file in the user + * manual directory. + * + * Parameters : + * 1 : csp = Current client state (buffers, headers, etc...) + * 2 : rsp = http_response data structure for output + * 3 : parameters = map of cgi parameters + * + * CGI Parameters : file=name.html, the name of the HTML file + * (relative to user-manual from config) + * + * Returns : JB_ERR_OK on success + * JB_ERR_MEMORY on out-of-memory error. + * + *********************************************************************/ +jb_err cgi_send_user_manual(struct client_state *csp, + struct http_response *rsp, + const struct map *parameters) +{ + const char * filename; + char *full_path; + FILE *fp; + jb_err err = JB_ERR_OK; + size_t length; + + assert(csp); + assert(rsp); + assert(parameters); + + if (!parameters->first) + { + /* requested http://p.p/user-manual (without trailing slash) */ + return cgi_redirect(rsp, CGI_PREFIX "user-manual/"); + } + + get_string_param(parameters, "file", &filename); + /* Check paramter for hack attempts */ + if (filename && strchr(filename, '/')) + { + return JB_ERR_CGI_PARAMS; + } + if (filename && strstr(filename, "..")) + { + return JB_ERR_CGI_PARAMS; + } + + full_path = make_path(csp->config->usermanual, filename ? filename : "index.html"); + if (full_path == NULL) + { + return JB_ERR_MEMORY; + } + + /* Open user-manual file */ + if (NULL == (fp = fopen(full_path, "rb"))) + { + log_error(LOG_LEVEL_ERROR, "Cannot open user-manual file %s: %E", full_path); + err = cgi_error_no_template(csp, rsp, full_path); + free(full_path); + return err; + } + + /* Get file length */ + fseek(fp, 0, SEEK_END); + length = (size_t)ftell(fp); + fseek(fp, 0, SEEK_SET); + + /* Allocate memory and load the file directly into the body */ + rsp->body = (char *)zalloc(length+1); + if (!rsp->body) + { + fclose(fp); + free(full_path); + return JB_ERR_MEMORY; + } + if (!fread(rsp->body, length, 1, fp)) + { + /* + * May happen if the file size changes between fseek() and fread(). + * If it does, we just log it and serve what we got. + */ + log_error(LOG_LEVEL_ERROR, "Couldn't completely read user-manual file %s.", full_path); + } + fclose(fp); + free(full_path); + + rsp->content_length = length; + + /* Guess correct Content-Type based on the filename's ending */ + if (filename) + { + length = strlen(filename); + } + else + { + length = 0; + } + if((length>=4) && !strcmp(&filename[length-4], ".css")) + { + err = enlist(rsp->headers, "Content-Type: text/css"); + } + else if((length>=4) && !strcmp(&filename[length-4], ".jpg")) + { + err = enlist(rsp->headers, "Content-Type: image/jpeg"); + } + else + { + err = enlist(rsp->headers, "Content-Type: text/html"); + } + + return err; +} + + /********************************************************************* * * Function : cgi_show_version @@ -548,7 +1080,7 @@ jb_err cgi_show_version(struct client_state *csp, * * Function : cgi_show_status * - * Description : CGI function that returns a a web page describing the + * Description : CGI function that returns a web page describing the * current status of Privoxy. * * Parameters : @@ -573,7 +1105,8 @@ jb_err cgi_show_status(struct client_state *csp, const struct map *parameters) { char *s = NULL; - int i; + unsigned i; + int j; FILE * fp; char buf[BUFFER_SIZE]; @@ -584,7 +1117,7 @@ jb_err cgi_show_status(struct client_state *csp, int local_urls_read; int local_urls_rejected; #endif /* ndef FEATURE_STATISTICS */ - jb_err err; + jb_err err = JB_ERR_OK; struct map *exports; @@ -599,19 +1132,19 @@ jb_err cgi_show_status(struct client_state *csp, switch (*(lookup(parameters, "file"))) { - case 'p': - if (csp->actions_list) + case 'a': + if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->actions_list[i]) { - filename = csp->actions_list->filename; - file_description = "Actions List"; + filename = csp->actions_list[i]->filename; + file_description = "Actions File"; } break; - case 'r': - if (csp->rlist) + case 'f': + if (!get_number_param(csp, parameters, "index", &i) && i < MAX_AF_FILES && csp->rlist[i]) { - filename = csp->rlist->filename; - file_description = "Regex Filter List"; + filename = csp->rlist[i]->filename; + file_description = "Filter File"; } break; @@ -620,7 +1153,7 @@ jb_err cgi_show_status(struct client_state *csp, if (csp->tlist) { filename = csp->tlist->filename; - file_description = "Trust List"; + file_description = "Trust File"; } break; #endif /* def FEATURE_TRUST */ @@ -649,7 +1182,6 @@ jb_err cgi_show_status(struct client_state *csp, while ((s != NULL) && fgets(buf, sizeof(buf), fp)) { string_join (&s, html_encode(buf)); - string_append(&s, "
"); } fclose(fp); @@ -663,27 +1195,23 @@ jb_err cgi_show_status(struct client_state *csp, return template_fill_for_cgi(csp, "show-status-file", exports, rsp); } - if (map(exports, "redirect-url", 1, html_encode(REDIRECT_URL), 0)) - { - free_map(exports); - return JB_ERR_MEMORY; - } - s = strdup(""); - for (i = 0; (s != NULL) && (i < Argc); i++) + for (j = 0; (s != NULL) && (j < Argc); j++) { - string_join (&s, html_encode(Argv[i])); - string_append(&s, " "); + if (!err) err = string_join (&s, html_encode(Argv[j])); + if (!err) err = string_append(&s, " "); } - if (map(exports, "invocation", 1, s, 0)) + if (!err) err = map(exports, "invocation", 1, s, 0); + + if (!err) err = map(exports, "options", 1, csp->config->proxy_args, 1); + if (!err) err = show_defines(exports); + + if (err) { free_map(exports); return JB_ERR_MEMORY; } - err = map(exports, "options", 1, csp->config->proxy_args, 1); - if (!err) err = show_defines(exports); - #ifdef FEATURE_STATISTICS local_urls_read = urls_read; local_urls_rejected = urls_rejected; @@ -709,36 +1237,95 @@ jb_err cgi_show_status(struct client_state *csp, perc_rej = (float)local_urls_rejected * 100.0F / (float)local_urls_read; - sprintf(buf, "%d", local_urls_read); + snprintf(buf, sizeof(buf), "%d", local_urls_read); if (!err) err = map(exports, "requests-received", 1, buf, 1); - sprintf(buf, "%d", local_urls_rejected); + snprintf(buf, sizeof(buf), "%d", local_urls_rejected); if (!err) err = map(exports, "requests-blocked", 1, buf, 1); - sprintf(buf, "%6.2f", perc_rej); + snprintf(buf, sizeof(buf), "%6.2f", perc_rej); if (!err) err = map(exports, "percent-blocked", 1, buf, 1); } #else /* ndef FEATURE_STATISTICS */ err = err || map_block_killer(exports, "statistics"); #endif /* ndef FEATURE_STATISTICS */ + + /* + * List all action files in use, together with view and edit links, + * except for standard.action, which should only be viewable. (Not + * enforced in the editor itself) + * FIXME: Shouldn't include hardwired HTML here, use line template instead! + */ + s = strdup(""); + for (i = 0; i < MAX_AF_FILES; i++) + { + if (csp->actions_list[i] != NULL) + { + if (!err) err = string_append(&s, ""); + if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename)); + snprintf(buf, sizeof(buf), + "View", i); + if (!err) err = string_append(&s, buf); - if (csp->actions_list) +#ifdef FEATURE_CGI_EDIT_ACTIONS + if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS) + && (NULL == strstr(csp->actions_list[i]->filename, "standard.action")) + && (NULL != csp->config->actions_file_short[i])) + { +#ifdef HAVE_ACCESS + if (access(csp->config->actions_file[i], W_OK) == 0) + { +#endif /* def HAVE_ACCESS */ + snprintf(buf, sizeof(buf), "  Edit", i); + if (!err) err = string_append(&s, buf); +#ifdef HAVE_ACCESS + } + else + { + if (!err) err = string_append(&s, "  No write access."); + } +#endif /* def HAVE_ACCESS */ + } +#endif + + if (!err) err = string_append(&s, "\n"); + } + } + if (*s != '\0') { - if (!err) err = map(exports, "actions-filename", 1, html_encode(csp->actions_list->filename), 0); + if (!err) err = map(exports, "actions-filenames", 1, s, 0); } else { - if (!err) err = map(exports, "actions-filename", 1, "None specified", 1); + if (!err) err = map(exports, "actions-filenames", 1, "None specified", 1); } - if (csp->rlist) + /* + * List all re_filterfiles in use, together with view options. + * FIXME: Shouldn't include hardwired HTML here, use line template instead! + */ + s = strdup(""); + for (i = 0; i < MAX_AF_FILES; i++) + { + if (csp->rlist[i] != NULL) + { + if (!err) err = string_append(&s, ""); + if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename)); + snprintf(buf, 100, + "View", i); + if (!err) err = string_append(&s, buf); + if (!err) err = string_append(&s, "\n"); + } + } + if (*s != '\0') { - if (!err) err = map(exports, "re-filter-filename", 1, html_encode(csp->rlist->filename), 0); + if (!err) err = map(exports, "re-filter-filenames", 1, s, 0); } else { - if (!err) err = map(exports, "re-filter-filename", 1, "None specified", 1); + if (!err) err = map(exports, "re-filter-filenames", 1, "None specified", 1); + if (!err) err = map_block_killer(exports, "have-filterfile"); } #ifdef FEATURE_TRUST @@ -749,11 +1336,19 @@ jb_err cgi_show_status(struct client_state *csp, else { if (!err) err = map(exports, "trust-filename", 1, "None specified", 1); + if (!err) err = map_block_killer(exports, "have-trustfile"); } #else if (!err) err = map_block_killer(exports, "trust-support"); #endif /* ndef FEATURE_TRUST */ +#ifdef FEATURE_CGI_EDIT_ACTIONS + if (!err && (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) + { + err = map_block_killer(exports, "cgi-editor-is-disabled"); + } +#endif /* ndef CGI_EDIT_ACTIONS */ + if (err) { free_map(exports); @@ -793,6 +1388,7 @@ jb_err cgi_show_url_info(struct client_state *csp, { char *url_param; struct map *exports; + char buf[150]; assert(csp); assert(rsp); @@ -851,19 +1447,33 @@ jb_err cgi_show_url_info(struct client_state *csp, /* * Unknown prefix - assume http:// */ - char * url_param_prefixed = malloc(7 + 1 + strlen(url_param)); + const size_t url_param_prefixed_size = 7 + 1 + strlen(url_param); + char * url_param_prefixed = malloc(url_param_prefixed_size); if (NULL == url_param_prefixed) { free(url_param); free_map(exports); return JB_ERR_MEMORY; } - strcpy(url_param_prefixed, "http://"); - strcpy(url_param_prefixed + 7, url_param); + strlcpy(url_param_prefixed, "http://", url_param_prefixed_size); + strlcat(url_param_prefixed, url_param, url_param_prefixed_size); free(url_param); url_param = url_param_prefixed; } + /* + * Hide "toggle off" warning if Privoxy is toggled on. + */ + if ( +#ifdef FEATURE_TOGGLE + (global_toggle_state == 1) && +#endif /* def FEATURE_TOGGLE */ + map_block_killer(exports, "privoxy-is-toggled-off") + ) + { + free_map(exports); + return JB_ERR_MEMORY; + } if (url_param[0] == '\0') { @@ -887,6 +1497,7 @@ jb_err cgi_show_url_info(struct client_state *csp, struct url_actions *b; struct http_request url_to_query[1]; struct current_action_spec action[1]; + int i; if (map(exports, "url", 1, html_encode(url_param), 0)) { @@ -897,8 +1508,7 @@ jb_err cgi_show_url_info(struct client_state *csp, init_current_action(action); - if (map(exports, "default", 1, html_encode_and_free_original( - current_action_to_text(action)), 0)) + if (map(exports, "default", 1, current_action_to_html(csp, action), 0)) { free_current_action(action); free(url_param); @@ -906,29 +1516,13 @@ jb_err cgi_show_url_info(struct client_state *csp, return JB_ERR_MEMORY; } - if (((fl = csp->actions_list) == NULL) || ((b = fl->f) == NULL)) - { - err = map(exports, "matches", 1, "none" , 1); - if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1); - - free_current_action(action); - free(url_param); - - if (err) - { - free_map(exports); - return JB_ERR_MEMORY; - } - - return template_fill_for_cgi(csp, "show-url-info", exports, rsp); - } - err = parse_http_url(url_param, url_to_query, csp); free(url_param); if (err == JB_ERR_MEMORY) { + free_http_request(url_to_query); free_current_action(action); free_map(exports); return JB_ERR_MEMORY; @@ -939,8 +1533,10 @@ jb_err cgi_show_url_info(struct client_state *csp, err = map(exports, "matches", 1, "[Invalid URL specified!]" , 1); if (!err) err = map(exports, "final", 1, lookup(exports, "default"), 1); + if (!err) err = map_block_killer(exports, "valid-url"); free_current_action(action); + free_http_request(url_to_query); if (err) { @@ -952,7 +1548,7 @@ jb_err cgi_show_url_info(struct client_state *csp, } /* - * We have a warning about SSL paths. Hide it for insecure sites. + * We have a warning about SSL paths. Hide it for unencrypted sites. */ if (!url_to_query->ssl) { @@ -960,57 +1556,193 @@ jb_err cgi_show_url_info(struct client_state *csp, { free_current_action(action); free_map(exports); + free_http_request(url_to_query); return JB_ERR_MEMORY; } } - matches = strdup(""); + matches = strdup(""); - for (b = b->next; (b != NULL) && (matches != NULL); b = b->next) + for (i = 0; i < MAX_AF_FILES; i++) { - if (url_match(b->url, url_to_query)) + if (NULL == csp->config->actions_file_short[i] + || !strcmp(csp->config->actions_file_short[i], "standard.action")) continue; + + b = NULL; + hits = 1; + if ((fl = csp->actions_list[i]) != NULL) + { + if ((b = fl->f) != NULL) + { + /* FIXME: Hardcoded HTML! */ + string_append(&matches, "\n"); + + hits = 0; + b = b->next; + } + } + + for (; (b != NULL) && (matches != NULL); b = b->next) { - string_append(&matches, "{"); - string_join (&matches, html_encode_and_free_original( - actions_to_text(b->action))); - string_append(&matches, " }
\n"); - string_join (&matches, html_encode(b->url->spec)); - string_append(&matches, "
\n
\n"); - - if (merge_current_action(action, b->action)) + if (url_match(b->url, url_to_query)) { - freez(matches); - free_http_request(url_to_query); - free_current_action(action); - free_map(exports); - return JB_ERR_MEMORY; + string_append(&matches, "\n"); + + if (merge_current_action(action, b->action)) + { + freez(matches); + free_http_request(url_to_query); + free_current_action(action); + free_map(exports); + return JB_ERR_MEMORY; + } + hits++; + } + } + + if (!hits) + { + string_append(&matches, "\n"); + } + } + string_append(&matches, "
In file: "); + string_join (&matches, html_encode(csp->config->actions_file_short[i])); + snprintf(buf, sizeof(buf), " ", i); + string_append(&matches, buf); + string_append(&matches, "View"); +#ifdef FEATURE_CGI_EDIT_ACTIONS + if (csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS) + { +#ifdef HAVE_ACCESS + if (access(csp->config->actions_file[i], W_OK) == 0) + { +#endif /* def HAVE_ACCESS */ + snprintf(buf, sizeof(buf), + " ", i); + string_append(&matches, buf); + string_append(&matches, "Edit"); +#ifdef HAVE_ACCESS + } + else + { + string_append(&matches, " No write access."); + } +#endif /* def HAVE_ACCESS */ + } +#endif /* FEATURE_CGI_EDIT_ACTIONS */ + + string_append(&matches, "
{"); + string_join (&matches, actions_to_html(csp, b->action)); + string_append(&matches, " }
\n"); + string_join (&matches, html_encode(b->url->spec)); + string_append(&matches, "
(no matches in this file)
\n"); + + /* + * XXX: Kludge to make sure the "Forward settings" section + * shows what forward-override{} would do with the requested URL. + * No one really cares how the CGI request would be forwarded + * if it wasn't intercepted as CGI request in the first place. + * + * From here on the action bitmask will no longer reflect + * the real url (http://config.privoxy.org/show-url-info?url=.*), + * but luckily it's no longer required later on anyway. + */ + free_current_action(csp->action); + get_url_actions(csp, url_to_query); + + /* + * Fill in forwarding settings. + * + * The possibilities are: + * - no forwarding + * - http forwarding only + * - socks4(a) forwarding only + * - socks4(a) and http forwarding. + * + * XXX: Parts of this code could be reused for the + * "forwarding-failed" template which currently doesn't + * display the proxy port and an eventual second forwarder. + */ + { + const struct forward_spec *fwd = forward_url(csp, url_to_query); + + if ((fwd->gateway_host == NULL) && (fwd->forward_host == NULL)) + { + if (!err) err = map_block_killer(exports, "socks-forwarder"); + if (!err) err = map_block_killer(exports, "http-forwarder"); + } + else + { + char port[10]; /* We save proxy ports as int but need a string here */ + + if (!err) err = map_block_killer(exports, "no-forwarder"); + + if (fwd->gateway_host != NULL) + { + char *socks_type = NULL; + + switch (fwd->type) + { + case SOCKS_4: + socks_type = "socks4"; + break; + case SOCKS_4A: + socks_type = "socks4a"; + break; + case SOCKS_5: + socks_type = "socks5"; + break; + default: + log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type); + } + + if (!err) err = map(exports, "socks-type", 1, socks_type, 1); + if (!err) err = map(exports, "gateway-host", 1, fwd->gateway_host, 1); + snprintf(port, sizeof(port), "%d", fwd->gateway_port); + if (!err) err = map(exports, "gateway-port", 1, port, 1); + } + else + { + if (!err) err = map_block_killer(exports, "socks-forwarder"); + } + + if (fwd->forward_host != NULL) + { + if (!err) err = map(exports, "forward-host", 1, fwd->forward_host, 1); + snprintf(port, sizeof(port), "%d", fwd->forward_port); + if (!err) err = map(exports, "forward-port", 1, port, 1); + } + else + { + if (!err) err = map_block_killer(exports, "http-forwarder"); } - hits++; } } free_http_request(url_to_query); - if (matches == NULL) + if (err || matches == NULL) { free_current_action(action); free_map(exports); return JB_ERR_MEMORY; } - if (!hits) +#ifdef FEATURE_CGI_EDIT_ACTIONS + if ((csp->config->feature_flags & RUNTIME_FEATURE_CGI_EDIT_ACTIONS)) { - free(matches); - matches = strdup("none"); + err = map_block_killer(exports, "cgi-editor-is-disabled"); } - if (map(exports, "matches", 1, matches , 0)) +#endif /* FEATURE_CGI_EDIT_ACTIONS */ + + if (err || map(exports, "matches", 1, matches , 0)) { free_current_action(action); free_map(exports); return JB_ERR_MEMORY; } - s = html_encode_and_free_original(current_action_to_text(action)); + s = current_action_to_html(csp, action); free_current_action(action); @@ -1066,7 +1798,7 @@ jb_err cgi_robots_txt(struct client_state *csp, rsp->is_static = 1; - get_http_time(7 * 24 * 60 * 60, buf); /* 7 days into future */ + get_http_time(7 * 24 * 60 * 60, buf, sizeof(buf)); /* 7 days into future */ if (!err) err = enlist_unique_header(rsp->headers, "Expires", buf); return (err ? JB_ERR_MEMORY : JB_ERR_OK); @@ -1123,6 +1855,12 @@ static jb_err show_defines(struct map *exports) if (!err) err = map(exports, "FORCE_PREFIX", 1, "(none - disabled)", 1); #endif /* ndef FEATURE_FORCE_LOAD */ +#ifdef FEATURE_GRACEFUL_TERMINATION + if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 1); +#else /* ifndef FEATURE_GRACEFUL_TERMINATION */ + if (!err) err = map_conditional(exports, "FEATURE_GRACEFUL_TERMINATION", 0); +#endif /* ndef FEATURE_GRACEFUL_TERMINATION */ + #ifdef FEATURE_IMAGE_BLOCKING if (!err) err = map_conditional(exports, "FEATURE_IMAGE_BLOCKING", 1); #else /* ifndef FEATURE_IMAGE_BLOCKING */ @@ -1135,12 +1873,6 @@ static jb_err show_defines(struct map *exports) if (!err) err = map_conditional(exports, "FEATURE_IMAGE_DETECT_MSIE", 0); #endif /* ndef FEATURE_IMAGE_DETECT_MSIE */ -#ifdef FEATURE_KILL_POPUPS - if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 1); -#else /* ifndef FEATURE_KILL_POPUPS */ - if (!err) err = map_conditional(exports, "FEATURE_KILL_POPUPS", 0); -#endif /* ndef FEATURE_KILL_POPUPS */ - #ifdef FEATURE_NO_GIFS if (!err) err = map_conditional(exports, "FEATURE_NO_GIFS", 1); #else /* ifndef FEATURE_NO_GIFS */ @@ -1171,17 +1903,11 @@ static jb_err show_defines(struct map *exports) if (!err) err = map_conditional(exports, "FEATURE_TRUST", 0); #endif /* ndef FEATURE_TRUST */ -#ifdef REGEX_GNU - if (!err) err = map_conditional(exports, "REGEX_GNU", 1); -#else /* ifndef REGEX_GNU */ - if (!err) err = map_conditional(exports, "REGEX_GNU", 0); -#endif /* def REGEX_GNU */ - -#ifdef REGEX_PCRE - if (!err) err = map_conditional(exports, "REGEX_PCRE", 1); -#else /* ifndef REGEX_PCRE */ - if (!err) err = map_conditional(exports, "REGEX_PCRE", 0); -#endif /* def REGEX_PCRE */ +#ifdef FEATURE_ZLIB + if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 1); +#else /* ifndef FEATURE_ZLIB */ + if (!err) err = map_conditional(exports, "FEATURE_ZLIB", 0); +#endif /* ndef FEATURE_ZLIB */ #ifdef STATIC_PCRE if (!err) err = map_conditional(exports, "STATIC_PCRE", 1); @@ -1223,13 +1949,17 @@ static char *show_rcs(void) #define SHOW_RCS(__x) \ { \ extern const char __x[]; \ - sprintf(buf, "%s\n", __x); \ + snprintf(buf, sizeof(buf), " %s\n", __x); \ string_append(&result, buf); \ } /* In alphabetical order */ SHOW_RCS(actions_h_rcs) SHOW_RCS(actions_rcs) +#ifdef AMIGA + SHOW_RCS(amiga_h_rcs) + SHOW_RCS(amiga_rcs) +#endif /* def AMIGA */ SHOW_RCS(cgi_h_rcs) SHOW_RCS(cgi_rcs) #ifdef FEATURE_CGI_EDIT_ACTIONS @@ -1251,18 +1981,10 @@ static char *show_rcs(void) SHOW_RCS(filters_rcs) SHOW_RCS(gateway_h_rcs) SHOW_RCS(gateway_rcs) -#ifdef GNU_REGEX - SHOW_RCS(gnu_regex_h_rcs) - SHOW_RCS(gnu_regex_rcs) -#endif /* def GNU_REGEX */ SHOW_RCS(jbsockets_h_rcs) SHOW_RCS(jbsockets_rcs) SHOW_RCS(jcc_h_rcs) SHOW_RCS(jcc_rcs) -#ifdef FEATURE_KILL_POPUPS - SHOW_RCS(killpopup_h_rcs) - SHOW_RCS(killpopup_rcs) -#endif /* def FEATURE_KILL_POPUPS */ SHOW_RCS(list_h_rcs) SHOW_RCS(list_rcs) SHOW_RCS(loadcfg_h_rcs)