pep8, style, dead code cleanup etc.

[redakcja.git] / apps / wiki / views.py

diff --git a/apps/wiki/views.py b/apps/wiki/views.py
index 4348cb8..1b16077 100644 (file)
--- a/apps/wiki/views.py
+++ b/apps/wiki/views.py
@@ -1,299 +1,213 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of MIL/PEER, licensed under GNU Affero GPLv3 or later.
+# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
+#
+import json

 import os
 import os

-import functools

 import logging
 import logging

-logger = logging.getLogger("fnp.wiki")
+import urllib

 
 from django.conf import settings
 
 from django.conf import settings

-
-from django.views.generic.simple import direct_to_template
-from django.views.decorators.http import require_POST, require_GET
-from django.core.urlresolvers import reverse
-from wiki.helpers import (JSONResponse, JSONFormInvalid, JSONServerError,
-                ajax_require_permission, recursive_groupby)

 from django import http
 from django import http

-
-from wiki.models import getstorage, DocumentNotFound, normalize_name, split_name, join_name, Theme
-from wiki.forms import DocumentTextSaveForm, DocumentTagForm, DocumentCreateForm, DocumentsUploadForm
-from datetime import datetime
-from django.utils.encoding import smart_unicode
-from django.utils.translation import ugettext_lazy as _
-from django.utils.decorators import decorator_from_middleware
+from django.http import HttpResponseForbidden

 from django.middleware.gzip import GZipMiddleware
 from django.middleware.gzip import GZipMiddleware

+from django.utils.decorators import decorator_from_middleware
+from django.utils.encoding import smart_unicode
+from django.utils.formats import localize
+from django.utils.translation import ugettext as _
+from django.views.decorators.http import require_POST
+from django.shortcuts import get_object_or_404, render

 
 

+from catalogue.models import Document, Template
+from dvcs.models import Revision
+import nice_diff
+from wiki import forms
+from wiki.helpers import JSONResponse, JSONFormInvalid

 
 #
 # Quick hack around caching problems, TODO: use ETags
 #
 from django.views.decorators.cache import never_cache
 
 
 #
 # Quick hack around caching problems, TODO: use ETags
 #
 from django.views.decorators.cache import never_cache
 

-import wlapi
-import nice_diff
-import operator
+logger = logging.getLogger("fnp.wiki")

 
 MAX_LAST_DOCS = 10
 
 
 
 MAX_LAST_DOCS = 10
 
 

-def normalized_name(view):
-
-    @functools.wraps(view)
-    def decorated(request, name, *args):
-        normalized = normalize_name(name)
-        logger.debug('View check %r -> %r', name, normalized)
-
-        if normalized != name:
-            return http.HttpResponseRedirect(
-                        reverse('wiki_' + view.__name__, kwargs={'name': normalized}))
-
-        return view(request, name, *args)
-
-    return decorated
-
-
-@never_cache
-def document_list(request):
-    return direct_to_template(request, 'wiki/document_list.html', extra_context={
-        'docs': getstorage().all(),
-        'last_docs': sorted(request.session.get("wiki_last_docs", {}).items(),
-                        key=operator.itemgetter(1), reverse=True),
-    })
+def get_history(document):
+    revisions = []
+    for i, revision in enumerate(document.history()):
+        revisions.append({
+            "version": i + 1,
+            "description": revision.description,
+            "author": revision.author_str(),
+            "date": localize(revision.created_at),
+            "revision": revision.pk,
+            "published": _("Published") + ": " +
+            localize(revision.publish_log.order_by('-timestamp')[0].timestamp)
+            if revision.publish_log.exists() else "",
+        })
+    return revisions

 
 
 @never_cache
 
 
 @never_cache

