Cache user's tags

boards/settings.py

@@ -0,0 +1,1 b''
+CACHE_TIMEOUT = 600 # Timeout for caching, if cache is used
  No newline at end of file

boards/models.py

@@ -1,382 +1,403 b''
 import os
 from random import random
 import time
 import math
+from django.core.cache import cache
 
 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 boards import settings as board_settings
 
 from neboard import settings
 import thumbs
 
 import re
 
 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
 
 SETTING_MODERATE = "moderate"
 
 REGEX_REPLY = re.compile('>>(\d+)')
 
 
 class PostManager(models.Manager):
 
     def create_post(self, title, text, image=None, thread=None,
                     ip=NO_IP, tags=None, user=None):
         post = self.create(title=title,
                            text=text,
                            pub_time=timezone.now(),
                            thread=thread,
                            image=image,
                            poster_ip=ip,
                            poster_user_agent=UNKNOWN_UA,
                            last_edit_time=timezone.now(),
                            bump_time=timezone.now(),
                            user=user)
 
         if tags:
             map(post.tags.add, tags)
             for tag in tags:
                 tag.threads.add(post)
 
         if thread:
             thread.replies.add(post)
             thread.bump()
             thread.last_edit_time = timezone.now()
             thread.save()
         else:
             self._delete_old_threads()
 
         self.connect_replies(post)
 
         return post
 
     def delete_post(self, post):
         if post.replies.count() > 0:
             map(self.delete_post, post.replies.all())
 
         # Update thread's last edit time (used as cache key)
         thread = post.thread
         if thread:
             thread.last_edit_time = timezone.now()
             thread.save()
 
         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='-bump_time'):
         if tag:
             threads = tag.threads
 
             if threads.count() == 0:
                 raise Http404
         else:
             threads = self.filter(thread=None)
 
         threads = threads.order_by(order_by)
 
         if page != ALL_PAGES:
             thread_count = threads.count()
 
             if page < self._get_page_count(thread_count):
                 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, thread=None)
         except Post.DoesNotExist:
             raise Http404
 
         if opening_post.replies:
             thread = [opening_post]
             thread.extend(opening_post.replies.all().order_by('pub_time'))
 
             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(thread=None, tags=tag)
         else:
             threads = self.filter(thread=None)
 
         return self._get_page_count(threads.count())
 
     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 = threads.count()
 
         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 connect_replies(self, post):
         """Connect replies to a post to show them as a refmap"""
 
         for reply_number in re.finditer(REGEX_REPLY, post.text.raw):
             id = reply_number.group(1)
             ref_post = self.filter(id=id)
             if ref_post.count() > 0:
                 ref_post[0].referenced_posts.add(post)
 
     def _get_page_count(self, thread_count):
         return int(math.ceil(thread_count / float(settings.THREADS_PER_PAGE)))
 
 
 class TagManager(models.Manager):
 
     def get_not_empty_tags(self):
         tags = self.annotate(Count('threads')) \
             .filter(threads__count__gt=0).order_by('name')
 
         return 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)
     threads = models.ManyToManyField('Post', null=True,
                                      blank=True, related_name='tag+')
     linked = models.ForeignKey('Tag', null=True, blank=True)
 
     def __unicode__(self):
         return self.name
 
     def is_empty(self):
         return self.get_post_count() == 0
 
     def get_post_count(self):
         return self.threads.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
 
     def get_linked_tags(self):
         tag_list = []
         self.get_linked_tags_list(tag_list)
 
         return tag_list
 
     def get_linked_tags_list(self, tag_list=[]):
         """
         Returns the list of tags linked to current. The list can be got
         through returned value or tag_list parameter
         """
 
         linked_tag = self.linked
 
         if linked_tag and not (linked_tag in tag_list):
             tag_list.append(linked_tag)
 
             linked_tag.get_linked_tags_list(tag_list)
 
 
 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()
 
     thread = models.ForeignKey('Post', null=True, default=None)
     tags = models.ManyToManyField(Tag)
     last_edit_time = models.DateTimeField()
     bump_time = models.DateTimeField()
     user = models.ForeignKey('User', null=True, default=None)
 
     replies = models.ManyToManyField('Post', symmetrical=False, null=True,
                                      blank=True, related_name='re+')
     referenced_posts = models.ManyToManyField('Post', symmetrical=False, null=True,
                                      blank=True, related_name='rfp+')
 
     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_reply_count(self):
         return self.replies.count()
 
     def get_images_count(self):
         images_count = 1 if self.image else 0
         images_count += self.replies.filter(image_width__gt=0).count()
 
         return images_count
 
     def can_bump(self):
         """Check if the thread can be bumped by replying"""
 
         post_count = self.get_reply_count() + 1
 
         return post_count <= settings.MAX_POSTS_PER_THREAD
 
     def bump(self):
         """Bump (move to up) thread"""
 
         if self.can_bump():
             self.bump_time = timezone.now()
 
     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.replies.all().order_by('pub_time')[reply_count -
                                                   reply_count_to_show:]
 
                 return last_replies
 
     def get_tags(self):
         """Get a sorted tag list"""
 
         return self.tags.order_by('name')
 
 
 class User(models.Model):
 
     user_id = models.CharField(max_length=50)
     rank = models.IntegerField()
 
     registration_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 = str(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):
