Don't let the less-download-windows filter mess up
[privoxy.git] / actions.h
1 #ifndef ACTIONS_H_INCLUDED
2 #define ACTIONS_H_INCLUDED
3 #define ACTIONS_H_VERSION "$Id: actions.h,v 1.15 2007/04/15 16:39:20 fabiankeil Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/actions.h,v $
7  *
8  * Purpose     :  Declares functions to work with actions files
9  *                Functions declared include: FIXME
10  *
11  * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
12  *                Privoxy team. http://www.privoxy.org/
13  *
14  *                Based on the Internet Junkbuster originally written
15  *                by and Copyright (C) 1997 Anonymous Coders and 
16  *                Junkbusters Corporation.  http://www.junkbusters.com
17  *
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.
23  *
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.
29  *
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.
35  *
36  * Revisions   :
37  *    $Log: actions.h,v $
38  *    Revision 1.15  2007/04/15 16:39:20  fabiankeil
39  *    Introduce tags as alternative way to specify which
40  *    actions apply to a request. At the moment tags can be
41  *    created based on client and server headers.
42  *
43  *    Revision 1.14  2006/07/18 14:48:45  david__schmidt
44  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
45  *    with what was really the latest development (the v_3_0_branch branch)
46  *
47  *    Revision 1.12  2002/05/06 07:56:50  oes
48  *    Made actions_to_html independent of FEATURE_CGI_EDIT_ACTIONS
49  *
50  *    Revision 1.11  2002/04/30 11:14:52  oes
51  *    Made csp the first parameter in *action_to_html
52  *
53  *    Revision 1.10  2002/04/26 12:53:33  oes
54  *     -  actions_to_html signature change
55  *     -  current_action_to_text: renamed to current_action_to_html
56  *        and signature change
57  *
58  *    Revision 1.9  2002/03/26 22:29:54  swa
59  *    we have a new homepage!
60  *
61  *    Revision 1.8  2002/03/24 13:25:43  swa
62  *    name change related issues
63  *
64  *    Revision 1.7  2002/03/16 23:54:06  jongfoster
65  *    Adding graceful termination feature, to help look for memory leaks.
66  *    If you enable this (which, by design, has to be done by hand
67  *    editing config.h) and then go to http://i.j.b/die, then the program
68  *    will exit cleanly after the *next* request.  It should free all the
69  *    memory that was used.
70  *
71  *    Revision 1.6  2001/10/23 21:30:30  jongfoster
72  *    Adding error-checking to selected functions.
73  *
74  *    Revision 1.5  2001/10/14 21:58:22  jongfoster
75  *    Adding support for the CGI-based editor:
76  *    - Exported get_actions()
77  *    - Added new function free_alias_list()
78  *    - Added support for {{settings}} and {{description}} blocks
79  *      in the actions file.  They are currently ignored.
80  *    - Added restriction to only one {{alias}} block which must appear
81  *      first in the file, to simplify the editor's rewriting rules.
82  *    - Note that load_actions_file() is no longer used by the CGI-based
83  *      editor, but some of the other routines in this file are.
84  *
85  *    Revision 1.4  2001/09/16 15:47:37  jongfoster
86  *    First version of CGI-based edit interface.  This is very much a
87  *    work-in-progress, and you can't actually use it to edit anything
88  *    yet.  You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
89  *    to have any effect.
90  *
91  *    Revision 1.3  2001/09/14 00:17:32  jongfoster
92  *    Tidying up memory allocation. New function init_action().
93  *
94  *    Revision 1.2  2001/07/29 19:01:11  jongfoster
95  *    Changed _FILENAME_H to FILENAME_H_INCLUDED.
96  *    Added forward declarations for needed structures.
97  *
98  *    Revision 1.1  2001/05/31 21:16:46  jongfoster
99  *    Moved functions to process the action list into this new file.
100  *
101  *
102  *********************************************************************/
103 \f
104
105 #ifdef __cplusplus
106 extern "C" {
107 #endif
108
109
110 struct action_spec;
111 struct current_action_spec;
112 struct client_state;
113
114
115
116 /* This structure is used to hold user-defined aliases */
117 struct action_alias
118 {
119    const char * name;
120    struct action_spec action[1];
121    struct action_alias * next;
122 };
123
124
125 extern jb_err get_actions (char *line, 
126                            struct action_alias * alias_list,
127                            struct action_spec *cur_action);
128 extern void free_alias_list(struct action_alias *alias_list);
129
130 extern void init_action(struct action_spec *dest);
131 extern void free_action(struct action_spec *src);
132 extern jb_err merge_actions (struct action_spec *dest, 
133                              const struct action_spec *src);
134 extern int update_action_bits_for_all_tags(struct client_state *csp);
135 extern int update_action_bits_for_tag(struct client_state *csp, const char *tag);
136 extern jb_err copy_action (struct action_spec *dest, 
137                            const struct action_spec *src);
138 extern char * actions_to_text     (struct action_spec *action);
139 extern char * actions_to_html     (struct client_state *csp,
140                                    struct action_spec *action);
141 extern void init_current_action     (struct current_action_spec *dest);
142 extern void free_current_action     (struct current_action_spec *src);
143 extern jb_err merge_current_action  (struct current_action_spec *dest, 
144                                      const struct action_spec *src);
145 extern char * current_action_to_html(struct client_state *csp,
146                                      struct current_action_spec *action);
147
148 extern jb_err get_action_token(char **line, char **name, char **value);
149 extern void unload_actions_file(void *file_data);
150 extern int load_actions_file(struct client_state *csp);
151
152 #ifdef FEATURE_GRACEFUL_TERMINATION
153 void unload_current_actions_file(void);
154 #endif
155
156
157 /* Revision control strings from this header and associated .c file */
158 extern const char actions_rcs[];
159 extern const char actions_h_rcs[];
160
161 #ifdef __cplusplus
162 } /* extern "C" */
163 #endif
164
165 #endif /* ndef ACTIONS_H_INCLUDED */
166
167 /*
168   Local Variables:
169   tab-width: 3
170   end:
171 */
172