Split post module into post and manager

boards/models/post/manager.py

@@ -0,0 +1,125 b''
+from datetime import datetime, timedelta, date
+from datetime import time as dtime
+import logging
+from django.db import models, transaction
+from django.utils import timezone
+from boards import utils
+from boards.mdx_neboard import Parser
+from boards.models import PostImage
+import boards.models
+
+__author__ = 'vurdalak'
+
+
+NO_IP = '0.0.0.0'
+POSTS_PER_DAY_RANGE = 7
+
+
+class PostManager(models.Manager):
+    @transaction.atomic
+    def create_post(self, title: str, text: str, image=None, thread=None,
+                    ip=NO_IP, tags: list=None, opening_posts: list=None):
+        """
+        Creates new post
+        """
+
+        is_banned = boards.models.Ban.objects.filter(ip=ip).exists()
+
+        # TODO Raise specific exception and catch it in the views
+        if is_banned:
+            raise Exception("This user is banned")
+
+        if not tags:
+            tags = []
+        if not opening_posts:
+            opening_posts = []
+
+        posting_time = timezone.now()
+        if not thread:
+            thread = boards.models.thread.Thread.objects.create(
+                bump_time=posting_time, last_edit_time=posting_time)
+            list(map(thread.tags.add, tags))
+            boards.models.thread.Thread.objects.process_oldest_threads()
+        else:
+            thread.last_edit_time = posting_time
+            thread.bump()
+            thread.save()
+
+        pre_text = Parser().preparse(text)
+
+        post = self.create(title=title,
+                           text=pre_text,
+                           pub_time=posting_time,
+                           poster_ip=ip,
+                           thread=thread,
+                           last_edit_time=posting_time)
+        post.threads.add(thread)
+
+        post.set_global_id()
+
+        logger = logging.getLogger('boards.post.create')
+
+        logger.info('Created post {} by {}'.format(post, post.poster_ip))
+
+        if image:
+            post.images.add(PostImage.objects.create_with_hash(image))
+
+        post.build_url()
+        post.connect_replies()
+        post.connect_threads(opening_posts)
+        post.connect_notifications()
+
+        return post
+
+    @transaction.atomic
+    def import_post(self, title: str, text: str, pub_time: str,
+                    opening_post=None, tags=list()):
+        if opening_post is None:
+            thread = boards.models.thread.Thread.objects.create(
+                bump_time=pub_time, last_edit_time=pub_time)
+            list(map(thread.tags.add, tags))
+        else:
+            thread = opening_post.get_thread()
+
+        post = self.create(title=title, text=text,
+                           pub_time=pub_time,
+                           poster_ip=NO_IP,
+                           last_edit_time=pub_time,
+                           thread_id=thread.id)
+
+        post.build_url()
+        post.connect_replies()
+        post.connect_notifications()
+
+        return post
+
+    def delete_posts_by_ip(self, ip):
+        """
+        Deletes all posts of the author with same IP
+        """
+
+        posts = self.filter(poster_ip=ip)
+        for post in posts:
+            post.delete()
+
+    @utils.cached_result()
+    def get_posts_per_day(self) -> float:
+        """
+        Gets average count of posts per day for the last 7 days
+        """
+
+        day_end = date.today()
+        day_start = day_end - timedelta(POSTS_PER_DAY_RANGE)
+
+        day_time_start = timezone.make_aware(datetime.combine(
+            day_start, dtime()), timezone.get_current_timezone())
+        day_time_end = timezone.make_aware(datetime.combine(
+            day_end, dtime()), timezone.get_current_timezone())
+
+        posts_per_period = float(self.filter(
+            pub_time__lte=day_time_end,
+            pub_time__gte=day_time_start).count())
+
+        ppd = posts_per_period / POSTS_PER_DAY_RANGE
+
+        return ppd

boards/management/commands/enforce_privacy.py

@@ -1,16 +1,15 b''
 from django.core.management import BaseCommand
 from django.db import transaction
 
 from boards.models import Post
-from boards.models.post import NO_IP
-
+from boards.models.post.manager import NO_IP
 
 __author__ = 'neko259'
 
 
 class Command(BaseCommand):
     help = 'Removes user and IP data from all posts'
 
     @transaction.atomic
     def handle(self, *args, **options):
         Post.objects.all().update(poster_ip=NO_IP)
  No newline at end of file

boards/models/post/__init__.py

