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, Theme
  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         'REDMINE_URL': settings.REDMINE_URL,
  88     })
  89
  90
  91 @require_GET
  92 @normalized_name
  93 def editor_readonly(request, name, template_name='wiki/document_details_readonly.html'):
  94     name = normalize_name(name)
  95     storage = getstorage()
  96
  97     try:
  98         revision = request.GET['revision']
  99         document = storage.get(name, revision)
 100     except (KeyError, DocumentNotFound):
 101         raise http.Http404
 102
 103     access_time = datetime.now()
 104     last_documents = request.session.get("wiki_last_docs", {})
 105     last_documents[name] = access_time
 106
 107     if len(last_documents) > MAX_LAST_DOCS:
 108         oldest_key = min(last_documents, key=last_documents.__getitem__)
 109         del last_documents[oldest_key]
 110     request.session['wiki_last_docs'] = last_documents
 111
 112     return direct_to_template(request, template_name, extra_context={
 113         'document': document,
 114         'document_name': document.name,
 115         'document_info': dict(document.info(), readonly=True),
 116         'document_meta': document.meta,
 117         'REDMINE_URL': settings.REDMINE_URL,
 118     })
 119
 120
 121 @normalized_name
 122 def create_missing(request, name):
 123     storage = getstorage()
 124
 125     if request.method == "POST":
 126         form = DocumentCreateForm(request.POST, request.FILES)
 127         if form.is_valid():
 128             doc = storage.create_document(
 129                 id=form.cleaned_data['id'],
 130                 text=form.cleaned_data['text'],
 131             )
 132
 133             return http.HttpResponseRedirect(reverse("wiki_details", args=[doc.name]))
 134     else:
 135         form = DocumentCreateForm(initial={
 136                 "id": name.replace(" ", "_"),
 137                 "title": name.title(),
 138         })
 139
 140     return direct_to_template(request, "wiki/document_create_missing.html", extra_context={
 141         "document_name": name,
 142         "form": form,
 143     })
 144
 145
 146 @never_cache
 147 @normalized_name
 148 def text(request, name):
 149     storage = getstorage()
 150
 151     if request.method == 'POST':
 152         form = DocumentTextSaveForm(request.POST, prefix="textsave")
 153         if form.is_valid():
 154             revision = form.cleaned_data['parent_revision']
 155             document = storage.get_or_404(name, revision)
 156             document.text = form.cleaned_data['text']
 157             comment = form.cleaned_data['comment']
 158             if form.cleaned_data['stage_completed']:
 159                 comment += '\n#stage-finished: %s\n' % form.cleaned_data['stage_completed']
 160             if request.user.is_authenticated():
 161                 author_name = request.user
 162                 author_email = request.user.email
 163             else:
 164                 author_name = form.cleaned_data['author_name']
 165                 author_email = form.cleaned_data['author_email']
 166             author = "%s <%s>" % (author_name, author_email)
 167             storage.put(document, author=author, comment=comment, parent=revision)
 168             document = storage.get(name)
 169             return JSONResponse({
 170                 'text': document.plain_text if revision != document.revision else None,
 171                 'meta': document.meta(),
 172                 'revision': document.revision,
 173             })
 174         else:
 175             return JSONFormInvalid(form)
 176     else:
 177         revision = request.GET.get("revision", None)
 178
 179         try:
 180             try:
 181                 revision = revision and int(revision)
 182                 logger.info("Fetching %s", revision)
 183                 document = storage.get(name, revision)
 184             except ValueError:
 185                 # treat as a tag
 186                 logger.info("Fetching tag %s", revision)
 187                 document = storage.get_by_tag(name, revision)
 188         except DocumentNotFound:
 189             raise http.Http404
 190
 191         return JSONResponse({
 192             'text': document.plain_text,
 193             'meta': document.meta(),
 194             'revision': document.revision,
 195         })
 196
 197
 198 @never_cache
 199 @normalized_name
 200 @require_POST
 201 def revert(request, name):
 202     storage = getstorage()
 203     revision = request.POST['target_revision']
 204
 205     try:
 206         document = storage.revert(name, revision)
 207
 208         return JSONResponse({
 209             'text': document.plain_text if revision != document.revision else None,
 210             'meta': document.meta(),
 211             'revision': document.revision,
 212         })
 213     except DocumentNotFound:
 214         raise http.Http404
 215
 216 @never_cache
 217 def gallery(request, directory):
 218     try:
 219         base_url = ''.join((
 220                         smart_unicode(settings.MEDIA_URL),
 221                         smart_unicode(settings.FILEBROWSER_DIRECTORY),
 222                         smart_unicode(directory)))
 223
 224         base_dir = os.path.join(
 225                     smart_unicode(settings.MEDIA_ROOT),
 226                     smart_unicode(settings.FILEBROWSER_DIRECTORY),
 227                     smart_unicode(directory))
 228
 229         def map_to_url(filename):
 230             return "%s/%s" % (base_url, smart_unicode(filename))
 231
 232         def is_image(filename):
 233             return os.path.splitext(f)[1].lower() in (u'.jpg', u'.jpeg', u'.png')
 234
 235         images = [map_to_url(f) for f in map(smart_unicode, os.listdir(base_dir)) if is_image(f)]
 236         images.sort()
 237         return JSONResponse(images)
 238     except (IndexError, OSError):
 239         logger.exception("Unable to fetch gallery")
 240         raise http.Http404
 241
 242
 243 @never_cache
 244 @normalized_name
 245 def diff(request, name):
 246     storage = getstorage()
 247
 248     revA = int(request.GET.get('from', 0))
 249     revB = int(request.GET.get('to', 0))
 250
 251     if revA > revB:
 252         revA, revB = revB, revA
 253
 254     if revB == 0:
 255         revB = None
 256
 257     docA = storage.get_or_404(name, int(revA))
 258     docB = storage.get_or_404(name, int(revB))
 259
 260     return http.HttpResponse(nice_diff.html_diff_table(docA.plain_text.splitlines(),
 261                                          docB.plain_text.splitlines(), context=3))
 262
 263
 264 @never_cache
 265 @normalized_name
 266 def history(request, name):
 267     storage = getstorage()
 268
 269     # TODO: pagination
 270     changesets = list(storage.history(name))
 271
 272     return JSONResponse(changesets)
 273
 274
 275 @require_POST
 276 @ajax_require_permission('wiki.can_change_tags')
 277 def add_tag(request, name):
 278     name = normalize_name(name)
 279     storage = getstorage()
 280
 281     form = DocumentTagForm(request.POST, prefix="addtag")
 282     if form.is_valid():
 283         doc = storage.get_or_404(form.cleaned_data['id'])
 284         doc.add_tag(tag=form.cleaned_data['tag'],
 285                     revision=form.cleaned_data['revision'],
 286                     author=request.user.username)
 287         return JSONResponse({"message": _("Tag added")})
 288     else:
 289         return JSONFormInvalid(form)
 290
 291
 292 @require_POST
 293 @ajax_require_permission('wiki.can_publish')
 294 def publish(request, name):
 295     name = normalize_name(name)
 296
 297     storage = getstorage()
 298     document = storage.get_by_tag(name, "ready_to_publish")
 299
 300     api = wlapi.WLAPI(**settings.WL_API_CONFIG)
 301
 302     try:
 303         return JSONResponse({"result": api.publish_book(document)})
 304     except wlapi.APICallException, e:
 305         return JSONServerError({"message": str(e)})
 306
 307
 308 def themes(request):
 309     prefix = request.GET.get('q', '')
 310     return http.HttpResponse('\n'.join([str(t) for t in Theme.objects.filter(name__istartswith=prefix)]))