Dodanie Pygments do requirements.txt (używane do kolorowania diffów).

[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 f7d5784..f97ff6c
--- a/apps/api/handlers/library_handlers.py
+++ b/apps/api/handlers/library_handlers.py
@@ -9,16 +9,16 @@ __date__ = "$2009-09-25 15:49:50$"
 __doc__ = "Module documentation."
 
 from piston.handler import BaseHandler, AnonymousBaseHandler
 __doc__ = "Module documentation."
 
 from piston.handler import BaseHandler, AnonymousBaseHandler

+from django.http import HttpResponse

 
 

-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 django.db import IntegrityError
 
 import librarian
 import librarian.html
 from django.db import IntegrityError
 
 import librarian
 import librarian.html

+import difflib

 from librarian import dcparser, parser
 
 from wlrepo import *
 from librarian import dcparser, parser
 
 from wlrepo import *


@@ -29,7 +29,11 @@ from explorer.models import GalleryForDocument
 import api.forms as forms
 import api.response as response
 from api.utils import validate_form, hglibrary, natural_order
 import api.forms as forms
 import api.response as response
 from api.utils import validate_form, hglibrary, natural_order

-from api.models import PartCache
+from api.models import PartCache, PullRequest
+
+from pygments import highlight
+from pygments.lexers import DiffLexer
+from pygments.formatters import HtmlFormatter

 
 #
 import settings
 
 #
 import settings


@@ -38,18 +42,24 @@ import settings
 def is_prq(username):
     return username.startswith('$prq-')
 
 def is_prq(username):
     return username.startswith('$prq-')
 

+def prq_for_user(username):
+    try:
+        return PullRequest.objects.get(id=int(username[5:]))
+    except:
+        return None
+

 def check_user(request, user):
     log.info("user: %r, perm: %r" % (request.user, request.user.get_all_permissions()) )
     #pull request
     if is_prq(user):
 def check_user(request, user):
     log.info("user: %r, perm: %r" % (request.user, request.user.get_all_permissions()) )
     #pull request
     if is_prq(user):

-        if not request.user.has_perm('api.pullrequest.can_view'):
+        if not request.user.has_perm('api.view_prq'):

             yield response.AccessDenied().django_response({
                 'reason': 'access-denied',
                 'message': "You don't have enough priviliges to view pull requests."
             })
     # other users
     elif request.user.username != user:
             yield response.AccessDenied().django_response({
                 'reason': 'access-denied',
                 'message': "You don't have enough priviliges to view pull requests."
             })
     # other users
     elif request.user.username != user:

-        if not request.user.has_perm('api.document.can_view_other'):
+        if not request.user.has_perm('api.view_other_document'):

             yield response.AccessDenied().django_response({
                 'reason': 'access-denied',
                 'message': "You don't have enough priviliges to view other people's document."
             yield response.AccessDenied().django_response({
                 'reason': 'access-denied',
                 'message': "You don't have enough priviliges to view other people's document."


@@ -140,7 +150,6 @@ class LibraryHandler(BaseHandler):
                 log.info("DOCID %s", docid)
                 doc = lib.document_create(docid)
                 # document created, but no content yet
                 log.info("DOCID %s", docid)
                 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)
                 try:
                     doc = doc.quickwrite('xml', data.encode('utf-8'),
                         '$AUTO$ XML data uploaded.', user=request.user.username)


@@ -195,6 +204,30 @@ class BasicDocumentHandler(AnonymousBaseHandler):
 
         return result
 
 
         return result
 

+
+class DiffHandler(BaseHandler):
+    allowed_methods = ('GET',)
+    
+    @hglibrary
+    def read(self, request, docid, lib):
+        '''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"))
+
+

 #
 # Document Meta Data
 #
 #
 # Document Meta Data
 #


@@ -206,7 +239,7 @@ class DocumentHandler(BaseHandler):
     @hglibrary
     def read(self, request, form, docid, lib):
         """Read document's meta data"""       
     @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


@@ -229,28 +262,28 @@ class DocumentHandler(BaseHandler):
             # 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

-            if is_prq(user) or (user == request.user.username):
-                try:
+            try:
+                if user == request.user.username:

                     mdoc = lib.document(docid)
                     doc = mdoc.take(user)
                     mdoc = lib.document(docid)
                     doc = mdoc.take(user)

-
-                    if is_prq(user):
-                        # source revision, should probably change
-                        # but there are no changes yet, so...
-                        pass
-                    
-                except RevisionNotFound, e:
+                elif is_prq(user):
+                    prq = prq_for_user(user)
+                    # commiter's document
+                    prq_doc = lib.document_for_revision(prq.source_revision)
+                    doc = prq_doc.take(user)
+                else:

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

-                        'docid': docid
+                        'docid': docid,
+                        'user': user,

                     })
                     })

-            else:
+            except RevisionNotFound, e:

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

-                    'user': user,
+                    'user': user

                 })
 
         return {
                 })
 
         return {


@@ -280,12 +313,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({


@@ -311,9 +344,12 @@ class DocumentHTMLHandler(BaseHandler):
         except (EntryNotFound, RevisionNotFound), e:
             return response.EntityNotFound().django_response({
                 'reason': 'not-found', 'message': e.message})
         except (EntryNotFound, RevisionNotFound), e:
             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
 
 #
 # Image Gallery


@@ -337,7 +373,7 @@ class DocumentGalleryHandler(BaseHandler):
 
             gallery = {'name': assoc.name, 'pages': []}
             
 
             gallery = {'name': assoc.name, 'pages': []}
             

-            for file in sorted(os.listdir(dirpath)):
+            for file in os.listdir(dirpath):

                 if not isinstance(file, unicode):
                     try:
                         file = file.decode('utf-8')
                 if not isinstance(file, unicode):
                     try:
                         file = file.decode('utf-8')


@@ -360,167 +396,11 @@ 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)
 
             galleries.append(gallery)
 

-        return galleries                      
-
-#
-# Document Text View
-#
-
-XINCLUDE_REGEXP = r"""<(?:\w+:)?include\s+[^>]*?href=("|')wlrepo://(?P<link>[^\1]+?)\1\s*[^>]*?>"""
-#
-#
-#
-
-class DocumentTextHandler(BaseHandler):
-    allowed_methods = ('GET', 'POST')
-
-    @validate_form(forms.TextRetrieveForm, 'GET')
-    @hglibrary
-    def read(self, request, form, docid, lib):
-        """Read document as raw text"""        
-        try:
-            revision = form.cleaned_data['revision']
-            part = form.cleaned_data['part']
-            user = form.cleaned_data['user'] or request.user.username            
-            
-            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'
-                })
-
-            if document.owner != user:
-                return response.BadRequest().django_response({
-                    'reason': 'user-mismatch',
-                    'message': "Provided revision doesn't belong to user %s" % user
-                })
-
-            for error in check_user(request, user):
-                return error
-            
-            if not part:                
-                return document.data('xml')
-            
-            xdoc = parser.WLDocument.from_string(document.data('xml'),\
-                parse_dublincore=False)
-            ptext = xdoc.part_as_text(part)
-
-            if ptext is None:
-                return response.EntityNotFound().django_response({
-                      'reason': 'no-part-in-document'                     
-                })
-
-            return ptext
-        except librarian.ParseError, e:
-            return response.EntityNotFound().django_response({
-                'reason': 'invalid-document-state',
-                'exception': type(e),
-                'message': e.message
-            })
-        except (EntryNotFound, RevisionNotFound), e:
-            return response.EntityNotFound().django_response({
-                'reason': 'not-found',
-                'exception': type(e), 'message': e.message
-            })   
-
-    @validate_form(forms.TextUpdateForm, 'POST')
-    @hglibrary
-    def create(self, request, form, docid, lib):
-        try:
-            revision = form.cleaned_data['revision']
-            msg = form.cleaned_data['message']
-            user = form.cleaned_data['user'] or request.user.username
-
-            # do not allow changing not owned documents
-            # (for now... )
-            
-            
-            if user != request.user.username:
-                return response.AccessDenied().django_response({
-                    'reason': 'insufficient-priviliges',
-                })
-            
-            current = lib.document(docid, user)
-            orig = lib.document_for_rev(revision)
-
-            if current != orig:
-                return response.EntityConflict().django_response({
-                        "reason": "out-of-date",
-                        "provided_revision": orig.revision,
-                        "latest_revision": current.revision })
-            
-            if form.cleaned_data.has_key('contents'):
-                data = form.cleaned_data['contents']
-            else:                               
-                chunks = form.cleaned_data['chunks']
-                xdoc = parser.WLDocument.from_string(current.data('xml'))
-                errors = xdoc.merge_chunks(chunks)
-
-                if len(errors):
-                    return response.EntityConflict().django_response({
-                            "reason": "invalid-chunks",
-                            "message": "Unable to merge following parts into the document: %s " % ",".join(errors)
-                    })
-
-                data = xdoc.serialize()
-
-            # try to find any Xinclude tags
-            includes = [m.groupdict()['link'] for m in (re.finditer(\
-                XINCLUDE_REGEXP, data, flags=re.UNICODE) or []) ]
-
-            log.info("INCLUDES: %s", 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)
+        return galleries

 
 

-                # 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, user) )
-
-            try:
-                # return the new revision number
-                return response.SuccessAllOk().django_response({
-                    "document": ndoc.id,
-                    "user": user,
-                    "subview": "xml",
-                    "previous_revision": current.revision,
-                    "revision": ndoc.revision,
-                    'timestamp': ndoc.revision.timestamp,
-                    "url": reverse("doctext_view", args=[ndoc.id])
-                })
-            except Exception, e:
-                if ndoc: lib._rollback()
-                raise e        
-        except RevisionNotFound, e:
-            return response.EntityNotFound(mimetype="text/plain").\
-                django_response(e.message)

 
 
 #
 
 
 #


@@ -540,7 +420,7 @@ class DocumentTextHandler(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:


@@ -565,7 +445,7 @@ class DocumentTextHandler(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({


@@ -604,107 +484,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']
-
-        # fetch the main branch document
-        doc = lib.document(docid)
+        try:
+            revision = form.cleaned_data['revision']

 
 

-        # fetch the base document
-        user_doc = lib.document_for_rev(revision)
-        base_doc = user_doc.latest()
+            # fetch the main branch document
+            doc = lib.document(docid)

 
 

-        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
-            changed, clean = base_doc.update(request.user.username)
-
-            # update user document
-            if changed:
-                user_doc_new = user_doc.latest()
-            else:
-                user_doc_new = user_doc
-                
-            # shared document is the same
-            doc_new = doc
+            # fetch the base document
+            user_doc = lib.document_for_revision(revision)
+            base_doc = user_doc.latest()

 
 

-        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 yout branch to the latest version."
+            if base_doc != user_doc:
+                return response.EntityConflict().django_response({
+                    "reason": "out-of-date",
+                    "provided": str(user_doc.revision),
+                    "latest": str(base_doc.revision)

                 })
 
                 })
 

-            # 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."
-                })
+            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 not request.user.has_perm('api.document.can_share'):
-                # 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 user_doc_new == user_doc:
+                    return response.SuccessAllOk().django_response({
+                        "result": "no-op"

                     })
 
                     })
 

-            changed = base_doc.share(form.cleaned_data['message'])
-
-            # update shared version if needed
-            if changed:
-                doc_new = doc.latest()
-            else:
+                # shared document is the same

                 doc_new = doc
 
                 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
-        
-        return response.SuccessAllOk().django_response({
-            "name": user_doc_new.id,
-            "user": user_doc_new.owner,
+            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."
+                    })

 
 

-            "revision": user_doc_new.revision,
-            'timestamp': user_doc_new.revision.timestamp,
+                anwser, info = base_doc.would_share()

 
 

-            "parent_revision": user_doc_new.revision,
-            "parent_timestamp": user_doc_new.revision.timestamp,
+                if not anwser:
+                    return response.SuccessAllOk().django_response({
+                        "result": "no-op", "message": info
+                    })

 
 

-            "shared_revision": doc_new.revision,
-            "shared_timestamp": doc_new.revision.timestamp,
+                # 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_parent_revision": doc.revision,
-            "shared_parent_timestamp": doc.revision.timestamp,
-        })
\ No newline at end of file
+                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
+
+            return response.SuccessAllOk().django_response({
+                "result": "success",
+                "name": user_doc_new.id,
+                "user": user_doc_new.owner,
+
+                "revision": user_doc_new.revision,
+                'timestamp': user_doc_new.revision.timestamp,
+
+                "parent_revision": user_doc.revision,
+                "parent_timestamp": user_doc.revision.timestamp,
+
+                "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
+                    })