Permit explicit "http_safe=0" for GET/POST.
[MyWeb.git] / Web.pm
1 # $Id$
2 # Common functions for HTML/XHTML output generation
3 # Copyright (C) 2003-2005 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
4
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
8
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.
13
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
17
18
19 package My::Web;
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; };
22 our $CVS_ID=q$Id$;
23 use strict;
24 use warnings;
25
26 use Exporter;
27 sub Wrequire($);
28 sub Wuse($@);
29 our $W;
30 our @EXPORT=qw(
31                 &Wrequire &Wuse
32                 &path_web &path_abs_disk
33                 &uri_escaped
34                 &a_href &a_href_cc
35                 &vskip
36                 &img &centerimg &rightimg
37                 $W
38                 &input_hidden_persistents
39                 &escapeHTML
40                 );
41 our @ISA=qw(Tie::Handle Exporter);
42
43 my %packages_used_hash; # $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
44 my %packages_used_array;
45
46 BEGIN
47 {
48         use Carp qw(cluck confess);
49         $W->{"__My::Web_init"}=1;
50
51         sub Wrequire ($)
52         {
53         my($file)=@_;
54
55 #               print STDERR "Wrequire $file\n";
56                 $file=~s#/#::#g;
57                 $file=~s/[.]pm$//;
58                 my $class=$file;
59                 $file=~s#::#/#g;
60                 $file.=".pm";
61                 my %callers;
62                 for (my $depth=0;defined caller($depth);$depth++) {
63                         $callers{caller($depth)}=1;
64                         }
65                 my $selfpkg=__PACKAGE__;
66                 $callers{$selfpkg}=1;
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;
72                                 }
73                         }
74                 eval { CORE::require "$file"; } or confess $@;
75                 1;      # Otherwise 'require' would already file above.
76         }
77
78         sub Wuse ($@)
79         {
80         my($file,@list)=@_;
81
82 #               print STDERR "Wuse $file\n";
83                 Wrequire $file;
84                 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
85                 $file->import(@list);
86                 1;
87         }
88
89         sub import
90         {
91         my($class,@rest)=@_;
92
93                 local $Exporter::ExportLevel=$Exporter::ExportLevel+1;
94                 Wrequire("$class");
95                 return $class->SUPER::import(@rest);
96         }
97 }
98
99 use WebConfig;  # see also below: Wuse 'WebConfig';
100 require CGI;
101 require Image::Size;    # for &imgsize
102 use File::Basename;     # &basename
103 use Carp qw(cluck confess);
104 use URI::Escape;
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
110 # I do not know why.
111 use POSIX qw(strftime);
112 use Tie::Handle;
113 use Apache2::Const qw(HTTP_MOVED_TEMPORARILY OK HTTP_OK);
114 use URI;
115 use URI::QueryParam;
116 use Cwd;
117 require HTTP::Date;
118 require Storable;
119 require Digest::MD5;
120 require Data::Compare;
121 use Data::Dumper;
122 require Encode;
123 use Apache2::Filter;
124 use Apache2::Connection;
125
126
127 #our $W;
128
129 sub cleanup($)
130 {
131 my($apache_request)=@_;
132
133         $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
134         cache_finish();
135         # Sanity protection.
136         $W=undef();
137         return OK;
138 }
139
140 sub request_check(;$)
141 {
142 my($self)=@_;
143
144         # Use &eval to prevent: Global $r object is not available. Set:\n\tPerlOptions +GlobalRequest\nin ...
145         # CGI requires valid "r": check it beforehand here.
146         confess "Calling sensitive dynamic code from a static code" if !eval { Apache2::RequestUtil->request(); };
147         # Do not: confess "Calling sensitive dynamic code without My::Web::init" if !$W->{"__PACKAGE__"};
148         # as it is valid at least while preparing arguments to call: &project::Lib::init
149 }
150
151 sub init ($%)
152 {
153 my($class,%args)=@_;
154
155         print STDERR "$class->init ".Apache2::RequestUtil->request()->unparsed_uri()."\n";
156
157         # We need to track package dependencies, so we need to call it from &init.
158         # We cannot do it in BEGIN { } block
159         # as it would not be tracked for each of the toplevel users later.
160         Wuse 'WebConfig';
161         Wrequire 'My::Hash';
162
163         $W=My::Hash->new({
164                 "__PACKAGE__"=>scalar(caller()),
165                 %WebConfig,
166                 %args,  # override %WebConfig settings
167                 },"My::Hash::Sub","My::Hash::Push");
168
169         # {"__PACKAGE__"} is mandatory for mod_perl-2.0;
170         # $Apache2::Registry::curstash is no longer supported.
171         do { cluck "No $_" if !$W->{$_}; } for "__PACKAGE__";
172
173         # See: &escapeHTML
174         do { cluck "charset==$_, expecting ISO-8859-1" if $_ ne "ISO-8859-1"; } for CGI::charset();
175         CGI::charset("utf-8");
176
177         do { $W->{$_}=0  if !defined $W->{$_}; } for "detect_ent";
178         do { $W->{$_}=0  if !defined $W->{$_}; } for "detect_js";
179         do { $W->{$_}=1  if !defined $W->{$_}; } for "have_css";        # AFAIK it does not hurt anyone.
180         do { $W->{$_}=0  if !defined $W->{$_}; } for "css_inherit";
181         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer";
182         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer_delimit";
183         do { $W->{$_}=1  if !defined $W->{$_}; } for "footer_ids";
184         do { $W->{$_}=1  if !defined $W->{$_}; } for "indexme";
185         do { $W->{$_}="" if !defined $W->{$_}; } for "head";
186         do { $W->{$_}="" if !defined $W->{$_}; } for "body_attr";
187         do { $W->{$_}="en-US" if !defined $W->{$_}; } for "language";
188
189         my $footer_any=0;
190         for (qw(footer_ids)) {
191                 $W->{$_}=0 if !$W->{"footer"};
192                 $footer_any=1 if $W->{$_};
193                 }
194         $W->{"footer"}=0 if !$footer_any;
195         $W->{"footer_delimit"}=0 if !$W->{"footer"};
196
197         $W->{"r"}=Apache2::RequestUtil->request();
198
199         $W->{"r"}->push_handlers("PerlCleanupHandler"=>\&cleanup);
200
201         $W->{"web_hostname"}||=$W->{"r"}->hostname();
202
203         tie *STDOUT,$W->{"r"};
204         select *STDOUT;
205         $|=1;
206
207         $W->{"QUERY_STRING"}=$W->{"r"}->args() || "";
208         if ($W->{"detect_ent"}) {
209                          if ($W->{"QUERY_STRING"}=~/[&]amp;have_ent/)
210                         { $W->{"have_ent"}=0; }
211                 elsif ($W->{"QUERY_STRING"}=~    /[&]have_ent/)
212                         { $W->{"have_ent"}=1; }
213                 else
214                         { delete $W->{"have_ent"}; }
215                 if (!defined $W->{"have_ent"} && $W->{"r"}->method() eq "GET") {
216                         $W->{"head"}.='<meta http-equiv="Refresh" content="0; URL='
217                                         .escapeHTML("http://".$W->{"web_hostname"}."/".($W->{"r"}->uri()=~m#^/*(.*)$#)[0]
218                                                         ."?".($W->{"QUERY_STRING"} || "detect_ent_glue=1").'&have_ent=detect')
219                                         .'" />'."\n";
220                         }
221                 }
222         $W->{"QUERY_STRING"}=~s/([&])amp;/$1/g;
223         $W->{"r"}->args($W->{"QUERY_STRING"});
224         # Workaround: &CGI::Vars behaves weird if strings passed both as POST data and in: $QUERY_STRING
225         do { $W->{"r"}->args(""); delete $ENV{"QUERY_STRING"}; } if $W->{"r"}->method() eq "POST";
226         # Do not: $W->{"r"}->args()
227         # as it parses only QUERY_STRING (not POST data).
228         $W->{"args_orig_array"}=[ CGI->new($W->{"r"})->Vars() ];
229         $W->{"args"}={ @{$W->{"args_orig_array"}} };
230         for my $name (keys(%{$W->{"args"}})) {
231                 my @vals=split /\x00/,$W->{"args"}{$name};
232                 next if @vals<=1;
233                 $W->{"args"}{$name}=[@vals];
234                 }
235
236         $W->{"headers_in"}=$W->{"r"}->headers_in();
237         Wrequire 'My::Hash::Merge';
238         $W->{"headers_in"}=My::Hash::Merge->new(
239                         $W->{"headers_in"},
240                         My::Hash::Sub->new({
241                                 "_remote_ip"=>sub { return $W->{"r"}->connection()->remote_ip(); },
242                                 }),
243                         );
244         $W->{"headers_in"}=My::Hash::Readonly->new($W->{"headers_in"});
245         
246         if ($W->{"r"}->method() eq "GET" || $W->{"r"}->method() eq "HEAD") {
247                 for (\$W->{"http_safe"}) {
248                         # Do not: # Extend the current ETag system instead if you would need it:
249                         #         cluck "Explicitely NOT HTTP-Safe for method \"".$W->{"r"}->method()."\"?!?"
250                         #                       if defined($$_) && !$$_;
251                         # as sometimes it just does not make sense to cache it.
252                         $$_=1 if !defined $$_;
253                         }
254                 }
255         else {
256                 for (\$W->{"http_safe"}) {
257                         cluck "Undefined HTTP-Safe-ty for method \"".$W->{"r"}->method()."\"!"
258                                         if !defined($$_);
259                         $$_=0 if !defined $$_;
260                         }
261                 }
262         if ($W->{"http_safe"}) {
263                 Wrequire 'My::Hash::RecordKeys';
264                 $W->{"headers_in_RecordKeys"}=My::Hash::RecordKeys->new($W->{"headers_in"});
265                 $W->{"headers_in"}=$W->{"headers_in_RecordKeys"};
266                 }
267
268         $W->{"browser"}=HTTP::BrowserDetect->new($W->{"headers_in"}{"User-Agent"});
269
270         if (!defined $W->{"have_style"}) {
271                 $W->{"have_style"}=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
272                 }
273
274         $W->{"have_js"}=($W->{"args"}{"have_js"} ? 1 : 0);
275         if ($W->{"detect_js"} && !$W->{"have_js"}) {
276                 $W->{"head"}.='<script type="text/javascript" src="'.uri_escaped(path_web('/My/HaveJS.pm')).'"></script>'."\n";
277                 }
278
279         do { _args_check(%$_) if $_; } for ($W->{"args_check"});
280
281         return bless $W,$class;
282 }
283
284 # Be aware other parts of code (non-My::Web) will NOT use this function!
285 # Do not: Wprint $W->{"heading"},"undef"=>1;
286 # as we would need to undef() it to turn it off and it would get defaulted in such case.
287 # Do not: exists $W->{"heading"}
288 # as we use a lot of 'for $W->{"heading"}' which instantiates it with the value: undef()
289 sub Wprint($%)
290 {
291 my($text,%args)=@_;
292
293         cluck "undef Wprint" if !defined $text && !$args{"undef"};
294         delete $args{"undef"};
295         cluck join(" ","Invalid arguments:",keys(%args)) if keys(%args);
296         return if !defined $text;
297         cluck "utf-8 untested" if Encode::is_utf8($text);
298         $W->{"r"}->puts($text);
299 }
300
301 sub escapeHTML($)
302 {
303 my($text)=@_;
304
305         # Prevent &CGI::escapeHTML breaking utf-8 strings like: \xC4\x9B eq \x{11B}
306         # Prevent case if we run under mod_perl but still just initializing:
307         request_check() if $ENV{"MOD_PERL"};
308         # Generally we are initialized from &init but we may be used without it without mod_perl
309         # and in such case check the change on all non-first invocations.
310         our $init;
311         if (!$ENV{"MOD_PERL"} && $init++) {
312                 do { cluck "charset==$_" if $_ ne "utf-8"; } for CGI::charset();
313                 }
314         CGI::charset("utf-8");
315
316         return CGI::escapeHTML($text);
317 }
318
319 # /home/user/www/webdir
320 sub dir_top_abs_disk()
321 {
322         our $dir_top_abs_disk;
323         if (!$dir_top_abs_disk) {
324                 my $selfpkg_relpath=__PACKAGE__;
325                 $selfpkg_relpath=~s{::}{/}g;
326                 $selfpkg_relpath.=".pm";
327                 my $selfpkg_abspath=$INC{$selfpkg_relpath} or do {
328                         cluck "Unable to find self package $selfpkg_relpath";
329                         return;
330                         };
331                 $selfpkg_abspath=~s{/*\Q$selfpkg_relpath\E$}{} or do {
332                         cluck "Unable to strip myself \"$selfpkg_relpath\" from the abspath: $selfpkg_abspath";
333                         return;
334                         };
335                 cluck "INC{myself} is relative?: $selfpkg_abspath" if $selfpkg_abspath!~m{^/};
336                 $dir_top_abs_disk=$selfpkg_abspath;
337                 }
338         return $dir_top_abs_disk;
339 }
340
341 sub unparsed_uri()
342 {
343         request_check();
344         if (!$W->{"unparsed_uri"}) {
345                 # Do not: $W->{"r"}
346                 # as we may be called before &init from: &My::Project::init
347                 my $r=Apache2::RequestUtil->request();
348                 cluck "Calling ".'&unparsed_uri'." from a static code, going to fail" if !$r;
349                 my $uri_string=$r->unparsed_uri() or cluck "Valid 'r' missing unparsed_uri()?";
350                 my $uri=URI->new_abs($uri_string,"http://".$W->{"web_hostname"}."/");
351                 $W->{"unparsed_uri"}=$uri;
352                 }
353         return $W->{"unparsed_uri"};
354 }
355
356 sub in_to_uri_abs($)
357 {
358 my($in)=@_;
359
360         # Otherwise we may have been already processed and thus legally relativized.
361         # FIXME data: Currently disabled, all the data are too violating such rule.
362         if (0 && !ref $in) {
363                 my $uri_check=URI->new($in);
364                 $uri_check->scheme() || $in=~m{^\Q./\E} || $in=~m{^/}
365                                 or cluck "Use './' or '/' prefix for all the local references: $in";
366                 }
367         my $uri=URI->new_abs($in,unparsed_uri());
368         $uri=$uri->canonical();
369         return $uri;
370 }
371
372 # $args{"uri_as_in"}=1 to permit passing URI objects as: $in
373 # $args{"abs"}=1;
374 sub path_web($%)
375 {
376 my($in,%args)=@_;
377
378         cluck if !$args{"uri_as_in"} && ref $in;
379         my $uri=in_to_uri_abs($in);
380         if (uri_is_local($uri)) {
381                 # Prefer the $uri values over "args_persistent" values.
382                 $uri->query_form_hash({
383                                 map({
384                                         my $key=$_;
385                                         my $val=$W->{"args"}{$key};
386                                         (!defined $val ? () : ($key=>$val));
387                                         } keys(%{$W->{"args_persistent"}})),
388                                 %{$uri->query_form_hash()},
389                                 });
390                 }
391         return $uri->abs(unparsed_uri()) if $W->{"args"}{"Wabs"} || $args{"abs"};
392         return $uri->rel(unparsed_uri());
393 }
394
395 sub path_abs_disk_register($)
396 {
397 my($path_abs_disk)=@_;
398
399         $W->{"path_abs_disk_register"}{$path_abs_disk}=1;
400 }
401
402 # $args{"uri_as_in"}=1 to permit passing URI objects as: $in
403 sub path_abs_disk($%)
404 {
405 my($in,%args)=@_;
406
407         cluck if !$args{"uri_as_in"} && ref $in;
408         my $uri=in_to_uri_abs($in);
409         cluck if !uri_is_local($uri);
410         my $path=$uri->path();
411         cluck "URI compatibility: ->path() not w/leading slash of URI \"$uri\"; path: $path" if $path!~m{^/};
412         my $r=dir_top_abs_disk().$path;
413         path_abs_disk_register $r if !defined $args{"register"} || $args{"register"};
414         return $r;
415 }
416
417 sub fatal (;$);
418
419 sub _args_check (%)
420 {
421 my(%tmpl)=@_;
422
423         while (my($name,$regex)=each(%tmpl)) {
424                 my $name_html="Parameter <span class=\"quote\">".escapeHTML($name)."</span>";
425                 $W->{"args"}{$name}="" if !defined $W->{"args"}{$name};
426                 $W->{"args"}{$name}=[ $W->{"args"}{$name} ] if !ref $W->{"args"}{$name} && ref $regex;
427                 fatal "$name_html passed as multivar although singlevar expected"
428                                 if ref $W->{"args"}{$name} && !ref $regex;
429                 $regex=$regex->[0] if ref $regex;
430                 for my $val (!ref $W->{"args"}{$name} ? $W->{"args"}{$name} : @{$W->{"args"}{$name}}) {
431                         $val="" if !defined $val;
432                         fatal "$name_html <span class=\"quote\">".escapeHTML($val)."</span>"
433                                                         ." does not match the required regex <span class=\"quote\">".escapeHTML($regex)."</span> "
434                                         if $regex ne "" && $val!~/$regex/;
435                         }
436                 }
437 }
438
439 sub vskip (;$)
440 {
441 my($height)=@_;
442
443         return '<p'.(!defined $height ? "" : ' style="height: '.$height.';"').'>&nbsp;</p>'."\n";
444 }
445
446 sub fatal (;$)
447 {
448 my($msg)=@_;
449
450         $msg="UNKNOWN" if !$msg;
451         cluck "FATAL: $msg";
452
453         # Do not send it unconditionally.
454         # The intial duplicated '<?xml...' crashes Gecko parser.
455         $W->{"heading_done"}=0 if $W->{"header_only"};
456         # Do not send it unconditionally.
457         # Prevents warn: Headers already sent
458         if (!$W->{"heading_done"}) {
459                 $W->{"indexme"}=0;      # For the case no heading was sent yet.
460                 $W->{"header_only"}=0;  # assurance for &heading
461                 My::Web->heading();
462                 }
463         Wprint "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
464                         ."<p>You can report this problem's details to"
465                         ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
466         footer();
467 }
468
469 sub footer (;$)
470 {
471         exit 1 if $W->{"footer_passed"}++;      # deadlock prevention:
472
473         Wprint vskip if $W->{"footer_delimit"};
474
475         do { Wprint $_ if $_; } for $W->{"footing_delimit"};
476
477         Wprint "<hr />\n" if $W->{"footer"};
478
479         my $packages_used=$packages_used_array{$W->{"__PACKAGE__"}};
480
481         if ($W->{"footer_ids"}) {
482                 Wprint '<p class="cvs-id">';
483                 Wprint join("<br />\n",map({ my $package=$_;
484                         my $cvs_id=(eval('$'.$package."::CVS_ID")
485 #                                       || $package     # debug
486                                         );
487                         if (!$cvs_id) {
488                                 ();
489                                 }
490                         else {
491                                 $cvs_id='$'.$cvs_id.'$';        # Eaten by 'q' operator.
492                                 my @cvs_id_split=split / +/,$cvs_id;
493                                 if (@cvs_id_split==8) {
494                                         my $file=$package;
495                                         $file=~s#::#/#g;
496                                         my $ext;
497                                         my @tried;
498                                         for (qw(.pm)) {
499                                                 $ext=$_;
500                                                 my $path_abs_disk=path_abs_disk("/$file$ext");
501                                                 push @tried,$path_abs_disk;
502                                                 last if -r $path_abs_disk;
503                                                 cluck "Class file $file not found; tried: ".join(" ",@tried) if !$ext;
504                                                 }
505                                         $file.=$ext;
506                                         $cvs_id_split[2]=""
507                                                         .a_href((map({ my $s=$_; $s=~s#/viewcvs/#$&~checkout~/#; $s; } $W->{"viewcvs"}))[0]."$file?rev=".$cvs_id_split[2],
508                                                                         $cvs_id_split[2]);
509                                         $cvs_id_split[1]=a_href($W->{"viewcvs"}.$file,
510                                                         ($package!~/^Apache2::/ ? $package : $cvs_id_split[1]));
511                                         $cvs_id_split[5]=&{$W->{"cvs_id_author_sub"}}($cvs_id_split[5]);
512                                         }
513                                 join " ",@cvs_id_split;
514                                 }
515                         } @$packages_used));
516                 Wprint "</p>\n";
517                 }
518
519         for my $package (@$packages_used) {
520                 my $cvs_id=(eval('$'.$package."::CVS_ID")
521 #                               || $package     # debug
522                                 );
523                 Wprint '<!-- '.$package.' - $'.$cvs_id.'$ -->'."\n" if $cvs_id;
524                 }
525
526         do { Wprint $_ if $_; } for $W->{"footing"};
527
528         Wprint "</body></html>\n";
529         exit 0;
530 }
531
532 # Existing entries are overwritten.
533 sub header(%)
534 {
535 my(%pairs)=@_;
536
537         while (my($key,$val)=each(%pairs)) {
538                 do { cluck "Headers already sent"; next; } if $W->{"heading_done"};
539                 $W->{"r"}->headers_out()->set($key,$val);
540                 }
541 }
542
543 sub size_display ($)
544 {
545 my($size)=@_;
546
547            if ($size<4096)
548                 {}
549         elsif ($size<1024*1024)
550                 { $size=sprintf "%.1fK",$size/1024; }
551         else
552                 { $size=sprintf "%.1fM",$size/1024/1024; }
553         $size.="B";
554         return $size;
555 }
556
557 sub uri_is_local($)
558 {
559 my($in)=@_;
560
561         my $uri_rel=in_to_uri_abs($in)->rel(unparsed_uri());
562         # Do not: defined $uri_rel->("userinfo"|"host"|"port")();
563         # as they fail to be called for schemes not supporting them.
564         return 0 if $uri_rel->scheme();
565         return 0 if $uri_rel->authority();
566         return 1;
567 }
568
569 # &path_web still may be required for &uri_escaped !
570 sub uri_escaped($)
571 {
572 my($uri)=@_;
573
574         cluck if !ref $uri;
575         my $urient=escapeHTML($uri);
576         return $uri    if $uri eq $urient;
577         request_check();
578         return $urient if uri_is_local $uri;
579         return $uri    if defined $W->{"have_ent"} && !$W->{"have_ent"};        # non-ent client
580         return $urient if $W->{"have_ent"};     # ent client
581         # Unknown client, &escapeHTML should not be needed here:
582         return escapeHTML(path_web('/My/Redirect.pm?location='.uri_escape($uri->abs(unparsed_uri()))));
583 }
584
585 our $a_href_inhibited;
586 sub a_href($;$%)
587 {
588 my($in,$contents,%args)=@_;
589
590         request_check();
591         do { $$_=1 if !defined $$_; } for (\$args{"size"});
592         if (!defined $contents) {
593                 $contents=$in;
594                 $contents=File::Basename::basename($contents) if $args{"basename"};
595                 $contents=escapeHTML($contents);
596                 }
597         $contents=~s#<a\b[^>]*>##gi;
598         $contents=~s#</a>##gi;
599         return $contents if $a_href_inhibited;
600
601         my $path_web=path_web $in,%args;
602         my $r="";
603         $r.='<a href="';
604         $r.=uri_escaped $path_web;
605         $r.='"';
606         do { $r.=" $_" if $_; } for ($args{"attr"});
607         $r.='>'.$contents.'</a>';
608         if ($args{"size"} && uri_is_local($in) && ($args{"size"}>=2 || $in=~/[.](?:gz|Z|rpm|zip|deb|lha)/)) {   # Downloadable?
609                 my $path_abs_disk=path_abs_disk $in,%args;
610                 cluck "File not readable: $path_abs_disk" if !-r $path_abs_disk;
611                 $r.='&nbsp;('.size_display((stat($path_abs_disk))[7]).')';
612                 }
613         return $r;
614 }
615
616 sub a_href_inhibit($$;@)
617 {
618 my($self,$sub,@sub_args)=@_;
619
620         local $a_href_inhibited=1;
621         return &{$sub}(@sub_args);
622 }
623
624 sub input_hidden_persistents()
625 {
626         request_check();
627         return join("",map({
628                 my $key=$_;
629                 my $val=$W->{"args"}{$key};
630                 (!defined $val ? () : '<input type="hidden"'
631                                 .' name="'.escapeHTML($key).'"'
632                                 .' value="'.escapeHTML($val).'"'
633                                 .' />'."\n");
634                 } (keys(%{$W->{"args_persistent"}}))));
635 }
636
637 sub http_moved($$;$)
638 {
639 my($self,$url,$status)=@_;
640
641         $url=path_web($url,"abs"=>1);
642         $status||=HTTP_MOVED_TEMPORARILY;
643         $W->{"r"}->status($status);
644         $W->{"r"}->headers_out()->{"Location"}=$url;
645         $W->{"header_only"}=1;
646         My::Web->heading();
647         exit;
648         die "NOTREACHED";
649 }
650
651 sub remote_ip ()
652 {
653         # Do not: PerlModule                 Apache2::ForwardedFor
654         #         PerlPostReadRequestHandler Apache2::ForwardedFor
655         # As 'Apache2::ForwardedFor' takes the first of $ENV{"HTTP_X_FORWARDED_FOR"}
656         # while the contents is '127.0.0.1, 213.220.195.171' if client has its own proxy.
657         # We must take the last item ourselves.
658         # Be VERY sure you always retrieve all the headers unconditionally to hit: My::Hash::RecordKeys
659         my $x_forwarded_for=$W->{"headers_in"}{"X-Forwarded-For"};
660         $x_forwarded_for=~s/^.*,\s*// if $x_forwarded_for;
661         my $remote_ip=$W->{"headers_in"}{"_remote_ip"};
662         my $r;
663         $r||=$x_forwarded_for;
664         $r||=$remote_ip;
665         return $r;
666 }
667
668 # $url={"JP"=>"http://specific",...};
669 # $url={""=>"http://default",...};
670 sub a_href_cc($$;%)
671 {
672 my($url,$contents,%args)=@_;
673
674         # A bit ineffective but we must process all the possibilities to get stable 'headers_in' hits!
675         my %map=map(($_=>a_href($url->{$_},$contents,%args)),keys(%$url));
676         my $cc;
677         $cc||=Geo::IP->new()->country_code_by_addr(remote_ip()) if $have_Geo_IP;
678         $cc||="";
679         my $r=$map{$cc};
680         return $r if $r;
681         return $contents;
682 }
683
684 sub make ($)
685 {
686 my($cmd)=@_;
687
688         # FIXME: &alarm, --timeout is now infinite.
689         # FIXME: Try to remove bash(1).
690         # FIXME: Use: @PATH_FLOCK@
691         my @argv=('flock',dir_top_abs_disk(),'bash','-c',$cmd.' >&2');
692         print STDERR join(" ","SPAWN:",@argv)."\n";
693         system @argv;
694 }
695
696 sub make_file($$)
697 {
698 my($self,$file)=@_;
699
700         cluck "Pathname not absolute: $file" if $file!~m{^/};
701         return if -f $file;
702         # TODO: Somehow quickly check dependencies?
703         return make('make -s --no-print-directory'
704                                         .' -C '."'".File::Basename::dirname($file)."' '".File::Basename::basename($file)."'");
705 }
706
707 sub img_size ($$)
708 {
709 my($width,$height)=@_;
710
711         cluck if !defined $width || !defined $height;
712         return ($W->{"have_style"} ? "style=\"border:0;width:${width}px;height:${height}px\"" : "border=\"0\"")
713                         ." width=\"$width\" height=\"$height\"";
714 }
715
716 sub negotiate_variant (%)
717 {
718 my(%args)=@_;
719
720         my @fields=("id","qs","content-type","encoding","charset","lang","size");
721         return [ map(($args{$_}),@fields) ];
722 }
723
724 # Input: $self is required!
725 # Input: Put the fallback variant as the first one.
726 # Returns: always only scalar!
727 sub Negotiate_choose($$)
728 {
729 my($self,$variants)=@_;
730
731         # Limit these entries to generate proper 'Vary' header.
732         my %hash=(map(($_=>$W->{"headers_in"}{$_}),qw(
733                         Accept
734                         Accept-Charset
735                         Accept-Encoding
736                         Accept-Language
737                         )));
738         my $best=HTTP::Negotiate::choose($variants,
739                         # Do not: $W->{"r"}
740                         # to prevent: Can't locate object method "scan" via package "Apache2::RequestRec" at HTTP/Negotiate.pm line 84.
741                         # Do not: $W->{"r"}->headers_in()
742                         # to prevent: Can't locate object method "scan" via package "APR::Table" at HTTP/Negotiate.pm line 84.
743                         # Do not: HTTP::Headers->new($W->{"r"}->headers_in());
744                         # to prevent empty result or even: Odd number of elements in anonymous hash
745                         HTTP::Headers->new(%hash));
746         $best||=$variants->[0][0];      # $variants->[0]{"id"}; &HTTP::Negotiate::choose failed?
747         return $best;
748 }
749
750 my @img_variants=(
751                 { "id"=>"png","qs"=>0.9,"content-type"=>"image/png" },
752                 { "id"=>"gif","qs"=>0.7,"content-type"=>"image/gif" },
753                 );
754 my $img_variants_re='[.](?:'.join('|',"jpeg",map(($_->{"id"}),@img_variants)).')$';
755
756 # Returns: ($path_web,$path_abs_disk)
757 # URI path segments support ignored here. Where it is used? (';' path segment options)
758 sub _img_src($%)
759 {
760 my($in,%args)=@_;
761
762         cluck if !uri_is_local $in;
763         my $uri=in_to_uri_abs $in;
764         my $path_abs_disk=path_abs_disk $uri,%args,"uri_as_in"=>1,"register"=>0;
765
766         # Known image extension?
767         return path_web($uri,%args,"uri_as_in"=>1),$path_abs_disk if $uri->path()=~m#$img_variants_re#o;
768
769         my @nego_variants;
770         for my $var (@img_variants) {
771                 my $path_abs_disk_variant=$path_abs_disk.".".$var->{"id"};
772                 path_abs_disk_register($path_abs_disk_variant);
773                 __PACKAGE__->make_file($path_abs_disk_variant);
774                 push @nego_variants,negotiate_variant(
775                                 %$var,
776                                 "size"=>(stat $path_abs_disk_variant)[7],
777                                 );
778                 }
779         my $ext=__PACKAGE__->Negotiate_choose(\@nego_variants);
780
781         $uri->path($uri->path().".$ext");
782         return path_web($uri,%args,"uri_as_in"=>1),path_abs_disk($uri,%args,"uri_as_in"=>1);
783 }
784
785 # $args{"attr"}
786 sub img ($$%)
787 {
788 my($in,$alt,%args)=@_;
789
790         request_check();
791         my($path_web,$path_abs_disk)=_img_src($in,%args);
792         my($width,$height)=Image::Size::imgsize($path_abs_disk);
793         $alt=~s/<[^>]*>//g;
794         $alt=escapeHTML($alt);
795         my $content="<img src=\"".uri_escaped($path_web)."\" alt=\"$alt\" title=\"$alt\" ".img_size($width,$height)
796                         .(!$args{"attr"} ? "" : " ".$args{"attr"})." />";
797         do { return a_href((_img_src($_))[0],$content,"uri_as_in"=>1) if $_; } for $args{"a_href_img"};
798         do { return a_href $_,$content if $_; } for $args{"a_href"};
799         return $content;
800 }
801
802 sub centerimg
803 {
804         my $r="";
805         $r.='<table border="0" width="100%"><tr>'."\n";
806         @_=( [@_] ) if !ref $_[0];
807         for (@_) {
808                 $r.="\t".'<td align="center">'.&{\&img}(@$_).'</td>'."\n";
809                 }
810         $r.='</tr></table>'."\n";
811         return $r;
812 }
813
814 sub rightimg
815 {
816 my($text,@args_img)=@_;
817
818         # FIXME: Workaround bug of 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)':
819         #        <col width="@{[ (!$W->{"browser"}->ie() ? "1*" : "90%" ) ]}" />
820         #        <col width="@{[ (!$W->{"browser"}->ie() ? "0*" : "10%" ) ]}" />
821         # causes whole invisible projects in: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.7.10) Gecko/20050719 Galeon/1.3.21
822         return <<"HERE";
823 <table border="0" width="100%">
824         <tr>
825                 <td align="left">
826                         @{[ $text ]}
827                 </td>
828                 <td align="right">
829                         @{[ &{\&img}(@args_img) ]}
830                 </td>
831         </tr>
832 </table>
833 HERE
834 }
835
836 sub readfile($$)
837 {
838 my($class,$filename)=@_;
839
840         local *F;
841         open F,$filename or cluck "Cannot open \"$filename\": $!";
842         my $F=do { local $/=undef(); <F>; };
843         close F or cluck "Cannot close \"$filename\": $!";
844         return $F;
845 }
846
847 sub _no_cache($)
848 {
849 my($self)=@_;
850
851         header("Expires"=>HTTP::Date::time2str(1000000000));    # date in the past
852         header("Last-Modified"=>HTTP::Date::time2str());        # always modified
853         header("Cache-Control"=>join(", ",
854                         "no-cache",
855                         "no-store",
856                         "must-revalidate",
857                         "max-age=0",
858                         "pre-check=0",  # MSIE
859                         "post-check=0", # MSIE
860                         ));     # HTTP/1.1
861         header("Pragma"=>"no-cache");   # HTTP/1.0
862         header("Vary"=>"*");    # content may ba based on unpredictable sources
863 }
864
865 sub headers_in_filtered(@)
866 {
867 my(@keys)=@_;
868
869         return map(($_=>$W->{"headers_in"}{$_}),@keys);
870 }
871
872 our %uri_args_frozen_to_headers_in_keys;
873 our %uri_args_headers_in_frozen_to_headers_out;
874
875 sub uri_args_headers_in_frozen_get($)
876 {
877 my($headers_in_keys_arrayref)=@_;
878
879         my %uri_args_headers_in_hash=(
880                 "uri_args_frozen"=>$W->{"uri_args_frozen"},
881                 "headers_in"=>{ headers_in_filtered(@$headers_in_keys_arrayref) },
882                 );
883         return do { local $Storable::canonical=1; Storable::freeze(\%uri_args_headers_in_hash); };
884 }
885
886 sub cache_output_filter($)
887 {
888 my($f)=@_;
889
890         while ($f->read(my $text,0x400)) {
891                 cluck "utf-8 untested" if Encode::is_utf8($text);       # Possible here at all?
892                 $f->print($text);
893                 $W->{"digest-md5"}->add($text);
894                 }
895         return OK;
896 }
897
898 sub cache_start()
899 {
900         if (!$W->{"http_safe"}) {
901                 __PACKAGE__->_no_cache();
902                 return;
903                 }
904
905         {
906                 # &Wrequire it here even if it will not be later used; to be stable!
907                 Wrequire 'My::Hash::RestrictTo';
908                 my %uri_args_hash=(
909                         "uri"=>"http://".$W->{"web_hostname"}."/".$W->{"r"}->uri(),
910                         "args"=>$W->{"args_orig_array"},
911                         );
912                 $W->{"uri_args_frozen"}=do { local $Storable::canonical=1; Storable::freeze(\%uri_args_hash); };
913                 last if !(my $headers_in_keys_arrayref=$uri_args_frozen_to_headers_in_keys{$W->{"uri_args_frozen"}});
914
915                 # Protection to be sure we are stable:
916                 $W->{"headers_in"}=My::Hash::RestrictTo->new($W->{"headers_in"},@$headers_in_keys_arrayref);
917
918                 $W->{"uri_args_headers_in_frozen"}=uri_args_headers_in_frozen_get($headers_in_keys_arrayref);
919                 last if !(my $headers_out_hashref=$uri_args_headers_in_frozen_to_headers_out{$W->{"uri_args_headers_in_frozen"}});
920                 header(%$headers_out_hashref);
921                 my $status;
922                 {
923                         # &meets_conditions will always deny the attempt if !2xx status().
924                         # At least ap_read_request() sets: r->status=HTTP_REQUEST_TIME_OUT;     /* Until we get a request */
925                         my $status_old=$W->{"r"}->status();
926                         $W->{"r"}->status(HTTP_OK);
927                         # Update httpd's 'r->mtime' as the header "Last-Modified" is just not enough for ap_meets_conditions():
928                         # &update_mtime() argument is really in _secs_, not in _msecs_ as the docs claim.
929                         # Be aware '*1000000' would overflow Perl integer anyway.
930                         # &set_last_modified would also override the "Last-Modified" headers_out!
931                         # &mtime may exist but somehow does not work.
932                         $W->{"r"}->update_mtime(HTTP::Date::str2time($headers_out_hashref->{"Last-Modified"}));
933                         $status=$W->{"r"}->meets_conditions();
934                         $W->{"r"}->status($status_old);
935                         }
936                 last if OK==$status;
937                 $W->{"r"}->status($status);
938                 exit 0;
939                 die "NOTREACHED";
940                 }
941
942         $W->{"digest-md5"}=Digest::MD5->new();
943         $W->{"cache_active"}=1;
944         $W->{"r"}->add_output_filter(\&cache_output_filter);
945 }
946
947 sub cache_finish_last_modified()
948 {
949         cluck "Not yet done now? W __PACKAGE__: ".$W->{"__PACKAGE__"}
950                         if !$packages_used_hash{$W->{"__PACKAGE__"}}{"_done"};
951         for my $package_orig (@{$packages_used_array{$W->{"__PACKAGE__"}}}) {
952                 local $_=$package_orig.".pm";
953                 s{::}{/}g;
954                 path_abs_disk "/$_","register"=>1;
955                 }
956         my $mtime_newest;
957         for my $path_abs_disk (keys(%{$W->{"path_abs_disk_register"}})) {
958                 my $mtime=(stat $path_abs_disk)[9];
959                 do { cluck "No mtime for: $path_abs_disk"; next; } if !$mtime;
960                 $mtime_newest=$mtime if !$mtime_newest || $mtime_newest<$mtime;
961                 }
962         cluck "No mtime_newest found for the current W __PACKAGE__: ".$W->{"__PACKAGE__"}
963                         if !$mtime_newest;
964         return HTTP::Date::time2str($mtime_newest);
965 }
966
967
968 sub cache_finish()
969 {
970         # Do not: return if !$W->{"uri_args_frozen"};
971         # as we may have just gave 304 and 'exit 0;' without starting the caching.
972         return if !$W->{"cache_active"};
973
974         # Fill-in/check: %uri_args_frozen_to_headers_in_keys
975         my $headers_in_keys_stored_arrayref_ref=\$uri_args_frozen_to_headers_in_keys{$W->{"uri_args_frozen"}};
976         my @headers_in_keys=tied(%{$W->{"headers_in_RecordKeys"}})->accessed();
977         if (!$$headers_in_keys_stored_arrayref_ref
978                         || !Data::Compare::Compare(\@headers_in_keys,$$headers_in_keys_stored_arrayref_ref)) {
979                 cluck "Non-matching generated 'headers_in_keys' per 'uri_args_frozen' key:\n"
980                                                 .Dumper(\@headers_in_keys,$$headers_in_keys_stored_arrayref_ref)
981                                 if $$headers_in_keys_stored_arrayref_ref;
982                 # Build or possibly prevent such further warn dupes:
983                 $$headers_in_keys_stored_arrayref_ref=\@headers_in_keys;
984                 # Build or regenerate as obsoleted now:
985                 $W->{"uri_args_headers_in_frozen"}=uri_args_headers_in_frozen_get(\@headers_in_keys);
986                 }
987
988         # Prepare 'headers_out' for the future reusal:
989         my %headers_out;
990         $headers_out{"Content-MD5"}=$W->{"digest-md5"}->b64digest();
991         # In fact we could also use MD5 for ETag as if we know ETag we also know MD5.
992         # But this way we do not need to calculate MD5 and we still can provide such ETag. So.
993         # $W->{"r"}->set_etag() ?
994         $headers_out{"ETag"}='"'.Digest::MD5::md5_base64($W->{"uri_args_headers_in_frozen"}).'"';
995         # $W->{"r"}->set_content_length() ?
996         $headers_out{"Content-Length"}=$W->{"r"}->bytes_sent();
997         my %Vary=map(($_=>1),(@headers_in_keys));
998         for (keys(%Vary)) {
999                 next if !/^_/;
1000                 $Vary{"*"}=1;
1001                 delete $Vary{$_};
1002                 }
1003         %Vary=("*"=>1) if $Vary{"*"};
1004         $headers_out{"Vary"}=join(", ",sort keys(%Vary));
1005         # $W->{"r"}->set_last_modified() ?
1006         $headers_out{"Last-Modified"}=cache_finish_last_modified();
1007
1008         # Fill-in/check: %uri_args_headers_in_frozen_to_headers_out
1009         my $headers_out_stored_hashref_ref=\$uri_args_headers_in_frozen_to_headers_out{$W->{"uri_args_headers_in_frozen"}};
1010         if (!$$headers_out_stored_hashref_ref
1011                         || !Data::Compare::Compare(\%headers_out,$$headers_out_stored_hashref_ref)) {
1012                 cluck "Non-matching generated 'headers_out' per 'uri_args_headers_in_frozen' key:\n"
1013                                                 .Dumper(\%headers_out,$$headers_out_stored_hashref_ref)
1014                                 if $$headers_out_stored_hashref_ref;
1015                 # Build or possibly prevent such further warn dupes:
1016                 $$headers_out_stored_hashref_ref=\%headers_out;
1017                 }
1018
1019 ###print STDERR Dumper(\%uri_args_frozen_to_headers_in_keys,\%uri_args_headers_in_frozen_to_headers_out);
1020 }
1021
1022 sub heading()
1023 {
1024 my($class)=@_;
1025
1026         if (!$W->{"header_only"}) {
1027                 header("Content-Style-Type"=>"text/css");
1028                 header("Content-Script-Type"=>"text/javascript");
1029                 # $W->{"r"}->content_languages() ?
1030                 do { header("Content-Language"=>$_) if $_; } for $W->{"language"};
1031                 }
1032         # TODO: Support also: private
1033         header("Cache-Control"=>"public");      # HTTP/1.1
1034
1035         # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
1036         my $client_charset=$W->{"force_charset"} || "us-ascii";
1037
1038         # Workaround bug
1039         #   https://bugzilla.mozilla.org/show_bug.cgi?id=120556
1040         # of at least
1041         #   Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
1042         my $mime;
1043         # http://validator.w3.org/ does not send ANY "Accept" headers!
1044         $mime||="application/xhtml+xml" if 1
1045                         && !$W->{"headers_in"}{"Accept"}
1046                         && ($W->{"headers_in"}{"User-Agent"}||"")=~m{^W3C_Validator/}i;
1047         $mime||=$class->Negotiate_choose([
1048                         # Put the fallback variant as the first one.
1049                         # Rate both variants the same to prefer "text/html" for undecided clients.
1050                         # At least
1051                         #   Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
1052                         # prefers "application/xhtml+xml" over "text/html" itself:
1053                         #   text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
1054                         negotiate_variant(
1055                                         "id"=>"text/html",
1056                                         "content-type"=>"text/html",
1057                                         "qs"=>0.6,
1058                                         "charset"=>$client_charset,
1059                                         "lang"=>$W->{"language"},
1060                                         ),
1061                         negotiate_variant(
1062                                         "id"=>"application/xhtml+xml",
1063                                         "content-type"=>"application/xhtml+xml",
1064                                         "qs"=>0.6,
1065                                         "charset"=>$client_charset,
1066                                         "lang"=>$W->{"language"},
1067                                         ),
1068                         # application/xml ?
1069                         # text/xml ?
1070                         ]);
1071         # mod_perl doc: If you set this header via the headers_out table directly, it
1072         #               will be ignored by Apache. So do not do that.
1073         $W->{"r"}->content_type("$mime; charset=$client_charset");
1074
1075         cache_start();
1076         return if $W->{"header_only"};
1077         # We still can append headers before we put out some text.
1078         # FIXME: It is not clean to still append them without overwriting.
1079         return if $W->{"heading_done"}++;
1080
1081         Wprint '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n" if $mime=~m{^application/\w+[+]xml$};
1082         return if $W->{"xml_header_only"};
1083         Wprint '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
1084         Wprint '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="'.$W->{"language"}.'">'."\n";
1085         my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
1086         # Do not: cluck if $title=~/[<>]/;
1087         # as it is not solved just by: &a_href_inhibit
1088         # as sometimes titles use also: <i>...</i>
1089         $title=~s#<[^>]*>##g;
1090         Wprint "<head>";
1091         Wprint "<title>$title</title>\n";
1092         if ($W->{"have_css"}) {
1093                 # Everything can get overriden later.
1094                 for my $css ("/My/Web.css",map((!$_ ? () : ("ARRAY" ne ref($_) ? $_ : @$_)),$W->{"css_push"})) {
1095                         Wprint <<"HERE";
1096 <link rel="stylesheet" type="text/css" href="@{[ uri_escaped(path_web $css) ]}" />
1097 HERE
1098                         }
1099                 if ($W->{"css_inherit"}) {
1100                         Wprint <<"HERE";
1101 <script type="text/javascript" src="@{[ uri_escaped(path_web('/My/css_inherit.js')) ]}" />
1102 HERE
1103                         }
1104                 }
1105         Wprint '<meta name="robots" content="'.($W->{"indexme"} ? "" : "no" ).'index,follow" />'."\n";
1106         Wprint $W->{"head"};
1107         for my $type (qw(prev next index contents start up)) {
1108                 do { Wprint '<link rel="'.$type.'" href="'.uri_escaped(path_web $_).'" />'."\n" if $_; }
1109                                 for ($W->{"rel_$type"});
1110                 }
1111         Wprint "</head><body";
1112 #       Wprint ' bgcolor="black" text="white" link="aqua" vlink="teal"'
1113 #                       if $W->{"browser"}->netscape() && (!$W->{"browser"}->major() || $W->{"browser"}->major()<=4);
1114         Wprint $W->{"body_attr"};
1115         Wprint ">\n";
1116
1117         do { Wprint $_ if $_; } for $W->{"heading"};
1118 }
1119
1120 BEGIN {
1121         delete $W->{"__My::Web_init"};
1122         }
1123
1124 1;