First version of CGI-based edit interface. This is very much a
[privoxy.git] / actions.c
index af10cfe..a09f95a 100644 (file)
--- a/actions.c
+++ b/actions.c
@@ -1,4 +1,4 @@
-const char actions_rcs[] = "$Id: actions.c,v 1.9 2001/07/30 22:08:36 jongfoster Exp $";
+const char actions_rcs[] = "$Id: actions.c,v 1.12 2001/09/16 13:21:27 jongfoster Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/actions.c,v $
@@ -33,6 +33,15 @@ const char actions_rcs[] = "$Id: actions.c,v 1.9 2001/07/30 22:08:36 jongfoster
  *
  * Revisions   :
  *    $Log: actions.c,v $
+ *    Revision 1.12  2001/09/16 13:21:27  jongfoster
+ *    Changes to use new list functions.
+ *
+ *    Revision 1.11  2001/09/14 00:17:32  jongfoster
+ *    Tidying up memory allocation. New function init_action().
+ *
+ *    Revision 1.10  2001/09/10 10:14:34  oes
+ *    Removing unused variable
+ *
  *    Revision 1.9  2001/07/30 22:08:36  jongfoster
  *    Tidying up #defines:
  *    - All feature #defines are now of the form FEATURE_xxx
@@ -81,6 +90,9 @@ const char actions_rcs[] = "$Id: actions.c,v 1.9 2001/07/30 22:08:36 jongfoster
 #include "miscutil.h"
 #include "errlog.h"
 #include "loaders.h"
+#ifdef FEATURE_CGI_EDIT_ACTIONS
+#include "encode.h"
+#endif /* def FEATURE_CGI_EDIT_ACTIONS */
 
 const char actions_h_rcs[] = ACTIONS_H_VERSION;
 
