from __future__ import absolute_import import tempfile 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.safestring import mark_safe from django.utils.translation import ugettext from django.utils.translation import ugettext_lazy as _ from acls.models import AccessEntry from common.utils import encapsulate from documents.exceptions import NewDocumentVersionNotAllowed from documents.models import DocumentType, Document from documents.permissions import (PERMISSION_DOCUMENT_CREATE, PERMISSION_DOCUMENT_NEW_VERSION) from metadata.api import decode_metadata_from_url, metadata_repr_as_list from permissions.models import Permission from .forms import (POP3EmailSetupForm, IMAPEmailSetupForm, StagingDocumentForm, StagingFolderSetupForm, SourceTransformationForm, SourceTransformationForm_create, WatchFolderSetupForm, WebFormForm, WebFormSetupForm) from .literals import (SOURCE_CHOICE_EMAIL_IMAP, SOURCE_CHOICE_EMAIL_POP3, SOURCE_CHOICE_STAGING, SOURCE_CHOICE_WATCH, SOURCE_CHOICE_WEB_FORM, SOURCE_UNCOMPRESS_CHOICE_ASK, SOURCE_UNCOMPRESS_CHOICE_Y) from .models import (IMAPEmail, POP3Email, Source, StagingFolderSource, SourceTransformation, WatchFolderSource, WebFormSource) from .permissions import (PERMISSION_SOURCES_SETUP_CREATE, PERMISSION_SOURCES_SETUP_DELETE, PERMISSION_SOURCES_SETUP_EDIT, PERMISSION_SOURCES_SETUP_VIEW) from .tasks import task_upload_document def get_class(source_type): if source_type == SOURCE_CHOICE_WEB_FORM: return WebFormSource elif source_type == SOURCE_CHOICE_STAGING: return StagingFolderSource elif source_type == SOURCE_CHOICE_WATCH: return WatchFolderSource elif source_type == SOURCE_CHOICE_EMAIL_POP3: return POP3Email elif source_type == SOURCE_CHOICE_EMAIL_IMAP: return IMAPEmail def get_form_class(source_type): if source_type == SOURCE_CHOICE_WEB_FORM: return WebFormSetupForm elif source_type == SOURCE_CHOICE_STAGING: return StagingFolderSetupForm elif source_type == SOURCE_CHOICE_WATCH: return WatchFolderSetupForm elif source_type == SOURCE_CHOICE_EMAIL_POP3: return POP3EmailSetupForm elif source_type == SOURCE_CHOICE_EMAIL_IMAP: return IMAPEmailSetupForm def document_create_siblings(request, document_id): Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_CREATE]) document = get_object_or_404(Document, pk=document_id) query_dict = {} for pk, metadata in enumerate(document.metadata.all()): query_dict['metadata%s_id' % pk] = metadata.metadata_type_id query_dict['metadata%s_value' % pk] = metadata.value if document.document_type_id: query_dict['document_type_id'] = document.document_type_id url = reverse('sources:upload_interactive') return HttpResponseRedirect('%s?%s' % (url, urlencode(query_dict))) def return_function(obj): return lambda context: context['source'].source_type == obj.source_type and context['source'].pk == obj.pk def get_tab_link_for_source(source, document=None): if document: view = u'sources:upload_version' args = [document.pk, source.pk] else: view = u'sources:upload_interactive' args = [source.pk] return { 'text': source.title, 'view': view, 'args': args, 'keep_query': True, 'conditional_highlight': return_function(source), } def get_active_tab_links(document=None): tab_links = [] web_forms = WebFormSource.objects.filter(enabled=True) for web_form in web_forms: tab_links.append(get_tab_link_for_source(web_form, document)) staging_folders = StagingFolderSource.objects.filter(enabled=True) for staging_folder in staging_folders: tab_links.append(get_tab_link_for_source(staging_folder, document)) pop3_emails = POP3Email.objects.filter(enabled=True) for source_instance in pop3_emails: tab_links.append(get_tab_link_for_source(source_instance, document)) imap_emails = IMAPEmail.objects.filter(enabled=True) for source_instance in imap_emails: tab_links.append(get_tab_link_for_source(source_instance, document)) return { 'tab_links': tab_links, SOURCE_CHOICE_WEB_FORM: web_forms, SOURCE_CHOICE_STAGING: staging_folders, SOURCE_CHOICE_EMAIL_POP3: pop3_emails, SOURCE_CHOICE_EMAIL_IMAP: imap_emails } def upload_interactive(request, source_id=None, document_pk=None): subtemplates_list = [] if document_pk: document = get_object_or_404(Document, pk=document_pk) try: Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_NEW_VERSION]) except PermissionDenied: AccessEntry.objects.check_access(PERMISSION_DOCUMENT_NEW_VERSION, request.user, document) results = get_active_tab_links(document) else: Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_CREATE]) document = None results = get_active_tab_links() context = {} # TODO: use InteractiveSource.objects.count() instead if results[SOURCE_CHOICE_WEB_FORM].count() == 0 and results[SOURCE_CHOICE_STAGING].count() == 0: source_setup_link = mark_safe('%s' % (reverse('sources:setup_web_form_list'), ugettext(u'Here'))) subtemplates_list.append( { 'name': 'main/generic_subtemplate.html', 'context': { 'title': _(u'Upload sources'), 'paragraphs': [ _(u'No interactive document sources have been defined or none have been enabled.'), _(u'Click %(setup_link)s to add or enable some document sources.') % { 'setup_link': source_setup_link } ], } }) document_type_id = request.GET.get('document_type_id', None) if document_type_id: document_type = get_object_or_404(DocumentType, pk=document_type_id) else: document_type = None if source_id is None: if results[SOURCE_CHOICE_WEB_FORM].count(): source_id = results[SOURCE_CHOICE_WEB_FORM][0].pk elif results[SOURCE_CHOICE_STAGING].count(): source_id = results[SOURCE_CHOICE_STAGING][0].pk if source_id: source = get_object_or_404(Source.objects.select_subclasses(), pk=source_id) if isinstance(source, WebFormSource): form_class = WebFormForm else: form_class = StagingDocumentForm context['source'] = source if request.method == 'POST': form = form_class( request.POST, request.FILES, document_type=document_type, show_expand=(source.uncompress == SOURCE_UNCOMPRESS_CHOICE_ASK) and not document, source=source, instance=document ) if form.is_valid(): try: if document: expand = False else: if source.uncompress == SOURCE_UNCOMPRESS_CHOICE_ASK: expand = form.cleaned_data.get('expand') else: if source.uncompress == SOURCE_UNCOMPRESS_CHOICE_Y: expand = True else: expand = False new_filename = get_form_filename(form) if isinstance(source, WebFormSource): file_object = request.FILES['file'] staging_file = None else: staging_file = source.get_file(encoded_filename=form.cleaned_data['staging_file_id']) file_object = staging_file.as_file() if document_type: document_type_id = document_type.pk else: document_type_id = None if document: document_id = document.pk else: document_id = None temporary_file = tempfile.NamedTemporaryFile(delete=False) for chunk in file_object.chunks(): temporary_file.write(chunk) temporary_file.close() file_object.close() if isinstance(source, StagingFolderSource): if source.delete_after_upload: staging_file.delete() if not request.user.is_anonymous(): user_id = request.user.pk else: user_id = None task_upload_document.apply_async(kwargs=dict( source_id=source.pk, file_path=temporary_file.name, filename=new_filename or file_object.name, use_file_name=form.cleaned_data.get('use_file_name', False), document_type_id=document_type_id, expand=expand, metadata_dict_list=decode_metadata_from_url(request.GET), user_id=user_id, document_id=document_id, new_version_data=form.cleaned_data.get('new_version_data'), description=form.cleaned_data.get('description'), ), queue='uploads') # TODO: Notify user if document: messages.success(request, _(u'New document queued for uploaded and will be available shortly.')) return HttpResponseRedirect(reverse('documents:document_version_list', args=[document.pk])) else: messages.success(request, _(u'New document version queued for uploaded and will be available shortly.')) return HttpResponseRedirect(request.get_full_path()) except Exception as exception: if settings.DEBUG: raise messages.error(request, _(u'Unhandled exception: %s') % exception) else: form = form_class( show_expand=(source.uncompress == SOURCE_UNCOMPRESS_CHOICE_ASK) and not document, document_type=document_type, source=source, instance=document ) if document: title = _(u'Upload a new version from source: %s') % source.title else: title = _(u'Upload a local document from source: %s') % source.title subtemplates_list.append({ 'name': 'main/generic_form_subtemplate.html', 'context': { 'form': form, 'title': title, }, }) if isinstance(source, StagingFolderSource): try: staging_filelist = list(source.get_files()) except Exception as exception: messages.error(request, exception) staging_filelist = [] finally: subtemplates_list = [ { 'name': 'main/generic_form_subtemplate.html', 'context': { 'form': form, 'title': title, } }, { 'name': 'main/generic_list_subtemplate.html', 'context': { 'title': _(u'Files in staging path'), 'object_list': staging_filelist, 'hide_link': True, } }, ] if document: context['object'] = document context.update({ 'document_type_id': document_type_id, 'subtemplates_list': subtemplates_list, 'temporary_navigation_links': { 'form_header': { 'sources:upload_version': { 'links': results['tab_links'] }, 'sources:upload_interactive': { 'links': results['tab_links'] } } }, }) if not document: context.update( { 'sidebar_subtemplates_list': [ { 'name': 'main/generic_subtemplate.html', 'context': { 'title': _(u'Current document type'), 'paragraphs': [document_type if document_type else _(u'None')], 'side_bar': True, } }, { 'name': 'main/generic_subtemplate.html', 'context': { 'title': _(u'Current metadata'), 'paragraphs': metadata_repr_as_list(decode_metadata_from_url(request.GET)), 'side_bar': True, } } ], } ) return render_to_response('main/generic_form.html', context, context_instance=RequestContext(request)) def get_form_filename(form): filename = None if form: if form.cleaned_data['new_filename']: return form.cleaned_data['new_filename'] if form and 'document_type_available_filenames' in form.cleaned_data: if form.cleaned_data['document_type_available_filenames']: return form.cleaned_data['document_type_available_filenames'].filename return filename def staging_file_delete(request, staging_folder_pk, encoded_filename): Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_CREATE, PERMISSION_DOCUMENT_NEW_VERSION]) staging_folder = get_object_or_404(StagingFolderSource, pk=staging_folder_pk) staging_file = staging_folder.get_file(encoded_filename=encoded_filename) next = request.POST.get('next', request.GET.get('next', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))) previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))) if request.method == 'POST': try: staging_file.delete() messages.success(request, _(u'Staging file delete successfully.')) except Exception as exception: messages.error(request, _(u'Staging file delete error; %s.') % exception) return HttpResponseRedirect(next) results = get_active_tab_links() return render_to_response('main/generic_confirm.html', { 'source': staging_folder, 'delete_view': True, 'object': staging_file, 'next': next, 'previous': previous, 'form_icon': u'delete.png', 'temporary_navigation_links': {'form_header': {'staging_file_delete': {'links': results['tab_links']}}}, }, context_instance=RequestContext(request)) # Setup views def setup_source_list(request, source_type): Permission.objects.check_permissions(request.user, [PERMISSION_SOURCES_SETUP_VIEW]) cls = get_class(source_type) # TODO: remove plurals context = { 'object_list': cls.objects.all(), 'title': cls.class_fullname_plural(), 'hide_link': True, 'list_object_variable_name': 'source', 'source_type': source_type, } return render_to_response('main/generic_list.html', context, context_instance=RequestContext(request)) def setup_source_edit(request, source_id): Permission.objects.check_permissions(request.user, [PERMISSION_SOURCES_SETUP_EDIT]) source = get_object_or_404(Source.objects.select_subclasses(), pk=source_id) form_class = get_form_class(source.source_type) next = request.POST.get('next', request.GET.get('next', request.META.get('HTTP_REFERER', reverse(settings.LOGIN_REDIRECT_URL)))) if request.method == 'POST': form = form_class(instance=source, data=request.POST) if form.is_valid(): try: form.save() messages.success(request, _(u'Source edited successfully')) return HttpResponseRedirect(next) except Exception as exception: messages.error(request, _(u'Error editing source; %s') % exception) else: form = form_class(instance=source) return render_to_response('main/generic_form.html', { 'title': _(u'Edit source: %s') % source.fullname(), 'form': form, 'source': source, 'navigation_object_name': 'source', 'next': next, 'object_name': _(u'Source'), 'source_type': source.source_type, }, context_instance=RequestContext(request)) def setup_source_delete(request, source_id): Permission.objects.check_permissions(request.user, [PERMISSION_SOURCES_SETUP_DELETE]) source = get_object_or_404(Source.objects.select_subclasses(), pk=source_id) redirect_view = reverse('sources:setup_source_list', args=[source.source_type]) if isinstance(source, WebFormSource): form_icon = u'application_form_delete.png' redirect_view = 'sources:setup_web_form_list' elif isinstance(source, StagingFolderSource): form_icon = u'folder_delete.png' redirect_view = 'sources:setup_staging_folder_list' elif isinstance(source, WatchFolderSource): form_icon = u'folder_delete.png' redirect_view = 'sources:setup_watch_folder_list' elif isinstance(source, POP3Email): form_icon = u'folder_delete.png' redirect_view = 'sources:setup_pop3_email_list' elif isinstance(source, IMAPEmail): form_icon = u'folder_delete.png' redirect_view = 'sources:setup_imap_email_list' previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', redirect_view))) if request.method == 'POST': try: source.delete() messages.success(request, _(u'Source "%s" deleted successfully.') % source) except Exception as exception: messages.error(request, _(u'Error deleting source "%(source)s": %(error)s') % { 'source': source, 'error': exception }) return HttpResponseRedirect(reverse(redirect_view)) context = { 'title': _(u'Are you sure you wish to delete the source: %s?') % source.fullname(), 'source': source, 'object_name': _(u'Source'), 'navigation_object_name': 'source', 'delete_view': True, 'previous': previous, 'form_icon': form_icon, 'source_type': source.source_type, } return render_to_response('main/generic_confirm.html', context, context_instance=RequestContext(request)) def setup_source_create(request, source_type): Permission.objects.check_permissions(request.user, [PERMISSION_SOURCES_SETUP_CREATE]) cls = get_class(source_type) form_class = get_form_class(source_type) if request.method == 'POST': form = form_class(data=request.POST) if form.is_valid(): try: form.save() messages.success(request, _(u'Source created successfully')) return HttpResponseRedirect(reverse('sources:setup_web_form_list')) except Exception as exception: messages.error(request, _(u'Error creating source; %s') % exception) else: form = form_class() return render_to_response('main/generic_form.html', { 'title': _(u'Create new source of type: %s') % cls.class_fullname(), 'form': form, 'source_type': source_type, 'navigation_object_name': 'source', }, context_instance=RequestContext(request)) def setup_source_transformation_list(request, source_id): Permission.objects.check_permissions(request.user, [PERMISSION_SOURCES_SETUP_EDIT]) source = get_object_or_404(Source.objects.select_subclasses(), pk=source_id) context = { 'object_list': SourceTransformation.transformations.get_for_object(source), 'title': _(u'Transformations for: %s') % source.fullname(), 'source': source, 'object_name': _(u'Source'), 'navigation_object_name': 'source', '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 setup_source_transformation_edit(request, transformation_id): Permission.objects.check_permissions(request.user, [PERMISSION_SOURCES_SETUP_EDIT]) source_transformation = get_object_or_404(SourceTransformation, pk=transformation_id) redirect_view = reverse('sources:setup_source_transformation_list', args=[source_transformation.content_object.pk]) next = request.POST.get('next', request.GET.get('next', request.META.get('HTTP_REFERER', redirect_view))) if request.method == 'POST': form = SourceTransformationForm(instance=source_transformation, data=request.POST) if form.is_valid(): try: form.save() messages.success(request, _(u'Source transformation edited successfully')) return HttpResponseRedirect(next) except Exception as exception: messages.error(request, _(u'Error editing source transformation; %s') % exception) else: form = SourceTransformationForm(instance=source_transformation) return render_to_response('main/generic_form.html', { 'title': _(u'Edit transformation: %s') % source_transformation, 'form': form, 'source': source_transformation.content_object, 'transformation': source_transformation, 'navigation_object_list': [ {'object': 'source', 'name': _(u'Source')}, {'object': 'transformation', 'name': _(u'Transformation')} ], 'next': next, }, context_instance=RequestContext(request)) def setup_source_transformation_delete(request, transformation_id): Permission.objects.check_permissions(request.user, [PERMISSION_SOURCES_SETUP_EDIT]) source_transformation = get_object_or_404(SourceTransformation, pk=transformation_id) redirect_view = reverse('sources:setup_source_transformation_list', args=[source_transformation.content_object.pk]) previous = request.POST.get('previous', request.GET.get('previous', request.META.get('HTTP_REFERER', redirect_view))) if request.method == 'POST': try: source_transformation.delete() messages.success(request, _(u'Source transformation deleted successfully.')) except Exception as exception: messages.error(request, _(u'Error deleting source transformation; %(error)s') % { 'error': exception} ) return HttpResponseRedirect(redirect_view) return render_to_response('main/generic_confirm.html', { 'delete_view': True, 'transformation': source_transformation, 'source': source_transformation.content_object, 'navigation_object_list': [ {'object': 'source', 'name': _(u'Source')}, {'object': 'transformation', 'name': _(u'Transformation')} ], 'title': _(u'Are you sure you wish to delete source transformation "%(transformation)s"') % { 'transformation': source_transformation.get_transformation_display(), }, 'previous': previous, 'form_icon': u'shape_square_delete.png', }, context_instance=RequestContext(request)) def setup_source_transformation_create(request, source_id): Permission.objects.check_permissions(request.user, [PERMISSION_SOURCES_SETUP_EDIT]) source = get_object_or_404(Source.objects.select_subclasses(), pk=source_id) redirect_view = reverse('sources:setup_source_transformation_list', args=[source.pk]) if request.method == 'POST': form = SourceTransformationForm_create(request.POST) if form.is_valid(): try: source_tranformation = form.save(commit=False) source_tranformation.content_object = source source_tranformation.save() messages.success(request, _(u'Source transformation created successfully')) return HttpResponseRedirect(redirect_view) except Exception as exception: messages.error(request, _(u'Error creating source transformation; %s') % exception) else: form = SourceTransformationForm_create() return render_to_response('main/generic_form.html', { 'form': form, 'source': source, 'object_name': _(u'Source'), 'navigation_object_name': 'source', 'title': _(u'Create new transformation for source: %s') % source, }, context_instance=RequestContext(request))