]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/bugs/Monotone_rcs_support.mdwn
web commit by http://willu.myopenid.com/: Add patch to fix a security FIXME
[ikiwiki.git] / doc / bugs / Monotone_rcs_support.mdwn
index fcf3b0d109f167875c42a2395f27ed7c297a7234..116939722184bc685fd251dedcec78d71f57a40b 100644 (file)
@@ -1,10 +1,97 @@
 #Ikiwiki plugin for the Monotone revision control system.
 
-I've just made a patch to the ikiwiki code that allows it to use the [Monotone](http://monotone.ca/) revision control system.  It is available at:
+I've just made a patch to the ikiwiki code that allows it to use the [[rcs/Monotone]] revision control system.  It is available at:
 
 <http://www.cse.unsw.edu.au/~willu/monotone-ikiwiki.diff>
 
-At the moment it supports basic committing and listing recent changes.  It does not support rcs_notify() or rcs_getctime() yet.  Moreover,
-while there is support for simultaneous commits (e.g. conflicts), it is untested and if it happens to work would leave the repository in an unmerged state.
+At the moment it is basically complete.  At present rcs_notify() is implemeted but untested, the rest is implemented and tested.
 
-But it is better than nothing.
+The current version of the patch handles conflicts through the web interface.  It is still not perfect as it will break if there is a rename that conflicts with a web change (but so will the other Rcs plugins I think).  It also commits a revision with conflict markers if there is a conflict requiring such markers... ick.
+
+Note: This patch requires a rather recent Monotone perl module (18 August 2007 or later).  It is available from the monotone repository here: <http://viewmtn.angrygoats.net/branch/changes/net.venge.monotone>.
+
+> The setup instructions to add 40 lines of code to monotonerc is pretty frightning stuff.
+> Is there some way this can be automated? --[[Joey]]
+
+>> I've committed a bunch of this to monotone so that in future it could be removed.
+>> I've also just fixed this so it is in a separate, automagically generated, rc file.
+
+>>> Fair enough. Didn't realize you were a monotone committer. :-)
+
+>>>> I am, but still a little newish.  Feedback is good.  In particular, this is my first major bit of PERL.
+
+> Having rcs_commit return a warning message when there's an unresolved conflict
+> isn't right; that message will populate the page edit box. You might want
+> to use the error() function here?
+
+>> It should never reach that case, so I have changed that to error.
+
+> There'an incomplete comment ending with "note, this relies on the fact that"
+
+>> erg... sorry, fixed.
+
+[[tag patch]]
+
+>> I've [[accepted|done]] this patch, thank you! 
+
+>>> Thanks for committing it.  I hate keeping my own diffs. :)
+
+>> I did make a few changes. Please review, and make sure it still works
+>> (a test case like we have for some of the other RCSes would be nice..)
+
+>>> Tested.  It still works at least as well as it did.  I'll try to get to a test case soon.
+>>> In checking the source I noticed a few bogus comments I left in when editing,
+>>> and a bug in page adding.
+>>> Here is a small patch for them:
+
+>>>> applied
+
+Here is another patch.  It fixes a FIXME you added.  I was using $file within backticks because
+I was getting an error trying to do it right.  I've figured out the error, and now do it right.  This
+should also speed things up (very slightly)
+
+    Index: IkiWiki/Rcs/monotone.pm
+    ===================================================================
+    --- IkiWiki/Rcs/monotone.pm        (revision 4234)
+    +++ IkiWiki/Rcs/monotone.pm        (working copy)
+    @@ -239,17 +239,11 @@
+     
+               # Something has been committed, has this file changed?
+               my ($out, $err);
+    -          #$automator->setOpts("-r", $oldrev, "-r", $rev);
+    -          #my ($out, $err) = $automator->call("content_diff", $file);
+    -          #debug("Problem committing $file") if ($err ne "");
+    -          # FIXME: use of $file in these backticks is not wise from a
+    -          # security POV. Probably safe, but should be avoided
+    -          # anyway.
+    -          # At the moment the backticks are used because the above call using the automate
+    -          # interface was failing.  When that bug in monotone is fixed, we should switch
+    -          # back.
+    -          my $diff = `mtn --root=$config{mtnrootdir} au content_diff -r $oldrev -r $rev $file`; # was just $out;
+    -
+    +          $automator->setOpts("r", $oldrev, "r", $rev);
+    +          ($out, $err) = $automator->call("content_diff", $file);
+    +          debug("Problem committing $file") if ($err ne "");
+    +          my $diff = $out;
+    +          
+               if ($diff) {
+                       # Commit a revision with just this file changed off
+                       # the old revision.
+
+
+>> BTW, will all the monotone output parsing work if LANG != C?
+
+>>> It should (he says crossing fingers).
+>>> In the places where I do any complex parsing I'm using a special
+>>> version of the mtn commands designed for scripting.  They have a
+>>> stable, easy to parse, output that doesn't get translated (I think).
+
+>> Do monotone post-commit hooks actually use REV?
+
+>>> Monotone post-commit hooks are written in Lua and can do
+>>> what they please.  Setting the REV environment var before
+>>> calling Ikiwiki seems reasonable, but I've not written the
+>>> Lua hook.
+
+>>>> So the rcs_notify support is not just untested, but can't work
+>>>> at all w/o further development.