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 #  split-args:
  93 #    Junkbuster was compiled with #define SPLIT_PROXY_ARGS
  94 #    In this case, the following symbols are available:
  95 #    actions-filename:
  96 #      The path to the actions file.
  97 #    re-filter-filename:
  98 #      The path to the re_filter file. Only available if
  99 #      pcrs-support is set
 100 #    trust-filename:
 101 #      The path to the trust file.Only available if
 102 #      trust-support is set
 103 #  no-split-args:
 104 #    Junkbuster was not compiled with #define SPLIT_PROXY_ARGS
 105 #    In this case, the following symbols are available:
 106 #    alist:
 107 #      The contents of the actionsfile
 108 #    rlist:
 109 #      The contents of the re_filterfile. Only available if
 110 #      pcrs-support is set
 111 #    tlist:
 112 #      The contents of the trustfile. Only available if
 113 #      trust-support is set
 114 #
 115 <html>
 116
 117 <head>
 118   <title>Junkbuster@@my-hostname@: Proxy Status</title>
 119   <style type="text/css">
 120     BODY, P, H1, H2, UL, OL, LI { font-family: Helvetica, Helv, Arial, Sans-Serif, sans-serif }
 121   </style>
 122 </head>
 123
 124 <body bgcolor="#ffffff">
 125
 126   <table cellpadding=20 cellspacing=10 border=0 width=100%>
 127     <tr>
 128       <td bgcolor=#dddddd>
 129         <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>
 130           <font size=+2><b>@version@ on @my-hostname@ (@my-ip-address@), port @my-port@</b></font></p>
 131       </td>
 132     </tr>
 133
 134 <!-- @if-unstable-start -->
 135 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
 136     <tr>
 137       <td bgcolor=#ffdddd>
 138         <p><b>Please note that this is a <font color=red>@code-status@</font> release,
 139           of the proxy software, 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
 143         <p>Feel free to <a href=mailto:ijbswa-developers@lists.sourceforge.net>mail the developers</a>
 144           with any problems you might have
 145         </p>
 146       </td>
 147     </tr>
 148 <!-- if-unstable-end@ -->
 149
 150     <tr>
 151       <td bgcolor=#eeeeee>
 152         <h2>The program was invoked as follows</h2>
 153         <blockquote><p>@invocation@</p></blockquote>
 154       </td>
 155     </tr>
 156
 157     <tr>
 158       <td bgcolor=#eeeeee>
 159         <h2>The following options were given in the config file:</h2>
 160         <blockquote><p>@options@</p></blockquote>
 161       </td>
 162     </tr>
 163
 164 <!-- @if-statistics-start -->
 165     <tr>
 166       <td bgcolor=#eeeeee>
 167         <h2>Blocking Statistics:</h2>
 168         <blockquote>
 169 <!-- @if-have-stats-start -->
 170         @requests-blocked@ out of @requests-received@ requests have been blocked,
 171         which equals a block rate of @percent-blocked@.
 172 <!-- if-have-stats-end@ -->
 173 <!-- @if-have-no-stats-start -->
 174         There haven't been any requests so far.
 175 <!-- if-have-no-stats-end@ -->
 176       </td>
 177     </tr>
 178 <!-- if-statistics-end@ -->
 179
 180 <!-- @if-split-args-start -->
 181     <tr>
 182       <td bgcolor=#eeeeee>
 183         <h2>The following files are in use:</h2>
 184         <blockquote><p>Click a filename to browse</p></blockquote>
 185         <ul>
 186           <li>Actions List: <a href="show-status?file=permit">@actions-filename@</a></li>
 187 <!-- @if-pcrs-support-start -->
 188           <li>Regex Filter List: <a href="show-status?file=re">@re-filter-filename@</a></li>
 189 <!-- if-pcrs-support-end@ -->
 190 <!-- @if-trust-support-start -->
 191           <li>Trust List: <a href="show-status?file=trust">@trust-filename@</a></li>
 192 <!-- if-trust-support-end@ -->
 193         </ul>
 194       </td>
 195     </tr>
 196 <!-- if-split-args-end@ -->
 197
 198 <!-- @if-no-split-args-start -->
 199     <tr>
 200       <td bgcolor=#eeeeee>
 201         <h2>Actions List:</h2>
 202         <blockquote><pre>@alist@</pre></blockquote>
 203       </td>
 204     </tr>
 205
 206 <!-- @if-pcrs-support-start -->
 207     <tr>
 208       <td bgcolor=#eeeeee>
 209         <h2>Regex Filter List:</h2>
 210         <blockquote><pre>@rlist@</pre></blockquote>
 211       </td>
 212     </tr>
 213 <!-- if-pcrs-support-end@ -->
 214
 215 <!-- @if-trust-support-start -->
 216     <tr>
 217       <td bgcolor=#eeeeee>
 218         <h2>Trust List:</h2>
 219         <blockquote><pre>@tlist@</pre></blockquote>
 220       </td>
 221     </tr>
 222 <!-- if-trust-support-end@ -->
 223 <!-- if-no-split-args-end@ -->
 224
 225     <tr>
 226       <td bgcolor=#eeeeee>
 227         <h2>Source code versions:</h2>
 228         <blockquote><pre>@sourceversions@</pre></blockquote>
 229       </td>
 230     </tr>
 231
 232     <tr>
 233       <td bgcolor=#eeeeee>
 234         <h2>Conditional #defines:</h2>
 235         <ul>@defines@</ul>
 236       </td>
 237     </tr>
 238
 239     <tr>
 240       <td bgcolor=#dddddd>
 241         <h2>More Junkbuster:</h2>
 242         <ul>@menu@</ul>
 243       </td>
 244     </tr>
 245
 246     <tr>
 247       <td bgcolor=#dddddd>
 248         <p>If you have any questions about this service,
 249
 250 <!-- @if-have-proxy-info-start -->
 251           consult the <a href="@proxy-info-url@">online documentation</a> or
 252 <!-- if-have-proxy-info-end@ -->
 253
 254           <a href=mailto:@admin-address@>send mail to <code>@admin-address@</code></a>
 255           who will be glad to help you.
 256         </p>
 257       </td>
 258     </tr>
 259
 260   </table>
 261
 262 </body>
 263 </html>