The actual commit.

[redakcja.git] / apps / api / handlers / library_handlers.py

diff --git a/apps/api/handlers/library_handlers.py b/apps/api/handlers/library_handlers.py
index 0ad23d9..2170b44 100644 (file)
--- a/apps/api/handlers/library_handlers.py
+++ b/apps/api/handlers/library_handlers.py
@@ -1,3 +1,4 @@
+import os.path

 # -*- encoding: utf-8 -*-
 
 __author__= "Łukasz Rekucki"
 # -*- encoding: utf-8 -*-
 
 __author__= "Łukasz Rekucki"


@@ -6,21 +7,27 @@ __doc__ = "Module documentation."
 
 from piston.handler import BaseHandler, AnonymousBaseHandler
 
 
 from piston.handler import BaseHandler, AnonymousBaseHandler
 

-
-import librarian
-import librarian.html
-import api.forms as forms
+import re

 from datetime import date
 
 from django.core.urlresolvers import reverse
 from datetime import date
 
 from django.core.urlresolvers import reverse

+from django.utils import simplejson as json

 
 

-from wlrepo import RevisionNotFound, LibraryException, DocumentAlreadyExists
+import librarian
+import librarian.html

 from librarian import dcparser
 
 from librarian import dcparser
 

+from wlrepo import *
+from explorer.models import PullRequest, GalleryForDocument
+
+# internal imports
+import api.forms as forms

 import api.response as response
 import api.response as response

-from api.utils import validate_form, hglibrary
+from api.utils import validate_form, hglibrary, natural_order
+from api.models import PartCache

 
 

-from explorer.models import PullRequest
+#
+import settings

 
 #
 # Document List Handlers
 
 #
 # Document List Handlers


@@ -46,11 +53,42 @@ class LibraryHandler(BaseHandler):
     def read(self, request, lib):
         """Return the list of documents."""
 
     def read(self, request, lib):
         """Return the list of documents."""
 

-        document_list = [{
-            'url': reverse('document_view', args=[docid]),
-            'name': docid } for docid in lib.documents() ]
+        documents = {}
+        
+        for docid in lib.documents():
+            docid = docid.decode('utf-8')
+            documents[docid] = {
+                'url': reverse('document_view', args=[docid]),
+                'name': docid,
+                'parts': []
+            }
+
+        parts = PartCache.objects.defer('part_id')\
+            .values_list('part_id', 'document_id').distinct()
+       
+        document_tree = dict(documents)
+
+        for part, docid in parts:
+            # this way, we won't display broken links
+            if not documents.has_key(part):
+                print "NOT FOUND:", part
+                continue
+
+            parent = documents[docid]
+            child = documents[part]
+
+            # not top-level anymore
+            document_tree.pop(part)
+            parent['parts'].append(child)
+
+        # sort the right way
+        

 
 

-        return {'documents' : document_list }        
+        for doc in documents.itervalues():
+            doc['parts'].sort(key=natural_order(lambda d: d['name']))
+            
+        return {'documents': sorted(document_tree.itervalues(),
+            key=natural_order(lambda d: d['name']) ) }

 
     @validate_form(forms.DocumentUploadForm, 'POST')
     @hglibrary
 
     @validate_form(forms.DocumentUploadForm, 'POST')
     @hglibrary


@@ -136,8 +174,9 @@ class DocumentHandler(BaseHandler):
         try:
             doc = lib.document(docid)
             udoc = doc.take(request.user.username)
         try:
             doc = lib.document(docid)
             udoc = doc.take(request.user.username)

-        except RevisionNotFound:
-            return request.EnityNotFound().django_response()
+        except RevisionNotFound, e:
+            return response.EntityNotFound().django_response({
+                'exception': type(e), 'message': e.message})

 
         # is_shared = udoc.ancestorof(doc)
         # is_uptodate = is_shared or shared.ancestorof(document)
 
         # is_shared = udoc.ancestorof(doc)
         # is_uptodate = is_shared or shared.ancestorof(document)


