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 &top_dir_disk);
  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_disk ()
 168 {
 169         do { return $_ if $_; } for ($W->{"top_dir"});
 170         return $INC[0]; # fallback
 171 }
 172
 173 sub top_dir ()
 174 {
 175         if (my $uri=$ENV{"REQUEST_URI"}) {
 176                 $uri.="Index" if $uri=~m#/$#;
 177                 $uri=~s#^/*##;
 178                 $uri=~s#[^/]+#..#g;
 179                 $uri=File::Basename::dirname($uri);
 180                 return $uri;
 181                 }
 182         return top_dir_disk();
 183 }
 184
 185 sub fatal (;$);
 186
 187 sub args_check (%)
 188 {
 189 my(%tmpl)=@_;
 190
 191         while (my($name,$regex)=each(%tmpl)) {
 192                 my $name_html="Parameter <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
 193                 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
 194                 my $val=$W->{"args"}{$name};
 195                 $val="" if !defined $val;
 196                 fatal "$name_html <span class=\"quote\">".CGI::escapeHTML($val)."</span>"
 197                                                 ." does not match required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span> "
 198                                 if $regex ne "" && $val!~/$regex/;
 199                 }
 200 }
 201
 202 sub vskip (;$)
 203 {
 204 my($height)=@_;
 205
 206         return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'>&nbsp;</p>'."\n";
 207 }
 208
 209 sub fatal (;$)
 210 {
 211 my($msg)=@_;
 212
 213         $msg="UNKNOWN" if !$msg;
 214
 215 #       heading(false/*title*/,false/*indexme*/);       # notitle is always safe, don't index the error message
 216         print "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
 217                         ."<p>You can report this problem's details to"
 218                         ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
 219         footer();
 220 }
 221
 222 sub footer (;$)
 223 {
 224         exit 1 if $W->{"footer_passed"}++;      # deadlock prevention:
 225
 226         print vskip if $W->{"footer_delimit"};
 227
 228         print "<hr />\n" if $W->{"footer"};
 229
 230         if ($W->{"footer_mailme"}) {
 231                 print '<form action="'.top_dir().'/SendMsg.pl" method="post" onsubmit="'
 232                                 ."this.elements['msgscript'].value=this.elements['msghtml'].value;"
 233                                 ."this.elements['msghtml'].value='';"
 234                                 ."this.submit();"
 235                                 .'">'."\n";
 236                         print '<p align="right">'."\n";
 237                                 print '<input name="msgscript" type="hidden" />'."\n";
 238                                 print '<input name="msghtml" type="text" size="32" alt="Message" />'."\n";
 239                                 print '<input name="submit" type="submit" value="Quick Note" />'."\n";
 240                         print '</p>'."\n";
 241                 print '</form>'."\n";
 242                 }
 243
 244         if ($W->{"footer_ids"}) {
 245                 print '<p class="cvs-id">';
 246                 print join("<br />\n",map({ my $package=$_;
 247                         my $cvs_id=(eval('$'.$package."::CVS_ID")
 248 #                                       || $package     # debug
 249                                         );
 250                         if (!$cvs_id) {
 251                                 ();
 252                                 }
 253                         else {
 254                                 $cvs_id='$'.$cvs_id.'$';        # Eaten by 'q' operator.
 255                                 my @cvs_id_split=split / +/,$cvs_id;
 256                                 if (@cvs_id_split==8) {
 257                                         my $file=$package;
 258                                         $file=~s#::#/#g;
 259                                         my $ext;
 260                                         for (qw(.html.pl .pl .pm),"") {
 261                                                 $ext=$_;
 262                                                 last if -r top_dir()."/$file$ext";
 263                                                 cluck "Class file $file not found" if !$ext;
 264                                                 }
 265                                         $file.=$ext;
 266                                         $cvs_id_split[2]=""
 267                                                         .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
 268                                                                         $cvs_id_split[2]);
 269                                         $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
 270                                                         ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
 271                                         $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
 272                                         }
 273                                 join " ",@cvs_id_split;
 274                                 }
 275                         } (
 276                                         $W->{"__PACKAGE__"},
 277                                         __PACKAGE__,
 278                                         @{$W->{"packages_used"}{$Apache::Registry::curstash}},
 279                                         )));
 280                 print "</p>\n";
 281                 }
 282
 283         for my $package (
 284                         $W->{"__PACKAGE__"},
 285                         __PACKAGE__,
 286                         @{$W->{"packages_used"}{$Apache::Registry::curstash}},
 287                         ) {
 288                 my $cvs_id=(eval('$'.$package."::CVS_ID")
 289 #                               || $package     # debug
 290                                 );
 291                 print '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
 292                 }
 293
 294         if ($W->{"heading"}) {
 295                 do { &{$_}() if $_; } for ($W->{"footing"});
 296                 }
 297
 298         print "</body></html>\n";
 299         exit(0);
 300 }
 301
 302 sub header (%)
 303 {
 304 my(%pairs)=@_;
 305
 306         while (my($key,$val)=each(%pairs)) {
 307                 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
 308                 for ($W->{"headers_lc"}{lc $key} || ()) {
 309                         delete $W->{"headers"}{$_};
 310                         }
 311                 $W->{"headers_lc"}{lc $key}=$key;
 312                 $W->{"headers"}{$key}=$val;
 313                 }
 314 }
 315
 316 sub size_display ($)
 317 {
 318 my($size)=@_;
 319
 320            if ($size<4096)
 321                 {}
 322         elsif ($size<1024*1024)
 323                 { $size=sprintf "%.1fK",$size/1024; }
 324         else
 325                 { $size=sprintf "%.1fM",$size/1024/1024; }
 326         $size.="B";
 327         return $size;
 328 }
 329
 330 sub url_is_local ($)
 331 {
 332 my($url)=@_;
 333
 334         return $url!~m#^[a-z]+://#;
 335 }
 336
 337 sub a_href ($;$%)
 338 {
 339 my($url,$contents,%args)=@_;
 340
 341         do { $$_=1 if !defined $$_; } for (\$args{"size"});
 342         $contents=CGI::escapeHTML($url) if !defined $contents;
 343         $contents=~s#<a\b[^>]*>##gi;
 344         $contents=~s#</a>##gi;
 345
 346         my $r='<a href="';
 347         my $urlent=CGI::escapeHTML($url);
 348            if ($url eq $urlent)
 349                 { $r.=$url; }
 350         elsif (url_is_local $url)
 351                 { $r.=$urlent; }
 352         elsif (defined $W->{"have_ent"} && !$W->{"have_ent"})   # non-ent client
 353                 { $r.=$url; }
 354         elsif ($W->{"have_ent"})        # ent client
 355                 { $r.=$urlent; }
 356         else    # unknown client, &CGI::escapeHTML should not be needed here
 357                 { $r.=CGI::escapeHTML(top_dir()."/Redirect.pl?location=".uri_escape($url)); }
 358         $r.='"';
 359         do { $r.=" $_" if $_; } for ($args{"attr"});
 360         $r.='>'.$contents.'</a>';
 361         if ($args{"size"} && url_is_local($url) && $url=~/[.](?:gz|Z|rpm|zip|deb|lha)/) {       # Downloadable?
 362                 if (!-r $url)
 363                         { cluck "File not readable: $url"; }
 364                 else {
 365                         $r.='&nbsp;('.size_display((stat($url))[7]).')';
 366                         }
 367                 }
 368         return $r;
 369 }
 370
 371 sub remote_ip ()
 372 {
 373         # Do not: PerlModule                 Apache::ForwardedFor
 374         #         PerlPostReadRequestHandler Apache::ForwardedFor
 375         # As 'Apache::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
 376         # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
 377         # We must take the last item ourselves.
 378         my $r=$ENV{"HTTP_X_FORWARDED_FOR"} || $W->{"r"}->get_remote_host();
 379         $r=~s/^.*,\s*//;
 380         return $r;
 381 }
 382
 383 sub is_cz ()
 384 {
 385         return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
 386 }
 387
 388 sub a_href_cz ($$;%)
 389 {
 390 my($url,$contents,%args)=@_;
 391
 392         return a_href $url,$contents,%args if is_cz();
 393         return $contents;
 394 }
 395
 396 sub img_size ($$)
 397 {
 398 my($width,$height)=@_;
 399
 400         return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
 401                         ." width=\"$width\" height=\"$height\"";
 402 }
 403
 404 sub negotiate_variant (%)
 405 {
 406 my(%args)=@_;
 407
 408         my @fields=("id","qs","content-type","encoding","charset","lang","size");
 409         return [ map(($args{$_}),@fields) ];
 410 }
 411
 412 my @img_variants=(
 413                 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
 414                 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
 415                 );
 416 my $img_variants_re='[.](?:'.join('|',map(($_->{"id"}),@img_variants)).')$';
 417
 418 sub img_src ($)
 419 {
 420 my($file_base)=@_;
 421
 422         return $file_base if !url_is_local($file_base)
 423                         # Known image extension?
 424                         || $file_base=~m#$img_variants_re#o;
 425
 426         my @nego_variants;
 427         for my $var (@img_variants) {
 428                 my $file=$file_base.".".$var->{"id"};
 429                 # TODO: Somehow quickly check dependencies?
 430                 system 'make >&2 -s --no-print-directory'
 431                                                 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'"
 432                                 if !-f $file;
 433                 push @nego_variants,negotiate_variant(
 434                                 %$var,
 435                                 "size"=>(stat $file)[7],
 436                                 );
 437                 }
 438         # Do not: ,$W->{"r"});
 439         # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
 440         my $ext=HTTP::Negotiate::choose(\@nego_variants);
 441         $ext||=$img_variants[0]->{"id"};        # &HTTP::Negotiate::choose failed?
 442         return $file_base.".".$ext;
 443 }
 444
 445 sub img ($$;$)
 446 {
 447 my($file_base,$alt,$attrs)=@_;
 448
 449         my $file=img_src $file_base;
 450         my($width,$height)=Image::Size::imgsize($file);
 451         $alt=~s/<[^>]*>//g;
 452         $alt=CGI::escapeHTML($alt);
 453         return "<img src=\"$file\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
 454                         .(!$attrs ? "" : " ".$attrs)." />";
 455 }
 456
 457 sub readfile ($$)
 458 {
 459 my($class,$filename)=@_;
 460
 461         local *F;
 462         open F,$filename or die "Cannot open \"$filename\": $!";
 463         local $/=undef();
 464         my $data=<F>;
 465         close F;
 466         return $data;
 467 }
 468
 469 sub arr_keys (@)
 470 {
 471 my(@arr)=@_;
 472
 473         my @r=();
 474         while (@arr) {
 475                 push @r,shift @arr;     # key
 476                 shift @arr;     # val
 477                 }
 478         return @r;
 479 }
 480
 481 sub heading ()
 482 {
 483 my($class)=@_;
 484
 485         # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
 486         my $client_charset=$W->{"force_charset"} || "us-ascii";
 487         header("Content-Style-Type"=>"text/css");
 488         header("Content-Script-Type"=>"text/javascript");
 489
 490         while (my($key,$val)=each(%{$W->{"headers"}})) {
 491                 $W->{"r"}->header_out($key,$val);
 492                 }
 493         $W->{"r"}->send_http_header("text/html; charset=$client_charset");      # "Content-type"; do not use header()
 494
 495         return if $W->{"heading_done"}++;
 496         exit if $W->{"r"}->header_only();
 497
 498         if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
 499                 print '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
 500                 }
 501         print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
 502         print '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
 503         my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
 504         $title=~s#<[^>]*>##g;
 505         print "<head>";
 506         print "<title>$title</title>\n";
 507
 508         if ($W->{"have_css"}) {
 509                 print <<'HERE';
 510 <style type="text/css"><!--
 511 .cvs-id   { font-family: monospace; }
 512 .error    { color: red;   background-color: transparent; }
 513 .quote    { font-family: monospace; }
 514 .nowrap   { white-space: nowrap; }
 515 .centered { text-align: center; }
 516 .tab-bold { font-weight: bold; }
 517 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
 518 body {
 519                 background-color: black;
 520                 color: white;
 521                 }
 522 :link    { color: aqua;   background-color: transparent; }
 523 :visited { color: teal;   background-color: transparent; }
 524 h1,h2    { color: yellow; background-color: transparent; }
 525 td       { padding: 2px; }
 526 caption  { caption-side: bottom; }
 527 .footer img { vertical-align: middle; }
 528 HERE
 529                 print $W->{"head_css"}."\n";
 530                 print "--></style>\n";
 531                 }
 532
 533         print '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
 534         print $W->{"head"};
 535         print "</head><body";
 536         print ' bgcolor="black" text="white" link="aqua" vlink="teal"'
 537                         if $W->{"browser"}->netscape() && $W->{"browser"}->major<=4;
 538         print ">\n";
 539
 540         if ($W->{"heading"}) {
 541                 do { &{$_}() if $_; } for ($W->{"heading"});
 542                 }
 543 }
 544
 545 1;