-@normalized_name
-def editor(request, name, template_name='wiki/document_details.html'):
-    storage = getstorage()
-
-    try:
-        document = storage.get(name)
-    except DocumentNotFound:
-        return http.HttpResponseRedirect(reverse("wiki_create_missing", args=[name]))
-
-    access_time = datetime.now()
-    last_documents = request.session.get("wiki_last_docs", {})
-    last_documents[name] = access_time
-
-    if len(last_documents) > MAX_LAST_DOCS:
-        oldest_key = min(last_documents, key=last_documents.__getitem__)
-        del last_documents[oldest_key]
-    request.session['wiki_last_docs'] = last_documents
-
-    return direct_to_template(request, template_name, extra_context={
-        'document': document,
-        'document_name': document.name,
-        'document_info': document.info,
-        'document_meta': document.meta,
+def editor(request, pk, template_name='wiki/bootstrap.html'):
+    doc = get_object_or_404(Document, pk=pk, deleted=False)
+
+    save_form = forms.DocumentTextSaveForm(user=request.user, prefix="textsave")
+    text = doc.materialize()
+    revision = doc.revision
+    history = get_history(doc)
+    return render(request, template_name, {
+        'serialized_document_data': json.dumps({
+            'document': text,
+            'document_id': doc.pk,
+            'title': doc.meta().get('title', ''),
+            'history': history,
+            'version': len(history),
+            'revision': revision.pk,
+            'stage': doc.stage,
+            'assignment': str(doc.assigned_to),
+        }),
+        'serialized_templates': json.dumps([
+            {'id': t.id, 'name': t.name, 'content': t.content} for t in Template.objects.filter(is_partial=True)
+        ]),

         'forms': {
         'forms': {

-            "text_save": DocumentTextSaveForm(prefix="textsave"),
-            "add_tag": DocumentTagForm(prefix="addtag"),
+            "text_save": save_form,
+            "text_revert": forms.DocumentTextRevertForm(prefix="textrevert"),
+            "text_publish": forms.DocumentTextPublishForm(prefix="textpublish"),

         },
         },

-        'REDMINE_URL': settings.REDMINE_URL,
-    })
-
-
-@require_GET
-@normalized_name
-def editor_readonly(request, name, template_name='wiki/document_details_readonly.html'):
-    name = normalize_name(name)
-    storage = getstorage()
-
-    try:
-        revision = request.GET['revision']
-        document = storage.get(name, revision)
-    except (KeyError, DocumentNotFound):
-        raise http.Http404
-
-    access_time = datetime.now()
-    last_documents = request.session.get("wiki_last_docs", {})
-    last_documents[name] = access_time
-
-    if len(last_documents) > MAX_LAST_DOCS:
-        oldest_key = min(last_documents, key=last_documents.__getitem__)
-        del last_documents[oldest_key]
-    request.session['wiki_last_docs'] = last_documents
-
-    return direct_to_template(request, template_name, extra_context={
-        'document': document,
-        'document_name': document.name,
-        'document_info': dict(document.info(), readonly=True),
-        'document_meta': document.meta,
-        'REDMINE_URL': settings.REDMINE_URL,
-    })
-
-
-@normalized_name
-def create_missing(request, name):
-    storage = getstorage()
-
-    if request.method == "POST":
-        form = DocumentCreateForm(request.POST, request.FILES)
-        if form.is_valid():
-            doc = storage.create_document(
-                name=form.cleaned_data['id'],
-                text=form.cleaned_data['text'],
-            )
-
-            return http.HttpResponseRedirect(reverse("wiki_editor", args=[doc.name]))
-    else:
-        form = DocumentCreateForm(initial={
-                "id": name.replace(" ", "_"),
-                "title": name.title(),
-        })
-
-    return direct_to_template(request, "wiki/document_create_missing.html", extra_context={
-        "document_name": name,
-        "form": form,
-    })
-
-
-def upload(request):
-    storage = getstorage()
-
-    if request.method == "POST":
-        form = DocumentsUploadForm(request.POST, request.FILES)
-        if form.is_valid():
-            zip = form.cleaned_data['zip']
-            skipped_list = []
-            ok_list = []
-            error_list = []
-            titles = {}
-            existing = storage.all()
-            for filename in zip.namelist():
-                if filename[-1] == '/':
-                    continue
-                title = normalize_name(os.path.basename(filename)[:-4])
-                if not (title and filename.endswith('.xml')):
-                    skipped_list.append(filename)
-                elif title in titles:
-                    error_list.append((filename, title, _('Title already used for %s' % titles[title])))
-                elif title in existing:
-                    error_list.append((filename, title, _('Title already used in repository.')))
-                else:
-                    try:
-                        zip.read(filename).decode('utf-8') # test read
-                        ok_list.append((filename, title))
-                    except UnicodeDecodeError:
-                        error_list.append((filename, title, _('File should be UTF-8 encoded.')))
-                    titles[title] = filename
-
-            if not error_list:
-                for filename, title in ok_list:
-                    storage.create_document(
-                        name=title,
-                        text=zip.read(filename).decode('utf-8')
-                    )
-
-            return direct_to_template(request, "wiki/document_upload.html", extra_context={
-                "form": form,
-                "ok_list": ok_list,
-                "skipped_list": skipped_list,
-                "error_list": error_list,
-            })
-                #doc = storage.create_document(
-                #    name=base,
-                #    text=form.cleaned_data['text'],
-
-            
-            return http.HttpResponse('\n'.join(yeslist) + '\n\n' + '\n'.join(nolist))
-    else:
-        form = DocumentsUploadForm()
-
-    return direct_to_template(request, "wiki/document_upload.html", extra_context={
-        "form": form,
+        'pk': doc.pk,

     })
 
 
 @never_cache
     })
 
 
 @never_cache

