Poprawienie nazwy zmiennej "availble_themes" -> "available_themes".

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

diff --git a/apps/api/handlers/library_handlers.py b/apps/api/handlers/library_handlers.py
old mode 100644 (file)
new mode 100755 (executable)
index aef1e9c..e2d986e
--- a/apps/api/handlers/library_handlers.py
+++ b/apps/api/handlers/library_handlers.py
@@ -4,11 +4,8 @@ import os.path
 import logging
 log = logging.getLogger('platforma.api.library')
 
 import logging
 log = logging.getLogger('platforma.api.library')
 

-__author__= "Łukasz Rekucki"
-__date__ = "$2009-09-25 15:49:50$"
-__doc__ = "Module documentation."
-

 from piston.handler import BaseHandler, AnonymousBaseHandler
 from piston.handler import BaseHandler, AnonymousBaseHandler

+from piston.utils import rc

 
 from datetime import date
 
 
 from datetime import date
 


@@ -17,9 +14,9 @@ from django.db import IntegrityError
 
 import librarian
 import librarian.html
 
 import librarian
 import librarian.html

+import difflib
+import wlrepo 

 
 

-from wlrepo import *
-from api.models import PullRequest

 from explorer.models import GalleryForDocument
 
 # internal imports
 from explorer.models import GalleryForDocument
 
 # internal imports


@@ -28,6 +25,10 @@ import api.response as response
 from api.utils import validate_form, hglibrary, natural_order
 from api.models import PartCache, PullRequest
 
 from api.utils import validate_form, hglibrary, natural_order
 from api.models import PartCache, PullRequest
 

+from pygments import highlight
+from pygments.lexers import DiffLexer
+from pygments.formatters import HtmlFormatter
+

 #
 import settings
 
 #
 import settings
 


@@ -150,7 +151,7 @@ class LibraryHandler(BaseHandler):
                     import traceback
                     # rollback branch creation
                     lib._rollback()
                     import traceback
                     # rollback branch creation
                     lib._rollback()

-                    raise LibraryException(traceback.format_exc())
+                    raise wlrepo.LibraryException(traceback.format_exc())

 
                 url = reverse('document_view', args=[doc.id])
 
 
                 url = reverse('document_view', args=[doc.id])
 


@@ -162,12 +163,12 @@ class LibraryHandler(BaseHandler):
                     url = url )            
             finally:
                 lock.release()
                     url = url )            
             finally:
                 lock.release()

-        except LibraryException, e:
+        except wlrepo.LibraryException, e:

             import traceback
             return response.InternalError().django_response({
                 "reason": traceback.format_exc()
             })
             import traceback
             return response.InternalError().django_response({
                 "reason": traceback.format_exc()
             })

