templates/show-status

   1 ##########################################################
   2 #
   3 # Show-Status-CGI Output template for Privoxy.
   4 #
   5 # USING HTML TEMPLATES:
   6 # ---------------------
   7 #
   8 # Template files are written win plain HTML, with a few
   9 # additions:
  10 #
  11 # - Lines that start with a '#' character like this one
  12 #   are ignored
  13 #
  14 # - Each item in the below list of exported symbols will
  15 #   be replaced by dynamically generated text, if they
  16 #   are enclosed in '@'-characters. E.g. The string @version@
  17 #   will be replaced by the version number of Privoxy.
  18 #
  19 # - One special application of this is to make whole blocks
  20 #   of the HTML template disappear if the condition <name>
  21 #   is not given. Simply enclose the block between the two
  22 #   strings @if-<name>start and if-<name>-end@. The strings
  23 #   should be placed in HTML comments (<!-- -->), so the
  24 #   html structure won't be messed when the magic happens.
  25 #
  26 # USABLE SYMBOLS IN THIS TEMPLATE:
  27 # --------------------------------
  28 #
  29 #  my-ip-addr:
  30 #    The IP-address that the client used to reach Privoxy
  31 #  my-hostname:
  32 #    The hostname associated with my-ip-addr
  33 #  admin-address:
  34 #    The email address of the Privoxy administrator, as configured
  35 #    in the config file
  36 #  default-cgi:
  37 #    The URL for the "main menu" builtin CGI of Privoxy
  38 #  menu:
  39 #    List of <li> elements linking to the other available CGIs
  40 #  version:
  41 #    The Privoxy version number
  42 #  code-status:
  43 #    The Privoxy development status: "alpha", "beta", or "stable".
  44 #  homepage:
  45 #    The URL of the SourceForge ijbswa project, who maintains this
  46 #    software.
  47 #
  48 #  redirect-url:
  49 #    The URL to a script that will redirect to the Privoxy
  50 #    documentation for a given item
  51 #  invocation:
  52 #    The command line with which Privoxy was invoked
  53 #  options:
  54 #    The options read from the configfile, linked to their
  55 #    explanations, plus warnings if parsing acl or forward
  56 #    statements produced errors.
  57 #  sourceversions:
  58 #    A HTML-formatted list of the individual source file cvs versions
  59 #  defines:
  60 #    A HTML-formatted list of all conditional #defines used when
  61 #    Privoxy was compiled
  62 #
  63 #
  64 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
  65 # ------------------------------------------------------------------
  66 #
  67 #  unstable:
  68 #    This is an alpha or beta Privoxy release
  69 #  have-adminaddr-info:
  70 #    An e-mail address for the local Privoxy adminstrator has
  71 #    been specified and is available through the "admin-address"
  72 #    symbol
  73 #  have-proxy-info:
  74 #    A URL for Privoxy's online documentation has been
  75 #    specified and is available through the "proxy-info-url"
  76 #    symbol
  77 #  have-help-info:
  78 #    If either have-proxy-info is true or have-adminaddr-info is
  79 #    true, have-help-info is true.  Used to conditionally include
  80 #    a grey box for any and all help info.
  81 #  statistics:
  82 #    Privoxy was compiled with statistics support
  83 #  have-stats:
  84 #    There have been previous requests and statistics have
  85 #    been collected. In this case, the following symbols
  86 #    are available:
  87 #    requests-received:
  88 #      The number of requests received so far
  89 #    requests-blocked:
  90 #      The number of request blocked so far
  91 #    percent-blocked:
  92 #      The percentage of blocked requests
  93 #  have-no-stats:
  94 #    There haven't any statistics been collected yet
  95 #  pcrs-support:
  96 #    Privoxy was compiled with pcrs support
  97 #  trust-support:
  98 #    Privoxy was compiled with trust support
  99 #  actions-filenames:
 100 #    The path to the actions files.
 101 #  re-filter-filenames:
 102 #    The path to the re_filter files. Only available if
 103 #    pcrs-support is set
 104 #  trust-filename:
 105 #    The path to the trust file. Only available if
 106 #    trust-support is set
 107 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 108 <html>
 109
 110 <head>
 111   <title>Privoxy@@my-hostname@: Proxy Status</title>
 112   <meta http-equiv="Content-Style-Type" content="text/css">
 113   <meta http-equiv="Content-Script-Type" content="text/javascript">
 114   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 115   <meta name="robots" content="noindex,nofollow">
 116   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
 117   <link rel="shortcut icon" href="@default-cgi@favicon.ico" type="image/x-icon">
 118 </head>
 119
 120 <body>
 121
 122   <table summary="" cellpadding="20" cellspacing="10" border="0" width="100%">
 123     <tr>
 124       <td class="title">
 125
 126 #include mod-title
 127
 128       </td>
 129     </tr>
 130
 131 <!-- @if-unstable-start -->
 132 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
 133     <tr>
 134       <td class="warning">
 135
 136 #include mod-unstable-warning
 137
 138       </td>
 139     </tr>
 140 <!-- if-unstable-end@ -->
 141
 142     <tr>
 143       <td class="box">
 144         <h2>The following files are in use:</h2>
 145         <table summary="Action, filter and trust files in use." class="transparent">
 146           <tr>
 147             <th colspan="2"><a href="@user-manual@@actions-help-prefix@ACTIONS-FILE">Actions Files:</a></th>
 148           </tr>
 149             @actions-filenames@
 150           <tr>
 151             <th colspan="2"><a href="@user-manual@filter-file.html">Filter Files:</a></th>
 152           </tr>
 153             @re-filter-filenames@
 154 <!-- @if-trust-support-start -->
 155           <tr>
 156             <th colspan="2"><a href="@user-manual@config.html#TRUSTFILE">Trust File:</a></th>
 157           </tr>
 158           <tr>
 159             <td>
 160               @trust-filename@
 161             </td>
 162             <td class="buttons">
 163               <!-- @if-have-trustfile-start -->
 164               <a href="show-status?file=trust">View</a>
 165               <!-- if-have-trustfile-end@ -->
 166             </td>
 167           </tr>
 168 <!-- if-trust-support-end@ -->
 169         </table>
 170 <!-- @if-cgi-editor-is-disabled-start -->
 171         <p>
 172           The CGI editor is currently disabled, thus no edit buttons are shown.<br>
 173           Please have a look at the
 174            <a href="@user-manual@config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions documentation</a>
 175           to learn how to enable it and what the risks are.
 176         </p>
 177 <!--  if-cgi-editor-is-disabled-end@ -->
 178       </td>
 179     </tr>
 180
 181     <tr>
 182       <td class="box">
 183         <h2>Privoxy was <a href="@user-manual@startup.html#CMDOPTIONS">invoked</a> as follows:</h2>
 184         <p>@invocation@</p>
 185       </td>
 186     </tr>
 187
 188     <tr>
 189       <td class="box">
 190         <h2>The following options were given in the <a href="@user-manual@config.html">config file</a>:</h2>
 191         <p>@options@</p>
 192       </td>
 193     </tr>
 194
 195 <!-- @if-statistics-start -->
 196     <tr>
 197       <td class="box">
 198         <h2>Blocking Statistics:</h2>
 199         <p>
 200   <!-- @if-have-stats-start -->
 201           @requests-blocked@ out of @requests-received@ requests have been blocked,
 202           which equals a block rate of @percent-blocked@%.
 203 <!-- if-have-stats-end@ -->
 204 <!-- @if-have-no-stats-start -->
 205           There haven't been any requests so far.
 206 <!-- if-have-no-stats-end@ -->
 207         </p>
 208       </td>
 209     </tr>
 210 <!-- if-statistics-end@ -->
 211
 212     <tr>
 213       <td class="box">
 214         <h2>Conditional #defines:</h2>
 215           <table summary="The state of some ./configure options and what they do." border="1" style="margin-left: 10px">
 216             <tr>
 217               <th>#define</th> <th>Enabled?</th> <th>Effects when enabled</th>
 218             </tr>
 219             <tr>
 220               <td><code>FEATURE_ACL</code></td>
 221               <td>@if-FEATURE_ACL-then@ Yes @else-not-FEATURE_ACL@ No @endif-FEATURE_ACL@</td>
 222               <td>Allows the use of an ACL to control access to Privoxy by IP address.</td>
 223             </tr>
 224             <tr>
 225               <td><code>FEATURE_CGI_EDIT_ACTIONS</code></td>
 226               <td>@if-FEATURE_CGI_EDIT_ACTIONS-then@ Yes @else-not-FEATURE_CGI_EDIT_ACTIONS@ No @endif-FEATURE_CGI_EDIT_ACTIONS@</td>
 227               <td>Allows the use of the @if-FEATURE_CGI_EDIT_ACTIONS-then@<a
 228                  href="@default-cgi@edit-actions">@else-not-FEATURE_CGI_EDIT_ACTIONS@
 229                  @endif-FEATURE_CGI_EDIT_ACTIONS@web-based actions file
 230                  editor@if-FEATURE_CGI_EDIT_ACTIONS-then@</a>@else-not-FEATURE_CGI_EDIT_ACTIONS@@endif-FEATURE_CGI_EDIT_ACTIONS@.</td>
 231             </tr>
 232             <tr>
 233               <td><code>FEATURE_CONNECTION_KEEP_ALIVE</code></td>
 234               <td>@if-FEATURE_CONNECTION_KEEP_ALIVE-then@ Yes @else-not-FEATURE_CONNECTION_KEEP_ALIVE@ No @endif-FEATURE_CONNECTION_KEEP_ALIVE@</td>
 235               <td>
 236                Allows to send multiple request through the same connections if the server supports it.
 237                Requires the keep-alive-timeout config directive to be set.
 238               </td>
 239             </tr>
 240             <tr>
 241               <td><code>FEATURE_FAST_REDIRECTS</code></td>
 242               <td>@if-FEATURE_FAST_REDIRECTS-then@ Yes @else-not-FEATURE_FAST_REDIRECTS@ No @endif-FEATURE_FAST_REDIRECTS@</td>
 243               <td>Allows the +fast-redirects action, to bypass redirect and logging scripts.</td>
 244             </tr>
 245             <tr>
 246               <td><code>FEATURE_FORCE_LOAD</code></td>
 247               <td>@if-FEATURE_FORCE_LOAD-then@ Yes @else-not-FEATURE_FORCE_LOAD@ No @endif-FEATURE_FORCE_LOAD@</td>
 248               <td>Allows bypassing all filtering for a single page using the prefix
 249                   <q><code>@FORCE_PREFIX@</code></q>.</td>
 250             </tr>
 251             <tr>
 252               <td><code>FEATURE_GRACEFUL_TERMINATION</code></td>
 253               <td>@if-FEATURE_GRACEFUL_TERMINATION-then@ Yes @else-not-FEATURE_GRACEFUL_TERMINATION@ No @endif-FEATURE_GRACEFUL_TERMINATION@</td>
 254               <td>Allows to shutdown Privoxy through the web interface.</td>
 255             </tr>
 256             <tr>
 257               <td><code>FEATURE_IMAGE_BLOCKING</code></td>
 258               <td>@if-FEATURE_IMAGE_BLOCKING-then@ Yes @else-not-FEATURE_IMAGE_BLOCKING@ No @endif-FEATURE_IMAGE_BLOCKING@</td>
 259               <td>Allows the +handle-as-image action, to send <q>blocked</q> images instead of HTML.</td>
 260             </tr>
 261             <tr>
 262               <td><code>FEATURE_IPV6_SUPPORT</code></td>
 263               <td>@if-FEATURE_IPV6_SUPPORT-then@ Yes @else-not-FEATURE_IPV6_SUPPORT@ No @endif-FEATURE_IPV6_SUPPORT@</td>
 264               <td>
 265                Allows IPv6 addresses in incoming requests, when resolving domains to
 266                IP addresses and in the configuration files.
 267               </td>
 268             </tr>
 269             <tr>
 270               <td><code>FEATURE_IMAGE_DETECT_MSIE</code></td>
 271               <td>@if-FEATURE_IMAGE_DETECT_MSIE-then@ Yes @else-not-FEATURE_IMAGE_DETECT_MSIE@ No @endif-FEATURE_IMAGE_DETECT_MSIE@</td>
 272               <td>Enables automatic detection of image and HTML requests from
 273                Microsoft Internet Explorer users, overriding the setting of
 274                +image in the actions file.</td>
 275             </tr>
 276             <tr>
 277               <td><code>FEATURE_NO_GIFS</code></td>
 278               <td>@if-FEATURE_NO_GIFS-then@ Yes @else-not-FEATURE_NO_GIFS@ No @endif-FEATURE_NO_GIFS@</td>
 279               <td>Use PNG instead of GIF for the built-in images.</td>
 280             </tr>
 281             <tr>
 282               <td><code>FEATURE_PTHREAD</code></td>
 283               <td>@if-FEATURE_PTHREAD-then@ Yes @else-not-FEATURE_PTHREAD@ No @endif-FEATURE_PTHREAD@</td>
 284               <td>Use POSIX threads rather than native threads</td>
 285             </tr>
 286             <tr>
 287               <td><code>FEATURE_STATISTICS</code></td>
 288               <td>@if-FEATURE_STATISTICS-then@ Yes @else-not-FEATURE_STATISTICS@ No @endif-FEATURE_STATISTICS@</td>
 289               <td>Enables the statistics function.</td>
 290             </tr>
 291             <tr>
 292               <td><code>FEATURE_TOGGLE</code></td>
 293               <td>@if-FEATURE_TOGGLE-then@ Yes @else-not-FEATURE_TOGGLE@ No @endif-FEATURE_TOGGLE@</td>
 294               <td>Allow Privoxy to be <q>disabled</q> so it is just a normal non-blocking non-anonymizing proxy.</td>
 295             </tr>
 296             <tr>
 297               <td><code>FEATURE_TRUST</code></td>
 298               <td>@if-FEATURE_TRUST-then@ Yes @else-not-FEATURE_TRUST@ No @endif-FEATURE_TRUST@</td>
 299               <td>Allows the use of trust files.</td>
 300             </tr>
 301             <tr>
 302               <td><code>FEATURE_ZLIB</code></td>
 303               <td>@if-FEATURE_ZLIB-then@ Yes @else-not-FEATURE_ZLIB@ No @endif-FEATURE_ZLIB@</td>
 304               <td>Allows to decompress gzip and zlib compressed documents for filtering.
 305                 Requires external zlib library and hasn't been tested on all platforms.</td>
 306             </tr>
 307             <tr>
 308               <td><code>STATIC_PCRE</code></td>
 309               <td>@if-STATIC_PCRE-then@ Yes @else-not-STATIC_PCRE@ No @endif-STATIC_PCRE@</td>
 310               <td>Use the supplied statically-linked PCRE library.  This is set automatically
 311                by <code>./configure</code> if you do not have the libpcre installed.</td>
 312             </tr>
 313             <tr>
 314               <td><code>STATIC_PCRS</code></td>
 315               <td>@if-STATIC_PCRS-then@ Yes @else-not-STATIC_PCRS@ No @endif-STATIC_PCRS@</td>
 316               <td>Use the supplied statically-linked PCRS library.  This is set automatically
 317                by <code>./configure</code> if you do not have the libpcrs installed.</td>
 318             </tr>
 319           </table>
 320       </td>
 321     </tr>
 322
 323     <tr>
 324       <td class="box">
 325         <h2>More Privoxy:</h2>
 326         <ul>@menu@<li><a href="@user-manual@">Documentation</a></li></ul>
 327       </td>
 328     </tr>
 329
 330     <tr>
 331       <td class="info">
 332
 333 #include mod-support-and-service
 334
 335       </td>
 336     </tr>
 337
 338 <!-- @if-have-help-info-start -->
 339     <tr>
 340       <td class="info">
 341
 342 #include mod-local-help
 343
 344       </td>
 345     </tr>
 346 <!-- if-have-help-info-end@ -->
 347
 348   </table>
 349
 350 </body>
 351 </html>