lib/vstorage/__init__.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # This file is part of FNP-Redakcja, licensed under GNU Affero GPLv3 or later.
   4 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   5 #
   6 import os
   7 import tempfile
   8 import datetime
   9 import mimetypes
  10 import urllib
  11 import functools
  12
  13 import logging
  14 logger = logging.getLogger('fnp.hazlenut.vstorage')
  15
  16 # Note: we have to set these before importing Mercurial
  17 os.environ['HGENCODING'] = 'utf-8'
  18 os.environ['HGMERGE'] = "internal:merge"
  19
  20 import mercurial.hg
  21 import mercurial.revlog
  22 import mercurial.util
  23
  24 from vstorage.hgui import SilentUI
  25
  26
  27 def urlquote(url, safe='/'):
  28     """Quotes URL
  29
  30     >>> urlquote(u'Za\u017c\xf3\u0142\u0107 g\u0119\u015bl\u0105 ja\u017a\u0144')
  31     'Za%C5%BC%C3%B3%C5%82%C4%87%20g%C4%99%C5%9Bl%C4%85%20ja%C5%BA%C5%84'
  32     """
  33     return urllib.quote(url.encode('utf-8', 'ignore'), safe)
  34
  35
  36 def urlunquote(url):
  37     """Unqotes URL
  38
  39     # >>> urlunquote('Za%C5%BC%C3%B3%C5%82%C4%87_g%C4%99%C5%9Bl%C4%85_ja%C5%BA%C5%84')
  40     # u'Za\u017c\xf3\u0142\u0107_g\u0119\u015bl\u0105 ja\u017a\u0144'
  41     """
  42     return unicode(urllib.unquote(url), 'utf-8', 'ignore')
  43
  44
  45 def find_repo_path(path):
  46     """Go up the directory tree looking for a Mercurial repository (a directory containing a .hg subdirectory)."""
  47     while not os.path.isdir(os.path.join(path, ".hg")):
  48         old_path, path = path, os.path.dirname(path)
  49         if path == old_path:
  50             return None
  51     return path
  52
  53
  54 def with_working_copy_locked(func):
  55     """A decorator for locking the repository when calling a method."""
  56
  57     @functools.wraps(func)
  58     def wrapped(self, *args, **kwargs):
  59         """Wrap the original function in locks."""
  60         wlock = self.repo.wlock()
  61         try:
  62             return func(self, *args, **kwargs)
  63         finally:
  64             wlock.release()
  65     return wrapped
  66
  67
  68 def with_storage_locked(func):
  69     """A decorator for locking the repository when calling a method."""
  70
  71     @functools.wraps(func)
  72     def wrapped(self, *args, **kwargs):
  73         """Wrap the original function in locks."""
  74         lock = self.repo.lock()
  75         try:
  76             return func(self, *args, **kwargs)
  77         finally:
  78             lock.release()
  79     return wrapped
  80
  81
  82 def guess_mime(file_name):
  83     """
  84     Guess file's mime type based on extension.
  85     Default of text/x-wiki for files without an extension.
  86
  87     >>> guess_mime('something.txt')
  88     'text/plain'
  89     >>> guess_mime('SomePage')
  90     'text/x-wiki'
  91     >>> guess_mime(u'ąęśUnicodePage')
  92     'text/x-wiki'
  93     >>> guess_mime('image.png')
  94     'image/png'
  95     >>> guess_mime('style.css')
  96     'text/css'
  97     >>> guess_mime('archive.tar.gz')
  98     'archive/gzip'
  99     """
 100
 101     mime, encoding = mimetypes.guess_type(file_name, strict=False)
 102     if encoding:
 103         mime = 'archive/%s' % encoding
 104     if mime is None:
 105         mime = 'text/x-wiki'
 106     return mime
 107
 108
 109 class DocumentNotFound(Exception):
 110     pass
 111
 112
 113 class VersionedStorage(object):
 114     """
 115     Provides means of storing text pages and keeping track of their
 116     change history, using Mercurial repository as the storage method.
 117     """
 118
 119     def __init__(self, path, charset=None):
 120         """
 121         Takes the path to the directory where the pages are to be kept.
 122         If the directory doen't exist, it will be created. If it's inside
 123         a Mercurial repository, that repository will be used, otherwise
 124         a new repository will be created in it.
 125         """
 126
 127         self.charset = charset or 'utf-8'
 128         self.path = path
 129         if not os.path.exists(self.path):
 130             os.makedirs(self.path)
 131         self.repo_path = find_repo_path(self.path)
 132
 133         self.ui = SilentUI()
 134
 135         if self.repo_path is None:
 136             self.repo_path = self.path
 137             create = True
 138         else:
 139             create = False
 140
 141         self.repo_prefix = self.path[len(self.repo_path):].strip('/')
 142         self.repo = mercurial.hg.repository(self.ui, self.repo_path,
 143                                             create=create)
 144
 145     def reopen(self):
 146         """Close and reopen the repo, to make sure we are up to date."""
 147         self.repo = mercurial.hg.repository(self.ui, self.repo_path)
 148
 149     def _file_path(self, title, type='.xml'):
 150         return os.path.join(self.path, urlquote(title, safe='')) + type
 151
 152     def _title_to_file(self, title, type=".xml"):
 153         return os.path.join(self.repo_prefix, urlquote(title, safe='')) + type
 154
 155     def _file_to_title(self, filename):
 156         assert filename.startswith(self.repo_prefix)
 157         name = filename[len(self.repo_prefix):].strip('/').split('.', 1)[0]
 158         return urlunquote(name)
 159
 160     def __contains__(self, title):
 161         return self._title_to_file(title) in self.repo['tip']
 162
 163     def __iter__(self):
 164         return self.all_pages()
 165
 166     def merge_changes(self, changectx, repo_file, text, user, parent):
 167         """Commits and merges conflicting changes in the repository."""
 168         tip_node = changectx.node()
 169         filectx = changectx[repo_file].filectx(parent)
 170         parent_node = filectx.changectx().node()
 171
 172         self.repo.dirstate.setparents(parent_node)
 173         node = self._commit([repo_file], text, user)
 174
 175         partial = lambda filename: repo_file == filename
 176
 177         # If p1 is equal to p2, there is no work to do. Even the dirstate is correct.
 178         p1, p2 = self.repo[None].parents()[0], self.repo[tip_node]
 179         if p1 == p2:
 180             return text
 181
 182         try:
 183             mercurial.merge.update(self.repo, tip_node, True, False, partial)
 184             msg = 'merge of edit conflict'
 185         except mercurial.util.Abort:
 186             msg = 'failed merge of edit conflict'
 187
 188         self.repo.dirstate.setparents(tip_node, node)
 189         # Mercurial 1.1 and later need updating the merge state
 190         try:
 191             mercurial.merge.mergestate(self.repo).mark(repo_file, "r")
 192         except (AttributeError, KeyError):
 193             pass
 194         return msg
 195
 196     @with_working_copy_locked
 197     @with_storage_locked
 198     def save_file(self, title, file_name, **kwargs):
 199         """Save an existing file as specified page."""
 200
 201         author = kwargs.get('author', u'anonymous').encode('utf-8')
 202         comment = kwargs.get('comment', u'Empty comment.').encode('utf-8')
 203         parent = kwargs.get('parent', None)
 204
 205         repo_file = self._title_to_file(title)
 206         file_path = self._file_path(title)
 207         mercurial.util.rename(file_name, file_path)
 208         changectx = self._changectx()
 209
 210         try:
 211             filectx_tip = changectx[repo_file]
 212             current_page_rev = filectx_tip.filerev()
 213         except mercurial.revlog.LookupError:
 214             self.repo.add([repo_file])
 215             current_page_rev = -1
 216
 217         if parent is not None and current_page_rev != parent:
 218             msg = self.merge_changes(changectx, repo_file, comment, author, parent)
 219             author = '<wiki>'
 220             comment = msg.encode('utf-8')
 221
 222         logger.debug("Commiting %r", repo_file)
 223
 224         self._commit([repo_file], comment, author)
 225
 226     def save_data(self, title, data, **kwargs):
 227         """Save data as specified page."""
 228         try:
 229             temp_path = tempfile.mkdtemp(dir=self.path)
 230             file_path = os.path.join(temp_path, 'saved')
 231             f = open(file_path, "wb")
 232             f.write(data)
 233             f.close()
 234
 235             return self.save_file(title=title, file_name=file_path, **kwargs)
 236         finally:
 237             try:
 238                 os.unlink(file_path)
 239             except OSError:
 240                 pass
 241             try:
 242                 os.rmdir(temp_path)
 243             except OSError:
 244                 pass
 245
 246     def save_text(self, **kwargs):
 247         """Save text as specified page, encoded to charset."""
 248         text = kwargs.pop('text')
 249         return self.save_data(data=text.encode(self.charset), **kwargs)
 250
 251     def _commit(self, files, comment, user):
 252         match = mercurial.match.exact(self.repo_path, '', list(files))
 253         return self.repo.commit(match=match, text=comment, user=user, force=True)
 254
 255     @with_working_copy_locked
 256     @with_storage_locked
 257     def delete_page(self, title, author=u'', comment=u''):
 258         user = author.encode('utf-8') or 'anon'
 259         text = comment.encode('utf-8') or 'deleted'
 260         repo_file = self._title_to_file(title)
 261         file_path = self._file_path(title)
 262         try:
 263             os.unlink(file_path)
 264         except OSError:
 265             pass
 266         self.repo.remove([repo_file])
 267         self._commit([repo_file], text, user)
 268
 269     def page_text(self, title, revision=None):
 270         """Read unicode text of a page."""
 271         ctx = self._find_filectx(title, revision)
 272
 273         if ctx is None:
 274             raise DocumentNotFound(title)
 275
 276         return ctx.data().decode(self.charset, 'replace'), ctx.filerev()
 277
 278     def page_text_by_tag(self, title, tag):
 279         """Read unicode text of a taged page."""
 280         fname = self._title_to_file(title)
 281         tag = u"{fname}#{tag}".format(**locals()).encode('utf-8')
 282
 283         try:
 284             ctx = self.repo[tag][fname]
 285             return ctx.data().decode(self.charset, 'replace'), ctx.filerev()
 286         except IndexError:
 287             raise DocumentNotFound(fname)
 288
 289     @with_working_copy_locked
 290     def page_file_meta(self, title):
 291         """Get page's inode number, size and last modification time."""
 292         try:
 293             (_st_mode, st_ino, _st_dev, _st_nlink, _st_uid, _st_gid, st_size,
 294              _st_atime, st_mtime, _st_ctime) = os.stat(self._file_path(title))
 295         except OSError:
 296             return 0, 0, 0
 297         return st_ino, st_size, st_mtime
 298
 299     @with_working_copy_locked
 300     def page_meta(self, title, revision=None):
 301         """Get page's revision, date, last editor and his edit comment."""
 302         fctx = self._find_filectx(title, revision)
 303
 304         if fctx is None:
 305             raise DocumentNotFound(title)
 306
 307         return {
 308             "revision": fctx.filerev(),
 309             "date": datetime.datetime.fromtimestamp(fctx.date()[0]),
 310             "author": fctx.user().decode("utf-8", 'replace'),
 311             "comment": fctx.description().decode("utf-8", 'replace'),
 312         }
 313
 314     def repo_revision(self):
 315         return self.repo['tip'].rev()
 316
 317     def _changectx(self):
 318         return self.repo['tip']
 319
 320     def page_mime(self, title):
 321         """
 322         Guess page's mime type based on corresponding file name.
 323         Default ot text/x-wiki for files without an extension.
 324         """
 325         return guess_mime(self._file_path(title))
 326
 327     def _find_filectx(self, title, rev=None):
 328         """Find the last revision in which the file existed."""
 329         tip = self._changectx()  # start with tip
 330
 331         def tree_search(tip, repo_file):
 332             logging.info("Searching for %r", repo_file)
 333             current = tip
 334             visited = set()
 335
 336             stack = [current]
 337             visited.add(current)
 338
 339             while repo_file not in current:
 340                 if not stack:
 341                     raise LookupError
 342
 343                 current = stack.pop()
 344                 for parent in current.parents():
 345                     if parent not in visited:
 346                         stack.append(parent)
 347                         visited.add(parent)
 348
 349             fctx = current[repo_file]
 350             if rev is not None:
 351                 fctx = fctx.filectx(rev)
 352                 fctx.filerev()
 353             return fctx
 354
 355         try:
 356             return tree_search(tip, self._title_to_file(title))
 357         except (IndexError, LookupError) as e:
 358             logging.info("XML file not found, trying plain")
 359             try:
 360                 return tree_search(tip, self._title_to_file(title, type=''))
 361             except (IndexError, LookupError) as e:
 362                 raise DocumentNotFound(title)
 363
 364     def page_history(self, title):
 365         """Iterate over the page's history."""
 366
 367         filectx_tip = self._find_filectx(title)
 368
 369         maxrev = filectx_tip.filerev()
 370         minrev = 0
 371         for rev in range(maxrev, minrev - 1, -1):
 372             filectx = filectx_tip.filectx(rev)
 373             date = datetime.datetime.fromtimestamp(filectx.date()[0])
 374             author = filectx.user().decode('utf-8', 'replace')
 375             comment = filectx.description().decode("utf-8", 'replace')
 376             tags = [t.rsplit('#', 1)[-1] for t in filectx.changectx().tags() if '#' in t]
 377
 378             yield {
 379                 "version": rev,
 380                 "date": date,
 381                 "author": author,
 382                 "description": comment,
 383                 "tag": tags,
 384             }
 385
 386     @with_working_copy_locked
 387     def add_page_tag(self, title, rev, tag, user, doctag=True):
 388         ctitle = self._title_to_file(title)
 389
 390         if doctag:
 391             tag = u"{ctitle}#{tag}".format(**locals()).encode('utf-8')
 392
 393         message = u"Assigned tag {tag!r} to version {rev!r} of {ctitle!r}".format(**locals()).encode('utf-8')
 394
 395         fctx = self._find_filectx(title, rev)
 396         self.repo.tag(
 397             names=tag, node=fctx.node(), local=False,
 398             user=user, message=message, date=None,
 399         )
 400
 401     def history(self):
 402         """Iterate over the history of entire wiki."""
 403
 404         changectx = self._changectx()
 405         maxrev = changectx.rev()
 406         minrev = 0
 407         for wiki_rev in range(maxrev, minrev - 1, -1):
 408             change = self.repo.changectx(wiki_rev)
 409             date = datetime.datetime.fromtimestamp(change.date()[0])
 410             author = change.user().decode('utf-8', 'replace')
 411             comment = change.description().decode("utf-8", 'replace')
 412             for repo_file in change.files():
 413                 if repo_file.startswith(self.repo_prefix):
 414                     title = self._file_to_title(repo_file)
 415                     try:
 416                         rev = change[repo_file].filerev()
 417                     except mercurial.revlog.LookupError:
 418                         rev = -1
 419                     yield title, rev, date, author, comment
 420
 421     def all_pages(self, type=''):
 422         tip = self.repo['tip']
 423         """Iterate over the titles of all pages in the wiki."""
 424         return [self._file_to_title(filename) for filename in tip
 425                   if not filename.startswith('.')
 426                     and filename.endswith(type) ]
 427
 428     def changed_since(self, rev):
 429         """Return all pages that changed since specified repository revision."""
 430
 431         try:
 432             last = self.repo.lookup(int(rev))
 433         except IndexError:
 434             for page in self.all_pages():
 435                 yield page
 436                 return
 437         current = self.repo.lookup('tip')
 438         status = self.repo.status(current, last)
 439         modified, added, removed, deleted, unknown, ignored, clean = status
 440         for filename in modified + added + removed + deleted:
 441             if filename.startswith(self.repo_prefix):
 442                 yield self._file_to_title(filename)
 443
 444     def revert(self, pageid, rev, **commit_args):
 445         """ Make the given version of page the current version (reverting changes). """
 446
 447         # Find the old version
 448         fctx = self._find_filectx(pageid, rev)
 449
 450         # Restore the contents
 451         self.save_data(pageid, fctx.data(), **commit_args)