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 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.24 2007/03/20 15:16:34 fabiankeil
43 * Use dedicated header filter actions instead of abusing "filter".
44 * Replace "filter-client-headers" and "filter-client-headers"
45 * with "server-header-filter" and "client-header-filter".
47 * Revision 1.23 2006/10/09 10:26:18 fabiankeil
48 * Changed the path in set-image-blocker's redirection default to
49 * "send-banner?type=pattern" instead of "show-banner?type=pattern"
50 * which isn't caught by Privoxy. Fixes BR 1573468.
52 * Changed hide-user-agent's default value to "Privoxy VERSION".
54 * Changed hide-referrer's default fake value to "http://www.privoxy.org/".
55 * A static referrer is obviously fake anyway, so we might as well
56 * advertise ourselves.
58 * Revision 1.22 2006/09/01 17:14:18 hal9
59 * Re-ordered the actions list so that they display in the actions editor in
60 * alphabetical order. Some of the new actions were "out of order".
62 * Revision 1.21 2006/08/14 08:25:19 fabiankeil
63 * Split filter-headers{} into filter-client-headers{}
64 * and filter-server-headers{}.
65 * Added parse_header_time() to share some code.
66 * Replaced timegm() with mktime().
68 * Revision 1.20 2006/08/03 02:46:41 david__schmidt
69 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
71 * Revision 1.19 2006/07/18 14:48:45 david__schmidt
72 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
73 * with what was really the latest development (the v_3_0_branch branch)
75 * Revision 1.17.2.3 2004/10/03 12:53:32 david__schmidt
76 * Add the ability to check jpeg images for invalid
77 * lengths of comment blocks. Defensive strategy
78 * against the exploit:
79 * Microsoft Security Bulletin MS04-028
80 * Buffer Overrun in JPEG Processing (GDI+) Could
81 * Allow Code Execution (833987)
82 * Enabled with +inspect-jpegs in actions files.
84 * Revision 1.17.2.2 2002/09/25 15:25:25 oes
85 * Added more aliases for prehistoric action names
87 * Revision 1.17.2.1 2002/08/02 12:50:47 oes
88 * Consistency with docs: Change default name for action from hide-referer to hide-referrer
90 * Revision 1.17 2002/05/14 21:25:55 oes
91 * Renamed prevent-(setting/reading)-cookies to crunch-(incoming/outgoing)-cookies
93 * Revision 1.16 2002/04/24 02:15:18 oes
94 * Renamed actions as discussed, Aliased old action names to new ones.
96 * Revision 1.15 2002/03/26 22:29:54 swa
97 * we have a new homepage!
99 * Revision 1.14 2002/03/24 16:32:08 jongfoster
100 * Removing logo option
102 * Revision 1.13 2002/03/24 15:23:33 jongfoster
105 * Revision 1.12 2002/03/24 13:25:43 swa
106 * name change related issues
108 * Revision 1.11 2002/03/12 01:42:49 oes
109 * Introduced modular filters
111 * Revision 1.10 2002/03/08 18:19:14 jongfoster
112 * Adding +image-blocker{pattern} option to edit interface
114 * Revision 1.9 2001/11/22 21:58:41 jongfoster
115 * Adding action +no-cookies-keep
117 * Revision 1.8 2001/10/10 16:42:52 oes
118 * Fixed a bug, Added +limit-connect string action
120 * Revision 1.7 2001/10/07 15:33:59 oes
121 * Introduced a +no-compression action
122 * Introduced a +downgrade action
124 * Revision 1.6 2001/09/16 15:47:37 jongfoster
125 * First version of CGI-based edit interface. This is very much a
126 * work-in-progress, and you can't actually use it to edit anything
127 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
128 * to have any effect.
130 * Revision 1.5 2001/07/18 12:27:03 oes
131 * Changed deanimate-gifs to string action
133 * Revision 1.4 2001/07/13 13:52:12 oes
135 * - Introduced new action ACTION_DEANIMATE
137 * Revision 1.3 2001/06/07 23:03:56 jongfoster
138 * Added standard comment at top of file.
141 *********************************************************************/
144 #if !(defined(DEFINE_ACTION_BOOL) && defined(DEFINE_ACTION_MULTI) && defined(DEFINE_ACTION_STRING))
145 #error Please define lots of macros before including "actionlist.h".
146 #endif /* !defined(all the DEFINE_ACTION_xxx macros) */
148 #ifndef DEFINE_CGI_PARAM_RADIO
149 #define DEFINE_CGI_PARAM_RADIO(name, bit, index, value, is_default)
150 #define DEFINE_CGI_PARAM_CUSTOM(name, bit, index, default_val)
151 #define DEFINE_CGI_PARAM_NO_RADIO(name, bit, index, default_val)
152 #endif /* ndef DEFINE_CGI_PARAM_RADIO */
154 DEFINE_ACTION_MULTI ("add-header", ACTION_MULTI_ADD_HEADER)
155 DEFINE_ACTION_BOOL ("block", ACTION_BLOCK)
156 DEFINE_ACTION_MULTI ("client-header-filter", ACTION_MULTI_CLIENT_HEADER_FILTER)
157 DEFINE_ACTION_MULTI ("client-header-tagger", ACTION_MULTI_CLIENT_HEADER_TAGGER)
158 DEFINE_ACTION_STRING ("content-type-overwrite", ACTION_CONTENT_TYPE_OVERWRITE, ACTION_STRING_CONTENT_TYPE)
159 DEFINE_CGI_PARAM_NO_RADIO("content-type-overwrite", ACTION_CONTENT_TYPE_OVERWRITE, ACTION_STRING_CONTENT_TYPE, "text/html")
160 DEFINE_ACTION_STRING ("crunch-client-header", ACTION_CRUNCH_CLIENT_HEADER, ACTION_STRING_CLIENT_HEADER)
161 DEFINE_CGI_PARAM_NO_RADIO("crunch-client-header", ACTION_CRUNCH_CLIENT_HEADER, ACTION_STRING_CLIENT_HEADER, "X-Whatever:")
162 DEFINE_ACTION_BOOL ("crunch-if-none-match", ACTION_CRUNCH_IF_NONE_MATCH)
163 DEFINE_ACTION_BOOL ("crunch-incoming-cookies", ACTION_NO_COOKIE_SET)
164 DEFINE_ACTION_BOOL ("crunch-outgoing-cookies", ACTION_NO_COOKIE_READ)
165 DEFINE_ACTION_STRING ("crunch-server-header", ACTION_CRUNCH_SERVER_HEADER, ACTION_STRING_SERVER_HEADER)
166 DEFINE_CGI_PARAM_NO_RADIO("crunch-server-header", ACTION_CRUNCH_SERVER_HEADER, ACTION_STRING_SERVER_HEADER, "X-Whatever:")
167 DEFINE_ACTION_STRING ("deanimate-gifs", ACTION_DEANIMATE, ACTION_STRING_DEANIMATE)
168 DEFINE_CGI_PARAM_RADIO ("deanimate-gifs", ACTION_DEANIMATE, ACTION_STRING_DEANIMATE, "first", 0)
169 DEFINE_CGI_PARAM_RADIO ("deanimate-gifs", ACTION_DEANIMATE, ACTION_STRING_DEANIMATE, "last", 1)
170 DEFINE_ACTION_BOOL ("downgrade-http-version", ACTION_DOWNGRADE)
171 DEFINE_ACTION_STRING ("fast-redirects", ACTION_FAST_REDIRECTS, ACTION_STRING_FAST_REDIRECTS)
172 DEFINE_CGI_PARAM_RADIO ("fast-redirects", ACTION_FAST_REDIRECTS, ACTION_STRING_FAST_REDIRECTS, "simple-check", 0)
173 DEFINE_CGI_PARAM_RADIO ("fast-redirects", ACTION_FAST_REDIRECTS, ACTION_STRING_FAST_REDIRECTS, "check-decoded-url", 1)
174 DEFINE_ACTION_MULTI ("filter", ACTION_MULTI_FILTER)
175 DEFINE_ACTION_BOOL ("force-text-mode", ACTION_FORCE_TEXT_MODE)
176 DEFINE_ACTION_BOOL ("handle-as-empty-document", ACTION_HANDLE_AS_EMPTY_DOCUMENT)
177 DEFINE_ACTION_BOOL ("handle-as-image", ACTION_IMAGE)
178 DEFINE_ACTION_STRING ("hide-accept-language", ACTION_HIDE_ACCEPT_LANGUAGE, ACTION_STRING_LANGUAGE)
179 DEFINE_CGI_PARAM_RADIO ("hide-accept-language", ACTION_HIDE_ACCEPT_LANGUAGE, ACTION_STRING_LANGUAGE, "block", 0)
180 DEFINE_CGI_PARAM_CUSTOM ("hide-accept-language", ACTION_HIDE_ACCEPT_LANGUAGE, ACTION_STRING_LANGUAGE, "de-de")
181 DEFINE_ACTION_STRING ("hide-content-disposition", ACTION_HIDE_CONTENT_DISPOSITION, ACTION_STRING_CONTENT_DISPOSITION)
182 DEFINE_CGI_PARAM_RADIO ("hide-content-disposition", ACTION_HIDE_CONTENT_DISPOSITION, ACTION_STRING_CONTENT_DISPOSITION, "block", 0)
183 DEFINE_CGI_PARAM_CUSTOM ("hide-content-disposition", ACTION_HIDE_CONTENT_DISPOSITION, ACTION_STRING_CONTENT_DISPOSITION, "attachment; filename=WHATEVER.txt")
184 DEFINE_ACTION_BOOL ("hide-forwarded-for-headers", ACTION_HIDE_FORWARDED)
185 DEFINE_ACTION_STRING ("hide-from-header", ACTION_HIDE_FROM, ACTION_STRING_FROM)
186 DEFINE_CGI_PARAM_RADIO ("hide-from-header", ACTION_HIDE_FROM, ACTION_STRING_FROM, "block", 1)
187 DEFINE_CGI_PARAM_CUSTOM ("hide-from-header", ACTION_HIDE_FROM, ACTION_STRING_FROM, "spam_me_senseless@sittingduck.xyz")
188 DEFINE_ACTION_STRING ("hide-if-modified-since", ACTION_HIDE_IF_MODIFIED_SINCE, ACTION_STRING_IF_MODIFIED_SINCE)
189 DEFINE_CGI_PARAM_RADIO ("hide-if-modified-since", ACTION_HIDE_IF_MODIFIED_SINCE, ACTION_STRING_IF_MODIFIED_SINCE, "block", 0)
190 DEFINE_CGI_PARAM_CUSTOM ("hide-if-modified-since", ACTION_HIDE_IF_MODIFIED_SINCE, ACTION_STRING_IF_MODIFIED_SINCE, "-1")
191 DEFINE_ACTION_STRING ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER)
192 DEFINE_CGI_PARAM_RADIO ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "conditional-block", 2)
193 DEFINE_CGI_PARAM_RADIO ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "forge", 1)
194 DEFINE_CGI_PARAM_RADIO ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "block", 0)
195 DEFINE_CGI_PARAM_CUSTOM ("hide-referrer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER, "http://www.privoxy.org/")
196 DEFINE_ACTION_STRING ("hide-user-agent", ACTION_HIDE_USER_AGENT, ACTION_STRING_USER_AGENT)
197 DEFINE_CGI_PARAM_NO_RADIO("hide-user-agent", ACTION_HIDE_USER_AGENT, ACTION_STRING_USER_AGENT, "Privoxy " VERSION)
198 DEFINE_ACTION_BOOL ("inspect-jpegs", ACTION_JPEG_INSPECT)
199 DEFINE_ACTION_BOOL ("kill-popups", ACTION_NO_POPUPS)
200 DEFINE_ACTION_STRING ("limit-connect", ACTION_LIMIT_CONNECT, ACTION_STRING_LIMIT_CONNECT)
201 DEFINE_CGI_PARAM_NO_RADIO("limit-connect", ACTION_LIMIT_CONNECT, ACTION_STRING_LIMIT_CONNECT, "443")
202 DEFINE_ACTION_STRING ("overwrite-last-modified", ACTION_OVERWRITE_LAST_MODIFIED, ACTION_STRING_LAST_MODIFIED)
203 DEFINE_CGI_PARAM_RADIO ("overwrite-last-modified", ACTION_OVERWRITE_LAST_MODIFIED, ACTION_STRING_LAST_MODIFIED, "block", 0)
204 DEFINE_CGI_PARAM_RADIO ("overwrite-last-modified", ACTION_OVERWRITE_LAST_MODIFIED, ACTION_STRING_LAST_MODIFIED, "reset-to-request-time", 1)
205 DEFINE_CGI_PARAM_RADIO ("overwrite-last-modified", ACTION_OVERWRITE_LAST_MODIFIED, ACTION_STRING_LAST_MODIFIED, "randomize", 2)
206 DEFINE_ACTION_BOOL ("prevent-compression", ACTION_NO_COMPRESSION)
207 DEFINE_ACTION_STRING ("redirect", ACTION_REDIRECT, ACTION_STRING_REDIRECT)
208 DEFINE_CGI_PARAM_NO_RADIO("redirect", ACTION_REDIRECT, ACTION_STRING_REDIRECT, "http://localhost/")
209 DEFINE_ACTION_BOOL ("send-vanilla-wafer", ACTION_VANILLA_WAFER)
210 DEFINE_ACTION_MULTI ("send-wafer", ACTION_MULTI_WAFER)
211 DEFINE_ACTION_MULTI ("server-header-filter", ACTION_MULTI_SERVER_HEADER_FILTER)
212 DEFINE_ACTION_MULTI ("server-header-tagger", ACTION_MULTI_SERVER_HEADER_TAGGER)
213 DEFINE_ACTION_BOOL ("session-cookies-only", ACTION_NO_COOKIE_KEEP)
214 DEFINE_ACTION_STRING ("set-image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER)
215 DEFINE_CGI_PARAM_RADIO ("set-image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER, "pattern", 1)
216 DEFINE_CGI_PARAM_RADIO ("set-image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER, "blank", 0)
217 DEFINE_CGI_PARAM_CUSTOM ("set-image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER, CGI_PREFIX "send-banner?type=pattern")
218 DEFINE_ACTION_BOOL ("treat-forbidden-connects-like-blocks", ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS)
221 #if DEFINE_ACTION_ALIAS
224 * Alternative spellings
226 DEFINE_ACTION_BOOL ("kill-popup", ACTION_NO_POPUPS)
227 DEFINE_ACTION_STRING ("hide-referer", ACTION_HIDE_REFERER, ACTION_STRING_REFERER)
228 DEFINE_ACTION_BOOL ("prevent-keeping-cookies", ACTION_NO_COOKIE_KEEP)
231 * Pre-3.0.7 (pseudo) compatibility
233 DEFINE_ACTION_MULTI ("filter-client-headers", ACTION_MULTI_CLIENT_HEADER_FILTER)
234 DEFINE_ACTION_MULTI ("filter-server-headers", ACTION_MULTI_SERVER_HEADER_FILTER)
237 * Pre-3.0 compatibility
239 DEFINE_ACTION_BOOL ("no-cookie-read", ACTION_NO_COOKIE_READ)
240 DEFINE_ACTION_BOOL ("no-cookie-set", ACTION_NO_COOKIE_SET)
241 DEFINE_ACTION_BOOL ("prevent-reading-cookies", ACTION_NO_COOKIE_READ)
242 DEFINE_ACTION_BOOL ("prevent-setting-cookies", ACTION_NO_COOKIE_SET)
243 DEFINE_ACTION_BOOL ("downgrade", ACTION_DOWNGRADE)
244 DEFINE_ACTION_BOOL ("hide-forwarded", ACTION_HIDE_FORWARDED)
245 DEFINE_ACTION_STRING ("hide-from", ACTION_HIDE_FROM, ACTION_STRING_FROM)
246 DEFINE_ACTION_BOOL ("image", ACTION_IMAGE)
247 DEFINE_ACTION_STRING ("image-blocker", ACTION_IMAGE_BLOCKER, ACTION_STRING_IMAGE_BLOCKER)
248 DEFINE_ACTION_BOOL ("no-compression", ACTION_NO_COMPRESSION)
249 DEFINE_ACTION_BOOL ("no-cookies-keep", ACTION_NO_COOKIE_KEEP)
250 DEFINE_ACTION_BOOL ("no-cookies-read", ACTION_NO_COOKIE_READ)
251 DEFINE_ACTION_BOOL ("no-cookies-set", ACTION_NO_COOKIE_SET)
252 DEFINE_ACTION_BOOL ("no-popups", ACTION_NO_POPUPS)
253 DEFINE_ACTION_BOOL ("vanilla-wafer", ACTION_VANILLA_WAFER)
254 DEFINE_ACTION_MULTI ("wafer", ACTION_MULTI_WAFER)
255 #endif /* if DEFINE_ACTION_ALIAS */
257 #undef DEFINE_ACTION_MULTI
258 #undef DEFINE_ACTION_STRING
259 #undef DEFINE_ACTION_BOOL
260 #undef DEFINE_ACTION_ALIAS
261 #undef DEFINE_CGI_PARAM_CUSTOM
262 #undef DEFINE_CGI_PARAM_RADIO
263 #undef DEFINE_CGI_PARAM_NO_RADIO