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; };
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);
29 our @EXPORT=qw(&require &a_href &a_href_cz &vskip &img $W);
30 our @ISA=qw(Exporter);
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);
38 require HTTP::BrowserDetect;
39 require HTTP::Negotiate;
43 # Undo 'www/engine/httpd-restart' as it may use obsolete Perl for 'mod_perl'
44 delete $ENV{"PERLLIB"};
45 delete $ENV{"LD_LIBRARY_PATH"};
52 # $W->{"force_charset"}
53 # %{$W->{"packages_used"}
54 # $W->{"heading_done"}
55 # $W->{"footer_passed"}
57 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
58 # @{$W->{"packages_used"}{$Apache::Registry::curstash}}}
65 $W={ %WebConfig,%args }; # override %WebConfig settings
67 $W->{"__PACKAGE__"}||="Apache::ROOT".$Apache::Registry::curstash;
69 $W->{"top_dir"}||=eval '$'.$W->{"__PACKAGE__"}.'::top_dir';
71 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_ent");
72 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_js");
73 do { $W->{$_}=1 if !defined $W->{$_}; } for ("have_css"); # AFAIK it does not hurt anyone.
74 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_delimit");
75 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_ids");
76 do { $W->{$_}=1 if !defined $W->{$_}; } for ("indexme");
77 do { $W->{$_}="" if !defined $W->{$_}; } for ("head");
78 do { $W->{$_}="" if !defined $W->{$_}; } for ("head_css");
80 $W->{"r"}=Apache->request();
82 $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
83 if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
84 { $W->{"have_ent"}=0; }
85 elsif ($W->{"QUERY_STRING"}=~ /[&]have_ent/)
86 { $W->{"have_ent"}=1; }
88 { delete $W->{"have_ent"}; }
89 if ($W->{"detect_ent"} && !defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
90 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
91 .CGI::escapeHTML("http://".$W->{"r"}->hostname()."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
92 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
95 $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
96 $W->{"r"}->args($W->{"QUERY_STRING"});
97 $W->{"args"}={ $W->{"r"}->args() };
99 do { $W->{$_}=$ENV{"HTTP_ACCEPT"} if !defined $W->{$_}; } for ("accept");
100 do { $W->{$_}=$ENV{"HTTP_USER_AGENT"} if !defined $W->{$_}; } for ("user_agent");
102 $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
104 if (!defined $W->{"have_style"}) {
105 $W->{"have_style"}=(!$W->{"browser"}->netscape() || $W->{"browser"}->major>4 ? 1 : 0);
108 $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
109 if ($W->{"detect_js"} && !$W->{"have_js"}) {
110 $W->{"head"}.='<script type="text/javascript" src="'.$W->{"top_dir"}.'/have_js.js.pl"></script>'."\n";
113 do { args_check(%$_) if $_; } for ($W->{"args_check"});
127 my $aref=($W->{"packages_used"}{$Apache::Registry::curstash}||=[]);
129 if !{ map(($_=>1),@$aref) }->{$class}; # Prevent duplicated entries.
131 1; # Otherwise 'require' would already file above.
140 while (my($name,$regex)=each(%tmpl)) {
141 my $name_html="Parametr <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
142 my $val=$W->{"args"}{$name};
143 fatal "$name_html does not match required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span>"
144 if defined $val && $val!~/$regex/;
145 fatal "$name_html is required"
154 return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'> </p>'."\n";
161 $msg="UNKNOWN" if !$msg;
163 # heading(false/*title*/,false/*indexme*/); # notitle is always safe, don't index the error message
164 print "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
165 ."<p>You can report this problem's details to"
166 ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
172 exit 1 if $W->{"footer_passed"}++; # deadlock prevention:
174 if ($W->{"footer_ids"}) {
175 print vskip if $W->{"footer_delimit"};
176 print '<hr /><p class="cvs-id">';
178 print join("<br />\n",map({ my $package=$_;
179 my $cvs_id=(eval('$'.$package."::CVS_ID")
180 # || $package # debug
186 $cvs_id='$'.$cvs_id.'$'; # Eaten by 'q' operator.
187 my @cvs_id_split=split / +/,$cvs_id;
188 if (@cvs_id_split==8) {
192 for (qw(.html.pl .pl .pm),"") {
194 last if -r $W->{"top_dir"}."/$file$ext";
195 cluck "Class file $file not found" if !$ext;
199 .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
201 $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
202 ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
203 $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
205 join " ",@cvs_id_split;
210 @{$W->{"packages_used"}{$Apache::Registry::curstash}},
214 print "</body></html>\n";
222 while (my($key,$val)=each(%pairs)) {
223 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
224 for ($W->{"headers_lc"}{lc $key} || ()) {
225 delete $W->{"headers"}{$_};
227 $W->{"headers_lc"}{lc $key}=$key;
228 $W->{"headers"}{$key}=$val;
238 elsif ($size<1024*1024)
239 { $size=sprintf "%.1fK",$size/1024; }
241 { $size=sprintf "%.1fM",$size/1024/1024; }
250 return $url!~m#^[a-z]+://#;
255 my($url,$contents,%args)=@_;
257 do { $$_=1 if !defined $$_; } for ($args{"size"});
258 $contents=CGI::escapeHTML($url) if !defined $contents;
261 my $urlent=CGI::escapeHTML($url);
264 elsif (url_is_local $url)
266 elsif (defined $W->{"have_ent"} && !$W->{"have_ent"}) # non-ent client
268 elsif ($W->{"have_ent"}) # ent client
270 else # unknown client, &CGI::escapeHTML should not be needed here
271 { $r.=CGI::escapeHTML("http://".$W->{"r"}->hostname()."/redirect.pl?location=".uri_escape($url)); }
272 $r.='">'.$contents.'</a>';
273 if ($args{"size"} && url_is_local($url) && $url=~/[.](?:gz|rpm|zip|deb)/) { # Downloadable?
275 { cluck "File not readable: $url"; }
277 $r.=' ('.size_display((stat($url))[7]).')';
285 return "CZ" eq Geo::IP->new()->country_code_by_addr($W->{"r"}->get_remote_host());
290 my($url,$contents,%args)=@_;
292 return a_href $url,$contents,%args if is_cz();
298 my($width,$height)=@_;
300 return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
301 ." width=\"$width\" height=\"$height\"";
304 sub negotiate_variant (%)
308 my @fields=("id","qs","content-type","encoding","charset","lang","size");
309 return [ map(($args{$_}),@fields) ];
313 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
314 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
316 my $img_variants_re='[.](?:'.join('|',map(($_->{"id"}),@img_variants)).')$';
320 my($file_base,$alt,$attrs)=@_;
323 if (url_is_local($file_base)
324 # No known image extension?
325 && $file_base!~m#$img_variants_re#o) {
327 for my $var (@img_variants) {
328 $file=$file_base.".".$var->{"id"};
329 # TODO: Somehow quickly check dependencies?
330 system 'make >&2 -s --no-print-directory'
331 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'"
333 push @nego_variants,negotiate_variant(
335 "size"=>(stat $file)[7],
338 # Do not: ,$W->{"r"});
339 # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
340 my $ext=HTTP::Negotiate::choose(\@nego_variants);
341 $ext||=$img_variants[0]->{"id"}; # &HTTP::Negotiate::choose failed?
342 $file=$file_base.".".$ext;
345 { $file=$file_base; }
346 my($width,$height)=Image::Size::imgsize($file);
347 $alt=CGI::escapeHTML($alt);
348 return "<img src=\"$file\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
349 .(!$attrs ? "" : " ".$attrs)." />";
354 my($class,$filename)=@_;
357 open F,$filename or die "Cannot open \"$filename\": $!";
370 push @r,shift @arr; # key
380 # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
381 my $client_charset=$W->{"force_charset"} || "us-ascii";
382 header("Content-Style-Type"=>"text/css");
384 while (my($key,$val)=each(%{$W->{"headers"}})) {
385 $W->{"r"}->header_out($key,$val);
387 $W->{"r"}->send_http_header("text/html; charset=$client_charset"); # "Content-type"; do not use header()
389 return if $W->{"heading_done"}++;
390 exit if $W->{"r"}->header_only();
392 if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
393 print '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
395 print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
396 print '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
397 print '<head><title>'.CGI::escapeHTML($W->{"title_prefix"})
398 .join("",map({ ': '.CGI::escapeHTML($_); } ($W->{"title"} || ())))
401 if ($W->{"have_css"}) {
403 <style type="text/css"><!--
404 .cvs-id { font-family: monospace; }
405 .error { color: red; background-color: transparent; }
406 .quote { font-family: monospace; }
407 .nowrap { white-space: nowrap; }
408 .centered { text-align: center; }
409 .tab-bold { font-weight: bold; }
410 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
412 background-color: black;
415 :link { color: aqua; background-color: transparent; }
416 :visited { color: teal; background-color: transparent; }
417 h1,h2 { color: yellow; background-color: transparent; }
419 .footer img { vertical-align: middle; }
421 print $W->{"head_css"}."\n";
422 print "--></style>\n";
425 print '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
427 print "</head><body";
428 print ' bgcolor="black" text="white" link="aqua" vlink="teal"'
429 if $W->{"browser"}->netscape() && $W->{"browser"}->major<=4;