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);
31 our @ISA=qw(Exporter);
39 # print STDERR "Wrequire $file\n";
45 my $aref=($W->{"packages_used"}{$Apache::Registry::curstash}||=[]);
47 if !{ map(($_=>1),@$aref) }->{$class}; # Prevent duplicated entries.
49 1; # Otherwise 'require' would already file above.
56 # print STDERR "Wuse $file\n";
58 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
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);
70 require HTTP::BrowserDetect;
71 require HTTP::Negotiate;
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"};
85 # $W->{"force_charset"}
86 # %{$W->{"packages_used"}
87 # $W->{"heading_done"}
88 # $W->{"footer_passed"}
90 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
91 # @{$W->{"packages_used"}{$Apache::Registry::curstash}}}
98 print STDERR "$class->init ".$ENV{"REQUEST_URI"}."\n";
100 my $packages_used_save=$W->{"packages_used"};
101 $W={ %WebConfig,%args }; # override %WebConfig settings
102 $W->{"packages_used"}=$packages_used_save;
104 $W->{"__PACKAGE__"}||="Apache::ROOT".$Apache::Registry::curstash;
106 $W->{"top_dir"}||=eval '$'.$W->{"__PACKAGE__"}.'::top_dir';
108 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_ent");
109 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_js");
110 do { $W->{$_}=1 if !defined $W->{$_}; } for ("have_css"); # AFAIK it does not hurt anyone.
111 do { $W->{$_}=1 if !defined $W->{$_}; } for ("heading");
112 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer");
113 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_delimit");
114 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_mailme");
115 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_ids");
116 do { $W->{$_}=1 if !defined $W->{$_}; } for ("indexme");
117 do { $W->{$_}="" if !defined $W->{$_}; } for ("head");
118 do { $W->{$_}="" if !defined $W->{$_}; } for ("head_css");
121 for (qw(footer_mailme footer_ids)) {
122 $W->{$_}=0 if !$W->{"footer"};
123 $footer_any=1 if $W->{$_};
125 $W->{"footer"}=0 if !$footer_any;
126 $W->{"footer_delimit"}=0 if !$W->{"footer"};
128 $W->{"r"}=Apache->request();
130 $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
131 if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
132 { $W->{"have_ent"}=0; }
133 elsif ($W->{"QUERY_STRING"}=~ /[&]have_ent/)
134 { $W->{"have_ent"}=1; }
136 { delete $W->{"have_ent"}; }
137 if ($W->{"detect_ent"} && !defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
138 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
139 .CGI::escapeHTML("http://".&{$W->{"web_hostname_sub"}}()."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
140 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
143 $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
144 $W->{"r"}->args($W->{"QUERY_STRING"});
145 $ENV{"QUERY_STRING"}=$W->{"QUERY_STRING"};
146 # Do not: $W->{"r"}->args()
147 # as it parses only QUERY_STRING (not POST data).
148 $W->{"args"}={ CGI->new()->Vars() };
149 for (keys(%{$W->{"args"}})) {
150 my @vals=split /\x00/,$W->{"args"}{$_};
152 $W->{"args"}{$_}=[@vals];
155 do { $W->{$_}=$ENV{"HTTP_ACCEPT"} if !defined $W->{$_}; } for ("accept");
156 do { $W->{$_}=$ENV{"HTTP_USER_AGENT"} if !defined $W->{$_}; } for ("user_agent");
158 $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
160 if (!defined $W->{"have_style"}) {
161 $W->{"have_style"}=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
164 $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
165 if ($W->{"detect_js"} && !$W->{"have_js"}) {
166 $W->{"head"}.='<script type="text/javascript" src="'.top_dir('/have_js.js.pl').'"></script>'."\n";
169 do { args_check(%$_) if $_; } for ($W->{"args_check"});
176 do { return $_ if $_; } for ($W->{"top_dir"});
177 return $INC[0]; # fallback
184 if (my $uri=$ENV{"REQUEST_URI"}) {
185 if ($W->{"args"}{"Wabs"}) {
190 $in=$ENV{"REQUEST_URI"}."/".$in;
192 1 while $in=~s#/(?:[^/]+)/\Q..\E/#/#g
194 return "http://".&{$W->{"web_hostname_sub"}}()."/".(defined $in ? $in : "");
196 $uri.="Index" if $uri=~m#/$#;
198 my($inpath,$inquery)=split /[?]/,$in,2;
202 my($in1 ,$in2 )=($in =~m#^(/[^/]+)(/.*)$#);
203 my($uri1,$uri2)=($uri=~m#^(/[^/]+)(/.*)$#);
204 last if !defined $in1 || !defined $uri1 || $in1 ne $uri1;
211 $uri=File::Basename::dirname($uri);
212 my $r=$uri.(defined $in ? $in : "");
213 # 1 while $r=~s#^[.]/##;
214 # $r="./$r" if $r=~m#^(?:?.*)$#; # empty pathname?
217 return top_dir_disk().$in;
226 while (my($name,$regex)=each(%tmpl)) {
227 my $name_html="Parameter <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
228 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
229 $W->{"args"}{$name}=[ $W->{"args"}{$name} ] if !ref $W->{"args"}{$name} && ref $regex;
230 fatal "$name_html passed as multivar although singlevar expected"
231 if ref $W->{"args"}{$name} && !ref $regex;
232 $regex=${$regex}[0] if ref $regex;
233 for my $val (!ref $W->{"args"}{$name} ? $W->{"args"}{$name} : @{$W->{"args"}{$name}}) {
234 $val="" if !defined $val;
235 fatal "$name_html <span class=\"quote\">".CGI::escapeHTML($val)."</span>"
236 ." does not match the required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span> "
237 if $regex ne "" && $val!~/$regex/;
246 return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'> </p>'."\n";
253 $msg="UNKNOWN" if !$msg;
255 $W->{"indexme"}=0; # For the case no heading was sent yet.
257 print "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
258 ."<p>You can report this problem's details to"
259 ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
265 exit 1 if $W->{"footer_passed"}++; # deadlock prevention:
267 print vskip if $W->{"footer_delimit"};
269 if ($W->{"heading"}) {
270 do { &{$_}() if $_; } for ($W->{"footing_delimit"});
273 print "<hr />\n" if $W->{"footer"};
275 if ($W->{"footer_mailme"}) {
276 print '<form action="'.top_dir('/SendMsg.pl').'" method="post" onsubmit="'
277 ."this.elements['msgscript'].value=this.elements['msghtml'].value;"
278 ."this.elements['msghtml'].value='';"
281 print '<p align="right">'."\n";
282 print '<input name="msgscript" type="hidden" />'."\n";
283 print '<input name="msghtml" type="text" size="32" alt="Message" />'."\n";
284 print '<input name="submit" type="submit" value="Quick Note" />'."\n";
286 print '</form>'."\n";
289 if ($W->{"footer_ids"}) {
290 print '<p class="cvs-id">';
291 print join("<br />\n",map({ my $package=$_;
292 my $cvs_id=(eval('$'.$package."::CVS_ID")
293 # || $package # debug
299 $cvs_id='$'.$cvs_id.'$'; # Eaten by 'q' operator.
300 my @cvs_id_split=split / +/,$cvs_id;
301 if (@cvs_id_split==8) {
305 for (qw(.html.pl .pl .pm),"") {
307 last if -r top_dir_disk()."/$file$ext";
308 cluck "Class file $file not found" if !$ext;
312 .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
314 $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
315 ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
316 $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
318 join " ",@cvs_id_split;
323 @{$W->{"packages_used"}{$Apache::Registry::curstash}},
331 @{$W->{"packages_used"}{$Apache::Registry::curstash}},
333 my $cvs_id=(eval('$'.$package."::CVS_ID")
334 # || $package # debug
336 print '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
339 if ($W->{"heading"}) {
340 do { &{$_}() if $_; } for ($W->{"footing"});
343 print "</body></html>\n";
351 while (my($key,$val)=each(%pairs)) {
352 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
353 for ($W->{"headers_lc"}{lc $key} || ()) {
354 delete $W->{"headers"}{$_};
356 $W->{"headers_lc"}{lc $key}=$key;
357 $W->{"headers"}{$key}=$val;
367 elsif ($size<1024*1024)
368 { $size=sprintf "%.1fK",$size/1024; }
370 { $size=sprintf "%.1fM",$size/1024/1024; }
379 return $url!~m#^[a-z]+://#;
384 my($url,$contents,%args)=@_;
386 do { $$_=1 if !defined $$_; } for (\$args{"size"});
387 if (!defined $contents) {
389 $contents=File::Basename::basename($contents) if $args{"basename"};
390 $contents=CGI::escapeHTML($contents);
392 $contents=~s#<a\b[^>]*>##gi;
393 $contents=~s#</a>##gi;
395 $url=top_dir($url) if url_is_local $url && $url=~m#^/#;
398 my $urlent=CGI::escapeHTML($url);
401 elsif (url_is_local $url)
403 elsif (defined $W->{"have_ent"} && !$W->{"have_ent"}) # non-ent client
405 elsif ($W->{"have_ent"}) # ent client
407 else # unknown client, &CGI::escapeHTML should not be needed here
408 { $r.=CGI::escapeHTML(top_dir('/Redirect.pl?location='.uri_escape($url))); }
410 do { $r.=" $_" if $_; } for ($args{"attr"});
411 $r.='>'.$contents.'</a>';
412 if ($args{"size"} && url_is_local($url) && $url=~/[.](?:gz|Z|rpm|zip|deb|lha)/) { # Downloadable?
413 $url=top_dir_disk().$url if $url=~m#^/#;
415 { cluck "File not readable: $url"; }
417 $r.=' ('.size_display((stat($url))[7]).')';
425 # Do not: PerlModule Apache::ForwardedFor
426 # PerlPostReadRequestHandler Apache::ForwardedFor
427 # As 'Apache::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
428 # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
429 # We must take the last item ourselves.
430 my $r=$ENV{"HTTP_X_FORWARDED_FOR"} || $W->{"r"}->get_remote_host();
437 return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
442 my($url,$contents,%args)=@_;
444 return a_href $url,$contents,%args if is_cz();
452 system {'flock'} 'flock','-x',top_dir_disk(),$cmd.' >&2';
457 my($width,$height)=@_;
459 return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
460 ." width=\"$width\" height=\"$height\"";
463 sub negotiate_variant (%)
467 my @fields=("id","qs","content-type","encoding","charset","lang","size");
468 return [ map(($args{$_}),@fields) ];
472 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
473 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
475 my $img_variants_re='[.](?:'.join('|',"jpeg",map(($_->{"id"}),@img_variants)).')$';
481 if (!url_is_local($file_base)) {
482 return $file_base if !wantarray();
483 return ($file_base,$file_base);
485 # Known image extension?
486 if ($file_base=~m#$img_variants_re#o) {
487 return $file_base if !wantarray();
488 return ($file_base,$file_base) if $file_base!~m#^/#;
489 return (top_dir($file_base),top_dir_disk().$file_base);
494 if ($file_base!~m#^/#) {
495 $file_base_disk=$file_base_uri=$file_base;
498 $file_base_disk=top_dir_disk().$file_base;
499 $file_base_uri=top_dir($file_base);
503 for my $var (@img_variants) {
504 my $file=$file_base_disk.".".$var->{"id"};
505 # TODO: Somehow quickly check dependencies?
506 make('make -s --no-print-directory'
507 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'")
509 push @nego_variants,negotiate_variant(
511 "size"=>(stat $file)[7],
514 # Do not: ,$W->{"r"});
515 # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
516 my $ext=HTTP::Negotiate::choose(\@nego_variants);
517 $ext||=$img_variants[0]->{"id"}; # &HTTP::Negotiate::choose failed?
519 return $file_base_uri.".".$ext if !wantarray();
520 return ($file_base_uri.".".$ext,$file_base_disk.".".$ext);
525 my($file_base,$alt,%attr)=@_;
527 my($file_uri,$file_disk)=img_src $file_base;
528 my($width,$height)=Image::Size::imgsize($file_disk);
530 $alt=CGI::escapeHTML($alt);
531 my $content="<img src=\"$file_uri\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
532 .(!$attr{"attr"} ? "" : " ".$attr{"attr"})." />";
533 return a_href img_src($attr{"a_href_img"}),$content if $attr{"a_href_img"};
534 return a_href $attr{"a_href"},$content if $attr{"a_href"};
541 $r.='<table border="0" width="100%"><tr>'."\n";
542 @_=( [@_] ) if !ref $_[0];
544 $r.="\t".'<td align="center">'.&{\&img}(@$_).'</td>'."\n";
546 $r.='</tr></table>'."\n";
552 my($text,@args_img)=@_;
554 # Workaround bug of 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)':
556 <table border="0" width="100%">
557 <col width="@{[ (!$W->{"browser"}->ie() ? "1*" : "90%" ) ]}" />
558 <col width="@{[ (!$W->{"browser"}->ie() ? "0*" : "10%" ) ]}" />
564 @{[ &{\&img}(@args_img) ]}
573 my($class,$filename)=@_;
576 open F,$filename or die "Cannot open \"$filename\": $!";
589 push @r,shift @arr; # key
599 return if $W->{"heading_passed"}++;
601 # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
602 my $client_charset=$W->{"force_charset"} || "us-ascii";
603 header("Content-Style-Type"=>"text/css");
604 header("Content-Script-Type"=>"text/javascript");
606 while (my($key,$val)=each(%{$W->{"headers"}})) {
607 $W->{"r"}->header_out($key,$val);
609 $W->{"r"}->send_http_header("text/html; charset=$client_charset"); # "Content-type"; do not use header()
611 return if $W->{"heading_done"}++;
612 exit if $W->{"r"}->header_only();
614 if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
615 print '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
617 print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
618 print '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
619 my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
620 $title=~s#<[^>]*>##g;
622 print "<title>$title</title>\n";
624 if ($W->{"have_css"}) {
626 <style type="text/css"><!--
627 .cvs-id { font-family: monospace; }
628 .error { color: red; background-color: transparent; }
629 .quote { font-family: monospace; }
630 .nowrap { white-space: nowrap; }
631 .centered { text-align: center; }
632 .tab-bold { font-weight: bold; }
633 .tab-head { font-weight: bold; }
635 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
637 background-color: black;
640 :link { color: aqua; background-color: transparent; }
641 :visited { color: teal; background-color: transparent; }
642 h1,h2 { color: yellow; background-color: transparent; }
645 caption { caption-side: bottom; }
646 .footer img { vertical-align: middle; }
648 print $W->{"head_css"}."\n";
649 print "--></style>\n";
652 print '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
654 for my $type (qw(prev next index contents start up)) {
655 do { print '<link rel="'.$type.'" href="'.$_.'" />'."\n" if $_; } for ($W->{"rel_$type"});
657 print "</head><body";
658 # print ' bgcolor="black" text="white" link="aqua" vlink="teal"'
659 # if $W->{"browser"}->netscape() && (!$W->{"browser"}->major() || $W->{"browser"}->major()<=4);
662 if ($W->{"heading"}) {
663 do { &{$_}() if $_; } for ($W->{"heading"});