46 |
47 | or
48 |
Cancel
49 |
50 | {% endblock %}
--------------------------------------------------------------------------------
/forum/templates/forum/add_topic.html:
--------------------------------------------------------------------------------
1 | {% extends "forum/base.html" %}{% load forum_tags %}
2 | {% block extrahead %}
3 | {{ block.super }}
4 |
5 | {% endblock %}
6 | {% block breadcrumbs %}
7 |
Forums
8 | »
{{ section.name }}
9 | »
{{ forum.name }}
10 | »
Add Topic
11 | {% endblock %}
12 | {% block main_content %}
13 | {% if preview %}
14 |
15 |
Topic Preview
16 |
17 | {{ preview|safe }}
18 |
19 |
20 | {% endif %}
21 |
61 | {% endblock %}
--------------------------------------------------------------------------------
/forum/templates/forum/search.html:
--------------------------------------------------------------------------------
1 | {% extends "forum/base.html" %}
2 | {% block main_content %}
3 |
68 | {% endblock %}
--------------------------------------------------------------------------------
/forum/templates/forum/new_posts.html:
--------------------------------------------------------------------------------
1 | {% extends "forum/base.html" %}{% load forum_tags %}{% load humanize %}
2 | {% block extrahead %}
3 | {% if is_paginated %}{% endif %}
4 | {{ block.super }}
5 | {% endblock %}
6 | {% block main_content %}
7 |
Topics with new posts in the last 14 days.
8 | {% if is_paginated %}
9 |
12 | {% endif %}
13 |
14 |
{{ title }}
15 | {% if topic_list %}
16 | {% if redis %}
17 | {% add_view_counts topic_list %}
18 | {% add_last_read_times topic_list user %}
19 | {% endif %}
20 |
58 | {% else %}
59 |
60 | No posts found.
61 |
62 | {% endif %}
63 |
64 | {% if is_paginated %}
65 |
68 | {% endif %}
69 | {% endblock %}
--------------------------------------------------------------------------------
/forum/templates/forum/user_topics.html:
--------------------------------------------------------------------------------
1 | {% extends "forum/base.html" %}{% load forum_tags %}{% load humanize %}
2 | {% block extrahead %}
3 | {{ block.super }}
4 | {% if is_paginated %}{% endif %}
5 | {% endblock %}
6 | {% block breadcrumbs %}
7 |
Forums
8 | »
Forum Profile for {{ forum_user.username }}
9 | »
{{ title }}
10 | {% endblock %}
11 | {% block main_content %}
12 | {% if is_paginated %}
13 |
16 | {% endif %}
17 |
18 |
{{ title }}
19 | {% if topic_list %}
20 | {% if redis %}
21 | {% add_view_counts topic_list %}
22 | {% add_last_read_times topic_list user %}
23 | {% endif %}
24 |
62 | {% else %}
63 |
64 | This user has not started any Topics yet.
65 |
66 | {% endif %}
67 |
68 | {% if is_paginated %}
69 |
72 | {% endif %}
73 | {% endblock %}
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | from distutils.core import setup
2 | from distutils.command.install_data import install_data
3 | from distutils.command.install import INSTALL_SCHEMES
4 | import os
5 | import sys
6 |
7 | class osx_install_data(install_data):
8 | # On MacOS, the platform-specific lib dir is /System/Library/Framework/Python/.../
9 | # which is wrong. Python 2.5 supplied with MacOS 10.5 has an Apple-specific fix
10 | # for this in distutils.command.install_data#306. It fixes install_lib but not
11 | # install_data, which is why we roll our own install_data class.
12 |
13 | def finalize_options(self):
14 | # By the time finalize_options is called, install.install_lib is set to the
15 | # fixed directory, so we set the installdir to install_lib. The
16 | # install_data class uses ('install_data', 'install_dir') instead.
17 | self.set_undefined_options('install', ('install_lib', 'install_dir'))
18 | install_data.finalize_options(self)
19 |
20 | if sys.platform == "darwin":
21 | cmdclasses = {'install_data': osx_install_data}
22 | else:
23 | cmdclasses = {'install_data': install_data}
24 |
25 | def fullsplit(path, result=None):
26 | """
27 | Split a pathname into components (the opposite of os.path.join) in a
28 | platform-neutral way.
29 | """
30 | if result is None:
31 | result = []
32 | head, tail = os.path.split(path)
33 | if head == '':
34 | return [tail] + result
35 | if head == path:
36 | return result
37 | return fullsplit(head, [tail] + result)
38 |
39 | # Tell distutils to put the data_files in platform-specific installation
40 | # locations. See here for an explanation:
41 | # http://groups.google.com/group/comp.lang.python/browse_thread/thread/35ec7b2fed36eaec/2105ee4d9e8042cb
42 | for scheme in INSTALL_SCHEMES.values():
43 | scheme['data'] = scheme['purelib']
44 |
45 | # Compile the list of packages available, because distutils doesn't have
46 | # an easy way to do this.
47 | packages, data_files = [], []
48 | root_dir = os.path.dirname(__file__)
49 | if root_dir != '':
50 | os.chdir(root_dir)
51 | app_dir = 'forum'
52 |
53 | for dirpath, dirnames, filenames in os.walk(app_dir):
54 | # Ignore dirnames that start with '.'
55 | for i, dirname in enumerate(dirnames):
56 | if dirname.startswith('.'): del dirnames[i]
57 | if '__init__.py' in filenames:
58 | packages.append('.'.join(fullsplit(dirpath)))
59 | elif filenames:
60 | data_files.append([dirpath, [os.path.join(dirpath, f) for f in filenames]])
61 |
62 | # Small hack for working with bdist_wininst.
63 | # See http://mail.python.org/pipermail/distutils-sig/2004-August/004134.html
64 | if len(sys.argv) > 1 and sys.argv[1] == 'bdist_wininst':
65 | for file_info in data_files:
66 | file_info[0] = '\\PURELIB\\%s' % file_info[0]
67 |
68 | # Dynamically calculate the version based on forum.VERSION.
69 | version = __import__('forum').get_version()
70 |
71 | setup(
72 | name = 'forum',
73 | version = version.replace(' ', '-'),
74 | author = 'Jonathan Buchanan',
75 | author_email = 'jonathan.buchanan@gmail.com',
76 | url = 'http://github.com/insin/forum/',
77 | packages = packages,
78 | cmdclass = cmdclasses,
79 | data_files = data_files
80 | )
81 |
--------------------------------------------------------------------------------
/forum/admin.py:
--------------------------------------------------------------------------------
1 | from django.contrib import admin
2 |
3 | from forum.models import ForumProfile, Section, Forum, Topic, Post, Search
4 |
5 | DENORMALISED_DATA_NOTICE = 'You shouldn\'t need to edit this data manually.'
6 |
7 | class ForumProfileAdmin(admin.ModelAdmin):
8 | list_display = ('user', 'group', 'title', 'location',
9 | 'post_count')
10 | list_filter = ('group',)
11 | fieldsets = (
12 | (None, {
13 | 'fields': ('user', 'group', 'title', 'location', 'avatar',
14 | 'website'),
15 | }),
16 | ('Board settings', {
17 | 'fields': ('timezone', 'topics_per_page', 'posts_per_page',
18 | 'auto_fast_reply'),
19 | }),
20 | ('Denormalised data', {
21 | 'classes': ('collapse',),
22 | 'description': DENORMALISED_DATA_NOTICE,
23 | 'fields': ('post_count',),
24 | }),
25 | )
26 |
27 | class SectionAdmin(admin.ModelAdmin):
28 | list_display = ('name', 'order')
29 |
30 | class ForumAdmin(admin.ModelAdmin):
31 | list_display = ('name', 'section', 'description', 'order',
32 | 'topic_count', 'locked', 'hidden')
33 | list_filter = ('section',)
34 | fieldsets = (
35 | (None, {
36 | 'fields': ('name', 'section', 'description', 'order'),
37 | }),
38 | ('Administration', {
39 | 'fields': ('locked', 'hidden'),
40 | }),
41 | ('Denormalised data', {
42 | 'classes': ('collapse',),
43 | 'description': DENORMALISED_DATA_NOTICE,
44 | 'fields': ('topic_count', 'last_post_at', 'last_topic_id',
45 | 'last_topic_title','last_user_id', 'last_username'),
46 | }),
47 | )
48 | search_fields = ('name',)
49 |
50 | class TopicAdmin(admin.ModelAdmin):
51 | list_display = ('title', 'forum', 'user', 'started_at', 'post_count',
52 | 'metapost_count', 'last_post_at', 'locked', 'pinned',
53 | 'hidden')
54 | list_filter = ('forum', 'locked', 'pinned', 'hidden')
55 | fieldsets = (
56 | (None, {
57 | 'fields': ('title', 'forum', 'user', 'description'),
58 | }),
59 | ('Administration', {
60 | 'fields': ('pinned', 'locked', 'hidden'),
61 | }),
62 | ('Denormalised data', {
63 | 'classes': ('collapse',),
64 | 'description': DENORMALISED_DATA_NOTICE,
65 | 'fields': ('post_count', 'metapost_count', 'last_post_at',
66 | 'last_user_id', 'last_username'),
67 | }),
68 | )
69 | search_fields = ('title',)
70 |
71 | class PostAdmin(admin.ModelAdmin):
72 | list_display = ('__unicode__', 'user', 'topic', 'meta', 'posted_at',
73 | 'edited_at', 'user_ip')
74 | list_filter = ('meta',)
75 | fieldsets = (
76 | (None, {
77 | 'fields': ('user', 'topic', 'body', 'meta', 'emoticons'),
78 | }),
79 | ('Denormalised data', {
80 | 'classes': ('collapse',),
81 | 'description': DENORMALISED_DATA_NOTICE,
82 | 'fields': ('num_in_topic',),
83 | }),
84 | )
85 | search_fields = ('body',)
86 |
87 | class SearchAdmin(admin.ModelAdmin):
88 | list_display = ('type', 'user', 'searched_at')
89 | list_filter = ('type',)
90 |
91 | admin.site.register(ForumProfile, ForumProfileAdmin)
92 | admin.site.register(Section, SectionAdmin)
93 | admin.site.register(Forum, ForumAdmin)
94 | admin.site.register(Topic, TopicAdmin)
95 | admin.site.register(Post, PostAdmin)
96 | admin.site.register(Search, SearchAdmin)
97 |
--------------------------------------------------------------------------------
/TODO.txt:
--------------------------------------------------------------------------------
1 | ======================
2 | Django Forum TODO List
3 | ======================
4 |
5 | :author: Jonathan Buchanan
6 |
7 | Top Priority
8 | ============
9 |
10 | *Dirty hacks and other broken windows.*
11 |
12 | Make It So, Number One
13 | ======================
14 |
15 | *Features, fixes and tasks which are ready to be implementated or performed as
16 | and when the time can be found.*
17 |
18 | - Non-standalone mode issues which will need to be resolved:
19 |
20 | - Provide a means of performing certain URL lookups based on whether we're in
21 | standalone mode or not. There's already a ``LOGIN_URL`` setting which we
22 | could use instead of django-registration's ``auth_login`` named URL, but
23 | what about the logout and register URLs?
24 | - I imagine it will be likely that the forum's standalone password
25 | change/reset forms will be used in favour of the admin application's any
26 | time a project is using the application directory template loader (as we
27 | require it to) - it might be necessary to add moving of the standalone
28 | registration templates into the ``/forum/templates/`` directory as one of
29 | the installation steps for using the forum in standalone mode.
30 |
31 | - Create full help templates for the provided post formatters.
32 | - Give the BBCode formatter some love - we're currently using the default set of
33 | tags it provides. Decide which we really need, which are missing and implement
34 | them if need be.
35 | - Post control for moderators - move post to another topic, merge all posts from
36 | one topic into another.
37 | - User control for moderators.
38 |
39 | *Testing.*
40 |
41 | - Write test client tests.
42 | - Testing in non-standalone mode - create a project which itself uses
43 | django-registration to ensure that the forum's set of templates don't take
44 | precedence. If the order of ``INSTALLED_APPS`` is important in this case,
45 | document it in the installation docs.
46 |
47 | For Future Consideration
48 | ========================
49 |
50 | *Features which require a bit more consideration - as in does the application
51 | really need the added complexity they bring? It has a fairly simple structure
52 | at the moment.*
53 |
54 | *Boring stuff which most forums have:*
55 |
56 | - Subforums.
57 | - Tracking which posts were replied to / using this information to offer a
58 | threaded topic view.
59 | - Poll topics.
60 |
61 | *Possibly less boring stuff:*
62 |
63 | - Up/down voting *everywhere*, starting with users, topics and posts, each of
64 | which should have a configurable lower boundary in user profiles, scores under
65 | which would result in topics, posts or everything from given users being
66 | hidden. Let consensus be your ignore list, if you're mad enough.
67 | - Forum Types, which could affect how everything in a particular forum works.
68 | Examples:
69 |
70 | - Help Forums could have the initial post in each topic displayed on every
71 | page, with some kind of kudos point system in place, where topic starters
72 | can award points for useful answers. Uses of kudos points:
73 |
74 | 1. Total points earned could be displayed in place of Postcounts in user
75 | profiles, and they would actually *mean* something.
76 | 2. An option to view only the starting post and posts which got kudos points
77 | if you just want to see what the useful answers were.
78 |
79 | - Progressive enhancement with JavaScript:
80 |
81 | - Hijack topic and forum pagination.
82 | - Hijack posting of new replies to work on the same page.
83 | - Periodic fetching of new posts when on the last page of a topic.
84 | - Adding a new control to edit replies in place, with preview.
85 |
--------------------------------------------------------------------------------
/forum/moderation.py:
--------------------------------------------------------------------------------
1 | """
2 | Functions which perform moderation tasks - this can involve making
3 | multiple, complex changes to the items being moderated.
4 | """
5 | from forum.models import Post
6 |
7 | def _update_num_in_topic(post, topic):
8 | """
9 | Updates the ``num_in_topic`` field for Posts in the given Topic
10 | affected by the given Post having its ``meta`` flag changed.
11 | """
12 | # Decrement num_in_topic for the post's current meta type
13 | Post.objects.update_num_in_topic(topic, post.num_in_topic, increment=False,
14 | meta=not post.meta)
15 | try:
16 | # Find the first prior post of the new meta type by post time -
17 | # fall back on id if times are equal.
18 | previous_post = \
19 | (topic.posts.filter(meta=post.meta, posted_at__lt=post.posted_at) | \
20 | topic.posts.filter(meta=post.meta, posted_at=post.posted_at, pk__lt=post.pk)) \
21 | .order_by('-posted_at', '-id')[0]
22 | post.num_in_topic = previous_post.num_in_topic + 1
23 | increment_from = previous_post.num_in_topic
24 | except IndexError:
25 | # There is no existing, earlier post - make this the first
26 | post.num_in_topic = 1
27 | increment_from = 0
28 | # Increment num_in_topic for the post's new meta type
29 | Post.objects.update_num_in_topic(topic, increment_from, increment=True,
30 | meta=post.meta)
31 | # Save the post to update its meta and num_in_topic attributes
32 | post.save()
33 |
34 | def make_post_not_meta(post, topic, forum):
35 | """
36 | Performs changes required to turn a metapost into a regular post.
37 | """
38 | # If this becomes the new last post in its topic, the topic will need
39 | # its last post details updated.
40 | is_last_in_topic = False
41 | if post.posted_at > topic.last_post_at:
42 | is_last_in_topic = True
43 | # If this becomes the new last post in its forum, the forum will need
44 | # its last post details updated.
45 | is_last_in_forum = False
46 | if post.posted_at > forum.last_post_at:
47 | is_last_in_forum = True
48 | # Update num_in_topic for all affected posts
49 | _update_num_in_topic(post, topic)
50 | # Make any changes required to the topic and forum
51 | if is_last_in_topic:
52 | topic.set_last_post(post)
53 | else:
54 | topic.update_post_count(meta=False)
55 | topic.update_post_count(meta=True)
56 | if is_last_in_forum:
57 | forum.set_last_post(post)
58 |
59 | def make_post_meta(post, topic, forum):
60 | """
61 | Performs changes required to turn a regular post into a metapost.
62 | """
63 | # If this was the last post in its topic, the topic will need its
64 | # last post details updated.
65 | was_last_in_topic = False
66 | if topic.last_post_at == post.posted_at and \
67 | topic.last_user_id == post.user_id:
68 | was_last_in_topic = True
69 | # If this was the last post in its forum, the forum will need its
70 | # latest post details updated.
71 | was_last_in_forum = False
72 | if forum.last_topic_id == topic.pk and \
73 | forum.last_post_at == post.posted_at and \
74 | forum.last_user_id == post.user_id:
75 | was_last_in_forum = True
76 | # Update num_in_topic for all affected posts
77 | _update_num_in_topic(post, topic)
78 | # Make any changes required to the topic and forum
79 | if was_last_in_topic:
80 | topic.set_last_post()
81 | else:
82 | topic.update_post_count(meta=False)
83 | topic.update_post_count(meta=True)
84 | if was_last_in_forum:
85 | forum.set_last_post()
86 |
--------------------------------------------------------------------------------
/forum/redis_connection.py:
--------------------------------------------------------------------------------
1 | """
2 | Connection and forum API for real-time tracking using Redis.
3 | """
4 | import datetime
5 | import time
6 |
7 | from django.core import signals
8 | from django.utils.html import escape
9 |
10 | import redis
11 | from forum import app_settings
12 |
13 | r = redis.StrictRedis(app_settings.REDIS_HOST,
14 | app_settings.REDIS_PORT,
15 | app_settings.REDIS_DB)
16 |
17 | TOPIC_ViEWS = 't:%s:v'
18 | TOPIC_TRACKER = 'u:%s:t:%s'
19 | ACTIVE_USERS = 'au'
20 | USER_USERNAME = 'u:%s:un'
21 | USER_LAST_SEEN = 'u:%s:s'
22 | USER_DOING = 'u:%s:d'
23 |
24 | def increment_view_count(topic):
25 | """Increments the view count for a Topic."""
26 | r.incr(TOPIC_ViEWS % topic.pk)
27 |
28 | def get_view_counts(topic_ids):
29 | """Yields viewcounts for the given Topics."""
30 | for view_count in r.mget([TOPIC_ViEWS % id for id in topic_ids]):
31 | if view_count:
32 | yield int(view_count)
33 | else:
34 | yield 0
35 |
36 | def update_last_read_time(user, topic):
37 | """
38 | Sets the last read time for a User in the given Topic, expiring in a
39 | fortnight.
40 | """
41 | key = TOPIC_TRACKER % (user.pk, topic.pk)
42 | last_read = datetime.datetime.now()
43 | expire_at = last_read + datetime.timedelta(days=14)
44 | r.set(key, int(time.mktime(last_read.timetuple())))
45 | r.expireat(key, int(time.mktime(expire_at.timetuple())))
46 |
47 | def get_last_read_time(user, topic_id):
48 | """Gets the last read time for a User in the given Topic."""
49 | last_read = r.get(TOPIC_TRACKER % (user.pk, topic_id))
50 | if last_read:
51 | return datetime.datetime.fromtimestamp(int(last_read))
52 | return None
53 |
54 | def get_last_read_times(user, topics):
55 | """Gets last read times for a User in the given Topics."""
56 | for last_read in r.mget([TOPIC_TRACKER % (user.pk, t.pk)
57 | for t in topics]):
58 | if last_read:
59 | yield datetime.datetime.fromtimestamp(int(last_read))
60 | else:
61 | yield None
62 |
63 | def seen_user(user, doing, item=None):
64 | """
65 | Stores what a User was doing when they were last seen and updates
66 | their last seen time in the active users sorted set.
67 | """
68 | last_seen = int(time.mktime(datetime.datetime.now().timetuple()))
69 | r.zadd(ACTIVE_USERS, last_seen, user.pk)
70 | r.setnx(USER_USERNAME % user.pk, user.username)
71 | r.set(USER_LAST_SEEN % user.pk, last_seen)
72 | if item:
73 | doing = '%s
%s ' % (
74 | doing, item.get_absolute_url(), escape(str(item)))
75 | r.set(USER_DOING % user.pk, doing)
76 |
77 | def get_active_users(minutes_ago=30):
78 | """
79 | Yields active Users in the last ``minutes_ago`` minutes, returning
80 | 2-tuples of (user_detail_dict, last_seen_time) in most-to-least recent
81 | order by time.
82 | """
83 | since = datetime.datetime.now() - datetime.timedelta(minutes=minutes_ago)
84 | since_time = int(time.mktime(since.timetuple()))
85 | for user_id, last_seen in reversed(r.zrangebyscore(ACTIVE_USERS, since_time,
86 | 'inf', withscores=True)):
87 | yield (
88 | {'id': int(user_id), 'username': r.get(USER_USERNAME % user_id)},
89 | datetime.datetime.fromtimestamp(int(last_seen)),
90 | )
91 |
92 | def get_last_seen(user):
93 | """
94 | Returns a 2-tuple of (last_seen, doing), where doing may contain HTML
95 | linking to the relevant place.
96 | """
97 | last_seen = r.get(USER_LAST_SEEN % user.pk)
98 | if last_seen:
99 | last_seen = datetime.datetime.fromtimestamp(int(last_seen))
100 | else:
101 | last_seen = user.date_joined
102 | doing = r.get(USER_DOING % user.pk)
103 | return last_seen, doing
104 |
--------------------------------------------------------------------------------
/forum/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls.defaults import *
2 | from django.conf import settings
3 |
4 | from forum import app_settings
5 |
6 | urlpatterns = patterns('forum.views',
7 | url(r'^$', 'forum_index', name='forum_index'),
8 | url(r'^search/$', 'search', name='forum_search'),
9 | url(r'^search_results/(?P
\d+)/$', 'search_results', name='forum_search_results'),
10 | url(r'^new_posts/$', 'new_posts', name='forum_new_posts'),
11 | url(r'^stalk_users/$', 'stalk_users', name='forum_stalk_users'),
12 | url(r'^add_section/$', 'add_section', name='forum_add_section'),
13 | url(r'^section/(?P\d+)/$', 'section_detail', name='forum_section_detail'),
14 | url(r'^section/(?P\d+)/edit/$', 'edit_section', name='forum_edit_section'),
15 | url(r'^section/(?P\d+)/delete/$', 'delete_section', name='forum_delete_section'),
16 | url(r'^section/(?P\d+)/add_forum/$', 'add_forum', name='forum_add_forum'),
17 | url(r'^forum/(?P\d+)/$', 'forum_detail', name='forum_forum_detail'),
18 | url(r'^forum/(?P\d+)/edit/$', 'edit_forum', name='forum_edit_forum'),
19 | url(r'^forum/(?P\d+)/delete/$', 'delete_forum', name='forum_delete_forum'),
20 | url(r'^forum/(?P\d+)/add_topic/$', 'add_topic', name='forum_add_topic'),
21 | url(r'^topic/(?P\d+)/$', 'topic_detail', {'meta': False}, name='forum_topic_detail'),
22 | url(r'^topic/(?P\d+)/edit/$', 'edit_topic', name='forum_edit_topic'),
23 | url(r'^topic/(?P\d+)/reply/$', 'add_reply', {'meta': False}, name='forum_add_reply'),
24 | url(r'^topic/(?P\d+)/last_post/$', 'redirect_to_last_post', name='forum_redirect_to_last_post'),
25 | url(r'^topic/(?P\d+)/unread_post/$', 'redirect_to_unread_post', name='forum_redirect_to_unread_post'),
26 | url(r'^topic/(?P\d+)/delete/$', 'delete_topic', name='forum_delete_topic'),
27 | url(r'^topic/(?P\d+)/meta/$', 'topic_detail', {'meta': True}, name='forum_topic_meta_detail'),
28 | url(r'^topic/(?P\d+)/meta/reply/$', 'add_reply', {'meta': True}, name='forum_add_meta_reply'),
29 | url(r'^topic/(?P\d+)/summary/$', 'topic_post_summary', name='forum_topic_post_summary'),
30 | url(r'^post/(?P\d+)/$', 'redirect_to_post', name='forum_redirect_to_post'),
31 | url(r'^post/(?P\d+)/edit/$', 'edit_post', name='forum_edit_post'),
32 | url(r'^post/(?P\d+)/quote/$', 'quote_post', name='forum_quote_post'),
33 | url(r'^post/(?P\d+)/delete/$', 'delete_post', name='forum_delete_post'),
34 | url(r'^user/(?P\d+)/$', 'user_profile', name='forum_user_profile'),
35 | url(r'^user/(?P\d+)/topics/$', 'user_topics', name='forum_user_topics'),
36 | url(r'^user/(?P\d+)/edit_profile/$', 'edit_user_forum_profile', name='forum_edit_user_forum_profile'),
37 | url(r'^user/edit_forum_settings/$', 'edit_user_forum_settings', name='forum_edit_user_forum_settings'),
38 | )
39 |
40 | if app_settings.STANDALONE:
41 | from django.contrib import admin
42 | admin.autodiscover()
43 | urlpatterns += patterns('',
44 | (r'^accounts/', include('registration.backends.default.urls')),
45 | (r'^admin/', include(admin.site.urls)),
46 | )
47 |
48 |
--------------------------------------------------------------------------------
/forum/static/forum/css/style.css:
--------------------------------------------------------------------------------
1 | body { font-family: "Lucida Grande", Tahoma, Arial, Verdana, sans-serif; font-size: 12px; margin: 0; padding: 1em; background-color: #fff; color: #000; }
2 | a img { border: none; }
3 | blockquote { border-left: 2px solid #595979; margin-left: 1em; padding-left: 6px; }
4 | img { vertical-align: text-bottom; }
5 | .clickable { cursor: pointer; }
6 |
7 | /* Tables */
8 | table { border-collapse: collapse; width: 100%; }
9 | td, th { padding: 4px 6px; border: 1px solid #999; text-align: left; }
10 | th { font-weight: bold; }
11 | td p.description { margin: 4px 0 0 0; }
12 | td.icon, td.posts, td.views { text-align: center; }
13 | td.last-post { white-space: nowrap; }
14 | th.forum-topics { text-align: center; }
15 | a.unread { margin-right: 4px; }
16 | a.unread img { vertical-align: middle; }
17 |
18 | /* Common formatting */
19 | .odd { background-color: #e9e9f9; }
20 | .even { background-color: #e3e3f3; }
21 | .module { border: 1px solid #ccc; margin-bottom: 1em; background-color: #fff; }
22 | .module-body { padding: 4px 8px; }
23 | .no-margin { margin: 0; }
24 | .module h2, .module caption { overflow: hidden; margin: 0; padding: 2px 8px 3px 8px; font-size: 1em; text-align: left; font-weight: bold; background: #595979 url("../img/module-bg.gif") top left repeat-x; color: #fff; border-bottom: 0; }
25 | .module h2 a { color: #fff; }
26 | .module h2 span.title { float: left; }
27 | .module h2 span.controls { float: right; }
28 | .module h2 span.controls a { color: #ff0; }
29 | .module h2 span.separator { display: none; }
30 | .module h3 { margin: 0 0 8px 0; }
31 | .module h3 span { font-weight: normal; }
32 | .module p.message { text-align: center; margin: 1em; }
33 | .clear { clear: both; }
34 |
35 | /* Navigation elements */
36 | #userbar { padding: 4px 6px; overflow: hidden; border: 1px solid #ccc; background: #e9e9f9 url("../img/module-bg.gif") top left repeat-x; }
37 | #authenticated { float: left; }
38 | #authenticated a.user { font-weight: bold; }
39 | #user-tools { float: right; }
40 | #breadcrumbs { padding: 6px 0; }
41 | p.description { font-style: italic; }
42 |
43 | div.tools { overflow: hidden; padding: 4px 0; }
44 | div.tools .actions { float: right; }
45 | div.paginator { float: left; }
46 |
47 | h1 { margin: .25em 0 .5em 0; }
48 |
49 | /* Posts */
50 | div.post { overflow: hidden; padding: 0 10px; }
51 | div.postbody { float: left; width: 76%; clear: both; padding-top: 6px; }
52 | div.postbody ul.post-actions { float: right; margin: 0; padding: 0; }
53 | div.postbody ul.post-actions li { list-style-type: none; float: left; margin-left: 10px; }
54 | p.author { margin: 0 0 .5em 0; }
55 | div.profile { border-left: 1px solid #fff; float: right; width: 22%; margin: 8px 0; }
56 | div.profile dl { margin-top: 0; margin-bottom: 0; }
57 | div.profile dd, div.profile dt { margin-left: 8px; }
58 | div.profile dd.postcount { margin-top: 1em; }
59 |
60 | /* Forms */
61 | fieldset { padding: 0; margin-left: 0; margin-right: 0; }
62 | .form-row { height: 100%; overflow: hidden; padding: 8px 12px; border-bottom: 1px solid #eee; border-right: 1px solid #eee; }
63 | .form-row img, .form-row input { vertical-align: middle; }
64 | .aligned label { padding: 0 1em 3px 0; float: left; width: 9em; }
65 | .checkbox-row label, label.checkbox, .radio-list label { pading: 0 0 3px 0; float: none; width: auto; }
66 | .radio-list ul { list-style-type: none; margin: 0; padding: 0; }
67 | .radio-list li { padding: 4px 0; margin: 0; }
68 | .form-field { float: left; }
69 | .avatar-field input, .avatar-field img { vertical-align: top; }
70 | .post-preview .body { padding: 0 12px; }
71 | #fast-reply { width: 70%; margin: 1em auto 0 auto; }
72 | .fast-reply-field { padding: 8px 12px; }
73 | .fast-reply-field textarea { width: 98.5%; margin: 0; padding: 3px; }
74 | #fast-reply .buttons { text-align: center; }
75 | #fast-reply .checkbox-row { text-align: center; padding-top: 0; }
76 | .post-body-field { margin-right: 1em; margin-bottom: .5em; }
77 | .quick-help { float: left; }
78 | .quick-help table { width: auto; }
79 | .quick-help ul, .quick-help li { margin: 0 0 0 1em; padding: 0; }
80 | .quick-help blockquote { margin: 0 0 0 2em; }
81 | .emoticon-help { float: left; }
82 | .emoticon-help table { width: auto; }
83 | .emoticon-help th, .emoticon-help td { text-align: center; }
84 | ul.errorlist { margin: 0; padding: 0; }
85 | ul.errorlist li { padding: 4px 8px 4px 25px; margin: 0 0 8px 0; border: 1px solid #f00; color: #fff; background: #f00 url("../img/icon_alert.gif") 5px .3em no-repeat; }
86 |
87 | .col-l { float: left; width: 30%; }
88 | .forum-profile th, .forum-settings th { width: 30%; }
89 | .col-r { float: right; width: 70%; }
90 | .col-r .last-topics-started { margin-left: 1em; }
91 |
92 | #active-users p { margin: 0; }
93 |
94 | #footer { clear: both; margin-top: 1em; padding: 4px 0; }
95 |
96 | #debug { clear: both; }
--------------------------------------------------------------------------------
/forum/templates/forum/forum_detail.html:
--------------------------------------------------------------------------------
1 | {% extends "forum/base.html" %}{% load forum_tags %}{% load humanize %}
2 | {% block extrahead %}
3 | {{ block.super }}
4 | {% if is_paginated %}{% endif %}
5 | {% endblock %}
6 | {% block main_content %}
7 | {% if forum.description %}{{ forum.description }}
{% endif %}
8 |
16 |
17 |
{{ forum.name }} {% if user|is_admin %} - Edit Forum | Delete Forum
18 | {% if topic_list or pinned_topics %}
19 |
74 | {% else %}
75 |
76 | This Forum does not have any Topics yet.
77 |
78 | {% endif %}
79 |
Forums
5 | » Search
6 | » {{ title }}
7 | {% endblock %}
8 |
9 | {% block main_content %}
10 | {% if object_list %}
11 |
14 | {% if search.is_post_search %}
15 | {% if redis %}
16 | {% add_topic_view_counts object_list %}
17 | {% endif %}
18 | {% for post in object_list %}
19 |
20 |
{{ post.topic_title }} in {{ post.forum_name }} - {{ post.topic_post_count|intcomma }} Post{{ post.topic_post_count|pluralize }}{% if redis %}, {{ post.topic_view_count|intcomma }} View{{ post.topic_view_count|pluralize }}{% endif %}
21 |
22 |
23 |
24 |
{% if post.meta %}Metapost {% endif %}#{{ post.num_in_topic }} by {{ post.user_username }} , {{ post.posted_at|post_time:user }}
25 |
26 | {{ post.body_html|safe }}
27 |
28 |
29 |
30 |
31 |
32 | {% if post.user_avatar %}
33 | {{ post.user_username }} {{ post.user_title }}
38 | {% endif %}
39 | Posts: {{ post.user_post_count }}Joined: {{ post.user_date_joined|joined_date }}Location: {{ post.user_location }}Post IP: {{ post.user_ip }}
48 |
49 |
50 |
No Posts Found
104 | Your search did not return any results.
105 | {% endif %}
106 | {% endblock %}
--------------------------------------------------------------------------------
/forum/templates/forum/user_profile.html:
--------------------------------------------------------------------------------
1 | {% extends "forum/base.html" %}{% load forum_tags %}
2 | {% block main_content %}
3 | {% ifequal user.id forum_user.id %}
4 |
9 | {% endifequal %}
10 |
11 |
12 |
{{ title }} {% if user|can_edit_user_profile:forum_user %} - Edit
13 |
14 |
15 |
16 | Avatar
17 | {% if forum_profile.avatar %}
18 |
19 |
20 | Group
21 | {{ forum_profile.get_group_display }}
22 |
23 |
24 | Title
25 | {{ forum_profile.title|default:"None" }}
26 |
27 |
28 | Posts
29 | {{ forum_profile.post_count }}
30 |
31 |
32 | Joined
33 | {{ forum_user.date_joined|joined_date }}
34 |
35 |
36 | Location
37 | {% if forum_profile.location %}{{ forum_profile.location }}{% else %}None{% endif %}
38 |
39 |
40 | Website
41 | {% if forum_profile.website %}{{ forum_profile.website }} {% else %}None{% endif %}
42 |
43 | {% if redis %}
44 |
45 | Last Seen
46 | {{ last_seen|timesince }}
47 |
48 |
49 | Doing
50 | {{ doing|safe }}
51 |
52 | {% endif %}
53 |
54 |
55 |
56 |
57 | {% ifequal user.id forum_user.id %}
58 |
59 |
Your Forum Settings - Edit
60 |
61 |
62 |
63 | Timezone
64 | {{ forum_profile.timezone|default:"None" }}
65 |
66 |
67 | Topics Per Page
68 | {{ forum_profile.topics_per_page|default:"Default" }}
69 |
70 |
71 | Posts Per Page
72 | {{ forum_profile.posts_per_page|default:"Default" }}
73 |
74 |
75 | Auto Fast Reply
76 | {{ forum_profile.auto_fast_reply|yesno:"Yes,No" }}
77 |
78 |
79 |
80 |
81 | {% endifequal %}
82 |
85 |
86 |
Most Recent Topics Started {% if recent_topics %} - View All Topics
87 | {% if recent_topics %}
88 | {% load humanize %}
89 |
90 |
97 |
98 | Topic
99 | In Forum
100 | Started
101 | Posts
102 | {% if redis %}Views {% endif %}
103 | Last Post
104 |
105 |
106 |
107 | {% for topic in recent_topics %}
108 |
109 |
110 | {% if topic.hidden %}{{ topic.title }}
113 | {% if topic.description %}{{ topic.description }}
{% endif %}
114 |
115 | {{ topic.forum_name }} {{ topic.started_at|timesince }} ago
117 | {{ topic.post_count|intcomma }} {{ topic.view_count|intcomma }} {% endif %}
119 | {{ topic.last_post_at|post_time:user }}Last Post by {{ topic.last_username }}
120 | {% endfor %}
121 |
122 |
123 | {% else %}
124 |
125 | This user has not started any Topics yet.
126 |
127 | {% endif %}
128 |
129 |
Forums
12 | » {{ topic.section_name }}
13 | » {{ topic.forum_name }}
14 | {% if meta %}
15 | » {{ title }}
16 | » Metaposts
17 | {% else %}
18 | » {{ title }}
19 | {% endif %}
20 | {% endblock %}
21 |
22 | {% block main_content %}
23 | {% if topic.hidden %}
24 |
25 | {% endif %}
26 | {% if topic.locked %}
27 |
28 | {% endif %}
29 |
38 |
39 |
40 | {{ topic.title }}{% if topic.description %}, {{ topic.description }}{% endif %}
41 | {% if not meta %} - View Metaposts {% if user|can_edit_topic:topic %} | Edit Topic | Delete Topic {% endif %}
43 | {% if post_list %}
44 | {% for post in post_list %}
45 |
46 |
47 | {% if user|can_see_post_actions:topic %}
48 |
49 | Reply with quote Edit Post Delete Post
55 | {% endif %}
56 |
57 |
{% if post.meta %}Metapost {% endif %}#{{ post.num_in_topic }} by {{ post.user_username }} , {{ post.posted_at|post_time:user }}
58 |
59 | {{ post.body_html|safe }}
60 |
61 |
62 |
63 |
64 |
65 | {% if post.user_avatar %}
66 | {{ post.user_username }} {{ post.user_title }}
71 | {% endif %}
72 | Posts: {{ post.user_post_count }}Joined: {{ post.user_date_joined|joined_date }}Location: {{ post.user_location }}Post IP: {{ post.user_ip }}
81 |
82 |
83 | {% endfor %}
84 | {% else %}
85 |
There are no {% if meta %}Meta{% endif %}posts yet.
86 | {% endif %}
87 |
",h).html(j).get(0)}else return jQuery("<"+i+">",h).get(0)}:function(){var i={tabindex:"tabIndex"},h={tabindex:"tabIndex",readonly:"readOnly","for":"htmlFor","class":"className",maxlength:"maxLength",
15 | cellspacing:"cellSpacing",cellpadding:"cellPadding",rowspan:"rowSpan",colspan:"colSpan",usemap:"useMap",frameborder:"frameBorder",contenteditable:"contentEditable"},j=function(){var e=o.createElement("div");e.setAttribute("className","t");e.innerHTML='s';var c=e.getElementsByTagName("span")[0],g=o.createElement("input");g.value="t";g.setAttribute("type","radio");return{style:/silver/.test(c.getAttribute("style")),getSetAttribute:e.className!="t",radioValue:g.value==
16 | "t"}}(),l,n=function(e,c,g){c!==!1&&(c=h[g]||g,c in e&&(e[c]=!0),e.setAttribute(g,g.toLowerCase()));return g},k={type:function(e,c){if(!j.radioValue&&c=="radio"&&e.nodeName&&e.nodeName.toUpperCase()=="INPUT"){var g=e.value;e.setAttribute("type",c);if(g)e.value=g;return c}},value:function(e,c,g){if(l&&e.nodeName&&e.nodeName.toUpperCase()=="BUTTON")return l(e,c,g);e.value=c}},r=/^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,
17 | t=/\:|^on/;if(!j.getSetAttribute)i=h,l=k.name=k.title=function(e,c,g){if(e=e.getAttributeNode(g))return e.nodeValue=c},k.width=k.height=function(e,c){if(c==="")return e.setAttribute(name,"auto"),c};if(!j.style)k.style=function(e,c){return e.style.cssText=""+c};return function(e,c){var g=o.createElement(e),j,p;q.call(c,"innerHTML")&&(u(g,c.innerHTML),delete c.innerHTML);for(j in c)if(p=c[j],s[j])g["on"+j]=p;else{var m=g,a=j;if("getAttribute"in m){var b=void 0,a=i[a]||a,b=k[a];if(!b)if(r.test(a))b=
18 | n;else if(l&&a!="className"&&(m.nodeName&&m.nodeName.toUpperCase()=="FORM"||t.test(a)))b=l;p!==void 0&&!(b&&b(m,p,a)!==void 0)&&m.setAttribute(a,""+p)}else a=h[a]||a,p!==void 0&&(m[a]=p)}return g}}();k.addMode({name:"dom",createElement:function(i,h,j){var l=q.call(h,"innerHTML"),i=v(i,h);if(!l)for(var l=0,h=j.length,k;l 0 and n <= context['pages']]
69 | show_first = 1 not in page_numbers
70 | show_last = context['pages'] not in page_numbers
71 | return {
72 | 'what': what,
73 | 'hits': context['hits'],
74 | 'page': context['page'],
75 | 'pages': context['pages'],
76 | 'page_numbers': page_numbers,
77 | 'next': context['next'],
78 | 'previous': context['previous'],
79 | 'has_next': context['has_next'],
80 | 'has_previous': context['has_previous'],
81 | 'show_first': show_first,
82 | 'show_first_divider': show_first and page_numbers[0] != 2,
83 | 'show_last': show_last,
84 | 'show_last_divider': show_last and page_numbers[-1] != context['pages'] - 1,
85 | }
86 |
87 | ###########
88 | # Filters #
89 | ###########
90 |
91 | @register.filter
92 | def partition(l, n):
93 | """
94 | Partitions a list into lists of size ``n``.
95 |
96 | From http://www.djangosnippets.org/snippets/6/
97 | """
98 | try:
99 | n = int(n)
100 | thelist = list(l)
101 | except (ValueError, TypeError):
102 | return [l]
103 | lists = [list() for i in range(int(ceil(len(l) / float(n))))]
104 | for i, item in enumerate(l):
105 | lists[i/n].append(item)
106 | return lists
107 |
108 | ##########################
109 | # Authentication Filters #
110 | ##########################
111 |
112 | @register.filter
113 | def can_edit_post(user, post):
114 | return user.is_authenticated() and \
115 | auth.user_can_edit_post(user, post)
116 |
117 | @register.filter
118 | def can_edit_topic(user, topic):
119 | return user.is_authenticated() and \
120 | auth.user_can_edit_topic(user, topic)
121 |
122 | @register.filter
123 | def can_edit_user_profile(user, user_to_edit):
124 | return user.is_authenticated() and \
125 | auth.user_can_edit_user_profile(user, user_to_edit)
126 |
127 | @register.filter
128 | def is_admin(user):
129 | """
130 | Returns ``True`` if the given user has admin permissions,
131 | ``False`` otherwise.
132 | """
133 | return user.is_authenticated() and \
134 | auth.is_admin(user)
135 |
136 | @register.filter
137 | def is_moderator(user):
138 | """
139 | Returns ``True`` if the given user has moderation permissions,
140 | ``False`` otherwise.
141 | """
142 | return user.is_authenticated() and \
143 | auth.is_moderator(user)
144 |
145 | @register.filter
146 | def can_see_post_actions(user, topic):
147 | """
148 | Returns ``True`` if the given User should be able to see the post
149 | action list for posts in the given topic, ``False`` otherwise.
150 |
151 | This function is used as part of ensuring that moderators have
152 | unrestricted access to locked Topics.
153 | """
154 | if user.is_authenticated():
155 | return not topic.locked or auth.is_moderator(user)
156 | else:
157 | return False
158 |
159 | #######################
160 | # Date / Time Filters #
161 | #######################
162 |
163 | @register.filter
164 | def forum_datetime(st, user=None):
165 | """
166 | Formats a general datetime.
167 | """
168 | return mark_safe(format_datetime(st, user, 'M jS Y', 'H:i A', ', '))
169 |
170 | @register.filter
171 | def post_time(posted_at, user=None):
172 | """
173 | Formats a Post time.
174 | """
175 | return mark_safe(format_datetime(posted_at, user, r'\o\n M jS Y', r'\a\t H:i A'))
176 |
177 | @register.filter
178 | def joined_date(date):
179 | """
180 | Formats a joined date.
181 | """
182 | return mark_safe(dateformat.format(date, 'M jS Y'))
183 |
184 | ########################
185 | # Topic / Post Filters #
186 | ########################
187 |
188 | @register.filter
189 | def is_first_post(post):
190 | """
191 | Determines if the given post is the first post in a topic.
192 | """
193 | return post.num_in_topic == 1 and not post.meta
194 |
195 | @register.filter
196 | def topic_status_image(topic):
197 | """
198 | Returns HTML for an image representing a topic's status.
199 | """
200 | if has_new_posts(topic):
201 | src = u'forum/img/new_posts.gif'
202 | description = u'New Posts'
203 | else:
204 | src = u'forum/img/no_new_posts.gif'
205 | description = u'No New Posts'
206 | return mark_safe(u'%%s ' % \
240 | topic.get_absolute_url()
241 | if pages < 6:
242 | html = u' '.join([page_link % (page, page) \
243 | for page in xrange(1, pages + 1)])
244 | else:
245 | html = u' '.join([page_link % (1 ,1), u'…'] + \
246 | [page_link % (page, page) \
247 | for page in xrange(pages - 2, pages + 1)])
248 | return mark_safe(html)
249 |
--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
1 | ============
2 | Django Forum
3 | ============
4 |
5 | This is a basic forum application which is usable by itself as a standalone
6 | project and should eventually be usable as a pluggable application in any
7 | Django project.
8 |
9 | .. contents::
10 | :local:
11 | :depth: 2
12 |
13 | Features
14 | ========
15 |
16 | - **Bog-standard layout** - Sections |rarr| Forums |rarr| Topics.
17 |
18 | - **Search** posts and topics - search for keywords by section, forum,
19 | username, post type and date.
20 |
21 | Searching supports quoted phrases and ``+`` and ``-`` modifiers on
22 | keywords and phrases.
23 |
24 | - **Real-time tracking** with `Redis`_ - performing ``UPDATE`` queries on
25 | every single page view to track view counts, active users and user
26 | activity on the forum? No.
27 |
28 | Redis does it in style.
29 |
30 | - **Configurable post formatting** - comes with BBCode and Markdown formatters.
31 |
32 | - **Metaposts** - each topic has regular posts, as you'd expect, and also
33 | metaposts. These are effectively a second thread of conversation for
34 | posts *about* the topic. Why, you say?
35 |
36 | People who want to talk about the topic itself or how it's being
37 | discussed, or just start a good old ding-dong with other users, rather
38 | than taking part in the discussion at hand, have a place to vent instead
39 | of dragging the topic into the realm of the off-topic.
40 |
41 | Moderators have another option other than deleting or hiding posts when
42 | topics start to take a turn for the worse in that direction.
43 |
44 | People who just wanted to read and post in the original topic can
45 | continue to do so *and* still have it out in the metaposts. Win/win
46 | or win/lose - the choice is yours.
47 |
48 | Inspired by my many years with the excellent people of `RLLMUK`_.
49 |
50 | - **Avatar validation** - linked avatars are validated for format, file
51 | size and dimensions.
52 |
53 | Possible Misfeatures
54 | --------------------
55 |
56 | - **Denormalised up the yazoo** - data such as post counts and last post
57 | information are maintained on all affected objects on every write.
58 |
59 | Trading write complexity and ease of maintenance against fewer, more
60 | simple reads, just because.
61 |
62 | - **No signatures** - it's not a bug, it's a feature.
63 |
64 | .. _`RLLMUK`: http://www.rllmukforum.com
65 | .. |rarr| unicode:: 0x2192 .. rightward arrow
66 |
67 | Installation
68 | ============
69 |
70 | Dependencies
71 | ------------
72 |
73 | **Required:**
74 |
75 | - `Python Imaging Library`_ (PIL) is required for validation of user avatars.
76 | - `pytz`_ is required to perform timezone conversions based on the timezone
77 | registered users can choose as part of their forum profile.
78 |
79 | **Required for standalone mode:**
80 |
81 | - `django-registration`_ is used to perform registration and validation of new
82 | users when running as a standalone project - it is assumed that when the forum
83 | is integrated into existing projects, they will already have their own
84 | registration mechanism in place.
85 |
86 | **Required based on settings:**
87 |
88 | - `Redis`_ and `redis-py`_ are required for real-time tracking fun if
89 | ``FORUM_USE_REDIS`` is set to ``True``. For Windows users,
90 | `native Redis binaries`_ are available.
91 | - `python-markdown2`_ is required to use ``forum.formatters.MarkdownFormatter``
92 | to format posts using `Markdown`_ syntax.
93 | - `postmarkup`_ and `Pygments`_ are required to use
94 | ``forum.formatters.BBCodeFormatter`` to format posts using `BBCode`_ syntax.
95 |
96 | **Others:**
97 |
98 | - `Django Debug Toolbar`_ will be used if available, if the forum is in
99 | standalone mode and ``DEBUG`` is set to ``True``.
100 |
101 | .. _`redis-py`: https://github.com/andymccurdy/redis-py
102 | .. _`native redis binaries`: https://github.com/dmajkic/redis/downloads
103 | .. _`Python Imaging Library`: http://www.pythonware.com/products/pil/
104 | .. _`pytz`: http://pytz.sourceforge.net/
105 | .. _`django-registration`: http://code.google.com/p/django-registration/
106 | .. _`Django Debug Toolbar`: http://robhudson.github.com/django-debug-toolbar/
107 | .. _`python-markdown2`: http://code.google.com/p/python-markdown2
108 | .. _`Markdown`: http://daringfireball.net/projects/markdown/
109 | .. _`postmarkup`: http://code.google.com/p/postmarkup/
110 | .. _`BBCode`: http://en.wikipedia.org/wiki/BBCode
111 | .. _`Pygments`: http://pygments.org
112 |
113 | Standalone Mode
114 | ---------------
115 |
116 | At the time of typing, the codebase comes with a complete development
117 | ``settings.py`` module which can be used to run the forum in standalone
118 | mode.
119 |
120 | It's configured to to use Redis for real-time tracking on the forum and
121 | for session management using ``forum.sessions.redis_session_backend``.
122 |
123 | Pluggable Application Mode
124 | --------------------------
125 |
126 | **Note: this mode has not yet been fully developed or tested**
127 |
128 | Add ``'forum'`` to your application's ``INSTALLED_APPS`` setting, then run
129 | ``syncdb`` to create its tables.
130 |
131 | Include the forum's URLConf in your project's main URLConf at whatever URL you
132 | like. For example::
133 |
134 | from django.conf.urls.defaults import *
135 |
136 | urlpatterns = patterns(
137 | (r'^forum/', include('forum.urls')),
138 | )
139 |
140 | The forum application's URLs are decoupled using Django's `named URL patterns`_
141 | feature, so it doesn't mind which URL you mount it at.
142 |
143 | .. _`named URL patterns`: http://www.djangoproject.com/documentation/url_dispatch/#naming-url-patterns
144 |
145 | Settings
146 | ========
147 |
148 | The following settings may be added to your project's settings module to
149 | configure the forum application.
150 |
151 | ``FORUM_STANDALONE``
152 |
153 | *Default:* ``False``
154 |
155 | Whether or not the forum is being used in standalone mode. If set to
156 | ``True``, URL configurations for the django.contrib.admin and
157 | django-registration apps will be included in the application's main
158 | URLConf.
159 |
160 | ``FORUM_USE_REDIS``
161 |
162 | *Default:* ``False``
163 |
164 | Whether or not the forum should use `Redis`_ to track real-time information
165 | such as topic view counts, active users and user locations on the forum.
166 |
167 | If set to ``False``, these details will not be displayed.
168 |
169 | ``FORUM_REDIS_HOST``
170 |
171 | *Default:* ``'localhost'``
172 |
173 | Redis host.
174 |
175 | ``FORUM_REDIS_PORT``
176 |
177 | *Default:* ``6379``
178 |
179 | Redis port.
180 |
181 | ``FORUM_REDIS_DB``
182 |
183 | *Default:* ``0``
184 |
185 | Redis database number, ``0``-``16``.
186 |
187 | ``FORUM_POST_FORMATTER``
188 |
189 | *Default:* ``'forum.formatters.PostFormatter'``
190 |
191 | The Python path to the module to be used to format raw post input. This class
192 | should satisfy the requirements defined below in `Post Formatter Structure`_.
193 |
194 | ``FORUM_DEFAULT_POSTS_PER_PAGE``
195 |
196 | *Default:* ``20``
197 |
198 | The number of posts which are displayed by default on any page where posts are
199 | listed - this applies to registered users who do not choose to override the
200 | number of posts per page and to anonymous users.
201 |
202 | ``FORUM_DEFAULT_TOPICS_PER_PAGE``
203 |
204 | *Default:* ``30``
205 |
206 | The number of topics which are displayed by default on any page where topics are
207 | listed - this applies to registered users who do not choose to override the
208 | number of topics per page and to anonymous users.
209 |
210 | ``FORUM_MAX_AVATAR_FILESIZE``
211 |
212 | *Default:* ``512 * 1024`` (512 kB)
213 |
214 | The maximum allowable filesize for user avatars, specified in bytes. To disable
215 | validation of user avatar filesizes, set this setting to ``None``.
216 |
217 | ``FORUM_ALLOWED_AVATAR_FORMATS``
218 |
219 | *Default:* ``('GIF', 'JPEG', 'PNG')``
220 |
221 | A tuple of allowed image formats for user avatars. To disable validation of user
222 | avatar image formats, set this setting to ``None``.
223 |
224 | ``FORUM_MAX_AVATAR_DIMENSIONS``
225 |
226 | *Default:* ``(64, 64)``
227 |
228 | A two-tuple, (width, height), of maximum allowable dimensions for user avatars.
229 | To disable validation of user avatar dimensions, set this setting to ``None``.
230 |
231 | ``FORUM_FORCE_AVATAR_DIMENSIONS``
232 |
233 | *Default:* ``True``
234 |
235 | Whether or not ``
305 | t![/quote]
306 |
307 | ...a BBCode post formatter might return something like::
308 |
309 | T
312 |
313 | ``quote_post(post)``
314 |
315 | This method should accept a ``Post`` object and return the raw post text for a
316 | a "quoted" version of the post's content. The ``Post`` object itself is passed,
317 | as opposed to just the raw post text, as the quote may wish to include other
318 | details such as the name of the user who made the post, the time the post was
319 | made at, a link back to the quoted post... and so on.
320 |
321 | Note that the raw post text returned by this function will be escaped when it is
322 | displayed to the user for editing, so to avoid double escaping it should *not*
323 | be escaped by this function.
324 |
325 | For example, given a ``Post`` whose raw ``body`` text is::
326 |
327 | Tt!
328 |
329 | ...a BBCode post formatter might return something like::
330 |
331 | [quote]Tt![/quote]
332 |
333 | .. _`Redis`: http://redis.io
334 |
335 | MIT License
336 | ===========
337 |
338 | Copyright (c) 2011, Jonathan Buchanan
339 |
340 | Permission is hereby granted, free of charge, to any person obtaining a copy of
341 | this software and associated documentation files (the "Software"), to deal in
342 | the Software without restriction, including without limitation the rights to
343 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
344 | the Software, and to permit persons to whom the Software is furnished to do so,
345 | subject to the following conditions:
346 |
347 | The above copyright notice and this permission notice shall be included in all
348 | copies or substantial portions of the Software.
349 |
350 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
351 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
352 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
353 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
354 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
355 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--------------------------------------------------------------------------------
/forum/forms.py:
--------------------------------------------------------------------------------
1 | import datetime
2 | import operator
3 | import urllib
4 |
5 | from django import forms
6 | from django.db.models.query_utils import Q
7 | from django.forms.models import modelform_factory
8 | from django.template.defaultfilters import filesizeformat
9 | from django.utils.text import capfirst, get_text_list, smart_split
10 |
11 | from forum import app_settings
12 | from forum.models import Forum, ForumProfile, Post, Search, Section, Topic
13 |
14 | # Try to import PIL in either of the two ways it can end up installed.
15 | try:
16 | from PIL import ImageFile as PILImageFile
17 | except ImportError:
18 | import ImageFile as PILImageFile
19 |
20 | class AddSectionForm(forms.Form):
21 | """
22 | Form for adding a new Section - takes and existing Section it should
23 | be inserted before.
24 | """
25 | name = forms.CharField(max_length=100)
26 | section = forms.ChoiceField(required=False)
27 |
28 | def __init__(self, sections, *args, **kwargs):
29 | super(AddSectionForm, self).__init__(*args, **kwargs)
30 | self.sections = sections
31 | self.fields['section'].choices = [('', '----------')] + \
32 | [(section.id, section.name) for section in sections]
33 |
34 | def clean_name(self):
35 | """Validates that the section name is unique."""
36 | for section in self.sections:
37 | if self.cleaned_data['name'] == section.name:
38 | raise forms.ValidationError('A Section with this name already exists.')
39 | return self.cleaned_data['name']
40 |
41 | class EditSectionForm(forms.ModelForm):
42 | """Form for editing a Section."""
43 | class Meta:
44 | model = Section
45 | fields = ('name',)
46 |
47 | def clean_name(self):
48 | """Validates that the section name is unique if it has changed."""
49 | if self.fields['name'].initial != self.cleaned_data['name']:
50 | try:
51 | Section.objects.get(name=self.cleaned_data['name'])
52 | raise forms.ValidationError('A Section with this name already exists.')
53 | except Section.DoesNotExist:
54 | pass
55 | return self.cleaned_data['name']
56 |
57 | class AddForumForm(forms.Form):
58 | """
59 | Form for adding a new Forum - takes an existing Forum it should be
60 | inserted before.
61 | """
62 | name = forms.CharField(max_length=100)
63 | description = forms.CharField(max_length=100, required=False, widget=forms.Textarea())
64 | forum = forms.ChoiceField(required=False)
65 |
66 | def __init__(self, forums, *args, **kwargs):
67 | super(AddForumForm, self).__init__(*args, **kwargs)
68 | self.fields['forum'].choices = [('', '----------')] + \
69 | [(forum.id, forum.name) for forum in forums]
70 |
71 | class EditForumForm(forms.ModelForm):
72 | """Form for editing a Forum."""
73 | class Meta:
74 | model = Forum
75 | fields = ('name', 'description')
76 |
77 | def topic_formfield_callback(field, **kwargs):
78 | """
79 | Callback for Post form field creation.
80 |
81 | Customises the size of the widgets used to edit topic details.
82 | """
83 | if field.name in ['title', 'description']:
84 | formfield = field.formfield(**kwargs)
85 | formfield.widget.attrs['size'] = 50
86 | return formfield
87 | else:
88 | return field.formfield(**kwargs)
89 |
90 | class AddTopicForm(forms.ModelForm):
91 | """Form for adding a new Topic."""
92 | formfield_callback = topic_formfield_callback
93 |
94 | class Meta:
95 | model = Topic
96 | fields = ('title', 'description')
97 |
98 | class EditTopicForm(forms.ModelForm):
99 | """Form for editing a Topic."""
100 | formfield_callback = topic_formfield_callback
101 |
102 | class Meta:
103 | model = Topic
104 | fields = ('title', 'description', 'pinned', 'locked', 'hidden')
105 |
106 | def __init__(self, moderate, *args, **kwargs):
107 | super(EditTopicForm, self).__init__(*args, **kwargs)
108 | if not moderate:
109 | del self.fields['pinned']
110 | del self.fields['locked']
111 | del self.fields['hidden']
112 |
113 | def post_formfield_callback(field, **kwargs):
114 | """
115 | Callback for Post form field creation.
116 |
117 | Customises the widget used to edit posts.
118 | """
119 | if field.name == 'body':
120 | formfield = field.formfield(**kwargs)
121 | formfield.widget.attrs['rows'] = 14
122 | formfield.widget.attrs['cols'] = 70
123 | return formfield
124 | else:
125 | return field.formfield(**kwargs)
126 |
127 | class TopicPostForm(forms.ModelForm):
128 | """Form for the initial Post in a new Topic."""
129 | formfield_callback = post_formfield_callback
130 |
131 | class Meta:
132 | model = Post
133 | fields = ('body', 'emoticons')
134 |
135 | class ReplyForm(forms.ModelForm):
136 | """Form for a reply Post."""
137 | formfield_callback = post_formfield_callback
138 |
139 | class Meta:
140 | model = Post
141 | fields = ('body', 'emoticons', 'meta')
142 |
143 | def __init__(self, meta, *args, **kwargs):
144 | super(ReplyForm, self).__init__(*args, **kwargs)
145 | if not meta:
146 | del self.fields['meta']
147 |
148 | class SearchForm(forms.Form):
149 | """
150 | Criteria for searching Topics or Posts.
151 |
152 | Creates a QuerySet based on selected criteria.
153 | """
154 | SEARCH_ALL_FORUMS = 'A'
155 | SEARCH_IN_SECTION = 'S'
156 | SEARCH_IN_FORUM = 'F'
157 |
158 | SEARCH_ALL_POSTS = 'A'
159 | SEARCH_REGULAR_POSTS = 'R'
160 | SEARCH_METAPOSTS = 'M'
161 | SEARCH_POST_TYPE_CHOICES = (
162 | (SEARCH_ALL_POSTS, 'All Posts'),
163 | (SEARCH_REGULAR_POSTS, 'Regular Posts'),
164 | (SEARCH_METAPOSTS, 'Metaposts'),
165 | )
166 |
167 | SEARCH_FROM_TODAY = 'T'
168 | SEARCH_ANY_DATE = 'A'
169 | SEARCH_FROM_CHOICES = (
170 | (SEARCH_FROM_TODAY, 'Today and...'),
171 | (7, '7 days ago and...'),
172 | (30, '30 days ago and...'),
173 | (60, '60 days ago and...'),
174 | (90, '90 days ago and...'),
175 | (180, '180 days ago and...'),
176 | (365, '365 days ago and...'),
177 | (SEARCH_ANY_DATE, 'Any date'),
178 | )
179 |
180 | SEARCH_OLDER = 'O'
181 | SEARCH_NEWER = 'N'
182 | SEARCH_WHEN_CHOICES = (
183 | (SEARCH_OLDER, 'Older'),
184 | (SEARCH_NEWER, 'Newer'),
185 | )
186 | SEARCH_WHEN_LOOKUP = {
187 | SEARCH_OLDER: 'lte',
188 | SEARCH_NEWER: 'gte',
189 | }
190 |
191 | SORT_DESCENDING = 'D'
192 | SORT_ASCENDING = 'A'
193 | SORT_DIRECTION_CHOICES = (
194 | (SORT_DESCENDING, 'Descending'),
195 | (SORT_ASCENDING, 'Ascending'),
196 | )
197 | SORT_DIRECTION_FLAG = {
198 | SORT_DESCENDING: '-',
199 | SORT_ASCENDING: '',
200 | }
201 |
202 | USERNAME_LOOKUP = {True: '', False: '__icontains'}
203 |
204 | search_type = forms.ChoiceField(choices=Search.TYPE_CHOICES, initial=Search.POST_SEARCH, widget=forms.RadioSelect)
205 | keywords = forms.CharField()
206 | username = forms.CharField(required=False)
207 | exact_username = forms.BooleanField(required=False, initial=True, label='Match exact username')
208 | post_type = forms.ChoiceField(choices=SEARCH_POST_TYPE_CHOICES, initial=SEARCH_ALL_POSTS, widget=forms.RadioSelect)
209 | search_in = forms.MultipleChoiceField(required=False, initial=[SEARCH_ALL_FORUMS])
210 | search_from = forms.ChoiceField(choices=SEARCH_FROM_CHOICES)
211 | search_when = forms.ChoiceField(choices=SEARCH_WHEN_CHOICES, initial=SEARCH_OLDER, widget=forms.RadioSelect)
212 | sort_direction = forms.ChoiceField(choices=SORT_DIRECTION_CHOICES, initial=SORT_DESCENDING, widget=forms.RadioSelect)
213 |
214 | def __init__(self, *args, **kwargs):
215 | super(SearchForm, self).__init__(*args, **kwargs)
216 | choices = [(self.SEARCH_ALL_FORUMS, 'All Forums')]
217 | for section, forums in Section.objects.get_forums_by_section():
218 | choices.append(('%s.%s' % (self.SEARCH_IN_SECTION, section.pk),
219 | section.name))
220 | choices.extend([('%s.%s' % (self.SEARCH_IN_FORUM, forum.pk),
221 | '|-- %s' % forum.name) \
222 | for forum in forums])
223 | self.fields['search_in'].choices = choices
224 | self.fields['search_in'].widget.attrs['size'] = 10
225 |
226 | def clean_keywords(self):
227 | """
228 | Validates that no search keyword is shorter than 3 characters.
229 | """
230 | for keyword in smart_split(self.cleaned_data['keywords']):
231 | keyword_len = len(keyword)
232 | if keyword[0] in ('+', '-'):
233 | keyword_len = keyword_len - 1
234 | elif keyword[0] == '"' and keyword[-1] == '"' or \
235 | keyword[0] == "'" and keyword[-1] == "'":
236 | keyword_len = keyword_len - 2
237 | if keyword_len < 3:
238 | raise forms.ValidationError('Keywords must be a minimun of 3 characters long.')
239 | return self.cleaned_data['keywords']
240 |
241 | def get_queryset(self):
242 | """
243 | Creates a ``QuerySet`` based on the search criteria specified in
244 | this form.
245 |
246 | Returns ``None`` if the form doesn't appear to have been
247 | validated.
248 | """
249 | if not hasattr(self, 'cleaned_data'):
250 | return None
251 |
252 | search_type = self.cleaned_data['search_type']
253 | filters = []
254 |
255 | # Calculate certain lookup values based on criteria
256 | search_in = {}
257 | if len(self.cleaned_data['search_in']) and \
258 | self.SEARCH_ALL_FORUMS not in self.cleaned_data['search_in']:
259 | for item in self.cleaned_data['search_in']:
260 | bits = item.split('.')
261 | search_in.setdefault(bits[0], []).append(bits[1])
262 |
263 | from_date = None
264 | if self.cleaned_data['search_from'] != self.SEARCH_ANY_DATE:
265 | from_date = datetime.date.today()
266 | if self.cleaned_data['search_from'] != self.SEARCH_FROM_TODAY:
267 | days_ago = int(self.cleaned_data['search_from'])
268 | from_date = from_date - datetime.timedelta(days=days_ago)
269 | if self.cleaned_data['search_when'] == self.SEARCH_OLDER:
270 | # Less-than date searches should compare to midnight on
271 | # the following day.
272 | from_date = from_date + datetime.timedelta(days=1)
273 |
274 | # Some lookup fields which change based on the search type
275 | if search_type == Search.POST_SEARCH:
276 | section_lookup = 'topic__forum__section'
277 | forum_lookup = 'topic__forum'
278 | date_lookup = 'posted_at'
279 | text_lookup = 'body'
280 | # Searching should not give the user access to Posts in
281 | # hidden Topics.
282 | filters.append(Q(topic__hidden=False))
283 | else:
284 | section_lookup = 'forum__section'
285 | forum_lookup = 'forum'
286 | date_lookup = 'started_at'
287 | text_lookup = 'title'
288 | # Searching should not give the user access to hidden Topics
289 | filters.append(Q(hidden=False))
290 |
291 | # Create lookup filters
292 | if search_type == Search.POST_SEARCH and \
293 | self.cleaned_data['post_type'] != self.SEARCH_ALL_POSTS:
294 | meta = self.cleaned_data['post_type'] == self.SEARCH_METAPOSTS
295 | filters.append(Q(meta=meta))
296 |
297 | if self.SEARCH_IN_SECTION in search_in and \
298 | self.SEARCH_IN_FORUM in search_in:
299 | filters.append(Q(**{'%s__in' % section_lookup: search_in[self.SEARCH_IN_SECTION]}) | \
300 | Q(**{'%s__in' % forum_lookup: search_in[self.SEARCH_IN_FORUM]}))
301 | elif self.SEARCH_IN_SECTION in search_in:
302 | filters.append(Q(**{'%s__in' % section_lookup: search_in[self.SEARCH_IN_SECTION]}))
303 | elif self.SEARCH_IN_FORUM in search_in:
304 | filters.append(Q(**{'%s__in' % forum_lookup: search_in[self.SEARCH_IN_FORUM]}))
305 |
306 | if from_date is not None:
307 | lookup_type = self.SEARCH_WHEN_LOOKUP[self.cleaned_data['search_when']]
308 | filters.append(Q(**{'%s__%s' % (date_lookup, lookup_type): from_date}))
309 |
310 | if self.cleaned_data['username']:
311 | lookup_type = self.USERNAME_LOOKUP[self.cleaned_data['exact_username']]
312 | filters.append(Q(**{'user__username%s' % lookup_type: \
313 | self.cleaned_data['username']}))
314 |
315 | one_of_filters = []
316 | phrase_filters = []
317 | for keyword in smart_split(self.cleaned_data['keywords']):
318 | if keyword[0] == '+':
319 | filters.append(Q(**{'%s__icontains' % text_lookup: keyword[1:]}))
320 | elif keyword[0] == '-':
321 | filters.append(~Q(**{'%s__icontains' % text_lookup: keyword[1:]}))
322 | elif keyword[0] == '"' and keyword[-1] == '"' or \
323 | keyword[0] == "'" and keyword[-1] == "'":
324 | phrase_filters.append(Q(**{'%s__icontains' % text_lookup: keyword[1:-1]}))
325 | else:
326 | one_of_filters.append(Q(**{'%s__icontains' % text_lookup: keyword}))
327 | if one_of_filters:
328 | filters.append(reduce(operator.or_, one_of_filters))
329 | if phrase_filters:
330 | filters.append(reduce(operator.or_, phrase_filters))
331 |
332 | # Apply filters and perform ordering
333 | if search_type == Search.POST_SEARCH:
334 | qs = Post.objects.all()
335 | else:
336 | qs = Topic.objects.all()
337 | if len(filters):
338 | qs = qs.filter(reduce(operator.and_, filters))
339 | sort_direction_flag = \
340 | self.SORT_DIRECTION_FLAG[self.cleaned_data['sort_direction']]
341 | return qs.order_by('%s%s' % (sort_direction_flag, date_lookup),
342 | '%sid' % sort_direction_flag)
343 |
344 | class ImageURLField(forms.URLField):
345 | """
346 | A URL field specifically for images, which can validate details
347 | about the filesize, dimensions and format of an image at a given
348 | URL.
349 |
350 | Specifying any of the following arguments will result in the
351 | appropriate validation of image details, retrieved from the URL
352 | specified in this field:
353 |
354 | max/min_filesize
355 | An integer specifying an image filesize limit, in bytes.
356 |
357 | max/min_width
358 | An integer specifying an image width limit, in pixels.
359 |
360 | max/min_height
361 | An integer specifying an image height limit, in pixels.
362 |
363 | image_formats
364 | A list of image formats to be accepted, specified as uppercase
365 | strings.
366 |
367 | For a list of valid image formats, see the "Image File Formats"
368 | section of the `Python Imaging Library Handbook`_.
369 |
370 | .. _`Python Imaging Library Handbook`: http://www.pythonware.com/library/pil/handbook/
371 | """
372 | def __init__(self, max_filesize=None, min_filesize=None, max_width=None,
373 | min_width=None, max_height=None, min_height=None, image_formats=None,
374 | *args, **kwargs):
375 | super(ImageURLField, self).__init__(*args, **kwargs)
376 | self.max_filesize, self.min_filesize = max_filesize, min_filesize
377 | self.max_width, self.min_width = max_width, min_width
378 | self.max_height, self.min_height = max_height, min_height
379 | self.image_formats = image_formats
380 | self.validate_image = \
381 | max_filesize is not None or min_filesize is not None or \
382 | max_width is not None or min_width is not None or \
383 | max_height is not None or min_height is not None or \
384 | image_formats is not None
385 |
386 | def validate(self, value):
387 | super(ImageURLField, self).validate(value)
388 |
389 | if value == '' or not self.validate_image:
390 | return
391 |
392 | try:
393 | filesize, dimensions, format = self._get_image_details(value)
394 | if dimensions is None or format is None:
395 | raise forms.ValidationError(
396 | 'Could not retrieve image details from this URL.')
397 | if self.max_filesize is not None and filesize > self.max_filesize:
398 | raise forms.ValidationError(
399 | 'The image at this URL is %s large - it must be at most %s.' % (
400 | filesizeformat(filesize), filesizeformat(self.max_filesize)))
401 | if self.min_filesize is not None and filesize < self.min_filesize:
402 | raise forms.ValidationError(
403 | 'The image at this URL is %s large - it must be at least %s.' % (
404 | filesizeformat(filesize), filesizeformat(self.min_filesize)))
405 | if self.max_width is not None and dimensions[0] > self.max_width:
406 | raise forms.ValidationError(
407 | 'The image at this URL is %s pixels wide - it must be at most %s pixels.' % (
408 | dimensions[0], self.max_width))
409 | if self.min_width is not None and dimensions[0] < self.min_width:
410 | raise forms.ValidationError(
411 | 'The image at this URL is %s pixels wide - it must be at least %s pixels.' % (
412 | dimensions[0], self.min_width))
413 | if self.max_height is not None and dimensions[1] > self.max_height:
414 | raise forms.ValidationError(
415 | 'The image at this URL is %s pixels high - it must be at most %s pixels.' % (
416 | dimensions[1], self.max_height))
417 | if self.min_height is not None and dimensions[1] < self.min_height:
418 | raise forms.ValidationError(
419 | 'The image at this URL is %s pixels high - it must be at least %s pixels.' % (
420 | dimensions[1], self.min_height))
421 | if self.image_formats is not None and format not in self.image_formats:
422 | raise forms.ValidationError(
423 | 'The image at this URL is in %s format - %s %s.' % (
424 | format,
425 | len(self.image_formats) == 1 and 'the only accepted format is' or 'accepted formats are',
426 | get_text_list(self.image_formats)))
427 | except IOError:
428 | raise forms.ValidationError('Could not load an image from this URL.')
429 | return value
430 |
431 | def _get_image_details(self, url):
432 | """
433 | Retrieves details about the image accessible at the given URL,
434 | returning a 3-tuple of (filesize, image dimensions (width,
435 | height) and image format), or (filesize, ``None``, ``None``) if
436 | image details could not be determined.
437 |
438 | The Python Imaging Library is used to parse the image in chunks
439 | in order to determine its dimension and format details without
440 | having to load the entire image into memory.
441 |
442 | Adapted from http://effbot.org/zone/pil-image-size.htm
443 | """
444 | file = urllib.urlopen(url)
445 | filesize = file.headers.get('content-length')
446 | if filesize: filesize = int(filesize)
447 | p = PILImageFile.Parser()
448 | while 1:
449 | data = file.read(1024)
450 | if not data:
451 | break
452 | p.feed(data)
453 | if p.image:
454 | return filesize, p.image.size, p.image.format
455 | break
456 | file.close()
457 | return filesize, None, None
458 |
459 | def forum_profile_formfield_callback(field, **kwargs):
460 | """
461 | Callback for forum profile form field creation.
462 |
463 | Generates an ``ImageURLField`` for the ``avatar`` field and default
464 | fields for all others.
465 | """
466 | if field.name == 'avatar':
467 | args = {
468 | 'verify_exists': field.validators[-1].verify_exists, # TODO Make nice
469 | 'max_length': field.max_length,
470 | 'required': not field.blank,
471 | 'label': capfirst(field.verbose_name),
472 | 'help_text': field.help_text,
473 | }
474 | if app_settings.MAX_AVATAR_FILESIZE is not None:
475 | args['max_filesize'] = app_settings.MAX_AVATAR_FILESIZE
476 | if app_settings.ALLOWED_AVATAR_FORMATS is not None:
477 | args['image_formats'] = app_settings.ALLOWED_AVATAR_FORMATS
478 | if app_settings.MAX_AVATAR_DIMENSIONS is not None:
479 | args['max_width'] = app_settings.MAX_AVATAR_DIMENSIONS[0]
480 | args['max_height'] = app_settings.MAX_AVATAR_DIMENSIONS[1]
481 | args.update(kwargs)
482 | return ImageURLField(**args)
483 | else:
484 | return field.formfield(**kwargs)
485 |
486 | class UserProfileForm(forms.ModelForm):
487 | """Form for editing the user profile fields in a ForumProfile."""
488 | formfield_callback = forum_profile_formfield_callback
489 |
490 | class Meta:
491 | model = ForumProfile
492 | fields = ('title', 'location', 'avatar', 'website')
493 |
494 | def __init__(self, can_edit_title, *args, **kwargs):
495 | super(UserProfileForm, self).__init__(*args, **kwargs)
496 | if not can_edit_title:
497 | del self.fields['title']
498 |
499 | class ForumSettingsForm(forms.ModelForm):
500 | """Form for editing the board setting fields in a ForumProfile."""
501 | class Meta:
502 | model = ForumProfile
503 | fields = ('timezone', 'topics_per_page', 'posts_per_page', 'auto_fast_reply')
504 |
--------------------------------------------------------------------------------
29 |