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