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