Submitter:	Christian Hammond	Reviewers
Branch:	trunk	Groups:	reviewboard
Bugs:		People:
Change Number:	None	Repository:	Review Board SVN

Description:

Up until now users have had to edit settings_local.py to customize their Review Board install. While we documented many of the options, it was still a pain for users as they'd have to log in and edit the file and then restart the server.

With the new djblets.siteconfig app, we can now move in a more modern direction for customization of Review Board. Aside from a few basic essential settings in settings_local.py (such as database configuration) the admin UI will now be the place to go to customize Review Board.

A migration script is provided to automatically migrate all settings into the new siteconfig database entry. The next time users run ./manage.py syncdb, the script will detect that the settings need to be migrated and handle it all. Everything we care about should be preserved, including authentication information.

Testing Done:

I've tested this with brand new installs and with a few different migrated databases. I haven't hit any problems yet but I haven't actually tested the resulting settings for authentication. Users can specify NIS or LDAP servers and I know we save the information but before this goes in, I'll be testing on an actual install.

Screenshots:

General Settings

LDAP

NIS

E-Mail Settings

Diff Viewer Settings

Diff revision 3 (Latest)

Jump to revision:	1 2 3
Changes between r3 and:	1 2 3

Files Changed:

/trunk/reviewboard/manage.py: 6 changes [ 1 2 3 4 5 6 ]
/trunk/reviewboard/settings.py: 6 changes [ 1 2 3 4 5 6 ]
/trunk/reviewboard/settings_local.py.tmpl: 2 changes [ 1 2 ]
/trunk/reviewboard/urls.py: 5 changes [ 1 2 3 4 5 ]
/trunk/reviewboard/accounts/backends.py: 1 change [ 1 ]
/trunk/reviewboard/accounts/decorators.py: 4 changes [ 1 2 3 4 ]
/trunk/reviewboard/accounts/forms.py: 4 changes [ 1 2 3 4 ]
/trunk/reviewboard/accounts/urls.py: 1 change [ new content ]
/trunk/reviewboard/accounts/views.py: 6 changes [ 1 2 3 4 5 6 ]
/trunk/reviewboard/admin/checks.py: 2 changes [ 1 2 ]
/trunk/reviewboard/admin/forms.py: 1 change [ new content ]
/trunk/reviewboard/admin/siteconfig.py: 1 change [ new content ]
/trunk/reviewboard/admin/urls.py: 5 changes [ 1 2 3 4 5 ]
/trunk/reviewboard/admin/management/__init__.py: 5 changes [ 1 2 3 4 5 ]
/trunk/reviewboard/admin/management/evolutions.py: 1 change [ new content ]
/trunk/reviewboard/admin/management/sites.py: 1 change [ new content ]
/trunk/reviewboard/contrib/tools/post-review: 3 changes [ 1 2 3 ]
/trunk/reviewboard/diffviewer/diffutils.py: 12 changes [ 1 2 3 4 5 6 7 8 9 10 11 12 ]
/trunk/reviewboard/diffviewer/tests.py: 4 changes [ 1 2 3 4 ]
/trunk/reviewboard/diffviewer/views.py: 6 changes [ 1 2 3 4 5 6 ]

This diff has been split across 2 pages: 1 2 >

Expand changes

 #!/usr/bin/env python
 import imp
 import sys
 import os
 from os.path import abspath, dirname
-from django.core.management import execute_manager
+from django.core.management import execute_manager, setup_environ
 from django.template.defaultfilters import striptags
 # Add the parent directory of 'manage.py' to the python path, so manage.py can
 # be run from any directory.  From http://www.djangosnippets.org/snippets/281/
 sys.path.insert(0, dirname(dirname(abspath(__file__))))
 try:
     import settings # Assumed to be in the same directory.
 except ImportError:
     sys.stderr.write("Error: Can't find the file 'settings.py' in the directory containing %r. It appears you've customized things.\nYou'll have to run django-admin.py, passing it your settings module.\n(If the file settings.py does indeed exist, it's causing an ImportError somehow.)\n" % __file__)
     sys.exit(1)
 from reviewboard.admin import checks
 warnings_found = 0
 def check_dependencies():
     from settings import dependency_error
     # Some of our checks require access to django.conf.settings, so
     # tell Django about our settings.
     setup_environ(settings)
     # Python 2.4
     if sys.version_info[0] < 2 or \
        (sys.version_info[0] == 2 and sys.version_info[1] < 4):
         dependency_error('Python 2.4 or newer is required.')
     except ImportError:
         dependency_error('The Python Imaging Library (PIL) is required.')
     import subprocess
