Refactor checkouts app

Change "checkin" usage to "check_in".

Update URL parameters to the "_id" form.

Add support to checkout and check in multiple documents.

Optimize queries that used an ID list of documents for
filtering using values_list('pk', flat=True). These
queries now use .values('pk') as a subquery.

Add pre save hooks to block new document version uploads.

Signed-off-by: Roberto Rosario <Roberto.Rosario@mayan-edms.com>

mayan/apps/checkouts/managers.py

@@ -2,48 +2,54 @@ from __future__ import absolute_import, unicode_literals
 
 import logging
 
-from django.apps import apps
-from django.db import models
+from django.core.exceptions import PermissionDenied
+from django.db import models, transaction
 from django.utils.timezone import now
+from django.utils.translation import ugettext_lazy as _
 
+from mayan.apps.acls.models import AccessControlList
 from mayan.apps.documents.models import Document
 
 from .events import (
     event_document_auto_check_in, event_document_check_in,
     event_document_forceful_check_in
 )
-from .exceptions import DocumentNotCheckedOut
+from .exceptions import DocumentNotCheckedOut, NewDocumentVersionNotAllowed
 from .literals import STATE_CHECKED_IN, STATE_CHECKED_OUT
+from .permissions import permission_document_check_in_override
 
 logger = logging.getLogger(__name__)
 
 
 class DocumentCheckoutManager(models.Manager):
-    def are_document_new_versions_allowed(self, document, user=None):
-        try:
-            checkout_info = self.document_checkout_info(document=document)
-        except DocumentNotCheckedOut:
-            return True
-        else:
-            return not checkout_info.block_new_version
-
     def check_in_document(self, document, user=None):
         try:
             document_checkout = self.model.objects.get(document=document)
         except self.model.DoesNotExist:
-            raise DocumentNotCheckedOut
+            raise DocumentNotCheckedOut(
+                _('Document not checked out.')
+            )
         else:
-            if user:
-                if self.get_document_checkout_info(document=document).user != user:
-                    event_document_forceful_check_in.commit(
-                        actor=user, target=document
-                    )
+            with transaction.atomic():
+                if user:
+                    if self.get_document_checkout_info(document=document).user != user:
+                        try:
+                            AccessControlList.objects.check_access(
+                                obj=document, permission=permission_document_check_in_override,
+                                user=user
+                            )
+                        except PermissionDenied:
+                            return
+                        else:
+                            event_document_forceful_check_in.commit(
+                                actor=user, target=document
+                            )
+                    else:
+                        event_document_check_in.commit(actor=user, target=document)
                 else:
-                    event_document_check_in.commit(actor=user, target=document)
-            else:
-                event_document_auto_check_in.commit(target=document)
+                    event_document_auto_check_in.commit(target=document)
 
-            document_checkout.delete()
+                document_checkout.delete()
 
     def check_in_expired_check_outs(self):
         for document in self.get_expired_check_outs():
@@ -57,15 +63,10 @@ class DocumentCheckoutManager(models.Manager):
 
     def checked_out_documents(self):
         return Document.objects.filter(
-            pk__in=self.model.objects.all().values_list(
-                'document__pk', flat=True
-            )
+            pk__in=self.model.objects.values('document__id')
         )
 
     def get_by_natural_key(self, document_natural_key):
-        Document = apps.get_model(
-            app_label='documents', model_name='Document'
-        )
         try:
             document = Document.objects.get_by_natural_key(document_natural_key)
         except Document.DoesNotExist:
@@ -87,15 +88,15 @@ class DocumentCheckoutManager(models.Manager):
 
     def get_expired_check_outs(self):
         expired_list = Document.objects.filter(
-            pk__in=self.model.objects.filter(
+            pk__in=self.filter(
                 expiration_datetime__lte=now()
-            ).values_list('document__pk', flat=True)
+            ).values('document__id')
         )
         logger.debug('expired_list: %s', expired_list)
         return expired_list
 
     def is_document_checked_out(self, document):
-        if self.model.objects.filter(document=document):
+        if self.filter(document=document).exists():
             return True
         else:
             return False
@@ -105,13 +106,7 @@ class NewVersionBlockManager(models.Manager):
     def block(self, document):
         self.get_or_create(document=document)
 
-    def is_blocked(self, document):
-        return self.filter(document=document).exists()
-
     def get_by_natural_key(self, document_natural_key):
-        Document = apps.get_model(
-            app_label='documents', model_name='Document'
-        )
         try:
             document = Document.objects.get_by_natural_key(document_natural_key)
         except Document.DoesNotExist:
@@ -119,5 +114,12 @@ class NewVersionBlockManager(models.Manager):
 
         return self.get(document__pk=document.pk)
 
+    def is_blocked(self, document):
+        return self.filter(document=document).exists()
+
+    def new_versions_allowed(self, document):
+        if self.filter(document=document).exist():
+            raise NewDocumentVersionNotAllowed
+
     def unblock(self, document):
         self.filter(document=document).delete()