Use transactions only in views that need them

boards/views.py

@@ -1,485 +1,492 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 django.db import transaction
 
 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)
 
 
[e-mail]_on_success
 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)
+	with transaction.commit_on_success():
+	    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']
+	    if form.is_valid():
+		selected_theme = form.cleaned_data['theme']
 
-            user.save_setting('theme', selected_theme)
+		user.save_setting('theme', selected_theme)
 
-            if is_moderator:
-                moderate = form.cleaned_data['moderate']
-                user.save_setting(SETTING_MODERATE, moderate)
+		if is_moderator:
+		    moderate = form.cleaned_data['moderate']
+		    user.save_setting(SETTING_MODERATE, moderate)
 
-            return redirect(settings)
+		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)
 
 
[e-mail]_on_success
 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)
 
 
[e-mail]_on_success
 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)
 
 
[e-mail]_on_success
 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.add_tag(tag)
 
     return _redirect_to_next(request)
 
 
[e-mail]_on_success
 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.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

neboard/settings.py

@@ -1,241 +1,240 b''
 # Django settings for neboard project.
 import os
 from boards.mdx_neboard import markdown_extended
 
 DEBUG = True
 TEMPLATE_DEBUG = DEBUG
 
 ADMINS = (
     # ('Your Name', '[e-mail]'),
     ('admin', '[e-mail]')
 )
 
 MANAGERS = ADMINS
 
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
         'NAME': 'database.db',                      # Or path to database file if using sqlite3.
         'USER': '',                      # Not used with sqlite3.
         'PASSWORD': '',                  # Not used with sqlite3.
         'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
         'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
 	'CONN_MAX_AGE': None,
     }
 }
 
 # Local time zone for this installation. Choices can be found here:
 # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
 # although not all choices may be available on all operating systems.
 # In a Windows environment this must be set to your system time zone.
 TIME_ZONE = 'Europe/Kiev'
 
 # Language code for this installation. All choices can be found here:
 # http://www.i18nguy.com/unicode/language-identifiers.html
 LANGUAGE_CODE = 'en'
 
 SITE_ID = 1
 
 # If you set this to False, Django will make some optimizations so as not
 # to load the internationalization machinery.
 USE_I18N = True
 
 # If you set this to False, Django will not format dates, numbers and
 # calendars according to the current locale.
 USE_L10N = True
 
 # If you set this to False, Django will not use timezone-aware datetimes.
 USE_TZ = True
 
 # Absolute filesystem path to the directory that will hold user-uploaded files.
 # Example: "/home/media/media.lawrence.com/media/"
 MEDIA_ROOT = './media/' 
 
 # URL that handles the media served from MEDIA_ROOT. Make sure to use a
 # trailing slash.
 # Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
 MEDIA_URL = '/media/'
 
 # Absolute path to the directory static files should be collected to.
 # Don't put anything in this directory yourself; store your static files
 # in apps' "static/" subdirectories and in STATICFILES_DIRS.
 # Example: "/home/media/media.lawrence.com/static/"
 STATIC_ROOT = ''
 
 # URL prefix for static files.
 # Example: "http://media.lawrence.com/static/"
 STATIC_URL = '/static/'
 
 # Additional locations of static files
 # It is really a hack, put real paths, not related
 STATICFILES_DIRS = (
     os.path.dirname(__file__) + '/boards/static',
 
 #    '/d/work/python/django/neboard/neboard/boards/static',
     # Put strings here, like "/home/html/static" or "C:/www/django/static".
     # Always use forward slashes, even on Windows.
     # Don't forget to use absolute paths, not relative paths.
 )
 
 # List of finder classes that know how to find static files in
 # various locations.
 STATICFILES_FINDERS = (
     'django.contrib.staticfiles.finders.FileSystemFinder',
     'django.contrib.staticfiles.finders.AppDirectoriesFinder',
 )
 
 if DEBUG:
     STATICFILES_STORAGE = \
         'django.contrib.staticfiles.storage.StaticFilesStorage'
 else:
     STATICFILES_STORAGE = \
         'django.contrib.staticfiles.storage.CachedStaticFilesStorage'
 
 # Make this unique, and don't share it with anybody.
 SECRET_KEY = '@1rc$o(7=tt#kd+4s$u6wchm**z^)4x90)7f6z(i&55@o11*8o'
 
 # List of callables that know how to import templates from various sources.
 TEMPLATE_LOADERS = (
     'django.template.loaders.filesystem.Loader',
     'django.template.loaders.app_directories.Loader',
 )
 
 TEMPLATE_CONTEXT_PROCESSORS = (
     'django.core.context_processors.media',
     'django.core.context_processors.static',
     'django.core.context_processors.request',
     'django.contrib.auth.context_processors.auth',
 )
 
 MIDDLEWARE_CLASSES = (
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.locale.LocaleMiddleware',
     'django.middleware.common.CommonMiddleware',
-    'django.middleware.transaction.TransactionMiddleware',
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'boards.middlewares.BanMiddleware',
 )
 
 ROOT_URLCONF = 'neboard.urls'
 
 # Python dotted path to the WSGI application used by Django's runserver.
 WSGI_APPLICATION = 'neboard.wsgi.application'
 
 TEMPLATE_DIRS = (
     # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
     # Always use forward slashes, even on Windows.
     # Don't forget to use absolute paths, not relative paths.
     'templates',
 )
 
 INSTALLED_APPS = (
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'django.contrib.sessions',
     # 'django.contrib.sites',
     'django.contrib.messages',
     'django.contrib.staticfiles',
     # Uncomment the next line to enable the admin:
      'django.contrib.admin',
     # Uncomment the next line to enable admin documentation:
     # 'django.contrib.admindocs',
     'django.contrib.markup',
     'django.contrib.humanize',
     'django_cleanup',
     'boards',
     'captcha',
     'south',
     'debug_toolbar',
 )
 
 DEBUG_TOOLBAR_PANELS = (
     'debug_toolbar.panels.version.VersionDebugPanel',
     'debug_toolbar.panels.timer.TimerDebugPanel',
     'debug_toolbar.panels.settings_vars.SettingsVarsDebugPanel',
     'debug_toolbar.panels.headers.HeaderDebugPanel',
     'debug_toolbar.panels.request_vars.RequestVarsDebugPanel',
     'debug_toolbar.panels.template.TemplateDebugPanel',
     'debug_toolbar.panels.sql.SQLDebugPanel',
     'debug_toolbar.panels.signals.SignalDebugPanel',
     'debug_toolbar.panels.logger.LoggingPanel',
 )
 
 # TODO: NEED DESIGN FIXES
 CAPTCHA_OUTPUT_FORMAT = (u' %(hidden_field)s '
                          u'<div class="form-label">%(image)s</div>'
                          u'<div class="form-text">%(text_field)s</div>')
 
 # A sample logging configuration. The only tangible logging
 # performed by this configuration is to send an email to
 # the site admins on every HTTP 500 error when DEBUG=False.
 # See http://docs.djangoproject.com/en/dev/topics/logging for
 # more details on how to customize your logging configuration.
 LOGGING = {
     'version': 1,
     'disable_existing_loggers': False,
     'filters': {
         'require_debug_false': {
             '()': 'django.utils.log.RequireDebugFalse'
         }
     },
     'handlers': {
         'mail_admins': {
             'level': 'ERROR',
             'filters': ['require_debug_false'],
             'class': 'django.utils.log.AdminEmailHandler'
         }
     },
     'loggers': {
         'django.request': {
             'handlers': ['mail_admins'],
             'level': 'ERROR',
             'propagate': True,
         },
     }
 }
 
 MARKUP_FIELD_TYPES = (
     ('markdown', markdown_extended),
 )
 # Custom imageboard settings
 # TODO These should me moved to
 MAX_POSTS_PER_THREAD = 10  # Thread bumplimit
 MAX_THREAD_COUNT = 500  # Old threads will be deleted to preserve this count
 THREADS_PER_PAGE = 10
 SITE_NAME = 'Neboard'
 
 THEMES = [
     ('md', 'Mystic Dark'),
     ('md_centered', 'Mystic Dark (centered)'),
     ('sw', 'Snow White'),
     ('pg', 'Photon Gray'),
 ]
 
 DEFAULT_THEME = 'md'
 
 POPULAR_TAGS = 10
 LAST_REPLIES_COUNT = 3
 
 ENABLE_CAPTCHA = False
 # if user tries to post before CAPTCHA_DEFAULT_SAFE_TIME. Captcha will be shown
 CAPTCHA_DEFAULT_SAFE_TIME = 30  # seconds
 POSTING_DELAY = 30  # seconds
 
 
 def custom_show_toolbar(request):
     return DEBUG
 
 DEBUG_TOOLBAR_CONFIG = {
     'INTERCEPT_REDIRECTS': False,
     'SHOW_TOOLBAR_CALLBACK': custom_show_toolbar,
     'HIDE_DJANGO_SQL': False,
     'ENABLE_STACKTRACES': True,
 }
 
 # Debug mode middlewares
 if DEBUG:
     MIDDLEWARE_CLASSES += (
         'boards.profiler.ProfilerMiddleware',
         'debug_toolbar.middleware.DebugToolbarMiddleware',
     )