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;
44 # Undo 'www/engine/httpd-restart' as it may use obsolete Perl for 'mod_perl'
45 delete $ENV{"PERLLIB"};
46 delete $ENV{"LD_LIBRARY_PATH"};
53 # $W->{"force_charset"}
54 # %{$W->{"packages_used"}
55 # $W->{"heading_done"}
56 # $W->{"footer_passed"}
58 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
59 # @{$W->{"packages_used"}{$Apache::Registry::curstash}}}
66 $W={ %WebConfig,%args }; # override %WebConfig settings
68 $W->{"__PACKAGE__"}||="Apache::ROOT".$Apache::Registry::curstash;
70 $W->{"top_dir"}||=eval '$'.$W->{"__PACKAGE__"}.'::top_dir';
72 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_ent");
73 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_js");
74 do { $W->{$_}=1 if !defined $W->{$_}; } for ("have_css"); # AFAIK it does not hurt anyone.
75 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer");
76 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_delimit");
77 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_mailme");
78 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_ids");
79 do { $W->{$_}=1 if !defined $W->{$_}; } for ("indexme");
80 do { $W->{$_}="" if !defined $W->{$_}; } for ("head");
81 do { $W->{$_}="" if !defined $W->{$_}; } for ("head_css");
84 for (qw(footer_mailme footer_ids)) {
85 $W->{$_}=0 if !$W->{"footer"};
86 $footer_any=1 if $W->{$_};
88 $W->{"footer"}=0 if !$footer_any;
89 $W->{"footer_delimit"}=0 if !$W->{"footer"};
91 $W->{"r"}=Apache->request();
93 $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
94 if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
95 { $W->{"have_ent"}=0; }
96 elsif ($W->{"QUERY_STRING"}=~ /[&]have_ent/)
97 { $W->{"have_ent"}=1; }
99 { delete $W->{"have_ent"}; }
100 if ($W->{"detect_ent"} && !defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
101 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
102 .CGI::escapeHTML("http://".$W->{"r"}->hostname()."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
103 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
106 $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
107 $W->{"r"}->args($W->{"QUERY_STRING"});
108 $ENV{"QUERY_STRING"}=$W->{"QUERY_STRING"};
109 # Do not: $W->{"r"}->args()
110 # as it parses only QUERY_STRING (not POST data).
111 $W->{"args"}={ CGI->new()->Vars() };
113 do { $W->{$_}=$ENV{"HTTP_ACCEPT"} if !defined $W->{$_}; } for ("accept");
114 do { $W->{$_}=$ENV{"HTTP_USER_AGENT"} if !defined $W->{$_}; } for ("user_agent");
116 $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
118 if (!defined $W->{"have_style"}) {
119 $W->{"have_style"}=(!$W->{"browser"}->netscape() || $W->{"browser"}->major>4 ? 1 : 0);
122 $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
123 if ($W->{"detect_js"} && !$W->{"have_js"}) {
124 $W->{"head"}.='<script type="text/javascript" src="'.$W->{"top_dir"}.'/have_js.js.pl"></script>'."\n";
127 do { args_check(%$_) if $_; } for ($W->{"args_check"});
141 my $aref=($W->{"packages_used"}{$Apache::Registry::curstash}||=[]);
143 if !{ map(($_=>1),@$aref) }->{$class}; # Prevent duplicated entries.
145 1; # Otherwise 'require' would already file above.
154 while (my($name,$regex)=each(%tmpl)) {
155 my $name_html="Parametr <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
156 my $val=$W->{"args"}{$name};
157 fatal "$name_html <span class=\"quote\">".CGI::escapeHTML($val)."</span>"
158 ." does not match required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span>"
159 if defined $val && $val!~/$regex/;
160 fatal "$name_html is required"
169 return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'> </p>'."\n";
176 $msg="UNKNOWN" if !$msg;
178 # heading(false/*title*/,false/*indexme*/); # notitle is always safe, don't index the error message
179 print "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
180 ."<p>You can report this problem's details to"
181 ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
187 exit 1 if $W->{"footer_passed"}++; # deadlock prevention:
189 print vskip if $W->{"footer_delimit"};
191 print "<hr />\n" if $W->{"footer"};
193 if ($W->{"footer_mailme"}) {
194 print '<form action="'.$W->{"top_dir"}.'/SendMsg.pl" method="post" onsubmit="'
195 ."this.elements['msgscript'].value=this.elements['msghtml'].value;"
196 ."this.elements['msghtml'].value='';"
199 print '<p align="center">'."\n";
200 print '<input name="msgscript" type="hidden" />'."\n";
201 print '<input name="msghtml" type="text" size="32" alt="Message" />'."\n";
202 print '<input name="submit" type="submit" value="Quick Note" />'."\n";
204 print '</form>'."\n";
207 if ($W->{"footer_ids"}) {
208 print '<p class="cvs-id">';
209 print join("<br />\n",map({ my $package=$_;
210 my $cvs_id=(eval('$'.$package."::CVS_ID")
211 # || $package # debug
217 $cvs_id='$'.$cvs_id.'$'; # Eaten by 'q' operator.
218 my @cvs_id_split=split / +/,$cvs_id;
219 if (@cvs_id_split==8) {
223 for (qw(.html.pl .pl .pm),"") {
225 last if -r $W->{"top_dir"}."/$file$ext";
226 cluck "Class file $file not found" if !$ext;
230 .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
232 $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
233 ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
234 $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
236 join " ",@cvs_id_split;
241 @{$W->{"packages_used"}{$Apache::Registry::curstash}},
245 print "</body></html>\n";
253 while (my($key,$val)=each(%pairs)) {
254 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
255 for ($W->{"headers_lc"}{lc $key} || ()) {
256 delete $W->{"headers"}{$_};
258 $W->{"headers_lc"}{lc $key}=$key;
259 $W->{"headers"}{$key}=$val;
269 elsif ($size<1024*1024)
270 { $size=sprintf "%.1fK",$size/1024; }
272 { $size=sprintf "%.1fM",$size/1024/1024; }
281 return $url!~m#^[a-z]+://#;
286 my($url,$contents,%args)=@_;
288 do { $$_=1 if !defined $$_; } for ($args{"size"});
289 $contents=CGI::escapeHTML($url) if !defined $contents;
292 my $urlent=CGI::escapeHTML($url);
295 elsif (url_is_local $url)
297 elsif (defined $W->{"have_ent"} && !$W->{"have_ent"}) # non-ent client
299 elsif ($W->{"have_ent"}) # ent client
301 else # unknown client, &CGI::escapeHTML should not be needed here
302 { $r.=CGI::escapeHTML("http://".$W->{"r"}->hostname()."/Redirect.pl?location=".uri_escape($url)); }
303 $r.='">'.$contents.'</a>';
304 if ($args{"size"} && url_is_local($url) && $url=~/[.](?:gz|rpm|zip|deb)/) { # Downloadable?
306 { cluck "File not readable: $url"; }
308 $r.=' ('.size_display((stat($url))[7]).')';
316 # Do not: PerlModule Apache::ForwardedFor
317 # PerlPostReadRequestHandler Apache::ForwardedFor
318 # As 'Apache::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
319 # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
320 # We must take the last item ourselves.
321 my $r=$ENV{"HTTP_X_FORWARDED_FOR"} || $W->{"r"}->remote_host();
328 print STDERR "IP=".remote_ip()."\n";
329 return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
334 my($url,$contents,%args)=@_;
336 return a_href $url,$contents,%args if is_cz();
342 my($width,$height)=@_;
344 return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
345 ." width=\"$width\" height=\"$height\"";
348 sub negotiate_variant (%)
352 my @fields=("id","qs","content-type","encoding","charset","lang","size");
353 return [ map(($args{$_}),@fields) ];
357 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
358 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
360 my $img_variants_re='[.](?:'.join('|',map(($_->{"id"}),@img_variants)).')$';
364 my($file_base,$alt,$attrs)=@_;
367 if (url_is_local($file_base)
368 # No known image extension?
369 && $file_base!~m#$img_variants_re#o) {
371 for my $var (@img_variants) {
372 $file=$file_base.".".$var->{"id"};
373 # TODO: Somehow quickly check dependencies?
374 system 'make >&2 -s --no-print-directory'
375 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'"
377 push @nego_variants,negotiate_variant(
379 "size"=>(stat $file)[7],
382 # Do not: ,$W->{"r"});
383 # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
384 my $ext=HTTP::Negotiate::choose(\@nego_variants);
385 $ext||=$img_variants[0]->{"id"}; # &HTTP::Negotiate::choose failed?
386 $file=$file_base.".".$ext;
389 { $file=$file_base; }
390 my($width,$height)=Image::Size::imgsize($file);
391 $alt=CGI::escapeHTML($alt);
392 return "<img src=\"$file\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
393 .(!$attrs ? "" : " ".$attrs)." />";
398 my($class,$filename)=@_;
401 open F,$filename or die "Cannot open \"$filename\": $!";
414 push @r,shift @arr; # key
424 # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
425 my $client_charset=$W->{"force_charset"} || "us-ascii";
426 header("Content-Style-Type"=>"text/css");
427 header("Content-Script-Type"=>"text/javascript");
429 while (my($key,$val)=each(%{$W->{"headers"}})) {
430 $W->{"r"}->header_out($key,$val);
432 $W->{"r"}->send_http_header("text/html; charset=$client_charset"); # "Content-type"; do not use header()
434 return if $W->{"heading_done"}++;
435 exit if $W->{"r"}->header_only();
437 if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
438 print '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
440 print '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
441 print '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
442 print '<head><title>'.CGI::escapeHTML($W->{"title_prefix"})
443 .join("",map({ ': '.CGI::escapeHTML($_); } ($W->{"title"} || ())))
446 if ($W->{"have_css"}) {
448 <style type="text/css"><!--
449 .cvs-id { font-family: monospace; }
450 .error { color: red; background-color: transparent; }
451 .quote { font-family: monospace; }
452 .nowrap { white-space: nowrap; }
453 .centered { text-align: center; }
454 .tab-bold { font-weight: bold; }
455 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
457 background-color: black;
460 :link { color: aqua; background-color: transparent; }
461 :visited { color: teal; background-color: transparent; }
462 h1,h2 { color: yellow; background-color: transparent; }
464 .footer img { vertical-align: middle; }
466 print $W->{"head_css"}."\n";
467 print "--></style>\n";
470 print '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
472 print "</head><body";
473 print ' bgcolor="black" text="white" link="aqua" vlink="teal"'
474 if $W->{"browser"}->netscape() && $W->{"browser"}->major<=4;