- List all AFs, with edit buttons
[privoxy.git] / cgi.c
diff --git a/cgi.c b/cgi.c
index 6df1413..df20340 100644 (file)
--- a/cgi.c
+++ b/cgi.c
@@ -1,4 +1,4 @@
-const char cgi_rcs[] = "$Id: cgi.c,v 1.60 2002/04/08 20:50:25 swa Exp $";
+const char cgi_rcs[] = "$Id: cgi.c,v 1.63 2002/04/15 19:06:43 jongfoster Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/cgi.c,v $
@@ -38,6 +38,17 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.60 2002/04/08 20:50:25 swa Exp $";
  *
  * Revisions   :
  *    $Log: cgi.c,v $
+ *    Revision 1.63  2002/04/15 19:06:43  jongfoster
+ *    Typos
+ *
+ *    Revision 1.62  2002/04/10 19:59:46  jongfoster
+ *    Fixes to #include in templates:
+ *    - Didn't close main file if loading an included template fails.
+ *    - I'm paranoid and want to disallow "#include /etc/passwd".
+ *
+ *    Revision 1.61  2002/04/10 13:37:48  oes
+ *    Made templates modular: template_load now recursive with max depth 1
+ *
  *    Revision 1.60  2002/04/08 20:50:25  swa
  *    fixed JB spelling
  *
@@ -347,6 +358,7 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.60 2002/04/08 20:50:25 swa Exp $";
 #include <stdlib.h>
 #include <ctype.h>
 #include <string.h>
+#include <limits.h>
 #include <assert.h>
 
 #ifdef _WIN32
@@ -386,25 +398,24 @@ static const struct cgi_dispatcher cgi_dispatchers[] = {
 #endif
    { "show-status", 
          cgi_show_status,  
-         "Show information about the current configuration" }, 
+         "View & change the current configuration" }, 
    { "show-version", 
          cgi_show_version,  
-         "Show the source code version numbers" }, 
+         "View the source code version numbers" }, 
    { "show-request", 
          cgi_show_request,  
-         "Show the request headers." }, 
+         "View the request headers." }, 
    { "show-url-info",
          cgi_show_url_info, 
-         "Show which actions apply to a URL and why"  },
+         "Look up which actions apply to a URL and why"  },
 #ifdef FEATURE_CGI_EDIT_ACTIONS
    { "toggle",
          cgi_toggle, 
          "Toggle Privoxy on or off" },
-   { "edit-actions",
-         cgi_edit_actions, 
-         "Edit the actions list" },
 
-   
+   { "edit-actions", /* Edit the actions list */
+         cgi_edit_actions, 
+         NULL },
    { "eaa", /* Shortcut for edit-actions-add-url-form */
          cgi_edit_actions_add_url_form, 
          NULL },
