Fix escaping of filenames in historyurl. (Thanks, aj)

[git.ikiwiki.info.git] / IkiWiki / Plugin / monotone.pm

diff --git a/IkiWiki/Plugin/monotone.pm b/IkiWiki/Plugin/monotone.pm
index 40a41c765b7142f5973c4ec63a956c6fd7569494..75bf2f458a48e461eadb91c44ffb9d21e89260c4 100644 (file)
--- a/IkiWiki/Plugin/monotone.pm
+++ b/IkiWiki/Plugin/monotone.pm
@@ -10,7 +10,7 @@ use Date::Format qw(time2str);
 
 my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate sha1sums
 
 
 my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate sha1sums
 

-sub import { #{{{
+sub import {

        hook(type => "checkconfig", id => "monotone", call => \&checkconfig);
        hook(type => "getsetup", id => "monotone", call => \&getsetup);
        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
        hook(type => "checkconfig", id => "monotone", call => \&checkconfig);
        hook(type => "getsetup", id => "monotone", call => \&getsetup);
        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);


@@ -23,9 +23,10 @@ sub import { #{{{
        hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
        hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
        hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
        hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
        hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
        hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);

-} #}}}
+       hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
+}

 
 

-sub checkconfig () { #{{{
+sub checkconfig () {

        if (!defined($config{mtnrootdir})) {
                $config{mtnrootdir} = $config{srcdir};
        }
        if (!defined($config{mtnrootdir})) {
                $config{mtnrootdir} = $config{srcdir};
        }


@@ -55,19 +56,20 @@ sub checkconfig () { #{{{
                error("Monotone version too old, is $version but required 0.38");
        }
 
                error("Monotone version too old, is $version but required 0.38");
        }
 

-       if (length $config{mtn_wrapper}) {
+       if (defined $config{mtn_wrapper} && length $config{mtn_wrapper}) {

                push @{$config{wrappers}}, {
                        wrapper => $config{mtn_wrapper},
                        wrappermode => (defined $config{mtn_wrappermode} ? $config{mtn_wrappermode} : "06755"),
                };
        }
                push @{$config{wrappers}}, {
                        wrapper => $config{mtn_wrapper},
                        wrappermode => (defined $config{mtn_wrappermode} ? $config{mtn_wrappermode} : "06755"),
                };
        }

-} #}}}
+}

 
 

-sub getsetup () { #{{{
+sub getsetup () {

        return
                plugin => {
                        safe => 0, # rcs plugin
                        rebuild => undef,
        return
                plugin => {
                        safe => 0, # rcs plugin
                        rebuild => undef,

+                       section => "rcs",

                },
                mtn_wrapper => {
                        type => "string",
                },
                mtn_wrapper => {
                        type => "string",


@@ -117,9 +119,9 @@ sub getsetup () { #{{{
                        safe => 0, # path
                        rebuild => 0,
                },
                        safe => 0, # path
                        rebuild => 0,
                },

-} #}}}
+}

 
 

-sub get_rev () { #{{{
+sub get_rev () {

        my $sha1 = `mtn --root=$config{mtnrootdir} automate get_base_revision_id`;
 
        ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
        my $sha1 = `mtn --root=$config{mtnrootdir} automate get_base_revision_id`;
 
        ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now


@@ -128,9 +130,9 @@ sub get_rev () { #{{{
        }
 
        return $sha1;
        }
 
        return $sha1;

-} #}}}
+}

 
 

-sub get_rev_auto ($) { #{{{
+sub get_rev_auto ($) {

        my $automator=shift;
 
        my @results = $automator->call("get_base_revision_id");
        my $automator=shift;
 
        my @results = $automator->call("get_base_revision_id");


@@ -142,9 +144,9 @@ sub get_rev_auto ($) { #{{{
        }
 
        return $sha1;
        }
 
        return $sha1;

-} #}}}
+}

 
 

