Merge branch 'master' into view-refactor
[redakcja.git] / apps / api / handlers / library_handlers.py
index 18dd3e8..5f844db 100644 (file)
@@ -7,18 +7,20 @@ __doc__ = "Module documentation."
 from piston.handler import BaseHandler, AnonymousBaseHandler
 
 
-import settings
 import librarian
+import librarian.html
 import api.forms as forms
 from datetime import date
 
 from django.core.urlresolvers import reverse
 
-from wlrepo import MercurialLibrary, RevisionNotFound, DocumentAlreadyExists
+from wlrepo import RevisionNotFound, LibraryException, DocumentAlreadyExists
 from librarian import dcparser
 
 import api.response as response
-from api.response import validate_form
+from api.utils import validate_form, hglibrary
+
+from explorer.models import PullRequest
 
 #
 # Document List Handlers
@@ -26,10 +28,9 @@ from api.response import validate_form
 class BasicLibraryHandler(AnonymousBaseHandler):
     allowed_methods = ('GET',)
 
-    def read(self, request):
-        """Return the list of documents."""
-        lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
-
+    @hglibrary
+    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() ]
@@ -41,9 +42,9 @@ class LibraryHandler(BaseHandler):
     allowed_methods = ('GET', 'POST')
     anonymous = BasicLibraryHandler
 
-    def read(self, request):
+    @hglibrary
+    def read(self, request, lib):
         """Return the list of documents."""
