klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2025-07-09 19:40:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

All: Apply Black coding rules

Browse Source
This commit is contained in:
Antoine Bartuccio
2018-10-04 21:29:19 +02:00
parent 0581c667de
commit cb58b00b6e
204 changed files with 13173 additions and 6376 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
forum/__init__.py
View File

@ -21,4 +21,3 @@
# Place - Suite 330, Boston, MA 02111-1307, USA.
#
#

1
forum/admin.py
View File

@ -45,4 +45,3 @@ admin.site.register(Forum, ForumAdmin)
admin.site.register(ForumTopic, ForumTopicAdmin)
admin.site.register(ForumMessage, ForumMessageAdmin)
admin.site.register(ForumUserInfo)

224
forum/migrations/0001_initial.py
View File

@ -12,71 +12,211 @@ class Migration(migrations.Migration):
dependencies = [
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
('club', '0006_auto_20161229_0040'),
('core', '0019_preferences_receive_weekmail'),
("club", "0006_auto_20161229_0040"),
("core", "0019_preferences_receive_weekmail"),
]
operations = [
migrations.CreateModel(
name='Forum',
name="Forum",
fields=[
('id', models.AutoField(primary_key=True, serialize=False, verbose_name='ID', auto_created=True)),
('name', models.CharField(max_length=64, verbose_name='name')),
('description', models.CharField(max_length=256, verbose_name='description', default='')),
('is_category', models.BooleanField(verbose_name='is a category', default=False)),
('edit_groups', models.ManyToManyField(related_name='editable_forums', to='core.Group', blank=True, default=[4])),
('owner_club', models.ForeignKey(to='club.Club', verbose_name='owner club', related_name='owned_forums', default=1)),
('parent', models.ForeignKey(to='forum.Forum', null=True, related_name='children', blank=True)),
('view_groups', models.ManyToManyField(related_name='viewable_forums', to='core.Group', blank=True, default=[2])),
(
"id",
models.AutoField(
primary_key=True,
serialize=False,
verbose_name="ID",
auto_created=True,
),
),
("name", models.CharField(max_length=64, verbose_name="name")),
(
"description",
models.CharField(
max_length=256, verbose_name="description", default=""
),
),
(
"is_category",
models.BooleanField(verbose_name="is a category", default=False),
),
(
"edit_groups",
models.ManyToManyField(
related_name="editable_forums",
to="core.Group",
blank=True,
default=[4],
),
),
(
"owner_club",
models.ForeignKey(
to="club.Club",
verbose_name="owner club",
related_name="owned_forums",
default=1,
),
),
(
"parent",
models.ForeignKey(
to="forum.Forum", null=True, related_name="children", blank=True
),
),
(
"view_groups",
models.ManyToManyField(
related_name="viewable_forums",
to="core.Group",
blank=True,
default=[2],
),
),
],
),
migrations.CreateModel(
name='ForumMessage',
name="ForumMessage",
fields=[
('id', models.AutoField(primary_key=True, serialize=False, verbose_name='ID', auto_created=True)),
('title', models.CharField(max_length=64, blank=True, verbose_name='title', default='')),
('message', models.TextField(verbose_name='message', default='')),
('date', models.DateTimeField(verbose_name='date', default=django.utils.timezone.now)),
('author', models.ForeignKey(related_name='forum_messages', to=settings.AUTH_USER_MODEL)),
('readers', models.ManyToManyField(to=settings.AUTH_USER_MODEL, verbose_name='readers', related_name='read_messages')),
(
"id",
models.AutoField(
primary_key=True,
serialize=False,
verbose_name="ID",
auto_created=True,
),
),
(
"title",
models.CharField(
max_length=64, blank=True, verbose_name="title", default=""
),
),
("message", models.TextField(verbose_name="message", default="")),
(
"date",
models.DateTimeField(
verbose_name="date", default=django.utils.timezone.now
),
),
(
"author",
models.ForeignKey(
related_name="forum_messages", to=settings.AUTH_USER_MODEL
),
),
(
"readers",
models.ManyToManyField(
to=settings.AUTH_USER_MODEL,
verbose_name="readers",
related_name="read_messages",
),
),
],
options={
'ordering': ['id'],
},
options={"ordering": ["id"]},
),
migrations.CreateModel(
name='ForumMessageMeta',
name="ForumMessageMeta",
fields=[
('id', models.AutoField(primary_key=True, serialize=False, verbose_name='ID', auto_created=True)),
('date', models.DateTimeField(verbose_name='date', default=django.utils.timezone.now)),
('action', models.CharField(max_length=16, choices=[('EDIT', 'Message edited by'), ('DELETE', 'Message deleted by'), ('UNDELETE', 'Message undeleted by')], verbose_name='action')),
('message', models.ForeignKey(related_name='metas', to='forum.ForumMessage')),
('user', models.ForeignKey(related_name='forum_message_metas', to=settings.AUTH_USER_MODEL)),
(
"id",
models.AutoField(
primary_key=True,
serialize=False,
verbose_name="ID",
auto_created=True,
),
),
(
"date",
models.DateTimeField(
verbose_name="date", default=django.utils.timezone.now
),
),
(
"action",
models.CharField(
max_length=16,
choices=[
("EDIT", "Message edited by"),
("DELETE", "Message deleted by"),
("UNDELETE", "Message undeleted by"),
],
verbose_name="action",
),
),
(
"message",
models.ForeignKey(related_name="metas", to="forum.ForumMessage"),
),
(
"user",
models.ForeignKey(
related_name="forum_message_metas", to=settings.AUTH_USER_MODEL
),
),
],
),
migrations.CreateModel(
name='ForumTopic',
name="ForumTopic",
fields=[
('id', models.AutoField(primary_key=True, serialize=False, verbose_name='ID', auto_created=True)),
('description', models.CharField(max_length=256, verbose_name='description', default='')),
('author', models.ForeignKey(related_name='forum_topics', to=settings.AUTH_USER_MODEL)),
('forum', models.ForeignKey(related_name='topics', to='forum.Forum')),
(
"id",
models.AutoField(
primary_key=True,
serialize=False,
verbose_name="ID",
auto_created=True,
),
),
(
"description",
models.CharField(
max_length=256, verbose_name="description", default=""
),
),
(
"author",
models.ForeignKey(
related_name="forum_topics", to=settings.AUTH_USER_MODEL
),
),
("forum", models.ForeignKey(related_name="topics", to="forum.Forum")),
],
options={
'ordering': ['-id'],
},
options={"ordering": ["-id"]},
),
migrations.CreateModel(
name='ForumUserInfo',
name="ForumUserInfo",
fields=[
('id', models.AutoField(primary_key=True, serialize=False, verbose_name='ID', auto_created=True)),
('last_read_date', models.DateTimeField(verbose_name='last read date', default=datetime.datetime(1999, 1, 1, 0, 0, tzinfo=utc))),
('user', models.OneToOneField(to=settings.AUTH_USER_MODEL, related_name='_forum_infos')),
(
"id",
models.AutoField(
primary_key=True,
serialize=False,
verbose_name="ID",
auto_created=True,
),
),
(
"last_read_date",
models.DateTimeField(
verbose_name="last read date",
default=datetime.datetime(1999, 1, 1, 0, 0, tzinfo=utc),
),
),
(
"user",
models.OneToOneField(
to=settings.AUTH_USER_MODEL, related_name="_forum_infos"
),
),
],
),
migrations.AddField(
model_name='forummessage',
name='topic',
field=models.ForeignKey(related_name='messages', to='forum.ForumTopic'),
model_name="forummessage",
name="topic",
field=models.ForeignKey(related_name="messages", to="forum.ForumTopic"),
),
]

