def testMailAuthDeserialize(self):
"""Testing mail authentication settings deserialization"""
# This is bug 1476. We deserialized the e-mail settings to Unicode
# strings automatically, but this broke mail sending on some setups.
# The HMAC library is incompatible with Unicode strings in more recent
# Python 2.6 versions. Now we deserialize as a string. This test
# ensures that these settings never break again.
username = '******'
password = '******'
self.assertEqual(type(username), six.text_type)
self.assertEqual(type(password), six.text_type)
self.siteconfig.set('mail_host_user', username)
self.siteconfig.set('mail_host_password', password)
apply_django_settings(self.siteconfig, mail_settings_map)
self.assertEqual(settings.EMAIL_HOST_USER, username)
self.assertEqual(settings.EMAIL_HOST_PASSWORD, password)
self.assertEqual(type(settings.EMAIL_HOST_USER), bytes)
self.assertEqual(type(settings.EMAIL_HOST_PASSWORD), bytes)
# Simulate the failure point in HMAC
import hmac
settings.EMAIL_HOST_USER.translate(hmac.trans_5C)
settings.EMAIL_HOST_PASSWORD.translate(hmac.trans_5C)
def test_cache_backend_with_caches_legacy_memcached(self):
"""Testing cache backend setting with siteconfig-stored CACHES and
legacy memcached.CacheClass
"""
settings.CACHES["staticfiles"] = {
"BACKEND": "django.core.cache.backends.locmem.LocMemCache",
"LOCATION": "staticfiles-cache",
}
self.siteconfig.set(
"cache_backend",
{"default": {"BACKEND": "django.core.cache.backends.memcached.CacheClass", "LOCATION": "localhost:12345"}},
)
apply_django_settings(self.siteconfig, cache_settings_map)
self.assertTrue("staticfiles" in settings.CACHES)
self.assertTrue("default" in settings.CACHES)
self.assertTrue("forwarded_backend" in settings.CACHES)
self.assertEqual(
settings.CACHES["default"]["BACKEND"], "djblets.cache.forwarding_backend.ForwardingCacheBackend"
)
self.assertEqual(settings.CACHES["default"]["LOCATION"], "forwarded_backend")
self.assertEqual(
settings.CACHES["forwarded_backend"]["BACKEND"], "django.core.cache.backends.memcached.MemcachedCache"
)
self.assertEqual(settings.CACHES["forwarded_backend"]["LOCATION"], "localhost:12345")
def test_cache_backend_with_caches_legacy_memcached(self):
"""Testing cache backend setting with siteconfig-stored CACHES and
legacy memcached.CacheClass
"""
settings.CACHES['staticfiles'] = {
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
'LOCATION': 'staticfiles-cache',
}
self.siteconfig.set('cache_backend', {
'default': {
'BACKEND':
'django.core.cache.backends.memcached.CacheClass',
'LOCATION': 'localhost:12345',
},
})
apply_django_settings(self.siteconfig, cache_settings_map)
self.assertTrue('staticfiles' in settings.CACHES)
self.assertTrue('default' in settings.CACHES)
self.assertTrue('forwarded_backend' in settings.CACHES)
self.assertEqual(
settings.CACHES['default']['BACKEND'],
'djblets.cache.forwarding_backend.ForwardingCacheBackend')
self.assertEqual(settings.CACHES['default']['LOCATION'],
'forwarded_backend')
self.assertEqual(settings.CACHES['forwarded_backend']['BACKEND'],
'django.core.cache.backends.memcached.MemcachedCache')
self.assertEqual(settings.CACHES['forwarded_backend']['LOCATION'],
'localhost:12345')
def test_cache_backend(self):
"""Testing cache backend setting with CACHES['default']"""
settings.CACHES = {
"default": {"BACKEND": "django.core.cache.backends.locmem.LocMemCache", "LOCATION": "foo"},
"staticfiles": {
"BACKEND": "django.core.cache.backends.locmem.LocMemCache",
"LOCATION": "staticfiles-cache",
},
}
self.siteconfig.set("cache_backend", "memcached://localhost:12345/")
apply_django_settings(self.siteconfig, cache_settings_map)
self.assertTrue("staticfiles" in settings.CACHES)
self.assertTrue("default" in settings.CACHES)
self.assertTrue("forwarded_backend" in settings.CACHES)
self.assertEqual(
settings.CACHES["default"]["BACKEND"], "djblets.cache.forwarding_backend.ForwardingCacheBackend"
)
self.assertEqual(settings.CACHES["default"]["LOCATION"], "forwarded_backend")
self.assertEqual(
settings.CACHES["forwarded_backend"]["BACKEND"], "django.core.cache.backends.memcached.MemcachedCache"
)
self.assertEqual(settings.CACHES["forwarded_backend"]["LOCATION"], "localhost:12345")
def testMailAuthDeserialize(self):
"""Testing mail authentication settings deserialization"""
# This is bug 1476. We deserialized the e-mail settings to Unicode
# strings automatically, but this broke mail sending on some setups.
# The HMAC library is incompatible with Unicode strings in more recent
# Python 2.6 versions. Now we deserialize as a string. This test
# ensures that these settings never break again.
username = '******'
password = '******'
self.assertEqual(type(username), six.text_type)
self.assertEqual(type(password), six.text_type)
self.siteconfig.set('mail_host_user', username)
self.siteconfig.set('mail_host_password', password)
apply_django_settings(self.siteconfig, mail_settings_map)
self.assertEqual(settings.EMAIL_HOST_USER, username)
self.assertEqual(settings.EMAIL_HOST_PASSWORD, password)
self.assertEqual(type(settings.EMAIL_HOST_USER), bytes)
self.assertEqual(type(settings.EMAIL_HOST_PASSWORD), bytes)
# Simulate the failure point in HMAC
import hmac
settings.EMAIL_HOST_USER.translate(hmac.trans_5C)
settings.EMAIL_HOST_PASSWORD.translate(hmac.trans_5C)
def test_cache_backend(self):
"""Testing cache backend setting with CACHES['default']"""
settings.CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
'LOCATION': 'foo',
},
'staticfiles': {
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
'LOCATION': 'staticfiles-cache',
}
}
self.siteconfig.set('cache_backend', 'memcached://localhost:12345/')
apply_django_settings(self.siteconfig, cache_settings_map)
self.assertTrue('staticfiles' in settings.CACHES)
self.assertTrue('default' in settings.CACHES)
self.assertTrue('forwarded_backend' in settings.CACHES)
self.assertEqual(
settings.CACHES['default']['BACKEND'],
'djblets.cache.forwarding_backend.ForwardingCacheBackend')
self.assertEqual(settings.CACHES['default']['LOCATION'],
'forwarded_backend')
self.assertEqual(settings.CACHES['forwarded_backend']['BACKEND'],
'django.core.cache.backends.memcached.MemcachedCache')
self.assertEqual(settings.CACHES['forwarded_backend']['LOCATION'],
'localhost:12345')
def load_site_config():
"""
Loads any stored site configuration settings and populates the Django
settings object with any that need to be there.
"""
def apply_setting(settings_key, db_key, default=None):
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured, \
"The site configuration entry does not exist in the database. " \
"Re-run `./manage.py` syncdb to fix this."
except:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = \
siteconfig.settings.get('mail_default_from',
global_settings.DEFAULT_FROM_EMAIL)
if (not mail_default_from or
mail_default_from == global_settings.DEFAULT_FROM_EMAIL):
domain = siteconfig.site.domain.split(':')[0]
siteconfig.set('mail_default_from', 'noreply@' + domain)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
# Now for some more complicated stuff...
# Site administrator settings
apply_setting("ADMINS", None, (
(siteconfig.get("site_admin_name", ""),
siteconfig.get("site_admin_email", "")),
))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the MEDIA_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.MEDIA_URL + "admin/")
def load_site_config():
"""Sets up the SiteConfiguration, provides defaults and syncs settings."""
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
# Either warn or just create the thing. Depends on your app
siteconfig = SiteConfiguration(site=Site.objects.get_current(),
version="1.0")
siteconfig.save()
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
apply_django_settings(siteconfig, settings_map)
return siteconfig
def load_site_config():
"""Sets up the SiteConfiguration, provides defaults and syncs settings."""
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
# Either warn or just create the thing. Depends on your app
siteconfig = SiteConfiguration(site=Site.objects.get_current(),
version="1.0")
siteconfig.save()
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
apply_django_settings(siteconfig, settings_map)
return siteconfig
def load_site_config(full_reload=False):
"""Load stored site configuration settings.
This populates the Django settings object with any keys that need to be
there.
"""
def apply_setting(settings_key, db_key, default=None):
"""Apply the given siteconfig value to the Django settings object."""
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
def update_haystack_settings():
"""Update the haystack settings in site config."""
search_backend_id = (siteconfig.get('search_backend_id') or
defaults['search_backend_id'])
search_backend = search_backend_registry.get_search_backend(
search_backend_id)
if not search_backend:
raise ImproperlyConfigured(_(
'The search engine "%s" could not be found. If this is '
'provided by an extension, you will have to make sure that '
'extension is enabled.'
% search_backend_id
))
apply_setting(
'HAYSTACK_CONNECTIONS', None,
{
'default': search_backend.configuration,
})
# Re-initialize Haystack's connection information to use the updated
# settings.
connections.connections_info = settings.HAYSTACK_CONNECTIONS
connections._connections = {}
# If siteconfig needs to be saved back to the DB, set dirty=true
dirty = False
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured(
"The site configuration entry does not exist in the database. "
"Re-run `./manage.py` syncdb to fix this.")
except Exception as e:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
logging.error('Could not load siteconfig: %s' % e)
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = \
siteconfig.settings.get('mail_default_from',
global_settings.DEFAULT_FROM_EMAIL)
if (not mail_default_from or
mail_default_from == global_settings.DEFAULT_FROM_EMAIL):
domain = siteconfig.site.domain.split(':')[0]
siteconfig.set('mail_default_from', 'noreply@' + domain)
# STATIC_* and MEDIA_* must be different paths, and differ in meaning.
# If site_static_* is empty or equal to media_static_*, we're probably
# migrating from an earlier Review Board install.
site_static_root = siteconfig.settings.get('site_static_root', '')
site_media_root = siteconfig.settings.get('site_media_root')
if site_static_root == '' or site_static_root == site_media_root:
siteconfig.set('site_static_root', settings.STATIC_ROOT)
site_static_url = siteconfig.settings.get('site_static_url', '')
site_media_url = siteconfig.settings.get('site_media_url')
if site_static_url == '' or site_static_url == site_media_url:
siteconfig.set('site_static_url', settings.STATIC_URL)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
if full_reload and not getattr(settings, 'RUNNING_TEST', False):
# Logging may have changed, so restart logging.
restart_logging()
# Now for some more complicated stuff...
update_haystack_settings()
# Site administrator settings
apply_setting("ADMINS", None, (
(siteconfig.get("site_admin_name", ""),
siteconfig.get("site_admin_email", "")),
))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the STATIC_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.STATIC_URL + "admin/")
# Set the auth backends
auth_backend_id = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend_obj = auth_backends.get('backend_id', 'builtin')
builtin_backend = "%s.%s" % (builtin_backend_obj.__module__,
builtin_backend_obj.__name__)
if auth_backend_id == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, six.string_types):
custom_backends = (custom_backends,)
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend,)
else:
backend = auth_backends.get('backend_id', auth_backend_id)
if backend and backend is not builtin_backend_obj:
settings.AUTHENTICATION_BACKENDS = \
("%s.%s" % (backend.__module__, backend.__name__),
builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend,)
# If we're upgrading from a 1.x LDAP configuration, populate
# ldap_uid and clear ldap_uid_mask
if auth_backend_id == "ldap":
if not hasattr(settings, 'LDAP_UID'):
if hasattr(settings, 'LDAP_UID_MASK'):
# Get the username attribute from the old UID mask
# LDAP attributes can contain only alphanumeric
# characters and the hyphen and must lead with an
# alphabetic character. This is not dependent upon
# locale.
m = re.search("([a-zA-Z][a-zA-Z0-9-]+)=%s",
settings.LDAP_UID_MASK)
if m:
# Assign LDAP_UID the value of the retrieved attribute
settings.LDAP_UID = m.group(1)
else:
# Couldn't match the old value?
# This should be impossible, but in this case, let's
# just guess a sane default and hope for the best.
settings.LDAP_UID = 'uid'
else:
# Neither the old nor new value?
# This should be impossible, but in this case, let's just
# guess a sane default and hope for the best.
settings.LDAP_UID = 'uid'
# Remove the LDAP_UID_MASK value
settings.LDAP_UID_MASK = None
siteconfig.set('auth_ldap_uid', settings.LDAP_UID)
siteconfig.set('auth_ldap_uid_mask', settings.LDAP_UID_MASK)
# Set the dirty flag so we save this back
dirty = True
# Add APITokenBackend to the list of auth backends. This one is always
# present, and is used only for API requests.
settings.AUTHENTICATION_BACKENDS += (
'reviewboard.webapi.auth_backends.TokenAuthBackend',
)
# Set the storage backend
storage_backend = siteconfig.settings.get('storage_backend', 'builtin')
if storage_backend in storage_backend_map:
settings.DEFAULT_FILE_STORAGE = storage_backend_map[storage_backend]
else:
settings.DEFAULT_FILE_STORAGE = storage_backend_map['builtin']
# These blow up if they're not the perfectly right types
settings.AWS_QUERYSTRING_AUTH = siteconfig.get('aws_querystring_auth')
settings.AWS_ACCESS_KEY_ID = six.text_type(
siteconfig.get('aws_access_key_id'))
settings.AWS_SECRET_ACCESS_KEY = six.text_type(
siteconfig.get('aws_secret_access_key'))
settings.AWS_STORAGE_BUCKET_NAME = six.text_type(
siteconfig.get('aws_s3_bucket_name'))
try:
settings.AWS_CALLING_FORMAT = int(siteconfig.get('aws_calling_format'))
except ValueError:
settings.AWS_CALLING_FORMAT = 0
settings.SWIFT_AUTH_URL = six.text_type(
siteconfig.get('swift_auth_url'))
settings.SWIFT_USERNAME = six.text_type(
siteconfig.get('swift_username'))
settings.SWIFT_KEY = six.text_type(
siteconfig.get('swift_key'))
try:
settings.SWIFT_AUTH_VERSION = int(siteconfig.get('swift_auth_version'))
except:
settings.SWIFT_AUTH_VERSION = 1
settings.SWIFT_CONTAINER_NAME = six.text_type(
siteconfig.get('swift_container_name'))
if siteconfig.settings.get('site_domain_method', 'http') == 'https':
os.environ[b'HTTPS'] = b'on'
else:
os.environ[b'HTTPS'] = b'off'
# Save back changes if they have been made
if dirty:
siteconfig.save()
site_settings_loaded.send(sender=None)
return siteconfig
def load_site_config():
"""
Loads any stored site configuration settings and populates the Django
settings object with any that need to be there.
"""
def apply_setting(settings_key, db_key, default=None):
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured, \
"The site configuration entry does not exist in the database. " \
"Re-run `./manage.py` syncdb to fix this."
except:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = \
siteconfig.settings.get('mail_default_from',
global_settings.DEFAULT_FROM_EMAIL)
if (not mail_default_from
or mail_default_from == global_settings.DEFAULT_FROM_EMAIL):
domain = siteconfig.site.domain.split(':')[0]
siteconfig.set('mail_default_from', 'noreply@' + domain)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
# Now for some more complicated stuff...
# Do some dependency checks and disable things if we don't support them.
if not get_can_enable_search()[0]:
siteconfig.set('search_enable', False)
if not get_can_enable_syntax_highlighting()[0]:
siteconfig.set('diffviewer_syntax_highlighting', False)
# Site administrator settings
apply_setting("ADMINS", None, ((siteconfig.get(
"site_admin_name", ""), siteconfig.get("site_admin_email", "")), ))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the MEDIA_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.MEDIA_URL + "admin/")
# Set the auth backends
auth_backend_map = dict(get_registered_auth_backends())
auth_backend_id = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend_obj = auth_backend_map['builtin']
builtin_backend = "%s.%s" % (builtin_backend_obj.__module__,
builtin_backend_obj.__name__)
if auth_backend_id == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, basestring):
custom_backends = (custom_backends, )
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend, )
elif auth_backend_id != "builtin" and auth_backend_id in auth_backend_map:
backend = auth_backend_map[auth_backend_id]
settings.AUTHENTICATION_BACKENDS = \
("%s.%s" % (backend.__module__, backend.__name__),
builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend, )
# Set the storage backend
storage_backend = siteconfig.settings.get('storage_backend', 'builtin')
if storage_backend in storage_backend_map:
settings.DEFAULT_FILE_STORAGE = storage_backend_map[storage_backend]
else:
settings.DEFAULT_FILE_STORAGE = storage_backend_map['builtin']
# These blow up if they're not the perfectly right types
settings.AWS_ACCESS_KEY_ID = str(siteconfig.get('aws_access_key_id'))
settings.AWS_SECRET_ACCESS_KEY = str(
siteconfig.get('aws_secret_access_key'))
settings.AWS_STORAGE_BUCKET_NAME = str(
siteconfig.get('aws_s3_bucket_name'))
try:
settings.AWS_CALLING_FORMAT = int(siteconfig.get('aws_calling_format'))
except ValueError:
settings.AWS_CALLING_FORMAT = 0
def load_site_config():
"""
Loads any stored site configuration settings and populates the Django
settings object with any that need to be there.
"""
def apply_setting(settings_key, db_key, default=None):
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured, \
"The site configuration entry does not exist in the database. " \
"Re-run `./manage.py` syncdb to fix this."
except:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
# Now for some more complicated stuff...
# Do some dependency checks and disable things if we don't support them.
if not get_can_enable_search()[0]:
siteconfig.set('search_enable', False)
if not get_can_enable_syntax_highlighting()[0]:
siteconfig.set('diffviewer_syntax_highlighting', False)
# Site administrator settings
apply_setting("ADMINS", None, (
(siteconfig.get("site_admin_name", ""),
siteconfig.get("site_admin_email", "")),
))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the MEDIA_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.MEDIA_URL + "admin/")
# Set the auth backends
auth_backend = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend = auth_backend_map['builtin']
if auth_backend == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, basestring):
custom_backends = (custom_backends,)
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend,)
elif auth_backend != "builtin" and auth_backend in auth_backend_map:
settings.AUTHENTICATION_BACKENDS = \
(auth_backend_map[auth_backend], builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend,)
def load_site_config(full_reload=False):
"""Load stored site configuration settings.
This populates the Django settings object with any keys that need to be
there.
"""
global _original_webapi_auth_backends
def apply_setting(settings_key, db_key, default=None):
"""Apply the given siteconfig value to the Django settings object."""
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
# If siteconfig needs to be saved back to the DB, set dirty=true
dirty = False
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured(
"The site configuration entry does not exist in the database. "
"You will need to re-create or upgrade your database.")
except Exception as e:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
logger.error('Could not load siteconfig: %s' % e)
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = \
siteconfig.settings.get('mail_default_from',
global_settings.DEFAULT_FROM_EMAIL)
if (not mail_default_from or
mail_default_from == global_settings.DEFAULT_FROM_EMAIL):
domain = siteconfig.site.domain.split(':')[0]
siteconfig.set('mail_default_from', 'noreply@' + domain)
# STATIC_* and MEDIA_* must be different paths, and differ in meaning.
# If site_static_* is empty or equal to media_static_*, we're probably
# migrating from an earlier Review Board install.
site_static_root = siteconfig.settings.get('site_static_root', '')
site_media_root = siteconfig.settings.get('site_media_root')
if site_static_root == '' or site_static_root == site_media_root:
siteconfig.set('site_static_root', settings.STATIC_ROOT)
site_static_url = siteconfig.settings.get('site_static_url', '')
site_media_url = siteconfig.settings.get('site_media_url')
if site_static_url == '' or site_static_url == site_media_url:
siteconfig.set('site_static_url', settings.STATIC_URL)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
if full_reload and not getattr(settings, 'RUNNING_TEST', False):
# Logging may have changed, so restart logging.
restart_logging()
# Now for some more complicated stuff...
haystack_connections['default'].reset_forwarding()
# Site administrator settings
apply_setting("ADMINS", None, (
(siteconfig.get("site_admin_name", ""),
siteconfig.get("site_admin_email", "")),
))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the STATIC_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.STATIC_URL + "admin/")
# Set the auth backends
auth_backend_id = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend_obj = auth_backends.get('backend_id', 'builtin')
builtin_backend = "%s.%s" % (builtin_backend_obj.__module__,
builtin_backend_obj.__name__)
if auth_backend_id == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, six.string_types):
custom_backends = (custom_backends,)
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend,)
else:
backend = auth_backends.get('backend_id', auth_backend_id)
if backend and backend is not builtin_backend_obj:
settings.AUTHENTICATION_BACKENDS = \
("%s.%s" % (backend.__module__, backend.__name__),
builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend,)
# If we're upgrading from a 1.x LDAP configuration, populate
# ldap_uid and clear ldap_uid_mask
if auth_backend_id == "ldap":
if not hasattr(settings, 'LDAP_UID'):
if hasattr(settings, 'LDAP_UID_MASK'):
# Get the username attribute from the old UID mask
# LDAP attributes can contain only alphanumeric
# characters and the hyphen and must lead with an
# alphabetic character. This is not dependent upon
# locale.
m = re.search("([a-zA-Z][a-zA-Z0-9-]+)=%s",
settings.LDAP_UID_MASK)
if m:
# Assign LDAP_UID the value of the retrieved attribute
settings.LDAP_UID = m.group(1)
else:
# Couldn't match the old value?
# This should be impossible, but in this case, let's
# just guess a sane default and hope for the best.
settings.LDAP_UID = 'uid'
else:
# Neither the old nor new value?
# This should be impossible, but in this case, let's just
# guess a sane default and hope for the best.
settings.LDAP_UID = 'uid'
# Remove the LDAP_UID_MASK value
settings.LDAP_UID_MASK = None
siteconfig.set('auth_ldap_uid', settings.LDAP_UID)
siteconfig.set('auth_ldap_uid_mask', settings.LDAP_UID_MASK)
# Set the dirty flag so we save this back
dirty = True
# Add APITokenBackend to the list of auth backends. This one is always
# present, and is used only for API requests.
settings.AUTHENTICATION_BACKENDS += (
'reviewboard.webapi.auth_backends.TokenAuthBackend',
)
# Reset the WebAPI auth backends in case OAuth2 has become disabled.
settings.WEB_API_AUTH_BACKENDS = _original_webapi_auth_backends
reset_auth_backends()
if oauth2_service_feature.is_enabled():
settings.AUTHENTICATION_BACKENDS += (
'reviewboard.webapi.auth_backends.OAuth2TokenAuthBackend',
)
settings.WEB_API_AUTH_BACKENDS += (
'djblets.webapi.auth.backends.oauth2_tokens'
'.WebAPIOAuth2TokenAuthBackend',
)
# Set the storage backend
storage_backend = siteconfig.settings.get('storage_backend', 'builtin')
if storage_backend in storage_backend_map:
settings.DEFAULT_FILE_STORAGE = storage_backend_map[storage_backend]
else:
settings.DEFAULT_FILE_STORAGE = storage_backend_map['builtin']
# These blow up if they're not the perfectly right types
settings.AWS_QUERYSTRING_AUTH = siteconfig.get('aws_querystring_auth')
settings.AWS_ACCESS_KEY_ID = six.text_type(
siteconfig.get('aws_access_key_id'))
settings.AWS_SECRET_ACCESS_KEY = six.text_type(
siteconfig.get('aws_secret_access_key'))
settings.AWS_STORAGE_BUCKET_NAME = six.text_type(
siteconfig.get('aws_s3_bucket_name'))
try:
settings.AWS_CALLING_FORMAT = int(siteconfig.get('aws_calling_format'))
except ValueError:
settings.AWS_CALLING_FORMAT = 0
settings.SWIFT_AUTH_URL = six.text_type(
siteconfig.get('swift_auth_url'))
settings.SWIFT_USERNAME = six.text_type(
siteconfig.get('swift_username'))
settings.SWIFT_KEY = six.text_type(
siteconfig.get('swift_key'))
try:
settings.SWIFT_AUTH_VERSION = int(siteconfig.get('swift_auth_version'))
except:
settings.SWIFT_AUTH_VERSION = 1
settings.SWIFT_CONTAINER_NAME = six.text_type(
siteconfig.get('swift_container_name'))
is_https = (
siteconfig.settings.get('site_domain_method', 'http') == 'https'
)
settings.CSRF_COOKIE_SECURE = is_https
settings.SESSION_COOKIE_SECURE = is_https
if is_https:
os.environ[str('HTTPS')] = str('on')
else:
os.environ[str('HTTPS')] = str('off')
# Migrate over any legacy avatar backend settings.
if avatar_services.migrate_settings(siteconfig):
dirty = True
# Save back changes if they have been made
if dirty:
siteconfig.save()
# Reload privacy consent requirements
recompute_privacy_consents()
site_settings_loaded.send(sender=None)
return siteconfig
def load_site_config():
"""
Loads any stored site configuration settings and populates the Django
settings object with any that need to be there.
"""
def apply_setting(settings_key, db_key, default=None):
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured(
"The site configuration entry does not exist in the database. " "Re-run `./manage.py` syncdb to fix this."
)
except:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = siteconfig.settings.get("mail_default_from", global_settings.DEFAULT_FROM_EMAIL)
if not mail_default_from or mail_default_from == global_settings.DEFAULT_FROM_EMAIL:
domain = siteconfig.site.domain.split(":")[0]
siteconfig.set("mail_default_from", "noreply@" + domain)
# STATIC_* and MEDIA_* must be different paths, and differ in meaning.
# If site_static_* is empty or equal to media_static_*, we're probably
# migrating from an earlier Review Board install.
site_static_root = siteconfig.settings.get("site_static_root", "")
site_media_root = siteconfig.settings.get("site_media_root")
if site_static_root == "" or site_static_root == site_media_root:
siteconfig.set("site_static_root", settings.STATIC_ROOT)
site_static_url = siteconfig.settings.get("site_static_url", "")
site_media_url = siteconfig.settings.get("site_media_url")
if site_static_url == "" or site_static_url == site_media_url:
siteconfig.set("site_static_url", settings.STATIC_URL)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
# Now for some more complicated stuff...
# Do some dependency checks and disable things if we don't support them.
if not get_can_enable_search()[0]:
siteconfig.set("search_enable", False)
if not get_can_enable_syntax_highlighting()[0]:
siteconfig.set("diffviewer_syntax_highlighting", False)
# Site administrator settings
apply_setting("ADMINS", None, ((siteconfig.get("site_admin_name", ""), siteconfig.get("site_admin_email", "")),))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the STATIC_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.STATIC_URL + "admin/")
# Set the auth backends
auth_backend_map = dict(get_registered_auth_backends())
auth_backend_id = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend_obj = auth_backend_map["builtin"]
builtin_backend = "%s.%s" % (builtin_backend_obj.__module__, builtin_backend_obj.__name__)
if auth_backend_id == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, six.string_types):
custom_backends = (custom_backends,)
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend,)
elif auth_backend_id != "builtin" and auth_backend_id in auth_backend_map:
backend = auth_backend_map[auth_backend_id]
settings.AUTHENTICATION_BACKENDS = ("%s.%s" % (backend.__module__, backend.__name__), builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend,)
# Set the storage backend
storage_backend = siteconfig.settings.get("storage_backend", "builtin")
if storage_backend in storage_backend_map:
settings.DEFAULT_FILE_STORAGE = storage_backend_map[storage_backend]
else:
settings.DEFAULT_FILE_STORAGE = storage_backend_map["builtin"]
# These blow up if they're not the perfectly right types
settings.AWS_QUERYSTRING_AUTH = siteconfig.get("aws_querystring_auth")
settings.AWS_ACCESS_KEY_ID = six.text_type(siteconfig.get("aws_access_key_id"))
settings.AWS_SECRET_ACCESS_KEY = six.text_type(siteconfig.get("aws_secret_access_key"))
settings.AWS_STORAGE_BUCKET_NAME = six.text_type(siteconfig.get("aws_s3_bucket_name"))
try:
settings.AWS_CALLING_FORMAT = int(siteconfig.get("aws_calling_format"))
except ValueError:
settings.AWS_CALLING_FORMAT = 0
def load_site_config(full_reload=False):
"""
Loads any stored site configuration settings and populates the Django
settings object with any that need to be there.
"""
def apply_setting(settings_key, db_key, default=None):
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
def update_haystack_settings():
"""Updates the haystack settings with settings in site config."""
apply_setting(
"HAYSTACK_CONNECTIONS", None, {
'default': {
'ENGINE':
settings.HAYSTACK_CONNECTIONS['default']['ENGINE'],
'PATH': (siteconfig.get('search_index_file')
or defaults['search_index_file']),
},
})
# Re-initialize Haystack's connection information to use the updated
# settings.
connections.connections_info = settings.HAYSTACK_CONNECTIONS
connections._connections = {}
# If siteconfig needs to be saved back to the DB, set dirty=true
dirty = False
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured(
"The site configuration entry does not exist in the database. "
"Re-run `./manage.py` syncdb to fix this.")
except Exception as e:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
logging.error('Could not load siteconfig: %s' % e)
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = \
siteconfig.settings.get('mail_default_from',
global_settings.DEFAULT_FROM_EMAIL)
if (not mail_default_from
or mail_default_from == global_settings.DEFAULT_FROM_EMAIL):
domain = siteconfig.site.domain.split(':')[0]
siteconfig.set('mail_default_from', 'noreply@' + domain)
# STATIC_* and MEDIA_* must be different paths, and differ in meaning.
# If site_static_* is empty or equal to media_static_*, we're probably
# migrating from an earlier Review Board install.
site_static_root = siteconfig.settings.get('site_static_root', '')
site_media_root = siteconfig.settings.get('site_media_root')
if site_static_root == '' or site_static_root == site_media_root:
siteconfig.set('site_static_root', settings.STATIC_ROOT)
site_static_url = siteconfig.settings.get('site_static_url', '')
site_media_url = siteconfig.settings.get('site_media_url')
if site_static_url == '' or site_static_url == site_media_url:
siteconfig.set('site_static_url', settings.STATIC_URL)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
if full_reload and not getattr(settings, 'RUNNING_TEST', False):
# Logging may have changed, so restart logging.
restart_logging()
# Now for some more complicated stuff...
update_haystack_settings()
# Site administrator settings
apply_setting("ADMINS", None, ((siteconfig.get(
"site_admin_name", ""), siteconfig.get("site_admin_email", "")), ))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the STATIC_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.STATIC_URL + "admin/")
# Set the auth backends
auth_backend_id = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend_obj = get_registered_auth_backend('builtin')
builtin_backend = "%s.%s" % (builtin_backend_obj.__module__,
builtin_backend_obj.__name__)
if auth_backend_id == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, six.string_types):
custom_backends = (custom_backends, )
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend, )
else:
backend = get_registered_auth_backend(auth_backend_id)
if backend and backend is not builtin_backend_obj:
settings.AUTHENTICATION_BACKENDS = \
("%s.%s" % (backend.__module__, backend.__name__),
builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend, )
# If we're upgrading from a 1.x LDAP configuration, populate
# ldap_uid and clear ldap_uid_mask
if auth_backend_id == "ldap":
if not hasattr(settings, 'LDAP_UID'):
if hasattr(settings, 'LDAP_UID_MASK'):
# Get the username attribute from the old UID mask
# LDAP attributes can contain only alphanumeric
# characters and the hyphen and must lead with an
# alphabetic character. This is not dependent upon
# locale.
m = re.search("([a-zA-Z][a-zA-Z0-9-]+)=%s",
settings.LDAP_UID_MASK)
if m:
# Assign LDAP_UID the value of the retrieved attribute
settings.LDAP_UID = m.group(1)
else:
# Couldn't match the old value?
# This should be impossible, but in this case, let's
# just guess a sane default and hope for the best.
settings.LDAP_UID = 'uid'
else:
# Neither the old nor new value?
# This should be impossible, but in this case, let's just
# guess a sane default and hope for the best.
settings.LDAP_UID = 'uid'
# Remove the LDAP_UID_MASK value
settings.LDAP_UID_MASK = None
siteconfig.set('auth_ldap_uid', settings.LDAP_UID)
siteconfig.set('auth_ldap_uid_mask', settings.LDAP_UID_MASK)
# Set the dirty flag so we save this back
dirty = True
# Add APITokenBackend to the list of auth backends. This one is always
# present, and is used only for API requests.
settings.AUTHENTICATION_BACKENDS += (
'reviewboard.webapi.auth_backends.TokenAuthBackend', )
# Set the storage backend
storage_backend = siteconfig.settings.get('storage_backend', 'builtin')
if storage_backend in storage_backend_map:
settings.DEFAULT_FILE_STORAGE = storage_backend_map[storage_backend]
else:
settings.DEFAULT_FILE_STORAGE = storage_backend_map['builtin']
# These blow up if they're not the perfectly right types
settings.AWS_QUERYSTRING_AUTH = siteconfig.get('aws_querystring_auth')
settings.AWS_ACCESS_KEY_ID = six.text_type(
siteconfig.get('aws_access_key_id'))
settings.AWS_SECRET_ACCESS_KEY = six.text_type(
siteconfig.get('aws_secret_access_key'))
settings.AWS_STORAGE_BUCKET_NAME = six.text_type(
siteconfig.get('aws_s3_bucket_name'))
try:
settings.AWS_CALLING_FORMAT = int(siteconfig.get('aws_calling_format'))
except ValueError:
settings.AWS_CALLING_FORMAT = 0
if siteconfig.settings.get('site_domain_method', 'http') == 'https':
os.environ['HTTPS'] = 'on'
else:
os.environ['HTTPS'] = 'off'
# Save back changes if they have been made
if dirty:
siteconfig.save()
site_settings_loaded.send(sender=None)
return siteconfig
def load_site_config():
"""
Loads any stored site configuration settings and populates the Django
settings object with any that need to be there.
"""
def apply_setting(settings_key, db_key, default=None):
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
def update_haystack_settings():
"""Updates the haystack settings with settings in site config."""
apply_setting("HAYSTACK_CONNECTIONS", None, {
'default': {
'ENGINE': settings.HAYSTACK_CONNECTIONS['default']['ENGINE'],
'PATH': (siteconfig.get('search_index_file') or
defaults['search_index_file']),
},
})
# Re-initialize Haystack's connection information to use the updated
# settings.
connections.connections_info = settings.HAYSTACK_CONNECTIONS
connections._connections = {}
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured(
"The site configuration entry does not exist in the database. "
"Re-run `./manage.py` syncdb to fix this.")
except:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = \
siteconfig.settings.get('mail_default_from',
global_settings.DEFAULT_FROM_EMAIL)
if (not mail_default_from or
mail_default_from == global_settings.DEFAULT_FROM_EMAIL):
domain = siteconfig.site.domain.split(':')[0]
siteconfig.set('mail_default_from', 'noreply@' + domain)
# STATIC_* and MEDIA_* must be different paths, and differ in meaning.
# If site_static_* is empty or equal to media_static_*, we're probably
# migrating from an earlier Review Board install.
site_static_root = siteconfig.settings.get('site_static_root', '')
site_media_root = siteconfig.settings.get('site_media_root')
if site_static_root == '' or site_static_root == site_media_root:
siteconfig.set('site_static_root', settings.STATIC_ROOT)
site_static_url = siteconfig.settings.get('site_static_url', '')
site_media_url = siteconfig.settings.get('site_media_url')
if site_static_url == '' or site_static_url == site_media_url:
siteconfig.set('site_static_url', settings.STATIC_URL)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
# Now for some more complicated stuff...
update_haystack_settings()
# Do some dependency checks and disable things if we don't support them.
if not get_can_enable_syntax_highlighting()[0]:
siteconfig.set('diffviewer_syntax_highlighting', False)
# Site administrator settings
apply_setting("ADMINS", None, (
(siteconfig.get("site_admin_name", ""),
siteconfig.get("site_admin_email", "")),
))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the STATIC_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.STATIC_URL + "admin/")
# Set the auth backends
auth_backend_id = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend_obj = get_registered_auth_backend('builtin')
builtin_backend = "%s.%s" % (builtin_backend_obj.__module__,
builtin_backend_obj.__name__)
if auth_backend_id == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, six.string_types):
custom_backends = (custom_backends,)
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend,)
else:
backend = get_registered_auth_backend(auth_backend_id)
if backend and backend is not builtin_backend_obj:
settings.AUTHENTICATION_BACKENDS = \
("%s.%s" % (backend.__module__, backend.__name__),
builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend,)
# Set the storage backend
storage_backend = siteconfig.settings.get('storage_backend', 'builtin')
if storage_backend in storage_backend_map:
settings.DEFAULT_FILE_STORAGE = storage_backend_map[storage_backend]
else:
settings.DEFAULT_FILE_STORAGE = storage_backend_map['builtin']
# These blow up if they're not the perfectly right types
settings.AWS_QUERYSTRING_AUTH = siteconfig.get('aws_querystring_auth')
settings.AWS_ACCESS_KEY_ID = six.text_type(siteconfig.get('aws_access_key_id'))
settings.AWS_SECRET_ACCESS_KEY = six.text_type(siteconfig.get('aws_secret_access_key'))
settings.AWS_STORAGE_BUCKET_NAME = six.text_type(siteconfig.get('aws_s3_bucket_name'))
try:
settings.AWS_CALLING_FORMAT = int(siteconfig.get('aws_calling_format'))
except ValueError:
settings.AWS_CALLING_FORMAT = 0
if siteconfig.settings.get('site_domain_method', 'http') == 'https':
os.environ['HTTPS'] = 'on'
else:
os.environ['HTTPS'] = 'off'
site_settings_loaded.send(sender=None)
return siteconfig
def load_site_config():
"""
Loads any stored site configuration settings and populates the Django
settings object with any that need to be there.
"""
def apply_setting(settings_key, db_key, default=None):
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured, \
"The site configuration entry does not exist in the database. " \
"Re-run `./manage.py` syncdb to fix this."
except:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = \
siteconfig.settings.get('mail_default_from',
global_settings.DEFAULT_FROM_EMAIL)
if (not mail_default_from or
mail_default_from == global_settings.DEFAULT_FROM_EMAIL):
domain = siteconfig.site.domain.split(':')[0]
siteconfig.set('mail_default_from', 'noreply@' + domain)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
# Now for some more complicated stuff...
# Do some dependency checks and disable things if we don't support them.
if not get_can_enable_search()[0]:
siteconfig.set('search_enable', False)
if not get_can_enable_syntax_highlighting()[0]:
siteconfig.set('diffviewer_syntax_highlighting', False)
# Site administrator settings
apply_setting("ADMINS", None, (
(siteconfig.get("site_admin_name", ""),
siteconfig.get("site_admin_email", "")),
))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the MEDIA_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.MEDIA_URL + "admin/")
# Set the auth backends
auth_backend_map = dict(get_registered_auth_backends())
auth_backend_id = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend_obj = auth_backend_map['builtin']
builtin_backend = "%s.%s" % (builtin_backend_obj.__module__,
builtin_backend_obj.__name__)
if auth_backend_id == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, basestring):
custom_backends = (custom_backends,)
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend,)
elif auth_backend_id != "builtin" and auth_backend_id in auth_backend_map:
backend = auth_backend_map[auth_backend_id]
settings.AUTHENTICATION_BACKENDS = \
("%s.%s" % (backend.__module__, backend.__name__),
builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend,)
# Set the storage backend
storage_backend = siteconfig.settings.get('storage_backend', 'builtin')
if storage_backend in storage_backend_map:
settings.DEFAULT_FILE_STORAGE = storage_backend_map[storage_backend]
else:
settings.DEFAULT_FILE_STORAGE = storage_backend_map['builtin']
# These blow up if they're not the perfectly right types
settings.AWS_ACCESS_KEY_ID = str(siteconfig.get('aws_access_key_id'))
settings.AWS_SECRET_ACCESS_KEY = str(siteconfig.get('aws_secret_access_key'))
settings.AWS_STORAGE_BUCKET_NAME = str(siteconfig.get('aws_s3_bucket_name'))
settings.AWS_CALLING_FORMAT = int(siteconfig.get('aws_calling_format'))
def load_site_config():
"""
Loads any stored site configuration settings and populates the Django
settings object with any that need to be there.
"""
def apply_setting(settings_key, db_key, default=None):
db_value = siteconfig.settings.get(db_key)
if db_value:
setattr(settings, settings_key, db_value)
elif default:
setattr(settings, settings_key, default)
def update_haystack_settings():
"""Updates the haystack settings with settings in site config."""
apply_setting(
"HAYSTACK_CONNECTIONS",
None,
{
"default": {
"ENGINE": settings.HAYSTACK_CONNECTIONS["default"]["ENGINE"],
"PATH": (siteconfig.get("search_index_file") or defaults["search_index_file"]),
}
},
)
# Re-initialize Haystack's connection information to use the updated
# settings.
connections.connections_info = settings.HAYSTACK_CONNECTIONS
connections._connections = {}
# If siteconfig needs to be saved back to the DB, set dirty=true
dirty = False
try:
siteconfig = SiteConfiguration.objects.get_current()
except SiteConfiguration.DoesNotExist:
raise ImproperlyConfigured(
"The site configuration entry does not exist in the database. " "Re-run `./manage.py` syncdb to fix this."
)
except Exception as e:
# We got something else. Likely, this doesn't exist yet and we're
# doing a syncdb or something, so silently ignore.
logging.error("Could not load siteconfig: %s" % e)
return
# Populate defaults if they weren't already set.
if not siteconfig.get_defaults():
siteconfig.add_defaults(defaults)
# The default value for DEFAULT_EMAIL_FROM (webmaster@localhost)
# is less than good, so use a better one if it's set to that or if
# we haven't yet set this value in siteconfig.
mail_default_from = siteconfig.settings.get("mail_default_from", global_settings.DEFAULT_FROM_EMAIL)
if not mail_default_from or mail_default_from == global_settings.DEFAULT_FROM_EMAIL:
domain = siteconfig.site.domain.split(":")[0]
siteconfig.set("mail_default_from", "noreply@" + domain)
# STATIC_* and MEDIA_* must be different paths, and differ in meaning.
# If site_static_* is empty or equal to media_static_*, we're probably
# migrating from an earlier Review Board install.
site_static_root = siteconfig.settings.get("site_static_root", "")
site_media_root = siteconfig.settings.get("site_media_root")
if site_static_root == "" or site_static_root == site_media_root:
siteconfig.set("site_static_root", settings.STATIC_ROOT)
site_static_url = siteconfig.settings.get("site_static_url", "")
site_media_url = siteconfig.settings.get("site_media_url")
if site_static_url == "" or site_static_url == site_media_url:
siteconfig.set("site_static_url", settings.STATIC_URL)
# Populate the settings object with anything relevant from the siteconfig.
apply_django_settings(siteconfig, settings_map)
# Now for some more complicated stuff...
update_haystack_settings()
# Do some dependency checks and disable things if we don't support them.
if not get_can_enable_syntax_highlighting()[0]:
siteconfig.set("diffviewer_syntax_highlighting", False)
# Site administrator settings
apply_setting("ADMINS", None, ((siteconfig.get("site_admin_name", ""), siteconfig.get("site_admin_email", "")),))
apply_setting("MANAGERS", None, settings.ADMINS)
# Explicitly base this off the STATIC_URL
apply_setting("ADMIN_MEDIA_PREFIX", None, settings.STATIC_URL + "admin/")
# Set the auth backends
auth_backend_id = siteconfig.settings.get("auth_backend", "builtin")
builtin_backend_obj = get_registered_auth_backend("builtin")
builtin_backend = "%s.%s" % (builtin_backend_obj.__module__, builtin_backend_obj.__name__)
if auth_backend_id == "custom":
custom_backends = siteconfig.settings.get("auth_custom_backends")
if isinstance(custom_backends, six.string_types):
custom_backends = (custom_backends,)
elif isinstance(custom_backends, list):
custom_backends = tuple(custom_backends)
settings.AUTHENTICATION_BACKENDS = custom_backends
if builtin_backend not in custom_backends:
settings.AUTHENTICATION_BACKENDS += (builtin_backend,)
else:
backend = get_registered_auth_backend(auth_backend_id)
if backend and backend is not builtin_backend_obj:
settings.AUTHENTICATION_BACKENDS = ("%s.%s" % (backend.__module__, backend.__name__), builtin_backend)
else:
settings.AUTHENTICATION_BACKENDS = (builtin_backend,)
# If we're upgrading from a 1.x LDAP configuration, populate
# ldap_uid and clear ldap_uid_mask
if auth_backend_id == "ldap":
if not hasattr(settings, "LDAP_UID"):
if hasattr(settings, "LDAP_UID_MASK"):
# Get the username attribute from the old UID mask
# LDAP attributes can contain only alphanumeric
# characters and the hyphen and must lead with an
# alphabetic character. This is not dependent upon
# locale.
m = re.search("([a-zA-Z][a-zA-Z0-9-]+)=%s", settings.LDAP_UID_MASK)
if m:
# Assign LDAP_UID the value of the retrieved attribute
settings.LDAP_UID = m.group(1)
else:
# Couldn't match the old value?
# This should be impossible, but in this case, let's
# just guess a sane default and hope for the best.
settings.LDAP_UID = "uid"
else:
# Neither the old nor new value?
# This should be impossible, but in this case, let's just
# guess a sane default and hope for the best.
settings.LDAP_UID = "uid"
# Remove the LDAP_UID_MASK value
settings.LDAP_UID_MASK = None
siteconfig.set("auth_ldap_uid", settings.LDAP_UID)
siteconfig.set("auth_ldap_uid_mask", settings.LDAP_UID_MASK)
# Set the dirty flag so we save this back
dirty = True
# Set the storage backend
storage_backend = siteconfig.settings.get("storage_backend", "builtin")
if storage_backend in storage_backend_map:
settings.DEFAULT_FILE_STORAGE = storage_backend_map[storage_backend]
else:
settings.DEFAULT_FILE_STORAGE = storage_backend_map["builtin"]
# These blow up if they're not the perfectly right types
settings.AWS_QUERYSTRING_AUTH = siteconfig.get("aws_querystring_auth")
settings.AWS_ACCESS_KEY_ID = six.text_type(siteconfig.get("aws_access_key_id"))
settings.AWS_SECRET_ACCESS_KEY = six.text_type(siteconfig.get("aws_secret_access_key"))
settings.AWS_STORAGE_BUCKET_NAME = six.text_type(siteconfig.get("aws_s3_bucket_name"))
try:
settings.AWS_CALLING_FORMAT = int(siteconfig.get("aws_calling_format"))
except ValueError:
settings.AWS_CALLING_FORMAT = 0
if siteconfig.settings.get("site_domain_method", "http") == "https":
os.environ["HTTPS"] = "on"
else:
os.environ["HTTPS"] = "off"
# Save back changes if they have been made
if dirty:
siteconfig.save()
site_settings_loaded.send(sender=None)
return siteconfig
