$W->{"browser"} is now lazy-evaluated for proper "headers_in" hits.
[MyWeb.git] / Web.pm
diff --git a/Web.pm b/Web.pm
index de12860..cabea9d 100644 (file)
--- a/Web.pm
+++ b/Web.pm
@@ -68,6 +68,8 @@ BEGIN
                        for my $caller (keys(%callers)) {
                                next if $caller eq $target;
                                next if $packages_used_hash{$caller}{$target}++;
+                               cluck "Appending to the '_done' package list: caller=$caller,target=$target"
+                                               if $packages_used_hash{$caller}{"_done"};
                                push @{$packages_used_array{$caller}},$target;
                                }
                        }
@@ -123,32 +125,12 @@ require Encode;
 use Apache2::Filter;
 use Apache2::Connection;
 require MIME::Base64;
+use Apache2::ServerUtil;
+require MIME::Types;
 
 
 #our $W;
 
-sub cleanup($)
-{
-my($apache_request)=@_;
-
-       $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
-       cache_finish();
-       # Sanity protection.
-       $W=undef();
-       return OK;
-}
-
-sub request_check(;$)
-{
-my($self)=@_;
-
-       # Use &eval to prevent: Global $r object is not available. Set:\n\tPerlOptions +GlobalRequest\nin ...
-       # CGI requires valid "r": check it beforehand here.
-       confess "Calling sensitive dynamic code from a static code" if !eval { Apache2::RequestUtil->request(); };
-       # Do not: confess "Calling sensitive dynamic code without My::Web::init" if !$W->{"__PACKAGE__"};
-       # as it is valid at least while preparing arguments to call: &project::Lib::init
-}
-
 sub init ($%)
 {
 my($class,%args)=@_;
@@ -267,7 +249,10 @@ my($class,%args)=@_;
                $W->{"headers_in"}=$W->{"headers_in_RecordKeys"};
                }
 
-       $W->{"browser"}=HTTP::BrowserDetect->new($W->{"headers_in"}{"User-Agent"});
+       $W->{"browser"}=sub {
+               # Lazy-evaluation, we may not need the "User-Agent" header at all.
+               return our $r||=HTTP::BrowserDetect->new($W->{"headers_in"}{"User-Agent"});
+               };
 
        if (!defined $W->{"have_style"}) {
                $W->{"have_style"}=(!$W->{"browser"}->netscape() || ($W->{"browser"}->major() && $W->{"browser"}->major()>4) ? 1 : 0);
@@ -283,6 +268,33 @@ my($class,%args)=@_;
        return bless $W,$class;
 }
 
+sub cleanup($)
+{
+my($apache_request)=@_;
+
+       cluck "CORE::GLOBAL::exit hook not ran" if !$W->{"_exit_ran"};
+       cluck "packages not finalized" if !$packages_used_hash{$W->{"__PACKAGE__"}}{"_done"};
+       cache_finish();
+       # Sanity protection.
+       $W=undef();
+       return OK;
+}
+
+# PerlResponseHandler is RUN_FIRST and &ModPerl::Util::exit returns OK, so no (sane) go.
+# PerlLogHandler is already too late to be able to produce any output.
+my $exit_orig=\&CORE::GLOBAL::exit;
+sub exit_hook
+{
+               # &footer will call us recursively!
+               footer() if !$W->{"_exit_ran"}++;
+               return &{$exit_orig}(@_);
+}
+{
+       # Prevent: Subroutine CORE::GLOBAL::exit redefined
+       no warnings 'redefine';
+       *CORE::GLOBAL::exit=\&exit_hook;
+       }
+
 # Be aware other parts of code (non-My::Web) will NOT use this function!
 # Do not: Wprint $W->{"heading"},"undef"=>1;
 # as we would need to undef() it to turn it off and it would get defaulted in such case.
@@ -301,6 +313,17 @@ my($text,%args)=@_;
        $W->{"r"}->puts($text);
 }
 
+sub request_check(;$)
+{
+my($self)=@_;
+
+       # Use &eval to prevent: Global $r object is not available. Set:\n\tPerlOptions +GlobalRequest\nin ...
+       # CGI requires valid "r": check it beforehand here.
+       confess "Calling sensitive dynamic code from a static code" if !eval { Apache2::RequestUtil->request(); };
+       # Do not: confess "Calling sensitive dynamic code without My::Web::init" if !$W->{"__PACKAGE__"};
+       # as it is valid at least while preparing arguments to call: &project::Lib::init
+}
+
 sub escapeHTML($)
 {
 my($text)=@_;
@@ -466,21 +489,26 @@ my($msg)=@_;
        Wprint "\n".vskip("3ex")."<hr /><h1 class=\"error\">FATAL ERROR: $msg!</h1>\n"
                        ."<p>You can report this problem's details to"
                        ." ".a_href("mailto:".$W->{"admin_mail"},"admin of this website").".</p>\n";
-       footer();
+       exit;
 }
 