-sub mtn_merge ($$$$) { #{{{
+sub mtn_merge ($$$$) {

        my $leftRev=shift;
        my $rightRev=shift;
        my $branch=shift;
        my $leftRev=shift;
        my $rightRev=shift;
        my $branch=shift;


@@ -172,9 +174,9 @@ sub mtn_merge ($$$$) { #{{{
        debug("merged $leftRev, $rightRev to make $mergeRev");
 
        return $mergeRev;
        debug("merged $leftRev, $rightRev to make $mergeRev");
 
        return $mergeRev;

-} #}}}
+}

 
 

-sub commit_file_to_new_rev ($$$$$$$$) { #{{{
+sub commit_file_to_new_rev ($$$$$$$$) {

        my $automator=shift;
        my $wsfilename=shift;
        my $oldFileID=shift;
        my $automator=shift;
        my $wsfilename=shift;
        my $oldFileID=shift;


@@ -219,16 +221,16 @@ sub commit_file_to_new_rev ($$$$$$$$) { #{{{
        
        debug("Added certs for rev: $newRevID");
        return $newRevID;
        
        debug("Added certs for rev: $newRevID");
        return $newRevID;

-} #}}}
+}

 
 

-sub read_certs ($$) { #{{{
+sub read_certs ($$) {

        my $automator=shift;
        my $rev=shift;
        my @results = $automator->call("certs", $rev);
        my @ret;
 
        my $line = $results[0];
        my $automator=shift;
        my $rev=shift;
        my @results = $automator->call("certs", $rev);
        my @ret;
 
        my $line = $results[0];

-       while ($line =~ m/\s+key\s"(.*?)"\nsignature\s"(ok|bad|unknown)"\n\s+name\s"(.*?)"\n\s+value\s"(.*?)"\n\s+trust\s"(trusted|untrusted)"\n/sg) {
+       while ($line =~ m/\s+key\s["\[](.*?)[\]"]\nsignature\s"(ok|bad|unknown)"\n\s+name\s"(.*?)"\n\s+value\s"(.*?)"\n\s+trust\s"(trusted|untrusted)"\n/sg) {

                push @ret, {
                        key => $1,
                        signature => $2,
                push @ret, {
                        key => $1,
                        signature => $2,


@@ -239,9 +241,9 @@ sub read_certs ($$) { #{{{
        }
 
        return @ret;
        }
 
        return @ret;

-} #}}}
+}

 
 

-sub get_changed_files ($$) { #{{{
+sub get_changed_files ($$) {

        my $automator=shift;
        my $rev=shift;
        
        my $automator=shift;
        my $rev=shift;
        


@@ -250,9 +252,20 @@ sub get_changed_files ($$) { #{{{
 
        my @ret;
        my %seen = ();
 
        my @ret;
        my %seen = ();

-       
+
+       # we need to strip off the relative path to the source dir
+       # because monotone outputs all file paths absolute according
+       # to the workspace root
+       my $rel_src_dir = $config{'srcdir'};
+       $rel_src_dir =~ s/^\Q$config{'mtnrootdir'}\E\/?//;
+       $rel_src_dir .= "/" if length $rel_src_dir;
+

        while ($changes =~ m/\s*(add_file|patch|delete|rename)\s"(.*?)(?<!\\)"\n/sg) {
                my $file = $2;
        while ($changes =~ m/\s*(add_file|patch|delete|rename)\s"(.*?)(?<!\\)"\n/sg) {
                my $file = $2;

+               # ignore all file changes outside the source dir
+               next unless $file =~ m/^\Q$rel_src_dir\E/;
+               $file =~ s/^\Q$rel_src_dir\E//;
+        

                # don't add the same file multiple times
                if (! $seen{$file}) {
                        push @ret, $file;
                # don't add the same file multiple times
                if (! $seen{$file}) {
                        push @ret, $file;


@@ -261,9 +274,9 @@ sub get_changed_files ($$) { #{{{
        }
        
        return @ret;
        }
        
        return @ret;

-} #}}}
+}

 
 

-sub rcs_update () { #{{{
+sub rcs_update () {

        chdir $config{srcdir}
            or error("Cannot chdir to $config{srcdir}: $!");
 
        chdir $config{srcdir}
            or error("Cannot chdir to $config{srcdir}: $!");
 


@@ -278,9 +291,9 @@ sub rcs_update () { #{{{
        if (system("mtn", "--root=$config{mtnrootdir}", "update", "--quiet") != 0) {
                debug("monotone update failed");
        }
        if (system("mtn", "--root=$config{mtnrootdir}", "update", "--quiet") != 0) {
                debug("monotone update failed");
        }

-} #}}}
+}

 
 

-sub rcs_prepedit ($) { #{{{
+sub rcs_prepedit ($) {

        my $file=shift;
 
        chdir $config{srcdir}
        my $file=shift;
 
        chdir $config{srcdir}


@@ -289,33 +302,35 @@ sub rcs_prepedit ($) { #{{{
        # For monotone, return the revision of the file when
        # editing begins.
        return get_rev();
        # For monotone, return the revision of the file when
        # editing begins.
        return get_rev();

-} #}}}
+}
+
+sub commitauthor (@) {
+       my %params=@_;

 
 

-sub rcs_commit ($$$;$$) { #{{{
+       if (defined $params{session}) {
+               if (defined $params{session}->param("name")) {
+                       return "Web user: " . $params{session}->param("name");
+               }
+               elsif (defined $params{session}->remote_addr()) {
+                       return "Web IP: " . $params{session}->remote_addr();
+               }
+       }
+       return "Web: Anonymous";
+}
+
+
+sub rcs_commit (@) {

        # Tries to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on failure.
        # The file is relative to the srcdir.
        # Tries to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on failure.
        # The file is relative to the srcdir.

-       my $file=shift;
-       my $message=shift;
-       my $rcstoken=shift;
-       my $user=shift;
-       my $ipaddr=shift;
-       my $author;
+       my %params=@_;

 
 

-       if (defined $user) {
-               $author="Web user: " . $user;
-       }
-       elsif (defined $ipaddr) {
-               $author="Web IP: " . $ipaddr;
-       }
-       else {
-               $author="Web: Anonymous";
-       }
+       my $author=IkiWiki::possibly_foolish_untaint(commitauthor(%params)),

 
        chdir $config{srcdir}
            or error("Cannot chdir to $config{srcdir}: $!");
 
 
        chdir $config{srcdir}
            or error("Cannot chdir to $config{srcdir}: $!");
 

-       my ($oldrev)= $rcstoken=~ m/^($sha1_pattern)$/; # untaint
+       my ($oldrev) = $params{token} =~ m/^($sha1_pattern)$/; # untaint

        my $rev = get_rev();
        if (defined $rev && defined $oldrev && $rev ne $oldrev) {
                my $automator = Monotone->new();
        my $rev = get_rev();
        if (defined $rev && defined $oldrev && $rev ne $oldrev) {
                my $automator = Monotone->new();


@@ -324,8 +339,8 @@ sub rcs_commit ($$$;$$) { #{{{
                # Something has been committed, has this file changed?
                my ($out, $err);
                $automator->setOpts("r", $oldrev, "r", $rev);
                # Something has been committed, has this file changed?
                my ($out, $err);
                $automator->setOpts("r", $oldrev, "r", $rev);

-               ($out, $err) = $automator->call("content_diff", $file);
-               debug("Problem committing $file") if ($err ne "");
+               ($out, $err) = $automator->call("content_diff", $params{file});
+               debug("Problem committing $params{file}") if ($err ne "");

                my $diff = $out;
                
                if ($diff) {
                my $diff = $out;
                
                if ($diff) {


@@ -334,11 +349,11 @@ sub rcs_commit ($$$;$$) { #{{{
                        #
                        # first get the contents
                        debug("File changed: forming branch");
                        #
                        # first get the contents
                        debug("File changed: forming branch");

-                       my $newfile=readfile("$config{srcdir}/$file");
+                       my $newfile=readfile("$config{srcdir}/$params{file}");

                        
                        # then get the old content ID from the diff
                        
                        # then get the old content ID from the diff

-                       if ($diff !~ m/^---\s$file\s+($sha1_pattern)$/m) {
-                               error("Unable to find previous file ID for $file");
+                       if ($diff !~ m/^---\s$params{file}\s+($sha1_pattern)$/m) {
+                               error("Unable to find previous file ID for $params{file}");

                        }
                        my $oldFileID = $1;
 
                        }
                        my $oldFileID = $1;
 


@@ -349,13 +364,13 @@ sub rcs_commit ($$$;$$) { #{{{
                        my $branch = $1;
 
                        # then put the new content into the DB (and record the new content ID)
                        my $branch = $1;
 
                        # then put the new content into the DB (and record the new content ID)

-                       my $newRevID = commit_file_to_new_rev($automator, $file, $oldFileID, $newfile, $oldrev, $branch, $author, $message);
+                       my $newRevID = commit_file_to_new_rev($automator, $params{file}, $oldFileID, $newfile, $oldrev, $branch, $author, $params{message});

 
                        $automator->close();
 
                        # if we made it to here then the file has been committed... revert the local copy
 
                        $automator->close();
 
                        # if we made it to here then the file has been committed... revert the local copy

-                       if (system("mtn", "--root=$config{mtnrootdir}", "revert", $file) != 0) {
-                               debug("Unable to revert $file after merge on conflicted commit!");
+                       if (system("mtn", "--root=$config{mtnrootdir}", "revert", $params{file}) != 0) {
+                               debug("Unable to revert $params{file} after merge on conflicted commit!");

                        }
                        debug("Divergence created! Attempting auto-merge.");
 
                        }
                        debug("Divergence created! Attempting auto-merge.");
 


@@ -404,7 +419,7 @@ sub rcs_commit ($$$;$$) { #{{{
                                # for cleanup note, this relies on the fact
                                # that ikiwiki seems to call rcs_prepedit()
                                # again after we return
                                # for cleanup note, this relies on the fact
                                # that ikiwiki seems to call rcs_prepedit()
                                # again after we return

-                               return readfile("$config{srcdir}/$file");
+                               return readfile("$config{srcdir}/$params{file}");

                        }
                        return undef;
                }
                        }
                        return undef;
                }


@@ -416,11 +431,12 @@ sub rcs_commit ($$$;$$) { #{{{
 
        if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
                   "--author", $author, "--key", $config{mtnkey}, "-m",
 
        if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
                   "--author", $author, "--key", $config{mtnkey}, "-m",

-                  IkiWiki::possibly_foolish_untaint($message), $file) != 0) {
+                  IkiWiki::possibly_foolish_untaint($params{message}),
+                  $params{file}) != 0) {

                debug("Traditional commit failed! Returning data as conflict.");
                debug("Traditional commit failed! Returning data as conflict.");

-               my $conflict=readfile("$config{srcdir}/$file");
+               my $conflict=readfile("$config{srcdir}/$params{file}");

                if (system("mtn", "--root=$config{mtnrootdir}", "revert",
                if (system("mtn", "--root=$config{mtnrootdir}", "revert",

-                          "--quiet", $file) != 0) {
+                          "--quiet", $params{file}) != 0) {

                        debug("monotone revert failed");
                }
                return $conflict;
                        debug("monotone revert failed");
                }
                return $conflict;


@@ -434,39 +450,28 @@ sub rcs_commit ($$$;$$) { #{{{
        }
 
        return undef # success
        }
 
        return undef # success

-} #}}}
+}

 
 

-sub rcs_commit_staged ($$$) {
+sub rcs_commit_staged (@) {

        # Commits all staged changes. Changes can be staged using rcs_add,
        # rcs_remove, and rcs_rename.
        # Commits all staged changes. Changes can be staged using rcs_add,
        # rcs_remove, and rcs_rename.

-       my ($message, $user, $ipaddr)=@_;
-       
+       my %params=@_;
+

        # Note - this will also commit any spurious changes that happen to be
        # lying around in the working copy.  There shouldn't be any, but...
        
        chdir $config{srcdir}
            or error("Cannot chdir to $config{srcdir}: $!");
 
        # Note - this will also commit any spurious changes that happen to be
        # lying around in the working copy.  There shouldn't be any, but...
        
        chdir $config{srcdir}
            or error("Cannot chdir to $config{srcdir}: $!");
 

-       my $author;
-
-       if (defined $user) {
-               $author="Web user: " . $user;
-       }
-       elsif (defined $ipaddr) {
-               $author="Web IP: " . $ipaddr;
-       }
-       else {
-               $author="Web: Anonymous";
-       }
-

        if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
        if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",

-                  "--author", $author, "--key", $config{mtnkey}, "-m",
-                  IkiWiki::possibly_foolish_untaint($message)) != 0) {
+                  "--author", IkiWiki::possibly_foolish_untaint(commitauthor(%params)),
+                  "--key", $config{mtnkey}, "-m",
+                  IkiWiki::possibly_foolish_untaint($params{message})) != 0) {

                error("Monotone commit failed");
        }
 }
 
                error("Monotone commit failed");
        }
 }
 

-sub rcs_add ($) { #{{{
+sub rcs_add ($) {

        my $file=shift;
 
        chdir $config{srcdir}
        my $file=shift;
 
        chdir $config{srcdir}


@@ -476,9 +481,9 @@ sub rcs_add ($) { #{{{
                   $file) != 0) {
                error("Monotone add failed");
        }
                   $file) != 0) {
                error("Monotone add failed");
        }

-} #}}}
+}

 
 

-sub rcs_remove ($) { # {{{
+sub rcs_remove ($) {

        my $file = shift;
 
        chdir $config{srcdir}
        my $file = shift;
 
        chdir $config{srcdir}


@@ -495,9 +500,9 @@ sub rcs_remove ($) { # {{{
                   $file) != 0) {
                error("Monotone remove failed");
        }
                   $file) != 0) {
                error("Monotone remove failed");
        }

-} #}}}
+}

 
 

-sub rcs_rename ($$) { # {{{
+sub rcs_rename ($$) {

        my ($src, $dest) = @_;
 
        chdir $config{srcdir}
        my ($src, $dest) = @_;
 
        chdir $config{srcdir}


@@ -507,9 +512,9 @@ sub rcs_rename ($$) { # {{{
                   $src, $dest) != 0) {
                error("Monotone rename failed");
        }
                   $src, $dest) != 0) {
                error("Monotone rename failed");
        }

-} #}}}
+}

 
 

