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