Change document indexing to be signal based and decoupled from metadata and documents apps

This commit is contained in:
Roberto Rosario
2012-03-14 12:45:03 -04:00
parent 0ff1843545
commit 503c7c7594
3 changed files with 41 additions and 49 deletions

View File

@@ -1,13 +1,18 @@
from __future__ import absolute_import from __future__ import absolute_import
import logging
from django.utils.translation import ugettext_lazy as _ from django.utils.translation import ugettext_lazy as _
from django.db.models.signals import pre_save, post_save
from django.dispatch import receiver
from navigation.api import (register_top_menu, register_sidebar_template, from navigation.api import (register_top_menu, register_sidebar_template,
register_links) register_links)
from main.api import register_maintenance_links from main.api import register_maintenance_links
from documents.permissions import PERMISSION_DOCUMENT_VIEW from documents.permissions import PERMISSION_DOCUMENT_VIEW
from documents.models import Document from documents.models import Document, DocumentVersion
from metadata.models import DocumentMetadata
from project_setup.api import register_setup from project_setup.api import register_setup
from .models import (Index, IndexTemplateNode, IndexInstanceNode) from .models import (Index, IndexTemplateNode, IndexInstanceNode)
@@ -18,7 +23,7 @@ from .permissions import (PERMISSION_DOCUMENT_INDEXING_VIEW,
PERMISSION_DOCUMENT_INDEXING_EDIT, PERMISSION_DOCUMENT_INDEXING_EDIT,
PERMISSION_DOCUMENT_INDEXING_DELETE PERMISSION_DOCUMENT_INDEXING_DELETE
) )
from .api import update_indexes, delete_indexes
def is_root_node(context): def is_root_node(context):
return context['node'].parent is None return context['node'].parent is None
@@ -27,6 +32,7 @@ def is_root_node(context):
def is_not_instance_root_node(context): def is_not_instance_root_node(context):
return context['object'].parent is not None return context['object'].parent is not None
logger = logging.getLogger(__name__)
index_setup = {'text': _(u'indexes'), 'view': 'index_setup_list', 'icon': 'tab.png', 'permissions': [PERMISSION_DOCUMENT_INDEXING_SETUP], 'children_view_regex': [r'^index_setup', r'^template_node']} index_setup = {'text': _(u'indexes'), 'view': 'index_setup_list', 'icon': 'tab.png', 'permissions': [PERMISSION_DOCUMENT_INDEXING_SETUP], 'children_view_regex': [r'^index_setup', r'^template_node']}
index_setup_list = {'text': _(u'index list'), 'view': 'index_setup_list', 'famfam': 'tab', 'permissions': [PERMISSION_DOCUMENT_INDEXING_SETUP]} index_setup_list = {'text': _(u'index list'), 'view': 'index_setup_list', 'famfam': 'tab', 'permissions': [PERMISSION_DOCUMENT_INDEXING_SETUP]}
@@ -63,3 +69,26 @@ register_links([Index, 'index_setup_list', 'index_setup_create', 'template_node_
register_links(Index, [index_setup_edit, index_setup_delete, index_setup_view]) register_links(Index, [index_setup_edit, index_setup_delete, index_setup_view])
register_links(IndexTemplateNode, [template_node_create, template_node_edit, template_node_delete]) register_links(IndexTemplateNode, [template_node_create, template_node_edit, template_node_delete])
@receiver(pre_save, dispatch_uid='delete_indexes_handler')
def delete_indexes_handler(sender, instance, **kwargs):
if isinstance(instance, DocumentVersion):
logger.debug('received pre save signal - document version')
logger.debug('instance: %s' % instance)
delete_indexes(instance.document)
elif isinstance(instance, DocumentMetadata):
logger.debug('received pre save signal - document metadata')
logger.debug('instance: %s' % instance)
delete_indexes(instance.document)
@receiver(post_save, dispatch_uid='update_indexes_handler')
def update_indexes_handler(sender, instance, **kwargs):
if isinstance(instance, DocumentVersion):
logger.debug('received post save signal - document version')
logger.debug('instance: %s' % instance)
update_indexes(instance.document)
elif isinstance(instance, DocumentMetadata):
logger.debug('received post save signal - document metadata')
logger.debug('instance: %s' % instance)
update_indexes(instance.document)

View File

@@ -29,7 +29,6 @@ from filetransfers.api import serve_file
from metadata.forms import MetadataFormSet, MetadataSelectionForm from metadata.forms import MetadataFormSet, MetadataSelectionForm
from navigation.utils import resolve_to_name from navigation.utils import resolve_to_name
from permissions.models import Permission from permissions.models import Permission
from document_indexing.api import update_indexes, delete_indexes
from history.api import create_history from history.api import create_history
from acls.models import AccessEntry from acls.models import AccessEntry
from common.compressed_files import CompressedFile from common.compressed_files import CompressedFile
@@ -208,11 +207,6 @@ def document_delete(request, document_id=None, document_id_list=None):
if request.method == 'POST': if request.method == 'POST':
for document in documents: for document in documents:
try: try:
warnings = delete_indexes(document)
if request.user.is_staff or request.user.is_superuser:
for warning in warnings:
messages.warning(request, warning)
document.delete() document.delete()
#create_history(HISTORY_DOCUMENT_DELETED, data={'user': request.user, 'document': document}) #create_history(HISTORY_DOCUMENT_DELETED, data={'user': request.user, 'document': document})
messages.success(request, _(u'Document deleted successfully.')) messages.success(request, _(u'Document deleted successfully.'))
@@ -257,29 +251,25 @@ def document_edit(request, document_id):
old_document = copy.copy(document) old_document = copy.copy(document)
form = DocumentForm_edit(request.POST, instance=document) form = DocumentForm_edit(request.POST, instance=document)
if form.is_valid(): if form.is_valid():
warnings = delete_indexes(document)
if request.user.is_staff or request.user.is_superuser:
for warning in warnings:
messages.warning(request, warning)
document.filename = form.cleaned_data['new_filename']
document.description = form.cleaned_data['description']
if 'document_type_available_filenames' in form.cleaned_data: if 'document_type_available_filenames' in form.cleaned_data:
if form.cleaned_data['document_type_available_filenames']: if form.cleaned_data['document_type_available_filenames']:
document.filename = form.cleaned_data['document_type_available_filenames'].filename new_filename = form.cleaned_data['document_type_available_filenames'].filename
else:
new_filename = form.cleaned_data['new_filename']
else:
new_filename = form.cleaned_data['new_filename']
print 'new_filename', new_filename
document.filename = new_filename
document.description = form.cleaned_data['description']
document.save() document.save()
create_history(HISTORY_DOCUMENT_EDITED, document, {'user': request.user, 'diff': return_diff(old_document, document, ['filename', 'description'])}) create_history(HISTORY_DOCUMENT_EDITED, document, {'user': request.user, 'diff': return_diff(old_document, document, ['filename', 'description'])})
RecentDocument.objects.add_document_for_user(request.user, document) RecentDocument.objects.add_document_for_user(request.user, document)
messages.success(request, _(u'Document "%s" edited successfully.') % document) messages.success(request, _(u'Document "%s" edited successfully.') % document)
warnings = update_indexes(document)
if request.user.is_staff or request.user.is_superuser:
for warning in warnings:
messages.warning(request, warning)
return HttpResponseRedirect(document.get_absolute_url()) return HttpResponseRedirect(document.get_absolute_url())
else: else:
form = DocumentForm_edit(instance=document, initial={ form = DocumentForm_edit(instance=document, initial={

View File

@@ -13,7 +13,6 @@ from django.core.exceptions import PermissionDenied
from documents.permissions import PERMISSION_DOCUMENT_TYPE_EDIT from documents.permissions import PERMISSION_DOCUMENT_TYPE_EDIT
from documents.models import Document, RecentDocument, DocumentType from documents.models import Document, RecentDocument, DocumentType
from permissions.models import Permission from permissions.models import Permission
from document_indexing.api import update_indexes, delete_indexes
from acls.models import AccessEntry from acls.models import AccessEntry
from common.utils import generate_choices_w_labels, encapsulate, get_object_name from common.utils import generate_choices_w_labels, encapsulate, get_object_name
@@ -80,12 +79,6 @@ def metadata_edit(request, document_id=None, document_id_list=None):
formset = MetadataFormSet(request.POST) formset = MetadataFormSet(request.POST)
if formset.is_valid(): if formset.is_valid():
for document in documents: for document in documents:
warnings = delete_indexes(document)
if request.user.is_staff or request.user.is_superuser:
for warning in warnings:
messages.warning(request, _(u'Error deleting document indexes; %s') % warning)
errors = [] errors = []
for form in formset.forms: for form in formset.forms:
if form.cleaned_data['update']: if form.cleaned_data['update']:
@@ -101,13 +94,6 @@ def metadata_edit(request, document_id=None, document_id_list=None):
else: else:
messages.success(request, _(u'Metadata for document %s edited successfully.') % document) messages.success(request, _(u'Metadata for document %s edited successfully.') % document)
warnings = update_indexes(document)
if warnings and (request.user.is_staff or request.user.is_superuser):
for warning in warnings:
messages.warning(request, _(u'Error updating document indexes; %s') % warning)
else:
messages.success(request, _(u'Document indexes updated successfully.'))
return HttpResponseRedirect(next) return HttpResponseRedirect(next)
context = { context = {
@@ -244,12 +230,6 @@ def metadata_remove(request, document_id=None, document_id_list=None):
formset = MetadataRemoveFormSet(request.POST) formset = MetadataRemoveFormSet(request.POST)
if formset.is_valid(): if formset.is_valid():
for document in documents: for document in documents:
warnings = delete_indexes(document)
if request.user.is_staff or request.user.is_superuser:
for warning in warnings:
messages.warning(request, _(u'Error deleting document indexes; %s') % warning)
for form in formset.forms: for form in formset.forms:
if form.cleaned_data['update']: if form.cleaned_data['update']:
metadata_type = get_object_or_404(MetadataType, pk=form.cleaned_data['id']) metadata_type = get_object_or_404(MetadataType, pk=form.cleaned_data['id'])
@@ -262,13 +242,6 @@ def metadata_remove(request, document_id=None, document_id_list=None):
messages.error(request, _(u'Error removing metadata type: %(metadata_type)s from document: %(document)s.') % { messages.error(request, _(u'Error removing metadata type: %(metadata_type)s from document: %(document)s.') % {
'metadata_type': metadata_type, 'document': document}) 'metadata_type': metadata_type, 'document': document})
warnings = update_indexes(document)
if warnings and (request.user.is_staff or request.user.is_superuser):
for warning in warnings:
messages.warning(request, _(u'Error updating document indexes; %s') % warning)
else:
messages.success(request, _(u'Document indexes updated successfully.'))
return HttpResponseRedirect(next) return HttpResponseRedirect(next)
context = { context = {