1 #ifndef LOADERS_H_INCLUDED
2 #define LOADERS_H_INCLUDED
3 #define LOADERS_H_VERSION "$Id: loaders.h,v 1.23 2008/03/30 14:52:10 fabiankeil Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/loaders.h,v $
8 * Purpose : Functions to load and unload the various
9 * configuration files. Also contains code to manage
10 * the list of active loaders, and to automatically
11 * unload files that are no longer in use.
13 * Copyright : Written by and Copyright (C) 2001-2009 the
14 * Privoxy team. http://www.privoxy.org/
16 * Based on the Internet Junkbuster originally written
17 * by and Copyright (C) 1997 Anonymous Coders and
18 * Junkbusters Corporation. http://www.junkbusters.com
20 * This program is free software; you can redistribute it
21 * and/or modify it under the terms of the GNU General
22 * Public License as published by the Free Software
23 * Foundation; either version 2 of the License, or (at
24 * your option) any later version.
26 * This program is distributed in the hope that it will
27 * be useful, but WITHOUT ANY WARRANTY; without even the
28 * implied warranty of MERCHANTABILITY or FITNESS FOR A
29 * PARTICULAR PURPOSE. See the GNU General Public
30 * License for more details.
32 * The GNU General Public License should be included with
33 * this file. If not, you can view it at
34 * http://www.gnu.org/copyleft/gpl.html
35 * or write to the Free Software Foundation, Inc., 59
36 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
40 * Revision 1.23 2008/03/30 14:52:10 fabiankeil
41 * Rename load_actions_file() and load_re_filterfile()
42 * as they load multiple files "now".
44 * Revision 1.22 2007/06/01 14:12:38 fabiankeil
45 * Add unload_forward_spec() in preparation for forward-override{}.
47 * Revision 1.21 2006/07/18 14:48:46 david__schmidt
48 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
49 * with what was really the latest development (the v_3_0_branch branch)
51 * Revision 1.19 2002/03/26 22:29:55 swa
52 * we have a new homepage!
54 * Revision 1.18 2002/03/24 13:25:43 swa
55 * name change related issues
57 * Revision 1.17 2002/03/16 23:54:06 jongfoster
58 * Adding graceful termination feature, to help look for memory leaks.
59 * If you enable this (which, by design, has to be done by hand
60 * editing config.h) and then go to http://i.j.b/die, then the program
61 * will exit cleanly after the *next* request. It should free all the
62 * memory that was used.
64 * Revision 1.16 2002/03/07 03:46:17 oes
65 * Fixed compiler warnings
67 * Revision 1.15 2002/01/22 23:46:18 jongfoster
68 * Moving edit_read_line() and simple_read_line() to loaders.c, and
69 * extending them to support reading MS-DOS, Mac and UNIX style files
72 * Modifying read_config_line() (without changing it's prototype) to
73 * be a trivial wrapper for edit_read_line(). This means that we have
74 * one function to read a line and handle comments, which is common
75 * between the initialization code and the edit interface.
77 * Revision 1.14 2002/01/17 21:03:08 jongfoster
78 * Moving all our URL and URL pattern parsing code to urlmatch.c.
80 * Renaming free_url to free_url_spec, since it frees a struct url_spec.
82 * Revision 1.13 2001/12/30 14:07:32 steudten
83 * - Add signal handling (unix)
84 * - Add SIGHUP handler (unix)
85 * - Add creation of pidfile (unix)
86 * - Add action 'top' in rc file (RH)
87 * - Add entry 'SIGNALS' to manpage
88 * - Add exit message to logfile (unix)
90 * Revision 1.12 2001/11/07 00:02:13 steudten
91 * Add line number in error output for lineparsing for
92 * actionsfile and configfile.
93 * Special handling for CLF added.
95 * Revision 1.11 2001/10/23 21:38:53 jongfoster
96 * Adding error-checking to create_url_spec()
98 * Revision 1.10 2001/09/22 16:36:59 jongfoster
99 * Removing unused parameter fs from read_config_line()
101 * Revision 1.9 2001/07/30 22:08:36 jongfoster
102 * Tidying up #defines:
103 * - All feature #defines are now of the form FEATURE_xxx
104 * - Permanently turned off WIN_GUI_EDIT
105 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
107 * Revision 1.8 2001/07/29 18:58:15 jongfoster
108 * Removing nested #includes, adding forward declarations for needed
109 * structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
111 * Revision 1.7 2001/07/13 14:01:54 oes
112 * Removed all #ifdef PCRS
114 * Revision 1.6 2001/06/07 23:14:38 jongfoster
115 * Removing ACL and forward file loaders - these files have
116 * been merged into the config file.
118 * Revision 1.5 2001/05/31 21:28:49 jongfoster
119 * Removed all permissionsfile code - it's now called the actions
120 * file, and (almost) all the code is in actions.c
122 * Revision 1.4 2001/05/29 09:50:24 jongfoster
123 * Unified blocklist/imagelist/permissionslist.
124 * File format is still under discussion, but the internal changes
127 * Also modified interceptor behaviour:
128 * - We now intercept all URLs beginning with one of the following
129 * prefixes (and *only* these prefixes):
131 * * http://ijbswa.sf.net/config/
132 * * http://ijbswa.sourceforge.net/config/
133 * - New interceptors "home page" - go to http://i.j.b/ to see it.
134 * - Internal changes so that intercepted and fast redirect pages
135 * are not replaced with an image.
136 * - Interceptors now have the option to send a binary page direct
137 * to the client. (i.e. ijb-send-banner uses this)
138 * - Implemented show-url-info interceptor. (Which is why I needed
139 * the above interceptors changes - a typical URL is
140 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
141 * The previous mechanism would not have intercepted that, and
142 * if it had been intercepted then it then it would have replaced
145 * Revision 1.3 2001/05/26 00:28:36 jongfoster
146 * Automatic reloading of config file.
147 * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
148 * Most of the global variables have been moved to a new
149 * struct configuration_spec, accessed through csp->config->globalname
150 * Most of the globals remaining are used by the Win32 GUI.
152 * Revision 1.2 2001/05/20 01:21:20 jongfoster
153 * Version 2.9.4 checkin.
154 * - Merged popupfile and cookiefile, and added control over PCRS
155 * filtering, in new "permissionsfile".
156 * - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
157 * file error you now get a message box (in the Win32 GUI) rather
158 * than the program exiting with no explanation.
159 * - Made killpopup use the PCRS MIME-type checking and HTTP-header
161 * - Removed tabs from "config"
162 * - Moved duplicated url parsing code in "loaders.c" to a new funcition.
163 * - Bumped up version number.
165 * Revision 1.1.1.1 2001/05/15 13:59:00 oes
166 * Initial import of version 2.9.3 source tree
169 *********************************************************************/
176 /* Structures taken from project.h */
179 struct configuration_spec;
182 extern unsigned int sweep(void);
183 extern char *read_config_line(char *buf, size_t buflen, FILE *fp, unsigned long *linenum);
184 extern int check_file_changed(const struct file_list * current,
185 const char * filename,
186 struct file_list ** newfl);
188 extern jb_err edit_read_line(FILE *fp,
193 unsigned long *line_number);
195 extern jb_err simple_read_line(FILE *fp, char **dest, int *newline);
198 * Various types of newlines that a file may contain.
200 #define NEWLINE_UNKNOWN 0 /* Newline convention in file is unknown */
201 #define NEWLINE_UNIX 1 /* Newline convention in file is '\n' (ASCII 10) */
202 #define NEWLINE_DOS 2 /* Newline convention in file is '\r\n' (ASCII 13,10) */
203 #define NEWLINE_MAC 3 /* Newline convention in file is '\r' (ASCII 13) */
206 * Types of newlines that a file may contain, as strings. If you have an
207 * extremely wierd compiler that does not have '\r' == CR == ASCII 13 and
208 * '\n' == LF == ASCII 10), then fix CHAR_CR and CHAR_LF in loaders.c as
209 * well as these definitions.
211 #define NEWLINE(style) ((style)==NEWLINE_DOS ? "\r\n" : \
212 ((style)==NEWLINE_MAC ? "\r" : "\n"))
215 extern short int MustReload;
216 extern int load_action_files(struct client_state *csp);
217 extern int load_re_filterfiles(struct client_state *csp);
220 extern int load_trustfile(struct client_state *csp);
221 #endif /* def FEATURE_TRUST */
223 #ifdef FEATURE_GRACEFUL_TERMINATION
225 void unload_current_trust_file(void);
227 void unload_current_re_filterfile(void);
228 #endif /* FEATURE_GRACEFUL_TERMINATION */
230 void unload_forward_spec(struct forward_spec *fwd);
232 extern void add_loader(int (*loader)(struct client_state *),
233 struct configuration_spec * config);
234 extern int run_loader(struct client_state *csp);
236 /* Revision control strings from this header and associated .c file */
237 extern const char loaders_rcs[];
238 extern const char loaders_h_rcs[];
244 #endif /* ndef LOADERS_H_INCLUDED */