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