/
__init__.py
413 lines (351 loc) · 17.1 KB
/
__init__.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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
# -*- coding: utf-8 -*-
from __future__ import absolute_import
import json
import gettext
from pytz import timezone, UTC
from pytz.tzinfo import BaseTzInfo
from speaklater import is_lazy_string
import six
from furl import furl
import pycountry
from flask import Blueprint, request, current_app
from flask.json import JSONEncoder as JSONEncoderBase
from flask_assets import Environment, Bundle
from flask_caching import Cache
from flask_babelex import Babel, Domain
from coaster.assets import split_namespec
from coaster.auth import current_auth, request_has_auth
from coaster.sqlalchemy import RoleAccessProxy
try:
from flask_debugtoolbar import DebugToolbarExtension
except ImportError:
DebugToolbarExtension = None
try:
from flask_debugtoolbar_lineprofilerpanel.profile import line_profile
except ImportError:
line_profile = None
from ._version import * # NOQA
from .assets import assets, Version
from . import translations
__all__ = ['baseframe', 'baseframe_js', 'baseframe_css', 'assets', 'Version', '_', '__'] # NOQA
networkbar_cache = Cache(with_jinja2_ext=False)
asset_cache = Cache(with_jinja2_ext=False)
cache = Cache()
babel = Babel()
if DebugToolbarExtension is not None: # pragma: no cover
toolbar = DebugToolbarExtension()
else: # pragma: no cover
toolbar = None
THEME_FILES = {
'bootstrap3': {
'ajaxform.html.jinja2': 'baseframe/bootstrap3/ajaxform.html.jinja2',
'autoform.html.jinja2': 'baseframe/bootstrap3/autoform.html.jinja2',
'delete.html.jinja2': 'baseframe/bootstrap3/delete.html.jinja2',
'message.html.jinja2': 'baseframe/bootstrap3/message.html.jinja2',
'redirect.html.jinja2': 'baseframe/bootstrap3/redirect.html.jinja2'
},
'mui': {
'ajaxform.html.jinja2': 'baseframe/mui/ajaxform.html.jinja2',
'autoform.html.jinja2': 'baseframe/mui/autoform.html.jinja2',
'delete.html.jinja2': 'baseframe/mui/delete.html.jinja2',
'message.html.jinja2': 'baseframe/mui/message.html.jinja2',
'redirect.html.jinja2': 'baseframe/mui/redirect.html.jinja2'
}
}
baseframe_translations = Domain(translations.__path__[0], domain='baseframe')
_ = baseframe_translations.gettext
__ = baseframe_translations.lazy_gettext
class JSONEncoder(JSONEncoderBase):
"""
Custom JSON encoder that adds support to types that are not supported
by Flask's JSON encoder. Eg: lazy_gettext
"""
def default(self, o):
if is_lazy_string(o):
return six.text_type(o)
if isinstance(o, BaseTzInfo):
return o.zone
if isinstance(o, RoleAccessProxy):
return dict(o)
if isinstance(o, furl):
return o.url
return super(JSONEncoder, self).default(o)
def _select_jinja_autoescape(filename):
"""
Returns `True` if autoescaping should be active for the given template name.
"""
if filename is None:
return False
return filename.endswith(('.html', '.htm', '.xml', '.xhtml',
'.html.jinja', '.html.jinja2', '.xml.jinja', '.xml.jinja2', '.xhtml.jinja', '.xhtml.jinja2'))
class BaseframeBlueprint(Blueprint):
def init_app(self, app, requires=[], ext_requires=[], bundle_js=None, bundle_css=None, assetenv=None, theme='bootstrap3'):
"""
Initialize an app and load necessary assets.
:param requires: List of required assets. If an asset has both .js
and .css components, both will be added to the requirement list.
Loaded assets will be minified and concatenated into the app's
``static/js`` and ``static/css`` folders. If an asset has problems
with either of these, it should be loaded pre-bundled via the
``bundle_js`` and ``bundle_css`` parameters.
:param ext_requires: Same as requires, but will be loaded from
an external cookiefree server if ``ASSET_SERVER`` is in config,
before the reqular requires list. Assets are loaded as part of
``requires`` if there is no asset server
:param bundle_js: Bundle of additional JavaScript
:param bundle_css: Bundle of additional CSS
:param assetenv: Environment for assets (in case your app needs a custom environment)
"""
# Since Flask 0.11, templates are no longer auto reloaded.
# Setting the config alone doesn't seem to work, so we explicitly
# set the jinja environment here.
if app.config.get('TEMPLATES_AUTO_RELOAD') or (
app.config.get('TEMPLATES_AUTO_RELOAD') is None and app.config.get('DEBUG')):
app.jinja_env.auto_reload = True
app.jinja_env.add_extension('jinja2.ext.do')
app.jinja_env.autoescape = _select_jinja_autoescape
if app.subdomain_matching:
# Does this app want a static subdomain? (Default: yes, 'static').
# Apps can disable this by setting STATIC_SUBDOMAIN = None.
# Since Werkzeug internally uses '' instead of None, but takes None
# as the default parameter, we remap '' to None in our config
subdomain = app.config.get('STATIC_SUBDOMAIN', 'static') or None
if subdomain:
for rule in app.url_map.iter_rules('static'):
# For safety, seek out and update the static route added by Flask.
# Do not touch additional static routes added by the app or other
# blueprints
if not rule.subdomain: # Will be '' not None
rule.subdomain = subdomain
rule.refresh()
break
else:
subdomain = None
ignore_js = ['!jquery.js']
ignore_css = []
ext_js = []
ext_css = []
if app.config.get('ASSET_SERVER'):
for itemgroup in ext_requires:
sub_js = []
sub_css = []
if not isinstance(itemgroup, (list, tuple)):
itemgroup = [itemgroup]
for item in itemgroup:
name, spec = split_namespec(item)
for alist, ilist, ext in [(sub_js, ignore_js, '.js'), (sub_css, ignore_css, '.css')]:
if name + ext in assets:
alist.append(name + ext + six.text_type(spec))
ilist.append('!' + name + ext)
if sub_js:
ext_js.append(sub_js)
if sub_css:
ext_css.append(sub_css)
else:
requires = [item for itemgroup in ext_requires
for item in (itemgroup if isinstance(itemgroup, (list, tuple)) else [itemgroup])] + requires
app.config['ext_js'] = ext_js
app.config['ext_css'] = ext_css
assets_js = []
assets_css = []
for item in requires:
name, spec = split_namespec(item)
for alist, ext in [(assets_js, '.js'), (assets_css, '.css')]:
if name + ext in assets:
alist.append(name + ext + six.text_type(spec))
js_all = Bundle(assets.require(*(ignore_js + assets_js)),
filters='uglipyjs', output='js/baseframe-packed.js')
css_all = Bundle(assets.require(*(ignore_css + assets_css)),
filters=['cssrewrite', 'cssmin'], output='css/baseframe-packed.css')
if bundle_js:
js_all = Bundle(js_all, bundle_js)
if bundle_css:
css_all = Bundle(css_all, bundle_css)
if assetenv is None:
app.assets = Environment(app)
else:
app.assets = assetenv
app.assets.register('js_jquery', assets.require('jquery.js'))
app.assets.register('js_all', js_all)
app.assets.register('css_all', css_all)
app.register_blueprint(self, static_subdomain=subdomain)
# Optional config for a client app to use a manifest file
# to load fingerprinted assets
# If used with webpack, the client app is expected to specify its own webpack.config.js
# Set `ASSETS_MANIFEST_PATH` in `app.config` to the path for `manifest.json`.
# Eg: "static/build/manifest.json"
# Set `ASSET_BASE_PATH` in `app.config` to the path in which the compiled assets are present.
# Eg: "static/build"
if app.config.get('ASSET_MANIFEST_PATH'):
# Load assets into config from a manifest file
with app.open_resource(app.config['ASSET_MANIFEST_PATH']) as f:
asset_bundles = json.loads(f.read())
if app.config.get('assets'):
raise ValueError("Loading assets via a manifest file needs the `ASSETS` config key to be unused")
app.config['assets'] = {}
for asset_key, asset_path in asset_bundles['assets'].items():
app.config['assets'][asset_key] = asset_path
app.config.setdefault('CACHE_KEY_PREFIX', 'flask_cache_' + app.name + '/')
nwcacheconfig = dict(app.config)
nwcacheconfig['CACHE_KEY_PREFIX'] = 'networkbar_'
if 'CACHE_TYPE' not in nwcacheconfig:
nwcacheconfig['CACHE_TYPE'] = 'simple'
acacheconfig = dict(app.config)
acacheconfig['CACHE_KEY_PREFIX'] = 'asset_'
if 'CACHE_TYPE' not in acacheconfig:
acacheconfig['CACHE_TYPE'] = 'simple'
networkbar_cache.init_app(app, config=nwcacheconfig)
asset_cache.init_app(app, config=acacheconfig)
cache.init_app(app)
babel.init_app(app)
if toolbar is not None:
if 'DEBUG_TB_PANELS' not in app.config:
app.config['DEBUG_TB_PANELS'] = [
'flask_debugtoolbar.panels.versions.VersionDebugPanel',
'flask_debugtoolbar.panels.timer.TimerDebugPanel',
'flask_debugtoolbar.panels.headers.HeaderDebugPanel',
'flask_debugtoolbar.panels.request_vars.RequestVarsDebugPanel',
'flask_debugtoolbar.panels.config_vars.ConfigVarsDebugPanel',
'flask_debugtoolbar.panels.template.TemplateDebugPanel',
'flask_debugtoolbar.panels.sqlalchemy.SQLAlchemyDebugPanel',
'flask_debugtoolbar.panels.logger.LoggingPanel',
'flask_debugtoolbar.panels.route_list.RouteListDebugPanel',
'flask_debugtoolbar.panels.profiler.ProfilerDebugPanel',
]
if line_profile is not None:
app.config['DEBUG_TB_PANELS'].append(
'flask_debugtoolbar_lineprofilerpanel.panels.LineProfilerPanel')
toolbar.init_app(app)
app.json_encoder = JSONEncoder
# If this app has a Lastuser extension registered, give it a cache
lastuser = getattr(app, 'extensions', {}).get('lastuser')
if lastuser and hasattr(lastuser, 'init_cache'):
lastuser.init_cache(app=app, cache=cache)
app.config['tz'] = timezone(app.config.get('TIMEZONE', 'UTC'))
if theme not in THEME_FILES:
raise ValueError("Unrecognised theme: %s" % theme)
app.config['theme'] = theme
if 'NETWORKBAR_DATA' not in app.config:
app.config['NETWORKBAR_DATA'] = 'https://api.hasgeek.com/1/networkbar/networkbar.json'
if isinstance(app.config.get('NETWORKBAR_DATA'), (list, tuple)):
app.config['NETWORKBAR_LINKS'] = app.config['NETWORKBAR_DATA']
def register(self, app, options, first_registration=False):
"""
Called by :meth:`Flask.register_blueprint` to register all views
and callbacks registered on the blueprint with the application. Creates
a :class:`.BlueprintSetupState` and calls each :meth:`record` callback
with it.
:param app: The application this blueprint is being registered with.
:param options: Keyword arguments forwarded from
:meth:`~Flask.register_blueprint`.
:param first_registration: Whether this is the first time this
blueprint has been registered on the application.
"""
self._got_registered_once = True
state = self.make_setup_state(app, options, first_registration)
if self.has_static_folder:
state.add_url_rule(
self.static_url_path + '/<path:filename>',
view_func=self.send_static_file,
endpoint='static',
subdomain=options.get('static_subdomain'))
for deferred in self.deferred_functions:
deferred(state)
baseframe = BaseframeBlueprint('baseframe', __name__,
static_folder='static',
static_url_path='/_baseframe',
template_folder='templates')
@babel.localeselector
def get_locale():
# If this app and request have a user that specifies a locale, use it
user = current_auth.actor # Use 'actor' instead of 'user' to support anon users
if user is not None and hasattr(user, 'locale') and user.locale:
return user.locale
# Otherwise try to guess the language from the user accept
# header the browser transmits. We support a few in this
# example. The best match wins.
# FIXME: Do this properly. Don't use a random selection of languages
return request.accept_languages.best_match(['de', 'fr', 'es', 'hi', 'te', 'ta', 'kn', 'ml', 'en']) or 'en'
@babel.timezoneselector
def get_timezone():
# If this app and request have a user, return user's timezone,
# else return app default timezone
if current_auth.actor is not None: # Use 'actor' instead of 'user' to support anon users
user = current_auth.actor
if hasattr(user, 'tz'):
return user.tz
elif hasattr(user, 'timezone'):
return timezone(user.timezone)
return current_app.config.get('tz') or UTC
def localized_country_list():
"""
Returns a localized list of country names and their ISO3166-1 alpha-2 code inside a request context.
The locale depends on the `Accept-Language` header of the request for now.
The best matched locale is picked in `get_locale()` function and then used
to localize the country names.
The list is ordered by the localized country name and not the alpha-2 code.
The list is also memoized with the locale code as the key for a day.
"""
return _localized_country_list_inner(get_locale())
@cache.memoize(timeout=86400)
def _localized_country_list_inner(locale):
if locale == 'en':
countries = [(country.name, country.alpha_2) for country in pycountry.countries]
else:
pycountry_locale = gettext.translation('iso3166-1', pycountry.LOCALES_DIR, languages=[locale])
if six.PY2:
countries = [(pycountry_locale.gettext(country.name).decode('utf-8'), country.alpha_2) for country in pycountry.countries]
else:
countries = [(pycountry_locale.gettext(country.name), country.alpha_2) for country in pycountry.countries]
countries.sort()
return [(code, name) for (name, code) in countries]
def localize_timezone(datetime, tz=None):
if not datetime.tzinfo:
datetime = UTC.localize(datetime)
if not tz:
tz = get_timezone()
if isinstance(tz, six.string_types):
tz = timezone(tz)
return datetime.astimezone(tz)
@baseframe.after_app_request
def process_response(response):
if request.endpoint in ('static', 'baseframe.static'):
if 'Access-Control-Allow-Origin' not in response.headers:
# This is required for webfont resources
# Note: We do not serve static assets in production, nginx does.
# That means this piece of code will never be called in production.
response.headers['Access-Control-Allow-Origin'] = '*'
if 'Vary' in response.headers:
vary_values = [item.strip() for item in response.headers['Vary'].split(',')]
if 'Accept-Language' not in vary_values:
vary_values.append('Accept-Language')
if 'Cookie' not in vary_values:
vary_values.append('Cookie')
response.headers['Vary'] = ', '.join(vary_values)
else:
response.headers['Vary'] = 'Accept-Language, Cookie'
# Prevent pages from being placed in an iframe. If the response already
# set has a value for this option, let it pass through
if 'X-Frame-Options' in response.headers:
frameoptions = response.headers.get('X-Frame-Options')
if not frameoptions or frameoptions == 'ALLOW':
# 'ALLOW' is an unofficial signal from the app to Baseframe.
# It signals us to remove the header and not set a default
response.headers.pop('X-Frame-Options')
else:
if request_has_auth() and getattr(current_auth, 'login_required', False):
# Protect only login_required pages from appearing in frames
response.headers['X-Frame-Options'] = 'SAMEORIGIN'
# In memoriam. http://www.gnuterrypratchett.com/
response.headers['X-Clacks-Overhead'] = 'GNU Terry Pratchett'
return response
# Replace gettext handlers for imports
b_ = _
b__ = __
from flask_babelex import gettext as _, lazy_gettext as __
from .utils import * # NOQA
from .views import * # NOQA
from .errors import * # NOQA
from .filters import * # NOQA
# Deprecated imports
from .deprecated import * # NOQA