protect $@ whenever a block using $@ is non-trivial

As noted in the Try::Tiny man page, eval/$@ can be quite awkward in
corner cases, because $@ has the same properties and problems as C's
errno. While writing a regression test for definetemplate
in which it couldn't find an appropriate template, I received

    <span class="error">Error: failed to process template
    <span class="createlink">deftmpl</span> </span>

instead of the intended

    <span class="error">Error: failed to process template
    <span class="createlink">deftmpl</span> template deftmpl not
    found</span>

which turned out to be because the "catch"-analogous block called
gettext before it used $@, and gettext can call define_gettext,
which uses eval.

This commit alters all current "catch"-like blocks that use $@, except
those that just do trivial things with $@ (string interpolation, string
concatenation) and call a function (die, error, print, etc.)

diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm
index 5baa6c1798ef02e1f45680daa032da17674fafb0..c0d8f598b5f882b27bd2d5671d476aa5164a812b 100644 (file)
--- a/IkiWiki/CGI.pm
+++ b/IkiWiki/CGI.pm
@@ -351,7 +351,8 @@ sub cgi_getsession ($) {
                        { FileName => "$config{wikistatedir}/sessions.db" })
        };
        if (! $session || $@) {
                        { FileName => "$config{wikistatedir}/sessions.db" })
        };
        if (! $session || $@) {

-               error($@." ".CGI::Session->errstr());
+               my $error = $@;
+               error($error." ".CGI::Session->errstr());

        }
        
        umask($oldmask);
        }
        
        umask($oldmask);

diff --git a/IkiWiki/Plugin/aggregate.pm b/IkiWiki/Plugin/aggregate.pm
index 28c445913f436e8ee7269fb1b3eea6ca35351bab..fbf88c62738d783c210d27cf6aa57c1b81c71fef 100644 (file)
--- a/IkiWiki/Plugin/aggregate.pm
+++ b/IkiWiki/Plugin/aggregate.pm
@@ -553,7 +553,9 @@ sub aggregate (@) {
                        };
                }
                if ($@) {
                        };
                }
                if ($@) {

-                       $feed->{message}=gettext("feed crashed XML::Feed!")." ($@)";
+                       # gettext can clobber $@
+                       my $error = $@;
+                       $feed->{message}=gettext("feed crashed XML::Feed!")." ($error)";

                        $feed->{error}=1;
                        debug($feed->{message});
                        next;
                        $feed->{error}=1;
                        debug($feed->{message});
                        next;


@@ -675,7 +677,9 @@ sub write_page ($$$$$) {
                $template=template($feed->{template}, blind_cache => 1);
        };
        if ($@) {
                $template=template($feed->{template}, blind_cache => 1);
        };
        if ($@) {

-               print STDERR gettext("failed to process template:")." $@";
+               # gettext can clobber $@
+               my $error = $@;
+               print STDERR gettext("failed to process template:")." $error";

                return;
        }
        $template->param(title => $params{title})
                return;
        }
        $template->param(title => $params{title})

diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm
index 83dd120f649ea13898ee9cc479bb576cb94043b7..d56dd18ad8ded90e3dd6f46598e7bc632359d4b5 100644 (file)
--- a/IkiWiki/Plugin/attachment.pm
+++ b/IkiWiki/Plugin/attachment.pm
@@ -229,8 +229,10 @@ sub attachment_store {
                check_canattach($session, $final_filename, $tempfile);
        };
        if ($@) {
                check_canattach($session, $final_filename, $tempfile);
        };
        if ($@) {

-               json_response($q, $form, $dest."/".$filename, $@);
-               error $@;
+               # save error in case called functions clobber $@
+               my $error = $@;
+               json_response($q, $form, $dest."/".$filename, $error);
+               error $error;

        }
 
        # Move the attachment into holding directory.
        }
 
        # Move the attachment into holding directory.

