Web.pm

   1 # $Id$
   2 # Common functions for HTML/XHTML output generation
   3 # Copyright (C) 2003-2005 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; exactly version 2 of June 1991 is required
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17
  18
  19 package My::Web;
  20 require 5.6.0;  # at least 'use warnings;' but we need some 5.6.0+ modules anyway
  21 our $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
  22 our $CVS_ID=q$Id$;
  23 use strict;
  24 use warnings;
  25
  26 use Exporter;
  27 sub Wrequire($);
  28 sub Wuse($@);
  29 our $W;
  30 our @EXPORT=qw(
  31                 &Wrequire &Wuse
  32                 &path_web &path_abs_disk
  33                 &uri_escaped
  34                 &a_href &a_href_cc
  35                 &vskip
  36                 &img &centerimg &rightimg
  37                 $W
  38                 &input_hidden_persistents
  39                 &escapeHTML
  40                 );
  41 our @ISA=qw(Tie::Handle Exporter);
  42
  43 my %packages_used_hash; # $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
  44 my %packages_used_array;
  45
  46 BEGIN
  47 {
  48         use Carp qw(cluck confess);
  49         $W->{"__My::Web_init"}=1;
  50
  51         sub Wrequire ($)
  52         {
  53         my($file)=@_;
  54
  55 #               print STDERR "Wrequire $file\n";
  56                 $file=~s#/#::#g;
  57                 $file=~s/[.]pm$//;
  58                 my $class=$file;
  59                 $file=~s#::#/#g;
  60                 $file.=".pm";
  61                 my %callers;
  62                 for (my $depth=0;defined caller($depth);$depth++) {
  63                         $callers{caller($depth)}=1;
  64                         }
  65                 my $selfpkg=__PACKAGE__;
  66                 $callers{$selfpkg}=1;
  67                 for my $target ($class,__PACKAGE__) {
  68                         for my $caller (keys(%callers)) {
  69                                 next if $caller eq $target;
  70                                 next if $packages_used_hash{$caller}{$target}++;
  71                                 cluck "Appending to the '_done' package list: caller=$caller,target=$target"
  72                                                 if $packages_used_hash{$caller}{"_done"};
  73                                 push @{$packages_used_array{$caller}},$target;
  74                                 }
  75                         }
  76                 eval { CORE::require "$file"; } or confess $@;
  77                 1;      # Otherwise 'require' would already file above.
  78         }
  79
  80         sub Wuse ($@)
  81         {
  82         my($file,@list)=@_;
  83
  84 #               print STDERR "Wuse $file\n";
  85                 Wrequire $file;
  86                 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
  87                 $file->import(@list);
  88                 1;
  89         }
  90
  91         sub import
  92         {
  93         my($class,@rest)=@_;
  94
  95                 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
  96                 Wrequire("$class");
  97                 return $class->SUPER::import(@rest);
  98         }
  99 }
 100
 101 use WebConfig;  # see also below: Wuse 'WebConfig';
 102 require CGI;
 103 require Image::Size;    # for &imgsize
 104 use File::Basename;     # &basename
 105 use Carp qw(cluck confess);
 106 use URI::Escape;
 107 require HTTP::BrowserDetect;
 108 require HTTP::Negotiate;
 109 our $have_Geo_IP; BEGIN { $have_Geo_IP=eval { require Geo::IP; 1; }; }
 110 # Do not: use ModPerl::Util qw(exit);
 111 # to prevent in mod_perl2: "exit" is not exported by the ModPerl::Util module
 112 # I do not know why.
 113 use POSIX qw(strftime);
 114 use Tie::Handle;
 115 use Apache2::Const qw(HTTP_MOVED_TEMPORARILY OK HTTP_OK);
 116 use URI;
 117 use URI::QueryParam;
 118 use Cwd;
 119 require HTTP::Date;
 120 require Storable;
 121 require Digest::MD5;
 122 require Data::Compare;
 123 use Data::Dumper;
 124 require Encode;
 125 use Apache2::Filter;
 126 use Apache2::Connection;
 127 require MIME::Base64;
 128 use Apache2::ServerUtil;
 129 require MIME::Types;
 130
 131
 132 #our $W;
 133
 134 sub init ($%)
 135 {
 136 my($class,%args)=@_;
 137
 138         print STDERR "$class->init ".Apache2::RequestUtil->request()->unparsed_uri()."\n";
 139
 140         # We need to track package dependencies, so we need to call it from &init.
 141         # We cannot do it in BEGIN { } block
 142         # as it would not be tracked for each of the toplevel users later.
 143         Wuse 'WebConfig';
 144         Wrequire 'My::Hash';
 145
 146         # $W={} can get somehow created very easily.
 147         # Do not: cluck "W not empty:\n".Dumper($W) if keys(%$W);
 148         # to prevent (of $W->{"headers_in"}): TODO: Enumeration may not be expected.
 149         cluck "W not empty; __PACKAGE__ was: ".$W->{"__PACKAGE__"} if keys(%$W);
 150         $W=My::Hash->new({},"My::Hash::Sub","My::Hash::Push");
 151         bless $W,$class;
 152         %$W=(
 153                 "__PACKAGE__"=>scalar(caller()),
 154                 %WebConfig,
 155                 %args,  # override %WebConfig settings
 156                 );
 157
 158         # {"__PACKAGE__"} is mandatory for mod_perl-2.0;
 159         # $Apache2::Registry::curstash is no longer supported.
 160         do { cluck "No $_" if !$W->{$_}; } for "__PACKAGE__";
 161         exit_hook_start();
 162
 163         # See: &escapeHTML
 164         do { cluck "charset==$_, expecting ISO-8859-1" if $_ ne "ISO-8859-1"; } for CGI::charset();
 165         CGI::charset("utf-8");
 166
 167         do { $W->{$_}=0  if !defined $W->{$_}; } for "detect_ent";
 168         do { $W->{$_}=0  if !defined $W->{$_}; } for "detect_js";
 169         do { $W->{$_}=1  if !defined $W->{$_}; } for "have_css";        # AFAIK it does not hurt anyone.
 170         do { $W->{$_}=0  if !defined $W->{$_}; } for "css_inherit";
 171         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer";
 172         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer_delimit";
 173         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer_ids";
 174         do { $W->{$_}=1  if !defined $W->{$_}; } for "indexme";
 175         do { $W->{$_}="" if !defined $W->{$_}; } for "head";
 176         do { $W->{$_}="" if !defined $W->{$_}; } for "body_attr";
 177         do { $W->{$_}="en-US" if !defined $W->{$_}; } for "language";
 178
 179         my $footer_any=0;
 180         for (qw(footer_ids)) {
 181                 $W->{$_}=0 if !$W->{"footer"};
 182                 $footer_any=1 if $W->{$_};
 183                 }
 184         $W->{"footer"}=0 if !$footer_any;
 185         $W->{"footer_delimit"}=0 if !$W->{"footer"};
 186
 187         $W->{"r"}=Apache2::RequestUtil->request();
 188
 189         $W->{"r"}->push_handlers("PerlCleanupHandler"=>\&cleanup);
 190
 191         $W->{"web_hostname"}||=$W->{"r"}->hostname();
 192
 193         tie *STDOUT,$W->{"r"};
 194         select *STDOUT;
 195         $|=1;
 196
 197         $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
 198         if ($W->{"detect_ent"}) {
 199                          if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
 200                         { $W->{"have_ent"}=0; }
 201                 elsif ($W->{"QUERY_STRING"}=~    /[&]have_ent/)
 202                         { $W->{"have_ent"}=1; }
 203                 else
 204                         { delete $W->{"have_ent"}; }
 205                 if (!defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
 206                         $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
 207                                         .escapeHTML("http://".$W->{"web_hostname"}."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
 208                                                         ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
 209                                         .'" />'."\n";
 210                         }
 211                 }
 212         $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
 213         $W->{"r"}->args($W->{"QUERY_STRING"});
 214         # Workaround: &CGI::Vars behaves weird if strings passed both as POST data and in: $QUERY_STRING
 215         do { $W->{"r"}->args(""); delete $ENV{"QUERY_STRING"}; } if $W->{"r"}->method() eq "POST";
 216         # Do not: $W->{"r"}->args()
 217         # as it parses only QUERY_STRING (not POST data).
 218         $W->{"args_orig_array"}=[ CGI->new($W->{"r"})->Vars() ];
 219         $W->{"args"}={ @{$W->{"args_orig_array"}} };
 220         for my $name (keys(%{$W->{"args"}})) {
 221                 my @vals=split /\x00/,$W->{"args"}{$name};
 222                 next if @vals<=1;
 223                 $W->{"args"}{$name}=[@vals];
 224                 }
 225
 226         $W->{"headers_in"}=$W->{"r"}->headers_in();
 227         Wrequire 'My::Hash::Merge';
 228         $W->{"headers_in"}=My::Hash::Merge->new(
 229                         $W->{"headers_in"},
 230                         My::Hash::Sub->new({
 231                                 "_remote_ip"=>sub { return $W->{"r"}->connection()->remote_ip(); },
 232                                 }),
 233                         );
 234         Wrequire 'My::Hash::Readonly';
 235         $W->{"headers_in"}=My::Hash::Readonly->new($W->{"headers_in"});
 236
 237         if ($W->{"r"}->method() eq "GET" || $W->{"r"}->method() eq "HEAD") {
 238                 for (\$W->{"http_safe"}) {
 239                         # Do not: # Extend the current ETag system instead if you would need it:
 240                         #         cluck "Explicitely NOT HTTP-Safe for method \"".$W->{"r"}->method()."\"?!?"
 241                         #                       if defined($$_) && !$$_;
 242                         # as sometimes it just does not make sense to cache it.
 243                         $$_=1 if !defined $$_;
 244                         }
 245                 }
 246         else {
 247                 for (\$W->{"http_safe"}) {
 248                         cluck "Undefined HTTP-Safe-ty for method \"".$W->{"r"}->method()."\"!"
 249                                         if !defined($$_);
 250                         $$_=0 if !defined $$_;
 251                         }
 252                 }
 253         if ($W->{"http_safe"}) {
 254                 Wrequire 'My::Hash::RecordKeys';
 255                 $W->{"headers_in_RecordKeys"}=My::Hash::RecordKeys->new($W->{"headers_in"});
 256                 $W->{"headers_in"}=$W->{"headers_in_RecordKeys"};
 257                 }
 258
 259         $W->{"browser"}=sub {
 260                 # Lazy-evaluation, we may not need the "User-Agent" header at all.
 261                 return our $r||=HTTP::BrowserDetect->new($W->{"headers_in"}{"User-Agent"});
 262                 };
 263
 264         if (!defined $W->{"have_style"}) {
 265                 $W->{"have_style"}=sub {
 266                         # Lazy-evaluation, we may not need the "User-Agent" header at all.
 267                         return our $r||=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
 268                         };
 269                 }
 270
 271         $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
 272         if ($W->{"detect_js"} && !$W->{"have_js"}) {
 273                 # Do not: <script />
 274                 # as at least Lynx inhibits any further HTML output.
 275                 $W->{"head"}.='<script type="text/javascript" src="'.uri_escaped(path_web('/My/HaveJS.pm')).'"></script>'."\n";
 276                 }
 277
 278         do { _args_check(%$_) if $_; } for ($W->{"args_check"});
 279
 280         $W->{"_init_done"}=1;
 281         return $W;
 282 }
 283
 284 sub cleanup($)
 285 {
 286 my($apache_request)=@_;
 287
 288         cluck "CORE::GLOBAL::exit hook not ran" if !$W->{"_exit_done"};
 289         cluck "packages not finalized" if !$packages_used_hash{$W->{"__PACKAGE__"}}{"_done"};
 290         cache_finish();
 291         # Sanity protection.
 292         $W=undef();
 293         exit_hook_stop();
 294         return OK;
 295 }
 296
 297 # PerlResponseHandler is RUN_FIRST and &ModPerl::Util::exit returns OK, so no (sane) go.
 298 # PerlLogHandler is already too late to be able to produce any output.
 299 my $exit_orig;
 300 sub exit_hook
 301 {
 302         cluck "Missing ->init while in exit_hook()" if !$W->{"_init_done"};
 303         # &footer will call us recursively!
 304         footer() if !$W->{"_exit_done"}++;
 305         return &{$exit_orig}(@_);
 306 }
 307 sub exit_hook_start
 308 {
 309         do { cluck "exit_hook_start() twice?"; return; } if defined $exit_orig;
 310         $exit_orig=\&CORE::GLOBAL::exit;
 311         # Prevent: Subroutine CORE::GLOBAL::exit redefined
 312         no warnings 'redefine';
 313         *CORE::GLOBAL::exit=\&exit_hook;
 314 }
 315 sub exit_hook_stop
 316 {
 317         do { cluck "exit_hook_stop() without exit_hook_start()?"; return; }
 318                         if \&exit_hook ne \&CORE::GLOBAL::exit;
 319         do { cluck "INTERNAL: exit_orig uninitialized"; return; }
 320                         if !$exit_orig;
 321         # Prevent: Subroutine CORE::GLOBAL::exit redefined
 322         no warnings 'redefine';
 323         *CORE::GLOBAL::exit=$exit_orig;
 324         $exit_orig=undef();
 325 }
 326
 327 # Be aware other parts of code (non-My::Web) will NOT use this function!
 328 # Do not: Wprint $W->{"heading"},"undef"=>1;
 329 # as we would need to undef() it to turn it off and it would get defaulted in such case.
 330 # Do not: exists $W->{"heading"}
 331 # as we use a lot of 'for $W->{"heading"}' which instantiates it with the value: undef()
 332 sub Wprint($%)
 333 {
 334 my($text,%args)=@_;
 335
 336         cluck "undef Wprint" if !defined $text && !$args{"undef"};
 337         delete $args{"undef"};
 338         cluck join(" ","Invalid arguments:",keys(%args)) if keys(%args);
 339         return if !defined $text;
 340         # Do not: cluck "utf-8 untested" if Encode::is_utf8($text);
 341         # as it is valid here.
 342         $W->{"r"}->puts($text);
 343 }
 344
 345 sub request_check(;$)
 346 {
 347 my($self)=@_;
 348
 349         # Use &eval to prevent: Global $r object is not available. Set:\n\tPerlOptions +GlobalRequest\nin ...
 350         # CGI requires valid "r": check it beforehand here.
 351         confess "Calling sensitive dynamic code from a static code" if !eval { Apache2::RequestUtil->request(); };
 352         # Do not: confess "Calling sensitive dynamic code without My::Web::init" if !$W->{"__PACKAGE__"};
 353         # as it is valid at least while preparing arguments to call: &project::Lib::init
 354 }
 355
 356 sub escapeHTML($)
 357 {
 358 my($text)=@_;
 359
 360         # Prevent &CGI::escapeHTML breaking utf-8 strings like: \xC4\x9B eq \x{11B}
 361         # Prevent case if we run under mod_perl but still just initializing:
 362         request_check() if $ENV{"MOD_PERL"};
 363         # Generally we are initialized from &init but we may be used without it without mod_perl
 364         # and in such case check the change on all non-first invocations.
 365         our $init;
 366         if (!$ENV{"MOD_PERL"} && $init++) {
 367                 do { cluck "charset==$_" if $_ ne "utf-8"; } for CGI::charset();
 368                 }
 369         CGI::charset("utf-8");
 370
 371         return CGI::escapeHTML($text);
 372 }
 373
 374 # /home/user/www/webdir
 375 sub dir_top_abs_disk()
 376 {
 377         our $dir_top_abs_disk;
 378         if (!$dir_top_abs_disk) {
 379                 my $selfpkg_relpath=__PACKAGE__;
 380                 $selfpkg_relpath=~s{::}{/}g;
 381                 $selfpkg_relpath.=".pm";
 382                 my $selfpkg_abspath=$INC{$selfpkg_relpath} or do {
 383                         cluck "Unable to find self package $selfpkg_relpath";
 384                         return;
 385                         };
 386                 $selfpkg_abspath=~s{/*\Q$selfpkg_relpath\E$}{} or do {
 387                         cluck "Unable to strip myself \"$selfpkg_relpath\" from the abspath: $selfpkg_abspath";
 388                         return;
 389                         };
 390                 cluck "INC{myself} is relative?: $selfpkg_abspath" if $selfpkg_abspath!~m{^/};
 391                 $dir_top_abs_disk=$selfpkg_abspath;
 392                 }
 393         return $dir_top_abs_disk;
 394 }
 395
 396 sub unparsed_uri()
 397 {
 398         request_check();
 399         if (!$W->{"unparsed_uri"}) {
 400                 # Do not: $W->{"r"}
 401                 # as we may be called before &init from: &My::Project::init
 402                 my $r=Apache2::RequestUtil->request();
 403                 cluck "Calling ".'&unparsed_uri'." from a static code, going to fail" if !$r;
 404                 my $uri_string=$r->unparsed_uri() or cluck "Valid 'r' missing unparsed_uri()?";
 405                 my $uri=URI->new_abs($uri_string,"http://".$W->{"web_hostname"}."/");
 406                 $W->{"unparsed_uri"}=$uri;
 407                 }
 408         return $W->{"unparsed_uri"};
 409 }
 410
 411 sub in_to_uri_abs($)
 412 {
 413 my($in)=@_;
 414
 415         # Otherwise we may have been already processed and thus legally relativized.
 416         # FIXME data: Currently disabled, all the data are too violating such rule.
 417         if (0 && !ref $in) {
 418                 my $uri_check=URI->new($in);
 419                 $uri_check->scheme() || $in=~m{^\Q./\E} || $in=~m{^/}
 420                                 or cluck "Use './' or '/' prefix for all the local references: $in";
 421                 }
 422         my $uri=URI->new_abs($in,unparsed_uri());
 423         $uri=$uri->canonical();
 424         return $uri;
 425 }
 426
 427 # $args{"uri_as_in"}=1 to permit passing URI objects as: $in
 428 # $args{"abs"}=1;
 429 sub path_web($%)
 430 {
 431 my($in,%args)=@_;
 432
 433         cluck if !$args{"uri_as_in"} && ref $in;
 434         my $uri=in_to_uri_abs($in);
 435         if (uri_is_local($uri)) {
 436                 # Prefer the $uri values over "args_persistent" values.
 437                 $uri->query_form_hash({
 438                                 map({
 439                                         my $key=$_;
 440                                         my $val=$W->{"args"}{$key};
 441                                         (!defined $val ? () : ($key=>$val));
 442                                         } keys(%{$W->{"args_persistent"}})),
 443                                 %{$uri->query_form_hash()},
 444                                 });
 445                 }
 446         return $uri->abs(unparsed_uri()) if $W->{"args"}{"Wabs"} || $args{"abs"};
 447         return $uri->rel(unparsed_uri());
 448 }
 449
 450 sub path_abs_disk_register($)
 451 {
 452 my($path_abs_disk)=@_;
 453
 454         $W->{"path_abs_disk_register"}{$path_abs_disk}=1;
 455 }
 456
 457 # $args{"uri_as_in"}=1 to permit passing URI objects as: $in
 458 sub path_abs_disk($%)
 459 {
 460 my($in,%args)=@_;
 461
 462         cluck if !$args{"uri_as_in"} && ref $in;
 463         my $uri=in_to_uri_abs($in);
 464         cluck if !uri_is_local($uri);
 465         my $path=$uri->path();
 466         cluck "URI compatibility: ->path() not w/leading slash of URI \"$uri\"; path: $path" if $path!~m{^/};
 467         my $r=dir_top_abs_disk().$path;
 468         path_abs_disk_register $r if !defined $args{"register"} || $args{"register"};
 469         return $r;
 470 }
 471
 472 sub fatal (;$);
 473
 474 sub _args_check (%)
 475 {
 476 my(%tmpl)=@_;
 477
 478         while (my($name,$regex)=each(%tmpl)) {
 479                 my $name_html="Parameter <span class=\"quote\">".escapeHTML($name)."</span>";
 480                 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
 481                 $W->{"args"}{$name}=[ $W->{"args"}{$name} ] if !ref $W->{"args"}{$name} && ref $regex;
 482                 fatal "$name_html passed as multivar although singlevar expected"
 483                                 if ref $W->{"args"}{$name} && !ref $regex;
 484                 $regex=$regex->[0] if ref $regex;
 485                 for my $val (!ref $W->{"args"}{$name} ? $W->{"args"}{$name} : @{$W->{"args"}{$name}}) {
 486                         $val="" if !defined $val;
 487                         fatal "$name_html <span class=\"quote\">".escapeHTML($val)."</span>"
 488                                                         ." does not match the required regex <span class=\"quote\">".escapeHTML($regex)."</span> "
 489                                         if $regex ne "" && $val!~/$regex/;
 490                         }
 491                 }
 492 }
 493
 494 sub vskip (;$)
 495 {
 496 my($height)=@_;
 497
 498         return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'>&nbsp;</p>'."\n";
 499 }
 500
 501 sub fatal (;$)
 502 {
 503 my($msg)=@_;
 504
 505         $msg="UNKNOWN" if !$msg;
 506         cluck "FATAL: $msg";
 507
 508         # Do not send it unconditionally.
 509         # The intial duplicated '<?xml...' crashes Gecko parser.
 510         $W->{"heading_done"}=0 if $W->{"header_only"};
 511         # Do not send it unconditionally.
 512         # Prevents warn: Headers already sent
 513         if (!$W->{"heading_done"}) {
 514                 $W->{"indexme"}=0;      # For the case no heading was sent yet.
 515                 $W->{"header_only"}=0;  # assurance for &heading
 516                 My::Web->heading();
 517                 }
 518         Wprint "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
 519                         ."<p>You can report this problem's details to"
 520                         ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
 521         exit;
 522 }
 523
 524 sub footer_packages_used_comments()
 525 {
 526         my $packages_used=$packages_used_array{$W->{"__PACKAGE__"}};
 527         for my $package (@$packages_used) {
 528                 my $cvs_id=(eval('$'.$package."::CVS_ID")
 529 #                               || $package     # debug
 530                                 );
 531                 Wprint '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
 532                 }
 533 }
 534
 535 sub footer()
 536 {
 537         cluck 'Explicit &footer call is deprecated, !_exit_dne' if !$W->{"_exit_done"};
 538         exit if $W->{"footer_done"}++;  # deadlock prevention:
 539         &{$_}() for reverse @{$W->{"footer_sub_push"}};
 540         if ($W->{"header_only"}) {
 541                 $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
 542                 exit;
 543                 }
 544
 545         Wprint vskip if $W->{"footer_delimit"};
 546         &{$_}() for reverse @{$W->{"footing_delimit_sub_push"}};
 547         Wprint "<hr />\n" if $W->{"footer"};
 548
 549         # Never update the package list while we examine it!
 550         $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
 551
 552         my $packages_used=$packages_used_array{$W->{"__PACKAGE__"}};
 553         if ($W->{"footer_ids"}) {
 554                 Wprint '<p class="cvs-id">';
 555                 Wprint join("<br />\n",map({ my $package=$_;
 556                         my $cvs_id=(eval('$'.$package."::CVS_ID")
 557 #                                       || $package     # debug
 558                                         );
 559                         if (!$cvs_id) {
 560                                 ();
 561                                 }
 562                         else {
 563                                 $cvs_id='$'.$cvs_id.'$';        # Eaten by 'q' operator.
 564                                 my @cvs_id_split=split / +/,$cvs_id;
 565                                 if (@cvs_id_split==8) {
 566                                         my $file=$package;
 567                                         $file=~s#::#/#g;
 568                                         my $ext;
 569                                         my @tried;
 570                                         for (qw(.pm)) {
 571                                                 $ext=$_;
 572                                                 my $path_abs_disk=path_abs_disk("/$file$ext");
 573                                                 push @tried,$path_abs_disk;
 574                                                 last if -r $path_abs_disk;
 575                                                 cluck "Class file $file not found; tried: ".join(" ",@tried) if !$ext;
 576                                                 }
 577                                         $file.=$ext;
 578                                         my $viewcvs;
 579                                         if ((my $file_cvs=$file)=~s{^My/}{}) {
 580                                                 $viewcvs=$W->{"viewcvs_My"}.$file_cvs;
 581                                                 }
 582                                         else {
 583                                                 $viewcvs=$W->{"viewcvs"}.$file;
 584                                                 }
 585                                         $cvs_id_split[2]=""
 586                                                         .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $viewcvs))[0]."?rev=".$cvs_id_split[2],
 587                                                                         $cvs_id_split[2]);
 588                                         $cvs_id_split[1]=a_href($viewcvs,($package!~/^Apache2::/ ? $package : $cvs_id_split[1]));
 589                                         $cvs_id_split[5]=&{$W->{"cvs_id_author_sub"}}($cvs_id_split[5]);
 590                                         }
 591                                 join " ",@cvs_id_split;
 592                                 }
 593                         } @$packages_used));
 594                 Wprint "</p>\n";
 595                 }
 596
 597         footer_packages_used_comments();
 598
 599         do { Wprint $_ if $_; } for $W->{"footing"};
 600
 601         Wprint "</body></html>\n";
 602         exit;
 603 }
 604
 605 # Existing entries are overwritten.
 606 sub header(%)
 607 {
 608 my(%pairs)=@_;
 609
 610         while (my($key,$val)=each(%pairs)) {
 611                 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
 612                 $W->{"r"}->headers_out()->set($key,$val);
 613                 }
 614 }
 615
 616 sub size_display ($)
 617 {
 618 my($size)=@_;
 619
 620            if ($size<4096)
 621                 {}
 622         elsif ($size<1024*1024)
 623                 { $size=sprintf "%.1fK",$size/1024; }
 624         else
 625                 { $size=sprintf "%.1fM",$size/1024/1024; }
 626         $size.="B";
 627         return $size;
 628 }
 629
 630 sub uri_is_local($)
 631 {
 632 my($in)=@_;
 633
 634         my $uri_rel=in_to_uri_abs($in)->rel(unparsed_uri());
 635         # Do not: defined $uri_rel->("userinfo"|"host"|"port")();
 636         # as they fail to be called for schemes not supporting them.
 637         return 0 if $uri_rel->scheme();
 638         return 0 if $uri_rel->authority();
 639         return 1;
 640 }
 641
 642 # &path_web still may be required for &uri_escaped !
 643 sub uri_escaped($)
 644 {
 645 my($uri)=@_;
 646
 647         cluck if !ref $uri;
 648         my $urient=escapeHTML($uri);
 649         return $uri    if $uri eq $urient;
 650         request_check();
 651         return $urient if uri_is_local $uri;
 652         return $uri    if defined $W->{"have_ent"} && !$W->{"have_ent"};        # non-ent client
 653         return $urient if $W->{"have_ent"};     # ent client
 654         # Unknown client, &escapeHTML should not be needed here:
 655         return escapeHTML(path_web('/My/Redirect.pm?location='.uri_escape($uri->abs(unparsed_uri()))));
 656 }
 657
 658 our $a_href_inhibited;
 659 sub a_href($;$%)
 660 {
 661 my($in,$contents,%args)=@_;
 662
 663         request_check();
 664         do { $$_=1 if !defined $$_; } for (\$args{"size"});
 665         if (!defined $contents) {
 666                 $contents=$in;
 667                 $contents=File::Basename::basename($contents) if $args{"basename"};
 668                 $contents=escapeHTML($contents);
 669                 }
 670         $contents=~s#<a\b[^>]*>##gi;
 671         $contents=~s#</a>##gi;
 672         return $contents if $a_href_inhibited;
 673
 674         my $path_web=path_web $in,%args;
 675         my $r="";
 676         $r.='<a href="';
 677         $r.=uri_escaped $path_web;
 678         $r.='"';
 679         do { $r.=" $_" if $_; } for ($args{"attr"});
 680         $r.='>'.$contents.'</a>';
 681         if ($args{"size"} && uri_is_local($in) && ($args{"size"}>=2 || $in=~/[.](?:gz|Z|rpm|zip|deb|lha)/)) {   # Downloadable?
 682                 my $path_abs_disk=path_abs_disk $in,%args;
 683                 cluck "File not readable: $path_abs_disk" if !-r $path_abs_disk;
 684                 $r.='&nbsp;('.size_display((stat($path_abs_disk))[7]).')';
 685                 }
 686         return $r;
 687 }
 688
 689 sub a_href_inhibit($$;@)
 690 {
 691 my($self,$sub,@sub_args)=@_;
 692
 693         local $a_href_inhibited=1;
 694         return &{$sub}(@sub_args);
 695 }
 696
 697 sub input_hidden_persistents()
 698 {
 699         request_check();
 700         return join("",map({
 701                 my $key=$_;
 702                 my $val=$W->{"args"}{$key};
 703                 (!defined $val ? () : '<input type="hidden"'
 704                                 .' name="'.escapeHTML($key).'"'
 705                                 .' value="'.escapeHTML($val).'"'
 706                                 .' />'."\n");
 707                 } (keys(%{$W->{"args_persistent"}}))));
 708 }
 709
 710 sub http_moved($$;$)
 711 {
 712 my($self,$url,$status)=@_;
 713
 714         $url=path_web($url,"abs"=>1);
 715         $status||=HTTP_MOVED_TEMPORARILY;
 716         $W->{"r"}->status($status);
 717         $W->{"r"}->headers_out()->{"Location"}=$url;
 718         $W->{"header_only"}=1;
 719         $W->{"content_type"}=0;
 720         $W->{"charset"}=0;
 721         My::Web->heading();
 722         exit;
 723         die "NOTREACHED";
 724 }
 725
 726 sub remote_ip ()
 727 {
 728         # Do not: PerlModule                 Apache2::ForwardedFor
 729         #         PerlPostReadRequestHandler Apache2::ForwardedFor
 730         # As 'Apache2::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
 731         # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
 732         # We must take the last item ourselves.
 733         # Be VERY sure you always retrieve all the headers unconditionally to hit: My::Hash::RecordKeys
 734         my $x_forwarded_for=$W->{"headers_in"}{"X-Forwarded-For"};
 735         $x_forwarded_for=~s/^.*,\s*// if $x_forwarded_for;
 736         my $remote_ip=$W->{"headers_in"}{"_remote_ip"};
 737         my $r;
 738         $r||=$x_forwarded_for;
 739         $r||=$remote_ip;
 740         return $r;
 741 }
 742
 743 # $url={"JP"=>"http://specific",...};
 744 # $url={""=>"http://default",...};
 745 sub a_href_cc($$;%)
 746 {
 747 my($url,$contents,%args)=@_;
 748
 749         # A bit ineffective but we must process all the possibilities to get stable 'headers_in' hits!
 750         my %map=map(($_=>a_href($url->{$_},$contents,%args)),keys(%$url));
 751         my $cc;
 752         $cc||=Geo::IP->new()->country_code_by_addr(remote_ip()) if $have_Geo_IP;
 753         $cc||="";
 754         my $r=$map{$cc};
 755         return $r if $r;
 756         return $contents;
 757 }
 758
 759 sub make ($)
 760 {
 761 my($cmd)=@_;
 762
 763         # FIXME: &alarm, --timeout is now infinite.
 764         # FIXME: Try to remove bash(1).
 765         # FIXME: Use: @PATH_FLOCK@
 766         my @argv=('flock',dir_top_abs_disk(),'bash','-c',$cmd.' >&2');
 767         print STDERR join(" ","SPAWN:",@argv)."\n";
 768         system @argv;
 769 }
 770
 771 sub make_file($$)
 772 {
 773 my($self,$file)=@_;
 774
 775         cluck "Pathname not absolute: $file" if $file!~m{^/};
 776         return if -f $file;
 777         # TODO: Somehow quickly check dependencies?
 778         return make('make -s --no-print-directory'
 779                                         .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'");
 780 }
 781
 782 sub img_size ($$)
 783 {
 784 my($width,$height)=@_;
 785
 786         cluck if !defined $width || !defined $height;
 787         return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
 788                         ." width=\"$width\" height=\"$height\"";
 789 }
 790
 791 sub negotiate_variant (%)
 792 {
 793 my(%args)=@_;
 794
 795         my @fields=("id","qs","content-type","encoding","charset","lang","size");
 796         return [ map(($args{$_}),@fields) ];
 797 }
 798
 799 # Input: $self is required!
 800 # Input: Put the fallback variant as the first one.
 801 # Returns: always only scalar!
 802 sub Negotiate_choose($$)
 803 {
 804 my($self,$variants)=@_;
 805
 806         # Limit these entries to generate proper 'Vary' header.
 807         my %hash=(map(($_=>$W->{"headers_in"}{$_}),qw(
 808                         Accept
 809                         Accept-Charset
 810                         Accept-Encoding
 811                         Accept-Language
 812                         )));
 813         my $best=HTTP::Negotiate::choose($variants,
 814                         # Do not: $W->{"r"}
 815                         # to prevent: Can't locate object method "scan" via package "Apache2::RequestRec" at HTTP/Negotiate.pm line 84.
 816                         # Do not: $W->{"r"}->headers_in()
 817                         # to prevent: Can't locate object method "scan" via package "APR::Table" at HTTP/Negotiate.pm line 84.
 818                         # Do not: HTTP::Headers->new($W->{"r"}->headers_in());
 819                         # to prevent empty result or even: Odd number of elements in anonymous hash
 820                         HTTP::Headers->new(%hash));
 821         $best||=$variants->[0][0];      # $variants->[0]{"id"}; &HTTP::Negotiate::choose failed?
 822         return $best;
 823 }
 824
 825 my @img_variants=(
 826                 { "id"=>"png","qs"=>0.9,"content-type"=>"image/png" },
 827                 { "id"=>"gif","qs"=>0.7,"content-type"=>"image/gif" },
 828                 );
 829 my $img_variants_re='[.](?:'.join('|',"jpeg",map(($_->{"id"}),@img_variants)).')$';
 830
 831 # Returns: ($path_web,$path_abs_disk)
 832 # URI path segments support ignored here. Where it is used? (';' path segment options)
 833 sub _img_src($%)
 834 {
 835 my($in,%args)=@_;
 836
 837         cluck if !uri_is_local $in;
 838         my $uri=in_to_uri_abs $in;
 839         my $path_abs_disk=path_abs_disk $uri,%args,"uri_as_in"=>1,"register"=>0;
 840
 841         # Known image extension?
 842         return path_web($uri,%args,"uri_as_in"=>1),$path_abs_disk if $uri->path()=~m#$img_variants_re#o;
 843
 844         my @nego_variants;
 845         for my $var (@img_variants) {
 846                 my $path_abs_disk_variant=$path_abs_disk.".".$var->{"id"};
 847                 path_abs_disk_register($path_abs_disk_variant);
 848                 __PACKAGE__->make_file($path_abs_disk_variant);
 849                 push @nego_variants,negotiate_variant(
 850                                 %$var,
 851                                 "size"=>(stat $path_abs_disk_variant)[7],
 852                                 );
 853                 }
 854         my $ext=__PACKAGE__->Negotiate_choose(\@nego_variants);
 855
 856         $uri->path($uri->path().".$ext");
 857         return path_web($uri,%args,"uri_as_in"=>1),path_abs_disk($uri,%args,"uri_as_in"=>1);
 858 }
 859
 860 # $args{"attr"}
 861 sub img ($$%)
 862 {
 863 my($in,$alt,%args)=@_;
 864
 865         request_check();
 866         my($path_web,$path_abs_disk)=_img_src($in,%args);
 867         my($width,$height)=Image::Size::imgsize($path_abs_disk);
 868         $alt=~s/<[^>]*>//g;
 869         $alt=escapeHTML($alt);
 870         my $content="<img src=\"".uri_escaped($path_web)."\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
 871                         .(!$args{"attr"} ? "" : " ".$args{"attr"})." />";
 872         do { return a_href((_img_src($_))[0],$content,"uri_as_in"=>1) if $_; } for $args{"a_href_img"};
 873         do { return a_href $_,$content if $_; } for $args{"a_href"};
 874         return $content;
 875 }
 876
 877 sub centerimg
 878 {
 879         my $r="";
 880         $r.='<table border="0" width="100%"><tr>'."\n";
 881         @_=( [@_] ) if !ref $_[0];
 882         for (@_) {
 883                 $r.="\t".'<td align="center">'.&{\&img}(@$_).'</td>'."\n";
 884                 }
 885         $r.='</tr></table>'."\n";
 886         return $r;
 887 }
 888
 889 sub rightimg
 890 {
 891 my($text,@args_img)=@_;
 892
 893         # FIXME: Workaround bug of 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)':
 894         #        <col width="@{[ (!$W->{"browser"}->ie() ? "1*" : "90%" ) ]}" />
 895         #        <col width="@{[ (!$W->{"browser"}->ie() ? "0*" : "10%" ) ]}" />
 896         # causes whole invisible projects in: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.7.10) Gecko/20050719 Galeon/1.3.21
 897         return <<"HERE";
 898 <table border="0" width="100%">
 899         <tr>
 900                 <td align="left">
 901                         @{[ $text ]}
 902                 </td>
 903                 <td align="right">
 904                         @{[ &{\&img}(@args_img) ]}
 905                 </td>
 906         </tr>
 907 </table>
 908 HERE
 909 }
 910
 911 sub readfile($$)
 912 {
 913 my($class,$filename)=@_;
 914
 915         local *F;
 916         open F,$filename or cluck "Cannot open \"$filename\": $!";
 917         my $F=do { local $/=undef(); <F>; };
 918         close F or cluck "Cannot close \"$filename\": $!";
 919         return $F;
 920 }
 921
 922 sub _no_cache($)
 923 {
 924 my($self)=@_;
 925
 926         header("Expires"=>HTTP::Date::time2str(1000000000));    # date in the past
 927         header("Last-Modified"=>HTTP::Date::time2str());        # always modified
 928         header("Cache-Control"=>join(", ",
 929                         "no-cache",
 930                         "no-store",
 931                         "must-revalidate",
 932                         "max-age=0",
 933                         "pre-check=0",  # MSIE
 934                         "post-check=0", # MSIE
 935                         ));     # HTTP/1.1
 936         header("Pragma"=>"no-cache");   # HTTP/1.0
 937         header("Vary"=>"*");    # content may ba based on unpredictable sources
 938 }
 939
 940 sub headers_in_filtered(@)
 941 {
 942 my(@keys)=@_;
 943
 944         return map(($_=>$W->{"headers_in"}{$_}),@keys);
 945 }
 946
 947 our %uri_args_frozen_to_headers_in_keys;
 948 our %uri_args_headers_in_frozen_to_headers_out;
 949
 950 sub uri_args_headers_in_frozen_get($)
 951 {
 952 my($headers_in_keys_arrayref)=@_;
 953
 954         my %uri_args_headers_in_hash=(
 955                 "uri_args_frozen"=>$W->{"uri_args_frozen"},
 956                 "headers_in"=>{ headers_in_filtered(@$headers_in_keys_arrayref) },
 957                 );
 958         return do { local $Storable::canonical=1; Storable::freeze(\%uri_args_headers_in_hash); };
 959 }
 960
 961 sub cache_output_filter($)
 962 {
 963 my($f)=@_;
 964
 965         while ($f->read(my $text,0x400)) {
 966                 cluck "utf-8 untested" if Encode::is_utf8($text);       # Possible here at all?
 967                 $f->print($text);
 968                 $W->{"digest-md5"}->add($text);
 969                 }
 970         return OK;
 971 }
 972
 973 sub cache_start()
 974 {
 975         if (!$W->{"http_safe"}) {
 976                 __PACKAGE__->_no_cache();
 977                 return;
 978                 }
 979
 980         {
 981                 # &Wrequire it here even if it will not be later used; to be stable!
 982                 Wrequire 'My::Hash::RestrictTo';
 983                 my %uri_args_hash=(
 984                         "uri"=>"http://".$W->{"web_hostname"}."/".$W->{"r"}->uri(),
 985                         "args"=>$W->{"args_orig_array"},
 986                         );
 987                 $W->{"uri_args_frozen"}=do { local $Storable::canonical=1; Storable::freeze(\%uri_args_hash); };
 988                 last if !(my $headers_in_keys_arrayref=$uri_args_frozen_to_headers_in_keys{$W->{"uri_args_frozen"}});
 989
 990                 # Protection to be sure we are stable:
 991                 $W->{"headers_in"}=My::Hash::RestrictTo->new($W->{"headers_in"},@$headers_in_keys_arrayref);
 992
 993                 $W->{"uri_args_headers_in_frozen"}=uri_args_headers_in_frozen_get($headers_in_keys_arrayref);
 994                 last if !(my $headers_out_hashref=$uri_args_headers_in_frozen_to_headers_out{$W->{"uri_args_headers_in_frozen"}});
 995                 header(%$headers_out_hashref);
 996                 my $status;
 997                 {
 998                         # &meets_conditions will always deny the attempt if !2xx status().
 999                         # At least ap_read_request() sets: r->status=HTTP_REQUEST_TIME_OUT;     /* Until we get a request */
1000                         my $status_old=$W->{"r"}->status();
1001                         $W->{"r"}->status(HTTP_OK);
1002                         # Update httpd's 'r->mtime' as the header "Last-Modified" is just not enough for ap_meets_conditions():
1003                         # &update_mtime() argument is really in _secs_, not in _msecs_ as the docs claim.
1004                         # Be aware '*1000000' would overflow Perl integer anyway.
1005                         # &set_last_modified would also override the "Last-Modified" headers_out!
1006                         # &mtime may exist but somehow does not work.
1007                         $W->{"r"}->update_mtime(HTTP::Date::str2time($headers_out_hashref->{"Last-Modified"}));
1008                         $status=$W->{"r"}->meets_conditions();
1009                         $W->{"r"}->status($status_old);
1010                         }
1011                 last if OK==$status;
1012                 $W->{"r"}->status($status);
1013                 $W->{"header_only"}=1;  # Inhibit &footer output.
1014                 exit;
1015                 die "NOTREACHED";
1016                 }
1017
1018         $W->{"digest-md5"}=Digest::MD5->new();
1019         $W->{"cache_active"}=1;
1020         $W->{"r"}->add_output_filter(\&cache_output_filter);
1021 }
1022
1023 sub cache_finish_last_modified()
1024 {
1025         cluck "Not yet done now? W __PACKAGE__: ".$W->{"__PACKAGE__"}
1026                         if !$packages_used_hash{$W->{"__PACKAGE__"}}{"_done"};
1027         for my $package_orig (@{$packages_used_array{$W->{"__PACKAGE__"}}}) {
1028                 local $_=$package_orig.".pm";
1029                 s{::}{/}g;
1030                 path_abs_disk "/$_","register"=>1;
1031                 }
1032         my $mtime_newest;
1033         for my $path_abs_disk (keys(%{$W->{"path_abs_disk_register"}})) {
1034                 my $mtime=(stat $path_abs_disk)[9];
1035                 do { cluck "No mtime for: $path_abs_disk"; next; } if !$mtime;
1036                 $mtime_newest=$mtime if !$mtime_newest || $mtime_newest<$mtime;
1037                 }
1038         cluck "No mtime_newest found for the current W __PACKAGE__: ".$W->{"__PACKAGE__"}
1039                         if !$mtime_newest;
1040         return HTTP::Date::time2str($mtime_newest);
1041 }
1042
1043
1044 sub cache_finish()
1045 {
1046         # Do not: return if !$W->{"uri_args_frozen"};
1047         # as we may have just gave 304 and 'exit;' without starting the caching.
1048         return if !$W->{"cache_active"};
1049
1050         # Fill-in/check: %uri_args_frozen_to_headers_in_keys
1051         my $headers_in_keys_stored_arrayref_ref=\$uri_args_frozen_to_headers_in_keys{$W->{"uri_args_frozen"}};
1052         my @headers_in_keys=tied(%{$W->{"headers_in_RecordKeys"}})->accessed();
1053         if (!$$headers_in_keys_stored_arrayref_ref
1054                         || !Data::Compare::Compare(\@headers_in_keys,$$headers_in_keys_stored_arrayref_ref)) {
1055                 cluck "Non-matching generated 'headers_in_keys' per 'uri_args_frozen' key:\n"
1056                                                 .Dumper(\@headers_in_keys,$$headers_in_keys_stored_arrayref_ref)
1057                                 if $$headers_in_keys_stored_arrayref_ref;
1058                 # Build or possibly prevent such further warn dupes:
1059                 $$headers_in_keys_stored_arrayref_ref=\@headers_in_keys;
1060                 # Build or regenerate as obsoleted now:
1061                 $W->{"uri_args_headers_in_frozen"}=uri_args_headers_in_frozen_get(\@headers_in_keys);
1062                 }
1063
1064         # Prepare 'headers_out' for the future reusal:
1065         my %headers_out;
1066         # Do not: $W->{"digest-md5"}->b64digest();
1067         # as it will not provide the trailing filling '='s.
1068         # RFC 1864 is not clear if they should be there but its sample provides them.
1069         # Do not try to provide canonical "\r\n" form of newlines as is said by RFC 1864.
1070         # RFC 2068 (HTTP/1.1) section 14.16 says the newlines should NOT be converted for HTTP.
1071         # ',""' to avoid breaking the headers by its default "\n".
1072         $headers_out{"Content-MD5"}=MIME::Base64::encode_base64($W->{"digest-md5"}->digest(),"");
1073         # In fact we could also use MD5 for ETag as if we know ETag we also know MD5.
1074         # But this way we do not need to calculate MD5 and we still can provide such ETag. So.
1075         # $W->{"r"}->set_etag() ?
1076         $headers_out{"ETag"}='"'.Digest::MD5::md5_base64($W->{"uri_args_headers_in_frozen"}).'"';
1077         # $W->{"r"}->set_content_length() ?
1078         $headers_out{"Content-Length"}=$W->{"r"}->bytes_sent();
1079         my %Vary=map(($_=>1),(@headers_in_keys));
1080         for (keys(%Vary)) {
1081                 next if !/^_/;
1082                 $Vary{"*"}=1;
1083                 delete $Vary{$_};
1084                 }
1085         %Vary=("*"=>1) if $Vary{"*"};
1086         $headers_out{"Vary"}=join(", ",sort keys(%Vary)) if keys(%Vary);
1087         # $W->{"r"}->set_last_modified() ?
1088         $headers_out{"Last-Modified"}=cache_finish_last_modified();
1089
1090         # Fill-in/check: %uri_args_headers_in_frozen_to_headers_out
1091         my $headers_out_stored_hashref_ref=\$uri_args_headers_in_frozen_to_headers_out{$W->{"uri_args_headers_in_frozen"}};
1092         if (!$$headers_out_stored_hashref_ref
1093                         || !Data::Compare::Compare(\%headers_out,$$headers_out_stored_hashref_ref)) {
1094                 cluck "Non-matching generated 'headers_out' per 'uri_args_headers_in_frozen' key:\n"
1095                                                 .Dumper(\%headers_out,$$headers_out_stored_hashref_ref)
1096                                 if $$headers_out_stored_hashref_ref;
1097                 # Build or possibly prevent such further warn dupes:
1098                 $$headers_out_stored_hashref_ref=\%headers_out;
1099                 }
1100
1101 ###print STDERR Dumper(\%uri_args_frozen_to_headers_in_keys,\%uri_args_headers_in_frozen_to_headers_out);
1102 }
1103
1104 sub heading()
1105 {
1106 my($class)=@_;
1107
1108         if (!$W->{"header_only"}) {
1109                 header("Content-Style-Type"=>"text/css");
1110                 header("Content-Script-Type"=>"text/javascript");
1111                 # $W->{"r"}->content_languages() ?
1112                 do { header("Content-Language"=>$_) if $_; } for $W->{"language"};
1113                 }
1114         # TODO: Support also: private
1115         header("Cache-Control"=>"public");      # HTTP/1.1
1116
1117         # Use $W->{"charset"}=0 to disable charset.
1118         $W->{"charset"}="us-ascii"
1119                         if !defined $W->{"charset"} && (!defined($W->{"content_type"}) || $W->{"content_type"});
1120
1121         # Workaround bug
1122         #   https://bugzilla.mozilla.org/show_bug.cgi?id=120556
1123         # of at least
1124         #   Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
1125         # http://validator.w3.org/ does not send ANY "Accept" headers!
1126         $W->{"content_type"}="application/xhtml+xml" if !defined $W->{"content_type"}
1127                         && !$W->{"headers_in"}{"Accept"}
1128                         && ($W->{"headers_in"}{"User-Agent"}||"")=~m{^W3C_Validator/}i;
1129         defined($W->{"content_type"}) or $W->{"content_type"}=$class->Negotiate_choose([
1130                         # Put the fallback variant as the first one.
1131                         # Rate both variants the same to prefer "text/html" for undecided clients.
1132                         # At least
1133                         #   Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
1134                         # prefers "application/xhtml+xml" over "text/html" itself:
1135                         #   text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
1136                         negotiate_variant(
1137                                         "id"=>"text/html",
1138                                         "content-type"=>"text/html",
1139                                         "qs"=>0.6,
1140                                         (!$W->{"charset"} ? () : "charset"=>$W->{"charset"}),
1141                                         "lang"=>$W->{"language"},
1142                                         ),
1143                         negotiate_variant(
1144                                         "id"=>"application/xhtml+xml",
1145                                         "content-type"=>"application/xhtml+xml",
1146                                         "qs"=>0.6,
1147                                         (!$W->{"charset"} ? () : "charset"=>$W->{"charset"}),
1148                                         "lang"=>$W->{"language"},
1149                                         ),
1150                         # application/xml ?
1151                         # text/xml ?
1152                         ]);
1153         # mod_perl doc: If you set this header via the headers_out table directly, it
1154         #               will be ignored by Apache. So do not do that.
1155         my $type;
1156         if ($W->{"content_type"}) {
1157                 $type=MIME::Types->new()->type($W->{"content_type"});
1158                 cluck "MIME::Types type '".$W->{"content_type"}."' not known" if !$type;
1159                 }
1160         cluck "charset='".$W->{"charset"}."' does not match content-type='".$W->{"content_type"}."'"
1161                         if ($W->{"charset"} ? 1 : 0) != (!$type ? 0 : $type->isAscii());
1162         $W->{"r"}->content_type($W->{"content_type"}.(!$W->{"charset"} ? "" : "; charset=".$W->{"charset"}))
1163                         if $W->{"content_type"};
1164
1165         cache_start();
1166         # We still can append headers before we put out some text.
1167         # FIXME: It is not clean to still append them without overwriting.
1168         return if $W->{"heading_done"};
1169         Wprint '<?xml version="1.0" encoding="'.$W->{"charset"}.'"?>'."\n"
1170                         if (!$W->{"header_only"} || $W->{"header_only"} eq "xml") && (0
1171                                         || $W->{"content_type"}=~m{^application/\w+[+]xml$}
1172                                         || $W->{"content_type"} eq "text/vnd.wap.wml");
1173         return if $W->{"header_only"};
1174         # Split 'heading_done' for the proper handling of: /project/Rel.pm
1175         $W->{"heading_done"}++;
1176
1177         Wprint '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
1178         Wprint '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="'.$W->{"language"}.'">'."\n";
1179         my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
1180         # Do not: cluck if $title=~/[<>]/;
1181         # as it is not solved just by: &a_href_inhibit
1182         # as sometimes titles use also: <i>...</i>
1183         $title=~s#<[^>]*>##g;
1184         Wprint "<head>";
1185         Wprint "<title>$title</title>\n";
1186         if ($W->{"have_css"}) {
1187                 # Everything can get overriden later.
1188                 for my $css ("/My/Web.css",@{$W->{"css_push"}}) {
1189                         Wprint <<"HERE";
1190 <link rel="stylesheet" type="text/css" href="@{[ uri_escaped(path_web $css) ]}" />
1191 HERE
1192                         }
1193                 if ($W->{"css_inherit"}) {
1194                         # Do not: <script />
1195                         # as at least Lynx inhibits any further HTML output.
1196                         Wprint <<"HERE";
1197 <script type="text/javascript" src="@{[ uri_escaped(path_web('/My/css_inherit.js')) ]}"></script>
1198 HERE
1199                         }
1200                 }
1201         Wprint '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
1202         Wprint $W->{"head"};
1203         for my $type (qw(prev next index contents start up)) {
1204                 do { Wprint '<link rel="'.$type.'" href="'.uri_escaped(path_web $_).'" />'."\n" if $_; }
1205                                 for ($W->{"rel_$type"});
1206                 }
1207         Wprint "</head><body";
1208 #       Wprint ' bgcolor="black" text="white" link="aqua" vlink="teal"'
1209 #                       if $W->{"browser"}->netscape() && (!$W->{"browser"}->major() || $W->{"browser"}->major()<=4);
1210         Wprint $W->{"body_attr"};
1211         Wprint ">\n";
1212
1213         do { Wprint $_ if $_; } for $W->{"heading"};
1214 }
1215
1216 BEGIN {
1217         delete $W->{"__My::Web_init"};
1218         }
1219
1220 1;