4f4337c388e08fda72448e82acfdd171a24bad73
[ikiwiki.git] / doc / patchqueue / darcs.mdwn
1 Here's Thomas Schwinge unfinished darcs support for ikiwiki.
2
3 (Finishing this has been succested as a [[soc]] project.)
4
5 > I haven't been working on this for months and also won't in the near
6 > future.  Feel free to use what I have done so
7 > far and bring it into an usable state!  Also, feel free to contact me
8 >  if there are questions.
9
10 -- [Thomas Schwinge](mailto:tschwinge@gnu.org)
11
12         # Support for the darcs rcs, <URL:http://darcs.net/>.
13         # Copyright (C) 2006  Thomas Schwinge <tschwinge@gnu.org>
14         #
15         # This program is free software; you can redistribute it and/or modify it
16         # under the terms of the GNU General Public License as published by the
17         # Free Software Foundation; either version 2 of the License, or (at your
18         # option) any later version.
19         #
20         # This program is distributed in the hope that it will be useful, but
21         # WITHOUT ANY WARRANTY; without even the implied warranty of
22         # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23         # General Public License for more details.
24         #
25         # You should have received a copy of the GNU General Public License along
26         # with this program; if not, write to the Free Software Foundation, Inc.,
27         # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28         
29         
30         # We're guaranteed to be the only instance of ikiwiki running at a given
31         # time.  It is essential that only ikiwiki is working on a particular
32         # repository.  That means one instance of ikiwiki and it also means that
33         # you must not `darcs push' into this repository, as this might create
34         # race conditions, as I understand it.
35         
36         
37         use warnings;
38         use strict;
39         use IkiWiki;
40         
41         package IkiWiki;
42         
43         
44         # Which darcs executable to use.
45         my $darcs = ($ENV{DARCS} or 'darcs');
46         
47         
48         # Internal functions.
49         
50         sub darcs_info ($$$) {
51             my $field = shift;
52             my $repodir = shift;
53             my $file = shift; # Relative to the repodir.
54         
55             my $child = open(DARCS_CHANGES, "-|");
56             if (! $child) {
57                 exec($darcs, 'changes', '--repo=' . $repodir, '--xml-output', $file) or
58                     error('failed to run `darcs changes\'');
59             }
60         
61             # Brute force for now.  :-/
62             while (<DARCS_CHANGES>) {
63                 last if /^<\/created_as>$/;
64             }
65             ($_) = <DARCS_CHANGES> =~ /$field=\'([^\']+)/;
66             $field eq 'hash' and s/\.gz//; # Strip away the `.gz' from `hash'es.
67         
68             close(DARCS_CHANGES) or error('`darcs changes\' exited ' . $?);
69         
70             return $_;
71         }
72         
73         
74         # Exported functions.
75         
76         sub rcs_update () {
77             # Not needed.
78         }
79         
80         sub rcs_prepedit ($) {
81             # Prepares to edit a file under revision control.  Returns a token that
82             # must be passed to rcs_commit() when the file is to be commited.  For us,
83             # this token the hash value of the latest patch that modifies the file,
84             # i.e. something like its current revision.  If the file is not yet added
85             # to the repository, we return TODO: the empty string.
86         
87             my $file = shift; # Relative to the repodir.
88         
89             my $hash = darcs_info('hash', $config{srcdir}, $file);
90             return defined $hash ? $hash : "";
91         }
92         
93         sub rcs_commit ($$$) {
94             # Commit the page.  Returns `undef' on success and a version of the page
95             # with conflict markers on failure.
96         
97             my $file = shift; # Relative to the repodir.
98             my $message = shift;
99             my $rcstoken = shift;
100         
101             # Compute if the ``revision'' of $file changed.
102             my $changed = darcs_info('hash', $config{srcdir}, $file) ne $rcstoken;
103         
104             # Yes, the following is a bit convoluted.
105             if ($changed) {
106                 # TODO.  Invent a better, non-conflicting name.
107                 rename("$config{srcdir}/$file", "$config{srcdir}/$file.save") or
108                     error("failed to rename $file to $file.save: $!");
109         
110                 # Roll the repository back to $rcstoken.
111         
112                 # TODO.  Can we be sure that no changes are lost?  I think that
113                 # we can, if we make sure that the `darcs push' below will always
114                 # succeed.
115         
116                 # We need to revert everything as `darcs obliterate' might choke
117                 # otherwise.
118                 # TODO: `yes | ...' needed?  Doesn't seem so.
119                 system($darcs, "revert", "--repodir=" . $config{srcdir}, "--all") and
120                     error("`darcs revert' failed");
121                 # Remove all patches starting at $rcstoken.
122                 # TODO.  Something like `yes | darcs obliterate ...' seems to be needed.
123                 system($darcs, "obliterate", "--quiet", "--repodir" . $config{srcdir},
124                        "--match", "hash " . $rcstoken) and
125                            error("`darcs obliterate' failed");
126                 # Restore the $rcstoken one.
127                 system($darcs, "pull", "--quiet", "--repodir=" . $config{srcdir},
128                        "--match", "hash " . $rcstoken, "--all") and
129                            error("`darcs pull' failed");
130         
131                 # We're back at $rcstoken.  Re-install the modified file.
132                 rename("$config{srcdir}/$file.save", "$config{srcdir}/$file") or
133                     error("failed to rename $file.save to $file: $!");
134             }
135         
136             # Record the changes.
137             # TODO: What if $message is empty?
138             writefile("$file.log", $config{srcdir}, $message);
139             system($darcs, 'record', '--repodir=' . $config{srcdir}, '--all',
140                    '--logfile=' . "$config{srcdir}/$file.log",
141                    '--author=' . 'web commit <web-hurd@gnu.org>', $file) and
142                        error('`darcs record\' failed');
143         
144             # Update the repository by pulling from the default repository, which is
145             # master repository.
146             system($darcs, "pull", "--quiet", "--repodir=" . $config{srcdir},
147                    "--all") and error("`darcs pull' failed\n");
148         
149             # If this updating yields any conflicts, we'll record them now to resolve
150             # them.  If nothing is recorded, there are no conflicts.
151             $rcstoken = darcs_info('hash', $config{srcdir}, $file);
152             # TODO: Use only the first line here, i.e. only the patch name?
153             writefile("$file.log", $config{srcdir}, 'resolve conflicts: ' . $message);
154             system($darcs, 'record', '--repodir=' . $config{srcdir}, '--all',
155                    '--logfile=' . "$config{srcdir}/$file.log",
156                    '--author=' . 'web commit <web-hurd@gnu.org>', $file) and
157                        error('`darcs record\' failed');
158             my $conflicts = darcs_info('hash', $config{srcdir}, $file) ne $rcstoken;
159             unlink("$config{srcdir}/$file.log") or
160                 error("failed to remove `$file.log'");
161         
162             # Push the changes to the main repository.
163             system($darcs, 'push', '--quiet', '--repodir=' . $config{srcdir}, '--all')
164                 and error('`darcs push\' failed');
165             # TODO: darcs send?
166         
167             if ($conflicts) {
168                 my $document = readfile("$config{srcdir}/$file");
169                 # Try to leave everything in a consistent state.
170                 # TODO: `yes | ...' needed?  Doesn't seem so.
171                 system($darcs, "revert", "--repodir=" . $config{srcdir}, "--all") and
172                     warn("`darcs revert' failed.\n");
173                 return $document;
174             } else {
175                 return undef;
176             }
177         }
178         
179         sub rcs_add ($) {
180             my $file = shift; # Relative to the repodir.
181         
182             # Intermediate directories will be added automagically.
183             system($darcs, 'add', '--quiet', '--repodir=' . $config{srcdir},
184                    '--boring', $file) and error('`darcs add\' failed');
185         }
186         
187         sub rcs_recentchanges ($) {
188             warn('rcs_recentchanges() is not implemented');
189             return 'rcs_recentchanges() is not implemented';
190         }
191         
192         sub rcs_notify () {
193             warn('rcs_notify() is not implemented');
194         }
195         
196         sub rcs_getctime () {
197             warn('rcs_getctime() is not implemented');
198         }
199         
200         1