Change the way new document version are blocked, moving the logic to the documents app from the checkouts app signal handler. Disable the upload new document version button and have the new version upload view redirect to the document version list with a message. GitLab issue #231.

This commit is contained in:
Roberto Rosario
2015-10-23 06:06:59 -04:00
parent 414c55f824
commit da4c41c5b2
16 changed files with 395 additions and 141 deletions
+17
View File
@@ -0,0 +1,17 @@
from __future__ import unicode_literals
from django.utils.translation import ugettext
class DocumentException(Exception):
"""
Base documents warning
"""
pass
class NewDocumentVersionNotAllowed(DocumentException):
"""
Uploading new versions for this document is not allowed
"""
pass
+45 -34
View File
@@ -13,29 +13,22 @@ from .settings import setting_recent_count
logger = logging.getLogger(__name__)
class RecentDocumentManager(models.Manager):
def add_document_for_user(self, user, document):
if user.is_authenticated():
new_recent, created = self.model.objects.get_or_create(
user=user, document=document
)
if not created:
# document already in the recent list, just save to force
# accessed date and time update
new_recent.save()
class DocumentManager(models.Manager):
def delete_stubs(self):
for stale_stub_document in self.filter(is_stub=True, date_added__lt=now() - timedelta(seconds=STUB_EXPIRATION_INTERVAL)):
stale_stub_document.delete(trash=False)
recent_to_delete = self.filter(user=user).values_list('pk', flat=True)[setting_recent_count.value:]
self.filter(pk__in=list(recent_to_delete)).delete()
def get_by_natural_key(self, uuid):
return self.get(uuid=uuid)
def get_for_user(self, user):
document_model = apps.get_model('documents', 'document')
def get_queryset(self):
return TrashCanQuerySet(
self.model, using=self._db
).filter(in_trash=False)
if user.is_authenticated():
return document_model.objects.filter(
recentdocument__user=user
).order_by('-recentdocument__datetime_accessed')
else:
return document_model.objects.none()
def invalidate_cache(self):
for document in self.model.objects.all():
document.invalidate_cache()
class DocumentTypeManager(models.Manager):
@@ -105,28 +98,46 @@ class DocumentTypeManager(models.Manager):
return self.get(label=label)
class DocumentManager(models.Manager):
def delete_stubs(self):
for stale_stub_document in self.filter(is_stub=True, date_added__lt=now() - timedelta(seconds=STUB_EXPIRATION_INTERVAL)):
stale_stub_document.delete(trash=False)
class NewVersionBlockManager(models.Manager):
def block(self, document):
self.get_or_create(document=document)
def get_by_natural_key(self, uuid):
return self.get(uuid=uuid)
def unblock(self, document):
self.filter(document=document).delete()
def get_queryset(self):
return TrashCanQuerySet(
self.model, using=self._db
).filter(in_trash=False)
def invalidate_cache(self):
for document in self.model.objects.all():
document.invalidate_cache()
def is_blocked(self, document):
return self.filter(document=document).exists()
class PassthroughManager(models.Manager):
pass
class RecentDocumentManager(models.Manager):
def add_document_for_user(self, user, document):
if user.is_authenticated():
new_recent, created = self.model.objects.get_or_create(
user=user, document=document
)
if not created:
# document already in the recent list, just save to force
# accessed date and time update
new_recent.save()
recent_to_delete = self.filter(user=user).values_list('pk', flat=True)[setting_recent_count.value:]
self.filter(pk__in=list(recent_to_delete)).delete()
def get_for_user(self, user):
document_model = apps.get_model('documents', 'document')
if user.is_authenticated():
return document_model.objects.filter(
recentdocument__user=user
).order_by('-recentdocument__datetime_accessed')
else:
return document_model.objects.none()
class TrashCanManager(models.Manager):
def get_queryset(self):
return super(
@@ -0,0 +1,26 @@
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
from django.db import models, migrations
class Migration(migrations.Migration):
dependencies = [
('documents', '0027_auto_20150824_0702'),
]
operations = [
migrations.CreateModel(
name='NewVersionBlock',
fields=[
('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
('document', models.ForeignKey(verbose_name='Document', to='documents.Document')),
],
options={
'verbose_name': 'New version block',
'verbose_name_plural': 'New version blocks',
},
bases=(models.Model,),
),
]
+16 -2
View File
@@ -31,10 +31,11 @@ from .events import (
event_document_properties_edit, event_document_type_change,
event_document_version_revert
)
from .exceptions import NewDocumentVersionNotAllowed
from .literals import DEFAULT_DELETE_PERIOD, DEFAULT_DELETE_TIME_UNIT
from .managers import (
DocumentManager, DocumentTypeManager, PassthroughManager,
RecentDocumentManager, TrashCanManager
DocumentManager, DocumentTypeManager, NewVersionBlockManager,
PassthroughManager, RecentDocumentManager, TrashCanManager
)
from .permissions import permission_document_view
from .runtime import cache_storage_backend, storage_backend
@@ -397,6 +398,8 @@ class DocumentVersion(models.Model):
if new_document_version:
logger.info('Creating new version for document: %s', self.document)
if NewVersionBlock.objects.is_blocked(self.document):
raise NewDocumentVersionNotAllowed
try:
with transaction.atomic():
@@ -779,6 +782,17 @@ class DocumentPage(models.Model):
return '{}-{}'.format(self.document_version.uuid, self.pk)
class NewVersionBlock(models.Model):
document = models.ForeignKey(Document, verbose_name=_('Document'))
objects = NewVersionBlockManager()
class Meta:
verbose_name = _('New version block')
verbose_name_plural = _('New version blocks')
@python_2_unicode_compatible
class RecentDocument(models.Model):
"""
+54 -1
View File
@@ -6,8 +6,9 @@ import time
from django.core.files import File
from django.test import TestCase, override_settings
from ..exceptions import NewDocumentVersionNotAllowed
from ..literals import STUB_EXPIRATION_INTERVAL
from ..models import DeletedDocument, Document, DocumentType
from ..models import DeletedDocument, Document, DocumentType, NewVersionBlock
from .literals import (
TEST_DOCUMENT_TYPE, TEST_DOCUMENT_PATH, TEST_MULTI_PAGE_TIFF_PATH,
@@ -257,3 +258,55 @@ class DocumentManagerTestCase(TestCase):
Document.objects.delete_stubs()
self.assertEqual(Document.objects.count(), 0)
@override_settings(OCR_AUTO_OCR=False)
class NewVersionBlockTestCase(TestCase):
def setUp(self):
self.document_type = DocumentType.objects.create(
label=TEST_DOCUMENT_TYPE
)
with open(TEST_SMALL_DOCUMENT_PATH) as file_object:
self.document = self.document_type.new_document(
file_object=File(file_object)
)
def tearDown(self):
self.document.delete()
self.document_type.delete()
def test_blocking(self):
NewVersionBlock.objects.block(document=self.document)
self.assertEqual(NewVersionBlock.objects.count(), 1)
self.assertEqual(
NewVersionBlock.objects.first().document, self.document
)
def test_unblocking(self):
NewVersionBlock.objects.create(document=self.document)
NewVersionBlock.objects.unblock(document=self.document)
self.assertEqual(NewVersionBlock.objects.count(), 0)
def test_is_blocked(self):
NewVersionBlock.objects.create(document=self.document)
self.assertTrue(
NewVersionBlock.objects.is_blocked(document=self.document)
)
NewVersionBlock.objects.all().delete()
self.assertFalse(
NewVersionBlock.objects.is_blocked(document=self.document)
)
def test_blocking_new_versions(self):
NewVersionBlock.objects.block(document=self.document)
with self.assertRaises(NewDocumentVersionNotAllowed):
with open(TEST_SMALL_DOCUMENT_PATH) as file_object:
self.document.new_version(file_object=File(file_object))
+32 -1
View File
@@ -16,7 +16,9 @@ from user_management.tests.literals import (
)
from ..literals import DEFAULT_DELETE_PERIOD, DEFAULT_DELETE_TIME_UNIT
from ..models import DeletedDocument, Document, DocumentType, HASH_FUNCTION
from ..models import (
DeletedDocument, Document, DocumentType, NewVersionBlock, HASH_FUNCTION
)
from ..permissions import (
permission_document_download, permission_document_properties_edit,
permission_document_restore, permission_document_tools,
@@ -575,3 +577,32 @@ class DocumentTypeViewsTestCase(GenericDocumentViewTestCase):
DocumentType.objects.get(pk=self.document_type.pk).label,
TEST_DOCUMENT_TYPE_EDITED_LABEL
)
class NewDocumentVersionBlockViewTestCase(GenericDocumentViewTestCase):
def test_document_new_version_after_checkout(self):
"""
Gitlab issue #231
User shown option to upload new version of a document even though it
is blocked by checkout - v2.0.0b2
Expected results:
- Link to upload version view should not resolve
- Upload version view should reject request
"""
self.login(
username=TEST_ADMIN_USERNAME, password=TEST_ADMIN_PASSWORD
)
NewVersionBlock.objects.block(self.document)
response = self.post(
'sources:upload_version', args=(self.document.pk,),
follow=True
)
self.assertContains(
response, text='blocked from uploading',
status_code=200
)