the kind of perl code that can only be written at 4:30 am

[ikiwiki.git] / IkiWiki.pm

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 7c910a53dfe62b6a88c5c7c85714318739c91663..73280abf1b13b0f3d56e3c71657ac401da061cc6 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -998,9 +998,37 @@ sub pagespec_match ($$;@) { #{{{
                unshift @params, "location";
        }
 
-       return eval pagespec_translate($spec);
+       my $ret=eval pagespec_translate($spec);
+       return IkiWiki::FailReason->new("syntax error") if $@;
+       return $ret;
 } #}}}
 
+package IkiWiki::FailReason;
+
+use overload (
+       '""'    => sub { return ${$_[0]} },
+       '0+'    => sub { return 0 },
+       '!'     => sub { bless $_[0], 'IkiWiki::SuccessReason'},
+       fallback => 1,
+);
+
+sub new {
+       bless \$_[1], $_[0];
+}
+
+package IkiWiki::SuccessReason;
+
+use overload (
+       '""'    => sub { return ${$_[0]} },
+       '0+'    => sub { return 1 },
+       '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
+       fallback => 1,
+);
+
+sub new {
+       bless \$_[1], $_[0];
+}
+
 package IkiWiki::PageSpec;
 
 sub match_glob ($$;@) { #{{{
@@ -1022,7 +1050,12 @@ sub match_glob ($$;@) { #{{{
        $glob=~s/\\\*/.*/g;
        $glob=~s/\\\?/./g;
 
-       return $page=~/^$glob$/i;
+       if ($page=~/^$glob$/i) {
+               return IkiWiki::SuccessReason->new("$glob matches $page");
+       }
+       else {
+               return IkiWiki::FailReason->new("$glob does not match $page");
+       }
 } #}}}
 
 sub match_link ($$;@) { #{{{
@@ -1040,13 +1073,14 @@ sub match_link ($$;@) { #{{{
        }
 
        my $links = $IkiWiki::links{$page} or return undef;
-       return 0 unless @$links;
+       return IkiWiki::FailReason->new("$page has no links") unless @$links;
        my $bestlink = IkiWiki::bestlink($from, $link);
-       return 0 unless length $bestlink;
+       return IkiWiki::FailReason->new("no such link") unless length $bestlink;
        foreach my $p (@$links) {
-               return 1 if $bestlink eq IkiWiki::bestlink($page, $p);
+               return IkiWiki::SuccessReason->new("$page links to $link")
+                       if $bestlink eq IkiWiki::bestlink($page, $p);
        }
-       return 0;
+       return IkiWiki::FailReason->new("$page does not link to $link");
 } #}}}
 
 sub match_backlink ($$;@) { #{{{
@@ -1058,10 +1092,15 @@ sub match_created_before ($$;@) { #{{{
        my $testpage=shift;
 
        if (exists $IkiWiki::pagectime{$testpage}) {
-               return $IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage};
+               if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
+                       IkiWiki::SuccessReason->new("$page created before $testpage");
+               }
+               else {
+                       IkiWiki::FailReason->new("$page not created before $testpage");
+               }
        }
        else {
-               return 0;
+               return IkiWiki::FailReason->new("$testpage has no ctime");
        }
 } #}}}
 
@@ -1070,23 +1109,43 @@ sub match_created_after ($$;@) { #{{{
        my $testpage=shift;
 
        if (exists $IkiWiki::pagectime{$testpage}) {
-               return $IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage};
+               if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
+                       IkiWiki::SuccessReason->new("$page created after $testpage");
+               }
+               else {
+                       IkiWiki::FailReason->new("$page not created after $testpage");
+               }
        }
        else {
-               return 0;
+               return IkiWiki::FailReason->new("$testpage has no ctime");
        }
 } #}}}
 
 sub match_creation_day ($$;@) { #{{{
-       return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift);
+       if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
+               return IkiWiki::SuccessReason->new("creation_day matched");
+       }
+       else {
+               return IkiWiki::FailReason->new("creation_day did not match");
+       }
 } #}}}
 
 sub match_creation_month ($$;@) { #{{{
-       return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift);
+       if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
+               return IkiWiki::SuccessReason->new("creation_month matched");
+       }
+       else {
+               return IkiWiki::FailReason->new("creation_month did not match");
+       }
 } #}}}
 
 sub match_creation_year ($$;@) { #{{{
-       return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift);
+       if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
+               return IkiWiki::SuccessReason->new("creation_year matched");
+       }
+       else {
+               return IkiWiki::FailReason->new("creation_year did not match");
+       }
 } #}}}
 
 sub match_user ($$;@) { #{{{
@@ -1094,8 +1153,13 @@ sub match_user ($$;@) { #{{{
        my $user=shift;
        my %params=@_;
 
-       return unless exists $params{user};
-       return $user eq $params{user};
+       return IkiWiki::FailReason->new("cannot match user") unless exists $params{user};
+       if ($user eq $params{user}) {
+               return IkiWiki::SuccessReason->new("user is $user")
+       }
+       else {
+               return IkiWiki::FailReason->new("user is not $user");
+       }
 } #}}}
 
 1