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