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