Merge branch 'master' of git@github.com:fnp/redakcja
[redakcja.git] / apps / wiki / models.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 from django.db import models
7 import re
8 import os
9 import vstorage
10 from vstorage import DocumentNotFound
11 from wiki import settings, constants
12 from django.utils.translation import ugettext_lazy as _
13
14 from django.http import Http404
15
16 import logging
17 logger = logging.getLogger("fnp.wiki")
18
19
20 # _PCHARS_DICT = dict(zip((ord(x) for x in u"ĄĆĘŁŃÓŚŻŹąćęłńóśżź "), u"ACELNOSZZacelnoszz_"))
21 _PCHARS_DICT = dict(zip((ord(x) for x in u" "), u"_"))
22
23 # I know this is barbaric, but I didn't find a better solution ;(
24 def split_name(name):
25     parts = name.translate(_PCHARS_DICT).split('__')
26     return parts
27
28 def join_name(*parts, **kwargs):
29     name = u'__'.join(p.translate(_PCHARS_DICT) for p in parts)
30     logger.info("JOIN %r -> %r", parts, name)
31     return name
32
33 def normalize_name(name):
34     """
35     >>> normalize_name("gąska".decode('utf-8'))
36     u'g\u0105ska'
37     """
38     return unicode(name).translate(_PCHARS_DICT)
39
40 STAGE_TAGS_RE = re.compile(r'^#stage-finished: (.*)$', re.MULTILINE)
41
42
43 class DocumentStorage(object):
44     def __init__(self, path):
45         self.vstorage = vstorage.VersionedStorage(path)
46
47     def get(self, name, revision=None):
48         text, rev = self.vstorage.page_text(name, revision)
49         return Document(self, name=name, text=text, revision=rev)
50
51     def get_by_tag(self, name, tag):
52         text, rev = self.vstorage.page_text_by_tag(name, tag)
53         return Document(self, name=name, text=text, revision=rev)
54
55     def revert(self, name, revision):
56         text, rev = self.vstorage.revert(name, revision)
57         return Document(self, name=name, text=text, revision=rev)
58
59     def get_or_404(self, *args, **kwargs):
60         try:
61             return self.get(*args, **kwargs)
62         except DocumentNotFound:
63             raise Http404
64
65     def put(self, document, author, comment, parent=None):
66         self.vstorage.save_text(
67                 title=document.name,
68                 text=document.text,
69                 author=author,
70                 comment=comment,
71                 parent=parent)
72
73         return document
74
75     def create_document(self, text, name):
76         title = u', '.join(p.title() for p in split_name(name))
77
78         if text is None:
79             text = u''
80
81         document = Document(self, name=name, text=text, title=title)
82         return self.put(document, u"<wiki>", u"Document created.")
83
84     def delete(self, name, author, comment):
85         self.vstorage.delete_page(name, author, comment)
86
87     def all(self):
88         return list(self.vstorage.all_pages())
89
90     def history(self, title):
91         def stage_desc(match):
92             stage = match.group(1)
93             return _("Finished stage: %s") % constants.DOCUMENT_STAGES_DICT[stage]
94
95         for changeset in self.vstorage.page_history(title):
96             changeset['description'] = STAGE_TAGS_RE.sub(stage_desc, changeset['description'])
97             yield changeset
98
99
100
101 class Document(object):
102     META_REGEX = re.compile(r'\s*<!--\s(.*?)-->', re.DOTALL | re.MULTILINE)
103
104     def __init__(self, storage, **kwargs):
105         self.storage = storage
106         for attr, value in kwargs.iteritems():
107             setattr(self, attr, value)
108
109     def add_tag(self, tag, revision, author):
110         """ Add document specific tag """
111         logger.debug("Adding tag %s to doc %s version %d", tag, self.name, revision)
112         self.storage.vstorage.add_page_tag(self.name, revision, tag, user=author)
113
114     @property
115     def plain_text(self):
116         return re.sub(self.META_REGEX, '', self.text, 1)
117
118     def meta(self):
119         result = {}
120
121         m = re.match(self.META_REGEX, self.text)
122         if m:
123             for line in m.group(1).split('\n'):
124                 try:
125                     k, v = line.split(':', 1)
126                     result[k.strip()] = v.strip()
127                 except ValueError:
128                     continue
129
130         gallery = result.get('gallery', self.name.replace(' ', '_'))
131
132         if gallery.startswith('/'):
133             gallery = os.path.basename(gallery)
134
135         result['gallery'] = gallery
136         return result
137
138     def info(self):
139         return self.storage.vstorage.page_meta(self.name, self.revision)
140
141 def getstorage():
142     return DocumentStorage(settings.REPOSITORY_PATH)
143
144 #
145 # Django models
146 #
147
148 class Theme(models.Model):
149     name = models.CharField(_('name'), max_length=50, unique=True)
150
151     class Meta:
152         ordering = ('name',)
153         verbose_name = _('theme')
154         verbose_name_plural = _('themes')
155
156     def __unicode__(self):
157         return self.name
158
159     def __repr__(self):
160         return "Theme(name=%r)" % self.name
161