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