-sub footer (;$)
+sub footer()
 {
-       exit 1 if $W->{"footer_passed"}++;      # deadlock prevention:
+       cluck 'Explicit &footer call is deprecated' if !$W->{"_exit_ran"};
+       exit if $W->{"footer_passed"}++;        # deadlock prevention:
+       if ($W->{"header_only"}) {
+               $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
+               exit;
+               }
 
        Wprint vskip if $W->{"footer_delimit"};
-
-       do { Wprint $_ if $_; } for $W->{"footing_delimit"};
-
+       &{$_}() for reverse @{$W->{"footing_delimit_sub_push"}};
        Wprint "<hr />\n" if $W->{"footer"};
 
-       my $packages_used=$packages_used_array{$W->{"__PACKAGE__"}};
+       # Never update the package list while we examine it!
+       $packages_used_hash{$W->{"__PACKAGE__"}}{"_done"}=1;
 
+       my $packages_used=$packages_used_array{$W->{"__PACKAGE__"}};
        if ($W->{"footer_ids"}) {
                Wprint '<p class="cvs-id">';
                Wprint join("<br />\n",map({ my $package=$_;
@@ -529,7 +557,7 @@ sub footer (;$)
        do { Wprint $_ if $_; } for $W->{"footing"};
 
        Wprint "</body></html>\n";
-       exit 0;
+       exit;
 }
 
 # Existing entries are overwritten.
@@ -938,7 +966,8 @@ sub cache_start()
                        }
                last if OK==$status;
                $W->{"r"}->status($status);
-               exit 0;
+               $W->{"header_only"}=1;  # Inhibit &footer output.
+               exit;
                die "NOTREACHED";
                }
 
@@ -971,7 +1000,7 @@ sub cache_finish_last_modified()
 sub cache_finish()
 {
        # Do not: return if !$W->{"uri_args_frozen"};
-       # as we may have just gave 304 and 'exit 0;' without starting the caching.
+       # as we may have just gave 304 and 'exit;' without starting the caching.
        return if !$W->{"cache_active"};
 
        # Fill-in/check: %uri_args_frozen_to_headers_in_keys
@@ -1010,7 +1039,7 @@ sub cache_finish()
                delete $Vary{$_};
                }
        %Vary=("*"=>1) if $Vary{"*"};
-       $headers_out{"Vary"}=join(", ",sort keys(%Vary));
+       $headers_out{"Vary"}=join(", ",sort keys(%Vary)) if keys(%Vary);
        # $W->{"r"}->set_last_modified() ?
        $headers_out{"Last-Modified"}=cache_finish_last_modified();
 
@@ -1041,19 +1070,20 @@ my($class)=@_;
        # TODO: Support also: private
        header("Cache-Control"=>"public");      # HTTP/1.1
 
-       # $ENV{"CLIENT_CHARSET"} ignored (mod_czech support dropped!)
-       my $client_charset=$W->{"force_charset"} || "us-ascii";
+       # Use $W->{"force_charset"}=0 to disable charset.
+       my $client_charset=$W->{"force_charset"};
+       $client_charset="us-ascii" if !defined $client_charset;
 
        # Workaround bug
        #   https://bugzilla.mozilla.org/show_bug.cgi?id=120556
        # of at least
        #   Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8b) Gecko/20050217
-       my $mime;
+       my $mime=$W->{"content_type"};
        # http://validator.w3.org/ does not send ANY "Accept" headers!
-       $mime||="application/xhtml+xml" if 1
+       $mime="application/xhtml+xml" if !$mime
                        && !$W->{"headers_in"}{"Accept"}
                        && ($W->{"headers_in"}{"User-Agent"}||"")=~m{^W3C_Validator/}i;
-       $mime||=$class->Negotiate_choose([
+       $mime or $mime=$class->Negotiate_choose([
                        # Put the fallback variant as the first one.
                        # Rate both variants the same to prefer "text/html" for undecided clients.
                        # At least
@@ -1079,16 +1109,21 @@ my($class)=@_;
                        ]);
        # mod_perl doc: If you set this header via the headers_out table directly, it
        #               will be ignored by Apache. So do not do that.
-       $W->{"r"}->content_type("$mime; charset=$client_charset");
+       my $type=MIME::Types->new()->type($mime) if $client_charset;
+       cluck "MIME::Types type $mime not known" if $client_charset && !$type;
+       $client_charset=undef() if $type && !$type->isAscii();
+       $W->{"r"}->content_type($mime.(!$client_charset ? "" : "; charset=$client_charset"));
 
        cache_start();
-       return if $W->{"header_only"};
        # We still can append headers before we put out some text.
        # FIXME: It is not clean to still append them without overwriting.
-       return if $W->{"heading_done"}++;
+       return if $W->{"heading_done"};
+       Wprint '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n"
+                       if (!$W->{"header_only"} || $W->{"header_only"} eq "xml") && $mime=~m{^application/\w+[+]xml$};
+       return if $W->{"header_only"};
+       # Split 'heading_done' for the proper handling of: /project/Rel.pm
+       $W->{"heading_done"}++;
 
-       Wprint '<?xml version="1.0" encoding="'.$client_charset.'"?>'."\n" if $mime=~m{^application/\w+[+]xml$};
-       return if $W->{"xml_header_only"};
        Wprint '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'."\n";
        Wprint '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="'.$W->{"language"}.'">'."\n";
        my $title=$W->{"title_prefix"}.join("",map({ ': '.$_; } ($W->{"title"} || ())));
@@ -1100,7 +1135,7 @@ my($class)=@_;
        Wprint "<title>$title</title>\n";
        if ($W->{"have_css"}) {
                # Everything can get overriden later.
-               for my $css ("/My/Web.css",map((!$_ ? () : ("ARRAY" ne ref($_) ? $_ : @$_)),$W->{"css_push"})) {
+               for my $css ("/My/Web.css",@{$W->{"css_push"}}) {
                        Wprint <<"HERE";
 <link rel="stylesheet" type="text/css" href="@{[ uri_escaped(path_web $css) ]}" />
 HERE