28
forum/migrations/0002_auto_20170312_1753.py
View File

@ -6,23 +6,25 @@ from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('forum', '0001_initial'),
]
dependencies = [("forum", "0001_initial")]
operations = [
migrations.AlterModelOptions(
name='forum',
options={'ordering': ['number']},
),
migrations.AlterModelOptions(name="forum", options={"ordering": ["number"]}),
migrations.AddField(
model_name='forum',
name='number',
field=models.IntegerField(verbose_name='number to choose a specific forum ordering', default=1),
model_name="forum",
name="number",
field=models.IntegerField(
verbose_name="number to choose a specific forum ordering", default=1
),
),
migrations.AlterField(
model_name='forum',
name='edit_groups',
field=models.ManyToManyField(related_name='editable_forums', blank=True, to='core.Group', default=[331]),
model_name="forum",
name="edit_groups",
field=models.ManyToManyField(
related_name="editable_forums",
blank=True,
to="core.Group",
default=[331],
),
),
]

14
forum/migrations/0003_auto_20170510_1754.py
View File

@ -6,14 +6,14 @@ from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('forum', '0002_auto_20170312_1753'),
]
dependencies = [("forum", "0002_auto_20170312_1753")]
operations = [
migrations.AlterField(
model_name='forum',
name='edit_groups',
field=models.ManyToManyField(blank=True, default=[4], related_name='editable_forums', to='core.Group'),
),
model_name="forum",
name="edit_groups",
field=models.ManyToManyField(
blank=True, default=[4], related_name="editable_forums", to="core.Group"
),
)
]

70
forum/migrations/0004_auto_20170531_1949.py
View File

