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; };
27 our @EXPORT=qw(&require &a_href &a_href_cz &vskip &img $W);
28 our @ISA=qw(Exporter);
30 use WebConfig; # for %WebConfig
31 require CGI; # for &escapeHTML
32 require Image::Size; # for &imgsize
33 use File::Basename; # &basename
34 use Carp qw(cluck confess);
36 require HTTP::BrowserDetect;
37 require HTTP::Negotiate;
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"};
51 # $W->{"force_charset"}
52 # %{$W->{"packages_used"}
53 # $W->{"heading_done"}
54 # $W->{"footer_passed"}
56 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
57 # @{$W->{"packages_used"}{$Apache::Registry::curstash}}}
64 $W={ %WebConfig,%args }; # override %WebConfig settings
66 $W->{"__PACKAGE__"}||="Apache::ROOT".$Apache::Registry::curstash;
68 $W->{"top_dir"}||=eval '$'.$W->{"__PACKAGE__"}.'::top_dir';
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");
74 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_delimit");
75 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_mailme");
76 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_ids");
77 do { $W->{$_}=1 if !defined $W->{$_}; } for ("indexme");
78 do { $W->{$_}="" if !defined $W->{$_}; } for ("head");
79 do { $W->{$_}="" if !defined $W->{$_}; } for ("head_css");
82 for (qw(footer_mailme footer_ids)) {
83 $W->{$_}=0 if !$W->{"footer"};
84 $footer_any=1 if $W->{$_};
86 $W->{"footer"}=0 if !$footer_any;
87 $W->{"footer_delimit"}=0 if !$W->{"footer"};
89 $W->{"r"}=Apache->request();
91 $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
92 if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
93 { $W->{"have_ent"}=0; }
94 elsif ($W->{"QUERY_STRING"}=~ /[&]have_ent/)
95 { $W->{"have_ent"}=1; }
97 { delete $W->{"have_ent"}; }
98 if ($W->{"detect_ent"} && !defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
99 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
100 .CGI::escapeHTML("http://".$W->{"r"}->hostname()."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
101 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
104 $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
105 $W->{"r"}->args($W->{"QUERY_STRING"});
106 $ENV{"QUERY_STRING"}=$W->{"QUERY_STRING"};
107 # Do not: $W->{"r"}->args()
108 # as it parses only QUERY_STRING (not POST data).
109 $W->{"args"}={ CGI->new()->Vars() };
111 do { $W->{$_}=$ENV{"HTTP_ACCEPT"} if !defined $W->{$_}; } for ("accept");
112 do { $W->{$_}=$ENV{"HTTP_USER_AGENT"} if !defined $W->{$_}; } for ("user_agent");
114 $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
116 if (!defined $W->{"have_style"}) {
117 $W->{"have_style"}=(!$W->{"browser"}->netscape() || $W->{"browser"}->major>4 ? 1 : 0);
120 $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
121 if ($W->{"detect_js"} && !$W->{"have_js"}) {
122 $W->{"head"}.='<script type="text/javascript" src="'.$W->{"top_dir"}.'/have_js.js.pl"></script>'."\n";
125 do { args_check(%$_) if $_; } for ($W->{"args_check"});
139 my $aref=($W->{"packages_used"}{$Apache::Registry::curstash}||=[]);
141 if !{ map(($_=>1),@$aref) }->{$class}; # Prevent duplicated entries.
143 1; # Otherwise 'require' would already file above.
152 while (my($name,$regex)=each(%tmpl)) {
153 my $name_html="Parametr <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
154 my $val=$W->{"args"}{$name};
155 fatal "$name_html <span class=\"quote\">".CGI::escapeHTML($val)."</span>"
156 ." does not match required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span>"
157 if defined $val && $val!~/$regex/;
158 fatal "$name_html is required"
167 return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'> </p>'."\n";
174 $msg="UNKNOWN" if !$msg;
176 # heading(false/*title*/,false/*indexme*/); # notitle is always safe, don't index the error message
177 print "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
178 ."<p>You can report this problem's details to"
179 ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
185 exit 1 if $W->{"footer_passed"}++; # deadlock prevention:
187 print vskip if $W->{"footer_delimit"};
189 print "<hr />\n" if $W->{"footer"};
191 if ($W->{"footer_mailme"}) {
192 print '<form action="'.$W->{"top_dir"}.'/SendMsg.pl" method="post" onsubmit="'
193 ."this.elements['msgscript'].value=this.elements['msghtml'].value;"
194 ."this.elements['msghtml'].value='';"
197 print '<p align="right">'."\n";
198 print '<input name="msgscript" type="hidden" />'."\n";
199 print '<input name="msghtml" type="text" size="32" alt="Message" />'."\n";
200 print '<input name="submit" type="submit" value="Quick Note" />'."\n";
202 print '</form>'."\n";
205 if ($W->{"footer_ids"}) {
206 print '<p class="cvs-id">';
207 print join("<br />\n",map({ my $package=$_;
208 my $cvs_id=(eval('$'.$package."::CVS_ID")
209 # || $package # debug
215 $cvs_id='$'.$cvs_id.'$'; # Eaten by 'q' operator.
216 my @cvs_id_split=split / +/,$cvs_id;
217 if (@cvs_id_split==8) {
221 for (qw(.html.pl .pl .pm),"") {
223 last if -r $W->{"top_dir"}."/$file$ext";
224 cluck "Class file $file not found" if !$ext;
228 .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
230 $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
231 ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
232 $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
234 join " ",@cvs_id_split;
240 @{$W->{"packages_used"}{$Apache::Registry::curstash}},
244 print "</body></html>\n";
252 while (my($key,$val)=each(%pairs)) {
253 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
254 for ($W->{"headers_lc"}{lc $key} || ()) {
255 delete $W->{"headers"}{$_};
257 $W->{"headers_lc"}{lc $key}=$key;
258 $W->{"headers"}{$key}=$val;
268 elsif ($size<1024*1024)
269 { $size=sprintf "%.1fK",$size/1024; }
271 { $size=sprintf "%.1fM",$size/1024/1024; }
280 return $url!~m#^[a-z]+://#;
285 my($url,$contents,%args)=@_;
287 do { $$_=1 if !defined $$_; } for (\$args{"size"});
288 $contents=CGI::escapeHTML($url) if !defined $contents;
291 my $urlent=CGI::escapeHTML($url);
294 elsif (url_is_local $url)
296 elsif (defined $W->{"have_ent"} && !$W->{"have_ent"}) # non-ent client
298 elsif ($W->{"have_ent"}) # ent client
300 else # unknown client, &CGI::escapeHTML should not be needed here
301 { $r.=CGI::escapeHTML($W->{"top_dir"}."/Redirect.pl?location=".uri_escape($url)); }
302 $r.='">'.$contents.'</a>';
303 if ($args{"size"} && url_is_local($url) && $url=~/[.](?:gz|Z|rpm|zip|deb|lha)/) { # Downloadable?
305 { cluck "File not readable: $url"; }
307 $r.=' ('.size_display((stat($url))[7]).')';
315 # Do not: PerlModule Apache::ForwardedFor
316 # PerlPostReadRequestHandler Apache::ForwardedFor
317 # As 'Apache::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
318 # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
319 # We must take the last item ourselves.
320 my $r=$ENV{"HTTP_X_FORWARDED_FOR"} || $W->{"r"}->get_remote_host();
327 return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
332 my($url,$contents,%args)=@_;
334 return a_href $url,$contents,%args if is_cz();
340 my($width,$height)=@_;
342 return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
343 ." width=\"$width\" height=\"$height\"";
346 sub negotiate_variant (%)
350 my @fields=("id","qs","content-type","encoding","charset","lang","size");
351 return [ map(($args{$_}),@fields) ];
355 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
356 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
358 my $img_variants_re='[.](?:'.join('|',map(($_->{"id"}),@img_variants)).')$';
364 return $file_base if !url_is_local($file_base)
365 # Known image extension?
366 || $file_base=~m#$img_variants_re#o;
369 for my $var (@img_variants) {
370 my $file=$file_base.".".$var->{"id"};
371 # TODO: Somehow quickly check dependencies?
372 system 'make >&2 -s --no-print-directory'
373 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'"
375 push @nego_variants,negotiate_variant(
377 "size"=>(stat $file)[7],
380 # Do not: ,$W->{"r"});
381 # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
382 my $ext=HTTP::Negotiate::choose(\@nego_variants);
383 $ext||=$img_variants[0]->{"id"}; # &HTTP::Negotiate::choose failed?
384 return $file_base.".".$ext;
389 my($file_base,$alt,$attrs)=@_;
391 my $file=img_src $file_base;
392 my($width,$height)=Image::Size::imgsize($file);
393 $alt=CGI::escapeHTML($alt);
394 return "<img src=\"$file\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
395 .(!$attrs ? "" : " ".$attrs)." />";
400 my($class,$filename)=@_;
403 open F,$filename or die "Cannot open \"$filename\": $!";
416 push @r,shift @arr; # key
426 # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
427 my $client_charset=$W->{"force_charset"} || "us-ascii";
428 header("Content-Style-Type"=>"text/css");
429 header("Content-Script-Type"=>"text/javascript");
431 while (my($key,$val)=each(%{$W->{"headers"}})) {
432 $W->{"r"}->header_out($key,$val);
434 $W->{"r"}->send_http_header("text/html; charset=$client_charset"); # "Content-type"; do not use header()
436 return if $W->{"heading_done"}++;
437 exit if $W->{"r"}->header_only();
439 if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
440 print '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
442 print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
443 print '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
444 print '<head><title>'.CGI::escapeHTML($W->{"title_prefix"})
445 .join("",map({ ': '.CGI::escapeHTML($_); } ($W->{"title"} || ())))
448 if ($W->{"have_css"}) {
450 <style type="text/css"><!--
451 .cvs-id { font-family: monospace; }
452 .error { color: red; background-color: transparent; }
453 .quote { font-family: monospace; }
454 .nowrap { white-space: nowrap; }
455 .centered { text-align: center; }
456 .tab-bold { font-weight: bold; }
457 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
459 background-color: black;
462 :link { color: aqua; background-color: transparent; }
463 :visited { color: teal; background-color: transparent; }
464 h1,h2 { color: yellow; background-color: transparent; }
466 caption { caption-side: bottom; }
467 .footer img { vertical-align: middle; }
469 print $W->{"head_css"}."\n";
470 print "--></style>\n";
473 print '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
475 print "</head><body";
476 print ' bgcolor="black" text="white" link="aqua" vlink="teal"'
477 if $W->{"browser"}->netscape() && $W->{"browser"}->major<=4;