templates/show-url-info

   1 ########################################################################
   2 #
   3 # File        :  $Source: /cvsroot/ijbswa/current/templates/show-url-info,v $
   4 #
   5 # Purpose     :  Template for Privoxy's show-url-info CGI page.
   6 #
   7 # Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
   8 #                Privoxy team. http://www.privoxy.org/
   9 #
  10 #                This program is free software; you can redistribute it
  11 #                and/or modify it under the terms of the GNU General
  12 #                Public License as published by the Free Software
  13 #                Foundation; either version 2 of the License, or (at
  14 #                your option) any later version.
  15 #
  16 #                This program is distributed in the hope that it will
  17 #                be useful, but WITHOUT ANY WARRANTY; without even the
  18 #                implied warranty of MERCHANTABILITY or FITNESS FOR A
  19 #                PARTICULAR PURPOSE.  See the GNU General Public
  20 #                License for more details.
  21 #
  22 #                The GNU General Public License should be included with
  23 #                this file.  If not, you can view it at
  24 #                http://www.gnu.org/copyleft/gpl.html
  25 #                or write to the Free Software Foundation, Inc., 59
  26 #                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  27 #
  28 #########################################################################
  29 # USING HTML TEMPLATES:
  30 # ---------------------
  31 #
  32 # Template files are written win plain HTML, with a few
  33 # additions:
  34 #
  35 # - Lines that start with a '#' character like this one
  36 #   are ignored
  37 #
  38 # - Each item in the below list of exported symbols will
  39 #   be replaced by dynamically generated text, if they
  40 #   are enclosed in '@'-characters. E.g. The string @version@
  41 #   will be replaced by the version number of Privoxy.
  42 #
  43 # - One special application of this is to make whole blocks
  44 #   of the HTML template disappear if the condition <name>
  45 #   is not given. Simply enclose the block between the two
  46 #   strings @if-<name>start and if-<name>-end@. The strings
  47 #   should be placed in HTML comments (<!-- -->), so the
  48 #   html structure won't be messed when the magic happens.
  49 #
  50 # USABLE SYMBOLS IN THIS TEMPLATE:
  51 # --------------------------------
  52 #
  53 #  my-ip-addr:
  54 #    The IP-address that the client used to reach Privoxy
  55 #  my-hostname:
  56 #    The hostname associated with my-ip-addr
  57 #  admin-address:
  58 #    The email address of the Privoxy administrator, as configured
  59 #    in the config file
  60 #  default-cgi:
  61 #    The URL for Privoxy's "main menu" builtin CGI page
  62 #  menu:
  63 #    List of <li> elements linking to the other available CGIs
  64 #  version:
  65 #    Privoxy's version number
  66 #  code-status:
  67 #    Privoxy's development status: "alpha", "beta", or "stable".
  68 #  homepage:
  69 #    The Privoxy web site.
  70 #
  71 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
  72 # ------------------------------------------------------------------
  73 #
  74 #  unstable:
  75 #    this is an alpha or beta release of the proxy software
  76 #  have-adminaddr-info:
  77 #    An e-mail address for the local Privoxy administrator has
  78 #    been specified and is available through the "admin-address"
  79 #    symbol
  80 #  have-proxy-info:
  81 #    A URL for online documentation about this proxy has been
  82 #    specified and is available through the "proxy-info-url"
  83 #    symbol
  84 #  have-help-info:
  85 #    If either have-proxy-info is true or have-adminaddr-info is
  86 #    true, have-help-info is true.  Used to conditionally include
  87 #    a grey box for any and all help info.
  88 #  url-given:
  89 #    The CGI was called with a url parameter. In that case, the
  90 #    following symbols are available:
  91 #    url:
  92 #      The given URL
  93 #    default:
  94 #      The system default for actions
  95 #    matches:
  96 #      The list of all matches in the actions file that this URL
  97 #      produced, along with the actions that were triggered by
  98 #      these matches
  99 #    final:
 100 #      The actions that are associated with the URL at the end of
 101 #      the matching process
 102 #  no-forwarder: Requests to url will be made directly.
 103 #  http-forwarder:
 104 #      Requests to url will be made through a HTTP proxy
 105 #      forward-host:
 106 #         The IP address or its hostname
 107 #      forward-port.
 108 #         The proxy port
 109 #  socks-forwarder:
 110 #      Requests to url will be made through a socks proxy
 111 #      socks-type:
 112 #         The socks type: socks4 or socks4a
 113 #      gateway-host:
 114 #         The IP address or its hostname
 115 #      gateway-port:
 116 #         The proxy port.
 117 #
 118 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 119 <html>
 120
 121 <head>
 122   <title>Privoxy@@my-hostname@ URL Info</title>
 123   <meta http-equiv="Content-Style-Type" content="text/css">
 124   <meta http-equiv="Content-Script-Type" content="text/javascript">
 125   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 126   <meta name="robots" content="noindex,nofollow">
 127   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
 128   <link rel="shortcut icon" href="@default-cgi@favicon.ico" type="image/x-icon">
 129   <link rel="search" type="application/opensearchdescription+xml" title="Privoxy URL Info" href="/url-info-osd.xml">
 130 </head>
 131
 132 <body>
 133
 134   <table summary="" cellpadding="20" cellspacing="10" border="0" width="100%">
 135     <tr>
 136       <td class="title">
 137
 138 #include mod-title
 139
 140       </td>
 141     </tr>
 142
 143 <!-- @if-unstable-start -->
 144 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
 145     <tr>
 146       <td class="warning">
 147
 148 #include mod-unstable-warning
 149
 150       </td>
 151     </tr>
 152 <!-- if-unstable-end@ -->
 153
 154 <!-- @if-url-given-start -->
 155     <tr>
 156       <td class="box">
 157 <!-- @if-valid-url-start -->
 158         <h2>Forwarding settings:</h2>
 159         <p>
 160           Requests for <a href="@url@">@url@</a> will be <!--
 161
 162 # "Interesting" formatting to prevent white space at the end of the sentence.
 163
 164           @if-no-forwarder-start -->
 165
 166              made <b>directly</b>, no forwarding settings apply<!--
 167
 168           if-no-forwarder-end@--><!--
 169           @if-http-forwarder-start --><!-- @if-socks-forwarder-start -->
 170
 171              first <!--
 172
 173           if-socks-forwarder-end@ --><!-- if-http-forwarder-end@ --><!--
 174           @if-socks-forwarder-start -->
 175
 176              forwarded through <b>@socks-type@-proxy @gateway-host@:@gateway-port@</b><!--
 177
 178           if-socks-forwarder-end@ --><!--
 179           @if-http-forwarder-start --><!-- @if-socks-forwarder-start -->
 180
 181              and then <!--
 182
 183           if-socks-forwarder-end@ --><!-- if-http-forwarder-end@ --><!--
 184           @if-http-forwarder-start -->
 185
 186              forwarded through <b>HTTP-proxy @forward-host@:@forward-port@</b><!--
 187
 188           if-http-forwarder-end@ -->.
 189       </td>
 190     </tr>
 191     <tr>
 192       <td class="box">
 193 <!-- @if-https-start -->
 194         <h2>NOTE:</h2>
 195         <p>This is a HTTPS URL, so the part after the "/" is ignored
 196           as Privoxy doesn't see the path for real HTTPS requests either.</p>
 197 <!-- if-https-end@ -->
 198 <!-- if-valid-url-end@ -->
 199         <h2>Matches for <a href="@url@">@url@</a>:</h2>
 200         @matches@
 201 <!-- @if-valid-url-start -->
 202 <!-- @if-cgi-editor-is-disabled-start -->
 203         <p>
 204           The CGI editor is currently disabled, thus no edit buttons are shown.<br>
 205           Please have a look at the
 206            <a href="@user-manual@config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions documentation</a>
 207           to learn how to enable it and what the risks are.
 208         </p>
 209 <!--  if-cgi-editor-is-disabled-end@ -->
 210 <!-- @if-valid-url-end -->
 211       </td>
 212     </tr>
 213 <!-- @if-valid-url-start -->
 214 <!-- @if-filters-might-be-ineffective-start -->
 215     <tr>
 216       <td class="warning">
 217         <h2>Warning:</h2>
 218         <p>
 219           This Privoxy version has been built without zlib support,
 220           <strong>content filters will not work if the server sends compressed content.</strong>
 221           Consider enabling the <a title="prevent-compression documentation"
 222            href="@user-manual@actions-file.html#PREVENT-COMPRESSION">prevent-compression</a>
 223           action for this URL or rebuild Privoxy with zlib support.
 224         </p>
 225       </td>
 226     </tr>
 227 <!-- if-filters-might-be-ineffective-end@ -->
 228     <tr>
 229       <td class="box">
 230         <h2>Final results:</h2>
 231         <b>@final@</b>
 232       </td>
 233     </tr>
 234 <!-- if-valid-url-end@ -->
 235 <!-- if-url-given-end@ -->
 236
 237 <!-- @if-privoxy-is-toggled-off-start -->
 238
 239     <tr>
 240       <td class="warning">
 241         <h2>Warning:</h2>
 242         <p>
 243           <strong>Privoxy is currently toggled off. Matching actions will not apply
 244           unless you <a href="@default-cgi@toggle?set=enable">toggle Privoxy on</a> first.</strong>
 245         </p>
 246       </td>
 247     </tr>
 248 <!-- if-privoxy-is-toggled-off-end@ -->
 249
 250     <tr>
 251       <td class="box">
 252         <h2>Look up the actions for a
 253 <!-- @if-url-given-start -->new<!-- if-url-given-end@ -->
 254           URL:</h2>
 255         <form method="GET" action="@default-cgi@show-url-info">
 256           <p>
 257             <input type="text" name="url" size="80" value="@url@" class="url">
 258             <input type="submit" value="Go">
 259           </p>
 260         </form>
 261       </td>
 262     </tr>
 263
 264     <tr>
 265       <td class="box">
 266         <h2>More Privoxy:</h2>
 267         <ul>@menu@<li><a href="@user-manual@">Documentation</a></li></ul>
 268       </td>
 269     </tr>
 270
 271     <tr>
 272       <td class="info">
 273
 274 #include mod-support-and-service
 275
 276       </td>
 277     </tr>
 278
 279 <!-- @if-have-help-info-start -->
 280     <tr>
 281       <td class="info">
 282
 283 #include mod-local-help
 284
 285       </td>
 286     </tr>
 287 <!-- if-have-help-info-end@ -->
 288
 289   </table>
 290
 291 </body>
 292 </html>