@ -7,57 +7,67 @@ import django.db.models.deletion
class Migration(migrations.Migration):
dependencies = [
('forum', '0003_auto_20170510_1754'),
]
dependencies = [("forum", "0003_auto_20170510_1754")]
operations = [
migrations.AlterModelOptions(
name='forummessage',
options={'ordering': ['-date']},
name="forummessage", options={"ordering": ["-date"]}
),
migrations.AlterModelOptions(
name='forumtopic',
options={'ordering': ['-_last_message__date']},
name="forumtopic", options={"ordering": ["-_last_message__date"]}
),
migrations.AddField(
model_name='forum',
name='_last_message',
field=models.ForeignKey(verbose_name='the last message', to='forum.ForumMessage', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='forums_where_its_last'),
model_name="forum",
name="_last_message",
field=models.ForeignKey(
verbose_name="the last message",
to="forum.ForumMessage",
null=True,
on_delete=django.db.models.deletion.SET_NULL,
related_name="forums_where_its_last",
),
),
migrations.AddField(
model_name='forum',
name='_topic_number',
field=models.IntegerField(default=0, verbose_name='number of topics'),
model_name="forum",
name="_topic_number",
field=models.IntegerField(default=0, verbose_name="number of topics"),
),
migrations.AddField(
model_name='forummessage',
name='_deleted',
field=models.BooleanField(default=False, verbose_name='is deleted'),
model_name="forummessage",
name="_deleted",
field=models.BooleanField(default=False, verbose_name="is deleted"),
),
migrations.AddField(
model_name='forumtopic',
name='_last_message',
field=models.ForeignKey(verbose_name='the last message', to='forum.ForumMessage', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+'),
model_name="forumtopic",
name="_last_message",
field=models.ForeignKey(
verbose_name="the last message",
to="forum.ForumMessage",
null=True,
on_delete=django.db.models.deletion.SET_NULL,
related_name="+",
),
),
migrations.AddField(
model_name='forumtopic',
name='_message_number',
field=models.IntegerField(default=0, verbose_name='number of messages'),
model_name="forumtopic",
name="_message_number",
field=models.IntegerField(default=0, verbose_name="number of messages"),
),
migrations.AddField(
model_name='forumtopic',
name='_title',
field=models.CharField(max_length=64, blank=True, verbose_name='title'),
model_name="forumtopic",
name="_title",
field=models.CharField(max_length=64, blank=True, verbose_name="title"),
),
migrations.AlterField(
model_name='forum',
name='description',
field=models.CharField(max_length=512, default='', verbose_name='description'),
model_name="forum",
name="description",
field=models.CharField(
max_length=512, default="", verbose_name="description"
),
),
migrations.AlterField(
model_name='forum',
name='id',
model_name="forum",
name="id",
field=models.AutoField(primary_key=True, serialize=False, db_index=True),
),
]

14
forum/migrations/0005_forumtopic_subscribed_users.py
View File

@ -9,13 +9,17 @@ class Migration(migrations.Migration):
dependencies = [
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
('forum', '0004_auto_20170531_1949'),
("forum", "0004_auto_20170531_1949"),
]
operations = [
migrations.AddField(
model_name='forumtopic',
name='subscribed_users',
field=models.ManyToManyField(verbose_name='subscribed users', related_name='favorite_topics', to=settings.AUTH_USER_MODEL),
),
model_name="forumtopic",
name="subscribed_users",
field=models.ManyToManyField(
verbose_name="subscribed users",
related_name="favorite_topics",
to=settings.AUTH_USER_MODEL,
),
)
]

26
forum/migrations/0006_auto_20180426_2013.py
View File

@ -7,19 +7,27 @@ import forum.models
class Migration(migrations.Migration):
dependencies = [
('forum', '0005_forumtopic_subscribed_users'),
]
dependencies = [("forum", "0005_forumtopic_subscribed_users")]
operations = [
migrations.AlterField(
model_name='forum',
name='edit_groups',
field=models.ManyToManyField(blank=True, default=forum.models.Forum.get_default_edit_group, related_name='editable_forums', to='core.Group'),
model_name="forum",
name="edit_groups",
field=models.ManyToManyField(
blank=True,
default=forum.models.Forum.get_default_edit_group,
related_name="editable_forums",
to="core.Group",
),
),
migrations.AlterField(
model_name='forum',
name='view_groups',
field=models.ManyToManyField(blank=True, default=forum.models.Forum.get_default_view_group, related_name='viewable_forums', to='core.Group'),
model_name="forum",
name="view_groups",
field=models.ManyToManyField(
blank=True,
default=forum.models.Forum.get_default_view_group,
related_name="viewable_forums",
to="core.Group",
),
),
]

183
forum/models.py
View File