diff --git a/IkiWiki/Plugin/editpage.pm b/IkiWiki/Plugin/editpage.pm
index d15607990db2412b8a14f281864f82f98b3cac7f..3047869c4a0ad4da75f715937b8fff185dc80970 100644 (file)
--- a/IkiWiki/Plugin/editpage.pm
+++ b/IkiWiki/Plugin/editpage.pm
@@ -400,10 +400,12 @@ sub cgi_editpage ($$) {
                eval { writefile($file, $config{srcdir}, $content) };
                $config{cgi}=1;
                if ($@) {
                eval { writefile($file, $config{srcdir}, $content) };
                $config{cgi}=1;
                if ($@) {

+                       # save $@ in case a called function clobbers it
+                       my $error = $@;

                        $form->field(name => "rcsinfo", value => rcs_prepedit($file),
                                force => 1);
                        my $mtemplate=template("editfailedsave.tmpl");
                        $form->field(name => "rcsinfo", value => rcs_prepedit($file),
                                force => 1);
                        my $mtemplate=template("editfailedsave.tmpl");

-                       $mtemplate->param(error_message => $@);
+                       $mtemplate->param(error_message => $error);

                        $form->tmpl_param("message", $mtemplate->output);
                        $form->field("editcontent", value => $content, force => 1);
                        $form->tmpl_param("page_select", 0);
                        $form->tmpl_param("message", $mtemplate->output);
                        $form->field("editcontent", value => $content, force => 1);
                        $form->tmpl_param("page_select", 0);

diff --git a/IkiWiki/Plugin/edittemplate.pm b/IkiWiki/Plugin/edittemplate.pm
index c7f1e4fa7f7117660b5d89207a1795caec9fc6af..e3ce5e3d97437392c681f20f6c3a23b0b9690790 100644 (file)
--- a/IkiWiki/Plugin/edittemplate.pm
+++ b/IkiWiki/Plugin/edittemplate.pm
@@ -130,9 +130,11 @@ sub filltemplate ($$) {
                $template=template("/".$template_page);
        };
        if ($@) {
                $template=template("/".$template_page);
        };
        if ($@) {

+               # gettext can clobber $@
+               my $error = $@;

                # Indicate that the earlier preprocessor directive set 
                # up a template that doesn't work.
                # Indicate that the earlier preprocessor directive set 
                # up a template that doesn't work.

-               return "[[!edittemplate ".gettext("failed to process template:")." $@]]";
+               return "[[!edittemplate ".gettext("failed to process template:")." $error]]";

        }
 
        $template->param(name => $page);
        }
 
        $template->param(name => $page);

diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm
index 0380bec3d6cd9948ec92229117ea3655212af59a..123dfd36489c8536450971c95267ef30261abcc9 100644 (file)
--- a/IkiWiki/Plugin/inline.pm
+++ b/IkiWiki/Plugin/inline.pm
@@ -391,7 +391,9 @@ sub preprocess_inline (@) {
                                        blind_cache => 1);
                        };
                        if ($@) {
                                        blind_cache => 1);
                        };
                        if ($@) {

-                               error sprintf(gettext("failed to process template %s"), $params{template}.".tmpl").": $@";
+                               # gettext can clobber $@
+                               my $error = $@;
+                               error sprintf(gettext("failed to process template %s"), $params{template}.".tmpl").": $error";

                        }
                }
                my $needcontent=$raw || (!($archive && $quick) && $template->query(name => 'content'));
                        }
                }
                my $needcontent=$raw || (!($archive && $quick) && $template->query(name => 'content'));

diff --git a/IkiWiki/Plugin/mdwn.pm b/IkiWiki/Plugin/mdwn.pm
index 430194bffdcc6444f34036709d9dc3767187af85..014e78eea124604e249d35d42a6b9ccf6524c254 100644 (file)
--- a/IkiWiki/Plugin/mdwn.pm
+++ b/IkiWiki/Plugin/mdwn.pm
@@ -92,8 +92,9 @@ sub htmlize (@) {
                                        $markdown_sub=\&Markdown::Markdown;
                                }
                                else {
                                        $markdown_sub=\&Markdown::Markdown;
                                }
                                else {

+                                       my $error = $@;

                                        do "/usr/bin/markdown" ||
                                        do "/usr/bin/markdown" ||

-                                               error(sprintf(gettext("failed to load Markdown.pm perl module (%s) or /usr/bin/markdown (%s)"), $@, $!));
+                                               error(sprintf(gettext("failed to load Markdown.pm perl module (%s) or /usr/bin/markdown (%s)"), $error, $!));

                                        $markdown_sub=\&Markdown::Markdown;
                                }
                        }
                                        $markdown_sub=\&Markdown::Markdown;
                                }
                        }

diff --git a/IkiWiki/Plugin/template.pm b/IkiWiki/Plugin/template.pm
index 3df06e652eeee285d51690b9d2178d6e0fb2b8ca..ccc9cb6664e5617c514ba6715107a2c4d1ddc448 100644 (file)
--- a/IkiWiki/Plugin/template.pm
+++ b/IkiWiki/Plugin/template.pm
@@ -41,9 +41,11 @@ sub preprocess (@) {
                        blind_cache => 1);
        };
        if ($@) {
                        blind_cache => 1);
        };
        if ($@) {

+               # gettext can clobber $@
+               my $error = $@;

                error sprintf(gettext("failed to process template %s"),
                        htmllink($params{page}, $params{destpage},
                error sprintf(gettext("failed to process template %s"),
                        htmllink($params{page}, $params{destpage},

-                               "/templates/$params{id}"))." $@";
+                               "/templates/$params{id}"))." $error";

        }
 
        $params{basename}=IkiWiki::basename($params{page});
        }
 
        $params{basename}=IkiWiki::basename($params{page});