summaryrefslogtreecommitdiffstats
path: root/src/privoxytemplates/show-status
blob: 7108722c22c99df2a15f270f316eade48a5acf52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
##########################################################
#
# Show-Status-CGI Output template for Privoxy.
#
# USING HTML TEMPLATES:
# ---------------------
#
# Template files are written win plain HTML, with a few
# additions:
# 
# - Lines that start with a '#' character like this one
#   are ignored
#
# - Each item in the below list of exported symbols will
#   be replaced by dynamically generated text, if they
#   are enclosed in '@'-characters. E.g. The string @version@
#   will be replaced by the version number of Privoxy.
#
# - One special application of this is to make whole blocks
#   of the HTML template disappear if the condition <name>
#   is not given. Simply enclose the block between the two
#   strings @if-<name>start and if-<name>-end@. The strings
#   should be placed in HTML comments (<!-- -->), so the
#   html structure won't be messed when the magic happens.
#   
# USABLE SYMBOLS IN THIS TEMPLATE:
# --------------------------------
#
#  my-ip-addr:
#    The IP-address that the client used to reach this proxy
#  my-hostname:
#    The hostname associated with my-ip-addr
#  admin-address:
#    The email address of the pxoxy's administrator, as configured
#    in the config file
#  default-cgi:
#    The URL for the "main menu" builtin CGI of this proxy
#  menu:
#    List of <li> elements linking to the other available CGIs
#  version:
#    The version number of the proxy software
#  code-status:
#    The development status of the proxy software: "alpha", "beta",
#    or "stable".
#  homepage:
#    The URL of the SourceForge ijbswa project, who maintains this
#    software.
#
#  redirect-url:
#    The URL to a script that will redirect to the Privoxy
#    documentation for a given item  
#  invocation:
#    The command line with whitch Privoxy was invoked
#  options:
#    The options read from the configfile, linked to their
#    explanations, plus warnings if parsing acl or forward
#    statements produced errors.
#  sourceversions:
#    A HTML-formatted list of the individual source file cvs versions
#  defines:
#    A HTML-formatted list of all conditional #defines used when
#    Privoxy was compiled
#
#  
# CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
# ------------------------------------------------------------------
#
#  unstable:
#    This is an alpha or beta release of the proxy software
#  have-adminaddr-info:
#    An e-mail address for the local Privoxy adminstrator has
#    been specified and is available through the "admin-address"
#    symbol
#  have-proxy-info:
#    A URL for online documentation about this proxy has been
#    specified and is available through the "proxy-info-url"
#    symbol
#  have-help-info:
#    If either have-proxy-info is true or have-adminaddr-info is
#    true, have-help-info is true.  Used to conditionally include
#    a grey box for any and all help info.
#  statistics:
#    Privoxy was compiled with statistics support
#  have-stats:
#    There have been previous requests and statistics have
#    been collected. In this case, the following symbols
#    are available:
#    requests-received:
#      The number of requests received so far
#    requests-blocked:
#      The number of request blocked so far
#    percent-blocked:
#      The percentage of blocked requests
#  have-no-stats:
#    There haven't any statistics been collected yet
#  pcrs-support:
#    Privoxy was compiled with pcrs support
#  trust-support:
#    Privoxy was compiled with trust support
#  actions-filename:
#    The path to the actions file.
#  re-filter-filename:
#    The path to the re_filter file. Only available if
#    pcrs-support is set
#  trust-filename:
#    The path to the trust file.Only available if
#    trust-support is set
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>

<head>
  <title>Privoxy@@my-hostname@: Proxy Status</title>
  <meta http-equiv="Content-Style-Type" content="text/css">
  <meta http-equiv="Content-Script-Type" content="text/javascript">
  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  <meta name="robots" content="noindex,nofollow">
  <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
</head>

<body>

  <table cellpadding="20" cellspacing="10" border="0" width="100%">
    <tr>
      <td class="title">

#include mod-title

      </td>
    </tr>

<!-- @if-unstable-start -->
# This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
    <tr>
      <td class="warning">

#include mod-unstable-warning

      </td>
    </tr>
