apps/wiki/views.py

   1 from datetime import datetime
   2 import os
   3 import logging
   4 import urllib
   5
   6 from django.conf import settings
   7 from django.core.urlresolvers import reverse
   8 from django import http
   9 from django.http import Http404, HttpResponseForbidden
  10 from django.middleware.gzip import GZipMiddleware
  11 from django.utils.decorators import decorator_from_middleware
  12 from django.utils.encoding import smart_unicode
  13 from django.utils.formats import localize
  14 from django.utils.translation import ugettext as _
  15 from django.views.decorators.http import require_POST, require_GET
  16 from django.shortcuts import get_object_or_404, render
  17 from django.utils import simplejson
  18
  19 from catalogue.models import Book, Chunk, Template
  20 import nice_diff
  21 from wiki import forms
  22 from wiki.helpers import (JSONResponse, JSONFormInvalid, JSONServerError,
  23                 ajax_require_permission)
  24 from wiki.models import Theme
  25
  26 #
  27 # Quick hack around caching problems, TODO: use ETags
  28 #
  29 from django.views.decorators.cache import never_cache
  30
  31 logger = logging.getLogger("fnp.wiki")
  32
  33 MAX_LAST_DOCS = 10
  34
  35
  36 def get_history(chunk):
  37     changes = []
  38     for change in chunk.history():
  39         changes.append({
  40                 "version": change.revision,
  41                 "description": change.description,
  42                 "author": change.author_str(),
  43                 "date": localize(change.created_at),
  44                 "publishable": _("Publishable") + "\n" if change.publishable else "",
  45                 "tag": ',\n'.join(unicode(tag) for tag in change.tags.all()),
  46                 "published": _("Published") + ": " + \
  47                     localize(change.publish_log.order_by('-book_record__timestamp')[0].book_record.timestamp) \
  48                     if change.publish_log.exists() else "",
  49             })
  50     return changes
  51
  52
  53 @never_cache
  54 def editor(request, slug, chunk=None, template_name='wiki/bootstrap.html'):
  55     try:
  56         chunk = Chunk.get(slug, chunk)
  57     except Chunk.MultipleObjectsReturned:
  58         # TODO: choice page
  59         raise Http404
  60     except Chunk.DoesNotExist:
  61         if chunk is None:
  62             try:
  63                 book = Book.objects.get(slug=slug)
  64             except Book.DoesNotExist:
  65                 return http.HttpResponseRedirect(reverse("catalogue_create_missing", args=[slug]))
  66         else:
  67             raise Http404
  68     if not chunk.book.accessible(request):
  69         return HttpResponseForbidden("Not authorized.")
  70
  71     access_time = datetime.now()
  72     last_books = request.session.get("wiki_last_books", {})
  73     last_books[slug, chunk.slug] = {
  74         'time': access_time,
  75         'title': chunk.pretty_name(),
  76         }
  77
  78     if len(last_books) > MAX_LAST_DOCS:
  79         oldest_key = min(last_books, key=lambda x: last_books[x]['time'])
  80         del last_books[oldest_key]
  81     request.session['wiki_last_books'] = last_books
  82
  83     save_form = forms.DocumentTextSaveForm(user=request.user, prefix="textsave")
  84     return render(request, template_name, {
  85         'serialized_document_data': simplejson.dumps({
  86             'document': chunk.materialize(),
  87             'document_id': chunk.id,
  88             'title': chunk.book.title,
  89             'history': get_history(chunk),
  90             'version': chunk.revision(),
  91             'stage': chunk.stage.name if chunk.stage else None,
  92             'assignment': chunk.user.username if chunk.user else None
  93         }),
  94         'serialized_templates': simplejson.dumps([
  95             {'id': t.id, 'name': t.name, 'content': t.content} for t in Template.objects.filter(is_partial=True)
  96         ]),
  97         'forms': {
  98             "text_save": save_form,
  99             "text_revert": forms.DocumentTextRevertForm(prefix="textrevert")
 100         },
 101         'tags': list(save_form.fields['stage_completed'].choices),
 102         'can_pubmark': request.user.has_perm('catalogue.can_pubmark'),
 103     })
 104
 105
 106 @require_GET
 107 def editor_readonly(request, slug, chunk=None, template_name='wiki/document_details_readonly.html'):
 108     try:
 109         chunk = Chunk.get(slug, chunk)
 110         revision = request.GET['revision']
 111     except (Chunk.MultipleObjectsReturned, Chunk.DoesNotExist, KeyError):
 112         raise Http404
 113     if not chunk.book.accessible(request):
 114         return HttpResponseForbidden("Not authorized.")
 115
 116     access_time = datetime.now()
 117     last_books = request.session.get("wiki_last_books", {})
 118     last_books[slug, chunk.slug] = {
 119         'time': access_time,
 120         'title': chunk.book.title,
 121         }
 122
 123     if len(last_books) > MAX_LAST_DOCS:
 124         oldest_key = min(last_books, key=lambda x: last_books[x]['time'])
 125         del last_books[oldest_key]
 126     request.session['wiki_last_books'] = last_books
 127
 128     return render(request, template_name, {
 129         'chunk': chunk,
 130         'revision': revision,
 131         'readonly': True,
 132         'REDMINE_URL': settings.REDMINE_URL,
 133     })
 134
 135
 136 @never_cache
 137 @decorator_from_middleware(GZipMiddleware)
 138 def text(request, chunk_id):
 139     doc = get_object_or_404(Chunk, pk=chunk_id)
 140     if not doc.book.accessible(request):
 141         return HttpResponseForbidden("Not authorized.")
 142
 143     if request.method == 'POST':
 144         form = forms.DocumentTextSaveForm(request.POST, user=request.user, prefix="textsave")
 145         if form.is_valid():
 146             if request.user.is_authenticated():
 147                 author = request.user
 148             else:
 149                 author = None
 150             text = form.cleaned_data['text']
 151             parent_revision = form.cleaned_data['parent_revision']
 152             if parent_revision is not None:
 153                 parent = doc.at_revision(parent_revision)
 154             else:
 155                 parent = None
 156             stage = form.cleaned_data['stage_completed']
 157             tags = [stage] if stage else []
 158             publishable = (form.cleaned_data['publishable'] and
 159                     request.user.has_perm('catalogue.can_pubmark'))
 160             doc.commit(author=author,
 161                        text=text,
 162                        parent=parent,
 163                        description=form.cleaned_data['comment'],
 164                        tags=tags,
 165                        author_name=form.cleaned_data['author_name'],
 166                        author_email=form.cleaned_data['author_email'],
 167                        publishable=publishable,
 168                        )
 169             revision = doc.revision()
 170             return JSONResponse({
 171                 'text': doc.materialize() if parent_revision != revision else None,
 172                 'version': revision,
 173                 'stage': doc.stage.name if doc.stage else None,
 174                 'assignment': doc.user.username if doc.user else None
 175             })
 176         else:
 177             return JSONFormInvalid(form)
 178     else:
 179         revision = request.GET.get("revision", None)
 180
 181         try:
 182             revision = int(revision)
 183         except (ValueError, TypeError):
 184             revision = doc.revision()
 185
 186         if revision is not None:
 187             text = doc.at_revision(revision).materialize()
 188         else:
 189             text = ''
 190
 191         return JSONResponse({
 192             'text': text,
 193             'meta': {},
 194             'revision': revision,
 195         })
 196
 197
 198 @never_cache
 199 @require_POST
 200 def revert(request, chunk_id):
 201     form = forms.DocumentTextRevertForm(request.POST, prefix="textrevert")
 202     if form.is_valid():
 203         doc = get_object_or_404(Chunk, pk=chunk_id)
 204         if not doc.book.accessible(request):
 205             return HttpResponseForbidden("Not authorized.")
 206
 207         revision = form.cleaned_data['revision']
 208
 209         comment = form.cleaned_data['comment']
 210         comment += "\n#revert to %s" % revision
 211
 212         if request.user.is_authenticated():
 213             author = request.user
 214         else:
 215             author = None
 216
 217         before = doc.revision()
 218         logger.info("Reverting %s to %s", chunk_id, revision)
 219         doc.at_revision(revision).revert(author=author, description=comment)
 220
 221         return JSONResponse({
 222             'document': doc.materialize() if before != doc.revision() else None,
 223             'version': doc.revision(),
 224         })
 225     else:
 226         return JSONFormInvalid(form)
 227
 228
 229 @never_cache
 230 def gallery(request, directory):
 231     try:
 232         base_url = ''.join((
 233                         smart_unicode(settings.MEDIA_URL),
 234                         smart_unicode(settings.IMAGE_DIR),
 235                         smart_unicode(directory)))
 236
 237         base_dir = os.path.join(
 238                     smart_unicode(settings.MEDIA_ROOT),
 239                     smart_unicode(settings.IMAGE_DIR),
 240                     smart_unicode(directory))
 241
 242         def map_to_url(filename):
 243             return urllib.quote("%s/%s" % (base_url, smart_unicode(filename)))
 244
 245         def is_image(filename):
 246             return os.path.splitext(f)[1].lower() in (u'.jpg', u'.jpeg', u'.png')
 247
 248         images = [map_to_url(f) for f in map(smart_unicode, os.listdir(base_dir)) if is_image(f)]
 249         images.sort()
 250
 251         if not request.user.is_authenticated():
 252             return HttpResponseForbidden("Not authorized.")
 253
 254         return JSONResponse(images)
 255     except (IndexError, OSError):
 256         logger.exception("Unable to fetch gallery")
 257         raise http.Http404
 258
 259
 260 @never_cache
 261 def diff(request, chunk_id):
 262     revA = int(request.GET.get('from', 0))
 263     revB = int(request.GET.get('to', 0))
 264
 265     if revA > revB:
 266         revA, revB = revB, revA
 267
 268     if revB == 0:
 269         revB = None
 270
 271     doc = get_object_or_404(Chunk, pk=chunk_id)
 272     if not doc.book.accessible(request):
 273         return HttpResponseForbidden("Not authorized.")
 274
 275     # allow diff from the beginning
 276     if revA:
 277         docA = doc.at_revision(revA).materialize()
 278     else:
 279         docA = ""
 280     docB = doc.at_revision(revB).materialize()
 281
 282     return http.HttpResponse(nice_diff.html_diff_table(docA.splitlines(),
 283                                          docB.splitlines(), context=3))
 284
 285
 286 @never_cache
 287 def revision(request, chunk_id):
 288     doc = get_object_or_404(Chunk, pk=chunk_id)
 289     if not doc.book.accessible(request):
 290         return HttpResponseForbidden("Not authorized.")
 291     return http.HttpResponse(str(doc.revision()))
 292
 293
 294 @never_cache
 295 def history(request, chunk_id):
 296     # TODO: pagination
 297     doc = get_object_or_404(Chunk, pk=chunk_id)
 298     if not doc.book.accessible(request):
 299         return HttpResponseForbidden("Not authorized.")
 300
 301     return JSONResponse(get_history(doc))
 302
 303
 304 @require_POST
 305 @ajax_require_permission('catalogue.can_pubmark')
 306 def pubmark(request, chunk_id):
 307     form = forms.DocumentPubmarkForm(request.POST, prefix="pubmark")
 308     if form.is_valid():
 309         doc = get_object_or_404(Chunk, pk=chunk_id)
 310         if not doc.book.accessible(request):
 311             return HttpResponseForbidden("Not authorized.")
 312
 313         revision = form.cleaned_data['revision']
 314         publishable = form.cleaned_data['publishable']
 315         change = doc.at_revision(revision)
 316         if publishable != change.publishable:
 317             change.set_publishable(publishable)
 318             return JSONResponse({"message": _("Revision marked")})
 319         else:
 320             return JSONResponse({"message": _("Nothing changed")})
 321     else:
 322         return JSONFormInvalid(form)
 323
 324
 325 def themes(request):
 326     prefix = request.GET.get('q', '')
 327     return http.HttpResponse('\n'.join([str(t) for t in Theme.objects.filter(name__istartswith=prefix)]))