-sub rcs_recentchanges ($) { #{{{
+sub rcs_recentchanges ($) {

        my $num=shift;
        my @ret;
 
        my $num=shift;
        my @ret;
 


@@ -525,13 +530,12 @@ sub rcs_recentchanges ($) { #{{{
        my $child = open(MTNLOG, "-|");
        if (! $child) {
                exec("mtn", "log", "--root=$config{mtnrootdir}", "--no-graph",
        my $child = open(MTNLOG, "-|");
        if (! $child) {
                exec("mtn", "log", "--root=$config{mtnrootdir}", "--no-graph",

-                    "--brief") || error("mtn log failed to run");
+                    "--brief", "--last=$num") || error("mtn log failed to run");

        }
 
        }
 

-       while (($num >= 0) and (my $line = <MTNLOG>)) {
+       while (my $line = <MTNLOG>) {

                if ($line =~ m/^($sha1_pattern)/) {
                        push @revs, $1;
                if ($line =~ m/^($sha1_pattern)/) {
                        push @revs, $1;

-                       $num -= 1;

                }
        }
        close MTNLOG || debug("mtn log exited $?");
                }
        }
        close MTNLOG || debug("mtn log exited $?");


@@ -559,8 +563,9 @@ sub rcs_recentchanges ($) { #{{{
                                        # from the changelog
                                        if ($cert->{key} eq $config{mtnkey}) {
                                                $committype = "web";
                                        # from the changelog
                                        if ($cert->{key} eq $config{mtnkey}) {
                                                $committype = "web";

-                                       } else {
-                                               $committype = "monotone";
+                                       }
+                                       else {
+                                               $committype = "mtn";

                                        }
                                } elsif ($cert->{name} eq "date") {
                                        $when = str2time($cert->{value}, 'UTC');
                                        }
                                } elsif ($cert->{name} eq "date") {
                                        $when = str2time($cert->{value}, 'UTC');


@@ -576,13 +581,12 @@ sub rcs_recentchanges ($) { #{{{
                }
                
                my @changed_files = get_changed_files($automator, $rev);
                }
                
                my @changed_files = get_changed_files($automator, $rev);

-               my $file;

                
                my ($out, $err) = $automator->call("parents", $rev);
                my @parents = ($out =~ m/^($sha1_pattern)$/);
                my $parent = $parents[0];
 
                
                my ($out, $err) = $automator->call("parents", $rev);
                my @parents = ($out =~ m/^($sha1_pattern)$/);
                my $parent = $parents[0];
 

-               foreach $file (@changed_files) {
+               foreach my $file (@changed_files) {

                        next unless length $file;
                        
                        if (defined $config{diffurl} and (@parents == 1)) {
                        next unless length $file;
                        
                        if (defined $config{diffurl} and (@parents == 1)) {


@@ -615,9 +619,9 @@ sub rcs_recentchanges ($) { #{{{
        $automator->close();
 
        return @ret;
        $automator->close();
 
        return @ret;

-} #}}}
+}

 
 

-sub rcs_diff ($) { #{{{
+sub rcs_diff ($) {

        my $rev=shift;
        my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
        
        my $rev=shift;
        my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
        


@@ -639,9 +643,9 @@ sub rcs_diff ($) { #{{{
        else {
                return join("", @lines);
        }
        else {
                return join("", @lines);
        }

-} #}}}
+}

 
 

-sub rcs_getctime ($) { #{{{
+sub rcs_getctime ($) {

        my $file=shift;
 
        chdir $config{srcdir}
        my $file=shift;
 
        chdir $config{srcdir}


@@ -691,6 +695,10 @@ sub rcs_getctime ($) { #{{{
        $date=str2time($date, 'UTC');
        debug("found ctime ".localtime($date)." for $file");
        return $date;
        $date=str2time($date, 'UTC');
        debug("found ctime ".localtime($date)." for $file");
        return $date;

-} #}}}
+}
+
+sub rcs_getmtime ($) {
+       error "rcs_getmtime is not implemented for monotone\n"; # TODO
+}

 
 1
 
 1