-    # pygments
-    if settings.DIFF_SYNTAX_HIGHLIGHTING:
-        try:
-            import pygments
-            version = pygments.__version__.split(".")
-            if version[0] == 0 and version[1] < 9:
-                dependency_error('Pygments is installed, but is an old version. '
-                                 'Versions prior to 0.9 are known to have '
-                                 'serious problems.')
-        except ImportError:
-            dependency_error('The Pygments library is required when ' +
-                             'DIFF_SYNTAX_HIGHLIGHTING is enabled.')
-    # PyLucene
-    if settings.ENABLE_SEARCH:
-        try:
-            import lucene
-        except ImportError:
-            dependency_error('PyLucene (with JCC) is required when '
-                             'ENABLE_SEARCH is set.')
     # The following checks are non-fatal warnings, since these dependencies are
     # merely recommended, not required.
     def dependency_warning(string):
         sys.stderr.write('Warning: %s\n' % string)
         global warnings_found
     try:
         imp.find_module('mercurial')
     except ImportError:
         dependency_warning('hg not found.  Mercurial integration will not work.')
     for check_func in (checks.get_can_enable_search,
                        checks.get_can_enable_syntax_highlighting):
         success, reason = check_func()
         if not success:
             dependency_warning(striptags(reason))
     found = False
     for dir in os.environ['PATH'].split(os.environ.get('IFS', ':')):
         if os.path.exists(os.path.join(dir, 'git')):
             found = True
             break

     'django.core.context_processors.auth',
     'django.core.context_processors.debug',
     'django.core.context_processors.i18n',
     'django.core.context_processors.media',
     'django.core.context_processors.request',
     'djblets.siteconfig.context_processors.siteconfig',
     'djblets.util.context_processors.settingsVars',
     'djblets.util.context_processors.siteRoot',
+)
 SITE_ROOT_URLCONF = 'reviewboard.urls'
     'django.contrib.markup',
     'django.contrib.sites',
     'django.contrib.sessions',
     'djblets.datagrid',
     'djblets.feedview',
     'djblets.siteconfig',
     'djblets.util',
     'djblets.webapi',
     'reviewboard.accounts',
     'reviewboard.admin',
     'reviewboard.diffviewer',
 WEB_API_ENCODERS = (
     'djblets.webapi.core.BasicAPIEncoder',
     'reviewboard.webapi.json.ReviewBoardAPIEncoder',
+)
-# Whether to use django's built-in system for users.  This turns on certain
-# features like the registration page and profile editing.  If you're tying
-# reviewboard in to an existing authentication environment (such as NIS),
-# this data will come in from outside.
-BUILTIN_AUTH = True
 AUTH_PROFILE_MODULE = "accounts.Profile"
-# Default repository path to use for the source code.
-DEFAULT_REPOSITORY_PATH = None
 # Default expiration time for the cache.  Note that this has no effect unless
 # CACHE_BACKEND is specified in settings_local.py
 CACHE_EXPIRATION_TIME = 60 * 60 * 24 * 30 # 1 month
 # Custom test runner, which uses nose to find tests and execute them.  This
 # gives us a somewhat more comprehensive test execution than django's built-in
 # runner, as well as some special features like a code coverage report.
 TEST_RUNNER = 'reviewboard.test.runner'
