Use properties in config for pass-through compat vars
Strings are immutable, so when one variable changes the other will not, as such there is variance on config load between variables that should be the the value of another variable. To solve that I've moved the config into a class and made those values read-only properties to the loaded values. Closes: #137 #138
This commit is contained in:
Sachi King
parent
9fd2661405
commit
695dba98f9
|
|
@ -164,7 +164,7 @@ def error_handler(e):
|
|||
|
||||
def create_app(config=None):
|
||||
app = Application(__name__)
|
||||
app.config.from_object('realms.config')
|
||||
app.config.from_object('realms.config.conf')
|
||||
app.url_map.converters['regex'] = RegexConverter
|
||||
app.url_map.strict_slashes = False
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,8 @@ import pip
|
|||
import time
|
||||
import subprocess
|
||||
|
||||
config = config.conf
|
||||
|
||||
# called to discover commands in modules
|
||||
app = create_app()
|
||||
|
||||
|
|
|
|||
|
|
@ -1,65 +1,14 @@
|
|||
import os
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
from urlparse import urlparse
|
||||
|
||||
from realms.lib.util import in_vagrant
|
||||
|
||||
|
||||
def update(data):
|
||||
conf = read()
|
||||
conf.update(data)
|
||||
return save(data)
|
||||
|
||||
|
||||
def read():
|
||||
conf = dict()
|
||||
|
||||
for k, v in os.environ.items():
|
||||
if k.startswith('REALMS_'):
|
||||
conf[k[7:]] = v
|
||||
|
||||
loc = get_path()
|
||||
|
||||
if loc:
|
||||
with open(loc) as f:
|
||||
conf.update(json.load(f))
|
||||
|
||||
for k in ['APP_PATH', 'USER_HOME']:
|
||||
if k in conf:
|
||||
del conf[k]
|
||||
|
||||
return conf
|
||||
|
||||
|
||||
def save(conf):
|
||||
loc = get_path(check_write=True)
|
||||
with open(loc, 'w') as f:
|
||||
f.write(json.dumps(conf, sort_keys=True, indent=4, separators=(',', ': ')).strip() + '\n')
|
||||
return loc
|
||||
|
||||
|
||||
def get_path(check_write=False):
|
||||
"""Find config path
|
||||
"""
|
||||
for loc in os.curdir, os.path.expanduser("~"), "/etc/realms-wiki":
|
||||
if not loc:
|
||||
continue
|
||||
path = os.path.join(loc, "realms-wiki.json")
|
||||
if os.path.isfile(path):
|
||||
# file exists
|
||||
if not check_write:
|
||||
# Don't care if I can write
|
||||
return path
|
||||
|
||||
if os.access(path, os.W_OK):
|
||||
# Has write access, ok!
|
||||
return path
|
||||
elif os.path.isdir(loc) and check_write:
|
||||
# dir exists file doesn't
|
||||
if os.access(loc, os.W_OK):
|
||||
# can write file
|
||||
return path
|
||||
return None
|
||||
class Config(object):
|
||||
|
||||
urlparse = urlparse
|
||||
|
||||
APP_PATH = os.path.abspath(os.path.dirname(__file__) + "/../..")
|
||||
USER_HOME = os.path.abspath(os.path.expanduser("~"))
|
||||
|
|
@ -69,10 +18,6 @@ PIDFILE = "/tmp/realms-wiki.pid"
|
|||
|
||||
ENV = 'DEV'
|
||||
|
||||
DEBUG = True
|
||||
ASSETS_DEBUG = True
|
||||
SQLALCHEMY_ECHO = False
|
||||
|
||||
HOST = "0.0.0.0"
|
||||
PORT = 5000
|
||||
BASE_URL = 'http://localhost'
|
||||
|
|
@ -117,25 +62,21 @@ DB_URI = 'sqlite:////tmp/wiki.db'
|
|||
# }
|
||||
# }
|
||||
|
||||
# Valid options: simple, redis, memcached
|
||||
CACHE_TYPE = 'simple'
|
||||
|
||||
# Redis
|
||||
# CACHE_TYPE = 'redis'
|
||||
CACHE_REDIS_HOST = '127.0.0.1'
|
||||
CACHE_REDIS_PORT = 6379
|
||||
CACHE_REDIS_DB = '0'
|
||||
|
||||
# Memcached
|
||||
# CACHE_TYPE = 'memcached'
|
||||
CACHE_MEMCACHED_SERVERS = ['127.0.0.1:11211']
|
||||
|
||||
SEARCH_TYPE = 'simple' # simple is not good for large wikis
|
||||
# Valid options: simple, elasticsearch, woosh
|
||||
SEARCH_TYPE = 'simple'
|
||||
|
||||
# SEARCH_TYPE = 'elasticsearch'
|
||||
ELASTICSEARCH_URL = 'http://127.0.0.1:9200'
|
||||
ELASTICSEARCH_FIELDS = ["name"]
|
||||
|
||||
# SEARCH_TYPE = 'whoosh'
|
||||
WHOOSH_INDEX = '/tmp/whoosh'
|
||||
WHOOSH_LANGUAGE = 'en'
|
||||
|
||||
|
|
@ -172,37 +113,106 @@ WIKI_LOCKED_PAGES = []
|
|||
ROOT_ENDPOINT = 'wiki.page'
|
||||
|
||||
# Used by Flask-Login
|
||||
LOGIN_DISABLED = ALLOW_ANON
|
||||
@property
|
||||
def LOGIN_DISABLED(self):
|
||||
return self.ALLOW_ANON
|
||||
|
||||
# Depreciated variable name
|
||||
LOCKED = WIKI_LOCKED_PAGES[:]
|
||||
@property
|
||||
def LOCKED(self):
|
||||
return self.WIKI_LOCKED_PAGES[:]
|
||||
|
||||
if BASE_URL.endswith('/'):
|
||||
BASE_URL = BASE_URL[:-1]
|
||||
@property
|
||||
def SQLALCHEMY_DATABASE_URI(self):
|
||||
return self.DB_URI
|
||||
|
||||
SQLALCHEMY_DATABASE_URI = DB_URI
|
||||
@property
|
||||
def _url(self):
|
||||
return urlparse(self.BASE_URL)
|
||||
|
||||
_url = urlparse(BASE_URL)
|
||||
RELATIVE_PATH = _url.path
|
||||
@property
|
||||
def RELATIVE_PATH(self):
|
||||
return self._url.path
|
||||
|
||||
if in_vagrant():
|
||||
# sendfile doesn't work well with Virtualbox shared folders
|
||||
USE_X_SENDFILE = False
|
||||
|
||||
if ENV != "DEV":
|
||||
DEBUG = False
|
||||
ASSETS_DEBUG = False
|
||||
SQLALCHEMY_ECHO = False
|
||||
|
||||
MODULES = ['wiki', 'search', 'auth']
|
||||
|
||||
globals().update(read())
|
||||
def __init__(self):
|
||||
for k, v in self.read().iteritems():
|
||||
setattr(self, k, v)
|
||||
if hasattr(self, 'AUTH_LOCAL_ENABLE'):
|
||||
self.MODULES.append('auth.local')
|
||||
if hasattr(self, 'OAUTH'):
|
||||
self.MODULES.append('auth.oauth')
|
||||
if hasattr(self, 'LDAP'):
|
||||
self.MODULES.append('auth.ldap')
|
||||
if in_vagrant():
|
||||
self.USE_X_SENDFILE = False
|
||||
if self.ENV == "DEV":
|
||||
self.DEBUG = True
|
||||
self.ASSETS_DEBUG = True
|
||||
self.SQLALCHEMY_ECHO = True
|
||||
self.USE_X_SENDFILE = False
|
||||
|
||||
if globals().get('AUTH_LOCAL_ENABLE'):
|
||||
MODULES.append('auth.local')
|
||||
def update(self, data):
|
||||
conf = self.read()
|
||||
conf.update(data)
|
||||
return self.save(data)
|
||||
|
||||
if globals().get('OAUTH'):
|
||||
MODULES.append('auth.oauth')
|
||||
def read(self):
|
||||
conf = dict()
|
||||
|
||||
if globals().get('LDAP'):
|
||||
MODULES.append('auth.ldap')
|
||||
for k, v in os.environ.items():
|
||||
if k.startswith('REALMS_'):
|
||||
conf[k[7:]] = v
|
||||
|
||||
loc = self.get_path()
|
||||
|
||||
if loc:
|
||||
with open(loc) as f:
|
||||
conf.update(json.load(f))
|
||||
|
||||
if 'BASE_URL' in conf and conf['BASE_URL'].endswith('/'):
|
||||
conf['BASE_URL'] = conf['BASE_URL'][:-1]
|
||||
|
||||
for k in ['APP_PATH', 'USER_HOME']:
|
||||
if k in conf:
|
||||
del conf[k]
|
||||
|
||||
return conf
|
||||
|
||||
def save(self, conf):
|
||||
loc = self.get_path(check_write=True)
|
||||
with open(loc, 'w') as f:
|
||||
f.write(json.dumps(conf, sort_keys=True, indent=4, separators=(',', ': ')).strip() + '\n')
|
||||
return loc
|
||||
|
||||
def get_path(self, check_write=False):
|
||||
"""Find config path
|
||||
"""
|
||||
for loc in os.curdir, os.path.expanduser("~"), "/etc/realms-wiki":
|
||||
if not loc:
|
||||
continue
|
||||
path = os.path.join(loc, "realms-wiki.json")
|
||||
if os.path.isfile(path):
|
||||
# file exists
|
||||
if not check_write:
|
||||
# Don't care if I can write
|
||||
return path
|
||||
|
||||
if os.access(path, os.W_OK):
|
||||
# Has write access, ok!
|
||||
return path
|
||||
elif os.path.isdir(loc) and check_write:
|
||||
# dir exists file doesn't
|
||||
if os.access(loc, os.W_OK):
|
||||
# can write file
|
||||
return path
|
||||
return None
|
||||
|
||||
conf = Config()
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ from flask_oauthlib.client import OAuth
|
|||
from realms import config
|
||||
from ..models import BaseUser
|
||||
|
||||
config = config.conf
|
||||
|
||||
oauth = OAuth()
|
||||
|
||||
users = {}
|
||||
|
|
|
|||
Loading…
Reference in a new issue