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