def ready(self):
super(DocumentCommentsApp, self).ready()
APIEndPoint(app=self, version_string='1')
Document = apps.get_model(
app_label='documents', model_name='Document'
)
Comment = self.get_model('Comment')
ModelEventType.register(
model=Document, event_types=(
event_document_comment_create, event_document_comment_delete
)
)
ModelPermission.register(
model=Document, permissions=(
permission_comment_create, permission_comment_delete,
permission_comment_view
)
)
SourceColumn(source=Comment, label=_('Date'), attribute='submit_date')
SourceColumn(
source=Comment, label=_('User'),
func=lambda context: context['object'].user.get_full_name() if context['object'].user.get_full_name() else context['object'].user
)
SourceColumn(source=Comment, label=_('Comment'), attribute='comment')
document_page_search.add_model_field(
field='document_version__document__comments__comment',
label=_('Comments')
)
document_search.add_model_field(
field='comments__comment',
label=_('Comments')
)
menu_sidebar.bind_links(
links=(link_comment_add,),
sources=(
'comments:comments_for_document', 'comments:comment_add',
'comments:comment_delete', 'comments:comment_multiple_delete'
)
)
menu_object.bind_links(
links=(link_comment_delete,), sources=(Comment,)
)
menu_facet.bind_links(
links=(link_comments_for_document,), sources=(Document,)
)
def ready(self):
super(DocumentCommentsApp, self).ready()
Document = apps.get_model(
app_label='documents', model_name='Document'
)
Comment = self.get_model('Comment')
ModelEventType.register(
model=Document, event_types=(
event_document_comment_create, event_document_comment_delete
)
)
ModelPermission.register(
model=Document, permissions=(
permission_comment_create, permission_comment_delete,
permission_comment_view
)
)
SourceColumn(source=Comment, label=_('Date'), attribute='submit_date')
SourceColumn(
source=Comment, label=_('User'),
func=lambda context: context['object'].user.get_full_name() if context['object'].user.get_full_name() else context['object'].user
)
SourceColumn(source=Comment, label=_('Comment'), attribute='comment')
document_page_search.add_model_field(
field='document_version__document__comments__comment',
label=_('Comments')
)
document_search.add_model_field(
field='comments__comment',
label=_('Comments')
)
menu_sidebar.bind_links(
links=(link_comment_add,),
sources=(
'comments:comments_for_document', 'comments:comment_add',
'comments:comment_delete', 'comments:comment_multiple_delete'
)
)
menu_object.bind_links(
links=(link_comment_delete,), sources=(Comment,)
)
menu_facet.bind_links(
links=(link_comments_for_document,), sources=(Document,)
)
def ready(self):
super(CheckoutsApp, self).ready()
APIEndPoint(app=self, version_string='1')
Document = apps.get_model(app_label='documents', model_name='Document')
DocumentVersion = apps.get_model(app_label='documents',
model_name='DocumentVersion')
DocumentCheckout = self.get_model('DocumentCheckout')
Document.add_to_class('check_in',
lambda document, user=None: DocumentCheckout.
objects.check_in_document(document, user))
Document.add_to_class(
'checkout_info', lambda document: DocumentCheckout.objects.
document_checkout_info(document))
Document.add_to_class(
'checkout_state', lambda document: DocumentCheckout.objects.
document_checkout_state(document))
Document.add_to_class(
'is_checked_out', lambda document: DocumentCheckout.objects.
is_document_checked_out(document))
ModelEventType.register(model=Document,
event_types=(event_document_auto_check_in,
event_document_check_in,
event_document_check_out,
event_document_forceful_check_in))
ModelPermission.register(
model=Document,
permissions=(permission_document_checkout,
permission_document_checkin,
permission_document_checkin_override,
permission_document_checkout_detail_view))
app.conf.CELERYBEAT_SCHEDULE.update({
'task_check_expired_check_outs': {
'task': 'checkouts.tasks.task_check_expired_check_outs',
'schedule':
timedelta(seconds=CHECK_EXPIRED_CHECK_OUTS_INTERVAL),
},
})
app.conf.CELERY_QUEUES.append(
Queue('checkouts_periodic',
Exchange('checkouts_periodic'),
routing_key='checkouts_periodic',
delivery_mode=1), )
app.conf.CELERY_ROUTES.update({
'checkouts.tasks.task_check_expired_check_outs': {
'queue': 'checkouts_periodic'
},
})
dashboard_main.add_widget(order=-1, widget=widget_checkouts)
menu_facet.bind_links(links=(link_checkout_info, ),
sources=(Document, ))
menu_main.bind_links(links=(link_checkout_list, ), position=98)
menu_sidebar.bind_links(links=(link_checkout_document,
link_checkin_document),
sources=('checkouts:checkout_info',
'checkouts:checkout_document',
'checkouts:checkin_document'))
pre_save.connect(check_new_version_creation,
dispatch_uid='check_new_version_creation',
sender=DocumentVersion)
def ready(self):
super(TagsApp, self).ready()
from actstream import registry
from .wizard_steps import WizardStepTags # NOQA
Document = apps.get_model(
app_label='documents', model_name='Document'
)
DocumentPageResult = apps.get_model(
app_label='documents', model_name='DocumentPageResult'
)
DocumentTag = self.get_model('DocumentTag')
Tag = self.get_model('Tag')
Document.add_to_class(
'attached_tags',
lambda document: DocumentTag.objects.filter(documents=document)
)
ModelEventType.register(
model=Tag, event_types=(
event_tag_attach, event_tag_created, event_tag_edited,
event_tag_remove
)
)
ModelField(
Document, name='tags__label'
)
ModelField(
Document, name='tags__color'
)
ModelPermission.register(
model=Document, permissions=(
permission_tag_attach, permission_tag_remove,
permission_tag_view
)
)
ModelPermission.register(
model=Tag, permissions=(
permission_acl_edit, permission_acl_view,
permission_events_view, permission_tag_attach,
permission_tag_delete, permission_tag_edit,
permission_tag_remove, permission_tag_view,
)
)
SourceColumn(
source=DocumentTag, attribute='label'
)
SourceColumn(
source=DocumentTag, attribute='get_preview_widget'
)
SourceColumn(
source=Document, label=_('Tags'),
func=lambda context: widget_document_tags(
document=context['object'], user=context['request'].user
)
)
SourceColumn(
source=DocumentPageResult, label=_('Tags'),
func=lambda context: widget_document_tags(
document=context['object'].document,
user=context['request'].user
)
)
SourceColumn(
source=Tag, attribute='label'
)
SourceColumn(
source=Tag, attribute='get_preview_widget'
)
SourceColumn(
source=Tag, label=_('Documents'),
func=lambda context: context['object'].get_document_count(
user=context['request'].user
)
)
document_page_search.add_model_field(
field='document_version__document__tags__label', label=_('Tags')
)
document_search.add_model_field(field='tags__label', label=_('Tags'))
menu_facet.bind_links(
links=(link_tag_document_list,), sources=(Document,)
)
menu_tags.bind_links(
links=(
link_tag_list, link_tag_create
)
)
menu_main.bind_links(links=(menu_tags,), position=98)
menu_multi_item.bind_links(
links=(
link_multiple_documents_attach_tag,
link_multiple_documents_tag_remove
),
sources=(Document,)
)
menu_multi_item.bind_links(
links=(link_tag_multiple_delete,), sources=(Tag,)
)
menu_object.bind_links(
links=(
link_tag_tagged_item_list, link_tag_edit, link_acl_list,
link_events_for_object,
link_object_event_types_user_subcriptions_list,
link_tag_delete
),
sources=(Tag,)
)
menu_sidebar.bind_links(
links=(link_tag_attach, link_single_document_multiple_tag_remove),
sources=(
'tags:tag_attach', 'tags:document_tags',
'tags:single_document_multiple_tag_remove'
)
)
registry.register(Tag)
# Index update
m2m_changed.connect(
handler_index_document,
dispatch_uid='tags_handler_index_document',
sender=Tag.documents.through
)
pre_delete.connect(
handler_tag_pre_delete,
dispatch_uid='tags_handler_tag_pre_delete',
sender=Tag
)
def ready(self):
super(MetadataApp, self).ready()
from actstream import registry
from .wizard_steps import WizardStepMetadata # NOQA
Document = apps.get_model(app_label='documents', model_name='Document')
DocumentPageResult = apps.get_model(app_label='documents',
model_name='DocumentPageResult')
DocumentType = apps.get_model(app_label='documents',
model_name='DocumentType')
DocumentMetadata = self.get_model('DocumentMetadata')
DocumentTypeMetadataType = self.get_model('DocumentTypeMetadataType')
MetadataType = self.get_model('MetadataType')
Document.add_to_class('metadata_value_of',
DocumentMetadataHelper.constructor)
ModelAttribute(
Document,
'metadata_value_of',
description=_('Return the value of a specific document metadata'),
)
ModelField(Document,
'metadata__metadata_type__name',
label=_('Metadata type name'))
ModelField(
Document,
'metadata__value',
label=_('Metadata type value'),
)
ModelEventType.register(model=Document,
event_types=(
event_document_metadata_added,
event_document_metadata_edited,
event_document_metadata_removed,
))
ModelEventType.register(model=MetadataType,
event_types=(
event_document_metadata_added,
event_document_metadata_edited,
event_document_metadata_removed,
event_metadata_type_edited,
event_metadata_type_relationship,
))
ModelEventType.register(
model=DocumentType,
event_types=(event_metadata_type_relationship, ))
ModelPermission.register(model=Document,
permissions=(
permission_metadata_document_add,
permission_metadata_document_edit,
permission_metadata_document_remove,
permission_metadata_document_view,
))
ModelPermission.register(model=MetadataType,
permissions=(permission_acl_edit,
permission_acl_view,
permission_events_view,
permission_metadata_type_delete,
permission_metadata_type_edit,
permission_metadata_type_view))
SourceColumn(
source=Document,
label=_('Metadata'),
func=lambda context: get_metadata_string(context['object']))
SourceColumn(source=DocumentPageResult,
label=_('Metadata'),
func=lambda context: get_metadata_string(context['object']
.document))
SourceColumn(source=DocumentMetadata,
label=_('Value'),
attribute='value')
SourceColumn(source=DocumentMetadata,
label=_('Required'),
func=lambda context: TwoStateWidget(state=context[
'object'].is_required).render())
app.conf.CELERY_QUEUES.append(
Queue('metadata', Exchange('metadata'), routing_key='metadata'), )
app.conf.CELERY_ROUTES.update({
'metadata.tasks.task_remove_metadata_type': {
'queue': 'metadata'
},
'metadata.tasks.task_add_required_metadata_type': {
'queue': 'metadata'
},
})
document_search.add_model_field(field='metadata__metadata_type__name',
label=_('Metadata type'))
document_search.add_model_field(field='metadata__value',
label=_('Metadata value'))
document_page_search.add_model_field(
field='document_version__document__metadata__metadata_type__name',
label=_('Metadata type'))
document_page_search.add_model_field(
field='document_version__document__metadata__value',
label=_('Metadata value'))
menu_facet.bind_links(links=(link_metadata_view, ),
sources=(Document, ))
menu_multi_item.bind_links(links=(link_metadata_multiple_add,
link_metadata_multiple_edit,
link_metadata_multiple_remove),
sources=(Document, ))
menu_object.bind_links(
links=(link_setup_document_type_metadata_types, ),
sources=(DocumentType, ))
menu_object.bind_links(links=(
link_setup_metadata_type_edit,
link_setup_metadata_type_document_types,
link_acl_list,
link_object_event_types_user_subcriptions_list,
link_events_for_object,
link_setup_metadata_type_delete,
),
sources=(MetadataType, ))
menu_secondary.bind_links(
links=(link_setup_metadata_type_list,
link_setup_metadata_type_create),
sources=(MetadataType, 'metadata:setup_metadata_type_list',
'metadata:setup_metadata_type_create'))
menu_setup.bind_links(links=(link_setup_metadata_type_list, ))
menu_sidebar.bind_links(
links=(link_metadata_add, link_metadata_edit,
link_metadata_remove),
sources=('metadata:metadata_add', 'metadata:metadata_edit',
'metadata:metadata_remove', 'metadata:metadata_view'))
post_delete.connect(
post_document_type_metadata_type_delete,
dispatch_uid='metadata_post_document_type_metadata_type_delete',
sender=DocumentTypeMetadataType)
post_document_type_change.connect(
post_document_type_change_metadata,
dispatch_uid='metadata_post_document_type_change_metadata',
sender=Document)
post_save.connect(
post_document_type_metadata_type_add,
dispatch_uid='metadata_post_document_type_metadata_type_add',
sender=DocumentTypeMetadataType)
# Index updating
post_delete.connect(
handler_index_document,
dispatch_uid='metadata_handler_index_document_delete',
sender=DocumentMetadata)
post_save.connect(handler_index_document,
dispatch_uid='metadata_handler_index_document_save',
sender=DocumentMetadata)
registry.register(MetadataType)
registry.register(DocumentTypeMetadataType)
def ready(self):
super(DocumentsApp, self).ready()
from actstream import registry
APIEndPoint(app=self, version_string='1')
APIResource(label=_('Document types'), name='document_types')
APIResource(label=_('Documents'), name='documents')
APIResource(label=_('Trashed documents'), name='trashed_documents')
DeletedDocument = self.get_model('DeletedDocument')
Document = self.get_model('Document')
DocumentPage = self.get_model('DocumentPage')
DocumentPageResult = self.get_model('DocumentPageResult')
DocumentType = self.get_model('DocumentType')
DocumentTypeFilename = self.get_model('DocumentTypeFilename')
DocumentVersion = self.get_model('DocumentVersion')
DuplicatedDocument = self.get_model('DuplicatedDocument')
DynamicSerializerField.add_serializer(
klass=Document,
serializer_class='documents.serializers.DocumentSerializer')
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')
ModelAttribute(Document,
label=_('Label'),
name='label',
type_name='field')
ModelAttribute(
Document,
description=_(
'The MIME type of any of the versions of a document'),
label=_('MIME type'),
name='versions__mimetype',
type_name='field')
ModelEventType.register(model=DocumentType,
event_types=(event_document_create, ))
ModelEventType.register(model=Document,
event_types=(event_document_download,
event_document_properties_edit,
event_document_type_change,
event_document_new_version,
event_document_version_revert,
event_document_view))
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_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))
ModelPermission.register_proxy(
source=Document,
model=DocumentType,
)
ModelPermission.register_inheritance(
model=Document,
related='document_type',
)
ModelPermission.register_inheritance(
model=DocumentPage,
related='document',
)
ModelPermission.register_inheritance(
model=DocumentTypeFilename,
related='document_type',
)
ModelPermission.register_inheritance(
model=DocumentVersion,
related='document',
)
# Document and document page thumbnail widget
document_page_thumbnail_widget = DocumentPageThumbnailWidget()
document_thumbnail_widget = DocumentThumbnailWidget()
document_version_thumbnail_widget = DocumentVersionThumbnailWidget()
# Document
SourceColumn(source=Document,
label=_('Thumbnail'),
func=lambda context: document_thumbnail_widget.render(
instance=context['object']))
SourceColumn(source=Document,
label=_('Type'),
attribute='document_type')
# DocumentPage
SourceColumn(source=DocumentPage,
label=_('Thumbnail'),
func=lambda context: document_page_thumbnail_widget.
render(instance=context['object']))
SourceColumn(source=DocumentPageResult,
label=_('Thumbnail'),
func=lambda context: document_page_thumbnail_widget.
render(instance=context['object']))
SourceColumn(source=DocumentPageResult,
label=_('Type'),
attribute='document_version.document.document_type')
# DocumentType
SourceColumn(source=DocumentType,
label=_('Documents'),
func=lambda context: context['object'].get_document_count(
user=context['request'].user))
SourceColumn(
source=DocumentTypeFilename,
label=_('Enabled'),
func=lambda context: two_state_template(context['object'].enabled))
# DeletedDocument
SourceColumn(source=DeletedDocument,
label=_('Thumbnail'),
func=lambda context: document_thumbnail_widget.render(
instance=context['object']))
SourceColumn(source=DeletedDocument,
label=_('Type'),
attribute='document_type')
SourceColumn(source=DeletedDocument,
label=_('Date time trashed'),
attribute='deleted_date_time')
# DocumentVersion
SourceColumn(source=DocumentVersion,
label=_('Time and date'),
attribute='timestamp')
SourceColumn(source=DocumentVersion,
label=_('MIME type'),
attribute='mimetype')
SourceColumn(source=DocumentVersion,
label=_('Encoding'),
attribute='encoding')
SourceColumn(source=DocumentVersion,
label=_('Comment'),
attribute='comment')
SourceColumn(source=DocumentVersion,
label=_('Thumbnail'),
func=lambda context: document_version_thumbnail_widget.
render(instance=context['object']))
# DuplicatedDocument
SourceColumn(source=DuplicatedDocument,
label=_('Thumbnail'),
func=lambda context: document_thumbnail_widget.render(
instance=context['object'].document))
SourceColumn(source=DuplicatedDocument,
label=_('Duplicates'),
func=lambda context: context['object'].documents.count())
app.conf.CELERYBEAT_SCHEDULE.update({
'task_check_delete_periods': {
'task': 'documents.tasks.task_check_delete_periods',
'schedule': timedelta(seconds=CHECK_DELETE_PERIOD_INTERVAL),
},
'task_check_trash_periods': {
'task': 'documents.tasks.task_check_trash_periods',
'schedule': timedelta(seconds=CHECK_TRASH_PERIOD_INTERVAL),
},
'task_delete_stubs': {
'task': 'documents.tasks.task_delete_stubs',
'schedule': timedelta(seconds=DELETE_STALE_STUBS_INTERVAL),
},
})
app.conf.CELERY_QUEUES.extend((
Queue('converter',
Exchange('converter'),
routing_key='converter',
delivery_mode=1),
Queue('documents_periodic',
Exchange('documents_periodic'),
routing_key='documents_periodic',
delivery_mode=1),
Queue('uploads', Exchange('uploads'), routing_key='uploads'),
Queue('documents', Exchange('documents'), routing_key='documents'),
))
app.conf.CELERY_ROUTES.update({
'documents.tasks.task_check_delete_periods': {
'queue': 'documents_periodic'
},
'documents.tasks.task_check_trash_periods': {
'queue': 'documents_periodic'
},
'documents.tasks.task_delete_stubs': {
'queue': 'documents_periodic'
},
'documents.tasks.task_clear_image_cache': {
'queue': 'tools'
},
'documents.tasks.task_generate_document_page_image': {
'queue': 'converter'
},
'documents.tasks.task_update_page_count': {
'queue': 'uploads'
},
'documents.tasks.task_upload_new_version': {
'queue': 'uploads'
},
'documents.tasks.task_scan_duplicates_all': {
'queue': 'tools'
},
'documents.tasks.task_scan_duplicates_for': {
'queue': 'uploads'
},
'documents.tasks.task_delete_document': {
'queue': 'documents'
},
})
dashboard_main.add_widget(widget=widget_document_types)
dashboard_main.add_widget(widget=widget_documents_in_trash)
dashboard_main.add_widget(widget=widget_new_documents_this_month)
dashboard_main.add_widget(widget=widget_pages_per_month)
dashboard_main.add_widget(widget=widget_total_documents)
menu_documents.bind_links(links=(link_document_list_recent,
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_clear_image_cache,
link_duplicated_document_scan))
# Document type links
menu_object.bind_links(
links=(link_document_type_edit, link_document_type_filename_list,
link_acl_list,
link_object_event_types_user_subcriptions_list,
link_document_type_delete),
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_sidebar.bind_links(
links=(link_document_type_filename_create, ),
sources=(DocumentTypeFilename,
'documents:document_type_filename_list',
'documents:document_type_filename_create'))
menu_sidebar.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_edit,
link_document_document_type_edit,
link_document_print,
link_document_trash,
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_with_icon,
),
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_with_icon,
link_document_version_list,
),
sources=(Document, ),
position=2)
menu_facet.bind_links(links=(link_document_pages, ),
sources=(Document, ))
menu_facet.bind_links(links=(link_document_version_view, ),
sources=(DocumentVersion, ))
# Document actions
menu_object.bind_links(links=(link_document_version_view,
link_document_version_revert,
link_document_version_download),
sources=(DocumentVersion, ))
menu_multi_item.bind_links(
links=(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, ))
menu_multi_item.bind_links(links=(link_document_multiple_restore,
link_document_multiple_delete),
sources=(DeletedDocument, ))
# Document pages
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_return,
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,
link_transformation_list),
sources=(DocumentPage, ))
menu_object.bind_links(links=(link_transformation_list, ),
sources=(DocumentPage, ))
# Document versions
menu_facet.bind_links(links=(link_document_version_return_document,
link_document_version_return_list),
sources=(DocumentVersion, ))
namespace = StatisticNamespace(slug='documents', label=_('Documents'))
namespace.add_statistic(slug='new-documents-per-month',
label=_('New documents per month'),
func=new_documents_per_month,
renderer=CharJSLine,
minute='0')
namespace.add_statistic(slug='new-document-versions-per-month',
label=_('New document versions per month'),
func=new_document_versions_per_month,
renderer=CharJSLine,
minute='0')
namespace.add_statistic(slug='new-document-pages-per-month',
label=_('New document pages per month'),
func=new_document_pages_per_month,
renderer=CharJSLine,
minute='0')
namespace.add_statistic(slug='total-documents-at-each-month',
label=_('Total documents at each month'),
func=total_document_per_month,
renderer=CharJSLine,
minute='0')
namespace.add_statistic(
slug='total-document-versions-at-each-month',
label=_('Total document versions at each month'),
func=total_document_version_per_month,
renderer=CharJSLine,
minute='0')
namespace.add_statistic(slug='total-document-pages-at-each-month',
label=_('Total document pages at each month'),
func=total_document_page_per_month,
renderer=CharJSLine,
minute='0')
post_initial_setup.connect(create_default_document_type,
dispatch_uid='create_default_document_type')
post_version_upload.connect(
handler_scan_duplicates_for,
dispatch_uid='handler_scan_duplicates_for',
)
registry.register(DeletedDocument)
registry.register(Document)
registry.register(DocumentType)
registry.register(DocumentVersion)
def ready(self):
super(CheckoutsApp, self).ready()
Document = apps.get_model(
app_label='documents', model_name='Document'
)
DocumentVersion = apps.get_model(
app_label='documents', model_name='DocumentVersion'
)
DocumentCheckout = self.get_model('DocumentCheckout')
Document.add_to_class(
'check_in',
lambda document, user=None: DocumentCheckout.objects.check_in_document(document, user)
)
Document.add_to_class(
'checkout_info',
lambda document: DocumentCheckout.objects.document_checkout_info(
document
)
)
Document.add_to_class(
'checkout_state',
lambda document: DocumentCheckout.objects.document_checkout_state(
document
)
)
Document.add_to_class(
'is_checked_out',
lambda document: DocumentCheckout.objects.is_document_checked_out(
document
)
)
ModelEventType.register(
model=Document, event_types=(
event_document_auto_check_in, event_document_check_in,
event_document_check_out, event_document_forceful_check_in
)
)
ModelPermission.register(
model=Document, permissions=(
permission_document_checkout,
permission_document_checkin,
permission_document_checkin_override,
permission_document_checkout_detail_view
)
)
app.conf.CELERYBEAT_SCHEDULE.update(
{
'task_check_expired_check_outs': {
'task': 'checkouts.tasks.task_check_expired_check_outs',
'schedule': timedelta(
seconds=CHECK_EXPIRED_CHECK_OUTS_INTERVAL
),
},
}
)
app.conf.CELERY_QUEUES.append(
Queue(
'checkouts_periodic', Exchange('checkouts_periodic'),
routing_key='checkouts_periodic', delivery_mode=1
),
)
app.conf.CELERY_ROUTES.update(
{
'checkouts.tasks.task_check_expired_check_outs': {
'queue': 'checkouts_periodic'
},
}
)
dashboard_main.add_widget(
widget=DashboardWidgetTotalCheckouts, order=-1
)
menu_facet.bind_links(links=(link_checkout_info,), sources=(Document,))
menu_main.bind_links(links=(link_checkout_list,), position=98)
menu_sidebar.bind_links(
links=(link_checkout_document, link_checkin_document),
sources=(
'checkouts:checkout_info', 'checkouts:checkout_document',
'checkouts:checkin_document'
)
)
pre_save.connect(
check_new_version_creation,
dispatch_uid='check_new_version_creation',
sender=DocumentVersion
)
def ready(self):
super(DocumentsApp, self).ready()
from actstream import registry
DeletedDocument = self.get_model('DeletedDocument')
Document = self.get_model('Document')
DocumentPage = self.get_model('DocumentPage')
DocumentPageResult = self.get_model('DocumentPageResult')
DocumentType = self.get_model('DocumentType')
DocumentTypeFilename = self.get_model('DocumentTypeFilename')
DocumentVersion = self.get_model('DocumentVersion')
DuplicatedDocument = self.get_model('DuplicatedDocument')
DynamicSerializerField.add_serializer(
klass=Document,
serializer_class='documents.serializers.DocumentSerializer'
)
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'
)
ModelField(Document, name='description')
ModelField(Document, name='date_added')
ModelField(Document, name='deleted_date_time')
ModelField(Document, name='document_type__label')
ModelField(Document, name='in_trash')
ModelField(Document, name='is_stub')
ModelField(Document, name='label')
ModelField(Document, name='language')
ModelField(Document, name='uuid')
ModelField(
Document, name='versions__checksum'
)
ModelField(
Document, label=_('Versions comment'), name='versions__comment'
)
ModelField(
Document, label=_('Versions encoding'), name='versions__encoding'
)
ModelField(
Document, label=_('Versions mime type'), name='versions__mimetype'
)
ModelField(
Document, label=_('Versions timestamp'), name='versions__timestamp'
)
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_change, event_document_new_version,
event_document_version_revert, event_document_view
)
)
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_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
)
)
ModelPermission.register_proxy(
source=Document, model=DocumentType,
)
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',
)
# Document and document page thumbnail widget
document_page_thumbnail_widget = DocumentPageThumbnailWidget()
# Document
SourceColumn(
source=Document, label=_('Thumbnail'),
func=lambda context: document_page_thumbnail_widget.render(
instance=context['object']
)
)
SourceColumn(
source=Document, attribute='document_type'
)
SourceColumn(
source=Document, label=_('Pages'),
func=lambda context: widget_document_page_number(
document=context['object']
)
)
# DocumentPage
SourceColumn(
source=DocumentPage, label=_('Thumbnail'),
func=lambda context: document_page_thumbnail_widget.render(
instance=context['object']
)
)
SourceColumn(
source=DocumentPageResult, label=_('Thumbnail'),
func=lambda context: document_page_thumbnail_widget.render(
instance=context['object']
)
)
SourceColumn(
source=DocumentPageResult, label=_('Type'),
attribute='document_version.document.document_type'
)
# DocumentType
SourceColumn(
source=DocumentType, label=_('Documents'),
func=lambda context: context['object'].get_document_count(
user=context['request'].user
)
)
SourceColumn(
source=DocumentTypeFilename, label=_('Enabled'),
func=lambda context: TwoStateWidget(
state=context['object'].enabled
).render()
)
# DeletedDocument
SourceColumn(
source=DeletedDocument, label=_('Thumbnail'),
func=lambda context: document_page_thumbnail_widget.render(
instance=context['object']
)
)
SourceColumn(
source=DeletedDocument, attribute='document_type'
)
SourceColumn(
source=DeletedDocument, attribute='deleted_date_time'
)
# DocumentVersion
SourceColumn(
source=DocumentVersion, label=_('Thumbnail'),
func=lambda context: document_page_thumbnail_widget.render(
instance=context['object']
)
)
SourceColumn(
source=DocumentVersion, attribute='timestamp'
)
SourceColumn(
source=DocumentVersion, label=_('Pages'),
func=lambda context: widget_document_version_page_number(
document_version=context['object']
)
)
SourceColumn(
source=DocumentVersion, attribute='mimetype'
)
SourceColumn(
source=DocumentVersion, attribute='encoding'
)
SourceColumn(
source=DocumentVersion, attribute='comment'
)
# DuplicatedDocument
SourceColumn(
source=DuplicatedDocument, label=_('Thumbnail'),
func=lambda context: document_page_thumbnail_widget.render(
instance=context['object'].document
)
)
SourceColumn(
source=DuplicatedDocument, label=_('Duplicates'),
func=lambda context: context['object'].documents.count()
)
app.conf.CELERYBEAT_SCHEDULE.update(
{
'task_check_delete_periods': {
'task': 'documents.tasks.task_check_delete_periods',
'schedule': timedelta(
seconds=CHECK_DELETE_PERIOD_INTERVAL
),
},
'task_check_trash_periods': {
'task': 'documents.tasks.task_check_trash_periods',
'schedule': timedelta(seconds=CHECK_TRASH_PERIOD_INTERVAL),
},
'task_delete_stubs': {
'task': 'documents.tasks.task_delete_stubs',
'schedule': timedelta(seconds=DELETE_STALE_STUBS_INTERVAL),
},
}
)
app.conf.CELERY_QUEUES.extend(
(
Queue(
'converter', Exchange('converter'),
routing_key='converter', delivery_mode=1
),
Queue(
'documents_periodic', Exchange('documents_periodic'),
routing_key='documents_periodic', delivery_mode=1
),
Queue('uploads', Exchange('uploads'), routing_key='uploads'),
Queue(
'documents', Exchange('documents'), routing_key='documents'
),
)
)
app.conf.CELERY_ROUTES.update(
{
'documents.tasks.task_check_delete_periods': {
'queue': 'documents_periodic'
},
'documents.tasks.task_check_trash_periods': {
'queue': 'documents_periodic'
},
'documents.tasks.task_clean_empty_duplicate_lists': {
'queue': 'documents'
},
'documents.tasks.task_clear_image_cache': {
'queue': 'tools'
},
'documents.tasks.task_delete_document': {
'queue': 'documents'
},
'documents.tasks.task_delete_stubs': {
'queue': 'documents_periodic'
},
'documents.tasks.task_generate_document_page_image': {
'queue': 'converter'
},
'documents.tasks.task_scan_duplicates_all': {
'queue': 'tools'
},
'documents.tasks.task_scan_duplicates_for': {
'queue': 'uploads'
},
'documents.tasks.task_update_page_count': {
'queue': 'uploads'
},
'documents.tasks.task_upload_new_version': {
'queue': 'uploads'
},
}
)
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_clear_image_cache, link_duplicated_document_scan)
)
# Document type links
menu_object.bind_links(
links=(
link_document_type_edit, link_document_type_filename_list,
link_acl_list, link_object_event_types_user_subcriptions_list,
link_document_type_delete,
link_events_for_object,
), 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_sidebar.bind_links(
links=(link_document_type_filename_create,),
sources=(
DocumentTypeFilename, 'documents:document_type_filename_list',
'documents:document_type_filename_create'
)
)
menu_sidebar.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,)
)
menu_multi_item.bind_links(
links=(
link_document_multiple_restore, link_document_multiple_delete
), sources=(DeletedDocument,)
)
# 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_return, 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, link_transformation_list
), sources=(DocumentPage,)
)
menu_object.bind_links(
links=(link_transformation_list,), sources=(DocumentPage,)
)
# Document versions
menu_facet.bind_links(
links=(
link_document_version_return_document,
link_document_version_return_list
), sources=(DocumentVersion,)
)
menu_facet.bind_links(
links=(link_document_version_view,), sources=(DocumentVersion,)
)
post_delete.connect(
dispatch_uid='handler_remove_empty_duplicates_lists',
receiver=handler_remove_empty_duplicates_lists,
sender=Document,
)
post_initial_setup.connect(
create_default_document_type,
dispatch_uid='create_default_document_type'
)
post_version_upload.connect(
handler_scan_duplicates_for,
dispatch_uid='handler_scan_duplicates_for',
)
registry.register(DeletedDocument)
registry.register(Document)
registry.register(DocumentType)
registry.register(DocumentVersion)