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