@ -38,7 +38,6 @@ from core.models import User, Group
from club.models import Club
class Forum(models.Model):
"""
The Forum class, made as a tree to allow nice tidy organization
@ -47,27 +46,51 @@ class Forum(models.Model):
edit_groups allows to put any group as a forum admin
view_groups allows some groups to view a forum
"""
# Those functions prevent generating migration upon settings changes
def get_default_edit_group(): return [settings.SITH_GROUP_OLD_SUBSCRIBERS_ID]
def get_default_view_group(): return [settings.SITH_GROUP_PUBLIC_ID]
def get_default_edit_group():
return [settings.SITH_GROUP_OLD_SUBSCRIBERS_ID]
def get_default_view_group():
return [settings.SITH_GROUP_PUBLIC_ID]
id = models.AutoField(primary_key=True, db_index=True)
name = models.CharField(_('name'), max_length=64)
description = models.CharField(_('description'), max_length=512, default="")
is_category = models.BooleanField(_('is a category'), default=False)
parent = models.ForeignKey('Forum', related_name='children', null=True, blank=True)
owner_club = models.ForeignKey(Club, related_name="owned_forums", verbose_name=_("owner club"),
default=settings.SITH_MAIN_CLUB_ID)
edit_groups = models.ManyToManyField(Group, related_name="editable_forums", blank=True,
default=get_default_edit_group)
view_groups = models.ManyToManyField(Group, related_name="viewable_forums", blank=True,
default=get_default_view_group)
number = models.IntegerField(_("number to choose a specific forum ordering"), default=1)
_last_message = models.ForeignKey('ForumMessage', related_name="forums_where_its_last",
verbose_name=_("the last message"), null=True, on_delete=models.SET_NULL)
name = models.CharField(_("name"), max_length=64)
description = models.CharField(_("description"), max_length=512, default="")
is_category = models.BooleanField(_("is a category"), default=False)
parent = models.ForeignKey("Forum", related_name="children", null=True, blank=True)
owner_club = models.ForeignKey(
Club,
related_name="owned_forums",
verbose_name=_("owner club"),
default=settings.SITH_MAIN_CLUB_ID,
)
edit_groups = models.ManyToManyField(
Group,
related_name="editable_forums",
blank=True,
default=get_default_edit_group,
)
view_groups = models.ManyToManyField(
Group,
related_name="viewable_forums",
blank=True,
default=get_default_view_group,
)
number = models.IntegerField(
_("number to choose a specific forum ordering"), default=1
)
_last_message = models.ForeignKey(
"ForumMessage",
related_name="forums_where_its_last",
verbose_name=_("the last message"),
null=True,
on_delete=models.SET_NULL,
)
_topic_number = models.IntegerField(_("number of topics"), default=0)
class Meta:
ordering = ['number']
ordering = ["number"]
def clean(self):
self.check_loop()
@ -87,8 +110,18 @@ class Forum(models.Model):
self.parent.set_topic_number()
def set_last_message(self):
topic = ForumTopic.objects.filter(forum__id=self.id).exclude(_last_message=None).order_by('-_last_message__id').first()
forum = Forum.objects.filter(parent__id=self.id).exclude(_last_message=None).order_by('-_last_message__id').first()
topic = (
ForumTopic.objects.filter(forum__id=self.id)
.exclude(_last_message=None)
.order_by("-_last_message__id")
.first()
)
forum = (
Forum.objects.filter(parent__id=self.id)
.exclude(_last_message=None)
.order_by("-_last_message__id")
.first()
)
if topic and forum:
if topic._last_message_id < forum._last_message_id:
self._last_message_id = forum._last_message_id
@ -117,8 +150,8 @@ class Forum(models.Model):
self.save()
_club_memberships = {} # This cache is particularly efficient:
# divided by 3 the number of requests on the main forum page
# after the first load
# divided by 3 the number of requests on the main forum page
# after the first load
def is_owned_by(self, user):
if user.is_in_group(settings.SITH_GROUP_FORUM_ADMIN_ID):
return True
@ -141,7 +174,7 @@ class Forum(models.Model):
cur = self
while cur.parent is not None:
if cur in objs:
raise ValidationError(_('You can not make loops in forums'))
raise ValidationError(_("You can not make loops in forums"))
objs.append(cur)
cur = cur.parent
@ -149,10 +182,14 @@ class Forum(models.Model):
return "%s" % (self.name)
def get_full_name(self):
return '/'.join(chain.from_iterable([[parent.name for parent in self.get_parent_list()], [self.name]]))
return "/".join(
chain.from_iterable(
[[parent.name for parent in self.get_parent_list()], [self.name]]
)
)
def get_absolute_url(self):
return reverse('forum:view_forum', kwargs={'forum_id': self.id})
return reverse("forum:view_forum", kwargs={"forum_id": self.id})
@cached_property
def parent_list(self):
@ -189,17 +226,24 @@ class Forum(models.Model):
class ForumTopic(models.Model):
forum = models.ForeignKey(Forum, related_name='topics')
author = models.ForeignKey(User, related_name='forum_topics')
description = models.CharField(_('description'), max_length=256, default="")
subscribed_users = models.ManyToManyField(User, related_name='favorite_topics', verbose_name=_("subscribed users"))
_last_message = models.ForeignKey('ForumMessage', related_name="+", verbose_name=_("the last message"),
null=True, on_delete=models.SET_NULL)
_title = models.CharField(_('title'), max_length=64, blank=True)
forum = models.ForeignKey(Forum, related_name="topics")
author = models.ForeignKey(User, related_name="forum_topics")
description = models.CharField(_("description"), max_length=256, default="")
subscribed_users = models.ManyToManyField(
User, related_name="favorite_topics", verbose_name=_("subscribed users")
)
_last_message = models.ForeignKey(
"ForumMessage",
related_name="+",
verbose_name=_("the last message"),
null=True,
on_delete=models.SET_NULL,
)
_title = models.CharField(_("title"), max_length=64, blank=True)
_message_number = models.IntegerField(_("number of messages"), default=0)
class Meta:
ordering = ['-_last_message__date']
ordering = ["-_last_message__date"]
def save(self, *args, **kwargs):
super(ForumTopic, self).save(*args, **kwargs)
@ -219,11 +263,16 @@ class ForumTopic(models.Model):
return "%s" % (self.title)
def get_absolute_url(self):
return reverse('forum:view_topic', kwargs={'topic_id': self.id})
return reverse("forum:view_topic", kwargs={"topic_id": self.id})
def get_first_unread_message(self, user):
try:
msg = self.messages.exclude(readers=user).filter(date__gte=user.forum_infos.last_read_date).order_by('id').first()
msg = (
self.messages.exclude(readers=user)
.filter(date__gte=user.forum_infos.last_read_date)
.order_by("id")
.first()
)
return msg
except:
return None
@ -241,16 +290,19 @@ class ForumMessage(models.Model):
"""
"A ForumMessage object represents a message in the forum" -- Cpt. Obvious
"""
topic = models.ForeignKey(ForumTopic, related_name='messages')
author = models.ForeignKey(User, related_name='forum_messages')
topic = models.ForeignKey(ForumTopic, related_name="messages")
author = models.ForeignKey(User, related_name="forum_messages")
title = models.CharField(_("title"), default="", max_length=64, blank=True)
message = models.TextField(_("message"), default="")
date = models.DateTimeField(_('date'), default=timezone.now)
readers = models.ManyToManyField(User, related_name="read_messages", verbose_name=_("readers"))
_deleted = models.BooleanField(_('is deleted'), default=False)
date = models.DateTimeField(_("date"), default=timezone.now)
readers = models.ManyToManyField(
User, related_name="read_messages", verbose_name=_("readers")
)
_deleted = models.BooleanField(_("is deleted"), default=False)
class Meta:
ordering = ['-date']
ordering = ["-date"]
def __str__(self):
return "%s (%s) - %s" % (self.id, self.author, self.title)
@ -266,32 +318,46 @@ class ForumMessage(models.Model):
self.topic.save()
def is_first_in_topic(self):
return bool(self.id == self.topic.messages.order_by('date').first().id)
return bool(self.id == self.topic.messages.order_by("date").first().id)
def is_last_in_topic(self):
return bool(self.id == self.topic.messages.order_by('date').last().id)
return bool(self.id == self.topic.messages.order_by("date").last().id)
def is_owned_by(self, user): # Anyone can create a topic: it's better to
# check the rights at the forum level, since it's more controlled
# check the rights at the forum level, since it's more controlled
return self.topic.forum.is_owned_by(user) or user.id == self.author.id
def can_be_edited_by(self, user):
return user.can_edit(self.topic.forum)
def can_be_viewed_by(self, user):
return not self._deleted # No need to check the real rights since it's already done by the Topic view
return (
not self._deleted
) # No need to check the real rights since it's already done by the Topic view
def can_be_moderated_by(self, user):
return self.topic.forum.is_owned_by(user) or user.id == self.author.id
def get_absolute_url(self):
return reverse('forum:view_message', kwargs={'message_id': self.id})
return reverse("forum:view_message", kwargs={"message_id": self.id})
def get_url(self):
return self.topic.get_absolute_url() + "?page=" + str(self.get_page()) + "#msg_" + str(self.id)
return (
self.topic.get_absolute_url()
+ "?page="
+ str(self.get_page())
+ "#msg_"
+ str(self.id)
)
def get_page(self):
return int(self.topic.messages.filter(id__lt=self.id).count() / settings.SITH_FORUM_PAGE_LENGTH) + 1
return (
int(
self.topic.messages.filter(id__lt=self.id).count()
/ settings.SITH_FORUM_PAGE_LENGTH
)
+ 1
)
def mark_as_read(self, user):
try: # Need the try/except because of AnonymousUser
@ -301,26 +367,28 @@ class ForumMessage(models.Model):
pass
def is_read(self, user):
return (self.date < user.forum_infos.last_read_date) or (user in self.readers.all())
return (self.date < user.forum_infos.last_read_date) or (
user in self.readers.all()
)
def is_deleted(self):
meta = self.metas.exclude(action="EDIT").order_by('-date').first()
meta = self.metas.exclude(action="EDIT").order_by("-date").first()
if meta:
return meta.action == "DELETE"
return False
MESSAGE_META_ACTIONS = [
('EDIT', _("Message edited by")),
('DELETE', _("Message deleted by")),
('UNDELETE', _("Message undeleted by")),
("EDIT", _("Message edited by")),
("DELETE", _("Message deleted by")),
("UNDELETE", _("Message undeleted by")),
]
class ForumMessageMeta(models.Model):
user = models.ForeignKey(User, related_name="forum_message_metas")
message = models.ForeignKey(ForumMessage, related_name="metas")
date = models.DateTimeField(_('date'), default=timezone.now)
date = models.DateTimeField(_("date"), default=timezone.now)
action = models.CharField(_("action"), choices=MESSAGE_META_ACTIONS, max_length=16)
def save(self, *args, **kwargs):
@ -335,9 +403,14 @@ class ForumUserInfo(models.Model):
However, this can be extended with lot of user preferences dedicated to a
user, such as the favourite topics, the signature, and so on...
"""
user = models.OneToOneField(User, related_name="_forum_infos")
last_read_date = models.DateTimeField(_('last read date'), default=datetime(year=settings.SITH_SCHOOL_START_YEAR,
month=1, day=1, tzinfo=pytz.UTC))
last_read_date = models.DateTimeField(
_("last read date"),
default=datetime(
year=settings.SITH_SCHOOL_START_YEAR, month=1, day=1, tzinfo=pytz.UTC
),
)
def __str__(self):
return str(self.user)

73
forum/urls.py
View File

@ -27,22 +27,59 @@ from django.conf.urls import url
from forum.views import *
urlpatterns = [
url(r'^$', ForumMainView.as_view(), name='main'),
url(r'^new_forum$', ForumCreateView.as_view(), name='new_forum'),
url(r'^mark_all_as_read$', ForumMarkAllAsRead.as_view(), name='mark_all_as_read'),
url(r'^last_unread$', ForumLastUnread.as_view(), name='last_unread'),
url(r'^favorite_topics$', ForumFavoriteTopics.as_view(), name='favorite_topics'),
url(r'^(?P<forum_id>[0-9]+)$', ForumDetailView.as_view(), name='view_forum'),
url(r'^(?P<forum_id>[0-9]+)/edit$', ForumEditView.as_view(), name='edit_forum'),
url(r'^(?P<forum_id>[0-9]+)/delete$', ForumDeleteView.as_view(), name='delete_forum'),
url(r'^(?P<forum_id>[0-9]+)/new_topic$', ForumTopicCreateView.as_view(), name='new_topic'),
url(r'^topic/(?P<topic_id>[0-9]+)$', ForumTopicDetailView.as_view(), name='view_topic'),
url(r'^topic/(?P<topic_id>[0-9]+)/edit$', ForumTopicEditView.as_view(), name='edit_topic'),
url(r'^topic/(?P<topic_id>[0-9]+)/new_message$', ForumMessageCreateView.as_view(), name='new_message'),
url(r'^topic/(?P<topic_id>[0-9]+)/toggle_subscribe$', ForumTopicSubscribeView.as_view(), name='toggle_subscribe_topic'),
url(r'^message/(?P<message_id>[0-9]+)$', ForumMessageView.as_view(), name='view_message'),
url(r'^message/(?P<message_id>[0-9]+)/edit$', ForumMessageEditView.as_view(), name='edit_message'),
url(r'^message/(?P<message_id>[0-9]+)/delete$', ForumMessageDeleteView.as_view(), name='delete_message'),
url(r'^message/(?P<message_id>[0-9]+)/undelete$', ForumMessageUndeleteView.as_view(), name='undelete_message'),
url(r"^$", ForumMainView.as_view(), name="main"),
url(r"^new_forum$", ForumCreateView.as_view(), name="new_forum"),
url(r"^mark_all_as_read$", ForumMarkAllAsRead.as_view(), name="mark_all_as_read"),
url(r"^last_unread$", ForumLastUnread.as_view(), name="last_unread"),
url(r"^favorite_topics$", ForumFavoriteTopics.as_view(), name="favorite_topics"),
url(r"^(?P<forum_id>[0-9]+)$", ForumDetailView.as_view(), name="view_forum"),
url(r"^(?P<forum_id>[0-9]+)/edit$", ForumEditView.as_view(), name="edit_forum"),
url(
r"^(?P<forum_id>[0-9]+)/delete$", ForumDeleteView.as_view(), name="delete_forum"
),
url(
r"^(?P<forum_id>[0-9]+)/new_topic$",
ForumTopicCreateView.as_view(),
name="new_topic",
),
url(
r"^topic/(?P<topic_id>[0-9]+)$",
ForumTopicDetailView.as_view(),
name="view_topic",
),
url(
r"^topic/(?P<topic_id>[0-9]+)/edit$",
ForumTopicEditView.as_view(),
name="edit_topic",
),
url(
r"^topic/(?P<topic_id>[0-9]+)/new_message$",
ForumMessageCreateView.as_view(),
name="new_message",
),
url(
r"^topic/(?P<topic_id>[0-9]+)/toggle_subscribe$",
ForumTopicSubscribeView.as_view(),
name="toggle_subscribe_topic",
),
url(
r"^message/(?P<message_id>[0-9]+)$",
ForumMessageView.as_view(),
name="view_message",
),
url(
r"^message/(?P<message_id>[0-9]+)/edit$",
ForumMessageEditView.as_view(),
name="edit_message",
),
url(
r"^message/(?P<message_id>[0-9]+)/delete$",
ForumMessageDeleteView.as_view(),
name="delete_message",
),
url(
r"^message/(?P<message_id>[0-9]+)/undelete$",
ForumMessageUndeleteView.as_view(),
name="undelete_message",
),
]

149
forum/views.py
View File

@ -42,13 +42,15 @@ from forum.models import Forum, ForumMessage, ForumTopic, ForumMessageMeta
class ForumMainView(ListView):
queryset = Forum.objects.filter(parent=None).prefetch_related("children___last_message__author", "children___last_message__topic")
queryset = Forum.objects.filter(parent=None).prefetch_related(
"children___last_message__author", "children___last_message__topic"
)
template_name = "forum/main.jinja"
class ForumMarkAllAsRead(RedirectView):
permanent = False
url = reverse_lazy('forum:last_unread')
url = reverse_lazy("forum:last_unread")
def get(self, request, *args, **kwargs):
try:
@ -78,11 +80,15 @@ class ForumLastUnread(ListView):
paginate_by = settings.SITH_FORUM_PAGE_LENGTH / 2
def get_queryset(self):
topic_list = self.model.objects.filter(_last_message__date__gt=self.request.user.forum_infos.last_read_date)\
.exclude(_last_message__readers=self.request.user)\
.order_by('-_last_message__date')\
.select_related('_last_message__author', 'author')\
.prefetch_related('forum__edit_groups')
topic_list = (
self.model.objects.filter(
_last_message__date__gt=self.request.user.forum_infos.last_read_date
)
.exclude(_last_message__readers=self.request.user)
.order_by("-_last_message__date")
.select_related("_last_message__author", "author")
.prefetch_related("forum__edit_groups")
)
return topic_list
@ -94,9 +100,18 @@ class ForumNameField(forms.ModelChoiceField):
class ForumForm(forms.ModelForm):
class Meta:
model = Forum
fields = ['name', 'parent', 'number', 'owner_club', 'is_category', 'edit_groups', 'view_groups']
edit_groups = make_ajax_field(Forum, 'edit_groups', 'groups', help_text="")
view_groups = make_ajax_field(Forum, 'view_groups', 'groups', help_text="")
fields = [
"name",
"parent",
"number",
"owner_club",
"is_category",
"edit_groups",
"view_groups",
]
edit_groups = make_ajax_field(Forum, "edit_groups", "groups", help_text="")
view_groups = make_ajax_field(Forum, "view_groups", "groups", help_text="")
parent = ForumNameField(Forum.objects.all())
@ -108,18 +123,20 @@ class ForumCreateView(CanCreateMixin, CreateView):
def get_initial(self):
init = super(ForumCreateView, self).get_initial()
try:
parent = Forum.objects.filter(id=self.request.GET['parent']).first()
init['parent'] = parent
init['owner_club'] = parent.owner_club
init['edit_groups'] = parent.edit_groups.all()
init['view_groups'] = parent.view_groups.all()
parent = Forum.objects.filter(id=self.request.GET["parent"]).first()
init["parent"] = parent
init["owner_club"] = parent.owner_club
init["edit_groups"] = parent.edit_groups.all()
init["view_groups"] = parent.view_groups.all()
except:
pass
return init
class ForumEditForm(ForumForm):
recursive = forms.BooleanField(label=_("Apply rights and club owner recursively"), required=False)
recursive = forms.BooleanField(
label=_("Apply rights and club owner recursively"), required=False
)
class ForumEditView(CanEditPropMixin, UpdateView):
@ -127,11 +144,11 @@ class ForumEditView(CanEditPropMixin, UpdateView):
pk_url_kwarg = "forum_id"
form_class = ForumEditForm
template_name = "core/edit.jinja"
success_url = reverse_lazy('forum:main')
success_url = reverse_lazy("forum:main")
def form_valid(self, form):
ret = super(ForumEditView, self).form_valid(form)
if form.cleaned_data['recursive']:
if form.cleaned_data["recursive"]:
self.object.apply_rights_recursively()
return ret
@ -140,7 +157,7 @@ class ForumDeleteView(CanEditPropMixin, DeleteView):
model = Forum
pk_url_kwarg = "forum_id"
template_name = "core/delete_confirm.jinja"
success_url = reverse_lazy('forum:main')
success_url = reverse_lazy("forum:main")
class ForumDetailView(CanViewMixin, DetailView):
@ -150,12 +167,13 @@ class ForumDetailView(CanViewMixin, DetailView):
def get_context_data(self, **kwargs):
kwargs = super(ForumDetailView, self).get_context_data(**kwargs)
qs = self.object.topics.order_by('-_last_message__date')\
.select_related('_last_message__author', 'author')\
qs = (
self.object.topics.order_by("-_last_message__date")
.select_related("_last_message__author", "author")
.prefetch_related("forum__edit_groups")
paginator = Paginator(qs,
settings.SITH_FORUM_PAGE_LENGTH)
page = self.request.GET.get('topic_page')
)
paginator = Paginator(qs, settings.SITH_FORUM_PAGE_LENGTH)
page = self.request.GET.get("topic_page")
try:
kwargs["topics"] = paginator.page(page)
except PageNotAnInteger:
@ -168,10 +186,9 @@ class ForumDetailView(CanViewMixin, DetailView):
class TopicForm(forms.ModelForm):
class Meta:
model = ForumMessage
fields = ['title', 'message']
widgets = {
'message': MarkdownInput,
}
fields = ["title", "message"]
widgets = {"message": MarkdownInput}
title = forms.CharField(required=True, label=_("Title"))
@ -181,13 +198,17 @@ class ForumTopicCreateView(CanCreateMixin, CreateView):
template_name = "forum/reply.jinja"
def dispatch(self, request, *args, **kwargs):
self.forum = get_object_or_404(Forum, id=self.kwargs['forum_id'], is_category=False)
self.forum = get_object_or_404(
Forum, id=self.kwargs["forum_id"], is_category=False
)
if not request.user.can_view(self.forum):
raise PermissionDenied
return super(ForumTopicCreateView, self).dispatch(request, *args, **kwargs)
def form_valid(self, form):
topic = ForumTopic(_title=form.instance.title, author=self.request.user, forum=self.forum)
topic = ForumTopic(
_title=form.instance.title, author=self.request.user, forum=self.forum
)
topic.save()
form.instance.topic = topic
form.instance.author = self.request.user
@ -196,10 +217,11 @@ class ForumTopicCreateView(CanCreateMixin, CreateView):
class ForumTopicEditView(CanEditMixin, UpdateView):
model = ForumTopic
fields = ['forum']
fields = ["forum"]
pk_url_kwarg = "topic_id"
template_name = "core/edit.jinja"
class ForumTopicSubscribeView(CanViewMixin, SingleObjectMixin, RedirectView):
model = ForumTopic
pk_url_kwarg = "topic_id"
@ -222,19 +244,22 @@ class ForumTopicDetailView(CanViewMixin, DetailView):
pk_url_kwarg = "topic_id"
template_name = "forum/topic.jinja"
context_object_name = "topic"
queryset = ForumTopic.objects.select_related('forum__parent')
queryset = ForumTopic.objects.select_related("forum__parent")
def get_context_data(self, **kwargs):
kwargs = super(ForumTopicDetailView, self).get_context_data(**kwargs)
try:
msg = self.object.get_first_unread_message(self.request.user)
kwargs['first_unread_message_id'] = msg.id
kwargs["first_unread_message_id"] = msg.id
except:
kwargs['first_unread_message_id'] = float("inf")
paginator = Paginator(self.object.messages.select_related('author__avatar_pict')
.prefetch_related('topic__forum__edit_groups', 'readers').order_by('date'),
settings.SITH_FORUM_PAGE_LENGTH)
page = self.request.GET.get('page')
kwargs["first_unread_message_id"] = float("inf")
paginator = Paginator(
self.object.messages.select_related("author__avatar_pict")
.prefetch_related("topic__forum__edit_groups", "readers")
.order_by("date"),
settings.SITH_FORUM_PAGE_LENGTH,
)
page = self.request.GET.get("page")
try:
kwargs["msgs"] = paginator.page(page)
except PageNotAnInteger:
@ -256,17 +281,23 @@ class ForumMessageView(SingleObjectMixin, RedirectView):
class ForumMessageEditView(CanEditMixin, UpdateView):
model = ForumMessage
form_class = forms.modelform_factory(model=ForumMessage, fields=['title', 'message', ], widgets={'message': MarkdownInput})
form_class = forms.modelform_factory(
model=ForumMessage,
fields=["title", "message"],
widgets={"message": MarkdownInput},
)
template_name = "forum/reply.jinja"
pk_url_kwarg = "message_id"
def form_valid(self, form):
ForumMessageMeta(message=self.object, user=self.request.user, action="EDIT").save()
ForumMessageMeta(
message=self.object, user=self.request.user, action="EDIT"
).save()
return super(ForumMessageEditView, self).form_valid(form)
def get_context_data(self, **kwargs):
kwargs = super(ForumMessageEditView, self).get_context_data(**kwargs)
kwargs['topic'] = self.object.topic
kwargs["topic"] = self.object.topic
return kwargs
@ -278,7 +309,9 @@ class ForumMessageDeleteView(SingleObjectMixin, RedirectView):
def get_redirect_url(self, *args, **kwargs):
self.object = self.get_object()
if self.object.can_be_moderated_by(self.request.user):
ForumMessageMeta(message=self.object, user=self.request.user, action="DELETE").save()
ForumMessageMeta(
message=self.object, user=self.request.user, action="DELETE"
).save()
return self.object.get_absolute_url()
@ -290,17 +323,23 @@ class ForumMessageUndeleteView(SingleObjectMixin, RedirectView):
def get_redirect_url(self, *args, **kwargs):
self.object = self.get_object()
if self.object.can_be_moderated_by(self.request.user):
ForumMessageMeta(message=self.object, user=self.request.user, action="UNDELETE").save()
ForumMessageMeta(
message=self.object, user=self.request.user, action="UNDELETE"
).save()
return self.object.get_absolute_url()
class ForumMessageCreateView(CanCreateMixin, CreateView):
model = ForumMessage
form_class = forms.modelform_factory(model=ForumMessage, fields=['title', 'message', ], widgets={'message': MarkdownInput})
form_class = forms.modelform_factory(
model=ForumMessage,
fields=["title", "message"],
widgets={"message": MarkdownInput},
)
template_name = "forum/reply.jinja"
def dispatch(self, request, *args, **kwargs):
self.topic = get_object_or_404(ForumTopic, id=self.kwargs['topic_id'])
self.topic = get_object_or_404(ForumTopic, id=self.kwargs["topic_id"])
if not request.user.can_view(self.topic):
raise PermissionDenied
return super(ForumMessageCreateView, self).dispatch(request, *args, **kwargs)
@ -308,12 +347,18 @@ class ForumMessageCreateView(CanCreateMixin, CreateView):
def get_initial(self):
init = super(ForumMessageCreateView, self).get_initial()
try:
message = ForumMessage.objects.select_related('author').filter(id=self.request.GET['quote_id']).first()
init['message'] = "> ##### %s\n" % (_("%(author)s said") % {'author': message.author.get_short_name()})
init['message'] += "\n".join([
"> " + line for line in message.message.split('\n')
])
init['message'] += "\n\n"
message = (
ForumMessage.objects.select_related("author")
.filter(id=self.request.GET["quote_id"])
.first()
)
init["message"] = "> ##### %s\n" % (
_("%(author)s said") % {"author": message.author.get_short_name()}
)
init["message"] += "\n".join(
["> " + line for line in message.message.split("\n")]
)
init["message"] += "\n\n"
except Exception as e:
print(repr(e))
return init
@ -325,5 +370,5 @@ class ForumMessageCreateView(CanCreateMixin, CreateView):
def get_context_data(self, **kwargs):
kwargs = super(ForumMessageCreateView, self).get_context_data(**kwargs)
kwargs['topic'] = self.topic
kwargs["topic"] = self.topic
return kwargs