-# Default diff settings
-DIFF_CONTEXT_NUM_LINES = 5
-DIFF_CONTEXT_COLLAPSE_THRESHOLD = 2 * DIFF_CONTEXT_NUM_LINES + 3
-# List of file patterns that will show whitespace-only changes. The
-# default behavior for diffs is to hide lines showing only leading
-# whitespace changes.
-# For example:
-#    DIFF_INCLUDE_SPACE_PATTERNS = ["*.py", "*.txt"]
-DIFF_INCLUDE_SPACE_PATTERNS = []
-# When enabled, this will send e-mails for all review requests and comments
-# out to the e-mail addresses defined for the group.
-SEND_REVIEW_MAIL = False
-# Enable syntax highlighting in the diff viewer
-DIFF_SYNTAX_HIGHLIGHTING = False
-# Access method used for the site, used in e-mails.  Override this in
-# settings_local.py if you choose to use https instead of http.
-DOMAIN_METHOD = "http"
-# Require a login for accessing any part of the site. If False, review
-# requests, diffs, lists of review requests, etc. will be accessible without
-# a login.
-REQUIRE_SITEWIDE_LOGIN = False
-# Enable search. See the comment in settings_local.py for more information on
-# what's required to get this working.
-ENABLE_SEARCH = False
-SEARCH_INDEX = os.path.join(REVIEWBOARD_ROOT, 'search-index')
-# The number of files to display per page in the diff viewer
-DIFFVIEWER_PAGINATE_BY = 20
-# The number of extra files required before adding another page
-DIFFVIEWER_PAGINATE_ORPHANS = 10
 # Dependency checker functionality.  Gives our users nice errors when they start
 # out, instead of encountering them later on.  Most of the magic for this
 # happens in manage.py, not here.
 install_help = '''
 Please see http://code.google.com/p/reviewboard/wiki/GettingStarted
 # Base these on the user's SITE_ROOT.
 LOGIN_URL = SITE_ROOT + 'account/login/'
 ADMIN_MEDIA_PREFIX = MEDIA_URL + 'admin/'
 # Cookie settings
 LANGUAGE_COOKIE_NAME = "rblanguage"
 SESSION_COOKIE_NAME = "rbsessionid"
 SESSION_COOKIE_AGE = 365 * 24 * 24 * 60 # 1 year
 SESSION_COOKIE_PATH = SITE_ROOT

 # Cache backend.  Unset this to turn off caching completely.  As with most
 # django installations, the best option is probably to use memcached.
 CACHE_BACKEND = 'locmem:///'
-# Whether to send e-mail for review requests.
-SEND_REVIEW_MAIL = False
 # Local time zone for this installation. All choices can be found here:
 # http://www.postgresql.org/docs/current/static/datetime-keywords.html#DATETIME-TIMEZONE-SET-TABLE
 TIME_ZONE = 'US/Pacific'
 # Language code for this installation. All choices can be found here:
 # If you set this to False, Django will make some optimizations so as not
 # to load the internationalization machinery.
 USE_I18N = True
-# Enable search.  Search needs PyLucene to be installed.  It also requires
-# that a regular job be set up to perform the indexing.  To generate the
-# index, run:
-#    manage.py index
-# This command will perform an incremental index.  To do a full reindex, run:
-#    manage.py index --full
-# Incremental indexes should be done fairly often.
-# A sample cron configuration exists in contrib/conf/search-cron.conf
-# If you want the search index to be located somewhere other than the
-# reviewboard root, set SEARCH_INDEX to the desired path.  The index needs to be
-# a directory writable by the user creating the index and readable by the user
-# that Review Board runs as.
-ENABLE_SEARCH = False
 # TLS for LDAP.  If you're using LDAP authentication and your LDAP server
 # doesn't support ldaps://, you can enable start-TLS with this.
 LDAP_TLS = False

 import os.path
 from django.conf import settings
 from django.conf.urls.defaults import patterns, include, url
 from django.contrib import admin
 from reviewboard.admin.checks import check_updates_required
 from reviewboard.admin.siteconfig import load_site_config
 from reviewboard.reviews.feeds import RssReviewsFeed, AtomReviewsFeed, \
                                       RssSubmitterReviewsFeed, \
                                       AtomSubmitterReviewsFeed, \
                                       RssGroupReviewsFeed, \
                                       AtomGroupReviewsFeed
 # Load all site settings.
 load_site_config()
 # Load in all the models for the admin UI.
 if not admin.site._registry:
     admin.autodiscover()
+    }
     # Main includes
     urlpatterns += patterns('',
         (r'^account/', include('reviewboard.accounts.urls')),
         (r'^api/json/', include('reviewboard.webapi.urls')),
         (r'^r/', include('reviewboard.reviews.urls')),
         (r'^reports/', include('reviewboard.reports.urls')),
+    )
     urlpatterns += patterns('',
         url(r'^$', 'django.views.generic.simple.redirect_to',
             {'url': 'dashboard/'},
             name="root"),
-        # Authentication and accounts
-        url(r'^account/login/$', 'djblets.auth.views.login',
-            {'next_page': settings.SITE_ROOT + 'dashboard/',
-             'extra_context': {'BUILTIN_AUTH': settings.BUILTIN_AUTH}},
-            name="login"),
-        url(r'^account/preferences/$',
-            'reviewboard.accounts.views.user_preferences',
-            name="user-preferences"),
         # This must be last.
         (r'^iphone/', include('reviewboard.iphone.urls')),
+    )
-    if settings.BUILTIN_AUTH:
-        urlpatterns += patterns('',
-            url(r'^account/register/$', 'djblets.auth.views.register',
-                {'next_page': settings.SITE_ROOT + 'dashboard/'},
-                name="register"),
-    else:
-        urlpatterns += patterns('',
-            (r'^account/register/$',
-             'django.views.generic.simple.redirect_to',
-             {'url': settings.SITE_ROOT + 'account/login/'}))

                 ldapo.simple_bind_s(settings.LDAP_ANON_BIND_UID, settings.LDAP_ANON_BIND_PASSWD)
                 passwd = ldapo.search_s(settings.LDAP_UID_MASK % username,
                                         ldap.SCOPE_SUBTREE, "objectclass=*")
-                first_name = passwd[0][1]['givenName'][0]
+                first_name = passwd[0][1]['givenName']
-                last_name = passwd[0][1]['sn'][0]
+                last_name = passwd[0][1]['sn']
                 email = u'%s@%s' % (username, settings.LDAP_EMAIL_DOMAIN)
                 user = User(username=username,
                             password='',
                             first_name=first_name,

 from urllib import quote
-from django.conf import settings
 from django.contrib.auth import REDIRECT_FIELD_NAME
 from django.core.urlresolvers import reverse
 from django.http import HttpResponseRedirect
 from djblets.auth.util import login_required
 from djblets.siteconfig.models import SiteConfiguration
 from djblets.util.decorators import simple_decorator
 from reviewboard.accounts.models import Profile
 @simple_decorator
 def check_login_required(view_func):
     """
     A decorator that checks whether login is required on this installation
     and, if so, checks if the user is logged in. If login is required and
     the user is not logged in, they're redirected to the login link.
     """
     def _check(*args, **kwargs):
-        if settings.REQUIRE_SITEWIDE_LOGIN:
+        siteconfig = SiteConfiguration.objects.get_current()
         if siteconfig.get("auth_require_sitewide_login"):
             return login_required(view_func)(*args, **kwargs)
         else:
             return view_func(*args, **kwargs)
     return _check

 from django import forms
 from django.conf import settings
 from django.forms import widgets
 from django.utils.translation import ugettext as _
 from djblets.siteconfig.models import SiteConfiguration
 from reviewboard.reviews.models import Group
 class PreferencesForm(forms.Form):
     redirect_to = forms.CharField(required=False, widget=forms.HiddenInput)
     groups = forms.MultipleChoiceField(widget=forms.CheckboxSelectMultiple,
                                        required=False)
     syntax_highlighting = forms.BooleanField(required=False,
         label=_("Enable syntax highlighting in the diff viewer"))
     first_name = forms.CharField(required=False)
     last_name = forms.CharField(required=False)
-    email = forms.EmailField(required=settings.BUILTIN_AUTH)
+    email = forms.EmailField()
     password1 = forms.CharField(required=False, widget=widgets.PasswordInput())
     password2 = forms.CharField(required=False, widget=widgets.PasswordInput())
     def __init__(self, *args, **kwargs):
-        forms.Form.__init__(self, *args, **kwargs)
+        forms.Form.__init__(

Review Board

beta

This change has been marked as submitted.

Add dynamic site configuration to Review Board

Diff revision 3 (Latest)