doc/plugins/contrib/cvs/discussion.mdwn

   1 I've started reviewing this, and the main thing I don't like is the
   2 post-commit wrapper wrapper that ikiwiki-makerepo is patched to set up.
   3 That just seems unnecessarily complicated. Why can't ikiwiki itself detect
   4 the "cvs add <directory>" call and avoid doing anything in that case?
   5 --[[Joey]]
   6
   7 > The wrapper wrapper does three things:
   8 >
   9 > 7. It ignores `cvs add <directory>`, since this is a weird CVS
  10 > behavior that ikiwiki gets confused by and doesn't need to act on.
  11 > 7. It prevents `cvs` locking against itself: `cvs commit` takes a
  12 > write lock and runs the post-commit hook, which runs `cvs update`,
  13 > which wants a read lock and sleeps forever -- unless the post-commit
  14 > hook runs in the background so the commit can "finish".
  15 > 7. It fails silently if the ikiwiki post-commit hook is missing.
  16 > CVS doesn't have any magic post-commit filenames, so hooks have to
  17 > be configured explicitly. I don't think a commit will actually fail
  18 > if a configured post-commit hook is missing (though I can't test
  19 > this at the moment).
  20 >
  21 > Thing 1 can probably be handled within ikiwiki, if that seems less
  22 > gross to you.
  23
  24 >> It seems like it might be. You can use a `getopt` hook to check
  25 >> `@ARGV` to see how it was called. --[[Joey]]
  26
  27 >>> This does the trick iff the post-commit wrapper passes its args
  28 >>> along. Committed on my branch. This seems potentially dangerous,
  29 >>> since the args passed to ikiwiki are influenced by web commits.
  30 >>> I don't see an exploit, but for paranoia's sake, maybe the wrapper
  31 >>> should only be built with execv() if the cvs plugin is loaded?
  32 >>> --[[schmonz]]
  33
  34 > Thing 2 I'm less sure of. (I'd like to see the web UI return
  35 > immediately on save anyway, to a temporary "rebuilding, please wait
  36 > if you feel like knowing when it's done" page, but this problem
  37 > with CVS happens with any kind of commit, and could conceivably
  38 > happen with some other VCS.)
  39
  40 >> None of the other VCSes let a write lock block a read lock, apparently.
  41 >>
  42 >> Anyway, re the backgrounding, when committing via the web, the
  43 >> post-commit hook doesn't run anyway; the rendering is done via the
  44 >> ikiwiki CGI. It would certianly be nice if it popped up a quick "working"
  45 >> page and replaced it with the updated page when done, but that's
  46 >> unrelated;  the post-commit
  47 >> hook only does rendering when committing using the VCS directly. The
  48 >> backgrounding you do actually seems safe enough -- but tacking
  49 >> on a " &" to the ikiwiki wrapper call doesn't need a wrapper script,
  50 >> does it? --[[Joey]]
  51
  52 >>> Nope, it works fine to append it to the `CVSROOT/loginfo` line.
  53 >>> Fixed on my branch. --[[schmonz]]
  54
  55 > Thing 3 I think I did in order to squelch the error messages that
  56 > were bollixing up the CGI. It was easy to do this in the wrapper
  57 > wrapper, but if that's going away, it can be done just as easily
  58 > with output redirection in `CVSROOT/loginfo`.
  59 >
  60 > --[[schmonz]]
  61
  62 >> If the error messages screw up the CGI they must go to stdout.
  63 >> I thought we had stderr even in the the CVS dark ages. ;-) --[[Joey]]
  64
  65 >>> Some messages go to stderr, but definitely not all. That's why
  66 >>> I wound up reaching for IPC::Cmd, to execute the command line
  67 >>> safely while shutting CVS up. Anyway, I've tested what happens
  68 >>> if a configured post-commit hook is missing, and it seems fine,
  69 >>> probably also thanks to IPC::Cmd.
  70 >>> --[[schmonz]]