2 # Common functions for HTML/XHTML output generation
3 # Copyright (C) 2003 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
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
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.
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
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; };
30 our @EXPORT=qw(&Wrequire &Wuse &a_href &a_href_cz &vskip &img ¢erimg &rightimg $W &top_dir &top_dir_disk &Wprint);
31 our @ISA=qw(Exporter Tie::Handle);
35 $W->{"__My::Web_init"}=1;
41 # print STDERR "Wrequire $file\n";
47 my $who=$W->{"__PACKAGE__"};
48 $who||="__My::Web" if $W->{"__My::Web_init"};
49 my $aref=($W->{"packages_used"}{$who}||=[]);
51 if !{ map(($_=>1),@$aref) }->{$class}; # Prevent duplicated entries.
53 1; # Otherwise 'require' would already file above.
60 # print STDERR "Wuse $file\n";
62 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
68 BEGIN { Wuse 'WebConfig'; } # for %WebConfig
69 require CGI; # for &escapeHTML
70 require Image::Size; # for &imgsize
71 use File::Basename; # &basename
72 use Carp qw(cluck confess);
74 require HTTP::BrowserDetect;
75 require HTTP::Negotiate;
76 my $have_Geo_IP; BEGIN { $have_Geo_IP=eval { require Geo::IP; 1; }; }
77 use ModPerl::Util qw(exit);
78 use POSIX qw(strftime);
86 # $W->{"force_charset"}
87 # $W->{"heading_done"}
88 # $W->{"footer_passed"}
90 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
91 # @{$W->{"packages_used"}{$W->{"__PACKAGE__"}}}
92 # @{$W->{"packages_used"}{"__My::Web"}}
99 print STDERR "$class->init ".Apache->request()->unparsed_uri()."\n";
101 my $packages_used_save=$W->{"packages_used"};
102 $W={ %WebConfig,%args }; # override %WebConfig settings
103 $W->{"packages_used"}=$packages_used_save;
105 # {"__PACKAGE__"} is mandatory for mod_perl-2.0;
106 # $Apache::Registry::curstash is no longer supported.
107 do { cluck "No $_" if !$W->{$_}; } for "__PACKAGE__";
109 $W->{"top_dir"}||=eval '$'.$W->{"__PACKAGE__"}.'::top_dir';
111 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_ent");
112 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_js");
113 do { $W->{$_}=1 if !defined $W->{$_}; } for ("have_css"); # AFAIK it does not hurt anyone.
114 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer");
115 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_delimit");
116 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_mailme");
117 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_ids");
118 do { $W->{$_}=1 if !defined $W->{$_}; } for ("indexme");
119 do { $W->{$_}="" if !defined $W->{$_}; } for ("head");
120 do { $W->{$_}="" if !defined $W->{$_}; } for ("head_css");
123 for (qw(footer_mailme footer_ids)) {
124 $W->{$_}=0 if !$W->{"footer"};
125 $footer_any=1 if $W->{$_};
127 $W->{"footer"}=0 if !$footer_any;
128 $W->{"footer_delimit"}=0 if !$W->{"footer"};
130 $W->{"r"}=Apache->request();
132 $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
133 if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
134 { $W->{"have_ent"}=0; }
135 elsif ($W->{"QUERY_STRING"}=~ /[&]have_ent/)
136 { $W->{"have_ent"}=1; }
138 { delete $W->{"have_ent"}; }
139 if ($W->{"detect_ent"} && !defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
140 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
141 .CGI::escapeHTML("http://".&{$W->{"web_hostname_sub"}}()."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
142 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
145 $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
146 $W->{"r"}->args($W->{"QUERY_STRING"});
147 # Do not: $W->{"r"}->args()
148 # as it parses only QUERY_STRING (not POST data).
149 $W->{"args"}={ CGI->new($W->{"r"})->Vars() };
150 for (keys(%{$W->{"args"}})) {
151 my @vals=split /\x00/,$W->{"args"}{$_};
153 $W->{"args"}{$_}=[@vals];
156 do { $W->{$_}=$W->{"r"}->headers_in()->{"Accept"} if !defined $W->{$_}; } for ("accept");
157 do { $W->{$_}=$W->{"r"}->headers_in()->{"User-Agent"} if !defined $W->{$_}; } for ("user_agent");
159 $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
161 if (!defined $W->{"have_style"}) {
162 $W->{"have_style"}=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
165 $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
166 if ($W->{"detect_js"} && !$W->{"have_js"}) {
167 $W->{"head"}.='<script type="text/javascript" src="'.top_dir('/have_js.js.pl').'"></script>'."\n";
170 do { args_check(%$_) if $_; } for ($W->{"args_check"});
172 $ENV{"HOSTNAME"}||=&{$W->{"web_hostname_sub"}}();
174 return bless $W,$class;
181 $W->{"r"}->puts($text);
185 # tie *FH,ref($W),$W;
191 $self->{"W"}=$W or confess "Missing W";
192 return bless $self,$class;
197 my($self,$scalar,$length,$offset)=@_;
199 Wprint substr($scalar,0,$length);
204 do { return $_ if $_; } for ($W->{"top_dir"});
205 return $INC[0]; # fallback
212 if (my $uri=$W->{"r"}->unparsed_uri()) {
213 if ($W->{"args"}{"Wabs"}) {
214 # FIXME: $in may not be defined here!
215 # to prevent: Use of uninitialized value in ...
222 1 while $in=~s#/(?:[^/]+)/\Q..\E/#/#g
224 return "http://".&{$W->{"web_hostname_sub"}}()."/".(defined $in ? $in : "");
226 $uri.="Index" if $uri=~m#/$#;
228 my($inpath,$inquery)=split /[?]/,$in,2;
232 my($in1 ,$in2 )=($in =~m#^(/[^/]+)(/.*)$#);
233 my($uri1,$uri2)=($uri=~m#^(/[^/]+)(/.*)$#);
234 last if !defined $in1 || !defined $uri1 || $in1 ne $uri1;
241 $uri=File::Basename::dirname($uri);
242 my $r=$uri.(defined $in ? $in : "");
243 # 1 while $r=~s#^[.]/##;
244 # $r="./$r" if $r=~m#^(?:?.*)$#; # empty pathname?
247 return top_dir_disk().$in;
256 while (my($name,$regex)=each(%tmpl)) {
257 my $name_html="Parameter <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
258 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
259 $W->{"args"}{$name}=[ $W->{"args"}{$name} ] if !ref $W->{"args"}{$name} && ref $regex;
260 fatal "$name_html passed as multivar although singlevar expected"
261 if ref $W->{"args"}{$name} && !ref $regex;
262 $regex=$regex->[0] if ref $regex;
263 for my $val (!ref $W->{"args"}{$name} ? $W->{"args"}{$name} : @{$W->{"args"}{$name}}) {
264 $val="" if !defined $val;
265 fatal "$name_html <span class=\"quote\">".CGI::escapeHTML($val)."</span>"
266 ." does not match the required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span> "
267 if $regex ne "" && $val!~/$regex/;
276 return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'> </p>'."\n";
283 $msg="UNKNOWN" if !$msg;
285 $W->{"indexme"}=0; # For the case no heading was sent yet.
287 Wprint "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
288 ."<p>You can report this problem's details to"
289 ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
295 exit 1 if $W->{"footer_passed"}++; # deadlock prevention:
297 Wprint vskip if $W->{"footer_delimit"};
299 do { &{$_}() if $_; } for ($W->{"footing_delimit"});
301 Wprint "<hr />\n" if $W->{"footer"};
303 if ($W->{"footer_mailme"}) {
304 Wprint '<form action="'.top_dir('/SendMsg.pl').'" method="post" onsubmit="'
305 ."this.elements['msgscript'].value=this.elements['msghtml'].value;"
306 ."this.elements['msghtml'].value='';"
309 Wprint '<p align="right">'."\n";
310 Wprint '<input name="msgscript" type="hidden" />'."\n";
311 Wprint '<input name="msghtml" type="text" size="32" alt="Message" />'."\n";
312 Wprint '<input name="submit" type="submit" value="Quick Note" />'."\n";
314 Wprint '</form>'."\n";
320 @{$W->{"packages_used"}{"__My::Web"}},
321 map((!$_ ? () : @$_),$W->{"packages_used"}{$W->{"__PACKAGE__"}}),
324 @packages_used=grep((!$packages_used{$_}++),@packages_used);
325 if ($W->{"footer_ids"}) {
326 Wprint '<p class="cvs-id">';
327 Wprint join("<br />\n",map({ my $package=$_;
328 my $cvs_id=(eval('$'.$package."::CVS_ID")
329 # || $package # debug
335 $cvs_id='$'.$cvs_id.'$'; # Eaten by 'q' operator.
336 my @cvs_id_split=split / +/,$cvs_id;
337 if (@cvs_id_split==8) {
342 for (qw(.html.pl .pl .pm),"") {
344 my $pathname=top_dir_disk()."/$file$ext";
345 push @tried,$pathname;
346 last if -r $pathname;
347 cluck "Class file $file not found; tried: ".join(" ",@tried) if !$ext;
351 .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
353 $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
354 ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
355 $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
357 join " ",@cvs_id_split;
363 for my $package (@packages_used) {
364 my $cvs_id=(eval('$'.$package."::CVS_ID")
365 # || $package # debug
367 Wprint '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
370 do { &{$_}() if $_; } for ($W->{"footing"});
372 Wprint "</body></html>\n";
380 while (my($key,$val)=each(%pairs)) {
381 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
382 for ($W->{"headers_lc"}{lc $key} || ()) {
383 delete $W->{"headers"}{$_};
385 $W->{"headers_lc"}{lc $key}=$key;
386 $W->{"headers"}{$key}=$val;
396 elsif ($size<1024*1024)
397 { $size=sprintf "%.1fK",$size/1024; }
399 { $size=sprintf "%.1fM",$size/1024/1024; }
408 return $url!~m#^[a-z]+://#;
413 my($url,$contents,%args)=@_;
415 do { $$_=1 if !defined $$_; } for (\$args{"size"});
416 if (!defined $contents) {
418 $contents=File::Basename::basename($contents) if $args{"basename"};
419 $contents=CGI::escapeHTML($contents);
421 $contents=~s#<a\b[^>]*>##gi;
422 $contents=~s#</a>##gi;
424 $url=top_dir($url) if url_is_local $url && $url=~m#^/#;
427 my $urlent=CGI::escapeHTML($url);
430 elsif (url_is_local $url)
432 elsif (defined $W->{"have_ent"} && !$W->{"have_ent"}) # non-ent client
434 elsif ($W->{"have_ent"}) # ent client
436 else # unknown client, &CGI::escapeHTML should not be needed here
437 { $r.=CGI::escapeHTML(top_dir('/Redirect.pl?location='.uri_escape($url))); }
439 do { $r.=" $_" if $_; } for ($args{"attr"});
440 $r.='>'.$contents.'</a>';
441 if ($args{"size"} && url_is_local($url) && ($args{"size"}>=2 || $url=~/[.](?:gz|Z|rpm|zip|deb|lha)/)) { # Downloadable?
442 $url=top_dir_disk().$url if $url=~m#^/#;
444 { cluck "File not readable: $url"; }
446 $r.=' ('.size_display((stat($url))[7]).')';
454 # Do not: PerlModule Apache::ForwardedFor
455 # PerlPostReadRequestHandler Apache::ForwardedFor
456 # As 'Apache::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
457 # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
458 # We must take the last item ourselves.
459 my $r=$W->{"r"}->headers_in()->{"X-Forwarded-For"} || $W->{"r"}->get_remote_host();
466 return 0 if !$have_Geo_IP;
467 return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
472 my($url,$contents,%args)=@_;
474 return a_href $url,$contents,%args if is_cz();
482 system {'flock'} 'flock','-x',top_dir_disk(),$cmd.' >&2';
487 my($width,$height)=@_;
489 return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
490 ." width=\"$width\" height=\"$height\"";
493 sub negotiate_variant (%)
497 my @fields=("id","qs","content-type","encoding","charset","lang","size");
498 return [ map(($args{$_}),@fields) ];
502 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
503 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
505 my $img_variants_re='[.](?:'.join('|',"jpeg",map(($_->{"id"}),@img_variants)).')$';
511 if (!url_is_local($file_base)) {
512 return $file_base if !wantarray();
513 return ($file_base,$file_base);
515 # Known image extension?
516 if ($file_base=~m#$img_variants_re#o) {
517 return $file_base if !wantarray();
518 return ($file_base,$file_base) if $file_base!~m#^/#;
519 return (top_dir($file_base),top_dir_disk().$file_base);
524 if ($file_base!~m#^/#) {
525 $file_base_disk=$file_base_uri=$file_base;
528 $file_base_disk=top_dir_disk().$file_base;
529 $file_base_uri=top_dir($file_base);
533 for my $var (@img_variants) {
534 my $file=$file_base_disk.".".$var->{"id"};
535 # TODO: Somehow quickly check dependencies?
536 make('make -s --no-print-directory'
537 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'")
539 push @nego_variants,negotiate_variant(
541 "size"=>(stat $file)[7],
544 # Do not: ,$W->{"r"});
545 # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
546 my $ext=HTTP::Negotiate::choose(\@nego_variants);
547 $ext||=$img_variants[0]->{"id"}; # &HTTP::Negotiate::choose failed?
549 return $file_base_uri.".".$ext if !wantarray();
550 return ($file_base_uri.".".$ext,$file_base_disk.".".$ext);
555 my($file_base,$alt,%attr)=@_;
557 my($file_uri,$file_disk)=img_src $file_base;
558 my($width,$height)=Image::Size::imgsize($file_disk);
560 $alt=CGI::escapeHTML($alt);
561 my $content="<img src=\"$file_uri\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
562 .(!$attr{"attr"} ? "" : " ".$attr{"attr"})." />";
563 return a_href img_src($attr{"a_href_img"}),$content if $attr{"a_href_img"};
564 return a_href $attr{"a_href"},$content if $attr{"a_href"};
571 $r.='<table border="0" width="100%"><tr>'."\n";
572 @_=( [@_] ) if !ref $_[0];
574 $r.="\t".'<td align="center">'.&{\&img}(@$_).'</td>'."\n";
576 $r.='</tr></table>'."\n";
582 my($text,@args_img)=@_;
584 # Workaround bug of 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)':
586 <table border="0" width="100%">
587 <col width="@{[ (!$W->{"browser"}->ie() ? "1*" : "90%" ) ]}" />
588 <col width="@{[ (!$W->{"browser"}->ie() ? "0*" : "10%" ) ]}" />
594 @{[ &{\&img}(@args_img) ]}
603 my($class,$filename)=@_;
606 open F,$filename or die "Cannot open \"$filename\": $!";
619 push @r,shift @arr; # key
629 header("Expires"=>"Mon, 26 Jul 1997 05:00:00 GMT"); # date in the past
630 header("Last-Modified"=>strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime())); # always modified
631 header("Cache-Control"=>"no-cache, must-revalidate"); # HTTP/1.1
632 header("Pragma"=>"no-cache"); # HTTP/1.0
639 return if $W->{"heading_passed"}++;
641 # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
642 my $client_charset=$W->{"force_charset"} || "us-ascii";
643 header("Content-Style-Type"=>"text/css");
644 header("Content-Script-Type"=>"text/javascript");
645 $class->no_cache() if $W->{"no_cache"};
647 while (my($key,$val)=each(%{$W->{"headers"}})) {
648 $W->{"r"}->header_out($key,$val);
650 if (!$W->{"header_only"}) {
651 $W->{"r"}->send_http_header("text/html; charset=$client_charset"); # "Content-type"; do not use header()
654 return if $W->{"heading_done"}++;
655 exit if $W->{"r"}->header_only();
656 return if $W->{"header_only"};
658 if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
659 Wprint '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
661 Wprint '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
662 Wprint '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
663 my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
664 $title=~s#<[^>]*>##g;
666 Wprint "<title>$title</title>\n";
668 if ($W->{"have_css"}) {
670 <style type="text/css"><!--
671 .cvs-id { font-family: monospace; }
672 .error { color: red; background-color: transparent; }
673 .quote { font-family: monospace; }
674 .nowrap { white-space: nowrap; }
675 .centered { text-align: center; }
676 .tab-bold { font-weight: bold; }
677 .tab-head { font-weight: bold; }
679 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
681 background-color: black;
684 :link { color: aqua; background-color: transparent; }
685 :visited { color: teal; background-color: transparent; }
686 h1,h2 { color: yellow; background-color: transparent; }
689 caption { caption-side: bottom; }
690 .footer img { vertical-align: middle; }
692 Wprint $W->{"head_css"}."\n";
693 Wprint "--></style>\n";
696 Wprint '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
698 for my $type (qw(prev next index contents start up)) {
699 do { Wprint '<link rel="'.$type.'" href="'.$_.'" />'."\n" if $_; } for ($W->{"rel_$type"});
701 Wprint "</head><body";
702 # Wprint ' bgcolor="black" text="white" link="aqua" vlink="teal"'
703 # if $W->{"browser"}->netscape() && (!$W->{"browser"}->major() || $W->{"browser"}->major()<=4);
704 do { &{$_}($W) if $_; } for $W->{"body_attr_sub"};
707 do { &{$_}() if $_; } for ($W->{"heading"});
711 delete $W->{"__My::Web_init"};