templates/show-url-info

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