@@ -202,9 +214,9 @@ void merge_actions (struct action_spec *dest,
       if (src->multi_remove_all[i])
       {
          /* Remove everything from dest */
-         destroy_list(dest->multi_remove[i]);
-         destroy_list(dest->multi_add[i]);
+         list_remove_all(dest->multi_remove[i]);
          dest->multi_remove_all[i] = 1;
+
          list_duplicate(dest->multi_add[i], src->multi_add[i]);
       }
       else if (dest->multi_remove_all[i])
@@ -233,6 +245,8 @@ void merge_actions (struct action_spec *dest,
  *
  * Description :  Copy an action_specs.
  *                Similar to "cur_action = new_action".
+ *                Note that dest better not contain valid data
+ *                - it's overwritten, not freed.
  *
  * Parameters  :
  *          1  :  dest = Destination of copy.
@@ -246,6 +260,8 @@ void copy_action (struct action_spec *dest,
 {
    int i;
 
+   memset(dest, '\0', sizeof(*dest));
+
    dest->mask = src->mask;
    dest->add  = src->add;
 
@@ -268,7 +284,9 @@ void copy_action (struct action_spec *dest,
  *
  * Function    :  free_action
  *
- * Description :  Free an action_specs.
+ * Description :  Destroy an action_spec.  Frees memory used by it,
+ *                except for the memory used by the struct action_spec
+ *                itself.
  *
  * Parameters  :
  *          1  :  src = Source to free.
@@ -422,7 +440,7 @@ static int get_actions(char *line,
                        struct action_alias * alias_list,
                        struct action_spec *cur_action)
 {
-   memset(cur_action, '\0', sizeof(*cur_action));
+   init_action(cur_action);
    cur_action->mask = ACTION_MASK_ALL;
 
    while (line)
@@ -509,8 +527,8 @@ static int get_actions(char *line,
                       *
                       * Remove *ALL*.
                       */
-                     destroy_list(remove);
-                     destroy_list(add);
+                     list_remove_all(remove);
+                     list_remove_all(add);
                      cur_action->multi_remove_all[action->index] = 1;
                   }
                   else
@@ -577,7 +595,7 @@ char * actions_to_text(struct action_spec *action)
    unsigned mask = action->mask;
    unsigned add  = action->add;
    char * result = strdup("");
-   struct list * lst;
+   struct list_entry * lst;
 
    /* sanity - prevents "-feature +feature" */
    mask |= add;
@@ -612,7 +630,7 @@ char * actions_to_text(struct action_spec *action)
    }                                                 \
    else                                              \
    {                                                 \
-      lst = action->multi_remove[__index]->next;     \
+      lst = action->multi_remove[__index]->first;    \
       while (lst)                                    \
       {                                              \
          result = strsav(result, " -" __name "{");   \
@@ -621,7 +639,7 @@ char * actions_to_text(struct action_spec *action)
          lst = lst->next;                            \
       }                                              \
    }                                                 \
-   lst = action->multi_add[__index]->next;           \
+   lst = action->multi_add[__index]->first;          \
    while (lst)                                       \
    {                                                 \
       result = strsav(result, " +" __name "{");      \
@@ -643,6 +661,106 @@ char * actions_to_text(struct action_spec *action)
 }
 
 
+#ifdef FEATURE_CGI_EDIT_ACTIONS
+/*********************************************************************
+ *
+ * Function    :  actions_to_html
+ *
+ * Description :  Converts a actionsfile entry from numeric form
+ *                ("mask" and "add") to a <br>-seperated HTML string.
+ *
+ * Parameters  :
+ *          1  :  mask = As from struct url_actions
+ *          2  :  add  = As from struct url_actions
+ *
+ * Returns     :  A string.  Caller must free it.
+ *
+ *********************************************************************/
+char * actions_to_html(struct action_spec *action)
+{
+   unsigned mask = action->mask;
+   unsigned add  = action->add;
+   char * result = strdup("");
+   char * enc_str;
+   struct list_entry * lst;
+
+   /* sanity - prevents "-feature +feature" */
+   mask |= add;
+
+
+#define DEFINE_ACTION_BOOL(__name, __bit)      \
+   if (!(mask & __bit))                        \
+   {                                           \
+      result = strsav(result, "\n<br>-" __name); \
+   }                                           \
+   else if (add & __bit)                       \
+   {                                           \
+      result = strsav(result, "\n<br>+" __name); \
+   }
+
+#define DEFINE_ACTION_STRING(__name, __bit, __index) \
+   if (!(mask & __bit))                              \
+   {                                                 \
+      result = strsav(result, "\n<br>-" __name);       \
+   }                                                 \
+   else if (add & __bit)                             \
+   {                                                 \
+      result = strsav(result, "\n<br>+" __name "{");   \
+      enc_str = html_encode(action->string[__index]);\
+      result = strsav(result, enc_str);              \
+      freez(enc_str);                                \
+      result = strsav(result, "}");                  \
+   }
+
+#define DEFINE_ACTION_MULTI(__name, __index)         \
+   if (action->multi_remove_all[__index])            \
+   {                                                 \
+      result = strsav(result, "\n<br>-" __name "{*}"); \
+   }                                                 \
+   else                                              \
+   {                                                 \
+      lst = action->multi_remove[__index]->first;    \
+      while (lst)                                    \
+      {                                              \
+         result = strsav(result, "\n<br>-" __name "{");\
+         enc_str = html_encode(lst->str);            \
+         result = strsav(result, enc_str);           \
+         freez(enc_str);                             \
+         result = strsav(result, "}");               \
+         lst = lst->next;                            \
+      }                                              \
+   }                                                 \
+   lst = action->multi_add[__index]->first;          \
+   while (lst)                                       \
+   {                                                 \
+      result = strsav(result, "\n<br>+" __name "{");   \
+      result = strsav(result, lst->str);             \
+      result = strsav(result, "}");                  \
+      lst = lst->next;                               \
+   }
+
+#define DEFINE_ACTION_ALIAS 0 /* No aliases for output */
+
+#include "actionlist.h"
+
+#undef DEFINE_ACTION_MULTI
+#undef DEFINE_ACTION_STRING
+#undef DEFINE_ACTION_BOOL
+#undef DEFINE_ACTION_ALIAS
+
+   /* trim leading <br> */
+   if (result && *result)
+   {
+      char * s = result;
+      result = strdup(result + 5);
+      free(s);
+   }
+
+   return result;
+}
+#endif /* def FEATURE_CGI_EDIT_ACTIONS */
+
+
 /*********************************************************************
  *
  * Function    :  current_actions_to_text
@@ -659,7 +777,7 @@ char * current_action_to_text(struct current_action_spec *action)
 {
    unsigned flags  = action->flags;
    char * result = strdup("");
-   struct list * lst;
+   struct list_entry * lst;
 
 #define DEFINE_ACTION_BOOL(__name, __bit)   \
    if (flags & __bit)                       \
@@ -684,7 +802,7 @@ char * current_action_to_text(struct current_action_spec *action)
    }
 
 #define DEFINE_ACTION_MULTI(__name, __index)            \
-   lst = action->multi[__index]->next;                  \
+   lst = action->multi[__index]->first;                 \
    if (lst == NULL)                                     \
    {                                                    \
       result = strsav(result, " -" __name);             \
@@ -728,10 +846,29 @@ char * current_action_to_text(struct current_action_spec *action)
 void init_current_action (struct current_action_spec *dest)
 {
    memset(dest, '\0', sizeof(*dest));
+
    dest->flags = ACTION_MOST_COMPATIBLE;
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  init_action
+ *
+ * Description :  Zero out an action.
+ *
+ * Parameters  :
+ *          1  :  dest = An uninitialized action_spec.
+ *
+ * Returns     :  N/A
+ *
+ *********************************************************************/
+void init_action (struct action_spec *dest)
+{
+   memset(dest, '\0', sizeof(*dest));
+}
+
+
 /*********************************************************************
  *
  * Function    :  merge_current_action
@@ -742,7 +879,7 @@ void init_current_action (struct current_action_spec *dest)
  *                is that this one doesn't allocate memory for
  *                strings (so "src" better be in memory for at least
  *                as long as "dest" is, and you'd better free
- *                "dest" using "current_free_action").
+ *                "dest" using "free_current_action").
  *                Also, there is no  mask or remove lists in dest.
  *                (If we're applying it to a URL, we don't need them)
  *
@@ -775,8 +912,7 @@ void merge_current_action (struct current_action_spec *dest,
    {
       if (src->multi_remove_all[i])
       {
-         /* Remove everything from dest */
-         destroy_list(dest->multi[i]);
+         /* Remove everything from dest, then add src->multi_add */
          list_duplicate(dest->multi[i], src->multi_add[i]);
       }
       else
@@ -792,7 +928,8 @@ void merge_current_action (struct current_action_spec *dest,
  *
  * Function    :  free_current_action
  *
- * Description :  Free a current_action_spec.
+ * Description :  Free memory used by a current_action_spec.
+ *                Does not free the current_action_spec itself.
  *
  * Parameters  :
  *          1  :  src = Source to free.
@@ -839,6 +976,7 @@ void unload_actions_file(void *file_data)
    {
       next = cur->next;
       free_url(cur->url);
+      free_action(cur->action);
       freez(cur);
       cur = next;
    }
@@ -876,7 +1014,7 @@ int load_actions_file(struct client_state *csp)
    struct action_spec cur_action[1];
    struct action_alias * alias_list = NULL;
 
-   memset(cur_action, '\0', sizeof(*cur_action));
+   init_action(cur_action);
 
    if (!check_file_changed(current_actions_file, csp->config->actions_file, &fs))
    {