Added replies manytomany field to the post to get its replies more efficiently.

boards/migrations/0005_auto.py

@@ -0,0 +1,81 b''
+# -*- coding: utf-8 -*-
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+from boards.models import Post, NO_PARENT
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        # Adding M2M table for field replies on 'Post'
+        m2m_table_name = db.shorten_name(u'boards_post_replies')
+        db.create_table(m2m_table_name, (
+            ('id', models.AutoField(verbose_name='ID', primary_key=True, auto_created=True)),
+            ('from_post', models.ForeignKey(orm[u'boards.post'], null=False)),
+            ('to_post', models.ForeignKey(orm[u'boards.post'], null=False))
+        ))
+        db.create_unique(m2m_table_name, ['from_post_id', 'to_post_id'])
+
+        for post in Post.objects.all():
+            if post.parent != NO_PARENT:
+                parent = Post.objects.get(id=post.parent)
+                parent.replies.add(post)
+
+
+    def backwards(self, orm):
+        # Removing M2M table for field replies on 'Post'
+        db.delete_table(db.shorten_name(u'boards_post_replies'))
+
+
+    models = {
+        u'boards.ban': {
+            'Meta': {'object_name': 'Ban'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'ip': ('django.db.models.fields.GenericIPAddressField', [], {'max_length': '39'})
+        },
+        u'boards.post': {
+            'Meta': {'object_name': 'Post'},
+            '_text_rendered': ('django.db.models.fields.TextField', [], {}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'image': ('boards.thumbs.ImageWithThumbsField', [], {'max_length': '100', 'blank': 'True'}),
+            'image_height': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'image_width': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'last_edit_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'parent': ('django.db.models.fields.BigIntegerField', [], {}),
+            'poster_ip': ('django.db.models.fields.GenericIPAddressField', [], {'max_length': '39'}),
+            'poster_user_agent': ('django.db.models.fields.TextField', [], {}),
+            'pub_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'replies': ('django.db.models.fields.related.ManyToManyField', [], {'blank': 'True', 'related_name': "'re+'", 'null': 'True', 'symmetrical': 'False', 'to': u"orm['boards.Post']"}),
+            'tags': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['boards.Tag']", 'symmetrical': 'False'}),
+            'text': ('markupfield.fields.MarkupField', [], {'rendered_field': 'True'}),
+            'text_markup_type': ('django.db.models.fields.CharField', [], {'default': "'markdown'", 'max_length': '30'}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '50'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'default': 'None', 'to': u"orm['boards.User']", 'null': 'True'})
+        },
+        u'boards.setting': {
+            'Meta': {'object_name': 'Setting'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['boards.User']"}),
+            'value': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        u'boards.tag': {
+            'Meta': {'object_name': 'Tag'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        u'boards.user': {
+            'Meta': {'object_name': 'User'},
+            'fav_tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'to': u"orm['boards.Tag']", 'null': 'True', 'blank': 'True'}),
+            'fav_threads': ('django.db.models.fields.related.ManyToManyField', [], {'blank': 'True', 'related_name': "'+'", 'null': 'True', 'symmetrical': 'False', 'to': u"orm['boards.Post']"}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'last_access_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'rank': ('django.db.models.fields.IntegerField', [], {}),
+            'registration_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'user_id': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        }
+    }
+
+    complete_apps = ['boards']
  No newline at end of file

boards/models.py

@@ -1,326 +1,332 b''
 import os
 from random import random
 import re
 import time
 import math
 
 from django.db import models
+from django.db.models import Count
 from django.http import Http404
 from django.utils import timezone
 from markupfield.fields import MarkupField
-from threading import Thread
 
 from neboard import settings
 import thumbs
 
 IMAGE_THUMB_SIZE = (200, 150)
 
 TITLE_MAX_LENGTH = 50
 
 DEFAULT_MARKUP_TYPE = 'markdown'
 
 NO_PARENT = -1
 NO_IP = '0.0.0.0'
 UNKNOWN_UA = ''
 ALL_PAGES = -1
 OPENING_POST_POPULARITY_WEIGHT = 2
 IMAGES_DIRECTORY = 'images/'
 FILE_EXTENSION_DELIMITER = '.'
 
 RANK_ADMIN = 0
 RANK_MODERATOR = 10
 RANK_USER = 100
 
 
 class PostManager(models.Manager):
     def create_post(self, title, text, image=None, parent_id=NO_PARENT,
                     ip=NO_IP, tags=None, user=None):
         post = self.create(title=title,
                            text=text,
                            pub_time=timezone.now(),
                            parent=parent_id,
                            image=image,
                            poster_ip=ip,
                            poster_user_agent=UNKNOWN_UA,
                            last_edit_time=timezone.now(),
                            user=user)
 
+        if parent_id != NO_PARENT:
+            parent = self.get(id=parent_id)
+            parent.replies.add(post)
+
         if tags:
             map(post.tags.add, tags)
 
         if parent_id != NO_PARENT:
             self._bump_thread(parent_id)
         else:
             self._delete_old_threads()
 
         return post
 
     def delete_post(self, post):
-        children = self.filter(parent=post.id)
-
-        map(self.delete_post, children)
+        if post.replies.count() > 0:
+            map(self.delete_post, post.replies)
         post.delete()
 
     def delete_posts_by_ip(self, ip):
         posts = self.filter(poster_ip=ip)
         map(self.delete_post, posts)
 
     def get_threads(self, tag=None, page=ALL_PAGES,
                     order_by='-last_edit_time'):
         if tag:
             threads = self.filter(parent=NO_PARENT, tags=tag)
 
             # TODO Throw error 404 if no threads for tag found?
         else:
             threads = self.filter(parent=NO_PARENT)
 
         threads = threads.order_by(order_by)
 
         if page != ALL_PAGES:
             thread_count = threads.count()
 
             if page < self.get_thread_page_count(tag=tag):
                 start_thread = page * settings.THREADS_PER_PAGE
                 end_thread = min(start_thread + settings.THREADS_PER_PAGE,
                                  thread_count)
                 threads = threads[start_thread:end_thread]
 
         return threads
 
     def get_thread(self, opening_post_id):
         try:
             opening_post = self.get(id=opening_post_id, parent=NO_PARENT)
         except Post.DoesNotExist:
             raise Http404
 
-        if opening_post.parent == NO_PARENT:
-            replies = self.filter(parent=opening_post_id)
-
+        if opening_post.replies:
             thread = [opening_post]
-            thread.extend(replies)
+            thread.extend(opening_post.replies.all())
 
             return thread
 
     def exists(self, post_id):
         posts = self.filter(id=post_id)
 
         return posts.count() > 0
 
     def get_thread_page_count(self, tag=None):
         if tag:
             threads = self.filter(parent=NO_PARENT, tags=tag)
         else:
             threads = self.filter(parent=NO_PARENT)
 
         return int(math.ceil(threads.count() / float(
             settings.THREADS_PER_PAGE)))
 
     def _delete_old_threads(self):
         """
         Preserves maximum thread count. If there are too many threads,
         delete the old ones.
         """
 
         # TODO Move old threads to the archive instead of deleting them.
         # Maybe make some 'old' field in the model to indicate the thread
         # must not be shown and be able for replying.
 
         threads = self.get_threads()
         thread_count = len(threads)
 
         if thread_count > settings.MAX_THREAD_COUNT:
             num_threads_to_delete = thread_count - settings.MAX_THREAD_COUNT
             old_threads = threads[thread_count - num_threads_to_delete:]
 
             map(self.delete_post, old_threads)
 
     def _bump_thread(self, thread_id):
         thread = self.get(id=thread_id)
 
         if thread.can_bump():
             thread.last_edit_time = timezone.now()
             thread.save()
 
 
 class TagManager(models.Manager):
     def get_not_empty_tags(self):
         all_tags = self.all().order_by('name')
         tags = []
         for tag in all_tags:
             if not tag.is_empty():
                 tags.append(tag)
 
         return tags
 
     def get_popular_tags(self):
         all_tags = self.get_not_empty_tags()
 
         sorted_tags = sorted(all_tags, key=lambda tag: tag.get_popularity(),
                              reverse=True)
 
         return sorted_tags[:settings.POPULAR_TAGS]
 
 
 class Tag(models.Model):
     """
     A tag is a text node assigned to the post. The tag serves as a board
     section. There can be multiple tags for each message
     """
 
     objects = TagManager()
 
     name = models.CharField(max_length=100)
 
     def __unicode__(self):
         return self.name
 
     def is_empty(self):
         return self.get_post_count() == 0
 
     def get_post_count(self):
         posts_with_tag = Post.objects.get_threads(tag=self)
         return posts_with_tag.count()
 
     def get_popularity(self):
         posts_with_tag = Post.objects.get_threads(tag=self)
         reply_count = 0
         for post in posts_with_tag:
             reply_count += post.get_reply_count()
             reply_count += OPENING_POST_POPULARITY_WEIGHT
 
         return reply_count
 
 
 class Post(models.Model):
     """A post is a message."""
 
     objects = PostManager()
 
     def _update_image_filename(self, filename):
         """Get unique image filename"""
 
         path = IMAGES_DIRECTORY
         new_name = str(int(time.mktime(time.gmtime())))
         new_name += str(int(random() * 1000))
         new_name += FILE_EXTENSION_DELIMITER
         new_name += filename.split(FILE_EXTENSION_DELIMITER)[-1:][0]
 
         return os.path.join(path, new_name)
 
     title = models.CharField(max_length=TITLE_MAX_LENGTH)
     pub_time = models.DateTimeField()
     text = MarkupField(default_markup_type=DEFAULT_MARKUP_TYPE,
                        escape_html=False)
 
     image_width = models.IntegerField(default=0)
     image_height = models.IntegerField(default=0)
 
     image = thumbs.ImageWithThumbsField(upload_to=_update_image_filename,
                                         blank=True, sizes=(IMAGE_THUMB_SIZE,),
                                         width_field='image_width',
                                         height_field='image_height')
 
     poster_ip = models.GenericIPAddressField()
     poster_user_agent = models.TextField()
+
+    # TODO Convert this field to ForeignKey
     parent = models.BigIntegerField()
+
     tags = models.ManyToManyField(Tag)
     last_edit_time = models.DateTimeField()
     user = models.ForeignKey('User', null=True, default=None)
 
+    replies = models.ManyToManyField('Post', symmetrical=False, null=True,
+                                     blank=True, related_name='re+')
+
     def __unicode__(self):
         return '#' + str(self.id) + ' ' + self.title + ' (' + \
                self.text.raw[:50] + ')'
 
     def get_title(self):
         title = self.title
         if len(title) == 0:
             title = self.text.raw[:20]
 
         return title
 
     def _get_replies(self):
-        return Post.objects.filter(parent=self.id)
+        return self.replies
 
     def get_reply_count(self):
-        return self._get_replies().count()
+        return self.replies.count()
 
     def get_images_count(self):
         images_count = 1 if self.image else 0
 
-        replies = self._get_replies()
-        for reply in replies:
+        for reply in self.replies:
             if reply.image:
                 images_count += 1
 
         return images_count
 
     def can_bump(self):
         """Check if the thread can be bumped by replying"""
 
-        replies_count = self.get_reply_count() + 1
+        post_count = self.get_reply_count() + 1
 
-        return replies_count <= settings.MAX_POSTS_PER_THREAD
+        return post_count <= settings.MAX_POSTS_PER_THREAD
 
     def get_last_replies(self):
         if settings.LAST_REPLIES_COUNT > 0:
             reply_count = self.get_reply_count()
 
             if reply_count > 0:
                 reply_count_to_show = min(settings.LAST_REPLIES_COUNT,
                                           reply_count)
-                last_replies = self._get_replies()[reply_count
-                                                   - reply_count_to_show:]
+                last_replies = self.replies.all()[reply_count -
+                                                  reply_count_to_show:]
 
                 return last_replies
 
 
 class User(models.Model):
 
     user_id = models.CharField(max_length=50)
     rank = models.IntegerField()
 
     registration_time = models.DateTimeField()
     last_access_time = models.DateTimeField()
 
     fav_tags = models.ManyToManyField(Tag, null=True, blank=True)
     fav_threads = models.ManyToManyField(Post, related_name='+', null=True,
                                          blank=True)
 
     def save_setting(self, name, value):
         setting, created = Setting.objects.get_or_create(name=name, user=self)
         setting.value = value
         setting.save()
 
         return setting
 
     def get_setting(self, name):
         if Setting.objects.filter(name=name, user=self).exists():
             setting = Setting.objects.get(name=name, user=self)
             setting_value = setting.value
         else:
             setting_value = None
 
         return setting_value
 
     def is_moderator(self):
         return RANK_MODERATOR >= self.rank
 
     def get_sorted_fav_tags(self):
         return self.fav_tags.order_by('name')
 
     def __unicode__(self):
         return self.user_id + '(' + str(self.rank) + ')'
 
 
 class Setting(models.Model):
 
     name = models.CharField(max_length=50)
     value = models.CharField(max_length=50)
     user = models.ForeignKey(User)
 
 
 class Ban(models.Model):
     ip = models.GenericIPAddressField()
 
     def __unicode__(self):
         return self.ip

boards/views.py

@@ -1,358 +1,359 b''
 import hashlib
 from django.core.urlresolvers import reverse
 from django.http import HttpResponseRedirect
 from django.template import RequestContext
 from django.shortcuts import render, redirect, get_object_or_404
 from django.utils import timezone
 
 from boards import forms
 import boards
 from boards import utils
 from boards.forms import ThreadForm, PostForm, SettingsForm, PlainErrorList, \
     ThreadCaptchaForm, PostCaptchaForm, LoginForm
 
 from boards.models import Post, Tag, Ban, User, RANK_USER, NO_PARENT
 from boards import authors
 import neboard
 
 
 def index(request, page=0):
     context = _init_default_context(request)
 
     if utils.need_include_captcha(request):
         threadFormClass = ThreadCaptchaForm
         kwargs = {'request': request}
     else:
         threadFormClass = ThreadForm
         kwargs = {}
 
     if request.method == 'POST':
         form = threadFormClass(request.POST, request.FILES,
                                error_class=PlainErrorList, **kwargs)
         form.session = request.session
 
         if form.is_valid():
             return _new_post(request, form)
     else:
         form = threadFormClass(error_class=PlainErrorList, **kwargs)
 
     threads = []
     for thread in Post.objects.get_threads(page=int(page)):
         threads.append({'thread': thread,
                         'bumpable': thread.can_bump()})
 
     context['threads'] = None if len(threads) == 0 else threads
     context['form'] = form
     context['pages'] = range(Post.objects.get_thread_page_count())
 
     return render(request, 'boards/posting_general.html',
                   context)
 
 
 def _new_post(request, form, thread_id=boards.models.NO_PARENT):
     """Add a new post (in thread or as a reply)."""
 
     ip = _get_client_ip(request)
     is_banned = Ban.objects.filter(ip=ip).count() > 0
 
     if is_banned:
         return redirect(you_are_banned)
 
     data = form.cleaned_data
 
     title = data['title']
     text = data['text']
 
     if 'image' in data.keys():
         image = data['image']
     else:
         image = None
 
     tags = []
 
     new_thread = thread_id == boards.models.NO_PARENT
     if new_thread:
         tag_strings = data['tags']
 
         if tag_strings:
             tag_strings = tag_strings.split(' ')
             for tag_name in tag_strings:
                 tag_name = tag_name.strip()
                 if len(tag_name) > 0:
                     tag, created = Tag.objects.get_or_create(name=tag_name)
                     tags.append(tag)
 
     # TODO Add a possibility to define a link image instead of an image file.
     # If a link is given, download the image automatically.
 
     post = Post.objects.create_post(title=title, text=text, ip=ip,
                                     parent_id=thread_id, image=image,
                                     tags=tags)
 
     thread_to_show = (post.id if new_thread else thread_id)
 
     if new_thread:
         return redirect(thread, post_id=thread_to_show)
     else:
         return redirect(reverse(thread,
                                 kwargs={'post_id': thread_to_show}) + '#'
                         + str(post.id))
 
 
 def tag(request, tag_name, page=0):
     """Get all tag threads (posts without a parent)."""
 
     tag = get_object_or_404(Tag, name=tag_name)
     threads = []
     for thread in Post.objects.get_threads(tag=tag, page=int(page)):
         threads.append({'thread': thread,
                         'bumpable': thread.can_bump()})
 
     if request.method == 'POST':
         form = ThreadForm(request.POST, request.FILES,
                           error_class=PlainErrorList)
         if form.is_valid():
             return _new_post(request, form)
     else:
         form = forms.ThreadForm(initial={'tags': tag_name},
                                 error_class=PlainErrorList)
 
     context = _init_default_context(request)
     context['threads'] = None if len(threads) == 0 else threads
     context['tag'] = tag_name
     context['pages'] = range(Post.objects.get_thread_page_count(tag=tag))
 
     context['form'] = form
 
     return render(request, 'boards/posting_general.html',
                   context)
 
 
 def thread(request, post_id):
     """Get all thread posts"""
 
     if utils.need_include_captcha(request):
         postFormClass = PostCaptchaForm
         kwargs = {'request': request}
     else:
         postFormClass = PostForm
         kwargs = {}
 
     if request.method == 'POST':
         form = postFormClass(request.POST, request.FILES,
                              error_class=PlainErrorList, **kwargs)
         form.session = request.session
 
         if form.is_valid():
             return _new_post(request, form, post_id)
     else:
         form = postFormClass(error_class=PlainErrorList, **kwargs)
 
     posts = Post.objects.get_thread(post_id)
 
     context = _init_default_context(request)
 
     context['posts'] = posts
     context['form'] = form
     context['bumpable'] = posts[0].can_bump()
 
     return render(request, 'boards/thread.html', context)
 
 
 def login(request):
     """Log in with user id"""
 
     context = _init_default_context(request)
 
     if request.method == 'POST':
         form = LoginForm(request.POST, request.FILES,
                          error_class=PlainErrorList)
         if form.is_valid():
             user = User.objects.get(user_id=form.cleaned_data['user_id'])
             request.session['user_id'] = user.id
             return redirect(index)
 
     else:
         form = LoginForm()
 
     context['form'] = form
 
     return render(request, 'boards/login.html', context)
 
 
 def settings(request):
     """User's settings"""
 
     context = _init_default_context(request)
 
     if request.method == 'POST':
         form = SettingsForm(request.POST)
         if form.is_valid():
             selected_theme = form.cleaned_data['theme']
 
             user = _get_user(request)
             user.save_setting('theme', selected_theme)
 
         return redirect(settings)
     else:
         selected_theme = _get_theme(request)
         form = SettingsForm(initial={'theme': selected_theme})
         context['form'] = form
 
         return render(request, 'boards/settings.html', context)
 
 
 def all_tags(request):
     """All tags list"""
 
     context = _init_default_context(request)
     context['all_tags'] = Tag.objects.get_not_empty_tags()
 
     return render(request, 'boards/tags.html', context)
 
 
 def jump_to_post(request, post_id):
     """Determine thread in which the requested post is and open it's page"""
 
     post = get_object_or_404(Post, id=post_id)
 
     if boards.models.NO_PARENT == post.parent:
         return redirect(thread, post_id=post.id)
     else:
+        # TODO Change this code to not use 'parent' field anymore
         parent_thread = get_object_or_404(Post, id=post.parent)
         return redirect(reverse(thread, kwargs={'post_id': parent_thread.id})
                         + '#' + str(post.id))
 
 
 def authors(request):
     context = _init_default_context(request)
     context['authors'] = boards.authors.authors
 
     return render(request, 'boards/authors.html', context)
 
 
 def delete(request, post_id):
     user = _get_user(request)
     post = get_object_or_404(Post, id=post_id)
 
     if user.is_moderator():
         # TODO Show confirmation page before deletion
         Post.objects.delete_post(post)
     
     if NO_PARENT == post.parent:
         return _redirect_to_next(request)
     else:
         return redirect(thread, post_id=post.parent)
 
 
 def ban(request, post_id):
     user = _get_user(request)
     post = get_object_or_404(Post, id=post_id)
 
     if user.is_moderator():
         # TODO Show confirmation page before ban
         Ban.objects.get_or_create(ip=post.poster_ip)
 
     return _redirect_to_next(request)
 
 
 def you_are_banned(request):
     context = _init_default_context(request)
     return render(request, 'boards/staticpages/banned.html', context)
 
 
 def page_404(request):
     context = _init_default_context(request)
     return render(request, 'boards/404.html', context)
 
 
 def tag_subscribe(request, tag_name):
     user = _get_user(request)
     tag = get_object_or_404(Tag, name=tag_name)
 
     if not tag in user.fav_tags.all():
         user.fav_tags.add(tag)
 
     return redirect(all_tags)
 
 
 def tag_unsubscribe(request, tag_name):
     user = _get_user(request)
     tag = get_object_or_404(Tag, name=tag_name)
 
     if tag in user.fav_tags.all():
         user.fav_tags.remove(tag)
 
     return redirect(all_tags)
 
 
 def static_page(request, name):
     context = _init_default_context(request)
     return render(request, 'boards/staticpages/' + name + '.html', context)
 
 
 def _get_theme(request, user=None):
     """Get user's CSS theme"""
 
     if not user:
         user = _get_user(request)
     theme = user.get_setting('theme')
     if not theme:
         theme = neboard.settings.DEFAULT_THEME
 
     return theme
 
 
 def _get_client_ip(request):
     x_forwarded_for = request.META.get('HTTP_X_FORWARDED_FOR')
     if x_forwarded_for:
         ip = x_forwarded_for.split(',')[-1].strip()
     else:
         ip = request.META.get('REMOTE_ADDR')
     return ip
 
 
 def _init_default_context(request):
     """Create context with default values that are used in most views"""
 
     context = RequestContext(request)
 
     user = _get_user(request)
     context['user'] = user
     context['tags'] = user.get_sorted_fav_tags()
     context['theme'] = _get_theme(request, user)
 
     return context
 
 
 def _get_user(request):
     """Get current user from the session"""
 
     session = request.session
     if not 'user_id' in session:
         request.session.save()
 
         md5 = hashlib.md5()
         md5.update(session.session_key)
         new_id = md5.hexdigest()
 
         time_now = timezone.now()
         user = User.objects.create(user_id=new_id, rank=RANK_USER,
                                    registration_time=time_now,
                                    last_access_time=time_now)
 
         session['user_id'] = user.id
     else:
         user = User.objects.get(id=session['user_id'])
         user.last_access_time = timezone.now()
         user.save()
 
     return user
 
 
 def _redirect_to_next(request):
     if 'next' in request.GET:
         next_page = request.GET['next']
         return HttpResponseRedirect(next_page)
     else:
         return redirect(index)