@@ -147,8 +186,12 @@ class DocumentHandler(BaseHandler):
             'html_url': reverse('dochtml_view', args=[udoc.id,udoc.revision]),
             'text_url': reverse('doctext_view', args=[udoc.id,udoc.revision]),
             'dc_url': reverse('docdc_view', args=[udoc.id,udoc.revision]),
             'html_url': reverse('dochtml_view', args=[udoc.id,udoc.revision]),
             'text_url': reverse('doctext_view', args=[udoc.id,udoc.revision]),
             'dc_url': reverse('docdc_view', args=[udoc.id,udoc.revision]),

+            'gallery_url': reverse('docgallery_view', args=[udoc.id]),
+            'merge_url': reverse('docmerge_view', args=[udoc.id]),

             'user_revision': udoc.revision,
             'user_revision': udoc.revision,

-            'public_revision': doc.revision,            
+            'user_timestamp': udoc.revision.timestamp,
+            'public_revision': doc.revision,
+            'public_timestamp': doc.revision.timestamp,

         }       
 
         return result
         }       
 
         return result


@@ -160,9 +203,8 @@ class DocumentHandler(BaseHandler):
 #
 #
 #
 #
 #
 #

-

 class DocumentHTMLHandler(BaseHandler):
 class DocumentHTMLHandler(BaseHandler):

-    allowed_methods = ('GET', 'PUT')
+    allowed_methods = ('GET')

 
     @hglibrary
     def read(self, request, docid, revision, lib):
 
     @hglibrary
     def read(self, request, docid, revision, lib):


@@ -173,13 +215,60 @@ class DocumentHTMLHandler(BaseHandler):
             else:
                 document = lib.document_for_rev(revision)
 
             else:
                 document = lib.document_for_rev(revision)
 

+            if document.id != docid:
+                return response.BadRequest().django_response({'reason': 'name-mismatch',
+                    'message': 'Provided revision refers, to document "%s", but provided "%s"' % (document.id, docid) })
+

             return librarian.html.transform(document.data('xml'), is_file=False)
             return librarian.html.transform(document.data('xml'), is_file=False)

-        except RevisionNotFound:
-            return response.EntityNotFound().django_response()
+        except (EntryNotFound, RevisionNotFound), e:
+            return response.EntityNotFound().django_response({
+                'exception': type(e), 'message': e.message})
+
+
+#
+# Image Gallery
+#
+from django.core.files.storage import FileSystemStorage
+
+class DocumentGalleryHandler(BaseHandler):
+    allowed_methods = ('GET')
+    
+    def read(self, request, docid):
+        """Read meta-data about scans for gallery of this document."""
+        galleries = []
+
+        for assoc in GalleryForDocument.objects.filter(document=docid):
+            dirpath = os.path.join(settings.MEDIA_ROOT, assoc.subpath)
+
+            if not os.path.isdir(dirpath):
+                print u"[WARNING]: missing gallery %s" % dirpath
+                continue
+
+            gallery = {'name': assoc.name, 'pages': []}
+            
+            for file in sorted(os.listdir(dirpath), key=natural_order()):
+                print file
+                name, ext = os.path.splitext(os.path.basename(file))
+
+                if ext.lower() not in ['.png', '.jpeg', '.jpg']:
+                    print "Ignoring:", name, ext
+                    continue
+
+                url = settings.MEDIA_URL + assoc.subpath + u'/' + file.decode('utf-8');
+                gallery['pages'].append(url)
+                
+            galleries.append(gallery)
+
+        return galleries                      

 
 #
 # Document Text View
 #
 
 #
 # Document Text View
 #

