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