Updates as of October 2013

AUTHORS

@@ -1 +1,2 @@
 Maciej Bliziński <[email protected]>
+Olivier Le Thanh Duong <[email protected]>

README.md

@@ -0,0 +1,111 @@
+---------------------------------------
+django-phpbb - Django-PhpBB integration
+---------------------------------------
+
+In case of django-phpbb, using it means that when you're coding a Django
+application, you have a set of classes and functions at your disposal, providing
+a glue between phpBB3 and Django.
+
+## Authentication ##
+
+### A prerequisite: Django authentication ###
+
+First, prerequisites. Make sure your [Django
+authentication](http://docs.djangoproject.com/en/dev/topics/auth/#topics-auth)
+is working. 
+
+If your Django website uses authentication already, you probably have the
+following lines in your `urls.py`.
+
+    (r'^accounts/login/$', 'django.contrib.auth.views.login', ),
+    (r'^accounts/logout/$', 'django.contrib.auth.views.logout', ),
+
+If there are no such lines in your `urls.py`, your application probably doesn't
+use authentication. Consult the Django documentation for instructions to get
+your authentication to work.
+
+## PYTHONPATH ##
+
+The django-phpbb directory must be in PYTHONPATH (or sys.path).
+
+## Adding phpbb3 authentication backend ##
+
+Edit your `settings.py` and make sure the following lines are present:
+
+    MIDDLEWARE_CLASSES = (
+        ...
+        'django.contrib.auth.middleware.AuthenticationMiddleware',
+    )
+    TEMPLATE_CONTEXT_PROCESSORS = (
+        ...
+        "django.core.context_processors.auth",
+    )
+    INSTALLED_APPS = (
+        'django.contrib.auth',
+        ...
+        'phpbb',
+    )
+    AUTHENTICATION_BACKENDS = (
+        'phpbb.backends.PhpbbBackend',
+        'django.contrib.auth.backends.ModelBackend',
+    )
+
+
+Once you've done that, the authentication backend should be enabled and users
+should be able to log in using not only Django passwords, but also passwords
+checked against the phpbb3 database.
+
+## phpBB3 classes ##
+
+You can access phpBB3 forum objects using provided classes. Look up the source
+code to see the details of the classes. (Sorry for not providing any better
+documentation at this time.)
+
+Fire up Django shell and try using django-phpbb classes:
+
+    ./manage.py shell
+    from django.contrib.phpbb import models as p3m
+    forum = p3m.PhpbbForum.objects.get(pk=1)
+    dir(forum)
+    forum.forum_name
+    forum.phpbbtopic_set.all()[:5]
+
+## Predefined views ##
+
+You need to have a `base.html` template that django-phpbb's template expect to
+extend.
+
+To enable predefined views, add this line to your `urls.py`:
+
+    (r'^forum/', include('phpbb.urls')),
+
+Also, make django-phpbb templates available:
+
+    TEMPLATE_DIRS = (
+        ...
+        "/some-directory/django-phpbb/phpbb/templates",
+    )
+
+_The views currently contain bits and pieces of the original website they've
+been cut from. The views are going to be reworked. Consider them more as a guide
+to see how you can implement your own forum browsing rather than a complete
+solution._
+
+License
+-------
+
+Copyright (C) 2008 Maciej Bliziński <[email protected]>  
+Copyright (C) 2010 Olivier Le Thanh Duong <[email protected]>
+
+django-phpbb is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place, Suite 330, Boston, MA 02111-1307 USA

TODO

@@ -6,6 +6,8 @@ To do list:
   - Option 1: use http://code.google.com/p/postmarkup/
     - Issues: Doesn't support integration with a real phpBB database
   - Option 2: port original bbcode[1].
+- Add support for access control, at the very least determining which forums
+  should be publicly visible and which shouldn't.
 
 [1] http://code.phpbb.com/repositories/entry/5/trunk/phpBB/includes/bbcode.php
     http://code.phpbb.com/repositories/entry/5/trunk/phpBB/includes/message_parser.php

phpbb/admin.py

@@ -63,7 +63,7 @@ class PhpbbAclRoleOptionAdmin(admin.ModelAdmin):
     #                 'auth_option',
     #                 'auth_global')
 admin.site.register(pm.PhpbbAclOption, PhpbbAclRoleOptionAdmin)
-#admin.site.register(pm.PhpbbAclRoleDatum)
+# admin.site.register(pm.PhpbbAclRoleDatum)
 # Composite keys support needed
 # admin.site.register(pm.PhpbbAclGroup)
 admin.site.register(pm.PhpbbGroup)

phpbb/backends.py

@@ -39,7 +39,7 @@ class PhpbbBackend:
 
     def authenticate(self, username=None, password=None):
         """Authenticate user against phpBB3 database.
-        
+
         Check if the user exists in Django users. If not, create it.
         Then authenticate."""
         logging.debug("PhpbbBackend::authenticate()")
@@ -67,7 +67,7 @@ def authenticate(self, username=None, password=None):
             logging.info("Creating new Django user '%s'" % username)
             if username:
                 user = User(username = username, password = "")
-                user.is_staff = True
+                user.is_staff = False
                 user.is_superuser = False
 
                 user.email = phpbb_user.user_email
@@ -117,4 +117,3 @@ def has_module_perms(self, user_obj, app_label):
             if perm[:perm.index('.')] == app_label:
                 return True
         return False
-

phpbb/bbcode.py

@@ -45,7 +45,7 @@ class BitField(object):
 http://code.phpbb.com/repositories/entry/5/trunk/phpBB/includes/functions_content.php"""
     def __init__(self, bitfield=""):
         self.data = bitfield.decode("base64")
-    
+
     def get(self, n):
         byte = n >> 3
         if len(self.data) >= byte + 1:
@@ -118,7 +118,7 @@ class BbCode(object):
 - user is passed to the constructor (on original code, a global variable is
   used)
 """
-    
+
     def __init__(self, user, bitfield=""):
         self.user = user
         if bitfield:

phpbb/bbcode_unittest.py → phpbb/bbcode_test.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 # -*- coding: utf-8 -*-
 # This file is part of django-phpbb, integration between Django and phpBB
 # Copyright (C) 2007-2008  Maciej Bliziński
@@ -57,28 +58,28 @@ def setUp(self):
 
     def testGet0(self):
         self.assertEquals(self.b1.get(0), 0)
-    
+
     def testGet3(self):
         self.assertEquals(self.b1.get(3), 16)
-    
+
     def testGet4(self):
         self.assertEquals(self.b1.get(4), 0)
-    
+
     def testSet0(self):
         self.b1.set(0)
         self.assertEquals(self.b1.get(0), 128)
 
     def testSet1(self):
         self.b1.set(0)
         self.assertEquals(self.b1.get_bin(), "10010000")
-    
+
     def testGetBin(self):
         self.assertEquals(self.b1.get_bin(), "00010000")
 
     def testGetAllSet(self):
         self.b1.set(7)
         self.assertEquals(self.b1.get_all_set(), [3, 7])
-    
+
     def testGetBlob(self):
         self.assertEquals(self.b1.get_blob(), '\x10')
 
@@ -92,7 +93,7 @@ def testMerge(self):
         self.assertEquals(b1.get(0), 128)
         self.assertEquals(b1.get(1), 64)
         del b1, b2
-    
+
     def tearDown(self):
         del self.b1
 

phpbb/feeds.py

@@ -19,16 +19,21 @@
 # Boston, MA  02110-1301  USA
 
 from django.utils.translation import gettext_lazy as _
-from django.contrib.syndication.feeds import Feed
+from django.contrib.syndication.views import Feed
 from models import PhpbbPost
+from phpbb import querysets
 
 class LatestPhpbbPosts(Feed):
+    """Returns the newest forum posts.
+
+    FIXME: Show only public forums. Needs composite primary keys, currently not
+           supported in Django.
+
+    """
     title = u"Forum"
     link = "/forum/"
     description = _("Newest posts on the forum.")
     def items(self):
-        return (PhpbbPost.objects.order_by('-post_time_int').
-            exclude(topic__forum__forum_id=15).
-            exclude(topic__forum__forum_id=6)[:20])
+        return querysets.postqs.order_by('-post_time_int')[:20]
     def item_link(self, obj):
         return obj.get_external_url()