apps/wiki/views.py

   1 import os
   2 import functools
   3 import logging
   4 logger = logging.getLogger("fnp.wiki")
   5
   6 from django.conf import settings
   7
   8 from django.views.generic.simple import direct_to_template
   9 from django.views.decorators.http import require_POST, require_GET
  10 from django.core.urlresolvers import reverse
  11 from wiki.helpers import (JSONResponse, JSONFormInvalid, JSONServerError,
  12                 ajax_require_permission, recursive_groupby)
  13 from django import http
  14
  15 from wiki.models import getstorage, DocumentNotFound, normalize_name, split_name, join_name
  16 from wiki.forms import DocumentTextSaveForm, DocumentTagForm, DocumentCreateForm
  17 from datetime import datetime
  18 from django.utils.encoding import smart_unicode
  19 from django.utils.translation import ugettext_lazy as _
  20
  21
  22 #
  23 # Quick hack around caching problems, TODO: use ETags
  24 #
  25 from django.views.decorators.cache import never_cache
  26
  27 import wlapi
  28 import nice_diff
  29 import operator
  30
  31 MAX_LAST_DOCS = 10
  32
  33
  34 def normalized_name(view):
  35
  36     @functools.wraps(view)
  37     def decorated(request, name, *args):
  38         normalized = normalize_name(name)
  39         logger.debug('View check %r -> %r', name, normalized)
  40
  41         if normalized != name:
  42             return http.HttpResponseRedirect(
  43                         reverse('wiki_' + view.__name__, kwargs={'name': normalized}))
  44
  45         return view(request, name, *args)
  46
  47     return decorated
  48
  49
  50 @never_cache
  51 def document_list(request):
  52     return direct_to_template(request, 'wiki/document_list.html', extra_context={
  53         'docs': getstorage().all(),
  54         'last_docs': sorted(request.session.get("wiki_last_docs", {}).items(),
  55                         key=operator.itemgetter(1), reverse=True),
  56     })
  57
  58
  59 @never_cache
  60 @normalized_name
  61 def editor(request, name, template_name='wiki/document_details.html'):
  62     storage = getstorage()
  63
  64     try:
  65         document = storage.get(name)
  66     except DocumentNotFound:
  67         return http.HttpResponseRedirect(reverse("wiki_create_missing", args=[name]))
  68
  69     access_time = datetime.now()
  70     last_documents = request.session.get("wiki_last_docs", {})
  71     last_documents[name] = access_time
  72
  73     if len(last_documents) > MAX_LAST_DOCS:
  74         oldest_key = min(last_documents, key=last_documents.__getitem__)
  75         del last_documents[oldest_key]
  76     request.session['wiki_last_docs'] = last_documents
  77
  78     return direct_to_template(request, template_name, extra_context={
  79         'document': document,
  80         'document_name': document.name,
  81         'document_info': document.info,
  82         'document_meta': document.meta,
  83         'forms': {
  84             "text_save": DocumentTextSaveForm(prefix="textsave"),
  85             "add_tag": DocumentTagForm(prefix="addtag"),
  86         },
  87     })
  88
  89
  90 @require_GET
  91 @normalized_name
  92 def editor_readonly(request, name, template_name='wiki/document_details_readonly.html'):
  93     name = normalize_name(name)
  94     storage = getstorage()
  95
  96     try:
  97         revision = request.GET['revision']
  98         document = storage.get(name, revision)
  99     except (KeyError, DocumentNotFound) as e:
 100         raise http.Http404
 101
 102     access_time = datetime.now()
 103     last_documents = request.session.get("wiki_last_docs", {})
 104     last_documents[name] = access_time
 105
 106     if len(last_documents) > MAX_LAST_DOCS:
 107         oldest_key = min(last_documents, key=last_documents.__getitem__)
 108         del last_documents[oldest_key]
 109     request.session['wiki_last_docs'] = last_documents
 110
 111     return direct_to_template(request, template_name, extra_context={
 112         'document': document,
 113         'document_name': document.name,
 114         'document_info': dict(document.info(), readonly=True),
 115         'document_meta': document.meta,
 116     })
 117
 118
 119 @normalized_name
 120 def create_missing(request, name):
 121     storage = getstorage()
 122
 123     if request.method == "POST":
 124         form = DocumentCreateForm(request.POST, request.FILES)
 125         if form.is_valid():
 126             doc = storage.create_document(
 127                 id=form.cleaned_data['id'],
 128                 text=form.cleaned_data['text'],
 129             )
 130
 131             return http.HttpResponseRedirect(reverse("wiki_details", args=[doc.name]))
 132     else:
 133         form = DocumentCreateForm(initial={
 134                 "id": name.replace(" ", "_"),
 135                 "title": name.title(),
 136         })
 137
 138     return direct_to_template(request, "wiki/document_create_missing.html", extra_context={
 139         "document_name": name,
 140         "form": form,
 141     })
 142
 143
 144 @never_cache
 145 @normalized_name
 146 def text(request, name):
 147     storage = getstorage()
 148
 149     if request.method == 'POST':
 150         form = DocumentTextSaveForm(request.POST, prefix="textsave")
 151
 152         if form.is_valid():
 153             revision = form.cleaned_data['parent_revision']
 154
 155             document = storage.get_or_404(name, revision)
 156             document.text = form.cleaned_data['text']
 157
 158             comment = form.cleaned_data['comment']
 159
 160             if form.cleaned_data['stage_completed']:
 161                 comment += '\n#stage-finished: %s\n' % form.cleaned_data['stage_completed']
 162
 163             author = "%s <%s>" % (form.cleaned_data['author_name'], form.cleaned_data['author_email'])
 164
 165             storage.put(document, author=author, comment=comment, parent=revision)
 166             document = storage.get(name)
 167
 168             return JSONResponse({
 169                 'text': document.plain_text if revision != document.revision else None,
 170                 'meta': document.meta(),
 171                 'revision': document.revision,
 172             })
 173         else:
 174             return JSONFormInvalid(form)
 175     else:
 176         revision = request.GET.get("revision", None)
 177
 178         try:
 179             try:
 180                 revision = revision and int(revision)
 181                 logger.info("Fetching %s", revision)
 182                 document = storage.get(name, revision)
 183             except ValueError:
 184                 # treat as a tag
 185                 logger.info("Fetching tag %s", revision)
 186                 document = storage.get_by_tag(name, revision)
 187         except DocumentNotFound:
 188             raise http.Http404
 189
 190         return JSONResponse({
 191             'text': document.plain_text,
 192             'meta': document.meta(),
 193             'revision': document.revision,
 194         })
 195
 196
 197 @never_cache
 198 def gallery(request, directory):
 199     try:
 200         base_url = ''.join((
 201                         smart_unicode(settings.MEDIA_URL),
 202                         smart_unicode(settings.FILEBROWSER_DIRECTORY),
 203                         smart_unicode(directory)))
 204
 205         base_dir = os.path.join(
 206                     smart_unicode(settings.MEDIA_ROOT),
 207                     smart_unicode(settings.FILEBROWSER_DIRECTORY),
 208                     smart_unicode(directory))
 209
 210         def map_to_url(filename):
 211             return "%s/%s" % (base_url, smart_unicode(filename))
 212
 213         def is_image(filename):
 214             return os.path.splitext(f)[1].lower() in (u'.jpg', u'.jpeg', u'.png')
 215
 216         images = [map_to_url(f) for f in map(smart_unicode, os.listdir(base_dir)) if is_image(f)]
 217         images.sort()
 218         return JSONResponse(images)
 219     except (IndexError, OSError) as e:
 220         logger.exception("Unable to fetch gallery")
 221         raise http.Http404
 222
 223
 224 @never_cache
 225 @normalized_name
 226 def diff(request, name):
 227     storage = getstorage()
 228
 229     revA = int(request.GET.get('from', 0))
 230     revB = int(request.GET.get('to', 0))
 231
 232     if revA > revB:
 233         revA, revB = revB, revA
 234
 235     if revB == 0:
 236         revB = None
 237
 238     docA = storage.get_or_404(name, int(revA))
 239     docB = storage.get_or_404(name, int(revB))
 240
 241     return http.HttpResponse(nice_diff.html_diff_table(docA.plain_text.splitlines(),
 242                                          docB.plain_text.splitlines(), context=3))
 243
 244
 245 @never_cache
 246 @normalized_name
 247 def history(request, name):
 248     storage = getstorage()
 249
 250     # TODO: pagination
 251     changesets = list(storage.history(name))
 252
 253     return JSONResponse(changesets)
 254
 255
 256 @require_POST
 257 @ajax_require_permission('wiki.can_change_tags')
 258 def add_tag(request, name):
 259     name = normalize_name(name)
 260     storage = getstorage()
 261
 262     form = DocumentTagForm(request.POST, prefix="addtag")
 263     if form.is_valid():
 264         doc = storage.get_or_404(form.cleaned_data['id'])
 265         doc.add_tag(tag=form.cleaned_data['tag'],
 266                     revision=form.cleaned_data['revision'],
 267                     author=request.user.username)
 268         return JSONResponse({"message": _("Tag added")})
 269     else:
 270         return JSONFormInvalid(form)
 271
 272
 273 @require_POST
 274 @ajax_require_permission('wiki.can_publish')
 275 def publish(request, name):
 276     name = normalize_name(name)
 277
 278     storage = getstorage()
 279     document = storage.get_by_tag(name, "ready_to_publish")
 280
 281     api = wlapi.WLAPI(**settings.WL_API_CONFIG)
 282
 283     try:
 284         return JSONResponse({"result": api.publish_book(document)})
 285     except wlapi.APICallException, e:
 286         return JSONServerError({"message": str(e)})