Indentation, CRLF->LF, Tab-> Space
[privoxy.git] / showargs.c
1 const char showargs_rcs[] = "$Id: showargs.c,v 1.16 2001/06/29 13:35:07 oes Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/showargs.c,v $
5  *
6  * Purpose     :  Contains various utility routines needed to 
7  *                generate the show-proxy-args page.
8  *                FIXME: Is this really stuff for a separate file?
9  *
10  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
11  *                IJBSWA team.  http://ijbswa.sourceforge.net
12  *
13  *                Based on the Internet Junkbuster originally written
14  *                by and Copyright (C) 1997 Anonymous Coders and 
15  *                Junkbusters Corporation.  http://www.junkbusters.com
16  *
17  *                This program is free software; you can redistribute it 
18  *                and/or modify it under the terms of the GNU General
19  *                Public License as published by the Free Software
20  *                Foundation; either version 2 of the License, or (at
21  *                your option) any later version.
22  *
23  *                This program is distributed in the hope that it will
24  *                be useful, but WITHOUT ANY WARRANTY; without even the
25  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
26  *                PARTICULAR PURPOSE.  See the GNU General Public
27  *                License for more details.
28  *
29  *                The GNU General Public License should be included with
30  *                this file.  If not, you can view it at
31  *                http://www.gnu.org/copyleft/gpl.html
32  *                or write to the Free Software Foundation, Inc., 59
33  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
34  *
35  * Revisions   :
36  *    $Log: showargs.c,v $
37  *    Revision 1.16  2001/06/29 13:35:07  oes
38  *    - Adapted
39  *    - Improved comments
40  *    - Removed init_proxy_args
41  *    - Renamed end_proxy_args(csp) to show_rcs(void)
42  *    - Removed logentry from cancelled commit
43  *    - Destroyed support for ndef SPLIT_PROXY_ARGS (Ooops)
44  *    - Separated the #define list into show_defines()
45  *
46  *    Revision 1.15  2001/06/09 10:55:28  jongfoster
47  *    Changing BUFSIZ ==> BUFFER_SIZE
48  *
49  *    Revision 1.14  2001/06/07 23:15:40  jongfoster
50  *    Removing config->proxy_args_gateways
51  *    Missing return statement added to end_proxy_args().
52  *
53  *    Revision 1.13  2001/06/06 09:37:59  sarantis
54  *    Fix misplaced comment start.
55  *
56  *    Revision 1.12  2001/06/04 10:41:52  swa
57  *    show version string of cgi.h and cgi.c
58  *
59  *    Revision 1.11  2001/06/03 11:03:48  oes
60  *    moved stuff to cgi.c
61  *
62  *    Revision 1.10  2001/05/31 21:36:07  jongfoster
63  *    Added RCS for actions.[ch] and list.[ch]
64  *
65  *    Revision 1.9  2001/05/29 23:11:38  oes
66  *
67  *     - Moved strsav() from showargs to miscutil
68  *
69  *    Revision 1.8  2001/05/29 09:50:24  jongfoster
70  *    Unified blocklist/imagelist/permissionslist.
71  *    File format is still under discussion, but the internal changes
72  *    are (mostly) done.
73  *
74  *    Also modified interceptor behaviour:
75  *    - We now intercept all URLs beginning with one of the following
76  *      prefixes (and *only* these prefixes):
77  *        * http://i.j.b/
78  *        * http://ijbswa.sf.net/config/
79  *        * http://ijbswa.sourceforge.net/config/
80  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
81  *    - Internal changes so that intercepted and fast redirect pages
82  *      are not replaced with an image.
83  *    - Interceptors now have the option to send a binary page direct
84  *      to the client. (i.e. ijb-send-banner uses this)
85  *    - Implemented show-url-info interceptor.  (Which is why I needed
86  *      the above interceptors changes - a typical URL is
87  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
88  *      The previous mechanism would not have intercepted that, and
89  *      if it had been intercepted then it then it would have replaced
90  *      it with an image.)
91  *
92  *    Revision 1.7  2001/05/26 00:28:36  jongfoster
93  *    Automatic reloading of config file.
94  *    Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
95  *    Most of the global variables have been moved to a new
96  *    struct configuration_spec, accessed through csp->config->globalname
97  *    Most of the globals remaining are used by the Win32 GUI.
98  *
99  *    Revision 1.6  2001/05/25 22:32:56  jongfoster
100  *    CRLF->LF
101  *
102  *    Revision 1.5  2001/05/22 18:54:49  oes
103  *
104  *    - Enabled filtering banners by size rather than URL
105  *      by adding patterns that replace all standard banner
106  *      sizes with the "Junkbuster" gif to the re_filterfile
107  *
108  *    - Enabled filtering WebBugs by providing a pattern
109  *      which kills all 1x1 images
110  *
111  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
112  *      which is selected by the (nonstandard and therefore
113  *      capital) letter 'U' in the option string.
114  *      It causes the quantifiers to be ungreedy by default.
115  *      Appending a ? turns back to greedy (!).
116  *
117  *    - Added a new interceptor ijb-send-banner, which
118  *      sends back the "Junkbuster" gif. Without imagelist or
119  *      MSIE detection support, or if tinygif = 1, or the
120  *      URL isn't recognized as an imageurl, a lame HTML
121  *      explanation is sent instead.
122  *
123  *    - Added new feature, which permits blocking remote
124  *      script redirects and firing back a local redirect
125  *      to the browser.
126  *      The feature is conditionally compiled, i.e. it
127  *      can be disabled with --disable-fast-redirects,
128  *      plus it must be activated by a "fast-redirects"
129  *      line in the config file, has its own log level
130  *      and of course wants to be displayed by show-proxy-args
131  *      Note: Boy, all the #ifdefs in 1001 locations and
132  *      all the fumbling with configure.in and acconfig.h
133  *      were *way* more work than the feature itself :-(
134  *
135  *    - Because a generic redirect template was needed for
136  *      this, tinygif = 3 now uses the same.
137  *
138  *    - Moved GIFs, and other static HTTP response templates
139  *      to project.h
140  *
141  *    - Some minor fixes
142  *
143  *    - Removed some >400 CRs again (Jon, you really worked
144  *      a lot! ;-)
145  *
146  *    Revision 1.4  2001/05/20 16:44:47  jongfoster
147  *    Removing last hardcoded JunkBusters.com URLs.
148  *
149  *    Revision 1.3  2001/05/20 01:21:20  jongfoster
150  *    Version 2.9.4 checkin.
151  *    - Merged popupfile and cookiefile, and added control over PCRS
152  *      filtering, in new "permissionsfile".
153  *    - Implemented LOG_LEVEL_FATAL, so that if there is a configuration
154  *      file error you now get a message box (in the Win32 GUI) rather
155  *      than the program exiting with no explanation.
156  *    - Made killpopup use the PCRS MIME-type checking and HTTP-header
157  *      skipping.
158  *    - Removed tabs from "config"
159  *    - Moved duplicated url parsing code in "loaders.c" to a new funcition.
160  *    - Bumped up version number.
161  *
162  *    Revision 1.2  2001/05/17 23:01:01  oes
163  *     - Cleaned CRLF's from the sources and related files
164  *
165  *    Revision 1.1.1.1  2001/05/15 13:59:03  oes
166  *    Initial import of version 2.9.3 source tree
167  *
168  *
169  *********************************************************************/
170 \f
171 #include "config.h"
172
173 #include <stdio.h>
174 #include <stdlib.h>
175 #include <sys/types.h>
176 #include <string.h>
177 #include <malloc.h>
178 #include <errno.h>
179
180 #include "project.h"
181 #include "showargs.h"
182 #include "jcc.h"
183 #include "encode.h"
184 #include "parsers.h"
185 #include "errlog.h"
186 #include "miscutil.h"
187 #include "gateway.h"
188
189 const char showargs_h_rcs[] = SHOWARGS_H_VERSION;
190
191
192 /*********************************************************************
193  *
194  * Function    :  savearg
195  *
196  * Description :  Called from `load_config'.  It saves each non-empty
197  *                and non-comment line from config into a list.  This
198  *                list is used to create the show-proxy-args page.
199  *
200  * Parameters  :
201  *          1  :  c = config setting that was found
202  *          2  :  o = the setting's argument (if any)
203  *
204  * Returns     :  N/A
205  *
206  *********************************************************************/
207 void savearg(char *c, char *o, struct configuration_spec * config)
208 {
209    char buf[BUFFER_SIZE];
210
211    *buf = '\0';
212
213    if ( ( NULL != c ) && ( '\0' != *c ) )
214    {
215       if ((c = html_encode(c)))
216       {
217          sprintf(buf, "<a href=\"" REDIRECT_URL "option#%s\">%s</a> ", c, c);
218       }
219       freez(c);
220    }
221    if ( ( NULL != o ) && ( '\0' != *o ) )
222    {
223       if ((o = html_encode(o)))
224       {
225          if (strncmpic(o, "http://", 7) == 0)
226          {
227             strcat(buf, "<a href=\"");
228             strcat(buf, o);
229             strcat(buf, "\">");
230             strcat(buf, o);
231             strcat(buf, "</a>");
232          }
233          else
234          {
235             strcat(buf, o);
236          }
237       }
238       freez(o);
239    }
240
241    strcat(buf, "<br>\n");
242
243    config->proxy_args = strsav(config->proxy_args, buf);
244
245 }
246
247
248 /*********************************************************************
249  *
250  * Function    :  show_rcs
251  *
252  * Description :  Create a string with the rcs info for all sourcefiles
253  *
254  * Parameters  :  None
255  *
256  * Returns     :  string 
257  *
258  *********************************************************************/
259 char *show_rcs(void)
260 {
261    char *b = NULL;
262    char buf[BUFFER_SIZE];
263
264    /* Instead of including *all* dot h's in the project (thus creating a
265     * tremendous amount of dependencies), I will concede to declaring them
266     * as extern's.  This forces the developer to add to this list, but oh well.
267     */
268
269 #define SHOW_RCS(__x)            \
270    {                             \
271       extern const char __x[];   \
272       sprintf(buf, "%s\n", __x); \
273       b = strsav(b, buf);        \
274    }
275
276    /* In alphabetical order */
277    SHOW_RCS(actions_h_rcs)
278    SHOW_RCS(actions_rcs)
279    SHOW_RCS(cgi_h_rcs)
280    SHOW_RCS(cgi_rcs)
281 #ifdef __MINGW32__
282    SHOW_RCS(cygwin_h_rcs)
283 #endif
284    SHOW_RCS(encode_h_rcs)
285    SHOW_RCS(encode_rcs)
286    SHOW_RCS(errlog_h_rcs)
287    SHOW_RCS(errlog_rcs)
288    SHOW_RCS(filters_h_rcs)
289    SHOW_RCS(filters_rcs)
290    SHOW_RCS(gateway_h_rcs)
291    SHOW_RCS(gateway_rcs)
292 #ifdef GNU_REGEX
293    SHOW_RCS(gnu_regex_h_rcs)
294    SHOW_RCS(gnu_regex_rcs)
295 #endif /* def GNU_REGEX */
296    SHOW_RCS(jbsockets_h_rcs)
297    SHOW_RCS(jbsockets_rcs)
298    SHOW_RCS(jcc_h_rcs)
299    SHOW_RCS(jcc_rcs)
300 #ifdef KILLPOPUPS
301    SHOW_RCS(killpopup_h_rcs)
302    SHOW_RCS(killpopup_rcs)
303 #endif /* def KILLPOPUPS */
304    SHOW_RCS(list_h_rcs)
305    SHOW_RCS(list_rcs)
306    SHOW_RCS(loadcfg_h_rcs)
307    SHOW_RCS(loadcfg_rcs)
308    SHOW_RCS(loaders_h_rcs)
309    SHOW_RCS(loaders_rcs)
310    SHOW_RCS(miscutil_h_rcs)
311    SHOW_RCS(miscutil_rcs)
312    SHOW_RCS(parsers_h_rcs)
313    SHOW_RCS(parsers_rcs)
314 #ifdef PCRS
315    SHOW_RCS(pcrs_rcs)
316    SHOW_RCS(pcrs_h_rcs)
317 #endif /* def PCRS */
318    SHOW_RCS(project_h_rcs)
319    SHOW_RCS(showargs_h_rcs)
320    SHOW_RCS(showargs_rcs)
321    SHOW_RCS(ssplit_h_rcs)
322    SHOW_RCS(ssplit_rcs)
323 #ifdef _WIN32
324 #ifndef _WIN_CONSOLE
325    SHOW_RCS(w32log_h_rcs)
326    SHOW_RCS(w32log_rcs)
327    SHOW_RCS(w32res_h_rcs)
328    SHOW_RCS(w32rulesdlg_h_rcs)
329    SHOW_RCS(w32rulesdlg_rcs)
330    SHOW_RCS(w32taskbar_h_rcs)
331    SHOW_RCS(w32taskbar_rcs)
332 #endif /* ndef _WIN_CONSOLE */
333    SHOW_RCS(win32_h_rcs)
334    SHOW_RCS(win32_rcs)
335 #endif /* def _WIN32 */
336
337 #undef SHOW_RCS
338
339    return(b);
340 }
341
342 /*********************************************************************
343  *
344  * Function    :  show_defines
345  *
346  * Description :  Create a string with all conditional #defines used
347  *                when building
348  *
349  * Parameters  :  None
350  *
351  * Returns     :  string 
352  *
353  *********************************************************************/
354 char *show_defines(void)
355 {
356    char *b = NULL;
357
358 #ifdef REGEX
359    b = strsav(b, "  <li><code>#define <b>REGEX</b></code> - Support for regular expressions in the path specs.</li>\n");
360 #else /* ifndef REGEX */
361    b = strsav(b, "  <li><code>#undef <b>REGEX</b></code> - No support for regular expressions in the path specs.</li>\n");
362 #endif /* ndef REGEX */
363
364 #ifdef PCRE
365    b = strsav(b, "  <li><code>#define <b>PCRE</b></code> - Use PCRE rather than old GNU regex library.</li>\n");
366 #else /* ifndef PCRE */
367    b = strsav(b, "  <li><code>#undef <b>PCRE</b></code> - Use old GNU regex library rather than PCRE.</li>\n");
368 #endif /* ndef PCRE */
369
370 #ifdef PCRS
371    b = strsav(b, "  <li><code>#define <b>PCRS</b></code> - Enables arbitrary content modification regexps.</li>\n");
372 #else /* ifndef PCRS */
373    b = strsav(b, "  <li><code>#undef <b>PCRS</b></code> - Disables arbitrary content modification regexps.</li>\n");
374 #endif /* ndef PCRS */
375
376 #ifdef TOGGLE
377    b = strsav(b, "  <li><code>#define <b>TOGGLE</b></code> - Allow JunkBuster to be \"disabled\" so it is just a normal non-blocking non-anonymizing proxy.</li>\n");
378 #else /* ifndef TOGGLE */
379    b = strsav(b, "  <li><code>#undef <b>TOGGLE</b></code> - Do not allow JunkBuster to be \"disabled\" so it is just a normal non-blocking non-anonymizing proxy.</li>\n");
380 #endif /* ndef TOGGLE */
381
382 #ifdef FORCE_LOAD
383    b = strsav(b, "  <li><code>#define <b>FORCE_LOAD</b></code> - Enables bypassing filtering for a single page using the prefix \"" FORCE_PREFIX "\".</li>\n");
384 #else /* ifndef FORCE_LOAD */
385    b = strsav(b, "  <li><code>#undef <b>FORCE_LOAD</b></code> - Disables bypassing filtering for a single page.</li>\n");
386 #endif /* ndef FORCE_LOAD */
387
388 #ifdef DENY_GZIP
389    b = strsav(b, "  <li><code>#define <b>DENY_GZIP</b></code> - Prevents requests from being compressed - required for PCRS.</li>\n");
390 #else /* ifndef DENY_GZIP */
391    b = strsav(b, "  <li><code>#undef <b>DENY_GZIP</b></code> - Allows requests to be compressed if the browser and server support it.</li>\n");
392 #endif /* ndef DENY_GZIP */
393
394 #ifdef STATISTICS
395    b = strsav(b, "  <li><code>#define <b>STATISTICS</b></code> - Enables statistics function.</li>\n");
396 #else /* ifndef STATISTICS */
397    b = strsav(b, "  <li><code>#undef <b>STATISTICS</b></code> - Disables statistics function.</li>\n");
398 #endif /* ndef STATISTICS */
399
400 #ifdef SPLIT_PROXY_ARGS
401    b = strsav(b, "  <li><code>#define <b>SPLIT_PROXY_ARGS</b></code> - Split this page up by placing the configuration files on separate pages.</li>\n");
402 #else /* ifndef SPLIT_PROXY_ARGS */
403    b = strsav(b, "  <li><code>#undef <b>SPLIT_PROXY_ARGS</b></code> - This page contains the text of the configuration files, they are not split onto separate pages.</li>\n");
404 #endif /* ndef SPLIT_PROXY_ARGS */
405
406 #ifdef KILLPOPUPS
407    b = strsav(b, "  <li><code>#define <b>KILLPOPUPS</b></code> - Enables killing JavaScript popups.</li>\n");
408 #else /* ifndef KILLPOPUPS */
409    b = strsav(b, "  <li><code>#undef <b>KILLPOPUPS</b></code> - Disables killing JavaScript popups.</li>\n");
410 #endif /* ndef KILLPOPUPS */
411
412 #ifdef WEBDAV
413    b = strsav(b, "  <li><code>#define <b>WEBDAV</b></code> - Enables support for webDAV - e.g. stops Microsoft Outlook from accessing HotMail e-mail.</li>\n");
414 #else /* ifndef WEBDAV */
415    b = strsav(b, "  <li><code>#undef <b>WEBDAV</b></code> - Disables support for webDAV - e.g. so Microsoft Outlook can access HotMail e-mail.</li>\n");
416 #endif /* ndef WEBDAV */
417
418 #ifdef DETECT_MSIE_IMAGES
419    b = strsav(b, "  <li><code>#define <b>DETECT_MSIE_IMAGES</b></code> - Enables detecting image requests automatically for MSIE.</li>\n");
420 #else /* ifndef DETECT_MSIE_IMAGES */
421    b = strsav(b, "  <li><code>#undef <b>DETECT_MSIE_IMAGES</b></code> - Disables detecting image requests automatically for MSIE.</li>\n");
422 #endif /* ndef DETECT_MSIE_IMAGES */
423
424 #ifdef IMAGE_BLOCKING
425    b = strsav(b, "  <li><code>#define <b>IMAGE_BLOCKING</b></code> - Enables sending \"blocked\" images instead of HTML.</li>\n");
426 #else /* ifndef IMAGE_BLOCKING */
427    b = strsav(b, "  <li><code>#undef <b>IMAGE_BLOCKING</b></code> - Disables sending \"blocked\" images instead of HTML.</li>\n");
428 #endif /* ndef IMAGE_BLOCKING */
429
430 #ifdef ACL_FILES
431    b = strsav(b, "  <li><code>#define <b>ACL_FILES</b></code> - Enables the use of ACL files to control access to the proxy by IP address.</li>\n");
432 #else /* ifndef ACL_FILES */
433    b = strsav(b, "  <li><code>#undef <b>ACL_FILES</b></code> - Disables the use of ACL files to control access to the proxy by IP address.</li>\n");
434 #endif /* ndef ACL_FILES */
435
436 #ifdef TRUST_FILES
437    b = strsav(b, "  <li><code>#define <b>TRUST_FILES</b></code> - Enables the use of trust files.</li>\n");
438 #else /* ifndef TRUST_FILES */
439    b = strsav(b, "  <li><code>#undef <b>TRUST_FILES</b></code> - Disables the use of trust files.</li>\n");
440 #endif /* ndef TRUST_FILES */
441
442 #ifdef JAR_FILES
443    b = strsav(b, "  <li><code>#define <b>JAR_FILES</b></code> - Enables the use of jar files to capture cookies.</li>\n");
444 #else /* ifndef JAR_FILES */
445    b = strsav(b, "  <li><code>#undef <b>JAR_FILES</b></code> - Disables the use of jar files to capture cookies.</li>\n");
446 #endif /* ndef JAR_FILES */
447
448 #ifdef FAST_REDIRECTS
449    b = strsav(b, "  <li><code>#define <b>FAST_REDIRECTS</b></code> - Enables intercepting remote script redirects.</li>\n");
450 #else /* ifndef FAST_REDIRECTS */
451    b = strsav(b, "  <li><code>#undef <b>FAST_REDIRECTS</b></code> - Disables intercepting remote script redirects.</li>\n");
452 #endif /* ndef FAST_REDIRECTS */
453
454    return b;
455 }
456
457
458 /*
459   Local Variables:
460   tab-width: 3
461   end:
462 */