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