Backport support for global and object event notification. GitLab issue #262.
Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
@@ -1,70 +1,231 @@
|
||||
from __future__ import unicode_literals
|
||||
|
||||
import logging
|
||||
|
||||
from django.apps import apps
|
||||
from django.utils.encoding import force_text
|
||||
from django.contrib.auth import get_user_model
|
||||
from django.core.exceptions import PermissionDenied
|
||||
from django.utils.encoding import force_text, python_2_unicode_compatible
|
||||
from django.utils.translation import ugettext_lazy as _
|
||||
|
||||
from actstream import action
|
||||
|
||||
from .permissions import permission_events_view
|
||||
|
||||
class Event(object):
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@python_2_unicode_compatible
|
||||
class EventTypeNamespace(object):
|
||||
_registry = {}
|
||||
|
||||
@classmethod
|
||||
def all(cls):
|
||||
return Event.sort(event_type_list=cls._registry.values())
|
||||
return sorted(cls._registry.values())
|
||||
|
||||
@classmethod
|
||||
def get(cls, name):
|
||||
return cls._registry[name]
|
||||
|
||||
def __init__(self, name, label):
|
||||
self.name = name
|
||||
self.label = label
|
||||
self.event_types = []
|
||||
self.__class__._registry[name] = self
|
||||
|
||||
def __str__(self):
|
||||
return force_text(self.label)
|
||||
|
||||
def add_event_type(self, name, label):
|
||||
event_type = EventType(namespace=self, name=name, label=label)
|
||||
self.event_types.append(event_type)
|
||||
return event_type
|
||||
|
||||
def get_event_types(self):
|
||||
return EventType.sort(event_type_list=self.event_types)
|
||||
|
||||
|
||||
@python_2_unicode_compatible
|
||||
class EventType(object):
|
||||
_registry = {}
|
||||
|
||||
@staticmethod
|
||||
def sort(event_type_list):
|
||||
return sorted(
|
||||
event_type_list, key=lambda x: (x.namespace.label, x.label)
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def all(cls):
|
||||
# Return sorted permisions by namespace.name
|
||||
return EventType.sort(event_type_list=cls._registry.values())
|
||||
|
||||
@classmethod
|
||||
def get(cls, name):
|
||||
try:
|
||||
return cls._registry[name]
|
||||
except KeyError:
|
||||
raise KeyError(
|
||||
_('Unknown or obsolete event type: {0}'.format(name))
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def get_label(cls, name):
|
||||
try:
|
||||
return cls.get(name=name).label
|
||||
except KeyError as exception:
|
||||
return force_text(exception)
|
||||
return _('Unknown or obsolete event type: %s') % name
|
||||
|
||||
@classmethod
|
||||
def refresh(cls):
|
||||
for event_type in cls.all():
|
||||
event_type.get_type()
|
||||
event_type.get_stored_event_type()
|
||||
|
||||
@staticmethod
|
||||
def sort(event_type_list):
|
||||
return sorted(
|
||||
event_type_list, key=lambda x: x.label
|
||||
)
|
||||
|
||||
def __init__(self, name, label):
|
||||
def __init__(self, namespace, name, label):
|
||||
self.namespace = namespace
|
||||
self.name = name
|
||||
self.label = label
|
||||
self.event_type = None
|
||||
self.__class__._registry[name] = self
|
||||
self.stored_event_type = None
|
||||
self.__class__._registry[self.id] = self
|
||||
|
||||
def get_type(self):
|
||||
if not self.event_type:
|
||||
EventType = apps.get_model('events', 'EventType')
|
||||
|
||||
self.event_type, created = EventType.objects.get_or_create(
|
||||
name=self.name
|
||||
)
|
||||
|
||||
return self.event_type
|
||||
def __str__(self):
|
||||
return force_text('{}: {}'.format(self.namespace.label, self.label))
|
||||
|
||||
def commit(self, actor=None, action_object=None, target=None):
|
||||
if not self.event_type:
|
||||
EventType = apps.get_model('events', 'EventType')
|
||||
self.event_type, created = EventType.objects.get_or_create(
|
||||
name=self.name
|
||||
)
|
||||
AccessControlList = apps.get_model(
|
||||
app_label='acls', model_name='AccessControlList'
|
||||
)
|
||||
Action = apps.get_model(
|
||||
app_label='actstream', model_name='Action'
|
||||
)
|
||||
ContentType = apps.get_model(
|
||||
app_label='contenttypes', model_name='ContentType'
|
||||
)
|
||||
Notification = apps.get_model(
|
||||
app_label='events', model_name='Notification'
|
||||
)
|
||||
|
||||
action.send(
|
||||
actor or target, actor=actor, verb=self.name,
|
||||
results = action.send(
|
||||
actor or target, actor=actor, verb=self.id,
|
||||
action_object=action_object, target=target
|
||||
)
|
||||
|
||||
for handler, result in results:
|
||||
if isinstance(result, Action):
|
||||
for user in get_user_model().objects.all():
|
||||
notification = None
|
||||
|
||||
if user.event_subscriptions.filter(stored_event_type__name=result.verb).exists():
|
||||
if result.target:
|
||||
try:
|
||||
AccessControlList.objects.check_access(
|
||||
permissions=permission_events_view,
|
||||
user=user, obj=result.target
|
||||
)
|
||||
except PermissionDenied:
|
||||
pass
|
||||
else:
|
||||
notification = Notification.objects.create(action=result, user=user)
|
||||
else:
|
||||
notification = Notification.objects.create(action=result, user=user)
|
||||
|
||||
if result.target:
|
||||
content_type = ContentType.objects.get_for_model(model=result.target)
|
||||
|
||||
relationship = user.object_subscriptions.filter(
|
||||
content_type=content_type,
|
||||
object_id=result.target.pk,
|
||||
stored_event_type__name=result.verb
|
||||
)
|
||||
|
||||
if relationship.exists():
|
||||
try:
|
||||
AccessControlList.objects.check_access(
|
||||
permissions=permission_events_view,
|
||||
user=user, obj=result.target
|
||||
)
|
||||
except PermissionDenied:
|
||||
pass
|
||||
else:
|
||||
notification = Notification.objects.create(action=result, user=user)
|
||||
if not notification and result.action_object:
|
||||
content_type = ContentType.objects.get_for_model(model=result.action_object)
|
||||
|
||||
relationship = user.object_subscriptions.filter(
|
||||
content_type=content_type,
|
||||
object_id=result.action_object.pk,
|
||||
stored_event_type__name=result.verb
|
||||
)
|
||||
|
||||
if relationship.exists():
|
||||
try:
|
||||
AccessControlList.objects.check_access(
|
||||
permissions=permission_events_view,
|
||||
user=user, obj=result.action_object
|
||||
)
|
||||
except PermissionDenied:
|
||||
pass
|
||||
else:
|
||||
notification = Notification.objects.create(action=result, user=user)
|
||||
|
||||
def get_stored_event_type(self):
|
||||
if not self.stored_event_type:
|
||||
StoredEventType = apps.get_model('events', 'StoredEventType')
|
||||
|
||||
self.stored_event_type, created = StoredEventType.objects.get_or_create(
|
||||
name=self.id
|
||||
)
|
||||
|
||||
return self.stored_event_type
|
||||
|
||||
@property
|
||||
def id(self):
|
||||
return '%s.%s' % (self.namespace.name, self.name)
|
||||
|
||||
|
||||
class ModelEventType(object):
|
||||
"""
|
||||
Class to allow matching a model to a specific set of events.
|
||||
"""
|
||||
_inheritances = {}
|
||||
_proxies = {}
|
||||
_registry = {}
|
||||
|
||||
@classmethod
|
||||
def get_for_class(cls, klass):
|
||||
return cls._registry.get(klass, ())
|
||||
|
||||
@classmethod
|
||||
def get_for_instance(cls, instance):
|
||||
StoredEventType = apps.get_model(
|
||||
app_label='events', model_name='StoredEventType'
|
||||
)
|
||||
|
||||
events = []
|
||||
|
||||
class_events = cls._registry.get(type(instance))
|
||||
|
||||
if class_events:
|
||||
events.extend(class_events)
|
||||
|
||||
proxy = cls._proxies.get(type(instance))
|
||||
|
||||
if proxy:
|
||||
events.extend(cls._registry.get(proxy))
|
||||
|
||||
pks = [
|
||||
event.id for event in set(events)
|
||||
]
|
||||
|
||||
return EventType.sort(
|
||||
event_type_list=StoredEventType.objects.filter(name__in=pks)
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def get_inheritance(cls, model):
|
||||
return cls._inheritances[model]
|
||||
|
||||
@classmethod
|
||||
def register(cls, model, event_types):
|
||||
cls._registry.setdefault(model, [])
|
||||
for event_type in event_types:
|
||||
cls._registry[model].append(event_type)
|
||||
|
||||
@classmethod
|
||||
def register_inheritance(cls, model, related):
|
||||
cls._inheritances[model] = related
|
||||
|
||||
@classmethod
|
||||
def register_proxy(cls, source, model):
|
||||
cls._proxies[model] = source
|
||||
|
||||
Reference in New Issue
Block a user