-        lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
 
         document_list = [{
             'url': reverse('document_view', args=[docid]),
@@ -52,34 +53,47 @@ class LibraryHandler(BaseHandler):
         return {'documents' : document_list }        
 
     @validate_form(forms.DocumentUploadForm, 'POST')
-    def create(self, request, form):
-        """Create a new document."""
-        lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+    @hglibrary
+    def create(self, request, form, lib):
+        """Create a new document."""       
 
         if form.cleaned_data['ocr_data']:
-            data = form.cleaned_data['ocr_data'].encode('utf-8')
+            data = form.cleaned_data['ocr_data']
         else:            
-            data = request.FILES['ocr'].read().decode('utf-8')
+            data = request.FILES['ocr_file'].read().decode('utf-8')
 
         if form.cleaned_data['generate_dc']:
             data = librarian.wrap_text(data, unicode(date.today()))
 
         docid = form.cleaned_data['bookname']
-        try:
-            doc = lib.document_create(docid)
-            doc.quickwrite('xml', data, '$AUTO$ XML data uploaded.',
-                user=request.user.username)
-
-            url = reverse('document_view', args=[doc.id])
 
-
-            return response.EntityCreated().django_response(\
-                body = {
-                    'url': url,
-                    'name': doc.id,
-                    'revision': doc.revision },
-                url = url )
-                
+        try:
+            lock = lib.lock()            
+            try:
+                doc = lib.document_create(docid)
+                # document created, but no content yet
+
+                try:
+                    doc = doc.quickwrite('xml', data.encode('utf-8'),
+                        '$AUTO$ XML data uploaded.', user=request.user.username)
+                except Exception,e:
+                    # rollback branch creation
+                    lib._rollback()
+                    raise LibraryException("Exception occured:" + repr(e))
+
+                url = reverse('document_view', args=[doc.id])
+
+                return response.EntityCreated().django_response(\
+                    body = {
+                        'url': url,
+                        'name': doc.id,
+                        'revision': doc.revision },
+                    url = url )            
+            finally:
+                lock.release()
+        except LibraryException, e:
+            return response.InternalError().django_response(\
+                {'exception': repr(e) })                
         except DocumentAlreadyExists:
             # Document is already there
             return response.EntityConflict().django_response(\
@@ -91,17 +105,18 @@ class LibraryHandler(BaseHandler):
 class BasicDocumentHandler(AnonymousBaseHandler):
     allowed_methods = ('GET',)
 
-    def read(self, request, docid):
-        try:
-            lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+    @hglibrary
+    def read(self, request, docid, lib):
+        try:    
             doc = lib.document(docid)
         except RevisionNotFound:
             return rc.NOT_FOUND
 
         result = {
             'name': doc.id,
-            'text_url': reverse('doctext_view', args=[doc.id]),
-            'dc_url': reverse('docdc_view', docid=doc.id),
+            'html_url': reverse('dochtml_view', args=[doc.id,doc.revision]),
+            'text_url': reverse('doctext_view', args=[doc.id,doc.revision]),
+            'dc_url': reverse('docdc_view', args=[doc.id,doc.revision]),
             'public_revision': doc.revision,
         }
 
@@ -114,10 +129,9 @@ class DocumentHandler(BaseHandler):
     allowed_methods = ('GET', 'PUT')
     anonymous = BasicDocumentHandler
 
-    def read(self, request, docid):
-        """Read document's meta data"""
-        lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
-        
+    @hglibrary
+    def read(self, request, docid, lib):
+        """Read document's meta data"""       
         try:
             doc = lib.document(docid)
             udoc = doc.take(request.user.username)
@@ -129,18 +143,38 @@ class DocumentHandler(BaseHandler):
 
         result = {
             'name': udoc.id,
-            'text_url': reverse('doctext_view', args=[udoc.id]),
-            'dc_url': reverse('docdc_view', args=[udoc.id]),
-            'parts_url': reverse('docparts_view', args=[udoc.id]),
+            '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]),
             'user_revision': udoc.revision,
             'public_revision': doc.revision,            
         }       
 
         return result
 
-    def update(self, request, docid):
+    @hglibrary
+    def update(self, request, docid, lib):
         """Update information about the document, like display not"""
         return
+#
+#
+#
+
+class DocumentHTMLHandler(BaseHandler):
+    allowed_methods = ('GET', 'PUT')
+
+    @hglibrary
+    def read(self, request, docid, revision, lib):
+        """Read document as html text"""
+        try:
+            if revision == 'latest':
+                document = lib.document(docid)
+            else:
+                document = lib.document_for_rev(revision)
+
+            return librarian.html.transform(document.data('xml'))
+        except RevisionNotFound:
+            return response.EntityNotFound().django_response()
 
 #
 # Document Text View
@@ -148,27 +182,24 @@ class DocumentHandler(BaseHandler):
 class DocumentTextHandler(BaseHandler):
     allowed_methods = ('GET', 'PUT')
 
-    @validate_form(forms.DocumentEntryRequest)
-    def read(self, request, form, docid):
-        """Read document as raw text"""        
-        lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
-        
+    @hglibrary
+    def read(self, request, docid, revision, lib):
+        """Read document as raw text"""               
         try:
-            if request.GET['revision'] == 'latest':
+            if revision == 'latest':
                 document = lib.document(docid)
             else:
-                document = lib.document_for_rev(request.GET['revision'])
+                document = lib.document_for_rev(revision)
             
             # TODO: some finer-grained access control
             return document.data('xml')
         except RevisionNotFound:
             return response.EntityNotFound().django_response()
 
-    def update(self, request, docid):
-        lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+    @hglibrary
+    def update(self, request, docid, revision, lib):
         try:
-            data = request.PUT['contents']
-            prev = request.PUT['revision']
+            data = request.PUT['contents']            
 
             if request.PUT.has_key('message'):
                 msg = u"$USER$ " + request.PUT['message']
@@ -176,7 +207,7 @@ class DocumentTextHandler(BaseHandler):
                 msg = u"$AUTO$ XML content update."
 
             current = lib.document(docid, request.user.username)
-            orig = lib.document_for_rev(prev)
+            orig = lib.document_for_rev(revision)
 
             if current != orig:
                 return response.EntityConflict().django_response({
@@ -184,15 +215,19 @@ class DocumentTextHandler(BaseHandler):
                         "provided_revision": orig.revision,
                         "latest_revision": current.revision })
 
-            ndoc = doc.quickwrite('xml', data, msg)
-
-            # return the new revision number
-            return {
-                "document": ndoc.id,
-                "subview": "xml",
-                "previous_revision": prev,
-                "updated_revision": ndoc.revision
-            }
+            ndoc = current.quickwrite('xml', data, msg)
+
+            try:
+                # return the new revision number
+                return {
+                    "document": ndoc.id,
+                    "subview": "xml",
+                    "previous_revision": current.revision,
+                    "updated_revision": ndoc.revision
+                }
+            except Exception, e:
+                lib.rollback()
+                raise e
         
         except (RevisionNotFound, KeyError):
             return response.EntityNotFound().django_response()
@@ -205,33 +240,31 @@ class DocumentTextHandler(BaseHandler):
 class DocumentDublinCoreHandler(BaseHandler):
     allowed_methods = ('GET', 'PUT')
 
-    @validate_form(forms.DocumentEntryRequest)
-    def read(self, request, docid):
-        """Read document as raw text"""
-        lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+    @hglibrary
+    def read(self, request, docid, revision, lib):
+        """Read document as raw text"""        
         try:
-            if request.GET['revision'] == 'latest':
+            if revision == 'latest':
                 document = lib.document(docid)
             else:
-                document = lib.document_for_rev(request.GET['revision'])                
+                document = lib.document_for_rev(revision)
             
             bookinfo = dcparser.BookInfo.from_string(doc.data('xml'))
             return bookinfo.serialize()
         except RevisionNotFound:
             return response.EntityNotFound().django_response()
 
-    def update(self, request, docid):
-        lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+    @hglibrary
+    def update(self, request, docid, revision, lib):
         try:
-            bi_json = request.PUT['contents']
-            prev = request.PUT['revision']
+            bi_json = request.PUT['contents']            
             if request.PUT.has_key('message'):
                 msg = u"$USER$ " + request.PUT['message']
             else:
                 msg = u"$AUTO$ Dublin core update."
 
             current = lib.document(docid, request.user.username)
-            orig = lib.document_for_rev(prev)
+            orig = lib.document_for_rev(revision)
 
             if current != orig:
                 return response.EntityConflict().django_response({
@@ -255,3 +288,82 @@ class DocumentDublinCoreHandler(BaseHandler):
             }
         except (RevisionNotFound, KeyError):
             return response.EntityNotFound().django_response()
+
+
+class MergeHandler(BaseHandler):
+    allowed_methods = ('POST',)
+
+    @validate_form(forms.MergeRequestForm)
+    @hglibrary
+    def create(self, request, form, docid, lib):
+        """Create a new document revision from the information provided by user"""
+
+        target_rev = form.cleaned_data['target_revision']
+
+        doc = lib.document(docid)
+        udoc = doc.take(request.user.username)
+
+        if target_rev == 'latest':
+            target_rev = udoc.revision
+
+        if udoc.revision != target_rev:
+            # user think doesn't know he has an old version
+            # of his own branch.
+            
+            # Updating is teorericly ok, but we need would
+            # have to force a refresh. Sharing may be not safe,
+            # 'cause it doesn't always result in update.
+
+            # In other words, we can't lie about the resource's state
+            # So we should just yield and 'out-of-date' conflict
+            # and let the client ask again with updated info.
+
+            # NOTE: this could result in a race condition, when there
+            # are 2 instances of the same user editing the same document.
+            # Instance "A" trying to update, and instance "B" always changing
+            # the document right before "A". The anwser to this problem is
+            # for the "A" to request a merge from 'latest' and then
+            # check the parent revisions in response, if he actually
+            # merge from where he thinks he should. If not, the client SHOULD
+            # update his internal state.
+            return response.EntityConflict().django_response({
+                    "reason": "out-of-date",
+                    "provided": target_revision,
+                    "latest": udoc.revision })
+
+        if not request.user.has_permission('explorer.pull_request.can_add'):
+            # User is not permitted to make a merge, right away
+            # So we instead create a pull request in the database
+            prq = PullRequest(
+                commiter=request.uset.username,
+                document=docid,
+                source_revision = udoc.revision,
+                status="N",
+                comment = form.cleaned_data['comment']
+            )
+
+            prq.save()
+            return response.RequestAccepted()
+
+        if form.cleanded_data['type'] == 'update':
+            # 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 not success:
+            return response.EntityConflict().django_response()
+
+        if not changed:
+            return response.SuccessNoContent().django_response()
+
+        new_udoc = udoc.latest()
+
+        return response.SuccessAllOk().django_response({
+            "name": udoc.id,
+            "parent_user_resivion": udoc.revision,
+            "parent_revision": doc.revision,
+            "revision": udoc.revision,
+        })
\ No newline at end of file