1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/actionlist.h,v $
5 * Purpose : Master list of supported actions.
6 * Not really a header, since it generates code.
7 * This is included (3 times!) from actions.c
8 * Each time, the following macros are defined to
9 * suitable values beforehand:
10 * DEFINE_ACTION_MULTI()
11 * DEFINE_ACTION_STRING()
12 * DEFINE_ACTION_BOOL()
15 * Copyright : Written by and Copyright (C) 2001-2008 the SourceForge
16 * Privoxy team. http://www.privoxy.org/
18 * Based on the Internet Junkbuster originally written
19 * by and Copyright (C) 1997 Anonymous Coders and
20 * Junkbusters Corporation. http://www.junkbusters.com
22 * This program is free software; you can redistribute it
23 * and/or modify it under the terms of the GNU General
24 * Public License as published by the Free Software
25 * Foundation; either version 2 of the License, or (at
26 * your option) any later version.
28 * This program is distributed in the hope that it will
29 * be useful, but WITHOUT ANY WARRANTY; without even the
30 * implied warranty of MERCHANTABILITY or FITNESS FOR A
31 * PARTICULAR PURPOSE. See the GNU General Public
32 * License for more details.
34 * The GNU General Public License should be included with
35 * this file. If not, you can view it at
36 * http://www.gnu.org/copyleft/gpl.html
37 * or write to the Free Software Foundation, Inc., 59
38 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
41 * $Log: actionlist.h,v $
42 * Revision 1.30 2008/03/04 18:30:34 fabiankeil
43 * Remove the treat-forbidden-connects-like-blocks action. We now
44 * use the "blocked" page for forbidden CONNECT requests by default.
46 * Revision 1.29 2008/03/01 14:00:43 fabiankeil
47 * Let the block action take the reason for the block
48 * as argument and show it on the "blocked" page.
50 * Revision 1.28 2007/12/11 21:08:29 fabiankeil
51 * Let the CGI editor suggest a forward-override
52 * parameter whose syntax is actually valid.
54 * Revision 1.27 2007/11/10 15:04:08 fabiankeil
55 * Tell the CGI editor about +hide-referrer{conditional-forge}.
57 * Revision 1.26 2007/06/01 16:54:28 fabiankeil
58 * Add forward-override{} to change the forwarding settings through
59 * action sections. This is mainly interesting to forward different
60 * clients differently (for example based on User-Agent or request
63 * Revision 1.25 2007/04/15 16:39:20 fabiankeil
64 * Introduce tags as alternative way to specify which
65 * actions apply to a request. At the moment tags can be
66 * created based on client and server headers.
68 * Revision 1.24 2007/03/20 15:16:34 fabiankeil
69 * Use dedicated header filter actions instead of abusing "filter".
70 * Replace "filter-client-headers" and "filter-client-headers"
71 * with "server-header-filter" and "client-header-filter".
73 * Revision 1.23 2006/10/09 10:26:18 fabiankeil
74 * Changed the path in set-image-blocker's redirection default to
75 * "send-banner?type=pattern" instead of "show-banner?type=pattern"
76 * which isn't caught by Privoxy. Fixes BR 1573468.
78 * Changed hide-user-agent's default value to "Privoxy VERSION".
80 * Changed hide-referrer's default fake value to "http://www.privoxy.org/".
81 * A static referrer is obviously fake anyway, so we might as well
82 * advertise ourselves.
84 * Revision 1.22 2006/09/01 17:14:18 hal9
85 * Re-ordered the actions list so that they display in the actions editor in
86 * alphabetical order. Some of the new actions were "out of order".
88 * Revision 1.21 2006/08/14 08:25:19 fabiankeil
89 * Split filter-headers{} into filter-client-headers{}
90 * and filter-server-headers{}.
91 * Added parse_header_time() to share some code.
92 * Replaced timegm() with mktime().
94 * Revision 1.20 2006/08/03 02:46:41 david__schmidt
95 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
97 * Revision 1.19 2006/07/18 14:48:45 david__schmidt
98 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
99 * with what was really the latest development (the v_3_0_branch branch)
101 * Revision 1.17.2.3 2004/10/03 12:53:32 david__schmidt
102 * Add the ability to check jpeg images for invalid
103 * lengths of comment blocks. Defensive strategy
104 * against the exploit:
105 * Microsoft Security Bulletin MS04-028
106 * Buffer Overrun in JPEG Processing (GDI+) Could
107 * Allow Code Execution (833987)
108 * Enabled with +inspect-jpegs in actions files.
110 * Revision 1.17.2.2 2002/09/25 15:25:25 oes
111 * Added more aliases for prehistoric action names
113 * Revision 1.17.2.1 2002/08/02 12:50:47 oes
114 * Consistency with docs: Change default name for action from hide-referer to hide-referrer
116 * Revision 1.17 2002/05/14 21:25:55 oes
117 * Renamed prevent-(setting/reading)-cookies to crunch-(incoming/outgoing)-cookies
119 * Revision 1.16 2002/04/24 02:15:18 oes
120 * Renamed actions as discussed, Aliased old action names to new ones.
122 * Revision 1.15 2002/03/26 22:29:54 swa
123 * we have a new homepage!
125 * Revision 1.14 2002/03/24 16:32:08 jongfoster
126 * Removing logo option
128 * Revision 1.13 2002/03/24 15:23:33 jongfoster
131 * Revision 1.12 2002/03/24 13:25:43 swa
132 * name change related issues
134 * Revision 1.11 2002/03/12 01:42:49 oes
135 * Introduced modular filters
137 * Revision 1.10 2002/03/08 18:19:14 jongfoster
138 * Adding +image-blocker{pattern} option to edit interface
140 * Revision 1.9 2001/11/22 21:58:41 jongfoster
141 * Adding action +no-cookies-keep
143 * Revision 1.8 2001/10/10 16:42:52 oes
144 * Fixed a bug, Added +limit-connect string action
146 * Revision 1.7 2001/10/07 15:33:59 oes
147 * Introduced a +no-compression action
148 * Introduced a +downgrade action
150 * Revision 1.6 2001/09/16 15:47:37 jongfoster
151 * First version of CGI-based edit interface. This is very much a
152 * work-in-progress, and you can't actually use it to edit anything
153 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
154 * to have any effect.
156 * Revision 1.5 2001/07/18 12:27:03 oes
157 * Changed deanimate-gifs to string action
159 * Revision 1.4 2001/07/13 13:52:12 oes
161 * - Introduced new action ACTION_DEANIMATE
163 * Revision 1.3 2001/06/07 23:03:56 jongfoster
164 * Added standard comment at top of file.
167 *********************************************************************/
170 #if !(defined(DEFINE_ACTION_BOOL) && defined(DEFINE_ACTION_MULTI) && defined(DEFINE_ACTION_STRING))
171 #error Please define lots of macros before including "actionlist.h".
172 #endif /* !defined(all the DEFINE_ACTION_xxx macros) */
174 #ifndef DEFINE_CGI_PARAM_RADIO
175 #define DEFINE_CGI_PARAM_RADIO(name, bit, index, value, is_default)
176 #define DEFINE_CGI_PARAM_CUSTOM(name, bit, index, default_val)
177 #define DEFINE_CGI_PARAM_NO_RADIO(name, bit, index, default_val)
178 #endif /* ndef DEFINE_CGI_PARAM_RADIO */
180 DEFINE_ACTION_MULTI ("add-header", ACTION_MULTI_ADD_HEADER)
181 DEFINE_ACTION_STRING ("block", ACTION_BLOCK, ACTION_STRING_BLOCK)
182 DEFINE_CGI_PARAM_NO_RADIO("block", ACTION_BLOCK, ACTION_STRING_BLOCK, "No reason specified.")
183 DEFINE_ACTION_MULTI ("client-header-filter", ACTION_MULTI_CLIENT_HEADER_FILTER)
184 DEFINE_ACTION_MULTI ("client-header-tagger", ACTION_MULTI_CLIENT_HEADER_TAGGER)
185 DEFINE_ACTION_STRING ("content-type-overwrite", ACTION_CONTENT_TYPE_OVERWRITE, ACTION_STRING_CONTENT_TYPE)
186 DEFINE_CGI_PARAM_NO_RADIO("content-type-overwrite", ACTION_CONTENT_TYPE_OVERWRITE, ACTION_STRING_CONTENT_TYPE, "text/html")
187 DEFINE_ACTION_STRING ("crunch-client-header", ACTION_CRUNCH_CLIENT_HEADER, ACTION_STRING_CLIENT_HEADER)
188 DEFINE_CGI_PARAM_NO_RADIO("crunch-client-header", ACTION_CRUNCH_CLIENT_HEADER, ACTION_STRING_CLIENT_HEADER, "X-Whatever:")
189 DEFINE_ACTION_BOOL ("crunch-if-none-match", ACTION_CRUNCH_IF_NONE_MATCH)
190 DEFINE_ACTION_BOOL ("crunch-incoming-cookies", ACTION_NO_COOKIE_SET)
191 DEFINE_ACTION_BOOL ("crunch-outgoing-cookies", ACTION_NO_COOKIE_READ)
192 DEFINE_ACTION_STRING ("crunch-server-header", ACTION_CRUNCH_SERVER_HEADER, ACTION_STRING_SERVER_HEADER)
193 DEFINE_CGI_PARAM_NO_RADIO("crunch-server-header", ACTION_CRUNCH_SERVER_HEADER, ACTION_STRING_SERVER_HEADER, "X-Whatever:")
194 DEFINE_ACTION_STRING ("deanimate-gifs", ACTION_DEANIMATE, ACTION_STRING_DEANIMATE)
195 DEFINE_CGI_PARAM_RADIO ("deanimate-gifs", ACTION_DEANIMATE, ACTION_STRING_DEANIMATE, "first", 0)
196 DEFINE_CGI_PARAM_RADIO ("deanimate-gifs", ACTION_DEANIMATE, ACTION_STRING_DEANIMATE, "last", 1)
197 DEFINE_ACTION_BOOL ("downgrade-http-version", ACTION_DOWNGRADE)
198 DEFINE_ACTION_STRING ("fast-redirects", ACTION_FAST_REDIRECTS, ACTION_STRING_FAST_REDIRECTS)
199 DEFINE_CGI_PARAM_RADIO ("fast-redirects", ACTION_FAST_REDIRECTS, ACTION_STRING_FAST_REDIRECTS, "simple-check", 0)
200 DEFINE_CGI_PARAM_RADIO ("fast-redirects", ACTION_FAST_REDIRECTS, ACTION_STRING_FAST_REDIRECTS, "check-decoded-url", 1)
201 DEFINE_ACTION_MULTI ("filter", ACTION_MULTI_FILTER)
202 DEFINE_ACTION_BOOL ("force-text-mode", ACTION_FORCE_TEXT_MODE)
203 DEFINE_ACTION_STRING ("forward-override", ACTION_FORWARD_OVERRIDE, ACTION_STRING_FORWARD_OVERRIDE)
204 DEFINE_CGI_PARAM_CUSTOM ("forward-override", ACTION_FORWARD_OVERRIDE, ACTION_STRING_FORWARD_OVERRIDE, "forward .")
205 DEFINE_ACTION_BOOL ("handle-as-empty-document", ACTION_HANDLE_AS_EMPTY_DOCUMENT)
206 DEFINE_ACTION_BOOL ("handle-as-image", ACTION_IMAGE)
207 DEFINE_ACTION_STRING ("hide-accept-language", ACTION_HIDE_ACCEPT_LANGUAGE, ACTION_STRING_LANGUAGE)
208 DEFINE_CGI_PARAM_RADIO ("hide-accept-language", ACTION_HIDE_ACCEPT_LANGUAGE, ACTION_STRING_LANGUAGE, "block", 0)
209 DEFINE_CGI_PARAM_CUSTOM ("hide-accept-language", ACTION_HIDE_ACCEPT_LANGUAGE, ACTION_STRING_LANGUAGE, "de-de")
210 DEFINE_ACTION_STRING ("hide-content-disposition", ACTION_HIDE_CONTENT_DISPOSITION, ACTION_STRING_CONTENT_DISPOSITION)
211 DEFINE_CGI_PARAM_RADIO ("hide-content-disposition", ACTION_HIDE_CONTENT_DISPOSITION, ACTION_STRING_CONTENT_DISPOSITION, "block", 0)
212 DEFINE_CGI_PARAM_CUSTOM ("hide-content-disposition", ACTION_HIDE_CONTENT_DISPOSITION, ACTION_STRING_CONTENT_DISPOSITION, "attachment; filename=WHATEVER.txt")
213 DEFINE_ACTION_BOOL ("hide-forwarded-for-headers", ACTION_HIDE_FORWARDED)
214 DEFINE_ACTION_STRING ("hide-from-header", ACTION_HIDE_FROM, ACTION_STRING_FROM)
215 DEFINE_CGI_PARAM_RADIO ("hide-from-header", ACTION_HIDE_FROM, ACTION_STRING_FROM, "block", 1)
216 DEFINE_CGI_PARAM_CUSTOM ("hide-from-header", ACTION_HIDE_FROM, ACTION_STRING_FROM, "spam_me_senseless@sittingduck.xyz")
217 DEFINE_ACTION_STRING ("hide-if-modified-since", ACTION_HIDE_IF_MODIFIED_SINCE, ACTION_STRING_IF_MODIFIED_SINCE)
218 DEFINE_CGI_PARAM_RADIO ("hide-if-modified-since", ACTION_HIDE_IF_MODIFIED_SINCE, ACTION_STRING_IF_MODIFIED_SINCE, "block", 0)
219 DEFINE_CGI_PARAM_CUSTOM ("hide-if-modified-since", ACTION_HIDE_IF_MODIFIED_SINCE, ACTION_STRING_IF_MODIFIED_SINCE, "-1")
220 DEFINE_ACTION_STRING ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER)
221 DEFINE_CGI_PARAM_RADIO ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "conditional-forge", 3)
222 DEFINE_CGI_PARAM_RADIO ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "conditional-block", 2)
223 DEFINE_CGI_PARAM_RADIO ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "forge", 1)
224 DEFINE_CGI_PARAM_RADIO ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "block", 0)
225 DEFINE_CGI_PARAM_CUSTOM ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "http://www.privoxy.org/")
226 DEFINE_ACTION_STRING ("hide-user-agent", ACTION_HIDE_USER_AGENT, ACTION_STRING_USER_AGENT)
227 DEFINE_CGI_PARAM_NO_RADIO("hide-user-agent", ACTION_HIDE_USER_AGENT, ACTION_STRING_USER_AGENT, "Privoxy " VERSION)
228 DEFINE_ACTION_BOOL ("inspect-jpegs", ACTION_JPEG_INSPECT)
229 DEFINE_ACTION_STRING ("limit-connect", ACTION_LIMIT_CONNECT, ACTION_STRING_LIMIT_CONNECT)
230 DEFINE_CGI_PARAM_NO_RADIO("limit-connect", ACTION_LIMIT_CONNECT, ACTION_STRING_LIMIT_CONNECT, "443")
231 DEFINE_ACTION_STRING ("overwrite-last-modified", ACTION_OVERWRITE_LAST_MODIFIED, ACTION_STRING_LAST_MODIFIED)
232 DEFINE_CGI_PARAM_RADIO ("overwrite-last-modified", ACTION_OVERWRITE_LAST_MODIFIED, ACTION_STRING_LAST_MODIFIED, "block", 0)
233 DEFINE_CGI_PARAM_RADIO ("overwrite-last-modified", ACTION_OVERWRITE_LAST_MODIFIED, ACTION_STRING_LAST_MODIFIED, "reset-to-request-time", 1)
234 DEFINE_CGI_PARAM_RADIO ("overwrite-last-modified", ACTION_OVERWRITE_LAST_MODIFIED, ACTION_STRING_LAST_MODIFIED, "randomize", 2)
235 DEFINE_ACTION_BOOL ("prevent-compression", ACTION_NO_COMPRESSION)
236 DEFINE_ACTION_STRING ("redirect", ACTION_REDIRECT, ACTION_STRING_REDIRECT)
237 DEFINE_CGI_PARAM_NO_RADIO("redirect", ACTION_REDIRECT, ACTION_STRING_REDIRECT, "http://localhost/")
238 DEFINE_ACTION_BOOL ("send-vanilla-wafer", ACTION_VANILLA_WAFER)
239 DEFINE_ACTION_MULTI ("send-wafer", ACTION_MULTI_WAFER)
240 DEFINE_ACTION_MULTI ("server-header-filter", ACTION_MULTI_SERVER_HEADER_FILTER)
241 DEFINE_ACTION_MULTI ("server-header-tagger", ACTION_MULTI_SERVER_HEADER_TAGGER)
242 DEFINE_ACTION_BOOL ("session-cookies-only", ACTION_NO_COOKIE_KEEP)
243 DEFINE_ACTION_STRING ("set-image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER)
244 DEFINE_CGI_PARAM_RADIO ("set-image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER, "pattern", 1)
245 DEFINE_CGI_PARAM_RADIO ("set-image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER, "blank", 0)
246 DEFINE_CGI_PARAM_CUSTOM ("set-image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER, CGI_PREFIX "send-banner?type=pattern")
248 #if DEFINE_ACTION_ALIAS
251 * Alternative spellings
253 DEFINE_ACTION_STRING ("hide-referer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER)
254 DEFINE_ACTION_BOOL ("prevent-keeping-cookies", ACTION_NO_COOKIE_KEEP)
257 * Pre-3.0.7 (pseudo) compatibility
259 DEFINE_ACTION_MULTI ("filter-client-headers", ACTION_MULTI_CLIENT_HEADER_FILTER)
260 DEFINE_ACTION_MULTI ("filter-server-headers", ACTION_MULTI_SERVER_HEADER_FILTER)
263 * Pre-3.0 compatibility
265 DEFINE_ACTION_BOOL ("no-cookie-read", ACTION_NO_COOKIE_READ)
266 DEFINE_ACTION_BOOL ("no-cookie-set", ACTION_NO_COOKIE_SET)
267 DEFINE_ACTION_BOOL ("prevent-reading-cookies", ACTION_NO_COOKIE_READ)
268 DEFINE_ACTION_BOOL ("prevent-setting-cookies", ACTION_NO_COOKIE_SET)
269 DEFINE_ACTION_BOOL ("downgrade", ACTION_DOWNGRADE)
270 DEFINE_ACTION_BOOL ("hide-forwarded", ACTION_HIDE_FORWARDED)
271 DEFINE_ACTION_STRING ("hide-from", ACTION_HIDE_FROM, ACTION_STRING_FROM)
272 DEFINE_ACTION_BOOL ("image", ACTION_IMAGE)
273 DEFINE_ACTION_STRING ("image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER)
274 DEFINE_ACTION_BOOL ("no-compression", ACTION_NO_COMPRESSION)
275 DEFINE_ACTION_BOOL ("no-cookies-keep", ACTION_NO_COOKIE_KEEP)
276 DEFINE_ACTION_BOOL ("no-cookies-read", ACTION_NO_COOKIE_READ)
277 DEFINE_ACTION_BOOL ("no-cookies-set", ACTION_NO_COOKIE_SET)
278 DEFINE_ACTION_BOOL ("vanilla-wafer", ACTION_VANILLA_WAFER)
279 DEFINE_ACTION_MULTI ("wafer", ACTION_MULTI_WAFER)
280 #endif /* if DEFINE_ACTION_ALIAS */
282 #undef DEFINE_ACTION_MULTI
283 #undef DEFINE_ACTION_STRING
284 #undef DEFINE_ACTION_BOOL
285 #undef DEFINE_ACTION_ALIAS
286 #undef DEFINE_CGI_PARAM_CUSTOM
287 #undef DEFINE_CGI_PARAM_RADIO
288 #undef DEFINE_CGI_PARAM_NO_RADIO