<!-- if-unstable-end@ -->

    <tr>
      <td class="box">
        <h2>The program was invoked as follows</h2>
        <p>@invocation@</p>
      </td>
    </tr>

    <tr>
      <td class="box">
        <h2>The following options were given in the config file:</h2>
        <p>@options@</p>
      </td>
    </tr>

<!-- @if-statistics-start -->
    <tr>
      <td class="box">
        <h2>Blocking Statistics:</h2>
        <p>
  <!-- @if-have-stats-start -->
          @requests-blocked@ out of @requests-received@ requests have been blocked,
          which equals a block rate of @percent-blocked@%.
<!-- if-have-stats-end@ -->
<!-- @if-have-no-stats-start -->
          There haven't been any requests so far.
<!-- if-have-no-stats-end@ -->
        </p>                                   
      </td>
    </tr>
<!-- if-statistics-end@ -->

    <tr>
      <td class="box">
        <h2>The following files are in use:</h2>
        <p>Click a filename to browse</p>
        <ul>
          <li>Actions List: <a href="show-status?file=permit">@actions-filename@</a></li>
<!-- @if-pcrs-support-start -->
          <li>Regex Filter List: <a href="show-status?file=re">@re-filter-filename@</a></li>
<!-- if-pcrs-support-end@ -->
<!-- @if-trust-support-start -->
          <li>Trust List: <a href="show-status?file=trust">@trust-filename@</a></li>
