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