-        except DocumentAlreadyExists:
+        except wlrepo.DocumentAlreadyExists:

             # Document is already there
             return response.EntityConflict().django_response({
                 "reason": "already-exists",
             # Document is already there
             return response.EntityConflict().django_response({
                 "reason": "already-exists",


@@ -177,38 +178,41 @@ class LibraryHandler(BaseHandler):
 #
 # Document Handlers
 #
 #
 # Document Handlers
 #

-class BasicDocumentHandler(AnonymousBaseHandler):
-    allowed_methods = ('GET',)

 
 

+class DiffHandler(BaseHandler):
+    allowed_methods = ('GET',)
+    

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

-        try:    
-            doc = lib.document(docid)
-        except RevisionNotFound:
-            return rc.NOT_FOUND
-
-        result = {
-            'name': doc.id,
-            'html_url': reverse('dochtml_view', args=[doc.id]),
-            'text_url': reverse('doctext_view', args=[doc.id]),
-            'dc_url': reverse('docdc_view', args=[doc.id]),
-            'public_revision': doc.revision,
-        }
+        '''Return diff between source_revision and target_revision)'''        
+        revision = request.GET.get('revision')
+        if not revision:
+            return ''
+        source_document = lib.document(docid)
+        target_document = lib.document_for_revision(revision)
+        print source_document, target_document
+        
+        diff = difflib.unified_diff(
+            source_document.data('xml').splitlines(True),
+            target_document.data('xml').splitlines(True),
+            'source',
+            'target')
+        
+        s =  ''.join(list(diff))
+        return highlight(s, DiffLexer(), HtmlFormatter(cssclass="pastie"))

 
 

-        return result

 
 #
 # Document Meta Data
 #
 class DocumentHandler(BaseHandler):
     allowed_methods = ('GET', 'PUT')
 
 #
 # Document Meta Data
 #
 class DocumentHandler(BaseHandler):
     allowed_methods = ('GET', 'PUT')

-    anonymous = BasicDocumentHandler

 
     @validate_form(forms.DocumentRetrieveForm, 'GET')
     @hglibrary
     def read(self, request, form, docid, lib):
         """Read document's meta data"""       
 
     @validate_form(forms.DocumentRetrieveForm, 'GET')
     @hglibrary
     def read(self, request, form, docid, lib):
         """Read document's meta data"""       

-        log.info(u"User '%s' wants to %s(%s) as %s" % \
+        log.info(u"User '%s' wants to edit %s(%s) as %s" % \

             (request.user.username, docid, form.cleaned_data['revision'], form.cleaned_data['user']) )
 
         user = form.cleaned_data['user'] or request.user.username
             (request.user.username, docid, form.cleaned_data['revision'], form.cleaned_data['user']) )
 
         user = form.cleaned_data['user'] or request.user.username


@@ -219,7 +223,7 @@ class DocumentHandler(BaseHandler):
             
         try:
             doc = lib.document(docid, user, rev=rev)
             
         try:
             doc = lib.document(docid, user, rev=rev)

-        except RevisionMismatch, e:
+        except wlrepo.RevisionMismatch, e:

             # the document exists, but the revision is bad
             return response.EntityNotFound().django_response({
                 'reason': 'revision-mismatch',
             # the document exists, but the revision is bad
             return response.EntityNotFound().django_response({
                 'reason': 'revision-mismatch',


@@ -227,7 +231,7 @@ class DocumentHandler(BaseHandler):
                 'docid': docid,
                 'user': user,
             })
                 'docid': docid,
                 'user': user,
             })

-        except RevisionNotFound, e:
+        except wlrepo.RevisionNotFound, e:

             # the user doesn't have this document checked out
             # or some other weird error occured
             # try to do the checkout
             # the user doesn't have this document checked out
             # or some other weird error occured
             # try to do the checkout


@@ -238,7 +242,7 @@ class DocumentHandler(BaseHandler):
                 elif is_prq(user):
                     prq = prq_for_user(user)
                     # commiter's document
                 elif is_prq(user):
                     prq = prq_for_user(user)
                     # commiter's document

-                    prq_doc = lib.document_for_rev(prq.source_revision)
+                    prq_doc = lib.document_for_revision(prq.source_revision)

                     doc = prq_doc.take(user)
                 else:
                     return response.EntityNotFound().django_response({
                     doc = prq_doc.take(user)
                 else:
                     return response.EntityNotFound().django_response({


@@ -247,7 +251,7 @@ class DocumentHandler(BaseHandler):
                         'docid': docid,
                         'user': user,
                     })
                         'docid': docid,
                         'user': user,
                     })

-            except RevisionNotFound, e:
+            except wlrepo.RevisionNotFound, e:

                 return response.EntityNotFound().django_response({
                     'reason': 'document-not-found',
                     'message': e.message,
                 return response.EntityNotFound().django_response({
                     'reason': 'document-not-found',
                     'message': e.message,


@@ -282,12 +286,12 @@ class DocumentHTMLHandler(BaseHandler):
 
     @validate_form(forms.DocumentRetrieveForm, 'GET')
     @hglibrary
 
     @validate_form(forms.DocumentRetrieveForm, 'GET')
     @hglibrary

-    def read(self, request, form, docid, lib, stylesheet='partial'):
+    def read(self, request, form, docid, lib, stylesheet='full'):

         """Read document as html text"""
         try:
             revision = form.cleaned_data['revision']
             user = form.cleaned_data['user'] or request.user.username
         """Read document as html text"""
         try:
             revision = form.cleaned_data['revision']
             user = form.cleaned_data['user'] or request.user.username

-            document = lib.document_for_rev(revision)
+            document = lib.document_for_revision(revision)

 
             if document.id != docid:
                 return response.BadRequest().django_response({
 
             if document.id != docid:
                 return response.BadRequest().django_response({


@@ -310,19 +314,22 @@ class DocumentHTMLHandler(BaseHandler):
                     "with-paths": 'boolean(1)',                    
                 })
                 
                     "with-paths": 'boolean(1)',                    
                 })
                 

-        except (EntryNotFound, RevisionNotFound), e:
+        except (wlrepo.EntryNotFound, wlrepo.RevisionNotFound), e:

             return response.EntityNotFound().django_response({
                 'reason': 'not-found', 'message': e.message})
             return response.EntityNotFound().django_response({
                 'reason': 'not-found', 'message': e.message})

+        except librarian.ValidationError, e:
+            return response.InternalError().django_response({
+                'reason': 'xml-non-valid', 'message': e.message or u''})

         except librarian.ParseError, e:
             return response.InternalError().django_response({
         except librarian.ParseError, e:
             return response.InternalError().django_response({

-                'reason': 'xml-parse-error', 'message': e.message })
+                'reason': 'xml-parse-error', 'message': e.message or u'' })

 
 #
 # Image Gallery
 #
 
 class DocumentGalleryHandler(BaseHandler):
 
 #
 # Image Gallery
 #
 
 class DocumentGalleryHandler(BaseHandler):

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

     
     
     def read(self, request, docid):
     
     
     def read(self, request, docid):


@@ -362,12 +369,32 @@ class DocumentGalleryHandler(BaseHandler):
                     
                 gallery['pages'].append( quote(url.encode('utf-8')) )
 
                     
                 gallery['pages'].append( quote(url.encode('utf-8')) )
 

-#            gallery['pages'].sort()
+            gallery['pages'].sort()

             galleries.append(gallery)
 
         return galleries
 
             galleries.append(gallery)
 
         return galleries
 

-
+    def create(self, request, docid):
+        if not request.user.is_superuser:
+            return rc.FORBIDDEN
+        
+        new_path = request.POST.get('path')
+        
+        if new_path:
+            gallery, created = GalleryForDocument.objects.get_or_create(
+                document = docid,
+                defaults = {
+                    'subpath': new_path,
+                }
+            )
+
+            if not created:
+                gallery.subpath = new_path
+                gallery.save()
+
+            return rc.CREATED
+        
+        return rc.BAD_REQUEST

 
 #
 # Dublin Core handlers
 
 #
 # Dublin Core handlers


@@ -386,7 +413,7 @@ class DocumentGalleryHandler(BaseHandler):
 #            if revision == 'latest':
 #                doc = lib.document(docid)
 #            else:
 #            if revision == 'latest':
 #                doc = lib.document(docid)
 #            else:

-#                doc = lib.document_for_rev(revision)
+#                doc = lib.document_for_revision(revision)

 #
 #
 #            if document.id != docid:
 #
 #
 #            if document.id != docid:


@@ -411,7 +438,7 @@ class DocumentGalleryHandler(BaseHandler):
 #                msg = u"$AUTO$ Dublin core update."
 #
 #            current = lib.document(docid, request.user.username)
 #                msg = u"$AUTO$ Dublin core update."
 #
 #            current = lib.document(docid, request.user.username)

-#            orig = lib.document_for_rev(revision)
+#            orig = lib.document_for_revision(revision)

 #
 #            if current != orig:
 #                return response.EntityConflict().django_response({
 #
 #            if current != orig:
 #                return response.EntityConflict().django_response({


@@ -450,112 +477,125 @@ class MergeHandler(BaseHandler):
     @hglibrary
     def create(self, request, form, docid, lib):
         """Create a new document revision from the information provided by user"""
     @hglibrary
     def create(self, request, form, docid, lib):
         """Create a new document revision from the information provided by user"""

-        revision = form.cleaned_data['revision']
+        try:
+            revision = form.cleaned_data['revision']

 
 

-        # fetch the main branch document
-        doc = lib.document(docid)
+            # fetch the main branch document
+            doc = lib.document(docid)

 
 

-        # fetch the base document
-        user_doc = lib.document_for_rev(revision)
-        base_doc = user_doc.latest()
+            # fetch the base document
+            user_doc = lib.document_for_revision(revision)
+            base_doc = user_doc.latest()

 
 

-        if base_doc != user_doc:
-            return response.EntityConflict().django_response({
-                "reason": "out-of-date",
-                "provided": str(user_doc.revision),
-                "latest": str(base_doc.revision)
-            })      
-
-        if form.cleaned_data['type'] == 'update':
-            # update is always performed from the file branch
-            # to the user branch
-            user_doc_new = base_doc.update(request.user.username)
-
-            if user_doc_new == user_doc:
-                return response.SuccessAllOk().django_response({
-                    "result": "no-op"
+            if base_doc != user_doc:
+                return response.EntityConflict().django_response({
+                    "reason": "out-of-date",
+                    "provided": str(user_doc.revision),
+                    "latest": str(base_doc.revision)

                 })
                 })

-                
-            # shared document is the same
-            doc_new = doc

 
 

-        if form.cleaned_data['type'] == 'share':
-            if not base_doc.up_to_date():
-                return response.BadRequest().django_response({
-                    "reason": "not-fast-forward",
-                    "message": "You must first update your branch to the latest version."
-                })
+            if form.cleaned_data['type'] == 'update':
+                # update is always performed from the file branch
+                # to the user branch
+                user_doc_new = base_doc.update(request.user.username)

 
 

-            if base_doc.parentof(doc) or base_doc.has_parent_from(doc):
-                return response.SuccessAllOk().django_response({
-                    "result": "no-op"
-                })
+                if user_doc_new == user_doc:
+                    return response.SuccessAllOk().django_response({
+                        "result": "no-op"
+                    })

 
 

-            # check for unresolved conflicts            
-            if base_doc.has_conflict_marks():
-                return response.BadRequest().django_response({                    
-                    "reason": "unresolved-conflicts",
-                    "message": "There are unresolved conflicts in your file. Fix them, and try again."
-                })
+                # shared document is the same
+                doc_new = doc

 
 

-            if not request.user.has_perm('api.share_document'):
-                # User is not permitted to make a merge, right away
-                # So we instead create a pull request in the database
-                try:
-                    prq, created = PullRequest.objects.get_or_create(
-                        comitter = request.user,
-                        document = docid,
-                        status = "N",
-                        defaults = {
-                            'source_revision': str(base_doc.revision),
-                            'comment': form.cleaned_data['message'] or '$AUTO$ Document shared.',
-                        }
-                    )
-
-                    # there can't be 2 pending request from same user
-                    # for the same document
-                    if not created:
-                        prq.source_revision = str(base_doc.revision)
-                        prq.comment = prq.comment + 'u\n\n' + (form.cleaned_data['message'] or u'')
-                        prq.save()
-
-                    return response.RequestAccepted().django_response(\
-                        ticket_status=prq.status, \
-                        ticket_uri=reverse("pullrequest_view", args=[prq.id]) )
-                except IntegrityError:
-                    return response.EntityConflict().django_response({
-                        'reason': 'request-already-exist'
+            if form.cleaned_data['type'] == 'share':
+                if not base_doc.up_to_date():
+                    return response.BadRequest().django_response({
+                        "reason": "not-fast-forward",
+                        "message": "You must first update your branch to the latest version."

                     })
 
                     })
 

-            changed = base_doc.share(form.cleaned_data['message'])
+                anwser, info = base_doc.would_share()

 
 

-            # update shared version if needed
-            if changed:
-                doc_new = doc.latest()
-            else:
-                doc_new = doc
+                if not anwser:
+                    return response.SuccessAllOk().django_response({
+                        "result": "no-op", "message": info
+                    })

 
 

-            # the user wersion is the same
-            user_doc_new = base_doc
+                # check for unresolved conflicts
+                if base_doc.has_conflict_marks():
+                    return response.BadRequest().django_response({
+                        "reason": "unresolved-conflicts",
+                        "message": "There are unresolved conflicts in your file. Fix them, and try again."
+                    })

 
 

-        # The client can compare parent_revision to revision
-        # to see if he needs to update user's view        
-        # Same goes for shared view
-        
-        return response.SuccessAllOk().django_response({
-            "result": "success",
-            "name": user_doc_new.id,
-            "user": user_doc_new.owner,
+                if not request.user.has_perm('api.share_document'):
+                    # User is not permitted to make a merge, right away
+                    # So we instead create a pull request in the database
+                    try:
+                        prq, created = PullRequest.objects.get_or_create(
+                            comitter = request.user,
+                            document = docid,
+                            status = "N",
+                            defaults = {
+                                'source_revision': str(base_doc.revision),
+                                'comment': form.cleaned_data['message'] or '$AUTO$ Document shared.',
+                            }
+                        )
+
+                        # there can't be 2 pending request from same user
+                        # for the same document
+                        if not created:
+                            prq.source_revision = str(base_doc.revision)
+                            prq.comment = prq.comment + 'u\n\n' + (form.cleaned_data['message'] or u'')
+                            prq.save()
+
+                        return response.RequestAccepted().django_response(\
+                            ticket_status=prq.status, \
+                            ticket_uri=reverse("pullrequest_view", args=[prq.id]) )
+                    except IntegrityError:
+                        return response.EntityConflict().django_response({
+                            'reason': 'request-already-exist'
+                        })
+
+                changed = base_doc.share(form.cleaned_data['message'])
+
+                # update shared version if needed
+                if changed:
+                    doc_new = doc.latest()
+                else:
+                    doc_new = doc
+
+                # the user wersion is the same
+                user_doc_new = base_doc
+
+            # The client can compare parent_revision to revision
+            # to see if he needs to update user's view
+            # Same goes for shared view

 
 

-            "revision": user_doc_new.revision,
-            'timestamp': user_doc_new.revision.timestamp,
+            return response.SuccessAllOk().django_response({
+                "result": "success",
+                "name": user_doc_new.id,
+                "user": user_doc_new.owner,

 
 

-            "parent_revision": user_doc.revision,
-            "parent_timestamp": user_doc.revision.timestamp,
+                "revision": user_doc_new.revision,
+                'timestamp': user_doc_new.revision.timestamp,

 
 

-            "shared_revision": doc_new.revision,
-            "shared_timestamp": doc_new.revision.timestamp,
+                "parent_revision": user_doc.revision,
+                "parent_timestamp": user_doc.revision.timestamp,

 
 

-            "shared_parent_revision": doc.revision,
-            "shared_parent_timestamp": doc.revision.timestamp,
-        })
\ No newline at end of file
+                "shared_revision": doc_new.revision,
+                "shared_timestamp": doc_new.revision.timestamp,
+
+                "shared_parent_revision": doc.revision,
+                "shared_parent_timestamp": doc.revision.timestamp,
+            })
+        except wlrepo.OutdatedException, e:
+            return response.BadRequest().django_response({
+                        "reason": "not-fast-forward",
+                        "message": e.message
+                    })
+        except wlrepo.LibraryException, e:
+            return response.InternalError().django_response({
+                        "reason": "merge-error",
+                        "message": e.message
+                    })