147 lines
4.4 KiB
Python
147 lines
4.4 KiB
Python
from __future__ import unicode_literals
|
|
|
|
import logging
|
|
|
|
from django.conf import settings
|
|
from django.core.exceptions import ValidationError
|
|
from django.db import models, transaction
|
|
from django.urls import reverse
|
|
from django.utils.encoding import force_text, python_2_unicode_compatible
|
|
from django.utils.timezone import now
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from mayan.apps.documents.models import Document
|
|
|
|
from .events import event_document_check_out
|
|
from .exceptions import DocumentAlreadyCheckedOut
|
|
from .managers import (
|
|
DocumentCheckoutBusinessLogicManager, DocumentCheckoutManager,
|
|
NewVersionBlockManager
|
|
)
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@python_2_unicode_compatible
|
|
class DocumentCheckout(models.Model):
|
|
"""
|
|
Model to store the state and information of a document checkout.
|
|
"""
|
|
document = models.OneToOneField(
|
|
on_delete=models.CASCADE, to=Document, verbose_name=_('Document')
|
|
)
|
|
checkout_datetime = models.DateTimeField(
|
|
auto_now_add=True, verbose_name=_('Check out date and time')
|
|
)
|
|
expiration_datetime = models.DateTimeField(
|
|
help_text=_(
|
|
'Amount of time to hold the document checked out in minutes.'
|
|
),
|
|
verbose_name=_('Check out expiration date and time')
|
|
)
|
|
user = models.ForeignKey(
|
|
on_delete=models.CASCADE, to=settings.AUTH_USER_MODEL,
|
|
verbose_name=_('User')
|
|
)
|
|
block_new_version = models.BooleanField(
|
|
default=True,
|
|
help_text=_(
|
|
'Do not allow new version of this document to be uploaded.'
|
|
),
|
|
verbose_name=_('Block new version upload')
|
|
)
|
|
|
|
objects = DocumentCheckoutManager()
|
|
business_logic = DocumentCheckoutBusinessLogicManager()
|
|
|
|
class Meta:
|
|
ordering = ('pk',)
|
|
verbose_name = _('Document checkout')
|
|
verbose_name_plural = _('Document checkouts')
|
|
|
|
def __str__(self):
|
|
return force_text(self.document)
|
|
|
|
def clean(self):
|
|
if self.expiration_datetime < now():
|
|
raise ValidationError(
|
|
_('Check out expiration date and time must be in the future.')
|
|
)
|
|
|
|
def delete(self, *args, **kwargs):
|
|
with transaction.atomic():
|
|
NewVersionBlock.objects.unblock(document=self.document)
|
|
super(DocumentCheckout, self).delete(*args, **kwargs)
|
|
|
|
def get_absolute_url(self):
|
|
return reverse(
|
|
viewname='checkout:checkout_info', kwargs={
|
|
'pk': self.document.pk
|
|
}
|
|
)
|
|
|
|
def natural_key(self):
|
|
return self.document.natural_key()
|
|
natural_key.dependencies = ['documents.Document']
|
|
|
|
def save(self, *args, **kwargs):
|
|
is_new = not self.pk
|
|
if not is_new or self.document.is_checked_out():
|
|
raise DocumentAlreadyCheckedOut
|
|
|
|
with transaction.atomic():
|
|
result = super(DocumentCheckout, self).save(*args, **kwargs)
|
|
if is_new:
|
|
event_document_check_out.commit(
|
|
actor=self.user, target=self.document
|
|
)
|
|
if self.block_new_version:
|
|
NewVersionBlock.objects.block(self.document)
|
|
|
|
logger.info(
|
|
'Document "%s" checked out by user "%s"',
|
|
self.document, self.user
|
|
)
|
|
|
|
return result
|
|
|
|
|
|
class NewVersionBlock(models.Model):
|
|
"""
|
|
Model to keep track of which documents have new version upload restricted.
|
|
"""
|
|
document = models.ForeignKey(
|
|
on_delete=models.CASCADE, to=Document, verbose_name=_('Document')
|
|
)
|
|
|
|
objects = NewVersionBlockManager()
|
|
|
|
class Meta:
|
|
verbose_name = _('New version block')
|
|
verbose_name_plural = _('New version blocks')
|
|
|
|
def natural_key(self):
|
|
return self.document.natural_key()
|
|
natural_key.dependencies = ['documents.Document']
|
|
|
|
|
|
class CheckedOutDocument(Document):
|
|
class Meta:
|
|
proxy = True
|
|
|
|
def get_user_display(self):
|
|
check_out_info = self.get_check_out_info()
|
|
return check_out_info.user.get_full_name() or check_out_info.user
|
|
|
|
get_user_display.short_description = _('User')
|
|
|
|
def get_checkout_datetime(self):
|
|
return self.get_check_out_info().checkout_datetime
|
|
|
|
get_checkout_datetime.short_description = _('Checkout time and date')
|
|
|
|
def get_checkout_expiration(self):
|
|
return self.get_check_out_info().expiration_datetime
|
|
|
|
get_checkout_expiration.short_description = _('Checkout expiration')
|