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