2 package IkiWiki::Plugin::monotone;
8 use Date::Parse qw(str2time);
9 use Date::Format qw(time2str);
11 my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate sha1sums
14 hook(type => "checkconfig", id => "monotone", call => \&checkconfig);
15 hook(type => "getsetup", id => "monotone", call => \&getsetup);
16 hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
17 hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
18 hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
19 hook(type => "rcs", id => "rcs_commit_staged", call => \&rcs_commit_staged);
20 hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
21 hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
22 hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
23 hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
24 hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
25 hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
26 hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
30 if (!defined($config{mtnrootdir})) {
31 $config{mtnrootdir} = $config{srcdir};
33 if (! -d "$config{mtnrootdir}/_MTN") {
34 error("Ikiwiki srcdir does not seem to be a Monotone workspace (or set the mtnrootdir)!");
37 my $child = open(MTN, "-|");
39 open STDERR, ">/dev/null";
40 exec("mtn", "version") || error("mtn version failed to run");
45 if (/^monotone (\d+\.\d+) /) {
50 close MTN || debug("mtn version exited $?");
52 if (!defined($version)) {
53 error("Cannot determine monotone version");
55 if ($version < 0.38) {
56 error("Monotone version too old, is $version but required 0.38");
59 if (defined $config{mtn_wrapper} && length $config{mtn_wrapper}) {
60 push @{$config{wrappers}}, {
61 wrapper => $config{mtn_wrapper},
62 wrappermode => (defined $config{mtn_wrappermode} ? $config{mtn_wrappermode} : "06755"),
70 safe => 0, # rcs plugin
76 example => "/srv/mtn/wiki/_MTN/ikiwiki-netsync-hook",
77 description => "monotone netsync hook to generate",
84 description => "mode for mtn_wrapper (can safely be made suid)",
90 example => 'web@example.com',
91 description => "your monotone key",
97 example => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
98 description => "viewmtn url to show file history ([[file]] substituted)",
104 example => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
105 description => "viewmtn url to show a diff ([[r1]], [[r2]], and [[file]] substituted)",
112 description => "sync on update and commit?",
113 safe => 0, # paranoia
118 description => "path to your workspace (defaults to the srcdir; specify if the srcdir is a subdirectory of the workspace)",
125 my $sha1 = `mtn --root=$config{mtnrootdir} automate get_base_revision_id`;
127 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
129 debug("Unable to get base revision for '$config{srcdir}'.")
135 sub get_rev_auto ($) {
138 my @results = $automator->call("get_base_revision_id");
140 my $sha1 = $results[0];
141 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
143 debug("Unable to get base revision for '$config{srcdir}'.")
149 sub mtn_merge ($$$$) {
157 my $child = open(MTNMERGE, "-|");
159 open STDERR, ">&STDOUT";
160 exec("mtn", "--root=$config{mtnrootdir}",
161 "explicit_merge", $leftRev, $rightRev,
162 $branch, "--author", $author, "--key",
163 $config{mtnkey}) || error("mtn merge failed to run");
167 if (/^mtn.\s.merged.\s($sha1_pattern)$/) {
172 close MTNMERGE || return undef;
174 debug("merged $leftRev, $rightRev to make $mergeRev");
179 sub commit_file_to_new_rev ($$$$$$$$) {
181 my $wsfilename=shift;
183 my $newFileContents=shift;
190 my ($out, $err) = $automator->call("put_file", $oldFileID, $newFileContents);
191 my ($newFileID) = ($out =~ m/^($sha1_pattern)$/);
192 error("Failed to store file data for $wsfilename in repository")
193 if (! defined $newFileID || length $newFileID != 40);
195 # get the mtn filename rather than the workspace filename
196 ($out, $err) = $automator->call("get_corresponding_path", $oldrev, $wsfilename, $oldrev);
197 my ($filename) = ($out =~ m/^file "(.*)"$/);
198 error("Couldn't find monotone repository path for file $wsfilename") if (! $filename);
199 debug("Converted ws filename of $wsfilename to repos filename of $filename");
201 # then stick in a new revision for this file
202 my $manifest = "format_version \"1\"\n\n".
203 "new_manifest [0000000000000000000000000000000000000000]\n\n".
204 "old_revision [$oldrev]\n\n".
205 "patch \"$filename\"\n".
206 " from [$oldFileID]\n".
207 " to [$newFileID]\n";
208 ($out, $err) = $automator->call("put_revision", $manifest);
209 my ($newRevID) = ($out =~ m/^($sha1_pattern)$/);
210 error("Unable to make new monotone repository revision")
211 if (! defined $newRevID || length $newRevID != 40);
212 debug("put revision: $newRevID");
214 # now we need to add certs for this revision...
215 # author, branch, changelog, date
216 $automator->call("cert", $newRevID, "author", $author);
217 $automator->call("cert", $newRevID, "branch", $branch);
218 $automator->call("cert", $newRevID, "changelog", $message);
219 $automator->call("cert", $newRevID, "date",
220 time2str("%Y-%m-%dT%T", time, "UTC"));
222 debug("Added certs for rev: $newRevID");
226 sub read_certs ($$) {
229 my @results = $automator->call("certs", $rev);
232 my $line = $results[0];
233 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) {
246 sub get_changed_files ($$) {
250 my @results = $automator->call("get_revision", $rev);
251 my $changes=$results[0];
256 while ($changes =~ m/\s*(add_file|patch|delete|rename)\s"(.*?)(?<!\\)"\n/sg) {
258 # don't add the same file multiple times
259 if (! $seen{$file}) {
269 chdir $config{srcdir}
270 or error("Cannot chdir to $config{srcdir}: $!");
272 if (defined($config{mtnsync}) && $config{mtnsync}) {
273 if (system("mtn", "--root=$config{mtnrootdir}", "sync",
274 "--quiet", "--ticker=none",
275 "--key", $config{mtnkey}) != 0) {
276 debug("monotone sync failed before update");
280 if (system("mtn", "--root=$config{mtnrootdir}", "update", "--quiet") != 0) {
281 debug("monotone update failed");
285 sub rcs_prepedit ($) {
288 chdir $config{srcdir}
289 or error("Cannot chdir to $config{srcdir}: $!");
291 # For monotone, return the revision of the file when
296 sub rcs_commit ($$$;$$) {
297 # Tries to commit the page; returns undef on _success_ and
298 # a version of the page with the rcs's conflict markers on failure.
299 # The file is relative to the srcdir.
308 $author="Web user: " . $user;
310 elsif (defined $ipaddr) {
311 $author="Web IP: " . $ipaddr;
314 $author="Web: Anonymous";
317 chdir $config{srcdir}
318 or error("Cannot chdir to $config{srcdir}: $!");
320 my ($oldrev)= $rcstoken=~ m/^($sha1_pattern)$/; # untaint
322 if (defined $rev && defined $oldrev && $rev ne $oldrev) {
323 my $automator = Monotone->new();
324 $automator->open_args("--root", $config{mtnrootdir}, "--key", $config{mtnkey});
326 # Something has been committed, has this file changed?
328 $automator->setOpts("r", $oldrev, "r", $rev);
329 ($out, $err) = $automator->call("content_diff", $file);
330 debug("Problem committing $file") if ($err ne "");
334 # Commit a revision with just this file changed off
337 # first get the contents
338 debug("File changed: forming branch");
339 my $newfile=readfile("$config{srcdir}/$file");
341 # then get the old content ID from the diff
342 if ($diff !~ m/^---\s$file\s+($sha1_pattern)$/m) {
343 error("Unable to find previous file ID for $file");
347 # get the branch we're working in
348 ($out, $err) = $automator->call("get_option", "branch");
350 error("Illegal branch name in monotone workspace") if ($out !~ m/^([-\@\w\.]+)$/);
353 # then put the new content into the DB (and record the new content ID)
354 my $newRevID = commit_file_to_new_rev($automator, $file, $oldFileID, $newfile, $oldrev, $branch, $author, $message);
358 # if we made it to here then the file has been committed... revert the local copy
359 if (system("mtn", "--root=$config{mtnrootdir}", "revert", $file) != 0) {
360 debug("Unable to revert $file after merge on conflicted commit!");
362 debug("Divergence created! Attempting auto-merge.");
364 # see if it will merge cleanly
365 $ENV{MTN_MERGE}="fail";
366 my $mergeResult = mtn_merge($newRevID, $rev, $branch, $author);
369 # push any changes so far
370 if (defined($config{mtnsync}) && $config{mtnsync}) {
371 if (system("mtn", "--root=$config{mtnrootdir}", "push", "--quiet", "--ticker=none", "--key", $config{mtnkey}) != 0) {
372 debug("monotone push failed");
376 if (defined($mergeResult)) {
377 # everything is merged - bring outselves up to date
378 if (system("mtn", "--root=$config{mtnrootdir}",
379 "update", "-r", $mergeResult) != 0) {
380 debug("Unable to update to rev $mergeResult after merge on conflicted commit!");
384 debug("Auto-merge failed. Using diff-merge to add conflict markers.");
386 $ENV{MTN_MERGE}="diffutils";
387 $ENV{MTN_MERGE_DIFFUTILS}="partial=true";
388 $mergeResult = mtn_merge($newRevID, $rev, $branch, $author);
390 $ENV{MTN_MERGE_DIFFUTILS}="";
392 if (!defined($mergeResult)) {
393 debug("Unable to insert conflict markers!");
394 error("Your commit succeeded. Unfortunately, someone else committed something to the same ".
395 "part of the wiki at the same time. Both versions are stored in the monotone repository, ".
396 "but at present the different versions cannot be reconciled through the web interface. ".
397 "Please use the non-web interface to resolve the conflicts.");
400 if (system("mtn", "--root=$config{mtnrootdir}",
401 "update", "-r", $mergeResult) != 0) {
402 debug("Unable to update to rev $mergeResult after conflict-enhanced merge on conflicted commit!");
405 # return "conflict enhanced" file to the user
406 # for cleanup note, this relies on the fact
407 # that ikiwiki seems to call rcs_prepedit()
408 # again after we return
409 return readfile("$config{srcdir}/$file");
416 # If we reached here then the file we're looking at hasn't changed
417 # since $oldrev. Commit it.
419 if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
420 "--author", $author, "--key", $config{mtnkey}, "-m",
421 IkiWiki::possibly_foolish_untaint($message), $file) != 0) {
422 debug("Traditional commit failed! Returning data as conflict.");
423 my $conflict=readfile("$config{srcdir}/$file");
424 if (system("mtn", "--root=$config{mtnrootdir}", "revert",
425 "--quiet", $file) != 0) {
426 debug("monotone revert failed");
430 if (defined($config{mtnsync}) && $config{mtnsync}) {
431 if (system("mtn", "--root=$config{mtnrootdir}", "push",
432 "--quiet", "--ticker=none", "--key",
433 $config{mtnkey}) != 0) {
434 debug("monotone push failed");
438 return undef # success
441 sub rcs_commit_staged ($$$) {
442 # Commits all staged changes. Changes can be staged using rcs_add,
443 # rcs_remove, and rcs_rename.
444 my ($message, $user, $ipaddr)=@_;
446 # Note - this will also commit any spurious changes that happen to be
447 # lying around in the working copy. There shouldn't be any, but...
449 chdir $config{srcdir}
450 or error("Cannot chdir to $config{srcdir}: $!");
455 $author="Web user: " . $user;
457 elsif (defined $ipaddr) {
458 $author="Web IP: " . $ipaddr;
461 $author="Web: Anonymous";
464 if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
465 "--author", $author, "--key", $config{mtnkey}, "-m",
466 IkiWiki::possibly_foolish_untaint($message)) != 0) {
467 error("Monotone commit failed");
474 chdir $config{srcdir}
475 or error("Cannot chdir to $config{srcdir}: $!");
477 if (system("mtn", "--root=$config{mtnrootdir}", "add", "--quiet",
479 error("Monotone add failed");
486 chdir $config{srcdir}
487 or error("Cannot chdir to $config{srcdir}: $!");
489 # Note: it is difficult to undo a remove in Monotone at the moment.
490 # Until this is fixed, it might be better to make 'rm' move things
491 # into an attic, rather than actually remove them.
492 # To resurrect a file, you currently add a new file with the contents
493 # you want it to have. This loses all connectivity and automated
494 # merging with the 'pre-delete' versions of the file.
496 if (system("mtn", "--root=$config{mtnrootdir}", "rm", "--quiet",
498 error("Monotone remove failed");
502 sub rcs_rename ($$) {
503 my ($src, $dest) = @_;
505 chdir $config{srcdir}
506 or error("Cannot chdir to $config{srcdir}: $!");
508 if (system("mtn", "--root=$config{mtnrootdir}", "rename", "--quiet",
510 error("Monotone rename failed");
514 sub rcs_recentchanges ($) {
518 chdir $config{srcdir}
519 or error("Cannot chdir to $config{srcdir}: $!");
521 # use log --brief to get a list of revs, as this
522 # gives the results in a nice order
523 # (otherwise we'd have to do our own date sorting)
527 my $child = open(MTNLOG, "-|");
529 exec("mtn", "log", "--root=$config{mtnrootdir}", "--no-graph",
530 "--brief", "--last=$num") || error("mtn log failed to run");
533 while (my $line = <MTNLOG>) {
534 if ($line =~ m/^($sha1_pattern)/) {
538 close MTNLOG || debug("mtn log exited $?");
540 my $automator = Monotone->new();
541 $automator->open(undef, $config{mtnrootdir});
544 my $rev = shift @revs;
545 # first go through and figure out the messages, etc
547 my $certs = [read_certs($automator, $rev)];
552 my (@pages, @message);
554 foreach my $cert (@$certs) {
555 if ($cert->{signature} eq "ok" &&
556 $cert->{trust} eq "trusted") {
557 if ($cert->{name} eq "author") {
558 $user = $cert->{value};
559 # detect the source of the commit
561 if ($cert->{key} eq $config{mtnkey}) {
567 } elsif ($cert->{name} eq "date") {
568 $when = str2time($cert->{value}, 'UTC');
569 } elsif ($cert->{name} eq "changelog") {
570 my $messageText = $cert->{value};
571 # split the changelog into multiple
573 foreach my $msgline (split(/\n/, $messageText)) {
574 push @message, { line => $msgline };
580 my @changed_files = get_changed_files($automator, $rev);
582 my ($out, $err) = $automator->call("parents", $rev);
583 my @parents = ($out =~ m/^($sha1_pattern)$/);
584 my $parent = $parents[0];
586 foreach my $file (@changed_files) {
587 next unless length $file;
589 if (defined $config{diffurl} and (@parents == 1)) {
590 my $diffurl=$config{diffurl};
591 $diffurl=~s/\[\[r1\]\]/$parent/g;
592 $diffurl=~s/\[\[r2\]\]/$rev/g;
593 $diffurl=~s/\[\[file\]\]/$file/g;
595 page => pagename($file),
601 page => pagename($file),
609 committype => $committype,
611 message => [@message],
623 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
625 chdir $config{srcdir}
626 or error("Cannot chdir to $config{srcdir}: $!");
628 my $child = open(MTNDIFF, "-|");
630 exec("mtn", "diff", "--root=$config{mtnrootdir}", "-r", "p:".$sha1, "-r", $sha1) || error("mtn diff $sha1 failed to run");
633 my (@lines) = <MTNDIFF>;
635 close MTNDIFF || debug("mtn diff $sha1 exited $?");
641 return join("", @lines);
645 sub rcs_getctime ($) {
648 chdir $config{srcdir}
649 or error("Cannot chdir to $config{srcdir}: $!");
651 my $child = open(MTNLOG, "-|");
653 exec("mtn", "log", "--root=$config{mtnrootdir}", "--no-graph",
654 "--brief", $file) || error("mtn log $file failed to run");
659 if (/^($sha1_pattern)/) {
663 close MTNLOG || debug("mtn log $file exited $?");
665 if (! defined $firstRev) {
666 debug "failed to parse mtn log for $file";
670 my $automator = Monotone->new();
671 $automator->open(undef, $config{mtnrootdir});
673 my $certs = [read_certs($automator, $firstRev)];
679 foreach my $cert (@$certs) {
680 if ($cert->{signature} eq "ok" && $cert->{trust} eq "trusted") {
681 if ($cert->{name} eq "date") {
682 $date = $cert->{value};
687 if (! defined $date) {
688 debug "failed to find date cert for revision $firstRev when looking for creation time of $file";
692 $date=str2time($date, 'UTC');
693 debug("found ctime ".localtime($date)." for $file");
697 sub rcs_getmtime ($) {
698 error "rcs_getmtime is not implemented for monotone\n"; # TODO