-
Notifications
You must be signed in to change notification settings - Fork 2k
/
app_globals.py
197 lines (163 loc) · 6.03 KB
/
app_globals.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
''' The application's Globals object '''
import logging
import time
from threading import Lock
from paste.deploy.converters import asbool
from pylons import config
import ckan.model as model
log = logging.getLogger(__name__)
# mappings translate between config settings and globals because our naming
# conventions are not well defined and/or implemented
mappings = {
# 'config_key': 'globals_key',
}
# these config settings will get updated from system_info
auto_update = [
'ckan.site_title',
'ckan.site_logo',
'ckan.site_url',
'ckan.site_description',
'ckan.site_about',
'ckan.site_intro_text',
'ckan.site_custom_css',
]
config_details = {
'ckan.favicon': {}, # default gets set in config.environment.py
'ckan.template_head_end': {},
'ckan.template_footer_end': {},
# has been setup in load_environment():
'ckan.site_id': {},
'ckan.recaptcha.publickey': {'name': 'recaptcha_publickey'},
'ckan.recaptcha.privatekey': {'name': 'recaptcha_publickey'},
'ckan.template_title_deliminater': {'default': '-'},
'ckan.template_head_end': {},
'ckan.template_footer_end': {},
'ckan.dumps_url': {},
'ckan.dumps_format': {},
'ckan.api_url': {},
# split string
'search.facets': {'default': 'groups tags res_format license',
'type': 'split',
'name': 'facets'},
'package_hide_extras': {'type': 'split'},
'ckan.plugins': {'type': 'split'},
# bool
'openid_enabled': {'default': 'true', 'type' : 'bool'},
'debug': {'default': 'false', 'type' : 'bool'},
'ckan.debug_supress_header' : {'default': 'false', 'type' : 'bool'},
# int
'ckan.datasets_per_page': {'default': '20', 'type': 'int'},
'ckan.activity_list_limit': {'default': '30', 'type': 'int'},
}
# A place to store the origional config options of we override them
_CONFIG_CACHE = {}
def set_main_css(css_file):
''' Sets the main_css using debug css if needed. The css_file
must be of the form file.css '''
assert css_file.endswith('.css')
if config.debug and css_file == '/base/css/main.css':
new_css = '/base/css/main.debug.css'
else:
new_css = css_file
# FIXME we should check the css file exists
app_globals.main_css = str(new_css)
def set_global(key, value):
''' helper function for getting value from database or config file '''
model.set_system_info(key, value)
setattr(app_globals, get_globals_key(key), value)
model.set_system_info('ckan.config_update', str(time.time()))
# update the config
config[key] = value
log.info('config `%s` set to `%s`' % (key, value))
def delete_global(key):
model.delete_system_info(key)
log.info('config `%s` deleted' % (key))
def get_globals_key(key):
# create our globals key
# these can be specified in mappings or else we remove
# the `ckan.` part this is to keep the existing namings
# set the value
if key in mappings:
return mappings[key]
elif key.startswith('ckan.'):
return key[5:]
def reset():
''' set updatable values from config '''
def get_config_value(key, default=''):
if model.meta.engine.has_table('system_info'):
value = model.get_system_info(key)
else:
value = None
# we want to store the config the first time we get here so we can
# reset them if needed
config_value = config.get(key)
if key not in _CONFIG_CACHE:
_CONFIG_CACHE[key] = config_value
if value is not None:
log.debug('config `%s` set to `%s` from db' % (key, value))
else:
value = _CONFIG_CACHE[key]
if value:
log.debug('config `%s` set to `%s` from config' % (key, value))
else:
value = default
setattr(app_globals, get_globals_key(key), value)
# update the config
config[key] = value
return value
# update the config settings in auto update
for key in auto_update:
get_config_value(key)
# cusom styling
main_css = get_config_value('ckan.main_css', '/base/css/main.css')
set_main_css(main_css)
# site_url_nice
site_url_nice = app_globals.site_url.replace('http://', '')
site_url_nice = site_url_nice.replace('www.', '')
app_globals.site_url_nice = site_url_nice
if app_globals.site_logo:
app_globals.header_class = 'header-image'
elif not app_globals.site_description:
app_globals.header_class = 'header-text-logo'
else:
app_globals.header_class = 'header-text-logo-tagline'
class _Globals(object):
''' Globals acts as a container for objects available throughout the
life of the application. '''
def __init__(self):
'''One instance of Globals is created during application
initialization and is available during requests via the
'app_globals' variable
'''
self._init()
self._config_update = None
self._mutex = Lock()
def _check_uptodate(self):
''' check the config is uptodate needed when several instances are
running '''
value = model.get_system_info('ckan.config_update')
if self._config_update != value:
if self._mutex.acquire(False):
reset()
self._config_update = value
self._mutex.release()
def _init(self):
# process the config_details to set globals
for name, options in config_details.items():
if 'name' in options:
key = options['name']
elif name.startswith('ckan.'):
key = name[5:]
else:
key = name
value = config.get(name, options.get('default', ''))
data_type = options.get('type')
if data_type == 'bool':
value = asbool(value)
elif data_type == 'int':
value = int(value)
elif data_type == 'split':
value = value.split()
setattr(self, key, value)
app_globals = _Globals()
del _Globals