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