-@normalized_name

 @decorator_from_middleware(GZipMiddleware)
 @decorator_from_middleware(GZipMiddleware)

-def text(request, name):
-    storage = getstorage()
+def text(request, doc_id):
+    doc = get_object_or_404(Document, pk=doc_id, deleted=False)
+    # if not doc.book.accessible(request):
+    #     return HttpResponseForbidden("Not authorized.")

 
     if request.method == 'POST':
 
     if request.method == 'POST':

-        form = DocumentTextSaveForm(request.POST, prefix="textsave")
+        form = forms.DocumentTextSaveForm(request.POST, user=request.user, prefix="textsave")

         if form.is_valid():
         if form.is_valid():

-            revision = form.cleaned_data['parent_revision']
-            document = storage.get_or_404(name, revision)          
-            document.text = form.cleaned_data['text']
-            comment = form.cleaned_data['comment']
-            if form.cleaned_data['stage_completed']:        
-                comment += '\n#stage-finished: %s\n' % form.cleaned_data['stage_completed']         

             if request.user.is_authenticated():
             if request.user.is_authenticated():

-                author_name = request.user
-                author_email = request.user.email
+                author = request.user

             else:
             else:

-                author_name = form.cleaned_data['author_name']
-                author_email = form.cleaned_data['author_email']
-            author = "%s <%s>" % (author_name, author_email)
-            storage.put(document, author=author, comment=comment, parent=revision)           
-            document = storage.get(name)          
+                author = None
+            text = form.cleaned_data['text']
+            # parent_revision = form.cleaned_data['parent_revision']
+            # if parent_revision is not None:
+            #     parent = doc.at_revision(parent_revision)
+            # else:
+            #     parent = None
+            stage = form.cleaned_data['stage']
+            # tags = [stage] if stage else []
+            # publishable = (form.cleaned_data['publishable'] and
+            #                request.user.has_perm('catalogue.can_pubmark'))
+            try:
+                doc.commit(
+                    author=author,
+                    text=text,
+                    description=form.cleaned_data['comment'],
+                    author_name=form.cleaned_data['author_name'],
+                    author_email=form.cleaned_data['author_email'],
+                )
+                doc.set_stage(stage)
+            except:
+                from traceback import print_exc
+                print_exc()
+                raise
+            # revision = doc.revision()

             return JSONResponse({
             return JSONResponse({

-                'text': document.plain_text if revision != document.revision else None,
-                'meta': document.meta(),
-                'revision': document.revision,
+                'text': None,  # doc.materialize() if parent_revision != revision else None,
+                # 'version': revision,
+                # 'stage': doc.stage.name if doc.stage else None,
+                'assignment': doc.assigned_to.username if doc.assigned_to else None

             })
         else:
             return JSONFormInvalid(form)
     else:
         revision = request.GET.get("revision", None)
             })
         else:
             return JSONFormInvalid(form)
     else:
         revision = request.GET.get("revision", None)

