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-adminaddr-info:
  71 #    An e-mail address for the local Junkbuster 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 #    Junkbuster 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 #    Junkbuster was compiled with pcrs support
  98 #  trust-support:
  99 #    Junkbuster 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 <html>
 109
 110 <head>
 111   <title>Junkbuster@@my-hostname@: Proxy Status</title>
 112   <style type="text/css">
 113     BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
 114   </style>
 115 </head>
 116
 117 <body bgcolor="#ffffff">
 118
 119   <table cellpadding=20 cellspacing=10 border=0 width=100%>
 120     <tr>
 121       <td bgcolor=#dddddd>
 122         <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>
 123           <font size=+2><b> @version@ on @my-hostname@ (@my-ip-address@), port @my-port@, @if-enabled-display-then@Enabled@else-not-enabled-display@Disabled@endif-enabled-display@</b></font></p>
 124       </td>
 125     </tr>
 126
 127 <!-- @if-unstable-start -->
 128 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
 129     <tr>
 130       <td bgcolor=#ffdddd>
 131         <p><b>Please note that this <font color=red>@code-status@</font> release
 132           of the proxy software is not intended for production systems!
 133           <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
 134         </p>
 135         <p>
 136 <h2>Support and Service via Sourceforge</h2>
 137 <p>
 138 We value your feedback. However, to provide you with the best support,
 139 please note:
 140 <ul>
 141   <li>Use the <a href="http://sourceforge.net/tracker/?group_id=11118&atid=211118">support forum</a> to get
 142   help.</li>
 143   <li>Submit bugs only thru our <a href="http://sourceforge.net/tracker/?group_id=11118&atid=111118">bug
 144       forum</a>. Make sure that the bug has not yet been submitted.</li>
 145   <li>Submit feature requests only thru our <a
 146       href="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">feature request forum</a>.</li>
 147 </ul>
 148 </p>
 149 <p>
 150 For any other issues, feel free to use the <a
 151 href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a>.
 152 </p>
 153       </td>
 154     </tr>
 155 <!-- if-unstable-end@ -->
 156
 157     <tr>
 158       <td bgcolor=#eeeeee>
 159         <h2>The program was invoked as follows</h2>
 160         <blockquote><p>@invocation@</p></blockquote>
 161       </td>
 162     </tr>
 163
 164     <tr>
 165       <td bgcolor=#eeeeee>
 166         <h2>The following options were given in the config file:</h2>
 167         <blockquote><p>@options@</p></blockquote>
 168       </td>
 169     </tr>
 170
 171 <!-- @if-statistics-start -->
 172     <tr>
 173       <td bgcolor=#eeeeee>
 174         <h2>Blocking Statistics:</h2>
 175         <blockquote>
 176 <!-- @if-have-stats-start -->
 177         @requests-blocked@ out of @requests-received@ requests have been blocked,
 178         which equals a block rate of @percent-blocked@%.
 179 <!-- if-have-stats-end@ -->
 180 <!-- @if-have-no-stats-start -->
 181         There haven't been any requests so far.
 182 <!-- if-have-no-stats-end@ -->
 183       </td>
 184     </tr>
 185 <!-- if-statistics-end@ -->
 186
 187     <tr>
 188       <td bgcolor=#eeeeee>
 189         <h2>The following files are in use:</h2>
 190         <blockquote><p>Click a filename to browse</p></blockquote>
 191         <ul>
 192           <li>Actions List: <a href="show-status?file=permit">@actions-filename@</a></li>
 193 <!-- @if-pcrs-support-start -->
 194           <li>Regex Filter List: <a href="show-status?file=re">@re-filter-filename@</a></li>
 195 <!-- if-pcrs-support-end@ -->
 196 <!-- @if-trust-support-start -->
 197           <li>Trust List: <a href="show-status?file=trust">@trust-filename@</a></li>
 198 <!-- if-trust-support-end@ -->
 199         </ul>
 200       </td>
 201     </tr>
 202
 203     <tr>
 204       <td bgcolor=#eeeeee>
 205         <h2>Conditional #defines:</h2>
 206           <table border=1>
 207           <tr>
 208             <th>#define</th> <th>Enabled?</th> <th>Effects when enabled</th>
 209           </tr>
 210           <tr>
 211              <td><code>FEATURE_ACL</code></td>
 212              <td>@if-FEATURE_ACL-then@ Yes @else-not-FEATURE_ACL@ No @endif-FEATURE_ACL@</td>
 213              <td>Allows the use of an ACL to control access to the proxy by IP address.</td>
 214           </tr>
 215           <tr>
 216              <td><code>FEATURE_CGI_EDIT_ACTIONS</code></td>
 217              <td>@if-FEATURE_CGI_EDIT_ACTIONS-then@ Yes @else-not-FEATURE_CGI_EDIT_ACTIONS@ No @endif-FEATURE_CGI_EDIT_ACTIONS@</td>
 218              <td>Allows the use of the web-based actions file
 219                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>
 220           </tr>
 221           <tr>
 222              <td><code>FEATURE_COOKIE_JAR</code></td>
 223              <td>@if-FEATURE_COOKIE_JAR-then@ Yes @else-not-FEATURE_COOKIE_JAR@ No @endif-FEATURE_COOKIE_JAR@</td>
 224              <td>Allows the use of a "cookie jar" file to capture cookies.</td>
 225           </tr>
 226           <tr>
 227              <td><code>FEATURE_FAST_REDIRECTS</code></td>
 228              <td>@if-FEATURE_FAST_REDIRECTS-then@ Yes @else-not-FEATURE_FAST_REDIRECTS@ No @endif-FEATURE_FAST_REDIRECTS@</td>
 229              <td>Allows the +fast-redirects action, to bypass redirect and logging scripts.</td>
 230           </tr>
 231           <tr>
 232              <td><code>FEATURE_FORCE_LOAD</code></td>
 233              <td>@if-FEATURE_FORCE_LOAD-then@ Yes @else-not-FEATURE_FORCE_LOAD@ No @endif-FEATURE_FORCE_LOAD@</td>
 234              <td>Allows bypassing all filtering for a single page using the prefix "<code>@FORCE_PREFIX@</code>".</td>
 235           </tr>
 236           <tr>
 237              <td><code>FEATURE_IMAGE_BLOCKING</code></td>
 238              <td>@if-FEATURE_IMAGE_BLOCKING-then@ Yes @else-not-FEATURE_IMAGE_BLOCKING@ No @endif-FEATURE_IMAGE_BLOCKING@</td>
 239              <td>Allows the +image ation, to send "blocked" images instead of HTML.</td>
 240           </tr>
 241           <tr>
 242              <td><code>FEATURE_IMAGE_DETECT_MSIE</code></td>
 243              <td>@if-FEATURE_IMAGE_DETECT_MSIE-then@ Yes @else-not-FEATURE_IMAGE_DETECT_MSIE@ No @endif-FEATURE_IMAGE_DETECT_MSIE@</td>
 244              <td>Enables automatic detection of image and HTML requests from
 245              Microsoft Internet Explorer users, overriding the setting of
 246              +image in the actions file.</td>
 247           </tr>
 248           <tr>
 249              <td><code>FEATURE_KILL_POPUPS</code></td>
 250              <td>@if-FEATURE_KILL_POPUPS-then@ Yes @else-not-FEATURE_KILL_POPUPS@ No @endif-FEATURE_KILL_POPUPS@</td>
 251              <td>Allows the +no-popups action, to block JavaScript popups.</td>
 252           </tr>
 253           <tr>
 254              <td><code>FEATURE_PTHREAD</code></td>
 255              <td>@if-FEATURE_PTHREAD-then@ Yes @else-not-FEATURE_PTHREAD@ No @endif-FEATURE_PTHREAD@</td>
 256              <td>Use POSIX threads rather than native threads</td>
 257           </tr>
 258           <tr>
 259              <td><code>FEATURE_STATISTICS</code></td>
 260              <td>@if-FEATURE_STATISTICS-then@ Yes @else-not-FEATURE_STATISTICS@ No @endif-FEATURE_STATISTICS@</td>
 261              <td>Enables the statistics function.</td>
 262           </tr>
 263           <tr>
 264              <td><code>FEATURE_TOGGLE</code></td>
 265              <td>@if-FEATURE_TOGGLE-then@ Yes @else-not-FEATURE_TOGGLE@ No @endif-FEATURE_TOGGLE@</td>
 266              <td>Allow JunkBuster to be "disabled" so it is just a normal non-blocking non-anonymizing proxy.</td>
 267           </tr>
 268           <tr>
 269              <td><code>FEATURE_TRUST</code></td>
 270              <td>@if-FEATURE_TRUST-then@ Yes @else-not-FEATURE_TRUST@ No @endif-FEATURE_TRUST@</td>
 271              <td>Allows the use of trust files.</td>
 272           </tr>
 273           <tr>
 274              <td><code>REGEX_GNU</code></td>
 275              <td>@if-REGEX_GNU-then@ Yes @else-not-REGEX_GNU@ No @endif-REGEX_GNU@</td>
 276              <td rowspan="2">Changes the type of pattern matching done on URL paths.  PCRE is by far the best.
 277              The old GNU style will slow down JunkBuster and increase the executable's size.  If both of
 278              these are disabled, simple prefix matching is done, but this is very inflexible.</td>
 279           </tr>
 280           <tr>
 281              <td><code>REGEX_PCRE</code></td>
 282              <td>@if-REGEX_PCRE-then@ Yes @else-not-REGEX_PCRE@ No @endif-REGEX_PCRE@</td>
 283           </tr>
 284           <tr>
 285              <td><code>STATIC_PCRE</code></td>
 286              <td>@if-STATIC_PCRE-then@ Yes @else-not-STATIC_PCRE@ No @endif-STATIC_PCRE@</td>
 287              <td>Use the supplied statically-linked PCRE library.  This is set automatically
 288              by <code>./configure</code> if you do not have the libpcre installed.</td>
 289           </tr>
 290           <tr>
 291              <td><code>STATIC_PCRS</code></td>
 292              <td>@if-STATIC_PCRS-then@ Yes @else-not-STATIC_PCRS@ No @endif-STATIC_PCRS@</td>
 293              <td>Use the supplied statically-linked PCRS library.  This is set automatically
 294              by <code>./configure</code> if you do not have the libpcrs installed.</td>
 295           </tr>
 296         </table>
 297       </td>
 298     </tr>
 299
 300     <tr>
 301       <td bgcolor=#dddddd>
 302         <h2>More Junkbuster:</h2>
 303         <ul>@menu@</ul>
 304       </td>
 305     </tr>
 306
 307 <!-- @if-have-help-info-start -->
 308     <tr>
 309       <td bgcolor=#dddddd>
 310         <h2>Local Junkbuster support:</h2>
 311
 312 <!-- @if-have-proxy-info-start -->
 313         <p>You can consult the <a href="@proxy-info-url@">online documentation</a> for more information about this Junkbuster installation.
 314 <!-- if-have-proxy-info-end@ -->
 315
 316 <!-- @if-have-adminaddr-info-start -->
 317         <p>Address e-mail questions about this service to
 318           <a href=mailto:@admin-address@><code>@admin-address@</code></a>,
 319           who will be glad to help you.
 320 <!-- if-have-adminaddr-info-end@ -->
 321
 322         </p>
 323       </td>
 324     </tr>
 325 <!-- if-have-help-info-end@ -->
 326
 327   </table>
 328
 329 </body>
 330 </html>