+        cache_key = self._get_tag_cache_key()
+        fav_tags = cache.get(cache_key)
+        if fav_tags:
+            return fav_tags
+
         tags = self.fav_tags.annotate(Count('threads'))\
             .filter(threads__count__gt=0).order_by('name')
 
+        if tags:
+            cache.set(cache_key, tags, board_settings.CACHE_TIMEOUT)
+
         return tags
 
     def get_post_count(self):
         return Post.objects.filter(user=self).count()
 
     def __unicode__(self):
         return self.user_id + '(' + str(self.rank) + ')'
 
     def get_last_access_time(self):
         posts = Post.objects.filter(user=self)
         if posts.count() > 0:
             return posts.latest('pub_time').pub_time
 
+    def add_tag(self, tag):
+        self.fav_tags.add(tag)
+        cache.delete(self._get_tag_cache_key())
+
+    def remove_tag(self, tag):
+        self.fav_tags.remove(tag)
+        cache.delete(self._get_tag_cache_key())
+
+    def _get_tag_cache_key(self):
+        return self.user_id + '_tags'
+
 
 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,485 +1,485 b''
 import hashlib
 import string
 from django.core import serializers
 from django.core.urlresolvers import reverse
 from django.http import HttpResponseRedirect
 from django.http.response import HttpResponse
 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, ModeratorSettingsForm
 
 from boards.models import Post, Tag, Ban, User, RANK_USER, SETTING_MODERATE, \
     REGEX_REPLY
 from boards import authors
 from boards.utils import get_client_ip
 import neboard
 import re
 
 
 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)
         if form.need_to_ban:
             # Ban user because he is suspected to be a bot
             _ban_current_user(request)
     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(),
             'last_replies': thread.get_last_replies(),
         })
 
     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).exists()
 
     if is_banned:
         return redirect(you_are_banned)
 
     data = form.cleaned_data
 
     title = data['title']
     text = data['text']
 
     text = _remove_invalid_links(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 = string.lower(tag_name.strip())
                 if len(tag_name) > 0:
                     tag, created = Tag.objects.get_or_create(name=tag_name)
                     tags.append(tag)
 
                     linked_tags = tag.get_linked_tags()
                     if len(linked_tags) > 0:
                         tags.extend(linked_tags)
 
     op = None if thread_id == boards.models.NO_PARENT else \
         get_object_or_404(Post, id=thread_id)
     post = Post.objects.create_post(title=title, text=text, ip=ip,
                                     thread=op, image=image,
                                     tags=tags, user=_get_user(request))
 
     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. Threads are split in pages, so some page is
     requested. Default page is 0.
     """
 
     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(),
             'last_replies': thread.get_last_replies(),
         })
 
     if request.method == 'POST':
         form = ThreadForm(request.POST, request.FILES,
                           error_class=PlainErrorList)
         form.session = request.session
 
         if form.is_valid():
             return _new_post(request, form)
         if form.need_to_ban:
             # Ban user because he is suspected to be a bot
             _ban_current_user(request)
     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
     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)
         if form.need_to_ban:
             # Ban user because he is suspected to be a bot
             _ban_current_user(request)
     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()
     if context['bumpable']:
         context['posts_left'] = neboard.settings.MAX_POSTS_PER_THREAD - len(
             posts)
         context['bumplimit_progress'] = str(
             float(context['posts_left']) /
             neboard.settings.MAX_POSTS_PER_THREAD * 100)
 
     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)
         form.session = request.session
 
         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)
     user = _get_user(request)
     is_moderator = user.is_moderator()
 
     if request.method == 'POST':
         if is_moderator:
             form = ModeratorSettingsForm(request.POST,
                                          error_class=PlainErrorList)
         else:
             form = SettingsForm(request.POST, error_class=PlainErrorList)
 
         if form.is_valid():
             selected_theme = form.cleaned_data['theme']
 
             user.save_setting('theme', selected_theme)
 
             if is_moderator:
                 moderate = form.cleaned_data['moderate']
                 user.save_setting(SETTING_MODERATE, moderate)
 
             return redirect(settings)
     else:
         selected_theme = _get_theme(request)
 
         if is_moderator:
             form = ModeratorSettingsForm(initial={'theme': selected_theme,
                                          'moderate': context['moderator']},
                                          error_class=PlainErrorList)
         else:
             form = SettingsForm(initial={'theme': selected_theme},
                                 error_class=PlainErrorList)
 
     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 not post.thread:
         return redirect(thread, post_id=post.id)
     else:
         return redirect(reverse(thread, kwargs={'post_id': post.thread.id})
                         + '#' + str(post.id))
 
 
 def authors(request):
     """Show authors list"""
 
     context = _init_default_context(request)
     context['authors'] = boards.authors.authors
 
     return render(request, 'boards/authors.html', context)
 
 
 def delete(request, post_id):
     """Delete post"""
 
     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 not post.thread:
         return _redirect_to_next(request)
     else:
         return redirect(thread, post_id=post.thread.id)
 
 
 def ban(request, post_id):
     """Ban user"""
 
     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):
     """Show the page that notifies that user is banned"""
 
     context = _init_default_context(request)
     return render(request, 'boards/staticpages/banned.html', context)
 
 
 def page_404(request):
     """Show page 404 (not found error)"""
 
     context = _init_default_context(request)
     return render(request, 'boards/404.html', context)
 
 
 def tag_subscribe(request, tag_name):
     """Add tag to favorites"""
 
     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)
+        user.add_tag(tag)
 
     return _redirect_to_next(request)
 
 
 def tag_unsubscribe(request, tag_name):
     """Remove tag from favorites"""
 
     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)
+        user.remove_tag(tag)
 
     return _redirect_to_next(request)
 
 
 def static_page(request, name):
     """Show a static page that needs only tags list and a CSS"""
 
     context = _init_default_context(request)
     return render(request, 'boards/staticpages/' + name + '.html', context)
 
 
 def api_get_post(request, post_id):
     """
     Get the JSON of a post. This can be
     used as and API for external clients.
     """
 
     post = get_object_or_404(Post, id=post_id)
 
     json = serializers.serialize("json", [post], fields=(
         "pub_time", "_text_rendered", "title", "text", "image",
         "image_width", "image_height", "replies", "tags"
     ))
 
     return HttpResponse(content=json)
 
 
 def get_post(request, post_id):
     """Get the html of a post. Used for popups."""
 
     post = get_object_or_404(Post, id=post_id)
 
     context = RequestContext(request)
     context["post"] = post
 
     return render(request, 'boards/post.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 _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()
 
     theme = _get_theme(request, user)
     context['theme'] = theme
     context['theme_css'] = 'css/' + theme + '/base_page.css'
 
     # This shows the moderator panel
     moderate = user.get_setting(SETTING_MODERATE)
     if moderate == 'True':
         context['moderator'] = user.is_moderator()
     else:
         context['moderator'] = False
 
     return context
 
 
 def _get_user(request):
     """
     Get current user from the session. If the user does not exist, create
     a new one.
     """
 
     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)
 
         session['user_id'] = user.id
     else:
         user = User.objects.get(id=session['user_id'])
 
     return user
 
 
 def _redirect_to_next(request):
     """
     If a 'next' parameter was specified, redirect to the next page. This is
     used when the user is required to return to some page after the current
     view has finished its work.
     """
 
     if 'next' in request.GET:
         next_page = request.GET['next']
         return HttpResponseRedirect(next_page)
     else:
         return redirect(index)
 
 
 def _ban_current_user(request):
     """Add current user to the IP ban list"""
 
     ip = utils.get_client_ip(request)
     Ban.objects.get_or_create(ip=ip)
 
 
 def _remove_invalid_links(text):
     """
     Replace invalid links in posts so that they won't be parsed.
     Invalid links are links to non-existent posts
     """
 
     for reply_number in re.finditer(REGEX_REPLY, text):
         post_id = reply_number.group(1)
         post = Post.objects.filter(id=post_id)
         if not post.exists():
             text = string.replace(text, '>>' + id, id)
 
     return text