templates/show-status

   1 ##########################################################
   2 #
   3 # Show-Status-CGI Output template for junkbuster 2.9.x
   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 Junkbuster.
  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 junkbuster
  51 #    documentation for a given item
  52 #  invocation:
  53 #    The command line with whitch junkbuster 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 #    junkbuster 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-proxy-info:
  71 #    A URL for online documentation about this proxy has been
  72 #    specified and is available through the "proxy-info-url"
  73 #    symbol
  74 #  statistics:
  75 #    Junkbuster was compiled with statistics support
  76 #  have-stats:
  77 #    There have been previous requests and statistics have
  78 #    been collected. In this case, the following symbols
  79 #    are available:
  80 #    requests-received:
  81 #      The number of requests received so far
  82 #    requests-blocked:
  83 #      The number of request blocked so far
  84 #    percent-blocked:
  85 #      The percentage of blocked requests
  86 #  have-no-stats:
  87 #    There haven't any statistics been collected yet
  88 #  pcrs-support:
  89 #    Junkbuster was compiled with pcrs support
  90 #  trust-support:
  91 #    Junkbuster was compiled with trust support
  92 #  actions-filename:
  93 #    The path to the actions file.
  94 #  re-filter-filename:
  95 #    The path to the re_filter file. Only available if
  96 #    pcrs-support is set
  97 #  trust-filename:
  98 #    The path to the trust file.Only available if
  99 #    trust-support is set
 100 <html>
 101
 102 <head>
 103   <title>Junkbuster@@my-hostname@: Proxy Status</title>
 104   <style type="text/css">
 105     BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
 106   </style>
 107 </head>
 108
 109 <body bgcolor="#ffffff">
 110
 111   <table cellpadding=20 cellspacing=10 border=0 width=100%>
 112     <tr>
 113       <td bgcolor=#dddddd>
 114         <p><font size=+2><b>This is the Internet J</b></font><font size=+1><b>UNK<i></font><font color="red">BUSTER</font></i></b>
 115           <font size=+2><b>@version@ on @my-hostname@ (@my-ip-address@), port @my-port@</b></font></p>
 116       </td>
 117     </tr>
 118
 119 <!-- @if-unstable-start -->
 120 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
 121     <tr>
 122       <td bgcolor=#ffdddd>
 123         <p><b>Please note that this is a <font color=red>@code-status@</font> release,
 124           of the proxy software, not intended for production systems!
 125           <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
 126         </p>
 127
 128         <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
 129           with any problems you might have
 130         </p>
 131       </td>
 132     </tr>
 133 <!-- if-unstable-end@ -->
 134
 135     <tr>
 136       <td bgcolor=#eeeeee>
 137         <h2>The program was invoked as follows</h2>
 138         <blockquote><p>@invocation@</p></blockquote>
 139       </td>
 140     </tr>
 141
 142     <tr>
 143       <td bgcolor=#eeeeee>
 144         <h2>The following options were given in the config file:</h2>
 145         <blockquote><p>@options@</p></blockquote>
 146       </td>
 147     </tr>
 148
 149 <!-- @if-statistics-start -->
 150     <tr>
 151       <td bgcolor=#eeeeee>
 152         <h2>Blocking Statistics:</h2>
 153         <blockquote>
 154 <!-- @if-have-stats-start -->
 155         @requests-blocked@ out of @requests-received@ requests have been blocked,
 156         which equals a block rate of @percent-blocked@%.
 157 <!-- if-have-stats-end@ -->
 158 <!-- @if-have-no-stats-start -->
 159         There haven't been any requests so far.
 160 <!-- if-have-no-stats-end@ -->
 161       </td>
 162     </tr>
 163 <!-- if-statistics-end@ -->
 164
 165     <tr>
 166       <td bgcolor=#eeeeee>
 167         <h2>The following files are in use:</h2>
 168         <blockquote><p>Click a filename to browse</p></blockquote>
 169         <ul>
 170           <li>Actions List: <a href="show-status?file=permit">@actions-filename@</a></li>
 171 <!-- @if-pcrs-support-start -->
 172           <li>Regex Filter List: <a href="show-status?file=re">@re-filter-filename@</a></li>
 173 <!-- if-pcrs-support-end@ -->
 174 <!-- @if-trust-support-start -->
 175           <li>Trust List: <a href="show-status?file=trust">@trust-filename@</a></li>
 176 <!-- if-trust-support-end@ -->
 177         </ul>
 178       </td>
 179     </tr>
 180
 181     <tr>
 182       <td bgcolor=#eeeeee>
 183         <h2>Conditional #defines:</h2>
 184           <table border=1>
 185           <tr>
 186             <th>#define</th> <th>Enabled?</th> <th>Effects when enabled</th>
 187           </tr>
 188           <tr>
 189              <td><code>FEATURE_PTHREAD</code></td>
 190              <td>@if-FEATURE_PTHREAD-then@ Yes @else-not-FEATURE_PTHREAD@ No @endif-FEATURE_PTHREAD@</td>
 191              <td>Use POSIX threads rather than native threads</td>
 192           </tr>
 193           <tr>
 194              <td><code>FEATURE_ACL</code></td>
 195              <td>@if-FEATURE_ACL-then@ Yes @else-not-FEATURE_ACL@ No @endif-FEATURE_ACL@</td>
 196              <td>Allows the use of an ACL to control access to the proxy by IP address.</td>
 197           </tr>
 198           <tr>
 199              <td><code>FEATURE_COOKIE_JAR</code></td>
 200              <td>@if-FEATURE_COOKIE_JAR-then@ Yes @else-not-FEATURE_COOKIE_JAR@ No @endif-FEATURE_COOKIE_JAR@</td>
 201              <td>Allows the use of a "cookie jar" file to capture cookies.</td>
 202           </tr>
 203           <tr>
 204              <td><code>FEATURE_DENY_GZIP</code></td>
 205              <td>@if-FEATURE_DENY_GZIP-then@ Yes @else-not-FEATURE_DENY_GZIP@ No @endif-FEATURE_DENY_GZIP@</td>
 206              <td>Prevents requests from being compressed.  This means that all
 207                  sites can be filtered through +filter and +no-popups, but it
 208                  wastes bandwidth.</td>
 209           </tr>
 210           <tr>
 211              <td><code>FEATURE_FAST_REDIRECTS</code></td>
 212              <td>@if-FEATURE_FAST_REDIRECTS-then@ Yes @else-not-FEATURE_FAST_REDIRECTS@ No @endif-FEATURE_FAST_REDIRECTS@</td>
 213              <td>Allows the +fast-redirects action, to bypass redirect and logging scripts.</td>
 214           </tr>
 215           <tr>
 216              <td><code>FEATURE_FORCE_LOAD</code></td>
 217              <td>@if-FEATURE_FORCE_LOAD-then@ Yes @else-not-FEATURE_FORCE_LOAD@ No @endif-FEATURE_FORCE_LOAD@</td>
 218              <td>Allows bypassing all filtering for a single page using the prefix "<code>@FORCE_PREFIX@</code>".</td>
 219           </tr>
 220           <tr>
 221              <td><code>FEATURE_IMAGE_BLOCKING</code></td>
 222              <td>@if-FEATURE_IMAGE_BLOCKING-then@ Yes @else-not-FEATURE_IMAGE_BLOCKING@ No @endif-FEATURE_IMAGE_BLOCKING@</td>
 223              <td>Allows the +image ation, to send "blocked" images instead of HTML.</td>
 224           </tr>
 225           <tr>
 226              <td><code>FEATURE_IMAGE_DETECT_MSIE</code></td>
 227              <td>@if-FEATURE_IMAGE_DETECT_MSIE-then@ Yes @else-not-FEATURE_IMAGE_DETECT_MSIE@ No @endif-FEATURE_IMAGE_DETECT_MSIE@</td>
 228              <td>Enables automatic detection of image and HTML requests from
 229              Microsoft Internet Explorer users, overriding the setting of
 230              +image in the actions file.</td>
 231           </tr>
 232           <tr>
 233              <td><code>FEATURE_KILL_POPUPS</code></td>
 234              <td>@if-FEATURE_KILL_POPUPS-then@ Yes @else-not-FEATURE_KILL_POPUPS@ No @endif-FEATURE_KILL_POPUPS@</td>
 235              <td>Allows the +no-popups action, to block JavaScript popups.</td>
 236           </tr>
 237           <tr>
 238              <td><code>FEATURE_STATISTICS</code></td>
 239              <td>@if-FEATURE_STATISTICS-then@ Yes @else-not-FEATURE_STATISTICS@ No @endif-FEATURE_STATISTICS@</td>
 240              <td>Enables the statistics function.</td>
 241           </tr>
 242           <tr>
 243              <td><code>FEATURE_TOGGLE</code></td>
 244              <td>@if-FEATURE_TOGGLE-then@ Yes @else-not-FEATURE_TOGGLE@ No @endif-FEATURE_TOGGLE@</td>
 245              <td>Allow JunkBuster to be "disabled" so it is just a normal non-blocking non-anonymizing proxy.</td>
 246           </tr>
 247           <tr>
 248              <td><code>FEATURE_TRUST</code></td>
 249              <td>@if-FEATURE_TRUST-then@ Yes @else-not-FEATURE_TRUST@ No @endif-FEATURE_TRUST@</td>
 250              <td>Allows the use of trust files.</td>
 251           </tr>
 252           <tr>
 253              <td><code>REGEX_GNU</code></td>
 254              <td>@if-REGEX_GNU-then@ Yes @else-not-REGEX_GNU@ No @endif-REGEX_GNU@</td>
 255              <td rowspan="2">Changes the type of pattern matching done on URL paths.  PCRE is by far the best.
 256              The old GNU style will slow down JunkBuster and increase the executable's size.  If both of
 257              these are disabled, simple prefix matching is done, but this is very inflexible.</td>
 258           </tr>
 259           <tr>
 260              <td><code>REGEX_PCRE</code></td>
 261              <td>@if-REGEX_PCRE-then@ Yes @else-not-REGEX_PCRE@ No @endif-REGEX_PCRE@</td>
 262           </tr>
 263           <tr>
 264              <td><code>STATIC_PCRE</code></td>
 265              <td>@if-STATIC_PCRE-then@ Yes @else-not-STATIC_PCRE@ No @endif-STATIC_PCRE@</td>
 266              <td>Use the supplied statically-linked PCRE library.  This is set automatically
 267              by <code>./configure</code> if you do not have the libpcre installed.</td>
 268           </tr>
 269           <tr>
 270              <td><code>STATIC_PCRS</code></td>
 271              <td>@if-STATIC_PCRS-then@ Yes @else-not-STATIC_PCRS@ No @endif-STATIC_PCRS@</td>
 272              <td>Use the supplied statically-linked PCRS library.  This is set automatically
 273              by <code>./configure</code> if you do not have the libpcrs installed.</td>
 274           </tr>
 275         </table>
 276       </td>
 277     </tr>
 278
 279     <tr>
 280       <td bgcolor=#eeeeee>
 281         <h2>Source code versions:</h2>
 282         <blockquote><pre>@sourceversions@</pre></blockquote>
 283       </td>
 284     </tr>
 285
 286     <tr>
 287       <td bgcolor=#dddddd>
 288         <h2>More Junkbuster:</h2>
 289         <ul>@menu@</ul>
 290       </td>
 291     </tr>
 292
 293     <tr>
 294       <td bgcolor=#dddddd>
 295         <p>If you have any questions about this service,
 296
 297 <!-- @if-have-proxy-info-start -->
 298           consult the <a href="@proxy-info-url@">online documentation</a> or
 299 <!-- if-have-proxy-info-end@ -->
 300
 301           <a href=mailto:@admin-address@>send mail to <code>@admin-address@</code></a>
 302           who will be glad to help you.
 303         </p>
 304       </td>
 305     </tr>
 306
 307   </table>
 308
 309 </body>
 310 </html>