-
+        

         try:
         try:

-            try:
-                revision = revision and int(revision)
-                logger.info("Fetching %s", revision)
-                document = storage.get(name, revision)
-            except ValueError:
-                # treat as a tag
-                logger.info("Fetching tag %s", revision)
-                document = storage.get_by_tag(name, revision)
-        except DocumentNotFound:
-            raise http.Http404
+            revision = int(revision)
+        except (ValueError, TypeError):
+            revision = doc.revision()
+
+        if revision is not None:
+            text = doc.at_revision(revision).materialize()
+        else:
+            text = ''

 
         return JSONResponse({
 
         return JSONResponse({

-            'text': document.plain_text,
-            'meta': document.meta(),
-            'revision': document.revision,
+            'text': text,
+            'meta': {},
+            'revision': revision,

         })
 
 
 @never_cache
         })
 
 
 @never_cache

-@normalized_name

 @require_POST
 @require_POST

-def revert(request, name):
-    storage = getstorage()
-    revision = request.POST['target_revision']
+def revert(request, doc_id):
+    form = forms.DocumentTextRevertForm(request.POST, prefix="textrevert")
+    if form.is_valid():
+        doc = get_object_or_404(Document, pk=doc_id, deleted=False)
+        rev = get_object_or_404(Revision, pk=form.cleaned_data['revision'])

 
 

-    try:
-        document = storage.revert(name, revision)
+        comment = form.cleaned_data['comment']
+        comment += "\n#revert to %s" % rev.pk
+
+        if request.user.is_authenticated():
+            author = request.user
+        else:
+            author = None
+
+        # before = doc.revision
+        logger.info("Reverting %s to %s", doc_id, rev.pk)
+
+        doc.commit(
+            author=author,
+            text=rev.materialize(),
+            description=comment,
+            # author_name=form.cleaned_data['author_name'], #?
+            # author_email=form.cleaned_data['author_email'], #?
+        )

 
         return JSONResponse({
 
         return JSONResponse({

-            'text': document.plain_text if revision != document.revision else None,
-            'meta': document.meta(),
-            'revision': document.revision,
+            # 'document': None, #doc.materialize() if before != doc.revision else None,
+            # 'version': doc.revision(),

         })
         })

-    except DocumentNotFound:
-        raise http.Http404
+    else:
+        return JSONFormInvalid(form)
+

 
 @never_cache
 def gallery(request, directory):
 
 @never_cache
 def gallery(request, directory):

+    if not request.user.is_authenticated():
+        return HttpResponseForbidden("Not authorized.")
+

     try:
         base_url = ''.join((
                         smart_unicode(settings.MEDIA_URL),
     try:
         base_url = ''.join((
                         smart_unicode(settings.MEDIA_URL),

-                        smart_unicode(settings.FILEBROWSER_DIRECTORY),
+                        smart_unicode(settings.IMAGE_DIR),

                         smart_unicode(directory)))
 
         base_dir = os.path.join(
                     smart_unicode(settings.MEDIA_ROOT),
                         smart_unicode(directory)))
 
         base_dir = os.path.join(
                     smart_unicode(settings.MEDIA_ROOT),

-                    smart_unicode(settings.FILEBROWSER_DIRECTORY),
+                    smart_unicode(settings.IMAGE_DIR),

                     smart_unicode(directory))
 
         def map_to_url(filename):
                     smart_unicode(directory))
 
         def map_to_url(filename):