@@ -1,520 +1,405 b''
-from datetime import datetime, timedelta, date
-from datetime import time as dtime
 import logging
 import re
 import uuid
 
 from django.core.exceptions import ObjectDoesNotExist
 from django.core.urlresolvers import reverse
-from django.db import models, transaction
+from django.db import models
 from django.db.models import TextField, QuerySet
+
 from django.template.loader import render_to_string
+
 from django.utils import timezone
 
 from boards.mdx_neboard import Parser
 from boards.models import KeyPair, GlobalId
 from boards import settings
 from boards.models import PostImage
 from boards.models.base import Viewable
-from boards import utils
 from boards.models.post.export import get_exporter, DIFF_TYPE_JSON
-from boards.models.user import Notification, Ban
-import boards.models.thread
+from boards.models.post.manager import PostManager
+from boards.models.user import Notification
 
 WS_NOTIFICATION_TYPE_NEW_POST = 'new_post'
 WS_NOTIFICATION_TYPE = 'notification_type'
 
 WS_CHANNEL_THREAD = "thread:"
 
 APP_LABEL_BOARDS = 'boards'
 
-POSTS_PER_DAY_RANGE = 7
-
 BAN_REASON_AUTO = 'Auto'
 
 IMAGE_THUMB_SIZE = (200, 150)
 
 TITLE_MAX_LENGTH = 200
 
-NO_IP = '0.0.0.0'
-
 REGEX_REPLY = re.compile(r'\[post\](\d+)\[/post\]')
 REGEX_GLOBAL_REPLY = re.compile(r'\[post\](\w+)::([^:]+)::(\d+)\[/post\]')
 REGEX_URL = re.compile(r'https?\://[a-zA-Z0-9\-\.]+\.[a-zA-Z]{2,3}(/\S*)?')
 REGEX_NOTIFICATION = re.compile(r'\[user\](\w+)\[/user\]')
 
 PARAMETER_TRUNCATED = 'truncated'
 PARAMETER_TAG = 'tag'
 PARAMETER_OFFSET = 'offset'
 PARAMETER_DIFF_TYPE = 'type'
 PARAMETER_CSS_CLASS = 'css_class'
 PARAMETER_THREAD = 'thread'
 PARAMETER_IS_OPENING = 'is_opening'
 PARAMETER_MODERATOR = 'moderator'
 PARAMETER_POST = 'post'
 PARAMETER_OP_ID = 'opening_post_id'
 PARAMETER_NEED_OPEN_LINK = 'need_open_link'
 PARAMETER_REPLY_LINK = 'reply_link'
 PARAMETER_NEED_OP_DATA = 'need_op_data'
 
 POST_VIEW_PARAMS = (
     'need_op_data',
     'reply_link',
     'moderator',
     'need_open_link',
     'truncated',
     'mode_tree',
 )
 
 REFMAP_STR = '<a href="{}">&gt;&gt;{}</a>'
 
 
