]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Rcs/Stub.pm
a few thoughts on data: security
[ikiwiki.git] / IkiWiki / Rcs / Stub.pm
1 #!/usr/bin/perl
2 # Stubs for no revision control.
3
4 use warnings;
5 use strict;
6 use IkiWiki;
7
8 package IkiWiki;
9
10 sub rcs_update () {
11         # Update working directory to current version.
12         # (May be more complex for distributed RCS.)
13 }
14
15 sub rcs_prepedit ($) {
16         # Prepares to edit a file under revision control. Returns a token
17         # that must be passed into rcs_commit when the file is ready
18         # for committing.
19         # The file is relative to the srcdir.
20         return ""
21 }
22
23 sub rcs_commit ($$$;$$) {
24         # Tries to commit the page; returns undef on _success_ and
25         # a version of the page with the rcs's conflict markers on failure.
26         # The file is relative to the srcdir.
27         return undef # success
28 }
29
30 sub rcs_add ($) {
31         # Add a file. The filename is relative to the root of the srcdir.
32         # Note that this should not check the new file in, it should only
33         # prepare for it to be checked in when rcs_commit is called.
34 }
35
36 sub rcs_recentchanges ($) {
37         # Examine the RCS history and generate a list of recent changes.
38         # The data structure returned for each change is:
39         # {
40         #       rev => # the RCSs id for this commit
41         #       user => # name of user who made the change,
42         #       committype => # either "web" or the name of the rcs,
43         #       when => # time when the change was made,
44         #       message => [
45         #               { line => "commit message line" },
46         #               { line => "commit message line" },
47         #               # etc,
48         #       ],
49         #       pages => [
50         #               {
51         #                       page => # name of page changed,
52         #                       diffurl => # optional url to a diff showing 
53         #                                  # the changes,
54         #               },
55         #               # repeat for each page changed in this commit,
56         #       ],
57         # }
58 }
59
60 sub rcs_getctime ($) {
61         # Optional, used to get the page creation time from the RCS.
62         error gettext("getctime not implemented");
63 }
64
65 1