-            return "%s/%s" % (base_url, smart_unicode(filename))
+            return urllib.quote("%s/%s" % (base_url, smart_unicode(filename)))

 
         def is_image(filename):
             return os.path.splitext(f)[1].lower() in (u'.jpg', u'.jpeg', u'.png')
 
         images = [map_to_url(f) for f in map(smart_unicode, os.listdir(base_dir)) if is_image(f)]
         images.sort()
 
         def is_image(filename):
             return os.path.splitext(f)[1].lower() in (u'.jpg', u'.jpeg', u'.png')
 
         images = [map_to_url(f) for f in map(smart_unicode, os.listdir(base_dir)) if is_image(f)]
         images.sort()

+

         return JSONResponse(images)
     except (IndexError, OSError):
         logger.exception("Unable to fetch gallery")
         return JSONResponse(images)
     except (IndexError, OSError):
         logger.exception("Unable to fetch gallery")


@@ -301,10 +215,7 @@ def gallery(request, directory):
 
 
 @never_cache
 
 
 @never_cache

-@normalized_name
-def diff(request, name):
-    storage = getstorage()
-
+def diff(request, doc_id):

     revA = int(request.GET.get('from', 0))
     revB = int(request.GET.get('to', 0))
 
     revA = int(request.GET.get('from', 0))
     revB = int(request.GET.get('to', 0))
 


@@ -314,57 +225,23 @@ def diff(request, name):
     if revB == 0:
         revB = None
 
     if revB == 0:
         revB = None
 

-    docA = storage.get_or_404(name, int(revA))
-    docB = storage.get_or_404(name, int(revB))
+    # TODO: check if revisions in line.

 
 

-    return http.HttpResponse(nice_diff.html_diff_table(docA.plain_text.splitlines(),
-                                         docB.plain_text.splitlines(), context=3))
-
-
-@never_cache
-@normalized_name
-def history(request, name):
-    storage = getstorage()
+    doc = get_object_or_404(Document, pk=doc_id, deleted=False)

 
 

-    # TODO: pagination
-    changesets = list(storage.history(name))
-
-    return JSONResponse(changesets)
-
-
-@require_POST
-@ajax_require_permission('wiki.can_change_tags')
-def add_tag(request, name):
-    name = normalize_name(name)
-    storage = getstorage()
-
-    form = DocumentTagForm(request.POST, prefix="addtag")
-    if form.is_valid():
-        doc = storage.get_or_404(form.cleaned_data['id'])
-        doc.add_tag(tag=form.cleaned_data['tag'],
-                    revision=form.cleaned_data['revision'],
-                    author=request.user.username)
-        return JSONResponse({"message": _("Tag added")})
+    # allow diff from the beginning
+    if revA:
+        docA = Revision.objects.get(pk=revA).materialize()

     else:
     else:

-        return JSONFormInvalid(form)
-
-
-@require_POST
-@ajax_require_permission('wiki.can_publish')
-def publish(request, name):
-    name = normalize_name(name)
-
-    storage = getstorage()
-    document = storage.get_by_tag(name, "ready_to_publish")
+        docA = ""
+    docB = Revision.objects.get(pk=revB).materialize()

 
 

-    api = wlapi.WLAPI(**settings.WL_API_CONFIG)
+    return http.HttpResponse(nice_diff.html_diff_table(docA.splitlines(), docB.splitlines(), context=3))

 
 

-    try:
-        return JSONResponse({"result": api.publish_book(document)})
-    except wlapi.APICallException, e:
-        return JSONServerError({"message": str(e)})

 
 

+@never_cache
+def history(request, doc_id):
+    # TODO: pagination
+    doc = get_object_or_404(Document, pk=doc_id, deleted=False)

 
 

-def themes(request):
-    prefix = request.GET.get('q', '')
-    return http.HttpResponse('\n'.join([str(t) for t in Theme.objects.filter(name__istartswith=prefix)]))
+    return JSONResponse(get_history(doc))