def ready(self):
super(RedactionsApp, self).ready()
DocumentPage = apps.get_model(app_label='documents',
model_name='DocumentPage')
link_redaction_list = link_transformation_list.copy(
layer=layer_redactions)
link_redaction_list.text = _('Redactions')
menu_list_facet.bind_links(links=(link_redaction_list, ),
sources=(DocumentPage, ))
def ready(self):
super(DocumentsApp, self).ready()
DeletedDocument = self.get_model(model_name='DeletedDocument')
Document = self.get_model(model_name='Document')
DocumentPage = self.get_model(model_name='DocumentPage')
DocumentPageResult = self.get_model(model_name='DocumentPageResult')
DocumentType = self.get_model(model_name='DocumentType')
DocumentTypeFilename = self.get_model(
model_name='DocumentTypeFilename')
DocumentVersion = self.get_model(model_name='DocumentVersion')
DuplicatedDocument = self.get_model(model_name='DuplicatedDocument')
link_decorations_list = link_transformation_list.copy(
layer=layer_decorations)
link_decorations_list.text = _('Decorations')
DynamicSerializerField.add_serializer(
klass=Document,
serializer_class=
'mayan.apps.documents.serializers.DocumentSerializer')
EventModelRegistry.register(model=DeletedDocument)
EventModelRegistry.register(model=Document)
EventModelRegistry.register(model=DocumentType)
EventModelRegistry.register(model=DocumentVersion)
MissingItem(
label=_('Create a document type'),
description=_(
'Every uploaded document must be assigned a document type, '
'it is the basic way Mayan EDMS categorizes documents.'),
condition=lambda: not DocumentType.objects.exists(),
view='documents:document_type_list')
ModelCopy(model=DocumentTypeFilename).add_fields(
field_names=('document_type', 'filename', 'enabled'))
ModelCopy(model=DocumentType, bind_link=True,
register_permission=True).add_fields(
field_names=('label', 'trash_time_period',
'trash_time_unit', 'delete_time_period',
'delete_time_unit', 'filenames'))
ModelEventType.register(model=DocumentType,
event_types=(
event_document_create,
event_document_type_created,
event_document_type_edited,
))
ModelEventType.register(model=Document,
event_types=(event_document_download,
event_document_properties_edit,
event_document_type_changed,
event_document_version_new,
event_document_version_revert,
event_document_view))
ModelField(model=Document, name='description')
ModelField(model=Document, name='date_added')
ModelField(model=Document, name='deleted_date_time')
ModelField(model=Document, name='document_type')
ModelField(model=Document, name='in_trash')
ModelField(model=Document, name='is_stub')
ModelField(model=Document, name='label')
ModelField(model=Document, name='language')
ModelField(model=Document, name='uuid')
ModelFieldRelated(model=Document, name='document_type__label')
ModelFieldRelated(model=Document, name='versions__checksum')
ModelFieldRelated(model=Document,
label=_('Versions comment'),
name='versions__comment')
ModelFieldRelated(model=Document,
label=_('Versions encoding'),
name='versions__encoding')
ModelFieldRelated(model=Document,
label=_('Versions mime type'),
name='versions__mimetype')
ModelFieldRelated(model=Document,
label=_('Versions timestamp'),
name='versions__timestamp')
ModelField(model=DocumentPage,
label=_('Document version'),
name='document_version')
ModelField(model=DocumentPage,
label=_('Page number'),
name='page_number')
ModelProperty(
description=_('Return the lastest version of the document.'),
model=Document,
label=_('Latest version'),
name='latest_version')
ModelProperty(description=_('Return the document instance.'),
model=DocumentPage,
label=_('Document'),
name='document')
ModelPermission.register(model=Document,
permissions=(
permission_acl_edit,
permission_acl_view,
permission_document_delete,
permission_document_download,
permission_document_edit,
permission_document_new_version,
permission_document_print,
permission_document_properties_edit,
permission_document_restore,
permission_document_tools,
permission_document_trash,
permission_document_version_revert,
permission_document_version_view,
permission_document_view,
permission_events_view,
permission_transformation_create,
permission_transformation_delete,
permission_transformation_edit,
permission_transformation_view,
))
ModelPermission.register(model=DocumentType,
permissions=(
permission_document_create,
permission_document_type_delete,
permission_document_type_edit,
permission_document_type_view,
permission_acl_edit,
permission_acl_view,
permission_events_view,
))
ModelPermission.register_inheritance(
model=Document,
related='document_type',
)
ModelPermission.register_inheritance(
model=DocumentPage,
related='document_version__document',
)
ModelPermission.register_inheritance(
model=DocumentPageResult,
related='document_version__document',
)
ModelPermission.register_inheritance(
model=DocumentTypeFilename,
related='document_type',
)
ModelPermission.register_inheritance(
model=DocumentVersion,
related='document',
)
model_query_fields_document = ModelQueryFields(model=Document)
model_query_fields_document.add_prefetch_related_field(
field_name='versions')
model_query_fields_document.add_prefetch_related_field(
field_name='versions__version_pages')
model_query_fields_document.add_select_related_field(
field_name='document_type')
model_query_fields_document_version = ModelQueryFields(
model=DocumentVersion)
model_query_fields_document_version.add_prefetch_related_field(
field_name='version_pages')
model_query_fields_document_version.add_select_related_field(
field_name='document')
model_query_fields_document_page = ModelQueryFields(model=DocumentPage)
model_query_fields_document_page.add_select_related_field(
field_name='document_version')
# Document and document page thumbnail widget
document_page_thumbnail_widget = DocumentPageThumbnailWidget()
# Document
SourceColumn(attribute='label',
is_object_absolute_url=True,
is_identifier=True,
is_sortable=True,
source=Document)
SourceColumn(func=lambda context: document_page_thumbnail_widget.
render(instance=context['object']),
html_extra_classes='text-center document-thumbnail-list',
label=_('Thumbnail'),
source=Document)
SourceColumn(
attribute='document_type',
is_sortable=True,
source=Document,
)
SourceColumn(func=lambda context: widget_document_page_number(
document=context['object']),
label=_('Pages'),
source=Document)
SourceColumn(attribute='date_added',
include_label=True,
is_sortable=True,
source=Document,
views=('documents:document_list_recent_added', ))
SourceColumn(func=lambda context: DuplicatedDocument.objects.get(
document=context['object']).documents.count(),
include_label=True,
label=_('Duplicates'),
source=Document,
views=('documents:duplicated_document_list', ))
# DocumentPage
SourceColumn(attribute='get_label',
is_identifier=True,
is_object_absolute_url=True,
source=DocumentPage,
widget_condition=is_document_page_enabled)
SourceColumn(func=lambda context: document_page_thumbnail_widget.
render(instance=context['object']),
html_extra_classes='text-center document-thumbnail-list',
label=_('Thumbnail'),
source=DocumentPage)
SourceColumn(attribute='enabled',
include_label=True,
source=DocumentPage,
widget=TwoStateWidget)
SourceColumn(attribute='page_number',
include_label=True,
source=DocumentPage)
SourceColumn(attribute='get_label',
is_identifier=True,
is_object_absolute_url=True,
source=DocumentPageResult)
SourceColumn(func=lambda context: document_page_thumbnail_widget.
render(instance=context['object']),
html_extra_classes='text-center document-thumbnail-list',
label=_('Thumbnail'),
source=DocumentPageResult)
SourceColumn(attribute='document_version.document.document_type',
label=_('Type'),
source=DocumentPageResult)
# DocumentType
SourceColumn(attribute='label',
is_identifier=True,
is_sortable=True,
source=DocumentType)
SourceColumn(func=lambda context: context['object'].get_document_count(
user=context['request'].user),
include_label=True,
label=_('Documents'),
source=DocumentType)
SourceColumn(attribute='filename',
is_identifier=True,
is_sortable=True,
source=DocumentTypeFilename)
SourceColumn(attribute='enabled',
include_label=True,
is_sortable=True,
source=DocumentTypeFilename,
widget=TwoStateWidget)
# DeletedDocument
SourceColumn(attribute='label',
is_identifier=True,
is_sortable=True,
source=DeletedDocument)
SourceColumn(attribute='deleted_date_time',
include_label=True,
order=99,
source=DeletedDocument)
# DocumentVersion
SourceColumn(source=DocumentVersion,
attribute='timestamp',
is_identifier=True,
is_object_absolute_url=True)
SourceColumn(func=lambda context: document_page_thumbnail_widget.
render(instance=context['object']),
html_extra_classes='text-center document-thumbnail-list',
label=_('Thumbnail'),
source=DocumentVersion)
SourceColumn(func=lambda context: widget_document_version_page_number(
document_version=context['object']),
label=_('Pages'),
source=DocumentVersion)
SourceColumn(attribute='mimetype',
is_sortable=True,
source=DocumentVersion)
SourceColumn(attribute='encoding',
is_sortable=True,
source=DocumentVersion)
SourceColumn(attribute='comment',
is_sortable=True,
source=DocumentVersion)
Template(name='invalid_document',
template_name='documents/invalid_document.html')
dashboard_main.add_widget(widget=DashboardWidgetDocumentsTotal,
order=0)
dashboard_main.add_widget(widget=DashboardWidgetDocumentPagesTotal,
order=1)
dashboard_main.add_widget(widget=DashboardWidgetDocumentsInTrash,
order=2)
dashboard_main.add_widget(widget=DashboardWidgetDocumentsTypesTotal,
order=3)
dashboard_main.add_widget(widget=DashboardWidgetDocumentsNewThisMonth,
order=4)
dashboard_main.add_widget(
widget=DashboardWidgetDocumentsPagesNewThisMonth, order=5)
menu_documents.bind_links(links=(
link_document_list_recent_access,
link_document_list_recent_added,
link_document_list_favorites,
link_document_list,
link_document_list_deleted,
link_duplicated_document_list,
))
menu_main.bind_links(links=(menu_documents, ), position=0)
menu_setup.bind_links(links=(link_document_type_setup, ))
menu_tools.bind_links(links=(link_duplicated_document_scan, ))
# Document type links
menu_list_facet.bind_links(links=(
link_document_type_filename_list,
link_document_type_policies,
link_document_type_filename_generator,
link_acl_list,
link_object_event_types_user_subcriptions_list,
link_events_for_object,
),
sources=(DocumentType, ))
menu_object.bind_links(links=(link_document_type_delete,
link_document_type_edit),
sources=(DocumentType, ))
menu_object.bind_links(links=(link_document_type_filename_edit,
link_document_type_filename_delete),
sources=(DocumentTypeFilename, ))
menu_secondary.bind_links(links=(link_document_type_list,
link_document_type_create),
sources=(DocumentType,
'documents:document_type_create',
'documents:document_type_list'))
menu_secondary.bind_links(
links=(link_document_type_filename_create, ),
sources=(DocumentTypeFilename,
'documents:document_type_filename_list',
'documents:document_type_filename_create'))
menu_secondary.bind_links(links=(link_trash_can_empty, ),
sources=('documents:document_list_deleted',
'documents:trash_can_empty'))
# Document object links
menu_object.bind_links(links=(
link_document_favorites_add,
link_document_favorites_remove,
link_document_edit,
link_document_document_type_edit,
link_document_print,
link_document_trash,
link_document_quick_download,
link_document_download,
link_document_clear_transformations,
link_document_clone_transformations,
link_document_update_page_count,
),
sources=(Document, ))
menu_object.bind_links(links=(link_document_restore,
link_document_delete),
sources=(DeletedDocument, ))
# Document facet links
menu_facet.bind_links(links=(
link_document_duplicates_list,
link_acl_list,
),
sources=(Document, ))
menu_facet.bind_links(links=(link_document_preview, ),
sources=(Document, ),
position=0)
menu_facet.bind_links(links=(link_document_properties, ),
sources=(Document, ),
position=2)
menu_facet.bind_links(links=(
link_events_for_object,
link_object_event_types_user_subcriptions_list,
link_document_version_list,
),
sources=(Document, ),
position=2)
menu_facet.bind_links(links=(link_document_pages, ),
sources=(Document, ))
# Document actions
menu_object.bind_links(links=(link_document_version_revert,
link_document_version_download),
sources=(DocumentVersion, ))
menu_multi_item.bind_links(links=(
link_document_multiple_favorites_add,
link_document_multiple_favorites_remove,
link_document_multiple_clear_transformations,
link_document_multiple_trash,
link_document_multiple_download,
link_document_multiple_update_page_count,
link_document_multiple_document_type_edit,
),
sources=(Document, ))
# Document pages
menu_facet.add_unsorted_source(source=DocumentPage)
menu_facet.bind_links(
links=(link_document_page_rotate_left,
link_document_page_rotate_right, link_document_page_zoom_in,
link_document_page_zoom_out, link_document_page_view_reset),
sources=('documents:document_page_view', ))
menu_facet.bind_links(links=(link_document_page_view, ),
sources=(DocumentPage, ))
menu_facet.bind_links(links=(link_document_page_navigation_first,
link_document_page_navigation_previous,
link_document_page_navigation_next,
link_document_page_navigation_last),
sources=(DocumentPage, ))
menu_list_facet.bind_links(links=(link_decorations_list, ),
sources=(DocumentPage, ))
menu_list_facet.bind_links(links=(link_transformation_list, ),
sources=(DocumentPage, ))
menu_multi_item.bind_links(links=(link_document_page_multiple_disable,
link_document_page_multiple_enable),
sources=(DocumentPage, ))
menu_object.bind_links(links=(link_document_page_disable,
link_document_page_enable),
sources=(DocumentPage, ))
menu_related.bind_links(links=(link_document_page_return, ),
sources=(DocumentPage, ))
# Document versions
menu_list_facet.bind_links(links=(link_document_version_view, ),
sources=(DocumentVersion, ))
menu_related.bind_links(
links=(link_document_version_return_document, ),
sources=(DocumentVersion, ))
menu_secondary.bind_links(links=(link_document_version_return_list, ),
sources=(DocumentVersion, ))
# Trashed documents
menu_multi_item.add_proxy_exclusion(source=DeletedDocument)
menu_multi_item.bind_links(links=(link_document_multiple_restore,
link_document_multiple_delete),
sources=(DeletedDocument, ))
post_delete.connect(
dispatch_uid='documents_handler_remove_empty_duplicates_lists',
receiver=handler_remove_empty_duplicates_lists,
sender=Document)
post_migrate.connect(
dispatch_uid='documents_handler_create_document_cache',
receiver=handler_create_document_cache,
)
signal_post_initial_setup.connect(
dispatch_uid='documents_handler_create_default_document_type',
receiver=handler_create_default_document_type)
signal_post_version_upload.connect(
dispatch_uid='documents_handler_scan_duplicates_for',
receiver=handler_scan_duplicates_for)