2 # Common functions for HTML/XHTML output generation
3 # Copyright (C) 2003-2005 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; };
32 &path_web &path_abs_disk
36 &img ¢erimg &rightimg
38 &input_hidden_persistents
41 our @ISA=qw(Tie::Handle Exporter);
43 my %packages_used_hash; # $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
44 my %packages_used_array;
48 use Carp qw(cluck confess);
49 $W->{"__My::Web_init"}=1;
55 # print STDERR "Wrequire $file\n";
62 for (my $depth=0;defined caller($depth);$depth++) {
63 $callers{caller($depth)}=1;
65 my $selfpkg=__PACKAGE__;
67 for my $target ($class,__PACKAGE__) {
68 for my $caller (keys(%callers)) {
69 next if $caller eq $target;
70 next if $packages_used_hash{$caller}{$target}++;
71 push @{$packages_used_array{$caller}},$target;
74 eval { CORE::require "$file"; } or confess $@;
75 1; # Otherwise 'require' would already file above.
82 # print STDERR "Wuse $file\n";
84 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
93 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
95 return $class->SUPER::import(@rest);
99 use WebConfig; # see also below: Wuse 'WebConfig';
101 require Image::Size; # for &imgsize
102 use File::Basename; # &basename
103 use Carp qw(cluck confess);
105 require HTTP::BrowserDetect;
106 require HTTP::Negotiate;
107 our $have_Geo_IP; BEGIN { $have_Geo_IP=eval { require Geo::IP; 1; }; }
108 # Do not: use ModPerl::Util qw(exit);
109 # to prevent in mod_perl2: "exit" is not exported by the ModPerl::Util module
111 use POSIX qw(strftime);
113 use Apache2::Const qw(HTTP_MOVED_TEMPORARILY OK HTTP_OK);
120 require Data::Compare;
130 my($apache_request)=@_;
132 $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
139 sub request_check(;$)
143 # Use &eval to prevent: Global $r object is not available. Set:\n\tPerlOptions +GlobalRequest\nin ...
144 # CGI requires valid "r": check it beforehand here.
145 confess "Calling sensitive dynamic code from a static code" if !eval { Apache2::RequestUtil->request(); };
146 # Do not: confess "Calling sensitive dynamic code without My::Web::init" if !$W->{"__PACKAGE__"};
147 # as it is valid at least while preparing arguments to call: &project::Lib::init
154 print STDERR "$class->init ".Apache2::RequestUtil->request()->unparsed_uri()."\n";
156 # We need to track package dependencies, so we need to call it from &init.
157 # We cannot do it in BEGIN { } block
158 # as it would not be tracked for each of the toplevel users later.
163 "__PACKAGE__"=>scalar(caller()),
165 %args, # override %WebConfig settings
166 },"My::Hash::Sub","My::Hash::Push");
168 # {"__PACKAGE__"} is mandatory for mod_perl-2.0;
169 # $Apache2::Registry::curstash is no longer supported.
170 do { cluck "No $_" if !$W->{$_}; } for "__PACKAGE__";
173 do { cluck "charset==$_, expecting ISO-8859-1" if $_ ne "ISO-8859-1"; } for CGI::charset();
174 CGI::charset("utf-8");
176 do { $W->{$_}=0 if !defined $W->{$_}; } for "detect_ent";
177 do { $W->{$_}=0 if !defined $W->{$_}; } for "detect_js";
178 do { $W->{$_}=1 if !defined $W->{$_}; } for "have_css"; # AFAIK it does not hurt anyone.
179 do { $W->{$_}=0 if !defined $W->{$_}; } for "css_inherit";
180 do { $W->{$_}=1 if !defined $W->{$_}; } for "footer";
181 do { $W->{$_}=1 if !defined $W->{$_}; } for "footer_delimit";
182 do { $W->{$_}=1 if !defined $W->{$_}; } for "footer_ids";
183 do { $W->{$_}=1 if !defined $W->{$_}; } for "indexme";
184 do { $W->{$_}="" if !defined $W->{$_}; } for "head";
185 do { $W->{$_}="" if !defined $W->{$_}; } for "body_attr";
186 do { $W->{$_}="en-US" if !defined $W->{$_}; } for "language";
189 for (qw(footer_ids)) {
190 $W->{$_}=0 if !$W->{"footer"};
191 $footer_any=1 if $W->{$_};
193 $W->{"footer"}=0 if !$footer_any;
194 $W->{"footer_delimit"}=0 if !$W->{"footer"};
196 $W->{"r"}=Apache2::RequestUtil->request();
198 $W->{"r"}->push_handlers("PerlCleanupHandler"=>\&cleanup);
200 $W->{"web_hostname"}||=$W->{"r"}->hostname();
202 tie *STDOUT,$W->{"r"};
206 $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
207 if ($W->{"detect_ent"}) {
208 if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
209 { $W->{"have_ent"}=0; }
210 elsif ($W->{"QUERY_STRING"}=~ /[&]have_ent/)
211 { $W->{"have_ent"}=1; }
213 { delete $W->{"have_ent"}; }
214 if (!defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
215 $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
216 .escapeHTML("http://".$W->{"web_hostname"}."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
217 ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
221 $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
222 $W->{"r"}->args($W->{"QUERY_STRING"});
223 # Workaround: &CGI::Vars behaves weird if strings passed both as POST data and in: $QUERY_STRING
224 do { $W->{"r"}->args(""); delete $ENV{"QUERY_STRING"}; } if $W->{"r"}->method() eq "POST";
225 # Do not: $W->{"r"}->args()
226 # as it parses only QUERY_STRING (not POST data).
227 $W->{"args_orig_array"}=[ CGI->new($W->{"r"})->Vars() ];
228 $W->{"args"}={ @{$W->{"args_orig_array"}} };
229 for my $name (keys(%{$W->{"args"}})) {
230 my @vals=split /\x00/,$W->{"args"}{$name};
232 $W->{"args"}{$name}=[@vals];
235 $W->{"headers_in"}=$W->{"r"}->headers_in();
236 Wrequire 'My::Hash::Merge';
237 $W->{"headers_in"}=My::Hash::Merge->new(
240 "_get_remote_host"=>sub { return $W->{"r"}->get_remote_host(); },
243 $W->{"headers_in"}=My::Hash::Readonly->new($W->{"headers_in"});
245 if ($W->{"r"}->method() eq "GET" || $W->{"r"}->method() eq "HEAD") {
246 for (\$W->{"http_safe"}) {
247 # Extend the current ETag system instead if you would need it:
248 cluck "Explicitely NOT HTTP-Safe for method \"".$W->{"r"}->method()."\"?!?"
249 if defined($$_) && !$$_;
250 $$_=1 if !defined $$_;
254 for (\$W->{"http_safe"}) {
255 cluck "Undefined HTTP-Safe-ty for method \"".$W->{"r"}->method()."\"!"
257 $$_=0 if !defined $$_;
260 if ($W->{"http_safe"}) {
261 Wrequire 'My::Hash::RecordKeys';
262 $W->{"headers_in_RecordKeys"}=My::Hash::RecordKeys->new($W->{"headers_in"});
263 $W->{"headers_in"}=$W->{"headers_in_RecordKeys"};
266 $W->{"browser"}=HTTP::BrowserDetect->new($W->{"headers_in"}{"User-Agent"});
268 if (!defined $W->{"have_style"}) {
269 $W->{"have_style"}=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
272 $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
273 if ($W->{"detect_js"} && !$W->{"have_js"}) {
274 $W->{"head"}.='<script type="text/javascript" src="'.uri_escaped(path_web('/have_js.pm')).'"></script>'."\n";
277 do { _args_check(%$_) if $_; } for ($W->{"args_check"});
279 return bless $W,$class;
282 # Be aware other parts of code (non-My::Web) will NOT use this function!
283 # Do not: Wprint $W->{"heading"},"undef"=>1;
284 # as we would need to undef() it to turn it off and it would get defaulted in such case.
285 # Do not: exists $W->{"heading"}
286 # as we use a lot of 'for $W->{"heading"}' which instantiates it with the value: undef()
291 cluck "undef Wprint" if !defined $text && !$args{"undef"};
292 delete $args{"undef"};
293 cluck join(" ","Invalid arguments:",keys(%args)) if keys(%args);
294 return if !defined $text;
295 cluck "utf-8 untested" if Encode::is_utf8($text);
296 $W->{"r"}->puts($text);
303 # Prevent &CGI::escapeHTML breaking utf-8 strings like: \xC4\x9B eq \x{11B}
304 # Prevent case if we run under mod_perl but still just initializing:
305 request_check() if $ENV{"MOD_PERL"};
306 # Generally we are initialized from &init but we may be used without it without mod_perl
307 # and in such case check the change on all non-first invocations.
309 if (!$ENV{"MOD_PERL"} && $init++) {
310 do { cluck "charset==$_" if $_ ne "utf-8"; } for CGI::charset();
312 CGI::charset("utf-8");
314 return CGI::escapeHTML($text);
318 # tie *FH,ref($W),$W;
324 $self->{"W"}=$W or confess "Missing W";
325 return bless $self,$class;
330 my($self,$scalar,$length,$offset)=@_;
332 Wprint substr($scalar,0,$length);
335 # /home/user/www/webdir
336 sub dir_top_abs_disk()
338 our $dir_top_abs_disk;
339 if (!$dir_top_abs_disk) {
340 my $selfpkg_relpath=__PACKAGE__;
341 $selfpkg_relpath=~s{::}{/}g;
342 $selfpkg_relpath.=".pm";
343 my $selfpkg_abspath=$INC{$selfpkg_relpath} or do {
344 cluck "Unable to find self package $selfpkg_relpath";
347 $selfpkg_abspath=~s{/*\Q$selfpkg_relpath\E$}{} or do {
348 cluck "Unable to strip myself \"$selfpkg_relpath\" from the abspath: $selfpkg_abspath";
351 cluck "INC{myself} is relative?: $selfpkg_abspath" if $selfpkg_abspath!~m{^/};
352 $dir_top_abs_disk=$selfpkg_abspath;
354 return $dir_top_abs_disk;
360 if (!$W->{"unparsed_uri"}) {
362 # as we may be called before &init from: &My::Project::init
363 my $r=Apache2::RequestUtil->request();
364 cluck "Calling ".'&unparsed_uri'." from a static code, going to fail" if !$r;
365 my $uri_string=$r->unparsed_uri() or cluck "Valid 'r' missing unparsed_uri()?";
366 my $uri=URI->new_abs($uri_string,"http://".$W->{"web_hostname"}."/");
367 $W->{"unparsed_uri"}=$uri;
369 return $W->{"unparsed_uri"};
376 # Otherwise we may have been already processed and thus legally relativized.
377 # FIXME data: Currently disabled, all the data are too violating such rule.
379 my $uri_check=URI->new($in);
380 $uri_check->scheme() || $in=~m{^\Q./\E} || $in=~m{^/}
381 or cluck "Use './' or '/' prefix for all the local references: $in";
383 my $uri=URI->new_abs($in,unparsed_uri());
384 $uri=$uri->canonical();
388 # $args{"uri_as_in"}=1 to permit passing URI objects as: $in
394 cluck if !$args{"uri_as_in"} && ref $in;
395 my $uri=in_to_uri_abs($in);
396 if (uri_is_local($uri)) {
397 # Prefer the $uri values over "args_persistent" values.
398 $uri->query_form_hash({
401 my $val=$W->{"args"}{$key};
402 (!defined $val ? () : ($key=>$val));
403 } keys(%{$W->{"args_persistent"}})),
404 %{$uri->query_form_hash()},
407 return $uri->abs(unparsed_uri()) if $W->{"args"}{"Wabs"} || $args{"abs"};
408 return $uri->rel(unparsed_uri());
411 sub path_abs_disk_register($)
413 my($path_abs_disk)=@_;
415 $W->{"path_abs_disk_register"}{$path_abs_disk}=1;
418 # $args{"uri_as_in"}=1 to permit passing URI objects as: $in
419 sub path_abs_disk($%)
423 cluck if !$args{"uri_as_in"} && ref $in;
424 my $uri=in_to_uri_abs($in);
425 cluck if !uri_is_local($uri);
426 my $path=$uri->path();
427 cluck "URI compatibility: ->path() not w/leading slash of URI \"$uri\"; path: $path" if $path!~m{^/};
428 my $r=dir_top_abs_disk().$path;
429 path_abs_disk_register $r if !defined $args{"register"} || $args{"register"};
439 while (my($name,$regex)=each(%tmpl)) {
440 my $name_html="Parameter <span class=\"quote\">".escapeHTML($name)."</span>";
441 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
442 $W->{"args"}{$name}=[ $W->{"args"}{$name} ] if !ref $W->{"args"}{$name} && ref $regex;
443 fatal "$name_html passed as multivar although singlevar expected"
444 if ref $W->{"args"}{$name} && !ref $regex;
445 $regex=$regex->[0] if ref $regex;
446 for my $val (!ref $W->{"args"}{$name} ? $W->{"args"}{$name} : @{$W->{"args"}{$name}}) {
447 $val="" if !defined $val;
448 fatal "$name_html <span class=\"quote\">".escapeHTML($val)."</span>"
449 ." does not match the required regex <span class=\"quote\">".escapeHTML($regex)."</span> "
450 if $regex ne "" && $val!~/$regex/;
459 return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'> </p>'."\n";
466 $msg="UNKNOWN" if !$msg;
469 # Do not send it unconditionally.
470 # The intial duplicated '<?xml...' crashes Gecko parser.
471 $W->{"heading_done"}=0 if $W->{"header_only"};
472 # Do not send it unconditionally.
473 # Prevents warn: Headers already sent
474 if (!$W->{"heading_done"}) {
475 $W->{"indexme"}=0; # For the case no heading was sent yet.
476 $W->{"header_only"}=0; # assurance for &heading
479 Wprint "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
480 ."<p>You can report this problem's details to"
481 ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
487 exit 1 if $W->{"footer_passed"}++; # deadlock prevention:
489 Wprint vskip if $W->{"footer_delimit"};
491 do { Wprint $_ if $_; } for $W->{"footing_delimit"};
493 Wprint "<hr />\n" if $W->{"footer"};
495 my $packages_used=$packages_used_array{$W->{"__PACKAGE__"}};
497 if ($W->{"footer_ids"}) {
498 Wprint '<p class="cvs-id">';
499 Wprint join("<br />\n",map({ my $package=$_;
500 my $cvs_id=(eval('$'.$package."::CVS_ID")
501 # || $package # debug
507 $cvs_id='$'.$cvs_id.'$'; # Eaten by 'q' operator.
508 my @cvs_id_split=split / +/,$cvs_id;
509 if (@cvs_id_split==8) {
516 my $path_abs_disk=path_abs_disk("/$file$ext");
517 push @tried,$path_abs_disk;
518 last if -r $path_abs_disk;
519 cluck "Class file $file not found; tried: ".join(" ",@tried) if !$ext;
523 .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
525 $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
526 ($package!~/^Apache2::/ ? $package : $cvs_id_split[1]));
527 $cvs_id_split[5]=&{$W->{"cvs_id_author_sub"}}($cvs_id_split[5]);
529 join " ",@cvs_id_split;
535 for my $package (@$packages_used) {
536 my $cvs_id=(eval('$'.$package."::CVS_ID")
537 # || $package # debug
539 Wprint '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
542 do { Wprint $_ if $_; } for $W->{"footing"};
544 Wprint "</body></html>\n";
548 # Existing entries are overwritten.
553 while (my($key,$val)=each(%pairs)) {
554 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
555 $W->{"r"}->headers_out()->set($key,$val);
565 elsif ($size<1024*1024)
566 { $size=sprintf "%.1fK",$size/1024; }
568 { $size=sprintf "%.1fM",$size/1024/1024; }
577 my $uri_rel=in_to_uri_abs($in)->rel(unparsed_uri());
578 # Do not: defined $uri_rel->("userinfo"|"host"|"port")();
579 # as they fail to be called for schemes not supporting them.
580 return 0 if $uri_rel->scheme();
581 return 0 if $uri_rel->authority();
585 # &path_web still may be required for &uri_escaped !
591 my $urient=escapeHTML($uri);
592 return $uri if $uri eq $urient;
594 return $urient if uri_is_local $uri;
595 return $uri if defined $W->{"have_ent"} && !$W->{"have_ent"}; # non-ent client
596 return $urient if $W->{"have_ent"}; # ent client
597 # Unknown client, &escapeHTML should not be needed here:
598 return escapeHTML(path_web('/Redirect.pm?location='.uri_escape($uri->abs(unparsed_uri()))));
601 our $a_href_inhibited;
604 my($in,$contents,%args)=@_;
607 do { $$_=1 if !defined $$_; } for (\$args{"size"});
608 if (!defined $contents) {
610 $contents=File::Basename::basename($contents) if $args{"basename"};
611 $contents=escapeHTML($contents);
613 $contents=~s#<a\b[^>]*>##gi;
614 $contents=~s#</a>##gi;
615 return $contents if $a_href_inhibited;
617 my $path_web=path_web $in,%args;
620 $r.=uri_escaped $path_web;
622 do { $r.=" $_" if $_; } for ($args{"attr"});
623 $r.='>'.$contents.'</a>';
624 if ($args{"size"} && uri_is_local($in) && ($args{"size"}>=2 || $in=~/[.](?:gz|Z|rpm|zip|deb|lha)/)) { # Downloadable?
625 my $path_abs_disk=path_abs_disk $in,%args;
626 cluck "File not readable: $path_abs_disk" if !-r $path_abs_disk;
627 $r.=' ('.size_display((stat($path_abs_disk))[7]).')';
632 sub a_href_inhibit($$;@)
634 my($self,$sub,@sub_args)=@_;
636 local $a_href_inhibited=1;
637 return &{$sub}(@sub_args);
640 sub input_hidden_persistents()
645 my $val=$W->{"args"}{$key};
646 (!defined $val ? () : '<input type="hidden"'
647 .' name="'.escapeHTML($key).'"'
648 .' value="'.escapeHTML($val).'"'
650 } (keys(%{$W->{"args_persistent"}}))));
655 my($self,$url,$status)=@_;
657 $url=path_web($url,"abs"=>1);
658 $status||=HTTP_MOVED_TEMPORARILY;
659 $W->{"r"}->status($status);
660 $W->{"r"}->headers_out()->{"Location"}=$url;
661 $W->{"header_only"}=1;
669 # Do not: PerlModule Apache2::ForwardedFor
670 # PerlPostReadRequestHandler Apache2::ForwardedFor
671 # As 'Apache2::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
672 # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
673 # We must take the last item ourselves.
674 my $r=$W->{"headers_in"}{"X-Forwarded-For"} || $W->{"headers_in"}{"_get_remote_host"};
681 return 0 if !$have_Geo_IP;
682 return "CZ" eq Geo::IP->new()->country_code_by_addr(remote_ip());
687 my($url,$contents,%args)=@_;
689 return a_href $url,$contents,%args if is_cz();
697 # FIXME: &alarm, --timeout is now infinite.
698 # FIXME: Try to remove bash(1).
699 # FIXME: Use: @PATH_FLOCK@
700 my @argv=('flock',dir_top_abs_disk(),'bash','-c',$cmd.' >&2');
701 print STDERR join(" ","SPAWN:",@argv)."\n";
709 cluck "Pathname not absolute: $file" if $file!~m{^/};
711 # TODO: Somehow quickly check dependencies?
712 return make('make -s --no-print-directory'
713 .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'");
718 my($width,$height)=@_;
720 cluck if !defined $width || !defined $height;
721 return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
722 ." width=\"$width\" height=\"$height\"";
725 sub negotiate_variant (%)
729 my @fields=("id","qs","content-type","encoding","charset","lang","size");
730 return [ map(($args{$_}),@fields) ];
733 # Input: $self is required!
734 # Input: Put the fallback variant as the first one.
735 # Returns: always only scalar!
736 sub Negotiate_choose($$)
738 my($self,$variants)=@_;
740 # Limit these entries to generate proper 'Vary' header.
741 my %hash=(map(($_=>$W->{"headers_in"}{$_}),qw(
747 my $best=HTTP::Negotiate::choose($variants,
749 # to prevent: Can't locate object method "scan" via package "Apache2::RequestRec" at HTTP/Negotiate.pm line 84.
750 # Do not: $W->{"r"}->headers_in()
751 # to prevent: Can't locate object method "scan" via package "APR::Table" at HTTP/Negotiate.pm line 84.
752 # Do not: HTTP::Headers->new($W->{"r"}->headers_in());
753 # to prevent empty result or even: Odd number of elements in anonymous hash
754 HTTP::Headers->new(%hash));
755 $best||=$variants->[0][0]; # $variants->[0]{"id"}; &HTTP::Negotiate::choose failed?
760 { "id"=>"png","qs"=>0.9,"content-type"=>"image/png" },
761 { "id"=>"gif","qs"=>0.7,"content-type"=>"image/gif" },
763 my $img_variants_re='[.](?:'.join('|',"jpeg",map(($_->{"id"}),@img_variants)).')$';
765 # Returns: ($path_web,$path_abs_disk)
766 # URI path segments support ignored here. Where it is used? (';' path segment options)
771 cluck if !uri_is_local $in;
772 my $uri=in_to_uri_abs $in;
773 my $path_abs_disk=path_abs_disk $uri,%args,"uri_as_in"=>1,"register"=>0;
775 # Known image extension?
776 return path_web($uri,%args,"uri_as_in"=>1),$path_abs_disk if $uri->path()=~m#$img_variants_re#o;
779 for my $var (@img_variants) {
780 my $path_abs_disk_variant=$path_abs_disk.".".$var->{"id"};
781 path_abs_disk_register($path_abs_disk_variant);
782 __PACKAGE__->make_file($path_abs_disk_variant);
783 push @nego_variants,negotiate_variant(
785 "size"=>(stat $path_abs_disk_variant)[7],
788 my $ext=__PACKAGE__->Negotiate_choose(\@nego_variants);
790 $uri->path($uri->path().".$ext");
791 return path_web($uri,%args,"uri_as_in"=>1),path_abs_disk($uri,%args,"uri_as_in"=>1);
797 my($in,$alt,%args)=@_;
800 my($path_web,$path_abs_disk)=_img_src($in,%args);
801 my($width,$height)=Image::Size::imgsize($path_abs_disk);
803 $alt=escapeHTML($alt);
804 my $content="<img src=\"".uri_escaped($path_web)."\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
805 .(!$args{"attr"} ? "" : " ".$args{"attr"})." />";
806 do { return a_href((_img_src($_))[0],$content,"uri_as_in"=>1) if $_; } for $args{"a_href_img"};
807 do { return a_href $_,$content if $_; } for $args{"a_href"};
814 $r.='<table border="0" width="100%"><tr>'."\n";
815 @_=( [@_] ) if !ref $_[0];
817 $r.="\t".'<td align="center">'.&{\&img}(@$_).'</td>'."\n";
819 $r.='</tr></table>'."\n";
825 my($text,@args_img)=@_;
827 # FIXME: Workaround bug of 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)':
828 # <col width="@{[ (!$W->{"browser"}->ie() ? "1*" : "90%" ) ]}" />
829 # <col width="@{[ (!$W->{"browser"}->ie() ? "0*" : "10%" ) ]}" />
830 # causes whole invisible projects in: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.7.10) Gecko/20050719 Galeon/1.3.21
832 <table border="0" width="100%">
838 @{[ &{\&img}(@args_img) ]}
847 my($class,$filename)=@_;
850 open F,$filename or cluck "Cannot open \"$filename\": $!";
851 my $F=do { local $/=undef(); <F>; };
852 close F or cluck "Cannot close \"$filename\": $!";
860 header("Expires"=>HTTP::Date::time2str(1000000000)); # date in the past
861 header("Last-Modified"=>HTTP::Date::time2str()); # always modified
862 header("Cache-Control"=>join(", ",
867 "pre-check=0", # MSIE
868 "post-check=0", # MSIE
870 header("Pragma"=>"no-cache"); # HTTP/1.0
871 header("Vary"=>"*"); # content may ba based on unpredictable sources
874 sub headers_in_filtered(@)
878 return map(($_=>$W->{"headers_in"}{$_}),@keys);
881 our %uri_args_frozen_to_headers_in_keys;
882 our %uri_args_headers_in_frozen_to_headers_out;
884 sub uri_args_headers_in_frozen_get($)
886 my($headers_in_keys_arrayref)=@_;
888 my %uri_args_headers_in_hash=(
889 "uri_args_frozen"=>$W->{"uri_args_frozen"},
890 "headers_in"=>{ headers_in_filtered(@$headers_in_keys_arrayref) },
892 return do { local $Storable::canonical=1; Storable::freeze(\%uri_args_headers_in_hash); };
895 sub cache_output_filter($)
899 while ($f->read(my $text,0x400)) {
900 cluck "utf-8 untested" if Encode::is_utf8($text); # Possible here at all?
902 $W->{"digest-md5"}->add($text);
909 if (!$W->{"http_safe"}) {
910 __PACKAGE__->_no_cache();
915 # &Wrequire it here even if it will not be later used; to be stable!
916 Wrequire 'My::Hash::RestrictTo';
918 "uri"=>"http://".$W->{"web_hostname"}."/".$W->{"r"}->uri(),
919 "args"=>$W->{"args_orig_array"},
921 $W->{"uri_args_frozen"}=do { local $Storable::canonical=1; Storable::freeze(\%uri_args_hash); };
922 last if !(my $headers_in_keys_arrayref=$uri_args_frozen_to_headers_in_keys{$W->{"uri_args_frozen"}});
924 # Protection to be sure we are stable:
925 $W->{"headers_in"}=My::Hash::RestrictTo->new($W->{"headers_in"},@$headers_in_keys_arrayref);
927 $W->{"uri_args_headers_in_frozen"}=uri_args_headers_in_frozen_get($headers_in_keys_arrayref);
928 last if !(my $headers_out_hashref=$uri_args_headers_in_frozen_to_headers_out{$W->{"uri_args_headers_in_frozen"}});
929 header(%$headers_out_hashref);
932 # &meets_conditions will always deny the attempt if !2xx status().
933 # At least ap_read_request() sets: r->status=HTTP_REQUEST_TIME_OUT; /* Until we get a request */
934 my $status_old=$W->{"r"}->status();
935 $W->{"r"}->status(HTTP_OK);
936 # Update httpd's 'r->mtime' as the header "Last-Modified" is just not enough for ap_meets_conditions():
937 # &update_mtime() argument is really in _secs_, not in _msecs_ as the docs claim.
938 # Be aware '*1000000' would overflow Perl integer anyway.
939 # &set_last_modified would also override the "Last-Modified" headers_out!
940 # &mtime may exist but somehow does not work.
941 $W->{"r"}->update_mtime(HTTP::Date::str2time($headers_out_hashref->{"Last-Modified"}));
942 $status=$W->{"r"}->meets_conditions();
943 $W->{"r"}->status($status_old);
946 $W->{"r"}->status($status);
951 $W->{"digest-md5"}=Digest::MD5->new();
952 $W->{"cache_active"}=1;
953 $W->{"r"}->add_output_filter(\&cache_output_filter);
956 sub cache_finish_last_modified()
958 cluck "Not yet done now? W __PACKAGE__: ".$W->{"__PACKAGE__"}
959 if !$packages_used_hash{$W->{"__PACKAGE__"}}{"_done"};
960 for my $package_orig (@{$packages_used_array{$W->{"__PACKAGE__"}}}) {
961 local $_=$package_orig.".pm";
963 path_abs_disk "/$_","register"=>1;
966 for my $path_abs_disk (keys(%{$W->{"path_abs_disk_register"}})) {
967 my $mtime=(stat $path_abs_disk)[9];
968 do { cluck "No mtime for: $path_abs_disk"; next; } if !$mtime;
969 $mtime_newest=$mtime if !$mtime_newest || $mtime_newest<$mtime;
971 cluck "No mtime_newest found for the current W __PACKAGE__: ".$W->{"__PACKAGE__"}
973 return HTTP::Date::time2str($mtime_newest);
979 # Do not: return if !$W->{"uri_args_frozen"};
980 # as we may have just gave 304 and 'exit 0;' without starting the caching.
981 return if !$W->{"cache_active"};
983 # Fill-in/check: %uri_args_frozen_to_headers_in_keys
984 my $headers_in_keys_stored_arrayref_ref=\$uri_args_frozen_to_headers_in_keys{$W->{"uri_args_frozen"}};
985 my @headers_in_keys=tied(%{$W->{"headers_in_RecordKeys"}})->accessed();
986 if (!$$headers_in_keys_stored_arrayref_ref
987 || !Data::Compare::Compare(\@headers_in_keys,$$headers_in_keys_stored_arrayref_ref)) {
988 cluck "Non-matching generated 'headers_in_keys' per 'uri_args_frozen' key:\n"
989 .Dumper(\@headers_in_keys,$$headers_in_keys_stored_arrayref_ref)
990 if $$headers_in_keys_stored_arrayref_ref;
991 # Build or possibly prevent such further warn dupes:
992 $$headers_in_keys_stored_arrayref_ref=\@headers_in_keys;
993 # Build or regenerate as obsoleted now:
994 $W->{"uri_args_headers_in_frozen"}=uri_args_headers_in_frozen_get(\@headers_in_keys);
997 # Prepare 'headers_out' for the future reusal:
999 $headers_out{"Content-MD5"}=$W->{"digest-md5"}->b64digest();
1000 # In fact we could also use MD5 for ETag as if we know ETag we also know MD5.
1001 # But this way we do not need to calculate MD5 and we still can provide such ETag. So.
1002 # $W->{"r"}->set_etag() ?
1003 $headers_out{"ETag"}='"'.Digest::MD5::md5_base64($W->{"uri_args_headers_in_frozen"}).'"';
1004 # $W->{"r"}->set_content_length() ?
1005 $headers_out{"Content-Length"}=$W->{"r"}->bytes_sent();
1006 my %Vary=map(($_=>1),(@headers_in_keys));
1012 %Vary=("*"=>1) if $Vary{"*"};
1013 $headers_out{"Vary"}=join(", ",sort keys(%Vary));
1014 # $W->{"r"}->set_last_modified() ?
1015 $headers_out{"Last-Modified"}=cache_finish_last_modified();
1017 # Fill-in/check: %uri_args_headers_in_frozen_to_headers_out
1018 my $headers_out_stored_hashref_ref=\$uri_args_headers_in_frozen_to_headers_out{$W->{"uri_args_headers_in_frozen"}};
1019 if (!$$headers_out_stored_hashref_ref
1020 || !Data::Compare::Compare(\%headers_out,$$headers_out_stored_hashref_ref)) {
1021 cluck "Non-matching generated 'headers_out' per 'uri_args_headers_in_frozen' key:\n"
1022 .Dumper(\%headers_out,$$headers_out_stored_hashref_ref)
1023 if $$headers_out_stored_hashref_ref;
1024 # Build or possibly prevent such further warn dupes:
1025 $$headers_out_stored_hashref_ref=\%headers_out;
1028 ###print STDERR Dumper(\%uri_args_frozen_to_headers_in_keys,\%uri_args_headers_in_frozen_to_headers_out);
1035 if (!$W->{"header_only"}) {
1036 header("Content-Style-Type"=>"text/css");
1037 header("Content-Script-Type"=>"text/javascript");
1038 # $W->{"r"}->content_languages() ?
1039 do { header("Content-Language"=>$_) if $_; } for $W->{"language"};
1041 # TODO: Support also: private
1042 header("Cache-Control"=>"public"); # HTTP/1.1
1044 # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
1045 my $client_charset=$W->{"force_charset"} || "us-ascii";
1048 # https://bugzilla.mozilla.org/show_bug.cgi?id=120556
1050 # Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
1052 # http://validator.w3.org/ does not send ANY "Accept" headers!
1053 $mime||="application/xhtml+xml" if 1
1054 && !$W->{"headers_in"}{"Accept"}
1055 && ($W->{"headers_in"}{"User-Agent"}||"")=~m{^W3C_Validator/}i;
1056 $mime||=$class->Negotiate_choose([
1057 # Put the fallback variant as the first one.
1058 # Rate both variants the same to prefer "text/html" for undecided clients.
1060 # Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
1061 # prefers "application/xhtml+xml" over "text/html" itself:
1062 # text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
1065 "content-type"=>"text/html",
1067 "charset"=>$client_charset,
1068 "lang"=>$W->{"language"},
1071 "id"=>"application/xhtml+xml",
1072 "content-type"=>"application/xhtml+xml",
1074 "charset"=>$client_charset,
1075 "lang"=>$W->{"language"},
1080 # mod_perl doc: If you set this header via the headers_out table directly, it
1081 # will be ignored by Apache. So do not do that.
1082 $W->{"r"}->content_type("$mime; charset=$client_charset");
1085 return if $W->{"header_only"};
1086 # We still can append headers before we put out some text.
1087 # FIXME: It is not clean to still append them without overwriting.
1088 return if $W->{"heading_done"}++;
1090 Wprint '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n" if $mime=~m{^application/\w+[+]xml$};
1091 return if $W->{"xml_header_only"};
1092 Wprint '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
1093 Wprint '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="'.$W->{"language"}.'">'."\n";
1094 my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
1095 # Do not: cluck if $title=~/[<>]/;
1096 # as it is not solved just by: &a_href_inhibit
1097 # as sometimes titles use also: <i>...</i>
1098 $title=~s#<[^>]*>##g;
1100 Wprint "<title>$title</title>\n";
1101 if ($W->{"have_css"}) {
1102 # Everything can get overriden later.
1103 for my $css ("/My/Web.css",map((!$_ ? () : ("ARRAY" ne ref($_) ? $_ : @$_)),$W->{"css_push"})) {
1105 <link rel="stylesheet" type="text/css" href="@{[ uri_escaped(path_web $css) ]}" />
1108 if ($W->{"css_inherit"}) {
1110 <script type="text/javascript" src="@{[ uri_escaped(path_web('/My/css_inherit.js')) ]}" />
1114 Wprint '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
1115 Wprint $W->{"head"};
1116 for my $type (qw(prev next index contents start up)) {
1117 do { Wprint '<link rel="'.$type.'" href="'.uri_escaped(path_web $_).'" />'."\n" if $_; }
1118 for ($W->{"rel_$type"});
1120 Wprint "</head><body";
1121 # Wprint ' bgcolor="black" text="white" link="aqua" vlink="teal"'
1122 # if $W->{"browser"}->netscape() && (!$W->{"browser"}->major() || $W->{"browser"}->major()<=4);
1123 Wprint $W->{"body_attr"};
1126 do { Wprint $_ if $_; } for $W->{"heading"};
1130 delete $W->{"__My::Web_init"};