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 # Revisions   :
  29 #    $Log: show-url-info,v $
  30 #    Revision 1.20  2007/07/21 12:19:50  fabiankeil
  31 #    If show-url-info is called with an URL that Privoxy
  32 #    would reject as invalid, don't show unresolved forwarding
  33 #    variables, "final matches" or claim the site's secure.
  34 #
  35 #    Revision 1.19  2007/02/10 16:55:22  fabiankeil
  36 #    - Show forwarding settings on the show-url-info page
  37 #    - Fix some HTML syntax errors.
  38 #
  39 #
  40 #########################################################################
  41 # USING HTML TEMPLATES:
  42 # ---------------------
  43 #
  44 # Template files are written win plain HTML, with a few
  45 # additions:
  46 #
  47 # - Lines that start with a '#' character like this one
  48 #   are ignored
  49 #
  50 # - Each item in the below list of exported symbols will
  51 #   be replaced by dynamically generated text, if they
  52 #   are enclosed in '@'-characters. E.g. The string @version@
  53 #   will be replaced by the version number of Privoxy.
  54 #
  55 # - One special application of this is to make whole blocks
  56 #   of the HTML template disappear if the condition <name>
  57 #   is not given. Simply enclose the block between the two
  58 #   strings @if-<name>start and if-<name>-end@. The strings
  59 #   should be placed in HTML comments (<!-- -->), so the
  60 #   html structure won't be messed when the magic happens.
  61 #
  62 # USABLE SYMBOLS IN THIS TEMPLATE:
  63 # --------------------------------
  64 #
  65 #  my-ip-addr:
  66 #    The IP-address that the client used to reach Privoxy
  67 #  my-hostname:
  68 #    The hostname associated with my-ip-addr
  69 #  admin-address:
  70 #    The email address of the Privoxy administrator, as configured
  71 #    in the config file
  72 #  default-cgi:
  73 #    The URL for Privoxy's "main menu" builtin CGI page
  74 #  menu:
  75 #    List of <li> elements linking to the other available CGIs
  76 #  version:
  77 #    Privoxy's version number
  78 #  code-status:
  79 #    Privoxy's development status: "alpha", "beta", or "stable".
  80 #  homepage:
  81 #    The Privoxy web site.
  82 #
  83 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
  84 # ------------------------------------------------------------------
  85 #
  86 #  unstable:
  87 #    this is an alpha or beta release of the proxy software
  88 #  have-adminaddr-info:
  89 #    An e-mail address for the local Privoxy adminstrator has
  90 #    been specified and is available through the "admin-address"
  91 #    symbol
  92 #  have-proxy-info:
  93 #    A URL for online documentation about this proxy has been
  94 #    specified and is available through the "proxy-info-url"
  95 #    symbol
  96 #  have-help-info:
  97 #    If either have-proxy-info is true or have-adminaddr-info is
  98 #    true, have-help-info is true.  Used to conditionally include
  99 #    a grey box for any and all help info.
 100 #  url-given:
 101 #    The CGI was called with a url parameter. In that case, the
 102 #    following symbols are available:
 103 #    url:
 104 #      The given URL
 105 #    default:
 106 #      The system default for actions
 107 #    matches:
 108 #      The list of all matches in the actions file that this URL
 109 #      produced, along with the actions that were triggered by
 110 #      these matches
 111 #    final:
 112 #      The actions that are associated with the URL at the end of
 113 #      the matching process
 114 #  no-forwarder: Requests to url will be made directly.
 115 #  http-forwarder:
 116 #      Requests to url will be made through a HTTP proxy
 117 #      forward-host:
 118 #         The IP address or its hostname
 119 #      forward-port.
 120 #         The proxy port
 121 #  socks-forwarder:
 122 #      Requests to url will be made through a socks proxy
 123 #      socks-type:
 124 #         The socks type: socks4 or socks4a
 125 #      gateway-host:
 126 #         The IP address or its hostname
 127 #      gateway-port:
 128 #         The proxy port.
 129 #
 130 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 131 <html>
 132
 133 <head>
 134   <title>Privoxy@@my-hostname@ URL Info</title>
 135   <meta http-equiv="Content-Style-Type" content="text/css">
 136   <meta http-equiv="Content-Script-Type" content="text/javascript">
 137   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 138   <meta name="robots" content="noindex,nofollow">
 139   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
 140   <link rel="shortcut icon" href="@default-cgi@favicon.ico" type="image/x-icon">
 141 </head>
 142
 143 <body>
 144
 145   <table summary="" cellpadding="20" cellspacing="10" border="0" width="100%">
 146     <tr>
 147       <td class="title">
 148
 149 #include mod-title
 150
 151       </td>
 152     </tr>
 153
 154 <!-- @if-unstable-start -->
 155 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
 156     <tr>
 157       <td class="warning">
 158
 159 #include mod-unstable-warning
 160
 161       </td>
 162     </tr>
 163 <!-- if-unstable-end@ -->
 164
 165 <!-- @if-url-given-start -->
 166     <tr>
 167       <td class="box">
 168 <!-- @if-valid-url-start -->
 169         <h2>Forwarding settings:</h2>
 170         <p>
 171           Requests for <a href="@url@">@url@</a> will be <!--
 172
 173 # "Interesting" formatting to prevent white space at the end of the sentence.
 174
 175           @if-no-forwarder-start -->
 176
 177              made <b>directly</b>, no forwarding settings apply<!--
 178
 179           if-no-forwarder-end@--><!--
 180           @if-http-forwarder-start --><!-- @if-socks-forwarder-start -->
 181
 182              first <!--
 183
 184           if-socks-forwarder-end@ --><!-- if-http-forwarder-end@ --><!--
 185           @if-socks-forwarder-start -->
 186
 187              forwarded through <b>@socks-type@-proxy @gateway-host@:@gateway-port@</b><!--
 188
 189           if-socks-forwarder-end@ --><!--
 190           @if-http-forwarder-start --><!-- @if-socks-forwarder-start -->
 191
 192              and then <!--
 193
 194           if-socks-forwarder-end@ --><!-- if-http-forwarder-end@ --><!--
 195           @if-http-forwarder-start -->
 196
 197              forwarded through <b>HTTP-proxy @forward-host@:@forward-port@</b><!--
 198
 199           if-http-forwarder-end@ -->.
 200       </td>
 201     </tr>
 202     <tr>
 203       <td class="box">
 204 <!-- @if-https-start -->
 205         <h2>NOTE:</h2>
 206         <p>This is a HTTPS URL, so the part after the "/" is ignored
 207           as Privoxy doesn't see the path for real HTTPS requests either.</p>
 208 <!-- if-https-end@ -->
 209 <!-- if-valid-url-end@ -->
 210         <h2>Matches for <a href="@url@">@url@</a>:</h2>
 211         @matches@
 212       </td>
 213     </tr>
 214 <!-- @if-valid-url-start -->
 215     <tr>
 216       <td class="box">
 217         <h2>Final results:</h2>
 218         <p><b>@final@</b></p>
 219       </td>
 220     </tr>
 221 <!-- if-valid-url-end@ -->
 222 <!-- if-url-given-end@ -->
 223
 224 <!-- @if-privoxy-is-toggled-off-start -->
 225
 226     <tr>
 227       <td class="warning">
 228         <h2>Warning:</h2>
 229         <p>
 230           <strong>Privoxy is currently toggled off. Matching actions will not apply
 231           unless you <a href="@default-cgi@toggle?set=enable">toggle Privoxy on</a> first.</strong>
 232         </p>
 233       </td>
 234     </tr>
 235 <!-- if-privoxy-is-toggled-off-end@ -->
 236
 237     <tr>
 238       <td class="box">
 239         <h2>Look up the actions for a
 240 <!-- @if-url-given-start -->new<!-- if-url-given-end@ -->
 241           URL:</h2>
 242         <form method="GET" action="@default-cgi@show-url-info">
 243           <p>
 244             <input type="text" name="url" size="80" value="@url@">
 245             <input type="submit" value="Go">
 246           </p>
 247         </form>
 248       </td>
 249     </tr>
 250
 251     <tr>
 252       <td class="box">
 253         <h2>More Privoxy:</h2>
 254         <ul>@menu@<li><a href="@user-manual@">Documentation</a></li></ul>
 255       </td>
 256     </tr>
 257
 258     <tr>
 259       <td class="info">
 260
 261 #include mod-support-and-service
 262
 263       </td>
 264     </tr>
 265
 266 <!-- @if-have-help-info-start -->
 267     <tr>
 268       <td class="info">
 269
 270 #include mod-local-help
 271
 272       </td>
 273     </tr>
 274 <!-- if-have-help-info-end@ -->
 275
 276   </table>
 277
 278 </body>
 279 </html>