Files
mayan-edms/mayan/apps/documents/views.py
Roberto Rosario 84493b7a72 PEP8 Cleanups
2014-11-11 14:58:37 -04:00

1308 lines
55 KiB
Python

from __future__ import absolute_import
import logging
import urlparse
from django.conf import settings
from django.contrib import messages
from django.core.exceptions import PermissionDenied
from django.core.urlresolvers import reverse
from django.http import HttpResponseRedirect
from django.shortcuts import render_to_response, get_object_or_404
from django.template import RequestContext
from django.utils.http import urlencode
from django.utils.translation import ugettext_lazy as _, ungettext
import sendfile
from acls.models import AccessEntry
from common.compressed_files import CompressedFile
from common.utils import encapsulate, pretty_size, parse_range, urlquote
from common.views import SingleObjectListView
from common.widgets import two_state_template
from converter.literals import (DEFAULT_FILE_FORMAT_MIMETYPE, DEFAULT_PAGE_NUMBER,
DEFAULT_ROTATION, DEFAULT_ZOOM_LEVEL)
from filetransfers.api import serve_file
from history.api import create_history
from navigation.utils import resolve_to_name
from permissions.models import Permission
from .events import HISTORY_DOCUMENT_EDITED
from .forms import (DocumentContentForm, DocumentDownloadForm, DocumentForm,
DocumentPageForm, DocumentPageForm_edit,
DocumentPageForm_text, DocumentPageTransformationForm,
DocumentPreviewForm, DocumentPropertiesForm,
DocumentTypeForm, DocumentTypeFilenameForm,
DocumentTypeFilenameForm_create, DocumentTypeSelectForm,
PrintForm)
from .models import (Document, DocumentType, DocumentPage,
DocumentPageTransformation, DocumentTypeFilename,
DocumentVersion, RecentDocument)
from .permissions import (PERMISSION_DOCUMENT_PROPERTIES_EDIT,
PERMISSION_DOCUMENT_VIEW, PERMISSION_DOCUMENT_DELETE,
PERMISSION_DOCUMENT_DOWNLOAD, PERMISSION_DOCUMENT_TRANSFORM,
PERMISSION_DOCUMENT_TOOLS, PERMISSION_DOCUMENT_EDIT,
PERMISSION_DOCUMENT_VERSION_REVERT, PERMISSION_DOCUMENT_TYPE_EDIT,
PERMISSION_DOCUMENT_TYPE_DELETE, PERMISSION_DOCUMENT_TYPE_CREATE,
PERMISSION_DOCUMENT_TYPE_VIEW)
from .runtime import storage_backend
from .settings import (PREVIEW_SIZE, RECENT_COUNT, ROTATION_STEP,
ZOOM_PERCENT_STEP, ZOOM_MAX_LEVEL, ZOOM_MIN_LEVEL)
from .tasks import (task_clear_image_cache, task_get_document_image,
task_update_page_count)
logger = logging.getLogger(__name__)
class DocumentListView(SingleObjectListView):
queryset = Document.objects.all()
object_permission = PERMISSION_DOCUMENT_VIEW
extra_context = {
'title': _(u'All documents'),
'hide_links': True,
}
def document_list(request, object_list=None, title=None, extra_context=None):
pre_object_list = object_list if not (object_list is None) else Document.objects.all()
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
# If user doesn't have global permission, get a list of document
# for which he/she does hace access use it to filter the
# provided object_list
final_object_list = AccessEntry.objects.filter_objects_by_access(
PERMISSION_DOCUMENT_VIEW, request.user, pre_object_list)
else:
final_object_list = pre_object_list
context = {
'object_list': final_object_list,
'title': title if title else _(u'documents'),
'hide_links': True,
}
if extra_context:
context.update(extra_context)
return render_to_response('main/generic_list.html', context,
context_instance=RequestContext(request))
def document_view(request, document_id, advanced=False):
document = get_object_or_404(Document, pk=document_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document)
document.add_as_recent_document_for_user(request.user)
subtemplates_list = []
if advanced:
document_fields = [
{'label': _(u'Date added'), 'field': lambda x: x.date_added.date()},
{'label': _(u'Time added'), 'field': lambda x: unicode(x.date_added.time()).split('.')[0]},
{'label': _(u'UUID'), 'field': 'uuid'},
]
if document.latest_version:
document_fields.extend([
{'label': _(u'File mimetype'), 'field': lambda x: x.file_mimetype or _(u'None')},
{'label': _(u'File encoding'), 'field': lambda x: x.file_mime_encoding or _(u'None')},
{'label': _(u'File size'), 'field': lambda x: pretty_size(x.size) if x.size else '-'},
{'label': _(u'Exists in storage'), 'field': 'exists'},
{'label': _(u'File path in storage'), 'field': 'file'},
{'label': _(u'Checksum'), 'field': 'checksum'},
{'label': _(u'Pages'), 'field': 'page_count'},
])
document_properties_form = DocumentPropertiesForm(instance=document, extra_fields=document_fields)
subtemplates_list.append(
{
'name': 'main/generic_form_subtemplate.html',
'context': {
'form': document_properties_form,
'object': document,
'title': _(u'Document properties for: %s') % document,
}
},
)
else:
preview_form = DocumentPreviewForm(document=document)
subtemplates_list.append(
{
'name': 'main/generic_form_subtemplate.html',
'context': {
'form': preview_form,
'object': document,
}
},
)
content_form = DocumentContentForm(document=document)
subtemplates_list.append(
{
'name': 'main/generic_form_subtemplate.html',
'context': {
'title': _(u'Document data'),
'form': content_form,
'object': document,
},
}
)
return render_to_response('main/generic_detail.html', {
'object': document,
'document': document,
'subtemplates_list': subtemplates_list,
'disable_auto_focus': True,
}, context_instance=RequestContext(request))
def document_delete(request, document_id=None, document_id_list=None):
post_action_redirect = None
if document_id:
documents = [get_object_or_404(Document, pk=document_id)]
post_action_redirect = reverse('documents:document_list_recent')
elif document_id_list:
documents = [get_object_or_404(Document, pk=document_id) for document_id in document_id_list.split(',')]
else:
messages.error(request, _(u'Must provide at least one document.'))
return HttpResponseRedirect(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_DELETE])
except PermissionDenied:
documents = AccessEntry.objects.filter_objects_by_access(PERMISSION_DOCUMENT_DELETE, request.user, documents, exception_on_empty=True)
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
next = request.POST.get('next', request.GET.get('next', post_action_redirect if post_action_redirect else request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
if request.method == 'POST':
for document in documents:
try:
document.delete()
# create_history(HISTORY_DOCUMENT_DELETED, data={'user': request.user, 'document': document})
messages.success(request, _(u'Document deleted successfully.'))
except Exception as exception:
messages.error(request, _(u'Document: %(document)s delete error: %(error)s') % {
'document': document, 'error': exception
})
return HttpResponseRedirect(next)
context = {
'delete_view': True,
'previous': previous,
'next': next,
}
if len(documents) == 1:
context['object'] = documents[0]
context['title'] = _(u'Are you sure you wish to delete the document: %s?') % ', '.join([unicode(d) for d in documents])
elif len(documents) > 1:
context['title'] = _(u'Are you sure you wish to delete the documents: %s?') % ', '.join([unicode(d) for d in documents])
return render_to_response('main/generic_confirm.html', context,
context_instance=RequestContext(request))
def document_multiple_delete(request):
return document_delete(
request, document_id_list=request.GET.get('id_list', [])
)
def document_edit(request, document_id):
document = get_object_or_404(Document, pk=document_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_PROPERTIES_EDIT])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_PROPERTIES_EDIT, request.user, document)
if request.method == 'POST':
form = DocumentForm(request.POST, instance=document)
if form.is_valid():
document.label = form.cleaned_data['label']
document.description = form.cleaned_data['description']
document.language = form.cleaned_data['language']
if 'document_type_available_filenames' in form.cleaned_data:
if form.cleaned_data['document_type_available_filenames']:
document.label = form.cleaned_data['document_type_available_filenames'].filename
document.save()
create_history(HISTORY_DOCUMENT_EDITED, document, {'user': request.user})
document.add_as_recent_document_for_user(request.user)
messages.success(request, _(u'Document "%s" edited successfully.') % document)
return HttpResponseRedirect(document.get_absolute_url())
else:
form = DocumentForm(instance=document)
return render_to_response('main/generic_form.html', {
'form': form,
'object': document,
'title': _('Edit properties of: %s') % document,
}, context_instance=RequestContext(request))
def document_document_type_edit(request, document_id=None, document_id_list=None):
post_action_redirect = None
if document_id:
documents = [get_object_or_404(Document, pk=document_id)]
post_action_redirect = reverse('documents:document_list_recent')
elif document_id_list:
documents = [get_object_or_404(Document, pk=document_id) for document_id in document_id_list.split(',')]
else:
messages.error(request, _(u'Must provide at least one document.'))
return HttpResponseRedirect(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_PROPERTIES_EDIT])
except PermissionDenied:
documents = AccessEntry.objects.filter_objects_by_access(PERMISSION_DOCUMENT_PROPERTIES_EDIT, request.user, documents, exception_on_empty=True)
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
next = request.POST.get('next', request.GET.get('next', post_action_redirect if post_action_redirect else request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
if request.method == 'POST':
form = DocumentTypeSelectForm(request.POST)
if form.is_valid():
for document in documents:
document.set_document_type(form.cleaned_data['document_type'])
create_history(HISTORY_DOCUMENT_EDITED, document, {'user': request.user})
document.add_as_recent_document_for_user(request.user)
messages.success(request, _(u'Document type changed successfully.'))
return HttpResponseRedirect(next)
else:
form = DocumentTypeSelectForm(initial={'document_type': documents[0].document_type})
context = {
'form': form,
'submit_label': _('Submit'),
'previous': previous,
'next': next,
}
if len(documents) == 1:
context['object'] = documents[0]
context['title'] = _(u'Are you sure you wish to change the type of the document: %s?') % ', '.join([unicode(d) for d in documents])
elif len(documents) > 1:
context['title'] = _(u'Are you sure you wish to change the type of the documents: %s?') % ', '.join([unicode(d) for d in documents])
return render_to_response('main/generic_form.html', context,
context_instance=RequestContext(request))
def document_multiple_document_type_edit(request):
return document_document_type_edit(
request, document_id_list=request.GET.get('id_list', [])
)
# TODO: Get rid of this view and convert widget to use API and base64 only images
def get_document_image(request, document_id, size=PREVIEW_SIZE):
document = get_object_or_404(Document, pk=document_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document)
page = int(request.GET.get('page', DEFAULT_PAGE_NUMBER))
zoom = int(request.GET.get('zoom', DEFAULT_ZOOM_LEVEL))
version = int(request.GET.get('version', document.latest_version.pk))
if zoom < ZOOM_MIN_LEVEL:
zoom = ZOOM_MIN_LEVEL
if zoom > ZOOM_MAX_LEVEL:
zoom = ZOOM_MAX_LEVEL
rotation = int(request.GET.get('rotation', DEFAULT_ROTATION)) % 360
task = task_get_document_image.apply_async(kwargs=dict(document_id=document.pk, size=size, page=page, zoom=zoom, rotation=rotation, as_base64=False, version=version), queue='converter')
return sendfile.sendfile(request, task.get(timeout=10), mimetype=DEFAULT_FILE_FORMAT_MIMETYPE)
def document_download(request, document_id=None, document_id_list=None, document_version_pk=None):
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
if document_id:
document_versions = [get_object_or_404(Document, pk=document_id).latest_version]
elif document_id_list:
document_versions = [get_object_or_404(Document, pk=document_id).latest_version for document_id in document_id_list.split(',')]
elif document_version_pk:
document_versions = [get_object_or_404(DocumentVersion, pk=document_version_pk)]
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_DOWNLOAD])
except PermissionDenied:
document_versions = AccessEntry.objects.filter_objects_by_access(PERMISSION_DOCUMENT_DOWNLOAD, request.user, document_versions, related='document', exception_on_empty=True)
subtemplates_list = []
subtemplates_list.append(
{
'name': 'main/generic_list_subtemplate.html',
'context': {
'title': _(u'Documents to be downloaded'),
'object_list': document_versions,
'hide_link': True,
'hide_object': True,
'hide_links': True,
'scrollable_content': True,
'scrollable_content_height': '200px',
'extra_columns': [
{'name': _(u'Document'), 'attribute': 'document'},
{'name': _(u'Version'), 'attribute': encapsulate(lambda x: x.get_formated_version())},
],
}
}
)
if request.method == 'POST':
form = DocumentDownloadForm(request.POST, document_versions=document_versions)
if form.is_valid():
if form.cleaned_data['compressed'] or len(document_versions) > 1:
try:
compressed_file = CompressedFile()
for document_version in document_versions:
descriptor = document_version.open()
compressed_file.add_file(descriptor, arcname=document_version.document.label)
descriptor.close()
compressed_file.close()
return serve_file(
request,
compressed_file.as_file(form.cleaned_data['zip_filename']),
save_as=u'"%s"' % form.cleaned_data['zip_filename'],
content_type='application/zip'
)
# TODO: DO a redirection afterwards
except Exception as exception:
if settings.DEBUG:
raise
else:
messages.error(request, exception)
return HttpResponseRedirect(request.META['HTTP_REFERER'])
else:
try:
# Test permissions and trigger exception
fd = document_versions[0].open()
fd.close()
return serve_file(
request,
document_versions[0].file,
save_as=u'"%s"' % document_versions[0].document.label,
content_type=document_versions[0].mimetype if document_versions[0].mimetype else 'application/octet-stream'
)
except Exception as exception:
if settings.DEBUG:
raise
else:
messages.error(request, exception)
return HttpResponseRedirect(request.META['HTTP_REFERER'])
else:
form = DocumentDownloadForm(document_versions=document_versions)
context = {
'form': form,
'subtemplates_list': subtemplates_list,
'title': _(u'Download documents'),
'submit_label': _(u'Download'),
'previous': previous,
'cancel_label': _(u'Return'),
'disable_auto_focus': True,
}
if len(document_versions) == 1:
context['object'] = document_versions[0].document
return render_to_response(
'main/generic_form.html',
context,
context_instance=RequestContext(request)
)
def document_multiple_download(request):
return document_download(
request, document_id_list=request.GET.get('id_list', [])
)
def document_update_page_count(request, document_id=None, document_id_list=None):
if document_id:
documents = [get_object_or_404(Document.objects, pk=document_id)]
post_redirect = reverse('documents:document_view_simple', args=[documents[0].pk])
elif document_id_list:
documents = [get_object_or_404(Document, pk=document_id) for document_id in document_id_list.split(',')]
else:
messages.error(request, _(u'Must provide at least one document.'))
return HttpResponseRedirect(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TOOLS])
except PermissionDenied:
documents = AccessEntry.objects.filter_objects_by_access(PERMISSION_DOCUMENT_TOOLS, request.user, documents, exception_on_empty=True)
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
if request.method == 'POST':
for document in documents:
task_update_page_count.apply_async(kwargs={'version_id': document.latest_version.pk}, queue='tools')
messages.success(
request,
ungettext(
_(u'Document queued for page count reset.'),
_(u'Documents queued for page count reset.'),
len(documents)
)
)
return HttpResponseRedirect(previous)
title = ungettext(
_(u'Are you sure you wish to reset the page count of this document?'),
_(u'Are you sure you wish to reset the page count of these documents?'),
len(documents)
)
context = {
'previous': previous,
'title': title,
}
if len(documents) == 1:
context['object'] = documents[0]
return render_to_response('main/generic_confirm.html', context,
context_instance=RequestContext(request))
def document_multiple_update_page_count(request):
return document_update_page_count(request, document_id_list=request.GET.get('id_list', []))
def document_clear_transformations(request, document_id=None, document_id_list=None):
if document_id:
documents = [get_object_or_404(Document.objects, pk=document_id)]
post_redirect = reverse('documents:document_view_simple', args=[documents[0].pk])
elif document_id_list:
documents = [get_object_or_404(Document, pk=document_id) for document_id in document_id_list.split(',')]
post_redirect = None
else:
messages.error(request, _(u'Must provide at least one document.'))
return HttpResponseRedirect(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TRANSFORM])
except PermissionDenied:
documents = AccessEntry.objects.filter_objects_by_access(PERMISSION_DOCUMENT_TRANSFORM, request.user, documents, exception_on_empty=True)
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', post_redirect or reverse('documents:document_list'))))
next = request.POST.get('next', request.GET.get('next', request.META.get('HTTP_REFERER', post_redirect or reverse('documents:document_list'))))
if request.method == 'POST':
for document in documents:
try:
for document_page in document.pages.all():
document_page.document.invalidate_cached_image(document_page.page_number)
for transformation in document_page.documentpagetransformation_set.all():
transformation.delete()
messages.success(request, _(u'All the page transformations for document: %s, have been deleted successfully.') % document)
except Exception as exception:
messages.error(request, _(u'Error deleting the page transformations for document: %(document)s; %(error)s.') % {
'document': document, 'error': exception})
return HttpResponseRedirect(next)
context = {
'delete_view': True,
'previous': previous,
'next': next,
}
if len(documents) == 1:
context['object'] = documents[0]
context['title'] = _(u'Are you sure you wish to clear all the page transformations for document: %s?') % ', '.join([unicode(d) for d in documents])
elif len(documents) > 1:
context['title'] = _(u'Are you sure you wish to clear all the page transformations for documents: %s?') % ', '.join([unicode(d) for d in documents])
return render_to_response('main/generic_confirm.html', context,
context_instance=RequestContext(request))
def document_multiple_clear_transformations(request):
return document_clear_transformations(request, document_id_list=request.GET.get('id_list', []))
def document_missing_list(request):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', None)))
if request.method != 'POST':
return render_to_response('main/generic_confirm.html', {
'previous': previous,
'message': _(u'On large databases this operation may take some time to execute.'),
}, context_instance=RequestContext(request))
else:
missing_id_list = []
for document in Document.objects.only('id',):
if not storage_backend.exists(document.file):
missing_id_list.append(document.pk)
return render_to_response('main/generic_list.html', {
'object_list': Document.objects.in_bulk(missing_id_list).values(),
'title': _(u'Missing documents'),
}, context_instance=RequestContext(request))
def document_page_view(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document_page.document)
zoom = int(request.GET.get('zoom', DEFAULT_ZOOM_LEVEL))
rotation = int(request.GET.get('rotation', DEFAULT_ROTATION))
document_page_form = DocumentPageForm(instance=document_page, zoom=zoom, rotation=rotation)
base_title = _(u'Details for: %s') % document_page
if zoom != DEFAULT_ZOOM_LEVEL:
zoom_text = u'(%d%%)' % zoom
else:
zoom_text = u''
if rotation != 0 and rotation != 360:
rotation_text = u'(%d&deg;)' % rotation
else:
rotation_text = u''
return render_to_response('main/generic_detail.html', {
'page': document_page,
'access_object': document_page.document,
'navigation_object_name': 'page',
'web_theme_hide_menus': True,
'form': document_page_form,
'title': u' '.join([base_title, zoom_text, rotation_text]),
'zoom': zoom,
'rotation': rotation,
}, context_instance=RequestContext(request))
def document_page_view_reset(request, document_page_id):
return HttpResponseRedirect(reverse('documents:document_page_view', args=[document_page_id]))
def document_page_text(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document_page.document)
document_page_form = DocumentPageForm_text(instance=document_page)
return render_to_response('main/generic_detail.html', {
'page': document_page,
'navigation_object_name': 'page',
'web_theme_hide_menus': True,
'form': document_page_form,
'title': _(u'Details for: %s') % document_page,
'access_object': document_page.document,
}, context_instance=RequestContext(request))
def document_page_edit(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_EDIT])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_EDIT, request.user, document_page.document)
if request.method == 'POST':
form = DocumentPageForm_edit(request.POST, instance=document_page)
if form.is_valid():
document_page.page_label = form.cleaned_data['page_label']
document_page.content = form.cleaned_data['content']
document_page.save()
messages.success(request, _(u'Document page edited successfully.'))
return HttpResponseRedirect(document_page.get_absolute_url())
else:
form = DocumentPageForm_edit(instance=document_page)
return render_to_response('main/generic_form.html', {
'form': form,
'page': document_page,
'navigation_object_name': 'page',
'title': _(u'Edit: %s') % document_page,
'web_theme_hide_menus': True,
'access_object': document_page.document,
}, context_instance=RequestContext(request))
def document_page_navigation_next(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document_page.document)
view = resolve_to_name(urlparse.urlparse(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))).path)
if document_page.page_number >= document_page.siblings.count():
messages.warning(request, _(u'There are no more pages in this document'))
return HttpResponseRedirect(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))
else:
document_page = get_object_or_404(document_page.siblings, page_number=document_page.page_number + 1)
return HttpResponseRedirect(reverse(view, args=[document_page.pk]))
def document_page_navigation_previous(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document_page.document)
view = resolve_to_name(urlparse.urlparse(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))).path)
if document_page.page_number <= 1:
messages.warning(request, _(u'You are already at the first page of this document'))
return HttpResponseRedirect(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))
else:
document_page = get_object_or_404(document_page.siblings, page_number=document_page.page_number - 1)
return HttpResponseRedirect(reverse(view, args=[document_page.pk]))
def document_page_navigation_first(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
document_page = get_object_or_404(document_page.siblings, page_number=1)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document_page.document)
view = resolve_to_name(urlparse.urlparse(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))).path)
return HttpResponseRedirect(reverse(view, args=[document_page.pk]))
def document_page_navigation_last(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
document_page = get_object_or_404(document_page.siblings, page_number=document_page.siblings.count())
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document_page.document)
view = resolve_to_name(urlparse.urlparse(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))).path)
return HttpResponseRedirect(reverse(view, args=[document_page.pk]))
def document_list_recent(request):
return document_list(
request,
object_list=RecentDocument.objects.get_for_user(request.user),
title=_(u'Recent documents'),
extra_context={
'recent_count': RECENT_COUNT
}
)
def transform_page(request, document_page_id, zoom_function=None, rotation_function=None):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document_page.document)
view = resolve_to_name(urlparse.urlparse(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))).path)
# Get the query string from the referer url
query = urlparse.urlparse(request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))).query
# Parse the query string and get the zoom value
# parse_qs return a dictionary whose values are lists
zoom = int(urlparse.parse_qs(query).get('zoom', ['100'])[0])
rotation = int(urlparse.parse_qs(query).get('rotation', ['0'])[0])
if zoom_function:
zoom = zoom_function(zoom)
if rotation_function:
rotation = rotation_function(rotation)
return HttpResponseRedirect(
u'?'.join([
reverse(view, args=[document_page.pk]),
urlencode({'zoom': zoom, 'rotation': rotation})
])
)
def document_page_zoom_in(request, document_page_id):
return transform_page(
request,
document_page_id,
zoom_function=lambda x: ZOOM_MAX_LEVEL if x + ZOOM_PERCENT_STEP > ZOOM_MAX_LEVEL else x + ZOOM_PERCENT_STEP
)
def document_page_zoom_out(request, document_page_id):
return transform_page(
request,
document_page_id,
zoom_function=lambda x: ZOOM_MIN_LEVEL if x - ZOOM_PERCENT_STEP < ZOOM_MIN_LEVEL else x - ZOOM_PERCENT_STEP
)
def document_page_rotate_right(request, document_page_id):
return transform_page(
request,
document_page_id,
rotation_function=lambda x: (x + ROTATION_STEP) % 360
)
def document_page_rotate_left(request, document_page_id):
return transform_page(
request,
document_page_id,
rotation_function=lambda x: (x - ROTATION_STEP) % 360
)
def document_print(request, document_id):
document = get_object_or_404(Document, pk=document_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document)
document.add_as_recent_document_for_user(request.user)
post_redirect = None
next = request.POST.get('next', request.GET.get('next', request.META.get('HTTP_REFERER', post_redirect or document.get_absolute_url())))
new_window_url = None
html_redirect = None
if request.method == 'POST':
form = PrintForm(request.POST)
if form.is_valid():
hard_copy_arguments = {}
# Get page range
if form.cleaned_data['page_range']:
hard_copy_arguments['page_range'] = form.cleaned_data['page_range']
new_url = [reverse('documents:document_hard_copy', args=[document_id])]
if hard_copy_arguments:
new_url.append(urlquote(hard_copy_arguments))
new_window_url = u'?'.join(new_url)
else:
form = PrintForm()
return render_to_response('main/generic_form.html', {
'form': form,
'object': document,
'title': _(u'Print: %s') % document,
'next': next,
'html_redirect': html_redirect if html_redirect else html_redirect,
'new_window_url': new_window_url if new_window_url else new_window_url
}, context_instance=RequestContext(request))
def document_hard_copy(request, document_id):
# TODO: FIXME
document = get_object_or_404(Document, pk=document_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document)
document.add_as_recent_document_for_user(request.user)
page_range = request.GET.get('page_range', u'')
if page_range:
page_range = parse_range(page_range)
pages = document.pages.filter(page_number__in=page_range)
else:
pages = document.pages.all()
return render_to_response('document_print.html', {
'object': document,
'page_range': page_range,
'pages': pages,
}, context_instance=RequestContext(request))
def document_type_list(request):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TYPE_VIEW])
context = {
'object_list': DocumentType.objects.all(),
'title': _(u'Document types'),
'hide_link': True,
'list_object_variable_name': 'document_type',
'extra_columns': [
{'name': _('OCR'), 'attribute': 'ocr'},
{'name': _('Documents'), 'attribute': encapsulate(lambda x: x.documents.count())}
]
}
return render_to_response('main/generic_list.html', context,
context_instance=RequestContext(request))
def document_type_edit(request, document_type_id):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TYPE_EDIT])
document_type = get_object_or_404(DocumentType, pk=document_type_id)
next = request.POST.get('next', request.GET.get('next', request.META.get('HTTP_REFERER', reverse('documents:document_type_list'))))
if request.method == 'POST':
form = DocumentTypeForm(instance=document_type, data=request.POST)
if form.is_valid():
try:
form.save()
messages.success(request, _(u'Document type edited successfully'))
return HttpResponseRedirect(next)
except Exception as exception:
messages.error(request, _(u'Error editing document type; %s') % exception)
else:
form = DocumentTypeForm(instance=document_type)
return render_to_response('main/generic_form.html', {
'title': _(u'Edit document type: %s') % document_type,
'form': form,
'navigation_object_name': 'document_type',
'document_type': document_type,
'next': next
}, context_instance=RequestContext(request))
def document_type_delete(request, document_type_id):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TYPE_DELETE])
document_type = get_object_or_404(DocumentType, pk=document_type_id)
post_action_redirect = reverse('documents:document_type_list')
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
next = request.POST.get('next', request.GET.get('next', post_action_redirect if post_action_redirect else request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
if request.method == 'POST':
try:
document_type.delete()
messages.success(request, _(u'Document type: %s deleted successfully.') % document_type)
except Exception as exception:
messages.error(request, _(u'Document type: %(document_type)s delete error: %(error)s') % {
'document_type': document_type, 'error': exception})
return HttpResponseRedirect(next)
context = {
'document_type': document_type,
'delete_view': True,
'navigation_object_name': 'document_type',
'next': next,
'previous': previous,
'title': _(u'Are you sure you wish to delete the document type: %s?') % document_type,
'message': _(u'All documents of this type will be deleted too.'),
}
return render_to_response('main/generic_confirm.html', context,
context_instance=RequestContext(request))
def document_type_create(request):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TYPE_CREATE])
if request.method == 'POST':
form = DocumentTypeForm(request.POST)
if form.is_valid():
try:
form.save()
messages.success(request, _(u'Document type created successfully'))
return HttpResponseRedirect(reverse('documents:document_type_list'))
except Exception as exception:
messages.error(request, _(u'Error creating document type; %(error)s') % {
'error': exception})
else:
form = DocumentTypeForm()
return render_to_response('main/generic_form.html', {
'title': _(u'Create document type'),
'form': form,
}, context_instance=RequestContext(request))
def document_type_filename_list(request, document_type_id):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TYPE_VIEW])
document_type = get_object_or_404(DocumentType, pk=document_type_id)
context = {
'object_list': document_type.filenames.all(),
'title': _(u'filenames for document type: %s') % document_type,
'navigation_object_name': 'document_type',
'document_type': document_type,
'list_object_variable_name': 'filename',
'hide_link': True,
'extra_columns': [
{
'name': _(u'Enabled'),
'attribute': encapsulate(lambda x: two_state_template(x.enabled)),
}
]
}
return render_to_response('main/generic_list.html', context,
context_instance=RequestContext(request))
def document_type_filename_edit(request, document_type_filename_id):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TYPE_EDIT])
document_type_filename = get_object_or_404(DocumentTypeFilename, pk=document_type_filename_id)
next = request.POST.get('next', request.GET.get('next', request.META.get('HTTP_REFERER', reverse('documents:document_type_filename_list', args=[document_type_filename.document_type_id]))))
if request.method == 'POST':
form = DocumentTypeFilenameForm(instance=document_type_filename, data=request.POST)
if form.is_valid():
try:
document_type_filename.filename = form.cleaned_data['filename']
document_type_filename.enabled = form.cleaned_data['enabled']
document_type_filename.save()
messages.success(request, _(u'Document type filename edited successfully'))
return HttpResponseRedirect(next)
except Exception as exception:
messages.error(request, _(u'Error editing document type filename; %s') % exception)
else:
form = DocumentTypeFilenameForm(instance=document_type_filename)
return render_to_response('main/generic_form.html', {
'title': _(u'Edit filename "%(filename)s" from document type "%(document_type)s"') % {
'document_type': document_type_filename.document_type, 'filename': document_type_filename
},
'form': form,
'next': next,
'filename': document_type_filename,
'document_type': document_type_filename.document_type,
'navigation_object_list': [
{'object': 'document_type', 'name': _(u'Document type')},
{'object': 'filename', 'name': _(u'Document type filename')}
],
}, context_instance=RequestContext(request))
def document_type_filename_delete(request, document_type_filename_id):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TYPE_EDIT])
document_type_filename = get_object_or_404(DocumentTypeFilename, pk=document_type_filename_id)
post_action_redirect = reverse('documents:document_type_filename_list', args=[document_type_filename.document_type_id])
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
next = request.POST.get('next', request.GET.get('next', post_action_redirect if post_action_redirect else request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
if request.method == 'POST':
try:
document_type_filename.delete()
messages.success(request, _(u'Document type filename: %s deleted successfully.') % document_type_filename)
except Exception as exception:
messages.error(request, _(u'Document type filename: %(document_type_filename)s delete error: %(error)s') % {
'document_type_filename': document_type_filename, 'error': exception})
return HttpResponseRedirect(next)
context = {
'delete_view': True,
'previous': previous,
'next': next,
'filename': document_type_filename,
'document_type': document_type_filename.document_type,
'navigation_object_list': [
{'object': 'document_type', 'name': _(u'Document type')},
{'object': 'filename', 'name': _(u'Document type filename')}
],
'title': _(u'Are you sure you wish to delete the filename: %(filename)s, from document type "%(document_type)s"?') % {
'document_type': document_type_filename.document_type, 'filename': document_type_filename
},
}
return render_to_response('main/generic_confirm.html', context,
context_instance=RequestContext(request))
def document_type_filename_create(request, document_type_id):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TYPE_EDIT])
document_type = get_object_or_404(DocumentType, pk=document_type_id)
if request.method == 'POST':
form = DocumentTypeFilenameForm_create(request.POST)
if form.is_valid():
try:
document_type_filename = DocumentTypeFilename(
document_type=document_type,
filename=form.cleaned_data['filename'],
enabled=True
)
document_type_filename.save()
messages.success(request, _(u'Document type filename created successfully'))
return HttpResponseRedirect(reverse('documents:document_type_filename_list', args=[document_type_id]))
except Exception as exception:
messages.error(request, _(u'Error creating document type filename; %(error)s') % {
'error': exception})
else:
form = DocumentTypeFilenameForm_create()
return render_to_response('main/generic_form.html', {
'title': _(u'Create filename for document type: %s') % document_type,
'form': form,
'document_type': document_type,
'navigation_object_list': [
{'object': 'document_type', 'name': _(u'Document type')},
],
}, context_instance=RequestContext(request))
def document_clear_image_cache(request):
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TOOLS])
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
if request.method == 'POST':
task_clear_image_cache.apply_async(queue='tools')
messages.success(request, _(u'Document image cache clearing queued successfully.'))
return HttpResponseRedirect(previous)
return render_to_response('main/generic_confirm.html', {
'previous': previous,
'title': _(u'Are you sure you wish to clear the document image cache?'),
}, context_instance=RequestContext(request))
def document_version_list(request, document_pk):
document = get_object_or_404(Document, pk=document_pk)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VIEW, request.user, document)
document.add_as_recent_document_for_user(request.user)
context = {
'object_list': document.versions.order_by('-timestamp'),
'title': _(u'Versions for document: %s') % document,
'hide_object': True,
'object': document,
'access_object': document,
'extra_columns': [
{
'name': _(u'Version'),
'attribute': 'get_formated_version',
},
{
'name': _(u'Time and date'),
'attribute': 'timestamp',
},
{
'name': _(u'Mimetype'),
'attribute': 'mimetype',
},
{
'name': _(u'Encoding'),
'attribute': 'encoding',
},
{
'name': _(u'Comment'),
'attribute': 'comment',
},
]
}
return render_to_response('main/generic_list.html', context,
context_instance=RequestContext(request))
def document_version_revert(request, document_version_pk):
document_version = get_object_or_404(DocumentVersion, pk=document_version_pk)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VERSION_REVERT])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_VERSION_REVERT, request.user, document_version.document)
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL))))
if request.method == 'POST':
try:
document_version.revert()
messages.success(request, _(u'Document version reverted successfully'))
except Exception as exception:
messages.error(request, _(u'Error reverting document version; %s') % exception)
return HttpResponseRedirect(previous)
return render_to_response('main/generic_confirm.html', {
'previous': previous,
'object': document_version.document,
'title': _(u'Are you sure you wish to revert to this version?'),
'message': _(u'All later version after this one will be deleted too.'),
}, context_instance=RequestContext(request))
# DEPRECATION: These document page transformation views are schedules to be deleted once the transformations app is merged
def document_page_transformation_list(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TRANSFORM])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_TRANSFORM, request.user, document_page.document)
context = {
'object_list': document_page.documentpagetransformation_set.all(),
'page': document_page,
'navigation_object_name': 'page',
'title': _(u'Transformations for: %s') % document_page,
'web_theme_hide_menus': True,
'list_object_variable_name': 'transformation',
'extra_columns': [
{'name': _(u'Order'), 'attribute': 'order'},
{'name': _(u'Transformation'), 'attribute': encapsulate(lambda x: x.get_transformation_display())},
{'name': _(u'Arguments'), 'attribute': 'arguments'}
],
'hide_link': True,
'hide_object': True,
}
return render_to_response(
'main/generic_list.html', context, context_instance=RequestContext(request)
)
def document_page_transformation_create(request, document_page_id):
document_page = get_object_or_404(DocumentPage, pk=document_page_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TRANSFORM])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_TRANSFORM, request.user, document_page.document)
if request.method == 'POST':
form = DocumentPageTransformationForm(request.POST, initial={'document_page': document_page})
if form.is_valid():
document_page.document.invalidate_cached_image(document_page.page_number)
form.save()
messages.success(request, _(u'Document page transformation created successfully.'))
return HttpResponseRedirect(reverse('documents:document_page_transformation_list', args=[document_page_id]))
else:
form = DocumentPageTransformationForm(initial={'document_page': document_page})
return render_to_response('main/generic_form.html', {
'form': form,
'page': document_page,
'navigation_object_name': 'page',
'title': _(u'Create new transformation for page: %(page)s of document: %(document)s') % {
'page': document_page.page_number, 'document': document_page.document},
'web_theme_hide_menus': True,
}, context_instance=RequestContext(request))
def document_page_transformation_edit(request, document_page_transformation_id):
document_page_transformation = get_object_or_404(DocumentPageTransformation, pk=document_page_transformation_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TRANSFORM])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_TRANSFORM, request.user, document_page_transformation.document_page.document)
if request.method == 'POST':
form = DocumentPageTransformationForm(request.POST, instance=document_page_transformation)
if form.is_valid():
document_page_transformation.document_page.document.invalidate_cached_image(document_page_transformation.document_page.page_number)
form.save()
messages.success(request, _(u'Document page transformation edited successfully.'))
return HttpResponseRedirect(reverse('documents:document_page_transformation_list', args=[document_page_transformation.document_page_id]))
else:
form = DocumentPageTransformationForm(instance=document_page_transformation)
return render_to_response('main/generic_form.html', {
'form': form,
'transformation': document_page_transformation,
'page': document_page_transformation.document_page,
'navigation_object_list': [
{'object': 'page'},
{'object': 'transformation', 'name': _(u'Transformation')}
],
'title': _(u'Edit transformation "%(transformation)s" for: %(document_page)s') % {
'transformation': document_page_transformation.get_transformation_display(),
'document_page': document_page_transformation.document_page},
'web_theme_hide_menus': True,
}, context_instance=RequestContext(request))
def document_page_transformation_delete(request, document_page_transformation_id):
document_page_transformation = get_object_or_404(DocumentPageTransformation, pk=document_page_transformation_id)
try:
Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_TRANSFORM])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_TRANSFORM, request.user, document_page_transformation.document_page.document)
redirect_view = reverse('documents:document_page_transformation_list', args=[document_page_transformation.document_page_id])
previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', redirect_view)))
if request.method == 'POST':
document_page_transformation.document_page.document.invalidate_cached_image(document_page_transformation.document_page.page_number)
document_page_transformation.delete()
messages.success(request, _(u'Document page transformation deleted successfully.'))
return HttpResponseRedirect(redirect_view)
return render_to_response('main/generic_confirm.html', {
'delete_view': True,
'page': document_page_transformation.document_page,
'transformation': document_page_transformation,
'navigation_object_list': [
{'object': 'page'},
{'object': 'transformation', 'name': _(u'Transformation')}
],
'title': _(u'Are you sure you wish to delete transformation "%(transformation)s" for: %(document_page)s') % {
'transformation': document_page_transformation.get_transformation_display(),
'document_page': document_page_transformation.document_page},
'web_theme_hide_menus': True,
'previous': previous,
}, context_instance=RequestContext(request))