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