+
+XINCLUDE_REGEXP = r"""<(?:\w+:)?include\s+[^>]*?href=("|')wlrepo://(?P<link>[^\1]+?)\1\s*[^>]*?>"""
+#
+#
+#

 class DocumentTextHandler(BaseHandler):
     allowed_methods = ('GET', 'PUT')
 
 class DocumentTextHandler(BaseHandler):
     allowed_methods = ('GET', 'PUT')
 


@@ -191,11 +280,16 @@ class DocumentTextHandler(BaseHandler):
                 document = lib.document(docid)
             else:
                 document = lib.document_for_rev(revision)
                 document = lib.document(docid)
             else:
                 document = lib.document_for_rev(revision)

+
+            if document.id != docid:
+                return response.BadRequest().django_response({'reason': 'name-mismatch',
+                    'message': 'Provided revision is not valid for this document'})

             
             # TODO: some finer-grained access control
             return document.data('xml')
             
             # TODO: some finer-grained access control
             return document.data('xml')

-        except RevisionNotFound:
-            return response.EntityNotFound().django_response()
+        except (EntryNotFound, RevisionNotFound), e:
+            return response.EntityNotFound().django_response({
+                'exception': type(e), 'message': e.message})

 
     @hglibrary
     def update(self, request, docid, revision, lib):
 
     @hglibrary
     def update(self, request, docid, revision, lib):


@@ -216,21 +310,58 @@ class DocumentTextHandler(BaseHandler):
                         "provided_revision": orig.revision,
                         "latest_revision": current.revision })
 
                         "provided_revision": orig.revision,
                         "latest_revision": current.revision })
 

-            ndoc = current.quickwrite('xml', data, msg)
+            # try to find any Xinclude tags
+            includes = [m.groupdict()['link'] for m in (re.finditer(\
+                XINCLUDE_REGEXP, data, flags=re.UNICODE) or []) ]
+
+            print "INCLUDES: ", includes
+
+            # TODO: provide useful routines to make this simpler
+            def xml_update_action(lib, resolve):
+                try:
+                    f = lib._fileopen(resolve('parts'), 'r')
+                    stored_includes = json.loads(f.read())
+                    f.close()
+                except:
+                    stored_includes = []
+                
+                if stored_includes != includes:
+                    f = lib._fileopen(resolve('parts'), 'w+')
+                    f.write(json.dumps(includes))
+                    f.close()
+
+                    lib._fileadd(resolve('parts'))
+
+                    # update the parts cache
+                    PartCache.update_cache(docid, current.owner,\
+                        stored_includes, includes)
+
+                # now that the parts are ok, write xml
+                f = lib._fileopen(resolve('xml'), 'w+')
+                f.write(data.encode('utf-8'))
+                f.close()
+
+            ndoc = None
+            ndoc = current.invoke_and_commit(\
+                xml_update_action, lambda d: (msg, current.owner) )

 
             try:
                 # return the new revision number
 
             try:
                 # return the new revision number

-                return {
+                return response.SuccessAllOk().django_response({

                     "document": ndoc.id,
                     "subview": "xml",
                     "previous_revision": current.revision,
                     "document": ndoc.id,
                     "subview": "xml",
                     "previous_revision": current.revision,

-                    "updated_revision": ndoc.revision
-                }
+                    "revision": ndoc.revision,
+                    'timestamp': ndoc.revision.timestamp,
+                    "url": reverse("doctext_view", args=[ndoc.id, ndoc.revision])
+                })

             except Exception, e:
             except Exception, e:

-                lib._rollback()
+                if ndoc: lib._rollback()

                 raise e        
         except RevisionNotFound, e:
                 raise e        
         except RevisionNotFound, e:

-            return response.EntityNotFound().django_response(e)
+            return response.EntityNotFound(mimetype="text/plain").\
+                django_response(e.message)
+

 
 #
 # Dublin Core handlers
 
 #
 # Dublin Core handlers