<!-- if-trust-support-end@ -->
        </ul>
      </td>
    </tr>

    <tr>
      <td class="box">
        <h2>Conditional #defines:</h2>
        <p>
          <table border="1" style="margin-left: 10px">
            <tr> 
              <th>#define</th> <th>Enabled?</th> <th>Effects when enabled</th>
            </tr>
            <tr>
              <td><code>FEATURE_ACL</code></td>
              <td>@if-FEATURE_ACL-then@ Yes @else-not-FEATURE_ACL@ No @endif-FEATURE_ACL@</td>
              <td>Allows the use of an ACL to control access to the proxy by IP address.</td>
            </tr>
            <tr>
              <td><code>FEATURE_CGI_EDIT_ACTIONS</code></td>
              <td>@if-FEATURE_CGI_EDIT_ACTIONS-then@ Yes @else-not-FEATURE_CGI_EDIT_ACTIONS@ No @endif-FEATURE_CGI_EDIT_ACTIONS@</td>
              <td>Allows the use of the web-based actions file 
                 editor@if-FEATURE_CGI_EDIT_ACTIONS-then@, which is <a href="@default-cgi@edit-actions">here</a>@else-not-FEATURE_CGI_EDIT_ACTIONS@@endif-FEATURE_CGI_EDIT_ACTIONS@.</td>
            </tr>
            <tr>
              <td><code>FEATURE_COOKIE_JAR</code></td>
              <td>@if-FEATURE_COOKIE_JAR-then@ Yes @else-not-FEATURE_COOKIE_JAR@ No @endif-FEATURE_COOKIE_JAR@</td>
              <td>Allows the use of a "cookie jar" file to capture cookies.</td>
            </tr>
            <tr>
              <td><code>FEATURE_FAST_REDIRECTS</code></td>
              <td>@if-FEATURE_FAST_REDIRECTS-then@ Yes @else-not-FEATURE_FAST_REDIRECTS@ No @endif-FEATURE_FAST_REDIRECTS@</td>
              <td>Allows the +fast-redirects action, to bypass redirect and logging scripts.</td>
            </tr>
            <tr>
              <td><code>FEATURE_FORCE_LOAD</code></td>
              <td>@if-FEATURE_FORCE_LOAD-then@ Yes @else-not-FEATURE_FORCE_LOAD@ No @endif-FEATURE_FORCE_LOAD@</td>
              <td>Allows bypassing all filtering for a single page using the prefix "<code>@FORCE_PREFIX@</code>".</td>
            </tr>
            <tr>
              <td><code>FEATURE_IMAGE_BLOCKING</code></td>
              <td>@if-FEATURE_IMAGE_BLOCKING-then@ Yes @else-not-FEATURE_IMAGE_BLOCKING@ No @endif-FEATURE_IMAGE_BLOCKING@</td>
              <td>Allows the +image ation, to send "blocked" images instead of HTML.</td>
            </tr>
            <tr>
              <td><code>FEATURE_IMAGE_DETECT_MSIE</code></td>
              <td>@if-FEATURE_IMAGE_DETECT_MSIE-then@ Yes @else-not-FEATURE_IMAGE_DETECT_MSIE@ No @endif-FEATURE_IMAGE_DETECT_MSIE@</td>
              <td>Enables automatic detection of image and HTML requests from
               Microsoft Internet Explorer users, overriding the setting of 
               +image in the actions file.</td>
            </tr>
            <tr>
              <td><code>FEATURE_KILL_POPUPS</code></td>
              <td>@if-FEATURE_KILL_POPUPS-then@ Yes @else-not-FEATURE_KILL_POPUPS@ No @endif-FEATURE_KILL_POPUPS@</td>
              <td>Allows the +no-popups action, to block JavaScript popups.</td>
            </tr>
            <tr>
              <td><code>FEATURE_NO_GIFS</code></td>
              <td>@if-FEATURE_NO_GIFS-then@ Yes @else-not-FEATURE_NO_GIFS@ No @endif-FEATURE_NO_GIFS@</td>
              <td>Use PNG instead of GIF for the built-in images.</td>
            </tr>
            <tr>
              <td><code>FEATURE_PTHREAD</code></td>
              <td>@if-FEATURE_PTHREAD-then@ Yes @else-not-FEATURE_PTHREAD@ No @endif-FEATURE_PTHREAD@</td>
              <td>Use POSIX threads rather than native threads</td>
            </tr>
            <tr>
              <td><code>FEATURE_STATISTICS</code></td>
              <td>@if-FEATURE_STATISTICS-then@ Yes @else-not-FEATURE_STATISTICS@ No @endif-FEATURE_STATISTICS@</td>
              <td>Enables the statistics function.</td>
            </tr>
            <tr>
              <td><code>FEATURE_TOGGLE</code></td>
              <td>@if-FEATURE_TOGGLE-then@ Yes @else-not-FEATURE_TOGGLE@ No @endif-FEATURE_TOGGLE@</td>
              <td>Allow Privoxy to be "disabled" so it is just a normal non-blocking non-anonymizing proxy.</td>
            </tr>
            <tr>
              <td><code>FEATURE_TRUST</code></td>
              <td>@if-FEATURE_TRUST-then@ Yes @else-not-FEATURE_TRUST@ No @endif-FEATURE_TRUST@</td>
              <td>Allows the use of trust files.</td>
            </tr>
            <tr>
              <td><code>STATIC_PCRE</code></td>
              <td>@if-STATIC_PCRE-then@ Yes @else-not-STATIC_PCRE@ No @endif-STATIC_PCRE@</td>
              <td>Use the supplied statically-linked PCRE library.  This is set automatically
               by <code>./configure</code> if you do not have the libpcre installed.</td>
            </tr>
            <tr>
              <td><code>STATIC_PCRS</code></td>
              <td>@if-STATIC_PCRS-then@ Yes @else-not-STATIC_PCRS@ No @endif-STATIC_PCRS@</td>
              <td>Use the supplied statically-linked PCRS library.  This is set automatically
               by <code>./configure</code> if you do not have the libpcrs installed.</td>
            </tr>
          </table>
        </p>
      </td>
    </tr>

    <tr>
      <td class="box">
        <h2>More Privoxy:</h2>
        <ul>@menu@</ul>
      </td>
    </tr>

    <tr>
      <td class="info">

#include mod-support-and-service

      </td>
    </tr>

<!-- @if-have-help-info-start -->
    <tr>
      <td class="info">

#include mod-local-help

      </td>
    </tr>
<!-- if-have-help-info-end@ -->

     <tr>
      <td>
        <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
      </td>
    </tr>   
  </table>

</body>
</html>