bornhack-website/src/events/models.py

62 lines
1.9 KiB
Python
Raw Normal View History

Merge teamcomms branch. Refactor team app and add events app. * Primary commit towards improved team communications. Add new events app to handle team notifications when various events happen, with a Type model which contain event types and a Routing model which controls routing of events to teams. Add shortslug for Camp and Team models. events.handler.py contains the code for sending irc and email notifications for teams. The first two eventtypes have been added in datamigrations, 'ticket_created' and 'public_credit_name_changed', and the tickets and profile apps have been adjusted accordingly. Team IRC channels can be marked as managed and if so the IRC bot will register the team channel with ChanServ if possible. Team IRC channels can be marked as private and the bot will set invite only and maintain an ACL with team members. Users can set their NickServ username in their profile to get on the ACL. Rework all team views and templates. Remove TeamArea model and make Team have an FK to Camp directly. Add docstrings a whole bunch of places. Move signal handlers to apps.py and signal_handlers.py in a few apps. Add basic team mailing list handling, more work to be done. Update bootstrap-devsite script to add more teammembers and add some team event routing for the two eventtypes we have. * default to the console backend for email unless we specifically ask for realworld email * fix signal for public_credit_name approval irc message * fix name display on /people/ page * fix the text on people pages when all non-responsible team members are anonymous * handle cases where we fallback to the area responsible properly * readd removed property, it is used in team_detail view * make it possible to filter profiles by public_credit_name_approved * add method for sending IRC messages in ircbot.utils.add_irc_message(), extend periodic bot method to do more than check for outgoing messages so rename it, refactor chanserv and nickserv handling code, create methods to check and join/part IRC channels as needed, maintain channel ACLs for private channels, do not autojoin any channels when instatiating the bot instead rely on the new check_irc_channels() method to join them, rename profile presave signal, add checking for changed nickserv usernames for acl handling, add teammember.irc_channel_acl_ok boolean to track ACL state, add missing help_text properties to TeamMember fields, rename teammember postsave signal, add teammember deleted signal, readd wrongly deleted EnsureTeamMemberResponsibleMixin * add a few missing early returns
2018-04-09 21:11:05 +00:00
from django.db import models
from utils.models import CreatedUpdatedModel
from teams.models import Team
class Type(CreatedUpdatedModel):
"""
The events.Type model contains different types of system events which can happen.
New event types should be added in data migrations.
The following types are currently used in the codebase:
- ticket_created: Whenever a new ShopTicket is created
- public_credit_name_changed: Whenever a user changes public_credit_name in the profile
"""
name = models.TextField(
unique=True,
help_text='The type of event'
)
irc_notification = models.BooleanField(
default=False,
help_text='Check to send IRC notifications for this type of event.',
)
email_notification = models.BooleanField(
default=False,
help_text='Check to send email notifications for this type of event.',
)
def __str__(self):
return self.name
@property
def teams(self):
"""
This property returns a queryset with all the teams that should receive this type of events
"""
team_ids = Routing.objects.filter(eventtype=self).values_list('team', flat=True)
return Team.objects.filter(pk__in=team_ids)
class Routing(CreatedUpdatedModel):
"""
The events.Routing model contains routings for system events.
Add a new entry to route events of a certain type to a team.
Several teams can receive the same type of event.
"""
eventtype = models.ForeignKey(
'events.Type',
related_name='eventroutes',
on_delete=models.PROTECT,
help_text='The type of event to route',
)
team = models.ForeignKey(
'teams.Team',
related_name='eventroutes',
on_delete=models.PROTECT,
help_text='The team which should receive events of this type.'
)
def __str__(self):
return "%s -> %s" % (self.eventtype, self.team)