-const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.35.2.7 2006/01/29 23:10:56 david__schmidt Exp $";
+const char cgisimple_rcs[] = "$Id: cgisimple.c,v 1.43 2006/12/17 17:57:56 fabiankeil Exp $";
/*********************************************************************
*
- * File : $Source: /cvsroot/ijbswa/current/Attic/cgisimple.c,v $
+ * File : $Source: /cvsroot/ijbswa/current/cgisimple.c,v $
*
* Purpose : Simple CGIs to get information about Privoxy's
* status.
*
* Revisions :
* $Log: cgisimple.c,v $
+ * 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
*
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 */
+#ifdef WIN32
+ /*
+ * XXX: Do we support other operating systems that
+ * require special treatment to fopen in binary mode?
+ */
+ if (NULL == (fp = fopen(full_path, "rb")))
+#else
+ if (NULL == (fp = fopen(full_path, "r")))
+#endif /* def WIN32 */
+ {
+ 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 = ftell(fp);
+ fseek(fp, 0, SEEK_SET);
+
+ /* Allocate memory and load the file directly into the body */
+ rsp->body = (char *)malloc(length+1);
+ if (!rsp->body)
+ {
+ fclose(fp);
+ free(full_path);
+ return JB_ERR_MEMORY;
+ }
+ if (!fread(rsp->body, length, 1, fp))
+ {
+ /*
+ * This happens if we didn't fopen in binary mode.
+ * If it does, we just log it and serve what we got,
+ * most likely padded with garbage.
+ */
+ log_error(LOG_LEVEL_ERROR, "Couldn't completely read user-manual file %s.", full_path);
+ }
+ fclose(fp);
+ free(full_path);
+
+ rsp->content_length = (int)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_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 :
int local_urls_read;
int local_urls_rejected;
#endif /* ndef FEATURE_STATISTICS */
- struct file_list * fl;
- struct url_actions * b;
jb_err err = JB_ERR_OK;
struct map *exports;
s = strdup("");
for (i = 0; i < MAX_AF_FILES; i++)
{
- if (((fl = csp->actions_list[i]) != NULL) && ((b = fl->f) != NULL))
+ if (csp->actions_list[i] != NULL)
{
if (!err) err = string_append(&s, "<tr><td>");
if (!err) err = string_join(&s, html_encode(csp->actions_list[i]->filename));
- snprintf(buf, 100, "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
+ snprintf(buf, 100, "</td><td class=\"buttons\"><a href=\"/show-status?file=actions&index=%d\">View</a>", i);
if (!err) err = string_append(&s, buf);
#ifdef FEATURE_CGI_EDIT_ACTIONS
s = strdup("");
for (i = 0; i < MAX_AF_FILES; i++)
{
- if (((fl = csp->rlist[i]) != NULL) && ((b = fl->f) != NULL))
+ if (csp->rlist[i] != NULL)
{
if (!err) err = string_append(&s, "<tr><td>");
if (!err) err = string_join(&s, html_encode(csp->rlist[i]->filename));
- snprintf(buf, 100, "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
+ snprintf(buf, 100,
+ "</td><td class=\"buttons\"><a href=\"/show-status?file=filter&index=%d\">View</a>", i);
if (!err) err = string_append(&s, buf);
if (!err) err = string_append(&s, "</td></tr>\n");
}
}
if (*s != '\0')
{
- if (!err) err = map(exports, "re-filter-filename", 1, s, 0);
+ if (!err) err = map(exports, "re-filter-filenames", 1, s, 0);
}
else
{
- if (!err) err = map(exports, "re-filter-filename", 1, "<tr><td>None specified</td></tr>", 1);
+ if (!err) err = map(exports, "re-filter-filenames", 1, "<tr><td>None specified</td></tr>", 1);
if (!err) err = map_block_killer(exports, "have-filterfile");
}
/* FIXME: Hardcoded HTML! */
string_append(&matches, "<tr><th>In file: ");
string_join (&matches, html_encode(csp->config->actions_file_short[i]));
- snprintf(buf, 150, ".action <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
+ snprintf(buf, 150, ".action <a class=\"cmd\" href=\"/show-status?file=actions&index=%d\">", i);
string_append(&matches, buf);
string_append(&matches, "View</a>");
#ifdef FEATURE_CGI_EDIT_ACTIONS
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 */