-class PostManager(models.Manager):
-    @transaction.atomic
-    def create_post(self, title: str, text: str, image=None, thread=None,
-            ip=NO_IP, tags: list=None, opening_posts: list=None):
-        """
-        Creates new post
-        """
-
-        is_banned = Ban.objects.filter(ip=ip).exists()
-
-        # TODO Raise specific exception and catch it in the views
-        if is_banned:
-            raise Exception("This user is banned")
-
-        if not tags:
-            tags = []
-        if not opening_posts:
-            opening_posts = []
-
-        posting_time = timezone.now()
-        if not thread:
-            thread = boards.models.thread.Thread.objects.create(
-                bump_time=posting_time, last_edit_time=posting_time)
-            list(map(thread.tags.add, tags))
-            boards.models.thread.Thread.objects.process_oldest_threads()
-        else:
-            thread.last_edit_time = posting_time
-            thread.bump()
-            thread.save()
-
-        pre_text = Parser().preparse(text)
-
-        post = self.create(title=title,
-                           text=pre_text,
-                           pub_time=posting_time,
-                           poster_ip=ip,
-                           thread=thread,
-                           last_edit_time=posting_time)
-        post.threads.add(thread)
-
-        post.set_global_id()
-
-        logger = logging.getLogger('boards.post.create')
-
-        logger.info('Created post {} by {}'.format(post, post.poster_ip))
-
-        if image:
-            post.images.add(PostImage.objects.create_with_hash(image))
-
-        post.build_url()
-        post.connect_replies()
-        post.connect_threads(opening_posts)
-        post.connect_notifications()
-
-        return post
-
-    @transaction.atomic
-    def import_post(self, title: str, text:str, pub_time: str,
-                    opening_post=None, tags=list()):
-        if opening_post is None:
-            thread = boards.models.thread.Thread.objects.create(
-                bump_time=pub_time, last_edit_time=pub_time)
-            list(map(thread.tags.add, tags))
-        else:
-            thread = opening_post.get_thread()
-
-        post = Post.objects.create(title=title, text=text,
-                                   pub_time=pub_time,
-                                   poster_ip=NO_IP,
-                                   last_edit_time=pub_time,
-                                   thread_id=thread.id)
-
-        post.build_url()
-        post.connect_replies()
-        post.connect_notifications()
-
-        return post
-
-    def delete_posts_by_ip(self, ip):
-        """
-        Deletes all posts of the author with same IP
-        """
-
-        posts = self.filter(poster_ip=ip)
-        for post in posts:
-            post.delete()
-
-    @utils.cached_result()
-    def get_posts_per_day(self) -> float:
-        """
-        Gets average count of posts per day for the last 7 days
-        """
-
-        day_end = date.today()
-        day_start = day_end - timedelta(POSTS_PER_DAY_RANGE)
-
-        day_time_start = timezone.make_aware(datetime.combine(
-            day_start, dtime()), timezone.get_current_timezone())
-        day_time_end = timezone.make_aware(datetime.combine(
-            day_end, dtime()), timezone.get_current_timezone())
-
-        posts_per_period = float(self.filter(
-            pub_time__lte=day_time_end,
-            pub_time__gte=day_time_start).count())
-
-        ppd = posts_per_period / POSTS_PER_DAY_RANGE
-
-        return ppd
-    
-
 class Post(models.Model, Viewable):
     """A post is a message."""
 
     objects = PostManager()
 
     class Meta:
         app_label = APP_LABEL_BOARDS
         ordering = ('id',)
 
     title = models.CharField(max_length=TITLE_MAX_LENGTH, null=True, blank=True)
     pub_time = models.DateTimeField()
     text = TextField(blank=True, null=True)
     _text_rendered = TextField(blank=True, null=True, editable=False)
 
     images = models.ManyToManyField(PostImage, null=True, blank=True,
                                     related_name='ip+', db_index=True)
 
     poster_ip = models.GenericIPAddressField()
 
     # TODO This field can be removed cause UID is used for update now
     last_edit_time = models.DateTimeField()
 
     referenced_posts = models.ManyToManyField('Post', symmetrical=False,
                                               null=True,
                                               blank=True, related_name='refposts',
                                               db_index=True)
     refmap = models.TextField(null=True, blank=True)
     threads = models.ManyToManyField('Thread', db_index=True)
     thread = models.ForeignKey('Thread', db_index=True, related_name='pt+')
 
     url = models.TextField()
     uid = models.TextField(db_index=True)
 
     # Global ID with author key. If the message was downloaded from another
     # server, this indicates the server.
     global_id = models.OneToOneField('GlobalId', null=True, blank=True)
 
     # One post can be signed by many nodes that give their trust to it
     signature = models.ManyToManyField('Signature', null=True, blank=True)
 
     def __str__(self):
         return 'P#{}/{}'.format(self.id, self.title)
 
     def get_referenced_posts(self):
         threads = self.get_threads().all()
         return self.referenced_posts.filter(threads__in=threads)\
                 .order_by('pub_time').distinct().all()
 
     def get_title(self) -> str:
         """
         Gets original post title or part of its text.
         """
 
         title = self.title
         if not title:
             title = self.get_text()
 
         return title
 
     def build_refmap(self) -> None:
         """
         Builds a replies map string from replies list. This is a cache to stop
         the server from recalculating the map on every post show.
         """
 
         post_urls = [REFMAP_STR.format(refpost.get_absolute_url(), refpost.id)
                      for refpost in self.referenced_posts.all()]
 
         self.refmap = ', '.join(post_urls)
 
     def is_referenced(self) -> bool:
         return self.refmap and len(self.refmap) > 0
 
     def is_opening(self) -> bool:
         """
         Checks if this is an opening post or just a reply.
         """
 
         return self.get_thread().get_opening_post_id() == self.id
 
     def get_absolute_url(self):
         if self.url:
             return self.url
         else:
             opening_id = self.get_thread().get_opening_post_id()
             post_url = reverse('thread', kwargs={'post_id': opening_id})
             if self.id != opening_id:
                 post_url += '#' + str(self.id)
             return post_url
 
     def get_thread(self):
         return self.thread
 
     def get_threads(self) -> QuerySet:
         """
         Gets post's thread.
         """
 
         return self.threads
 
     def get_view(self, *args, **kwargs) -> str:
         """
         Renders post's HTML view. Some of the post params can be passed over
         kwargs for the means of caching (if we view the thread, some params
         are same for every post and don't need to be computed over and over.
         """
 
         thread = self.get_thread()
         is_opening = kwargs.get(PARAMETER_IS_OPENING, self.is_opening())
 
         if is_opening:
             opening_post_id = self.id
         else:
             opening_post_id = thread.get_opening_post_id()
 
         css_class = 'post'
         if thread.archived:
             css_class += ' archive_post'
         elif not thread.can_bump():
             css_class += ' dead_post'
 
         params = dict()
         for param in POST_VIEW_PARAMS:
             if param in kwargs:
                 params[param] = kwargs[param]
 
         params.update({
             PARAMETER_POST: self,
             PARAMETER_IS_OPENING: is_opening,
             PARAMETER_THREAD: thread,
             PARAMETER_CSS_CLASS: css_class,
             PARAMETER_OP_ID: opening_post_id,
         })
 
         return render_to_string('boards/post.html', params)
 
     def get_search_view(self, *args, **kwargs):
         return self.get_view(need_op_data=True, *args, **kwargs)
 
     def get_first_image(self) -> PostImage:
         return self.images.earliest('id')
 
     def delete(self, using=None):
         """
         Deletes all post images and the post itself.
         """
 
         for image in self.images.all():
             image_refs_count = Post.objects.filter(images__in=[image]).count()
             if image_refs_count == 1:
                 image.delete()
 
         self.signature.all().delete()
         if self.global_id:
             self.global_id.delete()
 
         thread = self.get_thread()
         thread.last_edit_time = timezone.now()
         thread.save()
 
         super(Post, self).delete(using)
 
         logging.getLogger('boards.post.delete').info(
             'Deleted post {}'.format(self))
 
     def set_global_id(self, key_pair=None):
         """
         Sets global id based on the given key pair. If no key pair is given,
         default one is used.
         """
 
         if key_pair:
             key = key_pair
         else:
             try:
                 key = KeyPair.objects.get(primary=True)
             except KeyPair.DoesNotExist:
                 # Do not update the global id because there is no key defined
                 return
         global_id = GlobalId(key_type=key.key_type,
                              key=key.public_key,
                              local_id=self.id)
         global_id.save()
 
         self.global_id = global_id
 
         self.save(update_fields=['global_id'])
 
     def get_pub_time_str(self):
         return str(self.pub_time)
 
     def get_replied_ids(self):
         """
         Gets ID list of the posts that this post replies.
         """
 
         raw_text = self.get_raw_text()
 
         local_replied = REGEX_REPLY.findall(raw_text)
         global_replied = []
         for match in REGEX_GLOBAL_REPLY.findall(raw_text):
             key_type = match[0]
             key = match[1]
             local_id = match[2]
 
             try:
                 global_id = GlobalId.objects.get(key_type=key_type,
                     key=key, local_id=local_id)
                 for post in Post.objects.filter(global_id=global_id).only('id'):
                     global_replied.append(post.id)
             except GlobalId.DoesNotExist:
                 pass
         return local_replied + global_replied
 
     def get_post_data(self, format_type=DIFF_TYPE_JSON, request=None,
                       include_last_update=False) -> str:
         """
         Gets post HTML or JSON data that can be rendered on a page or used by
         API.
         """
 
         return get_exporter(format_type).export(self, request,
                                                 include_last_update)
 
     def notify_clients(self, recursive=True):
         """
         Sends post HTML data to the thread web socket.
         """
 
         if not settings.get_bool('External', 'WebsocketsEnabled'):
             return
 
         thread_ids = list()
         for thread in self.get_threads().all():
             thread_ids.append(thread.id)
 
             thread.notify_clients()
 
         if recursive:
             for reply_number in re.finditer(REGEX_REPLY, self.get_raw_text()):
                 post_id = reply_number.group(1)
 
                 try:
                     ref_post = Post.objects.get(id=post_id)
 
                     if ref_post.get_threads().exclude(id__in=thread_ids).exists():
                         # If post is in this thread, its thread was already notified.
                         # Otherwise, notify its thread separately.
                         ref_post.notify_clients(recursive=False)
                 except ObjectDoesNotExist:
                     pass
 
     def build_url(self):
         self.url = self.get_absolute_url()
         self.save(update_fields=['url'])
 
     def save(self, force_insert=False, force_update=False, using=None,
              update_fields=None):
         self._text_rendered = Parser().parse(self.get_raw_text())
 
         self.uid = str(uuid.uuid4())
         if update_fields is not None and 'uid' not in update_fields:
             update_fields += ['uid']
 
         if self.id:
             for thread in self.get_threads().all():
                 thread.last_edit_time = self.last_edit_time
 
                 thread.save(update_fields=['last_edit_time'])
 
         super().save(force_insert, force_update, using, update_fields)
 
     def get_text(self) -> str:
         return self._text_rendered
 
     def get_raw_text(self) -> str:
         return self.text
 
     def get_sync_text(self) -> str:
         """
         Returns text applicable for sync. It has absolute post reflinks.
         """
 
         replacements = dict()
         for post_id in REGEX_REPLY.findall(self.get_raw_text()):
             absolute_post_id = str(Post.objects.get(id=post_id).global_id)
             replacements[post_id] = absolute_post_id
 
         text = self.get_raw_text()
         for key in replacements:
             text = text.replace('[post]{}[/post]'.format(key),
                                 '[post]{}[/post]'.format(replacements[key]))
 
         return text
 
     def get_absolute_id(self) -> str:
         """
         If the post has many threads, shows its main thread OP id in the post
         ID.
         """
 
         if self.get_threads().count() > 1:
             return '{}/{}'.format(self.get_thread().get_opening_post_id(), self.id)
         else:
             return str(self.id)
 
     def connect_notifications(self):
         for reply_number in re.finditer(REGEX_NOTIFICATION, self.get_raw_text()):
             user_name = reply_number.group(1).lower()
             Notification.objects.get_or_create(name=user_name, post=self)
 
     def connect_replies(self):
         """
         Connects replies to a post to show them as a reflink map
         """
 
         for reply_number in re.finditer(REGEX_REPLY, self.get_raw_text()):
             post_id = reply_number.group(1)
 
             try:
                 referenced_post = Post.objects.get(id=post_id)
 
                 referenced_post.referenced_posts.add(self)
                 referenced_post.last_edit_time = self.pub_time
                 referenced_post.build_refmap()
                 referenced_post.save(update_fields=['refmap', 'last_edit_time'])
             except ObjectDoesNotExist:
                 pass
 
     def connect_threads(self, opening_posts):
         for opening_post in opening_posts:
             threads = opening_post.get_threads().all()
             for thread in threads:
                 if thread.can_bump():
                     thread.update_bump_status()
 
                 thread.last_edit_time = self.last_edit_time
                 thread.save(update_fields=['last_edit_time', 'bumpable'])
             self.threads.add(opening_post.get_thread())

boards/models/user.py

@@ -1,46 +1,45 b''
 from django.db import models
-
-import boards.models.post
+import boards
 
 __author__ = 'neko259'
 
 BAN_REASON_AUTO = 'Auto'
 BAN_REASON_MAX_LENGTH = 200
 
 
 class Ban(models.Model):
 
     class Meta:
         app_label = 'boards'
 
     ip = models.GenericIPAddressField()
     reason = models.CharField(default=BAN_REASON_AUTO,
                               max_length=BAN_REASON_MAX_LENGTH)
     can_read = models.BooleanField(default=True)
 
     def __str__(self):
         return self.ip
 
 
 class NotificationManager(models.Manager):
     def get_notification_posts(self, username: str, last: int = None):
         i_username = username.lower()
 
         posts = boards.models.post.Post.objects.filter(notification__name=i_username)
         if last is not None:
             posts = posts.filter(id__gt=last)
         posts = posts.order_by('-id')
 
         return posts
 
 
 class Notification(models.Model):
 
     class Meta:
         app_label = 'boards'
 
     objects = NotificationManager()
 
     post = models.ForeignKey('Post')
     name = models.TextField()