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