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 &input_hidden_persistents);
31 our @ISA=qw(Exporter Tie::Handle);
35 $W->{"__My::Web_init"}=1;
41 # print STDERR "Wrequire $file\n";
47 my $who=$W->{"__PACKAGE__"};
48 $who||="__My::Web" if $W->{"__My::Web_init"};
49 my $aref=($W->{"packages_used"}{$who}||=[]);
51 if !{ map(($_=>1),@$aref) }->{$class}; # Prevent duplicated entries.
53 1; # Otherwise 'require' would already file above.
60 # print STDERR "Wuse $file\n";
62 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
68 BEGIN { Wuse 'WebConfig'; } # for %WebConfig
69 require CGI; # for &escapeHTML
70 require Image::Size; # for &imgsize
71 use File::Basename; # &basename
72 use Carp qw(cluck confess);
74 require HTTP::BrowserDetect;
75 require HTTP::Negotiate;
76 my $have_Geo_IP; BEGIN { $have_Geo_IP=eval { require Geo::IP; 1; }; }
77 use ModPerl::Util qw(exit);
78 use POSIX qw(strftime);
80 use Apache::Const qw(HTTP_MOVED_TEMPORARILY);
89 # $W->{"force_charset"}
90 # $W->{"heading_done"}
91 # $W->{"footer_passed"}
93 # %{$W->{"headers_lc"}} # maps lc($headers_key)=>$headers_key
94 # @{$W->{"packages_used"}{$W->{"__PACKAGE__"}}}
95 # @{$W->{"packages_used"}{"__My::Web"}}
102 print STDERR "$class->init ".Apache->request()->unparsed_uri()."\n";
104 my $packages_used_save=$W->{"packages_used"};
105 $W={ %WebConfig,%args }; # override %WebConfig settings
106 $W->{"packages_used"}=$packages_used_save;
108 # {"__PACKAGE__"} is mandatory for mod_perl-2.0;
109 # $Apache::Registry::curstash is no longer supported.
110 do { cluck "No $_" if !$W->{$_}; } for "__PACKAGE__";
112 $W->{"top_dir"}||=eval '$'.$W->{"__PACKAGE__"}.'::top_dir';
114 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_ent");
115 do { $W->{$_}=0 if !defined $W->{$_}; } for ("detect_js");
116 do { $W->{$_}=1 if !defined $W->{$_}; } for ("have_css"); # AFAIK it does not hurt anyone.
117 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer");
118 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_delimit");
119 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_mailme");
120 do { $W->{$_}=1 if !defined $W->{$_}; } for ("footer_ids");
121 do { $W->{$_}=1 if !defined $W->{$_}; } for ("indexme");
122 do { $W->{$_}="" if !defined $W->{$_}; } for ("head");
123 do { $W->{$_}="" if !defined $W->{$_}; } for ("head_css");
126 for (qw(footer_mailme footer_ids)) {
127 $W->{$_}=0 if !$W->{"footer"};
128 $footer_any=1 if $W->{$_};
130 $W->{"footer"}=0 if !$footer_any;
131 $W->{"footer_delimit"}=0 if !$W->{"footer"};
133 $W->{"r"}=Apache->request();
135 $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
136 if ($W->{"detect_ent"}) {
137 if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
138 { $W->{"have_ent"}=0; }
139 elsif ($W->{"QUERY_STRING"}=~ /[&]have_ent/)
140 { $W->{"have_ent"}=1; }
142 { delete $W->{"have_ent"}; }
143 if (!defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
144 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
145 .CGI::escapeHTML("http://".&{$W->{"web_hostname_sub"}}()."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
146 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
150 $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
151 $W->{"r"}->args($W->{"QUERY_STRING"});
152 # Workaround: &CGI::Vars behaves weird if strings passed both as POST data and in: $QUERY_STRING
153 do { $W->{"r"}->args(""); delete $ENV{"QUERY_STRING"}; } if $W->{"r"}->method() eq "POST";
154 # Do not: $W->{"r"}->args()
155 # as it parses only QUERY_STRING (not POST data).
156 $W->{"args"}={ CGI->new($W->{"r"})->Vars() };
157 for my $name (keys(%{$W->{"args"}})) {
158 my @vals=split /\x00/,$W->{"args"}{$name};
160 $W->{"args"}{$name}=[@vals];
163 do { $W->{$_}=$W->{"r"}->headers_in()->{"Accept"} if !defined $W->{$_}; } for ("accept");
164 do { $W->{$_}=$W->{"r"}->headers_in()->{"User-Agent"} if !defined $W->{$_}; } for ("user_agent");
166 $W->{"browser"}=HTTP::BrowserDetect->new($W->{"user_agent"});
168 if (!defined $W->{"have_style"}) {
169 $W->{"have_style"}=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
172 $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
173 if ($W->{"detect_js"} && !$W->{"have_js"}) {
174 $W->{"head"}.='<script type="text/javascript" src="'.top_dir('/have_js.js.pl').'"></script>'."\n";
177 do { args_check(%$_) if $_; } for ($W->{"args_check"});
179 $ENV{"HOSTNAME"}||=&{$W->{"web_hostname_sub"}}();
181 return bless $W,$class;
188 $W->{"r"}->puts($text);
192 # tie *FH,ref($W),$W;
198 $self->{"W"}=$W or confess "Missing W";
199 return bless $self,$class;
204 my($self,$scalar,$length,$offset)=@_;
206 Wprint substr($scalar,0,$length);
211 do { return $_ if $_; } for ($W->{"top_dir"});
212 return $INC[0]; # fallback
220 if (my $uri=$W->{"r"}->unparsed_uri()) {
221 if ($W->{"args"}{"Wabs"} || $args{"abs"}) {
222 # FIXME: $in may not be defined here!
223 # to prevent: Use of uninitialized value in ...
230 1 while $in=~s#/(?:[^/]+)/\Q..\E/#/#g
232 return "http://".&{$W->{"web_hostname_sub"}}()."/".(defined $in ? $in : "");
234 $uri.="Index" if $uri=~m#/$#;
236 my($inpath,$inquery)=split /[?]/,$in,2;
240 my($in1 ,$in2 )=($in =~m#^(/[^/]+)(/.*)$#);
241 my($uri1,$uri2)=($uri=~m#^(/[^/]+)(/.*)$#);
242 last if !defined $in1 || !defined $uri1 || $in1 ne $uri1;
249 $uri=File::Basename::dirname($uri);
250 my $r=$uri.(defined $in ? $in : "");
251 # 1 while $r=~s#^[.]/##;
252 # $r="./$r" if $r=~m#^(?:?.*)$#; # empty pathname?
255 return top_dir_disk().$in;
264 while (my($name,$regex)=each(%tmpl)) {
265 my $name_html="Parameter <span class=\"quote\">".CGI::escapeHTML($name)."</span>";
266 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
267 $W->{"args"}{$name}=[ $W->{"args"}{$name} ] if !ref $W->{"args"}{$name} && ref $regex;
268 fatal "$name_html passed as multivar although singlevar expected"
269 if ref $W->{"args"}{$name} && !ref $regex;
270 $regex=$regex->[0] if ref $regex;
271 for my $val (!ref $W->{"args"}{$name} ? $W->{"args"}{$name} : @{$W->{"args"}{$name}}) {
272 $val="" if !defined $val;
273 fatal "$name_html <span class=\"quote\">".CGI::escapeHTML($val)."</span>"
274 ." does not match the required regex <span class=\"quote\">".CGI::escapeHTML($regex)."</span> "
275 if $regex ne "" && $val!~/$regex/;
284 return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'> </p>'."\n";
291 $msg="UNKNOWN" if !$msg;
294 $W->{"indexme"}=0; # For the case no heading was sent yet.
295 $W->{"heading_done"}=0; # for the case of already sent {"header_only"}==1
296 $W->{"header_only"}=0; # assurance for &heading
298 Wprint "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
299 ."<p>You can report this problem's details to"
300 ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
306 exit 1 if $W->{"footer_passed"}++; # deadlock prevention:
308 Wprint vskip if $W->{"footer_delimit"};
310 do { &{$_}() if $_; } for ($W->{"footing_delimit"});
312 Wprint "<hr />\n" if $W->{"footer"};
314 if ($W->{"footer_mailme"}) {
315 Wprint '<form action="'.top_dir('/SendMsg.pl').'" method="post" onsubmit="'
316 ."this.elements['msgscript'].value=this.elements['msghtml'].value;"
317 ."this.elements['msghtml'].value='';"
320 Wprint input_hidden_persistents()."\n";
321 Wprint '<p align="right">'."\n";
322 Wprint '<input name="msgscript" type="hidden" />'."\n";
323 Wprint '<input name="msghtml" type="text" size="32" alt="Message" />'."\n";
324 Wprint '<input name="submit" type="submit" value="Quick Note" />'."\n";
326 Wprint '</form>'."\n";
332 @{$W->{"packages_used"}{"__My::Web"}},
333 map((!$_ ? () : @$_),$W->{"packages_used"}{$W->{"__PACKAGE__"}}),
336 @packages_used=grep((!$packages_used{$_}++),@packages_used);
337 if ($W->{"footer_ids"}) {
338 Wprint '<p class="cvs-id">';
339 Wprint join("<br />\n",map({ my $package=$_;
340 my $cvs_id=(eval('$'.$package."::CVS_ID")
341 # || $package # debug
347 $cvs_id='$'.$cvs_id.'$'; # Eaten by 'q' operator.
348 my @cvs_id_split=split / +/,$cvs_id;
349 if (@cvs_id_split==8) {
354 for (qw(.html.pl .pl .pm),"") {
356 my $pathname=top_dir_disk()."/$file$ext";
357 push @tried,$pathname;
358 last if -r $pathname;
359 cluck "Class file $file not found; tried: ".join(" ",@tried) if !$ext;
363 .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
365 $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
366 ($package!~/^Apache::/ ? $package : $cvs_id_split[1]));
367 $cvs_id_split[5]=&{$W->{"cvs_id_author"}}($cvs_id_split[5]);
369 join " ",@cvs_id_split;
375 for my $package (@packages_used) {
376 my $cvs_id=(eval('$'.$package."::CVS_ID")
377 # || $package # debug
379 Wprint '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
382 do { &{$_}() if $_; } for ($W->{"footing"});
384 Wprint "</body></html>\n";
392 while (my($key,$val)=each(%pairs)) {
393 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
394 for ($W->{"headers_lc"}{lc $key} || ()) {
395 delete $W->{"headers"}{$_};
397 $W->{"headers_lc"}{lc $key}=$key;
398 $W->{"headers"}{$key}=$val;
408 elsif ($size<1024*1024)
409 { $size=sprintf "%.1fK",$size/1024; }
411 { $size=sprintf "%.1fM",$size/1024/1024; }
420 return $url!~m#^[a-z]+://#;
427 return $url if !url_is_local $url;
428 $url=top_dir($url,%args) if $url=~m#^/# || $args{"abs"};
430 my $uri=URI->new($url);
431 for my $key (keys(%{$W->{"args_persistent"}})) {
432 my $val=$W->{"args"}{$key};
433 next if !defined $val;
434 $uri->query_param_append($key=>$val);
443 my($url,$contents,%args)=@_;
445 do { $$_=1 if !defined $$_; } for (\$args{"size"});
446 if (!defined $contents) {
448 $contents=File::Basename::basename($contents) if $args{"basename"};
449 $contents=CGI::escapeHTML($contents);
451 $contents=~s#<a\b[^>]*>##gi;
452 $contents=~s#</a>##gi;
454 $url=url_out($url,%args);
457 my $urlent=CGI::escapeHTML($url);
460 elsif (url_is_local $url)
462 elsif (defined $W->{"have_ent"} && !$W->{"have_ent"}) # non-ent client
464 elsif ($W->{"have_ent"}) # ent client
466 else # unknown client, &CGI::escapeHTML should not be needed here
467 { $r.=CGI::escapeHTML(top_dir('/Redirect.pl?location='.uri_escape($url))); }
469 do { $r.=" $_" if $_; } for ($args{"attr"});
470 $r.='>'.$contents.'</a>';
471 if ($args{"size"} && url_is_local($url) && ($args{"size"}>=2 || $url=~/[.](?:gz|Z|rpm|zip|deb|lha)/)) { # Downloadable?
472 $url=top_dir_disk().$url if $url=~m#^/#;
474 { cluck "File not readable: $url"; }
476 $r.=' ('.size_display((stat($url))[7]).')';
482 sub input_hidden_persistents()
486 my $val=$W->{"args"}{$key};
487 (!defined $val ? () : '<input type="hidden"'
488 .' name="'.CGI::escapeHTML($key).'"'
489 .' value="'.CGI::escapeHTML($val).'"'
491 } (keys(%{$W->{"args_persistent"}}))));
496 my($self,$url,$status)=@_;
498 $url=url_out($url,"abs"=>1);
499 $status||=Apache::HTTP_MOVED_TEMPORARILY;
500 $W->{"r"}->status($status);
501 $W->{"r"}->header_out("Location"=>$url);
502 $W->{"header_only"}=1;
510 # Do not: PerlModule Apache::ForwardedFor
511 # PerlPostReadRequestHandler Apache::ForwardedFor
512 # As 'Apache::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
513 # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
514 # We must take the last item ourselves.
515 my $r=$W->{"r"}->headers_in()->{"X-Forwarded-For"} || $W->{"r"}->get_remote_host();
522 return 0 if !$have_Geo_IP;
523 return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
528 my($url,$contents,%args)=@_;
530 return a_href $url,$contents,%args if is_cz();
538 system {'flock'} 'flock','-x',top_dir_disk(),$cmd.' >&2';
543 my($width,$height)=@_;
545 return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
546 ." width=\"$width\" height=\"$height\"";
549 sub negotiate_variant (%)
553 my @fields=("id","qs","content-type","encoding","charset","lang","size");
554 return [ map(($args{$_}),@fields) ];
558 { "id"=>"png","qs"=>1.0,"content-type"=>"image/png" },
559 { "id"=>"gif","qs"=>0.9,"content-type"=>"image/gif" },
561 my $img_variants_re='[.](?:'.join('|',"jpeg",map(($_->{"id"}),@img_variants)).')$';
567 if (!url_is_local($file_base)) {
568 return $file_base if !wantarray();
569 return ($file_base,$file_base);
571 # Known image extension?
572 if ($file_base=~m#$img_variants_re#o) {
573 return $file_base if !wantarray();
574 return ($file_base,$file_base) if $file_base!~m#^/#;
575 return (top_dir($file_base),top_dir_disk().$file_base);
580 if ($file_base!~m#^/#) {
581 $file_base_disk=$file_base_uri=$file_base;
584 $file_base_disk=top_dir_disk().$file_base;
585 $file_base_uri=top_dir($file_base);
589 for my $var (@img_variants) {
590 my $file=$file_base_disk.".".$var->{"id"};
591 # TODO: Somehow quickly check dependencies?
592 make('make -s --no-print-directory'
593 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'")
595 push @nego_variants,negotiate_variant(
597 "size"=>(stat $file)[7],
600 # Do not: ,$W->{"r"});
601 # but should we provide somehow either 'HTTP::Headers' or 'HTTP::Request' ?
602 my $ext=HTTP::Negotiate::choose(\@nego_variants);
603 $ext||=$img_variants[0]->{"id"}; # &HTTP::Negotiate::choose failed?
605 return $file_base_uri.".".$ext if !wantarray();
606 return ($file_base_uri.".".$ext,$file_base_disk.".".$ext);
611 my($file_base,$alt,%attr)=@_;
613 my($file_uri,$file_disk)=img_src $file_base;
614 my($width,$height)=Image::Size::imgsize($file_disk);
616 $alt=CGI::escapeHTML($alt);
617 my $content="<img src=\"$file_uri\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
618 .(!$attr{"attr"} ? "" : " ".$attr{"attr"})." />";
619 return a_href img_src($attr{"a_href_img"}),$content if $attr{"a_href_img"};
620 return a_href $attr{"a_href"},$content if $attr{"a_href"};
627 $r.='<table border="0" width="100%"><tr>'."\n";
628 @_=( [@_] ) if !ref $_[0];
630 $r.="\t".'<td align="center">'.&{\&img}(@$_).'</td>'."\n";
632 $r.='</tr></table>'."\n";
638 my($text,@args_img)=@_;
640 # Workaround bug of 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)':
642 <table border="0" width="100%">
643 <col width="@{[ (!$W->{"browser"}->ie() ? "1*" : "90%" ) ]}" />
644 <col width="@{[ (!$W->{"browser"}->ie() ? "0*" : "10%" ) ]}" />
650 @{[ &{\&img}(@args_img) ]}
659 my($class,$filename)=@_;
662 open F,$filename or die "Cannot open \"$filename\": $!";
675 push @r,shift @arr; # key
685 header("Expires"=>"Mon, 26 Jul 1997 05:00:00 GMT"); # date in the past
686 header("Last-Modified"=>strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime())); # always modified
687 header("Cache-Control"=>"no-cache, must-revalidate"); # HTTP/1.1
688 header("Pragma"=>"no-cache"); # HTTP/1.0
695 # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
696 my $client_charset=$W->{"force_charset"} || "us-ascii";
697 header("Content-Style-Type"=>"text/css");
698 header("Content-Script-Type"=>"text/javascript");
699 $class->no_cache() if $W->{"no_cache"};
701 while (my($key,$val)=each(%{$W->{"headers"}})) {
702 $W->{"r"}->header_out($key,$val);
704 if (!$W->{"header_only"}) {
705 $W->{"r"}->send_http_header("text/html; charset=$client_charset"); # "Content-type"; do not use header()
708 exit if $W->{"r"}->header_only();
709 return if $W->{"header_only"};
710 # We still can append headers before we put out some text.
711 # FIXME: It is not clean to still append them without overwriting.
712 return if $W->{"heading_done"}++;
714 if (1) { # || !$msie_major || $msie_major>=4) # TODO:dyn
715 Wprint '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n";
717 Wprint '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
718 Wprint '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">'."\n";
719 my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
720 $title=~s#<[^>]*>##g;
722 Wprint "<title>$title</title>\n";
724 if ($W->{"have_css"}) {
726 <style type="text/css"><!--
727 .cvs-id { font-family: monospace; }
728 .error { color: red; background-color: transparent; }
729 .quote { font-family: monospace; }
730 .nowrap { white-space: nowrap; }
731 .centered { text-align: center; }
732 .tab-bold { font-weight: bold; }
733 .tab-head { font-weight: bold; }
735 .tab-head { font-weight: bold; color: yellow; background-color: transparent; }
737 background-color: black;
740 :link { color: aqua; background-color: transparent; }
741 :visited { color: teal; background-color: transparent; }
742 h1,h2 { color: yellow; background-color: transparent; }
745 caption { caption-side: bottom; }
746 .footer img { vertical-align: middle; }
748 Wprint $W->{"head_css"}."\n";
749 Wprint "--></style>\n";
752 Wprint '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
754 for my $type (qw(prev next index contents start up)) {
755 do { Wprint '<link rel="'.$type.'" href="'.$_.'" />'."\n" if $_; } for ($W->{"rel_$type"});
757 Wprint "</head><body";
758 # Wprint ' bgcolor="black" text="white" link="aqua" vlink="teal"'
759 # if $W->{"browser"}->netscape() && (!$W->{"browser"}->major() || $W->{"browser"}->major()<=4);
760 do { &{$_}($W) if $_; } for $W->{"body_attr_sub"};
763 do { &{$_}() if $_; } for ($W->{"heading"});
767 delete $W->{"__My::Web_init"};