Oleg Komarov
bd3a17a19b
Implementation for #72 based on https://github.com/justquick/django-activity-stream/ Summary: - create an Action object, specifying a corresponding Extension object as a `target` and other relevant objects (Rating, ApprovalActivity, AbuseReport) as `action_object` (search code for `action.send` to see where it happens) - there is one exception when we don't have an `action_object` - when we submit a new extension for a review, but this could be restructured as creating a first ApprovalActivity item, TODO revisit this - use `follow` provided by actstream to specify relations between users and extensions, use different flags (author, moderator, reviewer) to explicitly manage those relations; proactively call the `follow` to make sure that users are subscribed before an Action interesting to them is created; - one downside here is that each moderator needs to follow each extensions individually, but this potentially allows to explicitly unsubscribe from activity on extensions that are not interesting to a given user - introduce `VERB2FLAGS` mapping to define when a given Action needs to generate a Notification for a follower of a particular type (=flag) based on the Action's verb - process Notification records by a new `send_notifications` management command that sends emails - add a profile setting to disable notification emails First iteration includes only internal (`@blender.org`) emails. If you have a DB with some preexisting data, you need to run `./manage.py ensure_followers` command to retroactively create expected follow relations. Next steps (out of scope for this PR): - refine notification texts: current `Verb` usage may be not grammatical and is not covered by i18n - UI: templates for showing notifications in user profile, marking notifications as read, unread counter in the header (there is some views code in this PR, but it it not surfaced to the users yet) - remove the internal email check Co-authored-by: Anna Sirota <railla@noreply.localhost> Reviewed-on: #80 Reviewed-by: Anna Sirota <railla@noreply.localhost>
57 lines
2.2 KiB
Python
57 lines
2.2 KiB
Python
from actstream.models import Action
|
|
from django.contrib.auth import get_user_model
|
|
from django.db import models
|
|
|
|
from constants.activity import Verb
|
|
from common.templatetags.common import absolutify
|
|
|
|
User = get_user_model()
|
|
|
|
|
|
class Notification(models.Model):
|
|
"""Notification records are created in Action's post_save signal.
|
|
When a user marks a notification as read, read_at is set.
|
|
send_notification_emails management command runs periodically in background and sends all
|
|
notifications that haven't been processed yet, read_at is not checked when sending emails.
|
|
email_sent flag is used only to record the fact that we attempted to send an email.
|
|
A user can unsubscribe from notification emails in their profile settings.
|
|
"""
|
|
|
|
recipient = models.ForeignKey(User, null=False, on_delete=models.CASCADE)
|
|
action = models.ForeignKey(Action, null=False, on_delete=models.CASCADE)
|
|
email_sent = models.BooleanField(default=False, null=False)
|
|
processed_by_mailer_at = models.DateTimeField(default=None, null=True)
|
|
read_at = models.DateTimeField(default=None, null=True)
|
|
|
|
class Meta:
|
|
indexes = [
|
|
models.Index(fields=['processed_by_mailer_at']),
|
|
models.Index(fields=['recipient', 'read_at']),
|
|
]
|
|
unique_together = ['recipient', 'action']
|
|
|
|
def format_email(self):
|
|
action = self.action
|
|
subject = f'New Activity: {action.actor.full_name} {action.verb} {action.target}'
|
|
url = self.get_absolute_url()
|
|
mesage = f'{action.actor.full_name} {action.verb} {action.target}: {url}'
|
|
return (subject, mesage)
|
|
|
|
def get_absolute_url(self):
|
|
if self.action.verb == Verb.RATED_EXTENSION:
|
|
url = self.action.target.get_ratings_url()
|
|
elif self.action.verb in [
|
|
Verb.APPROVED,
|
|
Verb.COMMENTED,
|
|
Verb.REQUESTED_CHANGES,
|
|
Verb.REQUESTED_REVIEW,
|
|
]:
|
|
url = self.action.target.get_review_url()
|
|
elif self.action.action_object is not None:
|
|
url = self.action.action_object.get_absolute_url()
|
|
else:
|
|
url = self.action.target.get_absolute_url()
|
|
|
|
# TODO? url cloacking to mark visited notifications as read automatically
|
|
return absolutify(url)
|