summaryrefslogtreecommitdiffstats
path: root/group_messaging/models.py
diff options
context:
space:
mode:
Diffstat (limited to 'group_messaging/models.py')
-rw-r--r--group_messaging/models.py91
1 files changed, 72 insertions, 19 deletions
diff --git a/group_messaging/models.py b/group_messaging/models.py
index 838134e7..978693ae 100644
--- a/group_messaging/models.py
+++ b/group_messaging/models.py
@@ -1,14 +1,26 @@
+"""models for the ``group_messaging`` app
+"""
+import datetime
from django.db import models
from django.contrib.auth.models import Group
from django.contrib.auth.models import User
MAX_TITLE_LENGTH = 80
+MAX_SENDERS_INFO_LENGTH = 64
#dummy parse message function
parse_message = lambda v: v
+GROUP_NAME_TPL = '_personal_%s'
+
def get_personal_group_by_user_id(user_id):
- return Group.objects.get(name='_personal_%s' % user_id)
+ return Group.objects.get(name=GROUP_NAME_TPL % user_id)
+
+
+def get_personal_groups_for_users(users):
+ """for a given list of users return their personal groups"""
+ group_names = [(GROUP_NAME_TPL % user.id) for user in users]
+ return Group.objects.filter(name__in=group_names)
def get_personal_group(user):
@@ -18,11 +30,23 @@ def get_personal_group(user):
def create_personal_group(user):
"""creates a personal group for the user"""
- group = Group(name='_personal_%s' % user.id)
+ group = Group(name=GROUP_NAME_TPL % user.id)
group.save()
return group
+class LastVisitTime(models.Model):
+ """just remembers when each user last
+ visited his/her messages inbox
+ updated any time when inbox is visited by the user.
+
+ there is only one value per user - it is necessary
+ for the quick determination of which threads are "new"
+ """
+ user = models.OneToOneField(User)
+ at = models.DateTimeField(auto_now_add=True)
+
+
class SenderListManager(models.Manager):
"""model manager for the :class:`SenderList`"""
@@ -61,7 +85,6 @@ class MessageMemo(models.Model):
STATUS_CHOICES = (
(SEEN, 'seen'),
(ARCHIVED, 'archived')
-
)
user = models.ForeignKey(User)
message = models.ForeignKey('Message')
@@ -99,13 +122,24 @@ class MessageManager(models.Manager):
headline = kwargs.get('headline', kwargs['text'])
kwargs['headline'] = headline[:MAX_TITLE_LENGTH]
kwargs['html'] = parse_message(kwargs['text'])
- return super(MessageManager, self).create(**kwargs)
+
+ message = super(MessageManager, self).create(**kwargs)
+ #creator of message saw it by definition
+ #crate a "seen" memo for the sender, because we
+ #don't want to inform the user about his/her own post
+ sender = kwargs['sender']
+ MessageMemo.objects.create(
+ message=message, user=sender, status=MessageMemo.SEEN
+ )
+ return message
+
def create_thread(self, sender=None, recipients=None, text=None):
"""creates a stored message and adds recipients"""
message = self.create(
message_type=Message.STORED,
sender=sender,
+ senders_info=sender.username,
text=text,
)
message.add_recipients(recipients)
@@ -123,10 +157,13 @@ class MessageManager(models.Manager):
recipients = set(parent.recipients.all())
senders_group = get_personal_group(parent.sender)
recipients.add(senders_group)
- message.add_recipients(recipients, ignore_user=sender)
+ message.add_recipients(recipients)
#add author of the parent as a recipient to parent
- #but make sure to mute the message
- parent.add_recipients([senders_group], ignore_user=parent.sender)
+ parent.add_recipients([senders_group])
+ #mark last active timestamp for the root message
+ #so that we know that this thread was most recently
+ #updated
+ message.update_root_info()
return message
@@ -150,47 +187,63 @@ class Message(models.Model):
)
sender = models.ForeignKey(User, related_name='sent_messages')
+
+ senders_info = models.CharField(
+ max_length=MAX_SENDERS_INFO_LENGTH,
+ default=''
+ )#comma-separated list of a few names
+
recipients = models.ManyToManyField(Group)
+
root = models.ForeignKey(
'self', null=True,
blank=True, related_name='descendants'
)
+
parent = models.ForeignKey(
'self', null=True,
blank=True, related_name='children'
)
+
headline = models.CharField(max_length=MAX_TITLE_LENGTH)
+
text = models.TextField(
null=True, blank=True,
help_text='source text for the message, e.g. in markdown format'
)
+
html = models.TextField(
null=True, blank=True,
help_text='rendered html of the message'
)
+
sent_at = models.DateTimeField(auto_now_add=True)
last_active_at = models.DateTimeField(auto_now_add=True)
active_until = models.DateTimeField(blank=True, null=True)
objects = MessageManager()
- def add_recipients(self, recipients, ignore_user=None):
+ def add_recipients(self, recipients):
"""adds recipients to the message
and updates the sender lists for all recipients
todo: sender lists may be updated in a lazy way - per user
-
- `ignore_user` parameter is used to mark a specific user
- as not needing to receive a message as new, even if that
- user is a member of any of the recipient groups
"""
- if ignore_user:
- #crate a "seen" memo for the sender, because we
- #don't want to inform the user about his/her own post
- MessageMemo.objects.create(
- message=self, user=self.sender, status=MessageMemo.SEEN
- )
-
self.recipients.add(*recipients)
for recipient in recipients:
sender_list, created = SenderList.objects.get_or_create(recipient=recipient)
sender_list.senders.add(self.sender)
+
+ def update_root_info(self):
+ """Update the last active at timestamp and
+ the contributors info, if relevant.
+ Root object will be saved to the database.
+ """
+ self.root.last_active_at = datetime.datetime.now()
+ senders_names = self.root.senders_info.split(',')
+
+ if self.sender.username in senders_names:
+ senders_names.remove(self.sender.username)
+ senders_names.insert(0, self.sender.username)
+
+ self.root.senders_info = (','.join(senders_names))[:64]
+ self.root.save()