Web.pm

   1 # $Id$
   2 # Common functions for HTML/XHTML output generation
   3 # Copyright (C) 2003 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(&Wrequire &Wuse &a_href &a_href_cz &vskip &img $W &top_dir);
  31 our @ISA=qw(Exporter);
  32
  33 BEGIN
  34 {
  35         sub Wrequire ($)
  36         {
  37         my($file)=@_;
  38
  39 #               print STDERR "Wrequire $file\n";
  40                 $file=~s#/#::#g;
  41                 $file=~s/[.]pm$//;
  42                 my $class=$file;
  43                 $file=~s#::#/#g;
  44                 $file.=".pm";
  45                 my $aref=($W->{"packages_used"}{$Apache::Registry::curstash}||=[]);
  46                 push @$aref,$class
  47                                 if !{ map(($_=>1),@$aref) }->{$class};  # Prevent duplicated entries.
  48                 CORE::require $file;
  49                 1;      # Otherwise 'require' would already file above.
  50         }
  51
  52         sub Wuse ($@)
  53         {
  54         my($file,@list)=@_;
  55
  56 #               print STDERR "Wuse $file\n";
  57                 Wrequire $file;
  58                 $file->import(@list);
  59                 1;
  60         }
  61 }
  62
  63 BEGIN { Wuse 'WebConfig'; }     # for %WebConfig
  64 require CGI;    # for &escapeHTML
  65 require Image::Size;    # for &imgsize
  66 use File::Basename;     # &basename
  67 use Carp qw(cluck confess);
  68 use URI::Escape;
  69 require HTTP::BrowserDetect;
  70 require HTTP::Negotiate;
  71 require Geo::IP;
  72 require CGI;
  73
  74
  75 # Undo 'www/engine/httpd-restart' as it may use obsolete Perl for 'mod_perl'
  76 delete $ENV{"PERLLIB"};
  77 delete $ENV{"LD_LIBRARY_PATH"};
  78
  79
  80 #our $W;
  81                 # $W->{"title"}
  82                 # $W->{"head"}
  83                 # $W->{"head_css"}
  84                 # $W->{"force_charset"}
  85                 # %{$W->{"packages_used"}
  86                 # $W->{"heading_done"}
  87                 # $W->{"footer_passed"}
  88                 # %{$W->{"headers"}}
  89                 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
  90                 # @{$W->{"packages_used"}{$Apache::Registry::curstash}}}
  91                 # %{$W->{"args"}}
  92
  93 sub init ($%)
  94 {
  95 my($class,%args)=@_;
  96
  97         my $packages_used_save=$W->{"packages_used"};
  98         $W={ %WebConfig,%args };        # override %WebConfig settings
  99         $W->{"packages_used"}=$packages_used_save;
 100
 101         $W->{"__PACKAGE__"}||="Apache::ROOT".$Apache::Registry::curstash;
 102
 103         $W->{"top_dir"}||=eval '$'.$W->{"__PACKAGE__"}.'::top_dir';
 104
 105         do { $W->{$_}=0  if !defined $W->{$_}; } for ("detect_ent");
 106         do { $W->{$_}=0  if !defined $W->{$_}; } for ("detect_js");
 107         do { $W->{$_}=1  if !defined $W->{$_}; } for ("have_css");      # AFAIK it does not hurt anyone.
 108         do { $W->{$_}=1  if !defined $W->{$_}; } for ("heading");
 109         do { $W->{$_}=1  if !defined $W->{$_}; } for ("footer");
 110         do { $W->{$_}=1  if !defined $W->{$_}; } for ("footer_delimit");
 111         do { $W->{$_}=1  if !defined $W->{$_}; } for ("footer_mailme");
 112         do { $W->{$_}=1  if !defined $W->{$_}; } for ("footer_ids");
 113         do { $W->{$_}=1  if !defined $W->{$_}; } for ("indexme");
 114         do { $W->{$_}="" if !defined $W->{$_}; } for ("head");
 115         do { $W->{$_}="" if !defined $W->{$_}; } for ("head_css");
 116
 117         my $footer_any=0;
 118         for (qw(footer_mailme footer_ids)) {
 119                 $W->{$_}=0 if !$W->{"footer"};
 120                 $footer_any=1 if $W->{$_};
 121                 }
 122         $W->{"footer"}=0 if !$footer_any;
 123         $W->{"footer_delimit"}=0 if !$W->{"footer"};
 124
 125         $W->{"r"}=Apache->request();
 126
 127         $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
 128            if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
 129                 { $W->{"have_ent"}=0; }
 130         elsif ($W->{"QUERY_STRING"}=~    /[&]have_ent/)
 131                 { $W->{"have_ent"}=1; }
 132         else
 133                 { delete $W->{"have_ent"}; }
 134         if ($W->{"detect_ent"} && !defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
 135                 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
 136                                 .CGI::escapeHTML("http://".$W->{"r"}->hostname()."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
 137                                                 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
 138                                 .'" />'."\n";
 139                 }
 140         $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
 141         $W->{"r"}->args($W->{"QUERY_STRING"});
 142         $ENV{"QUERY_STRING"}=$W->{"QUERY_STRING"};
 143         # Do not: $W->{"r"}->args()
 144         # as it  parses only QUERY_STRING (not POST data).
 145         $W->{"args"}={ CGI->new()->Vars() };
 146
 147         do { $W->{$_}=$ENV{"HTTP_ACCEPT"} if !defined $W->{$_}; } for ("accept");
 148         do { $W->{$_}=$ENV{"HTTP_USER_AGENT"} if !defined $W->{$_}; } for ("user_agent");
 149
 150         $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
 151
 152         if (!defined $W->{"have_style"}) {
 153                 $W->{"have_style"}=(!$W->{"browser"}->netscape() || $W->{"browser"}->major>4 ? 1 : 0);
 154                 }
 155
 156         $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
 157         if ($W->{"detect_js"} && !$W->{"have_js"}) {
 158                 $W->{"head"}.='<script type="text/javascript" src="'.top_dir().'/have_js.js.pl"></script>'."\n";
 159                 }
 160
 161         do { args_check(%$_) if $_; } for ($W->{"args_check"});
 162
 163         return $W;
 164 }
 165
 166 sub top_dir ()
 167 {
 168         do { return $_ if $_; } for ($W->{"top_dir"});
 169         return $INC[0]; # fallback
 170 }
 171
 172 sub fatal (;$);
 173
 174 sub args_check (%)
 175 {
 176 my(%tmpl)=@_;
 177
 178         while (my($name,$regex)=each(%tmpl)) {
 179                 my $name_html="Parametr <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
 180                 my $val=$W->{"args"}{$name};
 181                 fatal "$name_html <span class=\"quote\">".CGI::escapeHTML($val)."</span>"
 182                                                 ." does not match required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span>"
 183                                 if defined $val && $val!~/$regex/;
 184                 fatal "$name_html is required"
 185                                 if !defined $val;
 186                 }
 187 }
 188
 189 sub vskip (;$)
 190 {
 191 my($height)=@_;
 192
 193         return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'>&nbsp;</p>'."\n";
 194 }
 195
 196 sub fatal (;$)
 197 {
 198 my($msg)=@_;
 199
 200         $msg="UNKNOWN" if !$msg;
 201
 202 #       heading(false/*title*/,false/*indexme*/);       # notitle is always safe, don't index the error message
 203         print "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
 204                         ."<p>You can report this problem's details to"
 205                         ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
 206         footer();
 207 }
 208
 209 sub footer (;$)
 210 {
 211         exit 1 if $W->{"footer_passed"}++;      # deadlock prevention:
 212
 213         print vskip if $W->{"footer_delimit"};
 214
 215         print "<hr />\n" if $W->{"footer"};
 216
 217         if ($W->{"footer_mailme"}) {
 218                 print '<form action="'.top_dir().'/SendMsg.pl" method="post" onsubmit="'
 219                                 ."this.elements['msgscript'].value=this.elements['msghtml'].value;"
 220                                 ."this.elements['msghtml'].value='';"
 221                                 ."this.submit();"
 222                                 .'">'."\n";
 223                         print '<p align="right">'."\n";
 224                                 print '<input name="msgscript" type="hidden" />'."\n";
 225                                 print '<input name="msghtml" type="text" size="32" alt="Message" />'."\n";
 226                                 print '<input name="submit" type="submit" value="Quick Note" />'."\n";
 227                         print '</p>'."\n";
 228                 print '</form>'."\n";
 229                 }
 230
 231         if ($W->{"footer_ids"}) {
 232                 print '<p class="cvs-id">';
 233                 print join("<br />\n",map({ my $package=$_;
 234                         my $cvs_id=(eval('$'.$package."::CVS_ID")
 235 #                                       || $package     # debug
 236                                         );
 237                         if (!$cvs_id) {
 238                                 ();
 239                                 }
 240                         else {
 241                                 $cvs_id='$'.$cvs_id.'$';        # Eaten by 'q' operator.
 242                                 my @cvs_id_split=split / +/,$cvs_id;
 243                                 if (@cvs_id_split==8) {
 244                                         my $file=$package;
 245                                         $file=~s#::#/#g;
 246                                         my $ext;
 247                                         for (qw(.html.pl .pl .pm),"") {
 248                                                 $ext=$_;
 249                                                 last if -r top_dir()."/$file$ext";
 250                                                 cluck "Class file $file not found" if !$ext;
 251                                                 }
 252                                         $file.=$ext;
 253                                         $cvs_id_split[2]=""
 254                                                         .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
 255                                                                         $cvs_id_split[2]);
 256                                         $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
 257                                                         ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
 258                                         $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
 259                                         }
 260                                 join " ",@cvs_id_split;
 261                                 }
 262                         } (
 263                                         $W->{"__PACKAGE__"},
 264                                         __PACKAGE__,
 265                                         @{$W->{"packages_used"}{$Apache::Registry::curstash}},
 266                                         )));
 267                 print "</p>\n";
 268                 }
 269
 270         if ($W->{"heading"}) {
 271                 do { &{$_}() if $_; } for ($W->{"footing"});
 272                 }
 273
 274         print "</body></html>\n";
 275         exit(0);
 276 }
 277
 278 sub header (%)
 279 {
 280 my(%pairs)=@_;
 281
 282         while (my($key,$val)=each(%pairs)) {
 283                 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
 284                 for ($W->{"headers_lc"}{lc $key} || ()) {
 285                         delete $W->{"headers"}{$_};
 286                         }
 287                 $W->{"headers_lc"}{lc $key}=$key;
 288                 $W->{"headers"}{$key}=$val;
 289                 }
 290 }
 291
 292 sub size_display ($)
 293 {
 294 my($size)=@_;
 295
 296            if ($size<4096)
 297                 {}
 298         elsif ($size<1024*1024)
 299                 { $size=sprintf "%.1fK",$size/1024; }
 300         else
 301                 { $size=sprintf "%.1fM",$size/1024/1024; }
 302         $size.="B";
 303         return $size;
 304 }
 305
 306 sub url_is_local ($)
 307 {
 308 my($url)=@_;
 309
 310         return $url!~m#^[a-z]+://#;
 311 }
 312
 313 sub a_href ($;$%)
 314 {
 315 my($url,$contents,%args)=@_;
 316
 317         do { $$_=1 if !defined $$_; } for (\$args{"size"});
 318         $contents=CGI::escapeHTML($url) if !defined $contents;
 319
 320         my $r='<a href="';
 321         my $urlent=CGI::escapeHTML($url);
 322            if ($url eq $urlent)
 323                 { $r.=$url; }
 324         elsif (url_is_local $url)
 325                 { $r.=$urlent; }
 326         elsif (defined $W->{"have_ent"} && !$W->{"have_ent"})   # non-ent client
 327                 { $r.=$url; }
 328         elsif ($W->{"have_ent"})        # ent client
 329                 { $r.=$urlent; }
 330         else    # unknown client, &CGI::escapeHTML should not be needed here
 331                 { $r.=CGI::escapeHTML(top_dir()."/Redirect.pl?location=".uri_escape($url)); }
 332         $r.='">'.$contents.'</a>';
 333         if ($args{"size"} && url_is_local($url) && $url=~/[.](?:gz|Z|rpm|zip|deb|lha)/) {       # Downloadable?
 334                 if (!-r $url)
 335                         { cluck "File not readable: $url"; }
 336                 else {
 337                         $r.='&nbsp;('.size_display((stat($url))[7]).')';
 338                         }
 339                 }
 340         return $r;
 341 }
 342
 343 sub remote_ip ()
 344 {
 345         # Do not: PerlModule                 Apache::ForwardedFor
 346         #         PerlPostReadRequestHandler Apache::ForwardedFor
 347         # As 'Apache::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
 348         # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
 349         # We must take the last item ourselves.
 350         my $r=$ENV{"HTTP_X_FORWARDED_FOR"} || $W->{"r"}->get_remote_host();
 351         $r=~s/^.*,\s*//;
 352         return $r;
 353 }
 354
 355 sub is_cz ()
 356 {
 357         return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
 358 }
 359
 360 sub a_href_cz ($$;%)
 361 {
 362 my($url,$contents,%args)=@_;
 363
 364         return a_href $url,$contents,%args if is_cz();
 365         return $contents;
 366 }
 367
 368 sub img_size ($$)
 369 {
 370 my($width,$height)=@_;
 371
 372         return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
 373                         ." width=\"$width\" height=\"$height\"";
 374 }
 375
 376 sub negotiate_variant (%)
 377 {
 378 my(%args)=@_;
 379
 380         my @fields=("id","qs","content-type","encoding","charset","lang","size");
 381         return [ map(($args{$_}),@fields) ];
 382 }
 383
 384 my @img_variants=(
 385                 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
 386                 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
 387                 );
 388 my $img_variants_re='[.](?:'.join('|',map(($_->{"id"}),@img_variants)).')$';
 389
 390 sub img_src ($)
 391 {
 392 my($file_base)=@_;
 393
 394         return $file_base if !url_is_local($file_base)
 395                         # Known image extension?
 396                         || $file_base=~m#$img_variants_re#o;
 397
 398         my @nego_variants;
 399         for my $var (@img_variants) {
 400                 my $file=$file_base.".".$var->{"id"};
 401                 # TODO: Somehow quickly check dependencies?
 402                 system 'make >&2 -s --no-print-directory'
 403                                                 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'"
 404                                 if !-f $file;
 405                 push @nego_variants,negotiate_variant(
 406                                 %$var,
 407                                 "size"=>(stat $file)[7],
 408                                 );
 409                 }
 410         # Do not: ,$W->{"r"});
 411         # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
 412         my $ext=HTTP::Negotiate::choose(\@nego_variants);
 413         $ext||=$img_variants[0]->{"id"};        # &HTTP::Negotiate::choose failed?
 414         return $file_base.".".$ext;
 415 }
 416
 417 sub img ($$;$)
 418 {
 419 my($file_base,$alt,$attrs)=@_;
 420
 421         my $file=img_src $file_base;
 422         my($width,$height)=Image::Size::imgsize($file);
 423         $alt=CGI::escapeHTML($alt);
 424         return "<img src=\"$file\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
 425                         .(!$attrs ? "" : " ".$attrs)." />";
 426 }
 427
 428 sub readfile ($$)
 429 {
 430 my($class,$filename)=@_;
 431
 432         local *F;
 433         open F,$filename or die "Cannot open \"$filename\": $!";
 434         local $/=undef();
 435         my $data=<F>;
 436         close F;
 437         return $data;
 438 }
 439
 440 sub arr_keys (@)
 441 {
 442 my(@arr)=@_;
 443
 444         my @r=();
 445         while (@arr) {
 446                 push @r,shift @arr;     # key
 447                 shift @arr;     # val
 448                 }
 449         return @r;
 450 }
 451
 452 sub heading ()
 453 {
 454 my($class)=@_;
 455
 456         # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
 457         my $client_charset=$W->{"force_charset"} || "us-ascii";
 458         header("Content-Style-Type"=>"text/css");
 459         header("Content-Script-Type"=>"text/javascript");
 460
 461         while (my($key,$val)=each(%{$W->{"headers"}})) {
 462                 $W->{"r"}->header_out($key,$val);
 463                 }
 464         $W->{"r"}->send_http_header("text/html; charset=$client_charset");      # "Content-type"; do not use header()
 465
 466         return if $W->{"heading_done"}++;
 467         exit if $W->{"r"}->header_only();
 468
 469         if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
 470                 print '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
 471                 }
 472         print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
 473         print '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
 474         print '<head><title>'.CGI::escapeHTML($W->{"title_prefix"})
 475                         .join("",map({ ': '.CGI::escapeHTML($_); } ($W->{"title"} || ())))
 476                         .'</title>'."\n";
 477
 478         if ($W->{"have_css"}) {
 479                 print <<'HERE';
 480 <style type="text/css"><!--
 481 .cvs-id   { font-family: monospace; }
 482 .error    { color: red;   background-color: transparent; }
 483 .quote    { font-family: monospace; }
 484 .nowrap   { white-space: nowrap; }
 485 .centered { text-align: center; }
 486 .tab-bold { font-weight: bold; }
 487 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
 488 body {
 489                 background-color: black;
 490                 color: white;
 491                 }
 492 :link    { color: aqua;   background-color: transparent; }
 493 :visited { color: teal;   background-color: transparent; }
 494 h1,h2    { color: yellow; background-color: transparent; }
 495 td       { padding: 2px; }
 496 caption  { caption-side: bottom; }
 497 .footer img { vertical-align: middle; }
 498 HERE
 499                 print $W->{"head_css"}."\n";
 500                 print "--></style>\n";
 501                 }
 502
 503         print '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
 504         print $W->{"head"};
 505         print "</head><body";
 506         print ' bgcolor="black" text="white" link="aqua" vlink="teal"'
 507                         if $W->{"browser"}->netscape() && $W->{"browser"}->major<=4;
 508         print ">\n";
 509
 510         if ($W->{"heading"}) {
 511                 do { &{$_}() if $_; } for ($W->{"heading"});
 512                 }
 513 }
 514
 515 1;