@@ -414,9 +425,12 @@ static const struct cgi_dispatcher cgi_dispatchers[] = {
    { "ear", /* Shortcut for edit-actions-remove-url-form */
          cgi_edit_actions_remove_url_form, 
          NULL },
-   { "eas", /* Shortcut for edit-actions-for-url */
+   { "eafu", /* Shortcut for edit-actions-for-url */
          cgi_edit_actions_for_url, 
          NULL },
+   { "eas", /* Shortcut for edit-actions-submit */
+         cgi_edit_actions_submit, 
+         NULL },
    { "easa", /* Shortcut for edit-actions-section-add */
          cgi_edit_actions_section_add, 
          NULL },
@@ -552,7 +566,7 @@ static struct map *parse_cgi_parameters(char *argstring);
  * Function    :  dispatch_cgi
  *
  * Description :  Checks if a request URL has either the magical
- *                hostname CGI_SITE_1_HOST (usully http://i.j.b/) or
+ *                hostname CGI_SITE_1_HOST (usually http://p.p/) or
  *                matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
  *                http://ijbswa.sourceforge.net/config). If so, it passes
  *                the (rest of the) path onto dispatch_known_cgi, which
@@ -763,6 +777,188 @@ static struct map *parse_cgi_parameters(char *argstring)
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  get_char_param
+ *
+ * Description :  Get a single-character parameter passed to a CGI
+ *                function.
+ *
+ * Parameters  :
+ *          1  :  parameters = map of cgi parameters
+ *          2  :  param_name = The name of the parameter to read
+ *
+ * Returns     :  Uppercase character on success, '\0' on error.
+ *
+ *********************************************************************/
+char get_char_param(const struct map *parameters,
+                    const char *param_name)
+{
+   char ch;
+
+   assert(parameters);
+   assert(param_name);
+
+   ch = *(lookup(parameters, param_name));
+   if ((ch >= 'a') && (ch <= 'z'))
+   {
+      ch = ch - 'a' + 'A';
+   }
+
+   return ch;
+}
+
+
+/*********************************************************************
+ *
+ * Function    :  get_string_param
+ *
+ * Description :  Get a string paramater, to be used as an
+ *                ACTION_STRING or ACTION_MULTI paramater.
+ *                Validates the input to prevent stupid/malicious
+ *                users from corrupting their action file.
+ *
+ * Parameters  :
+ *          1  :  parameters = map of cgi parameters
+ *          2  :  param_name = The name of the parameter to read
+ *          3  :  pparam = destination for paramater.  Allocated as
+ *                part of the map "parameters", so don't free it.
+ *                Set to NULL if not specified.
+ *
+ * Returns     :  JB_ERR_OK         on success, or if the paramater
+ *                                  was not specified.
+ *                JB_ERR_MEMORY     on out-of-memory.
+ *                JB_ERR_CGI_PARAMS if the paramater is not valid.
+ *
+ *********************************************************************/
+jb_err get_string_param(const struct map *parameters,
+                        const char *param_name,
+                        const char **pparam)
+{
+   const char *param;
+   const char *s;
+   char ch;
+
+   assert(parameters);
+   assert(param_name);
+   assert(pparam);
+
+   *pparam = NULL;
+
+   param = lookup(parameters, param_name);
+   if (!*param)
+   {
+      return JB_ERR_OK;
+   }
+
+   if (strlen(param) >= CGI_PARAM_LEN_MAX)
+   {
+      /*
+       * Too long.
+       *
+       * Note that the length limit is arbitrary, it just seems
+       * sensible to limit it to *something*.  There's no
+       * technical reason for any limit at all.
+       */
+      return JB_ERR_CGI_PARAMS;
+   }
+
+   /* Check every character to see if it's legal */
+   s = param;
+   while ((ch = *s++) != '\0')
+   {
+      if ( ((unsigned char)ch < (unsigned char)' ')
+        || (ch == '}') )
+      {
+         /* Probable hack attempt, or user accidentally used '}'. */
+         return JB_ERR_CGI_PARAMS;
+      }
+   }
+
+   /* Success */
+   *pparam = param;
+
+   return JB_ERR_OK;
+}
+
+
+/*********************************************************************
+ *
+ * Function    :  get_number_param
+ *
+ * Description :  Get a non-negative integer from the parameters
+ *                passed to a CGI function.
+ *
+ * Parameters  :
+ *          1  :  csp = Current client state (buffers, headers, etc...)
+ *          2  :  parameters = map of cgi parameters
+ *          3  :  name = Name of CGI parameter to read
+ *          4  :  pvalue = destination for value.
+ *                         Set to -1 on error.
+ *
+ * Returns     :  JB_ERR_OK         on success
+ *                JB_ERR_MEMORY     on out-of-memory
+ *                JB_ERR_CGI_PARAMS if the parameter was not specified
+ *                                  or is not valid.
+ *
+ *********************************************************************/
+jb_err get_number_param(struct client_state *csp,
+                        const struct map *parameters,
+                        char *name,
+                        unsigned *pvalue)
+{
+   const char *param;
+   char ch;
+   unsigned value;
+
+   assert(csp);
+   assert(parameters);
+   assert(name);
+   assert(pvalue);
+
+   *pvalue = 0; 
+
+   param = lookup(parameters, name);
+   if (!*param)
+   {
+      return JB_ERR_CGI_PARAMS;
+   }
+
+   /* We don't use atoi because I want to check this carefully... */
+
+   value = 0;
+   while ((ch = *param++) != '\0')
+   {
+      if ((ch < '0') || (ch > '9'))
+      {
+         return JB_ERR_CGI_PARAMS;
+      }
+
+      ch -= '0';
+
+      /* Note:
+       *
+       * <limits.h> defines UINT_MAX
+       *
+       * (UINT_MAX - ch) / 10 is the largest number that
+       *     can be safely multiplied by 10 then have ch added.
+       */
+      if (value > ((UINT_MAX - (unsigned)ch) / 10U))
+      {
+         return JB_ERR_CGI_PARAMS;
+      }
+
+      value = value * 10 + ch;
+   }
+
+   /* Success */
+   *pvalue = value;
+
+   return JB_ERR_OK;
+
+}
+
+
 /*********************************************************************
  *
  * Function    :  error_response
@@ -1275,6 +1471,7 @@ jb_err template_load(struct client_state *csp, char **template_ptr,
    char *full_path;
    char *file_buffer;
    char *included_module;
+   const char *p;
    FILE *fp;
    char buf[BUFFER_SIZE];
 
@@ -1284,9 +1481,21 @@ jb_err template_load(struct client_state *csp, char **template_ptr,
 
    *template_ptr = NULL;
 
-   /*
-    * Open template file or fail
-    */
+   /* Validate template name.  Paranoia. */
+   for (p = templatename; *p != 0; p++)
+   {
+      if ( ((*p < 'a') || (*p > 'z'))
+        && ((*p < 'A') || (*p > 'Z'))
+        && ((*p < '0') || (*p > '9'))
+        && (*p != '-')
+        && (*p != '.'))
+      {
+         /* Illegal character */
+         return JB_ERR_FILE;
+      }
+   }
+
+   /* Generate full path */
 
    templates_dir_path = make_path(csp->config->confdir, "templates");
    if (templates_dir_path == NULL)
@@ -1301,6 +1510,8 @@ jb_err template_load(struct client_state *csp, char **template_ptr,
       return JB_ERR_MEMORY;
    }
 
+   /* Allocate buffer */
+
    file_buffer = strdup("");
    if (file_buffer == NULL)
    {
@@ -1308,6 +1519,8 @@ jb_err template_load(struct client_state *csp, char **template_ptr,
       return JB_ERR_MEMORY;
    }
 
+   /* Open template file */
+
    if (NULL == (fp = fopen(full_path, "r")))
    {
       log_error(LOG_LEVEL_ERROR, "Cannot open template file %s: %E", full_path);
@@ -1318,7 +1531,7 @@ jb_err template_load(struct client_state *csp, char **template_ptr,
    free(full_path);
 
    /* 
-    * Read the file, ignoring comments, and honring #include
+    * Read the file, ignoring comments, and honoring #include
     * statements, unless we're already called recursively.
     *
     * FIXME: The comment handling could break with lines >BUFFER_SIZE long.
@@ -1331,17 +1544,16 @@ jb_err template_load(struct client_state *csp, char **template_ptr,
          if (JB_ERR_OK != (err = template_load(csp, &included_module, chomp(buf + 9), 1)))
          {
             free(file_buffer);
+            fclose(fp);
             return err;
          }
 
-         if (string_append(&file_buffer, included_module))
+         if (string_join(&file_buffer, included_module))
          {
             fclose(fp);
-            free(included_module);
             return JB_ERR_MEMORY;
          }
 
-         free(included_module);
          continue;
       }