Add support for global and object event notification. GitLab issue #262.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>

mayan/apps/documents/apps.py

@@ -23,7 +23,11 @@ from converter.permissions import (
     permission_transformation_delete, permission_transformation_edit,
     permission_transformation_view,
 )
-from events.links import link_events_for_object
+from events import ModelEventType
+from events.links import (
+    link_events_for_object, link_object_event_types_user_subcriptions_list,
+    link_object_event_types_user_subcriptions_list_with_icon
+)
 from events.permissions import permission_events_view
 from mayan.celery import app
 from navigation import SourceColumn
@@ -31,6 +35,12 @@ from rest_api.classes import APIEndPoint, APIResource
 from rest_api.fields import DynamicSerializerField
 from statistics.classes import StatisticNamespace, CharJSLine
 
+from .events import (
+    event_document_create, event_document_download,
+    event_document_properties_edit, event_document_type_change,
+    event_document_new_version, event_document_version_revert,
+    event_document_view
+)
 from .handlers import (
     create_default_document_type, handler_scan_duplicates_for
 )
@@ -171,6 +181,19 @@ class DocumentsApp(MayanAppConfig):
             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,
@@ -386,7 +409,8 @@ class DocumentsApp(MayanAppConfig):
         menu_object.bind_links(
             links=(
                 link_document_type_edit, link_document_type_filename_list,
-                link_acl_list, link_document_type_delete
+                link_acl_list, link_object_event_types_user_subcriptions_list,
+                link_document_type_delete
             ), sources=(DocumentType,)
         )
         menu_object.bind_links(
@@ -443,8 +467,11 @@ class DocumentsApp(MayanAppConfig):
             links=(link_document_properties,), sources=(Document,), position=2
         )
         menu_facet.bind_links(
-            links=(link_events_for_object, link_document_version_list,),
-            sources=(Document,), position=2
+            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,))
 
@@ -548,3 +575,4 @@ class DocumentsApp(MayanAppConfig):
 
         registry.register(DeletedDocument)
         registry.register(Document)
+        registry.register(DocumentType)

mayan/apps/documents/events.py

@@ -2,29 +2,28 @@ from __future__ import absolute_import, unicode_literals
 
 from django.utils.translation import ugettext_lazy as _
 
-from events.classes import Event
+from events import EventTypeNamespace
 
-event_document_create = Event(
-    name='documents_document_create', label=_('Document created')
+namespace = EventTypeNamespace(name='documents', label=_('Documents'))
+
+event_document_create = namespace.add_event_type(
+    name='document_create', label=_('Document created')
 )
-event_document_download = Event(
-    name='documents_document_download',
-    label=_('Document downloaded')
+event_document_download = namespace.add_event_type(
+    name='document_download', label=_('Document downloaded')
 )
-event_document_properties_edit = Event(
-    name='documents_document_edit', label=_('Document properties edited')
+event_document_properties_edit = namespace.add_event_type(
+    name='document_edit', label=_('Document properties edited')
 )
-event_document_type_change = Event(
-    name='documents_document_type_change', label=_('Document type changed')
+event_document_type_change = namespace.add_event_type(
+    name='document_type_change', label=_('Document type changed')
 )
-event_document_new_version = Event(
-    name='documents_document_new_version', label=_('New version uploaded')
+event_document_new_version = namespace.add_event_type(
+    name='document_new_version', label=_('New version uploaded')
 )
-event_document_version_revert = Event(
-    name='documents_document_version_revert',
-    label=_('Document version reverted')
+event_document_version_revert = namespace.add_event_type(
+    name='document_version_revert', label=_('Document version reverted')
 )
-event_document_view = Event(
-    name='documents_document_view',
-    label=_('Document viewed')
+event_document_view = namespace.add_event_type(
+    name='document_view', label=_('Document viewed')
 )

mayan/apps/documents/models.py

@@ -219,9 +219,13 @@ class Document(models.Model):
         if new_document:
             if user:
                 self.add_as_recent_document_for_user(user)
-                event_document_create.commit(actor=user, target=self)
+                event_document_create.commit(
+                    actor=user, target=self, action_object=self.document_type
+                )
             else:
-                event_document_create.commit(target=self)
+                event_document_create.commit(
+                    target=self, action_object=self.document_type
+                )
         else:
             event_document_properties_edit.commit(actor=user, target=self)
 

mayan/apps/documents/tests/test_events.py

@@ -64,7 +64,7 @@ class DocumentEventsTestCase(GenericDocumentViewTestCase):
 
         event = Action.objects.any(obj=self.document).first()
 
-        self.assertEqual(event.verb, event_document_download.name)
+        self.assertEqual(event.verb, event_document_download.id)
         self.assertEqual(event.target, self.document)
         self.assertEqual(event.actor, self.user)
 
@@ -98,6 +98,6 @@ class DocumentEventsTestCase(GenericDocumentViewTestCase):
 
         event = Action.objects.any(obj=self.document).first()
 
-        self.assertEqual(event.verb, event_document_view.name)
+        self.assertEqual(event.verb, event_document_view.id)
         self.assertEqual(event.target, self.document)
         self.assertEqual(event.actor, self.user)