Added upload_document managment command.
[redakcja.git] / lib / wlrepo / mercurial_backend / library.py
1 # -*- encoding: utf-8 -*-
2
3 __author__= "Ɓukasz Rekucki"
4 __date__ = "$2009-09-25 09:33:02$"
5 __doc__ = "Module documentation."
6
7 import mercurial
8 from mercurial import localrepo as hglrepo
9 from mercurial import ui as hgui
10 from mercurial import error
11 import wlrepo
12
13 from wlrepo.mercurial_backend.document import MercurialDocument
14 from wlrepo.mercurial_backend import MercurialRevision
15
16 class MergeStatus(object):
17     def __init__(self, mstatus):
18         self.updated = mstatus[0]
19         self.merged = mstatus[1]
20         self.removed = mstatus[2]
21         self.unresolved = mstatus[3]
22
23     def isclean(self):
24         return self.unresolved == 0
25
26 class UpdateStatus(object):
27
28     def __init__(self, mstatus):
29         self.modified = mstatus[0]
30         self.added = mstatus[1]
31         self.removed = mstatus[2]
32         self.deleted = mstatus[3]
33         self.untracked = mstatus[4]
34         self.ignored = mstatus[5]
35         self.clean = mstatus[6]
36
37     def has_changes(self):
38         return bool(len(self.modified) + len(self.added) + \
39                     len(self.removed) + len(self.deleted))
40
41 class MercurialLibrary(wlrepo.Library):
42     """Mercurial implementation of the Library API"""
43
44     def __init__(self, path, **kwargs):
45         super(wlrepo.Library, self).__init__( ** kwargs)
46
47         self._revcache = {}
48         self._doccache = {}
49
50         self._hgui = hgui.ui()
51         self._hgui.config('ui', 'quiet', 'true')
52         self._hgui.config('ui', 'interactive', 'false')
53
54         import os.path
55         self._ospath = self._sanitize_string(os.path.realpath(path))        
56
57         if os.path.isdir(path):
58             try:
59                 self._hgrepo = hglrepo.localrepository(self._hgui, path)
60             except mercurial.error.RepoError:
61                 raise wlrepo.LibraryException("[HGLibrary] Not a valid repository at path '%s'." % path)
62         elif kwargs.get('create', False):
63             os.makedirs(path)
64             try:
65                 self._hgrepo = hglrepo.localrepository(self._hgui, path, create=1)
66             except mercurial.error.RepoError:
67                 raise wlrepo.LibraryException("[HGLibrary] Can't create a repository on path '%s'." % path)
68         else:
69             raise wlrepo.LibraryException("[HGLibrary] Can't open a library on path '%s'." % path)
70
71
72     def documents(self):
73         return [ key[5:] for key in \
74             self._hgrepo.branchmap() if key.startswith("$doc:") ]
75
76     @property
77     def ospath(self):
78         return self._ospath
79
80     def document_for_rev(self, revision):
81         if revision is None:
82             raise ValueError("Revision can't be None.")
83         
84         if not isinstance(revision, MercurialRevision):
85             rev = self.get_revision(revision)
86         else:
87             rev = revision       
88
89         if not self._doccache.has_key(str(rev)):
90             self._doccache[str(rev)] = MercurialDocument(self, rev)
91
92         # every revision is a document
93         return self._doccache[str(rev)]
94
95     def document(self, docid, user=None):       
96         return self.document_for_rev(self.fulldocid(docid, user))
97
98     def get_revision(self, revid):
99         revid = self._sanitize_string(revid)
100         
101         ctx = self._changectx(revid)
102
103         if ctx is None:
104             raise RevisionNotFound(revid)
105
106         if self._revcache.has_key(ctx):
107             return self._revcache[ctx]
108
109         return MercurialRevision(self, ctx)
110
111     def fulldocid(self, docid, user=None):
112         docid = self._sanitize_string(docid)
113         user = self._sanitize_string(user)
114         
115         fulldocid = ''
116         if user is not None:
117             fulldocid += '$user:' + user
118         fulldocid += '$doc:' + docid
119         return fulldocid
120
121
122     def has_revision(self, revid):
123         try:
124             self._hgrepo[revid]
125             return True
126         except error.RepoError:
127             return False
128
129     def document_create(self, docid):
130         docid = self._sanitize_string(docid)
131         
132         # check if it already exists
133         fullid = self.fulldocid(docid)
134
135         if self.has_revision(fullid):
136             raise wlrepo.DocumentAlreadyExists("Document %s already exists!" % docid);
137
138         # doesn't exist
139         self._create_branch(fullid)
140         return self.document_for_rev(fullid)
141
142     #
143     # Private methods
144     #
145
146     #
147     # Locking
148     #
149
150     def lock(self, write_mode=False):
151         return self._hgrepo.wlock() # no support for read/write mode yet
152
153     def _transaction(self, write_mode, action):
154         lock = self.lock(write_mode)
155         try:
156             return action(self)
157         finally:
158             lock.release()
159
160     #
161     # Basic repo manipulation
162     #
163
164     def _checkout(self, rev, force=True):
165         return MergeStatus(mercurial.merge.update(self._hgrepo, rev, False, force, None))
166
167     def _merge(self, rev):
168         """ Merge the revision into current working directory """
169         return MergeStatus(mercurial.merge.update(self._hgrepo, rev, True, False, None))
170
171     def _common_ancestor(self, revA, revB):
172         return self._hgrepo[revA].ancestor(self.repo[revB])
173
174     def _commit(self, message, user=u"library"):
175         return self._hgrepo.commit(text=message, user=user)
176
177
178     def _fileexists(self, fileid):
179         return (fileid in self._hgrepo[None])
180
181     def _fileadd(self, fileid):
182         return self._hgrepo.add([fileid])
183
184     def _filesadd(self, fileid_list):
185         return self._hgrepo.add(fileid_list)
186
187     def _filerm(self, fileid):
188         return self._hgrepo.remove([fileid])
189
190     def _filesrm(self, fileid_list):
191         return self._hgrepo.remove(fileid_list)   
192
193     def _fileopen(self, path, mode):
194         return self._hgrepo.wopener(path, mode)
195
196     def _filectx(self, fileid, revid):
197         return self._hgrepo.filectx(fileid, changeid=revid)
198
199     def _changectx(self, nodeid):
200         return self._hgrepo.changectx(nodeid)
201
202     def _rollback(self):
203         return self._hgrepo.rollback()
204
205     #
206     # BASIC BRANCH routines
207     #
208
209     def _bname(self, user, docid):
210         """Returns a branch name for a given document and user."""
211         docid = self._sanitize_string(docid)
212         uname = self._sanitize_string(user)
213         return "personal_" + uname + "_file_" + docid;
214
215     def _has_branch(self, name):
216         return self._hgrepo.branchmap().has_key(self._sanitize_string(name))
217
218     def _branch_tip(self, name):
219         name = self._sanitize_string(name)
220         return self._hgrepo.branchtags()[name]    
221
222     def _create_branch(self, name, parent=None, before_commit=None):
223         name = self._sanitize_string(name)
224
225         if self._has_branch(name): return # just exit
226
227         if parent is None:
228             parentrev = self._hgrepo['$branchbase'].node()
229         else:
230             parentrev = parent.hgrev()
231
232         self._checkout(parentrev)
233         self._hgrepo.dirstate.setbranch(name)
234
235         if before_commit: before_commit(self)
236
237         self._commit("$ADMN$ Initial commit for branch '%s'." % name, user='$library')        
238
239     def _switch_to_branch(self, branchname):
240         current = self._hgrepo[None].branch()
241
242         if current == branchname:
243             return current # quick exit
244
245         self._checkout(self._branch_tip(branchname))
246         return branchname    
247
248     #
249     # Utils
250     #
251
252     @staticmethod
253     def _sanitize_string(s):
254         if s is None:
255             return None
256
257         if isinstance(s, unicode):
258             s = s.encode('utf-8')
259
260         if ' ' in s:
261             raise ValueError('Whitespace is forbidden!')
262
263         return s