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         <h1>
 126           This is <a href="@homepage@">Privoxy</a> @version@ on @my-hostname@ (@my-ip-address@), port @my-port@,
 127           @if-enabled-display-then@Enabled@else-not-enabled-display@Disabled@endif-enabled-display@
 128         </h1>
 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         <h2>Warning:</h2>
 137           <p>
 138             <b>Please note that this <em class="warning">@code-status@</em> release
 139             of the proxy software is not intended for production systems!
 140             <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
 141           </p>
 142       </td>
 143     </tr>
 144 <!-- if-unstable-end@ -->
 145
 146     <tr>
 147       <td class="box">
 148         <h2>The program was invoked as follows</h2>
 149         <p>@invocation@</p>
 150       </td>
 151     </tr>
 152
 153     <tr>
 154       <td class="box">
 155         <h2>The following options were given in the config file:</h2>
 156         <p>@options@</p>
 157       </td>
 158     </tr>
 159
 160 <!-- @if-statistics-start -->
 161     <tr>
 162       <td class="box">
 163         <h2>Blocking Statistics:</h2>
 164         <p>
 165   <!-- @if-have-stats-start -->
 166           @requests-blocked@ out of @requests-received@ requests have been blocked,
 167           which equals a block rate of @percent-blocked@%.
 168 <!-- if-have-stats-end@ -->
 169 <!-- @if-have-no-stats-start -->
 170           There haven't been any requests so far.
 171 <!-- if-have-no-stats-end@ -->
 172         </p>
 173       </td>
 174     </tr>
 175 <!-- if-statistics-end@ -->
 176
 177     <tr>
 178       <td class="box">
 179         <h2>The following files are in use:</h2>
 180         <p>Click a filename to browse</p>
 181         <ul>
 182           <li>Actions List: <a href="show-status?file=permit">@actions-filename@</a></li>
 183 <!-- @if-pcrs-support-start -->
 184           <li>Regex Filter List: <a href="show-status?file=re">@re-filter-filename@</a></li>
 185 <!-- if-pcrs-support-end@ -->
 186 <!-- @if-trust-support-start -->
 187           <li>Trust List: <a href="show-status?file=trust">@trust-filename@</a></li>
 188 <!-- if-trust-support-end@ -->
 189         </ul>
 190       </td>
 191     </tr>
 192
 193     <tr>
 194       <td class="box">
 195         <h2>Conditional #defines:</h2>
 196         <table border="1" style="margin-left: 10px">
 197           <tr>
 198             <th>#define</th> <th>Enabled?</th> <th>Effects when enabled</th>
 199           </tr>
 200           <tr>
 201             <td><code>FEATURE_ACL</code></td>
 202             <td>@if-FEATURE_ACL-then@ Yes @else-not-FEATURE_ACL@ No @endif-FEATURE_ACL@</td>
 203             <td>Allows the use of an ACL to control access to the proxy by IP address.</td>
 204           </tr>
 205           <tr>
 206             <td><code>FEATURE_CGI_EDIT_ACTIONS</code></td>
 207             <td>@if-FEATURE_CGI_EDIT_ACTIONS-then@ Yes @else-not-FEATURE_CGI_EDIT_ACTIONS@ No @endif-FEATURE_CGI_EDIT_ACTIONS@</td>
 208             <td>Allows the use of the web-based actions file
 209                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>
 210           </tr>
 211           <tr>
 212             <td><code>FEATURE_COOKIE_JAR</code></td>
 213             <td>@if-FEATURE_COOKIE_JAR-then@ Yes @else-not-FEATURE_COOKIE_JAR@ No @endif-FEATURE_COOKIE_JAR@</td>
 214             <td>Allows the use of a "cookie jar" file to capture cookies.</td>
 215           </tr>
 216           <tr>
 217             <td><code>FEATURE_FAST_REDIRECTS</code></td>
 218             <td>@if-FEATURE_FAST_REDIRECTS-then@ Yes @else-not-FEATURE_FAST_REDIRECTS@ No @endif-FEATURE_FAST_REDIRECTS@</td>
 219             <td>Allows the +fast-redirects action, to bypass redirect and logging scripts.</td>
 220           </tr>
 221           <tr>
 222             <td><code>FEATURE_FORCE_LOAD</code></td>
 223             <td>@if-FEATURE_FORCE_LOAD-then@ Yes @else-not-FEATURE_FORCE_LOAD@ No @endif-FEATURE_FORCE_LOAD@</td>
 224             <td>Allows bypassing all filtering for a single page using the prefix "<code>@FORCE_PREFIX@</code>".</td>
 225           </tr>
 226           <tr>
 227             <td><code>FEATURE_IMAGE_BLOCKING</code></td>
 228             <td>@if-FEATURE_IMAGE_BLOCKING-then@ Yes @else-not-FEATURE_IMAGE_BLOCKING@ No @endif-FEATURE_IMAGE_BLOCKING@</td>
 229             <td>Allows the +image ation, to send "blocked" images instead of HTML.</td>
 230           </tr>
 231           <tr>
 232             <td><code>FEATURE_IMAGE_DETECT_MSIE</code></td>
 233             <td>@if-FEATURE_IMAGE_DETECT_MSIE-then@ Yes @else-not-FEATURE_IMAGE_DETECT_MSIE@ No @endif-FEATURE_IMAGE_DETECT_MSIE@</td>
 234             <td>Enables automatic detection of image and HTML requests from
 235              Microsoft Internet Explorer users, overriding the setting of
 236              +image in the actions file.</td>
 237           </tr>
 238           <tr>
 239             <td><code>FEATURE_KILL_POPUPS</code></td>
 240             <td>@if-FEATURE_KILL_POPUPS-then@ Yes @else-not-FEATURE_KILL_POPUPS@ No @endif-FEATURE_KILL_POPUPS@</td>
 241             <td>Allows the +no-popups action, to block JavaScript popups.</td>
 242           </tr>
 243           <tr>
 244             <td><code>FEATURE_NO_GIFS</code></td>
 245             <td>@if-FEATURE_NO_GIFS-then@ Yes @else-not-FEATURE_NO_GIFS@ No @endif-FEATURE_NO_GIFS@</td>
 246             <td>Use PNG instead of GIF for the built-in images.</td>
 247           </tr>
 248           <tr>
 249             <td><code>FEATURE_PTHREAD</code></td>
 250             <td>@if-FEATURE_PTHREAD-then@ Yes @else-not-FEATURE_PTHREAD@ No @endif-FEATURE_PTHREAD@</td>
 251             <td>Use POSIX threads rather than native threads</td>
 252           </tr>
 253           <tr>
 254             <td><code>FEATURE_STATISTICS</code></td>
 255             <td>@if-FEATURE_STATISTICS-then@ Yes @else-not-FEATURE_STATISTICS@ No @endif-FEATURE_STATISTICS@</td>
 256             <td>Enables the statistics function.</td>
 257           </tr>
 258           <tr>
 259             <td><code>FEATURE_TOGGLE</code></td>
 260             <td>@if-FEATURE_TOGGLE-then@ Yes @else-not-FEATURE_TOGGLE@ No @endif-FEATURE_TOGGLE@</td>
 261             <td>Allow Privoxy to be "disabled" so it is just a normal non-blocking non-anonymizing proxy.</td>
 262           </tr>
 263           <tr>
 264             <td><code>FEATURE_TRUST</code></td>
 265             <td>@if-FEATURE_TRUST-then@ Yes @else-not-FEATURE_TRUST@ No @endif-FEATURE_TRUST@</td>
 266             <td>Allows the use of trust files.</td>
 267           </tr>
 268           <tr>
 269             <td><code>STATIC_PCRE</code></td>
 270             <td>@if-STATIC_PCRE-then@ Yes @else-not-STATIC_PCRE@ No @endif-STATIC_PCRE@</td>
 271             <td>Use the supplied statically-linked PCRE library.  This is set automatically
 272              by <code>./configure</code> if you do not have the libpcre installed.</td>
 273           </tr>
 274           <tr>
 275             <td><code>STATIC_PCRS</code></td>
 276             <td>@if-STATIC_PCRS-then@ Yes @else-not-STATIC_PCRS@ No @endif-STATIC_PCRS@</td>
 277             <td>Use the supplied statically-linked PCRS library.  This is set automatically
 278              by <code>./configure</code> if you do not have the libpcrs installed.</td>
 279           </tr>
 280         </table>
 281       </td>
 282     </tr>
 283
 284     <tr>
 285       <td class="box">
 286         <h2>More Privoxy:</h2>
 287         <ul>@menu@</ul>
 288       </td>
 289     </tr>
 290
 291     <tr>
 292       <td class="info">
 293         <h2>Support and Service via Sourceforge:</h2>
 294         <p>
 295           We value your feedback. To provide you with the best support,
 296           we ask that you:
 297         </p>
 298         <ul>
 299           <li>
 300             use the <a href="http://sourceforge.net/tracker/?group_id=11118&amp;atid=211118">support forum</a> or (better) the
 301             <a href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a> to get help.
 302           </li>
 303           <li>
 304             submit banners and all problems with the actions file only through the
 305             <a href="javascript:void(window.open('http://www.privoxy.org/actions','Feedback','width=600,scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">actions
 306             file feedback system</a>.
 307           </li>
 308           <li>
 309             submit bugs only through our <a href="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">bug tracker</a>.
 310             Make sure that the bug has not yet been submitted.
 311           </li>
 312           <li>
 313             submit feature requests only through our <a href="http://sourceforge.net/tracker/?atid=361118&amp;group_id=11118&amp;func=browse">feature
 314             request tracker</a>.
 315           </li>
 316         </ul>
 317       </td>
 318     </tr>
 319
 320 <!-- @if-have-help-info-start -->
 321     <tr>
 322       <td class="info">
 323         <h2>Local Privoxy support:</h2>
 324
 325 <!-- @if-have-proxy-info-start -->
 326         <p>
 327           You can consult the <a href="@proxy-info-url@">online documentation</a> for more information
 328           about this Privoxy installation.
 329         </p>
 330 <!-- if-have-proxy-info-end@ -->
 331
 332 <!-- @if-have-adminaddr-info-start -->
 333         <p>Address e-mail questions about this service to
 334           <a href="mailto:@admin-address@"><code>@admin-address@</code></a>,
 335           who will be glad to help you.
 336         </p>
 337 <!-- if-have-adminaddr-info-end@ -->
 338       </td>
 339     </tr>
 340 <!-- if-have-help-info-end@ -->
 341
 342      <tr>
 343       <td>
 344         <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
 345       </td>
 346     </tr>
 347   </table>
 348
 349 </body>
 350 </html>