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);
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;
72 my $have_Geo_IP; BEGIN { $have_Geo_IP=eval { require Geo::IP; 1; }; }
74 use ModPerl::Util qw(exit);
81 # $W->{"force_charset"}
82 # %{$W->{"packages_used"}
83 # $W->{"heading_done"}
84 # $W->{"footer_passed"}
86 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
87 # @{$W->{"packages_used"}{$Apache::Registry::curstash}}}
94 print STDERR "$class->init ".Apache->request()->unparsed_uri()."\n";
97 my $packages_used_save=$W->{"packages_used"};
98 $W={ %WebConfig,%args }; # override %WebConfig settings
99 $W->{"packages_used"}=$packages_used_save;
101 $W->{"__PACKAGE__"}||="Apache::ROOT".$Apache::Registry::curstash;
103 $W->{"top_dir"}||=eval '$'.$W->{"__PACKAGE__"}.'::top_dir';
105 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_ent");
106 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_js");
107 do { $W->{$_}=1 if !defined $W->{$_}; } for ("have_css"); # AFAIK it does not hurt anyone.
108 do { $W->{$_}=1 if !defined $W->{$_}; } for ("heading");
109 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer");
110 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_delimit");
111 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_mailme");
112 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_ids");
113 do { $W->{$_}=1 if !defined $W->{$_}; } for ("indexme");
114 do { $W->{$_}="" if !defined $W->{$_}; } for ("head");
115 do { $W->{$_}="" if !defined $W->{$_}; } for ("head_css");
118 for (qw(footer_mailme footer_ids)) {
119 $W->{$_}=0 if !$W->{"footer"};
120 $footer_any=1 if $W->{$_};
122 $W->{"footer"}=0 if !$footer_any;
123 $W->{"footer_delimit"}=0 if !$W->{"footer"};
125 $W->{"r"}=Apache->request();
127 $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
128 if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
129 { $W->{"have_ent"}=0; }
130 elsif ($W->{"QUERY_STRING"}=~ /[&]have_ent/)
131 { $W->{"have_ent"}=1; }
133 { delete $W->{"have_ent"}; }
134 if ($W->{"detect_ent"} && !defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
135 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
136 .CGI::escapeHTML("http://".&{$W->{"web_hostname_sub"}}()."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
137 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
140 $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
141 $W->{"r"}->args($W->{"QUERY_STRING"});
142 # Do not: $W->{"r"}->args()
143 # as it parses only QUERY_STRING (not POST data).
144 $W->{"args"}={ CGI->new()->Vars() };
145 for (keys(%{$W->{"args"}})) {
146 my @vals=split /\x00/,$W->{"args"}{$_};
148 $W->{"args"}{$_}=[@vals];
151 do { $W->{$_}=$W->{"r"}->headers_in()->{"Accept"} if !defined $W->{$_}; } for ("accept");
152 do { $W->{$_}=$W->{"r"}->headers_in()->{"User-Agent"} if !defined $W->{$_}; } for ("user_agent");
154 $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
156 if (!defined $W->{"have_style"}) {
157 $W->{"have_style"}=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
160 $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
161 if ($W->{"detect_js"} && !$W->{"have_js"}) {
162 $W->{"head"}.='<script type="text/javascript" src="'.top_dir('/have_js.js.pl').'"></script>'."\n";
165 do { args_check(%$_) if $_; } for ($W->{"args_check"});
174 $W->{"r"}->print($text);
179 do { return $_ if $_; } for ($W->{"top_dir"});
180 return $INC[0]; # fallback
187 if (my $uri=$W->{"r"}->unparsed_uri()) {
188 if ($W->{"args"}{"Wabs"}) {
189 # FIXME: $in may not be defined here!
190 # to prevent: Use of uninitialized value in ...
197 1 while $in=~s#/(?:[^/]+)/\Q..\E/#/#g
199 return "http://".&{$W->{"web_hostname_sub"}}()."/".(defined $in ? $in : "");
201 $uri.="Index" if $uri=~m#/$#;
203 my($inpath,$inquery)=split /[?]/,$in,2;
207 my($in1 ,$in2 )=($in =~m#^(/[^/]+)(/.*)$#);
208 my($uri1,$uri2)=($uri=~m#^(/[^/]+)(/.*)$#);
209 last if !defined $in1 || !defined $uri1 || $in1 ne $uri1;
216 $uri=File::Basename::dirname($uri);
217 my $r=$uri.(defined $in ? $in : "");
218 # 1 while $r=~s#^[.]/##;
219 # $r="./$r" if $r=~m#^(?:?.*)$#; # empty pathname?
222 return top_dir_disk().$in;
231 while (my($name,$regex)=each(%tmpl)) {
232 my $name_html="Parameter <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
233 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
234 $W->{"args"}{$name}=[ $W->{"args"}{$name} ] if !ref $W->{"args"}{$name} && ref $regex;
235 fatal "$name_html passed as multivar although singlevar expected"
236 if ref $W->{"args"}{$name} && !ref $regex;
237 $regex=${$regex}[0] if ref $regex;
238 for my $val (!ref $W->{"args"}{$name} ? $W->{"args"}{$name} : @{$W->{"args"}{$name}}) {
239 $val="" if !defined $val;
240 fatal "$name_html <span class=\"quote\">".CGI::escapeHTML($val)."</span>"
241 ." does not match the required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span> "
242 if $regex ne "" && $val!~/$regex/;
251 return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'> </p>'."\n";
258 $msg="UNKNOWN" if !$msg;
260 $W->{"indexme"}=0; # For the case no heading was sent yet.
262 Wprint "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
263 ."<p>You can report this problem's details to"
264 ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
270 exit 1 if $W->{"footer_passed"}++; # deadlock prevention:
272 Wprint vskip if $W->{"footer_delimit"};
274 if ($W->{"heading"}) {
275 do { &{$_}() if $_; } for ($W->{"footing_delimit"});
278 Wprint "<hr />\n" if $W->{"footer"};
280 if ($W->{"footer_mailme"}) {
281 Wprint '<form action="'.top_dir('/SendMsg.pl').'" method="post" onsubmit="'
282 ."this.elements['msgscript'].value=this.elements['msghtml'].value;"
283 ."this.elements['msghtml'].value='';"
286 Wprint '<p align="right">'."\n";
287 Wprint '<input name="msgscript" type="hidden" />'."\n";
288 Wprint '<input name="msghtml" type="text" size="32" alt="Message" />'."\n";
289 Wprint '<input name="submit" type="submit" value="Quick Note" />'."\n";
291 Wprint '</form>'."\n";
294 if ($W->{"footer_ids"}) {
295 Wprint '<p class="cvs-id">';
296 Wprint join("<br />\n",map({ my $package=$_;
297 my $cvs_id=(eval('$'.$package."::CVS_ID")
298 # || $package # debug
304 $cvs_id='$'.$cvs_id.'$'; # Eaten by 'q' operator.
305 my @cvs_id_split=split / +/,$cvs_id;
306 if (@cvs_id_split==8) {
311 for (qw(.html.pl .pl .pm),"") {
313 my $pathname=top_dir_disk()."/$file$ext";
314 push @tried,$pathname;
315 last if -r $pathname;
316 cluck "Class file $file not found; tried: ".join(" ",@tried) if !$ext;
320 .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
322 $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
323 ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
324 $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
326 join " ",@cvs_id_split;
331 @{$W->{"packages_used"}{$Apache::Registry::curstash}},
339 @{$W->{"packages_used"}{$Apache::Registry::curstash}},
341 my $cvs_id=(eval('$'.$package."::CVS_ID")
342 # || $package # debug
344 Wprint '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
347 if ($W->{"heading"}) {
348 do { &{$_}() if $_; } for ($W->{"footing"});
351 Wprint "</body></html>\n";
359 while (my($key,$val)=each(%pairs)) {
360 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
361 for ($W->{"headers_lc"}{lc $key} || ()) {
362 delete $W->{"headers"}{$_};
364 $W->{"headers_lc"}{lc $key}=$key;
365 $W->{"headers"}{$key}=$val;
375 elsif ($size<1024*1024)
376 { $size=sprintf "%.1fK",$size/1024; }
378 { $size=sprintf "%.1fM",$size/1024/1024; }
387 return $url!~m#^[a-z]+://#;
392 my($url,$contents,%args)=@_;
394 do { $$_=1 if !defined $$_; } for (\$args{"size"});
395 if (!defined $contents) {
397 $contents=File::Basename::basename($contents) if $args{"basename"};
398 $contents=CGI::escapeHTML($contents);
400 $contents=~s#<a\b[^>]*>##gi;
401 $contents=~s#</a>##gi;
403 $url=top_dir($url) if url_is_local $url && $url=~m#^/#;
406 my $urlent=CGI::escapeHTML($url);
409 elsif (url_is_local $url)
411 elsif (defined $W->{"have_ent"} && !$W->{"have_ent"}) # non-ent client
413 elsif ($W->{"have_ent"}) # ent client
415 else # unknown client, &CGI::escapeHTML should not be needed here
416 { $r.=CGI::escapeHTML(top_dir('/Redirect.pl?location='.uri_escape($url))); }
418 do { $r.=" $_" if $_; } for ($args{"attr"});
419 $r.='>'.$contents.'</a>';
420 if ($args{"size"} && url_is_local($url) && ($args{"size"}>=2 || $url=~/[.](?:gz|Z|rpm|zip|deb|lha)/)) { # Downloadable?
421 $url=top_dir_disk().$url if $url=~m#^/#;
423 { cluck "File not readable: $url"; }
425 $r.=' ('.size_display((stat($url))[7]).')';
433 # Do not: PerlModule Apache::ForwardedFor
434 # PerlPostReadRequestHandler Apache::ForwardedFor
435 # As 'Apache::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
436 # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
437 # We must take the last item ourselves.
438 my $r=$W->{"r"}->headers_in()->{"X-Forwarded-For"} || $W->{"r"}->get_remote_host();
445 return 0 if !$have_Geo_IP;
446 return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
451 my($url,$contents,%args)=@_;
453 return a_href $url,$contents,%args if is_cz();
461 system {'flock'} 'flock','-x',top_dir_disk(),$cmd.' >&2';
466 my($width,$height)=@_;
468 return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
469 ." width=\"$width\" height=\"$height\"";
472 sub negotiate_variant (%)
476 my @fields=("id","qs","content-type","encoding","charset","lang","size");
477 return [ map(($args{$_}),@fields) ];
481 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
482 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
484 my $img_variants_re='[.](?:'.join('|',"jpeg",map(($_->{"id"}),@img_variants)).')$';
490 if (!url_is_local($file_base)) {
491 return $file_base if !wantarray();
492 return ($file_base,$file_base);
494 # Known image extension?
495 if ($file_base=~m#$img_variants_re#o) {
496 return $file_base if !wantarray();
497 return ($file_base,$file_base) if $file_base!~m#^/#;
498 return (top_dir($file_base),top_dir_disk().$file_base);
503 if ($file_base!~m#^/#) {
504 $file_base_disk=$file_base_uri=$file_base;
507 $file_base_disk=top_dir_disk().$file_base;
508 $file_base_uri=top_dir($file_base);
512 for my $var (@img_variants) {
513 my $file=$file_base_disk.".".$var->{"id"};
514 # TODO: Somehow quickly check dependencies?
515 make('make -s --no-print-directory'
516 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'")
518 push @nego_variants,negotiate_variant(
520 "size"=>(stat $file)[7],
523 # Do not: ,$W->{"r"});
524 # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
525 my $ext=HTTP::Negotiate::choose(\@nego_variants);
526 $ext||=$img_variants[0]->{"id"}; # &HTTP::Negotiate::choose failed?
528 return $file_base_uri.".".$ext if !wantarray();
529 return ($file_base_uri.".".$ext,$file_base_disk.".".$ext);
534 my($file_base,$alt,%attr)=@_;
536 my($file_uri,$file_disk)=img_src $file_base;
537 my($width,$height)=Image::Size::imgsize($file_disk);
539 $alt=CGI::escapeHTML($alt);
540 my $content="<img src=\"$file_uri\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
541 .(!$attr{"attr"} ? "" : " ".$attr{"attr"})." />";
542 return a_href img_src($attr{"a_href_img"}),$content if $attr{"a_href_img"};
543 return a_href $attr{"a_href"},$content if $attr{"a_href"};
550 $r.='<table border="0" width="100%"><tr>'."\n";
551 @_=( [@_] ) if !ref $_[0];
553 $r.="\t".'<td align="center">'.&{\&img}(@$_).'</td>'."\n";
555 $r.='</tr></table>'."\n";
561 my($text,@args_img)=@_;
563 # Workaround bug of 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)':
565 <table border="0" width="100%">
566 <col width="@{[ (!$W->{"browser"}->ie() ? "1*" : "90%" ) ]}" />
567 <col width="@{[ (!$W->{"browser"}->ie() ? "0*" : "10%" ) ]}" />
573 @{[ &{\&img}(@args_img) ]}
582 my($class,$filename)=@_;
585 open F,$filename or die "Cannot open \"$filename\": $!";
598 push @r,shift @arr; # key
608 return if $W->{"heading_passed"}++;
610 # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
611 my $client_charset=$W->{"force_charset"} || "us-ascii";
612 header("Content-Style-Type"=>"text/css");
613 header("Content-Script-Type"=>"text/javascript");
615 while (my($key,$val)=each(%{$W->{"headers"}})) {
616 $W->{"r"}->header_out($key,$val);
618 $W->{"r"}->send_http_header("text/html; charset=$client_charset"); # "Content-type"; do not use header()
620 return if $W->{"heading_done"}++;
621 exit if $W->{"r"}->header_only();
623 if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
624 Wprint '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
626 Wprint '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
627 Wprint '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
628 my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
629 $title=~s#<[^>]*>##g;
631 Wprint "<title>$title</title>\n";
633 if ($W->{"have_css"}) {
635 <style type="text/css"><!--
636 .cvs-id { font-family: monospace; }
637 .error { color: red; background-color: transparent; }
638 .quote { font-family: monospace; }
639 .nowrap { white-space: nowrap; }
640 .centered { text-align: center; }
641 .tab-bold { font-weight: bold; }
642 .tab-head { font-weight: bold; }
644 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
646 background-color: black;
649 :link { color: aqua; background-color: transparent; }
650 :visited { color: teal; background-color: transparent; }
651 h1,h2 { color: yellow; background-color: transparent; }
654 caption { caption-side: bottom; }
655 .footer img { vertical-align: middle; }
657 Wprint $W->{"head_css"}."\n";
658 Wprint "--></style>\n";
661 Wprint '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
663 for my $type (qw(prev next index contents start up)) {
664 do { Wprint '<link rel="'.$type.'" href="'.$_.'" />'."\n" if $_; } for ($W->{"rel_$type"});
666 Wprint "</head><body";
667 # Wprint ' bgcolor="black" text="white" link="aqua" vlink="teal"'
668 # if $W->{"browser"}->netscape() && (!$W->{"browser"}->major() || $W->{"browser"}->major()<=4);
671 if ($W->{"heading"}) {
672 do { &{$_}() if $_; } for ($W->{"heading"});