mirror of
https://github.com/Hopiu/django-notifications.git
synced 2026-05-02 18:54:42 +00:00
140 lines
4.7 KiB
Python
140 lines
4.7 KiB
Python
import datetime
|
|
from django.contrib.auth.models import User
|
|
from django.contrib.contenttypes.models import ContentType
|
|
from django.contrib.contenttypes import generic
|
|
from django.db import models
|
|
from django.utils.timezone import utc
|
|
from .utils import id2slug
|
|
from notifications.managers import NotificationManager
|
|
from notifications.signals import notify
|
|
|
|
try:
|
|
from django.utils import timezone
|
|
now = timezone.now
|
|
except ImportError:
|
|
now = datetime.datetime.now
|
|
|
|
class Notification(models.Model):
|
|
"""
|
|
Action model describing the actor acting out a verb (on an optional
|
|
target).
|
|
Nomenclature based on http://activitystrea.ms/specs/atom/1.0/
|
|
|
|
Generalized Format::
|
|
|
|
<actor> <verb> <time>
|
|
<actor> <verb> <target> <time>
|
|
<actor> <verb> <action_object> <target> <time>
|
|
|
|
Examples::
|
|
|
|
<justquick> <reached level 60> <1 minute ago>
|
|
<brosner> <commented on> <pinax/pinax> <2 hours ago>
|
|
<washingtontimes> <started follow> <justquick> <8 minutes ago>
|
|
<mitsuhiko> <closed> <issue 70> on <mitsuhiko/flask> <about 2 hours ago>
|
|
|
|
Unicode Representation::
|
|
|
|
justquick reached level 60 1 minute ago
|
|
mitsuhiko closed issue 70 on mitsuhiko/flask 3 hours ago
|
|
|
|
HTML Representation::
|
|
|
|
<a href="http://oebfare.com/">brosner</a> commented on <a href="http://github.com/pinax/pinax">pinax/pinax</a> 2 hours ago
|
|
|
|
"""
|
|
recipient = models.ForeignKey(User, blank=False, related_name='notifications')
|
|
readed = models.BooleanField(default=False, blank=False)
|
|
|
|
actor_content_type = models.ForeignKey(ContentType, related_name='notify_actor')
|
|
actor_object_id = models.CharField(max_length=255)
|
|
actor = generic.GenericForeignKey('actor_content_type', 'actor_object_id')
|
|
|
|
verb = models.CharField(max_length=255)
|
|
description = models.TextField(blank=True, null=True)
|
|
|
|
target_content_type = models.ForeignKey(ContentType, related_name='notify_target',
|
|
blank=True, null=True)
|
|
target_object_id = models.CharField(max_length=255, blank=True, null=True)
|
|
target = generic.GenericForeignKey('target_content_type',
|
|
'target_object_id')
|
|
|
|
action_object_content_type = models.ForeignKey(ContentType,
|
|
related_name='notify_action_object', blank=True, null=True)
|
|
action_object_object_id = models.CharField(max_length=255, blank=True,
|
|
null=True)
|
|
action_object = generic.GenericForeignKey('action_object_content_type',
|
|
'action_object_object_id')
|
|
|
|
timestamp = models.DateTimeField(default=now)
|
|
|
|
public = models.BooleanField(default=True)
|
|
|
|
objects = NotificationManager()
|
|
|
|
class Meta:
|
|
ordering = ('-timestamp', )
|
|
|
|
def __unicode__(self):
|
|
ctx = {
|
|
'actor': self.actor,
|
|
'verb': self.verb,
|
|
'action_object': self.action_object,
|
|
'target': self.target,
|
|
'timesince': self.timesince()
|
|
}
|
|
if self.target:
|
|
if self.action_object:
|
|
return '%(actor)s %(verb)s %(action_object)s on %(target)s %(timesince)s ago' % ctx
|
|
return '%(actor)s %(verb)s %(target)s %(timesince)s ago' % ctx
|
|
if self.action_object:
|
|
return '%(actor)s %(verb)s %(action_object)s %(timesince)s ago' % ctx
|
|
return '%(actor)s %(verb)s %(timesince)s ago' % ctx
|
|
|
|
def timesince(self, now=None):
|
|
"""
|
|
Shortcut for the ``django.utils.timesince.timesince`` function of the
|
|
current timestamp.
|
|
"""
|
|
from django.utils.timesince import timesince as timesince_
|
|
return timesince_(self.timestamp, now)
|
|
|
|
@property
|
|
def slug(self):
|
|
return id2slug(self.id)
|
|
|
|
def mark_as_read(self):
|
|
if not self.readed:
|
|
self.readed = True
|
|
self.save()
|
|
|
|
def notify_handler(verb, **kwargs):
|
|
"""
|
|
Handler function to create Notification instance upon action signal call.
|
|
"""
|
|
|
|
kwargs.pop('signal', None)
|
|
recipient = kwargs.pop('recipient')
|
|
actor = kwargs.pop('sender')
|
|
newnotify = Notification(
|
|
recipient = recipient,
|
|
actor_content_type=ContentType.objects.get_for_model(actor),
|
|
actor_object_id=actor.pk,
|
|
verb=unicode(verb),
|
|
public=bool(kwargs.pop('public', True)),
|
|
description=kwargs.pop('description', None),
|
|
timestamp=kwargs.pop('timestamp', datetime.datetime.utcnow().replace(tzinfo=utc))
|
|
)
|
|
|
|
for opt in ('target', 'action_object'):
|
|
obj = kwargs.pop(opt, None)
|
|
if not obj is None:
|
|
setattr(newnotify, '%s_object_id' % opt, obj.pk)
|
|
setattr(newnotify, '%s_content_type' % opt,
|
|
ContentType.objects.get_for_model(obj))
|
|
|
|
newnotify.save()
|
|
|
|
|
|
# connect the signal
|
|
notify.connect(notify_handler, dispatch_uid='notifications.models.notification')
|