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_cz
  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                                 push @{$packages_used_array{$caller}},$target;
  72                                 }
  73                         }
  74                 eval { CORE::require "$file"; } or confess $@;
  75                 1;      # Otherwise 'require' would already file above.
  76         }
  77
  78         sub Wuse ($@)
  79         {
  80         my($file,@list)=@_;
  81
  82 #               print STDERR "Wuse $file\n";
  83                 Wrequire $file;
  84                 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
  85                 $file->import(@list);
  86                 1;
  87         }
  88
  89         sub import
  90         {
  91         my($class,@rest)=@_;
  92
  93                 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
  94                 Wrequire("$class");
  95                 return $class->SUPER::import(@rest);
  96         }
  97 }
  98
  99 use WebConfig;  # see also below: Wuse 'WebConfig';
 100 require CGI;
 101 require Image::Size;    # for &imgsize
 102 use File::Basename;     # &basename
 103 use Carp qw(cluck confess);
 104 use URI::Escape;
 105 require HTTP::BrowserDetect;
 106 require HTTP::Negotiate;
 107 my $have_Geo_IP; BEGIN { $have_Geo_IP=eval { require Geo::IP; 1; }; }
 108 # Do not: use ModPerl::Util qw(exit);
 109 # to prevent in mod_perl2: "exit" is not exported by the ModPerl::Util module
 110 # I do not know why.
 111 use POSIX qw(strftime);
 112 use Tie::Handle;
 113 use Apache2::Const qw(HTTP_MOVED_TEMPORARILY OK);
 114 use URI;
 115 use URI::QueryParam;
 116 use Cwd;
 117 require HTTP::Date;
 118
 119
 120 #our $W;
 121                 # $W->{"title"}
 122                 # $W->{"head"}
 123                 # $W->{"force_charset"}
 124                 # $W->{"heading_done"}
 125                 # $W->{"footer_passed"}
 126                 # %{$W->{"headers"}}
 127                 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
 128                 # %{$W->{"args"}}
 129
 130 sub cleanup($)
 131 {
 132 my($apache_request)=@_;
 133
 134         $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
 135         # Sanity protection.
 136         $W=undef();
 137         return OK;
 138 }
 139
 140 sub request_check(;$)
 141 {
 142 my($self)=@_;
 143
 144         # Use &eval to prevent: Global $r object is not available. Set:\n\tPerlOptions +GlobalRequest\nin ...
 145         # CGI requires valid "r": check it beforehand here.
 146         confess "Calling sensitive dynamic code from a static code" if !eval { Apache2::RequestUtil->request(); };
 147         # Do not: confess "Calling sensitive dynamic code without My::Web::init" if !$W->{"__PACKAGE__"};
 148         # as it is valid at least while preparing arguments to call: &project::Lib::init
 149 }
 150
 151 sub init ($%)
 152 {
 153 my($class,%args)=@_;
 154
 155         print STDERR "$class->init ".Apache2::RequestUtil->request()->unparsed_uri()."\n";
 156
 157         # We need to track package dependencies, so we need to call it from &init.
 158         # We cannot do it in BEGIN { } block
 159         # as it would not be tracked for each of the toplevel users later.
 160         Wuse 'WebConfig';
 161         Wrequire 'My::Hash::Sub';
 162
 163         $W={};
 164         tie %$W,"My::Hash::Sub";
 165         %$W=(%WebConfig,%args); # override %WebConfig settings
 166         $W->{"__PACKAGE__"}||=caller();
 167
 168         # {"__PACKAGE__"} is mandatory for mod_perl-2.0;
 169         # $Apache2::Registry::curstash is no longer supported.
 170         do { cluck "No $_" if !$W->{$_}; } for "__PACKAGE__";
 171
 172         # See: &escapeHTML
 173         do { cluck "charset==$_, expecting ISO-8859-1" if $_ ne "ISO-8859-1"; } for CGI::charset();
 174         CGI::charset("utf-8");
 175
 176         do { $W->{$_}=0  if !defined $W->{$_}; } for "detect_ent";
 177         do { $W->{$_}=0  if !defined $W->{$_}; } for "detect_js";
 178         do { $W->{$_}=1  if !defined $W->{$_}; } for "have_css";        # AFAIK it does not hurt anyone.
 179         do { $W->{$_}=0  if !defined $W->{$_}; } for "css_inherit";
 180         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer";
 181         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer_delimit";
 182         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer_ids";
 183         do { $W->{$_}=1  if !defined $W->{$_}; } for "indexme";
 184         do { $W->{$_}="" if !defined $W->{$_}; } for "head";
 185         do { $W->{$_}="" if !defined $W->{$_}; } for "body_attr";
 186         do { $W->{$_}="en-US" if !defined $W->{$_}; } for "language";
 187
 188         my $footer_any=0;
 189         for (qw(footer_ids)) {
 190                 $W->{$_}=0 if !$W->{"footer"};
 191                 $footer_any=1 if $W->{$_};
 192                 }
 193         $W->{"footer"}=0 if !$footer_any;
 194         $W->{"footer_delimit"}=0 if !$W->{"footer"};
 195
 196         $W->{"r"}=Apache2::RequestUtil->request();
 197
 198         $W->{"r"}->push_handlers("PerlCleanupHandler"=>\&cleanup);
 199
 200         $W->{"web_hostname"}||=$W->{"r"}->hostname();
 201
 202         tie *STDOUT,$W->{"r"};
 203         select *STDOUT;
 204         $|=1;
 205
 206         $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
 207         if ($W->{"detect_ent"}) {
 208                          if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
 209                         { $W->{"have_ent"}=0; }
 210                 elsif ($W->{"QUERY_STRING"}=~    /[&]have_ent/)
 211                         { $W->{"have_ent"}=1; }
 212                 else
 213                         { delete $W->{"have_ent"}; }
 214                 if (!defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
 215                         $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
 216                                         .escapeHTML("http://".$W->{"web_hostname"}."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
 217                                                         ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
 218                                         .'" />'."\n";
 219                         }
 220                 }
 221         $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
 222         $W->{"r"}->args($W->{"QUERY_STRING"});
 223         # Workaround: &CGI::Vars behaves weird if strings passed both as POST data and in: $QUERY_STRING
 224         do { $W->{"r"}->args(""); delete $ENV{"QUERY_STRING"}; } if $W->{"r"}->method() eq "POST";
 225         # Do not: $W->{"r"}->args()
 226         # as it parses only QUERY_STRING (not POST data).
 227         $W->{"args"}={ CGI->new($W->{"r"})->Vars() };
 228         for my $name (keys(%{$W->{"args"}})) {
 229                 my @vals=split /\x00/,$W->{"args"}{$name};
 230                 next if @vals<=1;
 231                 $W->{"args"}{$name}=[@vals];
 232                 }
 233
 234         do { $W->{$_}=$W->{"r"}->headers_in()->{"Accept"}         if !defined $W->{$_}; } for ("accept");
 235         do { $W->{$_}=$W->{"r"}->headers_in()->{"User-Agent"}||"" if !defined $W->{$_}; } for ("user_agent");
 236
 237         $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
 238
 239         if (!defined $W->{"have_style"}) {
 240                 $W->{"have_style"}=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
 241                 }
 242
 243         $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
 244         if ($W->{"detect_js"} && !$W->{"have_js"}) {
 245                 $W->{"head"}.='<script type="text/javascript" src="'.uri_escaped(path_web('/have_js.pm')).'"></script>'."\n";
 246                 }
 247
 248         do { _args_check(%$_) if $_; } for ($W->{"args_check"});
 249
 250         return bless $W,$class;
 251 }
 252
 253 # Although we have &tie-d *STDOUT we try to not to be dependent on it in My::Web itself.
 254 # Do not: Wprint $W->{"heading"},"undef"=>1;
 255 # as we would need to undef() it to turn it off and it would get defaulted in such case.
 256 # Do not: exists $W->{"heading"}
 257 # as we use a lot of 'for $W->{"heading"}' which instantiates it with the value: undef()
 258 sub Wprint($%)
 259 {
 260 my($text,%args)=@_;
 261
 262         cluck "undef Wprint" if !defined $text && !$args{"undef"};
 263         delete $args{"undef"};
 264         cluck join(" ","Invalid arguments:",keys(%args)) if keys(%args);
 265         $W->{"r"}->puts($text) if defined $text;
 266 }
 267
 268 sub escapeHTML($)
 269 {
 270 my($text)=@_;
 271
 272         # Prevent &CGI::escapeHTML breaking utf-8 strings like: \xC4\x9B eq \x{11B}
 273         # Prevent case if we run under mod_perl but still just initializing:
 274         request_check() if $ENV{"MOD_PERL"};
 275         # Generally we are initialized from &init but we may be used without it without mod_perl
 276         # and in such case check the change on all non-first invocations.
 277         our $init;
 278         if (!$ENV{"MOD_PERL"} && $init++) {
 279                 do { cluck "charset==$_" if $_ ne "utf-8"; } for CGI::charset();
 280                 }
 281         CGI::charset("utf-8");
 282
 283         return CGI::escapeHTML($text);
 284 }
 285
 286 # local *FH;
 287 # tie *FH,ref($W),$W;
 288 sub TIEHANDLE($)
 289 {
 290 my($class,$W)=@_;
 291
 292         my $self={};
 293         $self->{"W"}=$W or confess "Missing W";
 294         return bless $self,$class;
 295 }
 296
 297 sub WRITE
 298 {
 299 my($self,$scalar,$length,$offset)=@_;
 300
 301         Wprint substr($scalar,0,$length);
 302 }
 303
 304 # /home/user/www/webdir
 305 sub dir_top_abs_disk()
 306 {
 307         our $dir_top_abs_disk;
 308         if (!$dir_top_abs_disk) {
 309                 my $selfpkg_relpath=__PACKAGE__;
 310                 $selfpkg_relpath=~s{::}{/}g;
 311                 $selfpkg_relpath.=".pm";
 312                 my $selfpkg_abspath=$INC{$selfpkg_relpath} or do {
 313                         cluck "Unable to find self package $selfpkg_relpath";
 314                         return;
 315                         };
 316                 $selfpkg_abspath=~s{/*\Q$selfpkg_relpath\E$}{} or do {
 317                         cluck "Unable to strip myself \"$selfpkg_relpath\" from the abspath: $selfpkg_abspath";
 318                         return;
 319                         };
 320                 cluck "INC{myself} is relative?: $selfpkg_abspath" if $selfpkg_abspath!~m{^/};
 321                 $dir_top_abs_disk=$selfpkg_abspath;
 322                 }
 323         return $dir_top_abs_disk;
 324 }
 325
 326 sub unparsed_uri()
 327 {
 328         request_check();
 329         if (!$W->{"unparsed_uri"}) {
 330                 # Do not: $W->{"r"}
 331                 # as we may be called before &init from: &My::Project::init
 332                 my $r=Apache2::RequestUtil->request();
 333                 cluck "Calling ".'&unparsed_uri'." from a static code, going to fail" if !$r;
 334                 my $uri_string=$r->unparsed_uri() or cluck "Valid 'r' missing unparsed_uri()?";
 335                 my $uri=URI->new_abs($uri_string,"http://".$W->{"web_hostname"}."/");
 336                 $W->{"unparsed_uri"}=$uri;
 337                 }
 338         return $W->{"unparsed_uri"};
 339 }
 340
 341 sub in_to_uri_abs($)
 342 {
 343 my($in)=@_;
 344
 345         # Otherwise we may have been already processed and thus legally relativized.
 346         # FIXME data: Currently disabled, all the data are too violating such rule.
 347         if (0 && !ref $in) {
 348                 my $uri_check=URI->new($in);
 349                 $uri_check->scheme() || $in=~m{^\Q./\E} || $in=~m{^/}
 350                                 or cluck "Use './' or '/' prefix for all the local references: $in";
 351                 }
 352         my $uri=URI->new_abs($in,unparsed_uri());
 353         $uri=$uri->canonical();
 354         return $uri;
 355 }
 356
 357 # $args{"uri_as_in"}=1 to permit passing URI objects as: $in
 358 # $args{"abs"}=1;
 359 sub path_web($%)
 360 {
 361 my($in,%args)=@_;
 362
 363         cluck if !$args{"uri_as_in"} && ref $in;
 364         my $uri=in_to_uri_abs($in);
 365         if (uri_is_local($uri)) {
 366                 # Prefer the $uri values over "args_persistent" values.
 367                 $uri->query_form_hash({
 368                                 map({
 369                                         my $key=$_;
 370                                         my $val=$W->{"args"}{$key};
 371                                         (!defined $val ? () : ($key=>$val));
 372                                         } keys(%{$W->{"args_persistent"}})),
 373                                 %{$uri->query_form_hash()},
 374                                 });
 375                 }
 376         return $uri->abs(unparsed_uri()) if $W->{"args"}{"Wabs"} || $args{"abs"};
 377         return $uri->rel(unparsed_uri());
 378 }
 379
 380 my %path_abs_disk_for_package;  # $path_abs_disk_for_package{$W->{"__PACKAGE__"}}{$path_abs_disk}=1;
 381
 382 sub path_abs_disk_register($)
 383 {
 384 my($path_abs_disk)=@_;
 385
 386         $path_abs_disk_for_package{$W->{"__PACKAGE__"}}{$path_abs_disk}=1;
 387 }
 388
 389 # $args{"uri_as_in"}=1 to permit passing URI objects as: $in
 390 sub path_abs_disk($%)
 391 {
 392 my($in,%args)=@_;
 393
 394         cluck if !$args{"uri_as_in"} && ref $in;
 395         my $uri=in_to_uri_abs($in);
 396         cluck if !uri_is_local($uri);
 397         my $path=$uri->path();
 398         cluck "URI compatibility: ->path() not w/leading slash of URI \"$uri\"; path: $path" if $path!~m{^/};
 399         my $r=dir_top_abs_disk().$path;
 400         path_abs_disk_register $r if !defined $args{"register"} || $args{"register"};
 401         return $r;
 402 }
 403
 404 sub fatal (;$);
 405
 406 sub _args_check (%)
 407 {
 408 my(%tmpl)=@_;
 409
 410         while (my($name,$regex)=each(%tmpl)) {
 411                 my $name_html="Parameter <span class=\"quote\">".escapeHTML($name)."</span>";
 412                 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
 413                 $W->{"args"}{$name}=[ $W->{"args"}{$name} ] if !ref $W->{"args"}{$name} && ref $regex;
 414                 fatal "$name_html passed as multivar although singlevar expected"
 415                                 if ref $W->{"args"}{$name} && !ref $regex;
 416                 $regex=$regex->[0] if ref $regex;
 417                 for my $val (!ref $W->{"args"}{$name} ? $W->{"args"}{$name} : @{$W->{"args"}{$name}}) {
 418                         $val="" if !defined $val;
 419                         fatal "$name_html <span class=\"quote\">".escapeHTML($val)."</span>"
 420                                                         ." does not match the required regex <span class=\"quote\">".escapeHTML($regex)."</span> "
 421                                         if $regex ne "" && $val!~/$regex/;
 422                         }
 423                 }
 424 }
 425
 426 sub vskip (;$)
 427 {
 428 my($height)=@_;
 429
 430         return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'>&nbsp;</p>'."\n";
 431 }
 432
 433 sub fatal (;$)
 434 {
 435 my($msg)=@_;
 436
 437         $msg="UNKNOWN" if !$msg;
 438         cluck "FATAL: $msg";
 439
 440         # Do not send it unconditionally.
 441         # The intial duplicated '<?xml...' crashes Gecko parser.
 442         $W->{"heading_done"}=0 if $W->{"header_only"};
 443         # Do not send it unconditionally.
 444         # Prevents warn: Headers already sent
 445         if (!$W->{"heading_done"}) {
 446                 $W->{"indexme"}=0;      # For the case no heading was sent yet.
 447                 $W->{"header_only"}=0;  # assurance for &heading
 448                 My::Web->heading();
 449                 }
 450         Wprint "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
 451                         ."<p>You can report this problem's details to"
 452                         ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
 453         footer();
 454 }
 455
 456 sub footer (;$)
 457 {
 458         exit 1 if $W->{"footer_passed"}++;      # deadlock prevention:
 459
 460         Wprint vskip if $W->{"footer_delimit"};
 461
 462         do { Wprint $_ if $_; } for $W->{"footing_delimit"};
 463
 464         Wprint "<hr />\n" if $W->{"footer"};
 465
 466         my $packages_used=$packages_used_array{$W->{"__PACKAGE__"}};
 467
 468         if ($W->{"footer_ids"}) {
 469                 Wprint '<p class="cvs-id">';
 470                 Wprint join("<br />\n",map({ my $package=$_;
 471                         my $cvs_id=(eval('$'.$package."::CVS_ID")
 472 #                                       || $package     # debug
 473                                         );
 474                         if (!$cvs_id) {
 475                                 ();
 476                                 }
 477                         else {
 478                                 $cvs_id='$'.$cvs_id.'$';        # Eaten by 'q' operator.
 479                                 my @cvs_id_split=split / +/,$cvs_id;
 480                                 if (@cvs_id_split==8) {
 481                                         my $file=$package;
 482                                         $file=~s#::#/#g;
 483                                         my $ext;
 484                                         my @tried;
 485                                         for (qw(.pm)) {
 486                                                 $ext=$_;
 487                                                 my $path_abs_disk=path_abs_disk("/$file$ext");
 488                                                 push @tried,$path_abs_disk;
 489                                                 last if -r $path_abs_disk;
 490                                                 cluck "Class file $file not found; tried: ".join(" ",@tried) if !$ext;
 491                                                 }
 492                                         $file.=$ext;
 493                                         $cvs_id_split[2]=""
 494                                                         .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
 495                                                                         $cvs_id_split[2]);
 496                                         $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
 497                                                         ($package!~/^Apache2::/ ? $package : $cvs_id_split[1]));
 498                                         $cvs_id_split[5]=&{$W->{"cvs_id_author_sub"}}($cvs_id_split[5]);
 499                                         }
 500                                 join " ",@cvs_id_split;
 501                                 }
 502                         } @$packages_used));
 503                 Wprint "</p>\n";
 504                 }
 505
 506         for my $package (@$packages_used) {
 507                 my $cvs_id=(eval('$'.$package."::CVS_ID")
 508 #                               || $package     # debug
 509                                 );
 510                 Wprint '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
 511                 }
 512
 513         do { Wprint $_ if $_; } for $W->{"footing"};
 514
 515         Wprint "</body></html>\n";
 516         exit 0;
 517 }
 518
 519 sub header (%)
 520 {
 521 my(%pairs)=@_;
 522
 523         while (my($key,$val)=each(%pairs)) {
 524                 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
 525                 for ($W->{"headers_lc"}{lc $key} || ()) {
 526                         delete $W->{"headers"}{$_};
 527                         }
 528                 $W->{"headers_lc"}{lc $key}=$key;
 529                 $W->{"headers"}{$key}=$val;
 530                 }
 531 }
 532
 533 sub size_display ($)
 534 {
 535 my($size)=@_;
 536
 537            if ($size<4096)
 538                 {}
 539         elsif ($size<1024*1024)
 540                 { $size=sprintf "%.1fK",$size/1024; }
 541         else
 542                 { $size=sprintf "%.1fM",$size/1024/1024; }
 543         $size.="B";
 544         return $size;
 545 }
 546
 547 sub uri_is_local($)
 548 {
 549 my($in)=@_;
 550
 551         my $uri_rel=in_to_uri_abs($in)->rel(unparsed_uri());
 552         # Do not: defined $uri_rel->("userinfo"|"host"|"port")();
 553         # as they fail to be called for schemes not supporting them.
 554         return 0 if $uri_rel->scheme();
 555         return 0 if $uri_rel->authority();
 556         return 1;
 557 }
 558
 559 # &path_web still may be required for &uri_escaped !
 560 sub uri_escaped($)
 561 {
 562 my($uri)=@_;
 563
 564         cluck if !ref $uri;
 565         my $urient=escapeHTML($uri);
 566         return $uri    if $uri eq $urient;
 567         request_check();
 568         return $urient if uri_is_local $uri;
 569         return $uri    if defined $W->{"have_ent"} && !$W->{"have_ent"};        # non-ent client
 570         return $urient if $W->{"have_ent"};     # ent client
 571         # Unknown client, &escapeHTML should not be needed here:
 572         return escapeHTML(path_web('/Redirect.pm?location='.uri_escape($uri->abs(unparsed_uri()))));
 573 }
 574
 575 our $a_href_inhibited;
 576 sub a_href($;$%)
 577 {
 578 my($in,$contents,%args)=@_;
 579
 580         request_check();
 581         do { $$_=1 if !defined $$_; } for (\$args{"size"});
 582         if (!defined $contents) {
 583                 $contents=$in;
 584                 $contents=File::Basename::basename($contents) if $args{"basename"};
 585                 $contents=escapeHTML($contents);
 586                 }
 587         $contents=~s#<a\b[^>]*>##gi;
 588         $contents=~s#</a>##gi;
 589         return $contents if $a_href_inhibited;
 590
 591         my $path_web=path_web $in,%args;
 592         my $r="";
 593         $r.='<a href="';
 594         $r.=uri_escaped $path_web;
 595         $r.='"';
 596         do { $r.=" $_" if $_; } for ($args{"attr"});
 597         $r.='>'.$contents.'</a>';
 598         if ($args{"size"} && uri_is_local($in) && ($args{"size"}>=2 || $in=~/[.](?:gz|Z|rpm|zip|deb|lha)/)) {   # Downloadable?
 599                 my $path_abs_disk=path_abs_disk $in,%args;
 600                 cluck "File not readable: $path_abs_disk" if !-r $path_abs_disk;
 601                 $r.='&nbsp;('.size_display((stat($path_abs_disk))[7]).')';
 602                 }
 603         return $r;
 604 }
 605
 606 sub a_href_inhibit($$;@)
 607 {
 608 my($self,$sub,@sub_args)=@_;
 609
 610         local $a_href_inhibited=1;
 611         return &{$sub}(@sub_args);
 612 }
 613
 614 sub input_hidden_persistents()
 615 {
 616         request_check();
 617         return join("",map({
 618                 my $key=$_;
 619                 my $val=$W->{"args"}{$key};
 620                 (!defined $val ? () : '<input type="hidden"'
 621                                 .' name="'.escapeHTML($key).'"'
 622                                 .' value="'.escapeHTML($val).'"'
 623                                 .' />'."\n");
 624                 } (keys(%{$W->{"args_persistent"}}))));
 625 }
 626
 627 sub http_moved($$;$)
 628 {
 629 my($self,$url,$status)=@_;
 630
 631         $url=path_web($url,"abs"=>1);
 632         $status||=HTTP_MOVED_TEMPORARILY;
 633         $W->{"r"}->status($status);
 634         $W->{"r"}->headers_out()->{"Location"}=$url;
 635         $W->{"header_only"}=1;
 636         My::Web->heading();
 637         exit;
 638         die "NOTREACHED";
 639 }
 640
 641 sub remote_ip ()
 642 {
 643         # Do not: PerlModule                 Apache2::ForwardedFor
 644         #         PerlPostReadRequestHandler Apache2::ForwardedFor
 645         # As 'Apache2::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
 646         # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
 647         # We must take the last item ourselves.
 648         my $r=$W->{"r"}->headers_in()->{"X-Forwarded-For"} || $W->{"r"}->get_remote_host();
 649         $r=~s/^.*,\s*//;
 650         return $r;
 651 }
 652
 653 sub is_cz ()
 654 {
 655         return 0 if !$have_Geo_IP;
 656         return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
 657 }
 658
 659 sub a_href_cz ($$;%)
 660 {
 661 my($url,$contents,%args)=@_;
 662
 663         return a_href $url,$contents,%args if is_cz();
 664         return $contents;
 665 }
 666
 667 sub make ($)
 668 {
 669 my($cmd)=@_;
 670
 671         # FIXME: &alarm, --timeout is now infinite.
 672         # FIXME: Try to remove bash(1).
 673         # FIXME: Use: @PATH_FLOCK@
 674         my @argv=('flock',dir_top_abs_disk(),'bash','-c',$cmd.' >&2');
 675         print STDERR join(" ","SPAWN:",@argv)."\n";
 676         system @argv;
 677 }
 678
 679 sub make_file($$)
 680 {
 681 my($self,$file)=@_;
 682
 683         cluck "Pathname not absolute: $file" if $file!~m{^/};
 684         return if -f $file;
 685         # TODO: Somehow quickly check dependencies?
 686         return make('make -s --no-print-directory'
 687                                         .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'");
 688 }
 689
 690 sub img_size ($$)
 691 {
 692 my($width,$height)=@_;
 693
 694         cluck if !defined $width || !defined $height;
 695         return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
 696                         ." width=\"$width\" height=\"$height\"";
 697 }
 698
 699 sub negotiate_variant (%)
 700 {
 701 my(%args)=@_;
 702
 703         my @fields=("id","qs","content-type","encoding","charset","lang","size");
 704         return [ map(($args{$_}),@fields) ];
 705 }
 706
 707 # Input: $self is required!
 708 # Input: Put the fallback variant as the first one.
 709 # Returns: always only scalar!
 710 sub Negotiate_choose($$)
 711 {
 712 my($self,$variants)=@_;
 713
 714         my $best=HTTP::Negotiate::choose($variants,
 715                         # Do not: $W->{"r"}
 716                         # to prevent: Can't locate object method "scan" via package "Apache2::RequestRec" at HTTP/Negotiate.pm line 84.
 717                         # Do not: $W->{"r"}->headers_in()
 718                         # to prevent: Can't locate object method "scan" via package "APR::Table" at HTTP/Negotiate.pm line 84.
 719                         # Do not: HTTP::Headers->new($W->{"r"}->headers_in());
 720                         # to prevent empty result or even: Odd number of elements in anonymous hash
 721                         HTTP::Headers->new(%{$W->{"r"}->headers_in()}));
 722         $best||=$variants->[0][0];      # $variants->[0]{"id"}; &HTTP::Negotiate::choose failed?
 723         return $best;
 724 }
 725
 726 my @img_variants=(
 727                 { "id"=>"png","qs"=>0.9,"content-type"=>"image/png" },
 728                 { "id"=>"gif","qs"=>0.7,"content-type"=>"image/gif" },
 729                 );
 730 my $img_variants_re='[.](?:'.join('|',"jpeg",map(($_->{"id"}),@img_variants)).')$';
 731
 732 # Returns: ($path_web,$path_abs_disk)
 733 # URI path segments support ignored here. Where it is used? (';' path segment options)
 734 sub _img_src($%)
 735 {
 736 my($in,%args)=@_;
 737
 738         cluck if !uri_is_local $in;
 739         my $uri=in_to_uri_abs $in;
 740         my $path_abs_disk=path_abs_disk $uri,%args,"uri_as_in"=>1,"register"=>0;
 741
 742         # Known image extension?
 743         return path_web($uri,%args,"uri_as_in"=>1),$path_abs_disk if $uri->path()=~m#$img_variants_re#o;
 744
 745         my @nego_variants;
 746         for my $var (@img_variants) {
 747                 my $path_abs_disk_variant=$path_abs_disk.".".$var->{"id"};
 748                 path_abs_disk_register($path_abs_disk_variant);
 749                 __PACKAGE__->make_file($path_abs_disk_variant);
 750                 push @nego_variants,negotiate_variant(
 751                                 %$var,
 752                                 "size"=>(stat $path_abs_disk_variant)[7],
 753                                 );
 754                 }
 755         my $ext=__PACKAGE__->Negotiate_choose(\@nego_variants);
 756
 757         $uri->path($uri->path().".$ext");
 758         return path_web($uri,%args,"uri_as_in"=>1),path_abs_disk($uri,%args,"uri_as_in"=>1);
 759 }
 760
 761 # $args{"attr"}
 762 sub img ($$%)
 763 {
 764 my($in,$alt,%args)=@_;
 765
 766         request_check();
 767         my($path_web,$path_abs_disk)=_img_src($in,%args);
 768         my($width,$height)=Image::Size::imgsize($path_abs_disk);
 769         $alt=~s/<[^>]*>//g;
 770         $alt=escapeHTML($alt);
 771         my $content="<img src=\"".uri_escaped($path_web)."\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
 772                         .(!$args{"attr"} ? "" : " ".$args{"attr"})." />";
 773         do { return a_href((_img_src($_))[0],$content,"uri_as_in"=>1) if $_; } for $args{"a_href_img"};
 774         do { return a_href $_,$content if $_; } for $args{"a_href"};
 775         return $content;
 776 }
 777
 778 sub centerimg
 779 {
 780         my $r="";
 781         $r.='<table border="0" width="100%"><tr>'."\n";
 782         @_=( [@_] ) if !ref $_[0];
 783         for (@_) {
 784                 $r.="\t".'<td align="center">'.&{\&img}(@$_).'</td>'."\n";
 785                 }
 786         $r.='</tr></table>'."\n";
 787         return $r;
 788 }
 789
 790 sub rightimg
 791 {
 792 my($text,@args_img)=@_;
 793
 794         # FIXME: Workaround bug of 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)':
 795         #        <col width="@{[ (!$W->{"browser"}->ie() ? "1*" : "90%" ) ]}" />
 796         #        <col width="@{[ (!$W->{"browser"}->ie() ? "0*" : "10%" ) ]}" />
 797         # causes whole invisible projects in: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.7.10) Gecko/20050719 Galeon/1.3.21
 798         return <<"HERE";
 799 <table border="0" width="100%">
 800         <tr>
 801                 <td align="left">
 802                         @{[ $text ]}
 803                 </td>
 804                 <td align="right">
 805                         @{[ &{\&img}(@args_img) ]}
 806                 </td>
 807         </tr>
 808 </table>
 809 HERE
 810 }
 811
 812 sub readfile($$)
 813 {
 814 my($class,$filename)=@_;
 815
 816         local *F;
 817         open F,$filename or cluck "Cannot open \"$filename\": $!";
 818         my $F=do { local $/=undef(); <F>; };
 819         close F or cluck "Cannot close \"$filename\": $!";
 820         return $F;
 821 }
 822
 823 sub no_cache($)
 824 {
 825 my($self)=@_;
 826
 827         header("Expires"=>HTTP::Date::time2str(1000000000));    # date in the past
 828         header("Last-Modified"=>HTTP::Date::time2str());        # always modified
 829         header("Cache-Control"=>join(", ",
 830                         "no-cache",
 831                         "no-store",
 832                         "must-revalidate",
 833                         "max-age=0",
 834                         "pre-check=0",  # MSIE
 835                         "post-check=0", # MSIE
 836                         ));     # HTTP/1.1
 837         header("Pragma"=>"no-cache");   # HTTP/1.0
 838         header("Vary"=>"*");    # content may ba based on unpredictable sources
 839 }
 840
 841 sub last_modified($)
 842 {
 843 my($self)=@_;
 844
 845         return if !$packages_used_hash{$W->{"__PACKAGE__"}}{"_done"};
 846         our %path_abs_disk_registered;
 847         if (!$path_abs_disk_registered{$W->{"__PACKAGE__"}}++) {
 848                 for my $package_orig (@{$packages_used_array{$W->{"__PACKAGE__"}}}) {
 849                         local $_=$package_orig.".pm";
 850                         s{::}{/}g;
 851                         path_abs_disk "/$_","register"=>1;
 852                         }
 853                 }
 854         my $mtime_newest;
 855         for my $path_abs_disk (keys(%{$path_abs_disk_for_package{$W->{"__PACKAGE__"}}})) {
 856 ###print STDERR "CHECK:$path_abs_disk\n";
 857                 my $mtime=(stat $path_abs_disk)[9];
 858                 do { cluck "No mtime for: $path_abs_disk"; next; } if !$mtime;
 859                 $mtime_newest=$mtime if !$mtime_newest || $mtime_newest<$mtime;
 860                 }
 861         cluck "No mtime_newest found for the current W __PACKAGE__: ".$W->{"__PACKAGE__"}
 862                         if !$mtime_newest;
 863         # "Vary" header is REQUIRED in this case:
 864         header("Last-Modified"=>HTTP::Date::time2str($mtime_newest));
 865         return 1;
 866 }
 867
 868 sub heading()
 869 {
 870 my($class)=@_;
 871
 872         # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
 873         my $client_charset=$W->{"force_charset"} || "us-ascii";
 874         header("Content-Style-Type"=>"text/css");
 875         header("Content-Script-Type"=>"text/javascript");
 876         do { header("Content-Language"=>$_) if $_; } for $W->{"language"};
 877         $class->last_modified() if !$W->{"no_cache"};
 878         $class->no_cache() if $W->{"no_cache"};
 879
 880         while (my($key,$val)=each(%{$W->{"headers"}})) {
 881                 $W->{"r"}->headers_out()->{$key}=$val;
 882                 }
 883         exit if $W->{"r"}->header_only();
 884         return if $W->{"header_only"};
 885         # We still can append headers before we put out some text.
 886         # FIXME: It is not clean to still append them without overwriting.
 887         return if $W->{"heading_done"}++;
 888
 889         # Workaround bug
 890         #   https://bugzilla.mozilla.org/show_bug.cgi?id=120556
 891         # of at least
 892         #   Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
 893         my $mime;
 894         # http://validator.w3.org/ does not send ANY "Accept" headers!
 895         $mime||="application/xhtml+xml" if !$W->{"accept"} && $W->{"user_agent"}=~m{^W3C_Validator/}i;
 896         $mime||=$class->Negotiate_choose([
 897                         # Put the fallback variant as the first one.
 898                         # Rate both variants the same to prefer "text/html" for undecided clients.
 899                         # At least
 900                         #   Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
 901                         # prefers "application/xhtml+xml" over "text/html" itself:
 902                         #   text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
 903                         negotiate_variant(
 904                                         "id"=>"text/html",
 905                                         "content-type"=>"text/html",
 906                                         "qs"=>0.6,
 907                                         "charset"=>$client_charset,
 908                                         "lang"=>$W->{"language"},
 909                                         ),
 910                         negotiate_variant(
 911                                         "id"=>"application/xhtml+xml",
 912                                         "content-type"=>"application/xhtml+xml",
 913                                         "qs"=>0.6,
 914                                         "charset"=>$client_charset,
 915                                         "lang"=>$W->{"language"},
 916                                         ),
 917                         # application/xml ?
 918                         # text/xml ?
 919                         ]);
 920         $W->{"r"}->content_type("$mime; charset=$client_charset");
 921         Wprint '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n" if $mime=~m{^application/\w+[+]xml$};
 922         return if $W->{"xml_header_only"};
 923         Wprint '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
 924         Wprint '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="'.$W->{"language"}.'">'."\n";
 925         my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
 926         # Do not: cluck if $title=~/[<>]/;
 927         # as it is not solved just by: &a_href_inhibit
 928         # as sometimes titles use also: <i>...</i>
 929         $title=~s#<[^>]*>##g;
 930         Wprint "<head>";
 931         Wprint "<title>$title</title>\n";
 932         if ($W->{"have_css"}) {
 933                 # Everything can get overriden later.
 934                 for my $css ("/My/Web.css",map((!$_ ? () : ("ARRAY" ne ref($_) ? $_ : @$_)),$W->{"css_push"})) {
 935                         Wprint <<"HERE";
 936 <link rel="stylesheet" type="text/css" href="@{[ uri_escaped(path_web $css) ]}" />
 937 HERE
 938                         }
 939                 if ($W->{"css_inherit"}) {
 940                         Wprint <<"HERE";
 941 <script type="text/javascript" src="@{[ uri_escaped(path_web('/My/css_inherit.js')) ]}" />
 942 HERE
 943                         }
 944                 }
 945         Wprint '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
 946         Wprint $W->{"head"};
 947         for my $type (qw(prev next index contents start up)) {
 948                 do { Wprint '<link rel="'.$type.'" href="'.uri_escaped(path_web $_).'" />'."\n" if $_; }
 949                                 for ($W->{"rel_$type"});
 950                 }
 951         Wprint "</head><body";
 952 #       Wprint ' bgcolor="black" text="white" link="aqua" vlink="teal"'
 953 #                       if $W->{"browser"}->netscape() && (!$W->{"browser"}->major() || $W->{"browser"}->major()<=4);
 954         Wprint $W->{"body_attr"};
 955         Wprint ">\n";
 956
 957         do { Wprint $_ if $_; } for $W->{"heading"};
 958 }
 959
 960 BEGIN {
 961         delete $W->{"__My::Web_init"};
 962         }
 963
 964 1;