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