1 #ifndef ACTIONS_H_INCLUDED
2 #define ACTIONS_H_INCLUDED
3 #define ACTIONS_H_VERSION "$Id: actions.h,v 1.17 2008/01/28 20:17:40 fabiankeil Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/actions.h,v $
8 * Purpose : Declares functions to work with actions files
9 * Functions declared include: FIXME
11 * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
12 * Privoxy team. http://www.privoxy.org/
14 * Based on the Internet Junkbuster originally written
15 * by and Copyright (C) 1997 Anonymous Coders and
16 * Junkbusters Corporation. http://www.junkbusters.com
18 * This program is free software; you can redistribute it
19 * and/or modify it under the terms of the GNU General
20 * Public License as published by the Free Software
21 * Foundation; either version 2 of the License, or (at
22 * your option) any later version.
24 * This program is distributed in the hope that it will
25 * be useful, but WITHOUT ANY WARRANTY; without even the
26 * implied warranty of MERCHANTABILITY or FITNESS FOR A
27 * PARTICULAR PURPOSE. See the GNU General Public
28 * License for more details.
30 * The GNU General Public License should be included with
31 * this file. If not, you can view it at
32 * http://www.gnu.org/copyleft/gpl.html
33 * or write to the Free Software Foundation, Inc., 59
34 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
38 * Revision 1.17 2008/01/28 20:17:40 fabiankeil
39 * - Mark some parameters as immutable.
40 * - Hide update_action_bits_for_all_tags() while it's unused.
42 * Revision 1.16 2007/04/17 18:21:45 fabiankeil
43 * Split update_action_bits() into
44 * update_action_bits_for_all_tags()
45 * and update_action_bits_for_tag().
47 * Revision 1.15 2007/04/15 16:39:20 fabiankeil
48 * Introduce tags as alternative way to specify which
49 * actions apply to a request. At the moment tags can be
50 * created based on client and server headers.
52 * Revision 1.14 2006/07/18 14:48:45 david__schmidt
53 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
54 * with what was really the latest development (the v_3_0_branch branch)
56 * Revision 1.12 2002/05/06 07:56:50 oes
57 * Made actions_to_html independent of FEATURE_CGI_EDIT_ACTIONS
59 * Revision 1.11 2002/04/30 11:14:52 oes
60 * Made csp the first parameter in *action_to_html
62 * Revision 1.10 2002/04/26 12:53:33 oes
63 * - actions_to_html signature change
64 * - current_action_to_text: renamed to current_action_to_html
65 * and signature change
67 * Revision 1.9 2002/03/26 22:29:54 swa
68 * we have a new homepage!
70 * Revision 1.8 2002/03/24 13:25:43 swa
71 * name change related issues
73 * Revision 1.7 2002/03/16 23:54:06 jongfoster
74 * Adding graceful termination feature, to help look for memory leaks.
75 * If you enable this (which, by design, has to be done by hand
76 * editing config.h) and then go to http://i.j.b/die, then the program
77 * will exit cleanly after the *next* request. It should free all the
78 * memory that was used.
80 * Revision 1.6 2001/10/23 21:30:30 jongfoster
81 * Adding error-checking to selected functions.
83 * Revision 1.5 2001/10/14 21:58:22 jongfoster
84 * Adding support for the CGI-based editor:
85 * - Exported get_actions()
86 * - Added new function free_alias_list()
87 * - Added support for {{settings}} and {{description}} blocks
88 * in the actions file. They are currently ignored.
89 * - Added restriction to only one {{alias}} block which must appear
90 * first in the file, to simplify the editor's rewriting rules.
91 * - Note that load_actions_file() is no longer used by the CGI-based
92 * editor, but some of the other routines in this file are.
94 * Revision 1.4 2001/09/16 15:47:37 jongfoster
95 * First version of CGI-based edit interface. This is very much a
96 * work-in-progress, and you can't actually use it to edit anything
97 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
100 * Revision 1.3 2001/09/14 00:17:32 jongfoster
101 * Tidying up memory allocation. New function init_action().
103 * Revision 1.2 2001/07/29 19:01:11 jongfoster
104 * Changed _FILENAME_H to FILENAME_H_INCLUDED.
105 * Added forward declarations for needed structures.
107 * Revision 1.1 2001/05/31 21:16:46 jongfoster
108 * Moved functions to process the action list into this new file.
111 *********************************************************************/
120 struct current_action_spec;
125 /* This structure is used to hold user-defined aliases */
129 struct action_spec action[1];
130 struct action_alias * next;
134 extern jb_err get_actions (char *line,
135 struct action_alias * alias_list,
136 struct action_spec *cur_action);
137 extern void free_alias_list(struct action_alias *alias_list);
139 extern void init_action(struct action_spec *dest);
140 extern void free_action(struct action_spec *src);
141 extern jb_err merge_actions (struct action_spec *dest,
142 const struct action_spec *src);
144 extern int update_action_bits_for_all_tags(struct client_state *csp);
146 extern int update_action_bits_for_tag(struct client_state *csp, const char *tag);
147 extern jb_err copy_action (struct action_spec *dest,
148 const struct action_spec *src);
149 extern char * actions_to_text (const struct action_spec *action);
150 extern char * actions_to_html (const struct client_state *csp,
151 const struct action_spec *action);
152 extern void init_current_action (struct current_action_spec *dest);
153 extern void free_current_action (struct current_action_spec *src);
154 extern jb_err merge_current_action (struct current_action_spec *dest,
155 const struct action_spec *src);
156 extern char * current_action_to_html(const struct client_state *csp,
157 const struct current_action_spec *action);
159 extern jb_err get_action_token(char **line, char **name, char **value);
160 extern void unload_actions_file(void *file_data);
161 extern int load_action_files(struct client_state *csp);
163 #ifdef FEATURE_GRACEFUL_TERMINATION
164 void unload_current_actions_file(void);
168 /* Revision control strings from this header and associated .c file */
169 extern const char actions_rcs[];
170 extern const char actions_h_rcs[];
176 #endif /* ndef ACTIONS_H_INCLUDED */