@@ -248,11 +379,17 @@ class DocumentDublinCoreHandler(BaseHandler):
                 doc = lib.document(docid)
             else:
                 doc = lib.document_for_rev(revision)
                 doc = lib.document(docid)
             else:
                 doc = lib.document_for_rev(revision)

+
+
+            if document.id != docid:
+                return response.BadRequest().django_response({'reason': 'name-mismatch',
+                    'message': 'Provided revision is not valid for this document'})

             
             bookinfo = dcparser.BookInfo.from_string(doc.data('xml'))
             return bookinfo.serialize()
             
             bookinfo = dcparser.BookInfo.from_string(doc.data('xml'))
             return bookinfo.serialize()

-        except RevisionNotFound:
-            return response.EntityNotFound().django_response()
+        except (EntryNotFound, RevisionNotFound), e:
+            return response.EntityNotFound().django_response({
+                'exception': type(e), 'message': e.message})

 
     @hglibrary
     def update(self, request, docid, revision, lib):
 
     @hglibrary
     def update(self, request, docid, revision, lib):


@@ -286,10 +423,12 @@ class DocumentDublinCoreHandler(BaseHandler):
                     "document": ndoc.id,
                     "subview": "dc",
                     "previous_revision": current.revision,
                     "document": ndoc.id,
                     "subview": "dc",
                     "previous_revision": current.revision,

-                    "updated_revision": ndoc.revision
+                    "revision": ndoc.revision,
+                    'timestamp': ndoc.revision.timestamp,
+                    "url": reverse("docdc_view", args=[ndoc.id, ndoc.revision])

                 }
             except Exception, e:
                 }
             except Exception, e:

-                lib._rollback()
+                if ndoc: lib._rollback()

                 raise e
         except RevisionNotFound:
             return response.EntityNotFound().django_response()
                 raise e
         except RevisionNotFound:
             return response.EntityNotFound().django_response()


@@ -343,7 +482,7 @@ class MergeHandler(BaseHandler):
                 document=docid,
                 source_revision = str(udoc.revision),
                 status="N",
                 document=docid,
                 source_revision = str(udoc.revision),
                 status="N",

-                comment = form.cleaned_data['comment'] or '$AUTO$ Document shared.'
+                comment = form.cleaned_data['message'] or '$AUTO$ Document shared.'

             )
 
             prq.save()
             )
 
             prq.save()


@@ -351,16 +490,16 @@ class MergeHandler(BaseHandler):
                 ticket_status=prq.status, \
                 ticket_uri=reverse("pullrequest_view", args=[prq.id]) )
 
                 ticket_status=prq.status, \
                 ticket_uri=reverse("pullrequest_view", args=[prq.id]) )
 

-        if form.cleanded_data['type'] == 'update':
+        if form.cleaned_data['type'] == 'update':

             # update is always performed from the file branch
             # to the user branch
             success, changed = udoc.update(request.user.username)
 
             # update is always performed from the file branch
             # to the user branch
             success, changed = udoc.update(request.user.username)
 

-        if form.cleanded_data['type'] == 'share':
-            success, changed = udoc.share(form.cleaned_data['comment'])
+        if form.cleaned_data['type'] == 'share':
+            success, changed = udoc.share(form.cleaned_data['message'])

 
         if not success:
 
         if not success:

-            return response.EntityConflict().django_response()
+            return response.EntityConflict().django_response({})

 
         if not changed:
             return response.SuccessNoContent().django_response()
 
         if not changed:
             return response.SuccessNoContent().django_response()


@@ -371,5 +510,6 @@ class MergeHandler(BaseHandler):
             "name": udoc.id,
             "parent_user_resivion": udoc.revision,
             "parent_revision": doc.revision,
             "name": udoc.id,
             "parent_user_resivion": udoc.revision,
             "parent_revision": doc.revision,

-            "revision": udoc.revision,
-        })
\ No newline at end of file
+            "revision": ndoc.revision,
+            'timestamp': ndoc.revision.timestamp,
+        })