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