def settings(request):
"""
Surface settings as an API.
This allows clients to qurey server settup rather than having to hard code bits into the clients
"""
if not is_admin(request):
log.debug('settings requested by non admin') # I'm curious if anyone will find this. would be fun to search logs after an event for this string
if method_put_router(None, request):
# with PUT requests, update settings
# only changing in production is bit over zelious #request.registry.settings.get('karakara.server.mode')!='production'
if request.registry.settings.get('karakara.server.mode')!='test' and not is_admin(request):
raise action_error(message='Settings modification for non admin users forbidden', code=403)
for key, value in request.params.items():
fallback_type = None
if request.registry.settings.get(key) != None:
fallback_type = type(request.registry.settings.get(key))
request.registry.settings[key] = convert_str_with_type(value, fallback_type=fallback_type)
setting_regex = re.compile(request.registry.settings.get('api.settings.regex','TODOmatch_nothing_regex'))
return action_ok(
data={
'settings': {
setting_key:request.registry.settings.get(setting_key)
for setting_key in
[key for key in request.registry.settings.keys() if setting_regex.match(key)]
}
}
)
def main(global_config, **settings):
""" This function returns a Pyramid WSGI application.
"""
config = Configurator(settings=settings, root_factory=GlobalRootFactory)
config.include('pyramid_mako')
# Parse/Convert setting keys that have specifyed datatypes
for key in config.registry.settings.keys():
config.registry.settings[key] = convert_str_with_type(config.registry.settings[key])
# Session Manager
session_settings = extract_subkeys(config.registry.settings, 'session.')
session_factory = SignedCookieSessionFactory(serializer=json_serializer, **session_settings)
config.set_session_factory(session_factory)
# Routes
def append_format_pattern(route):
return re.sub(r'{(.*)}', r'{\1:[^/\.]+}', route) + r'{spacer:[.]?}{format:(%s)?}' % '|'.join(registered_formats())
config.add_static_view('static', 'static', cache_max_age=3600)
#config.add_route('home', append_format_pattern('/'))
config.add_view('gluegov.views.traversal.home', context='gluegov.traversal.TraversalRoot')
config.add_view('gluegov.views.traversal.group', context='gluegov.traversal.TableGroupResource')
config.add_view('gluegov.views.traversal.table', context='gluegov.traversal.TableResource')
config.add_subscriber(add_render_globals_to_template, pyramid.events.BeforeRender)
config.scan()
return config.make_wsgi_app()
def main(global_config, **settings):
"""
This function returns a Pyramid WSGI application.
"""
# Setup --------------------------------------------------------------------
# Db
init_DBSession(settings)
# Pyramid Global Settings
config = Configurator(settings=settings) # , autocommit=True
# Register Aditional Includes ---------------------------------------------
config.include(
'pyramid_mako'
) # The mako.directories value is updated in the scan for addons. We trigger the import here to include the correct folders.
# Reload on template change - Dericated from pserve
#template_filenames = map(operator.attrgetter('absolute'), file_scan(config.registry.settings['mako.directories']))
#from pyramid.scripts.pserve import add_file_callback
#add_file_callback(lambda: template_filenames)
# Parse/Convert setting keys that have specifyed datatypes
for key in config.registry.settings.keys():
config.registry.settings[key] = convert_str_with_type(
config.registry.settings[key])
# i18n
config.add_translation_dirs(
config.registry.settings['i18n.translation_dirs'])
# Session Manager
session_settings = extract_subkeys(config.registry.settings, 'session.')
session_factory = SignedCookieSessionFactory(serializer=json_serializer,
**session_settings)
config.set_session_factory(session_factory)
# Cachebust etags ----------------------------------------------------------
# crude implementation; count the number of tags in db, if thats changed, the etags will invalidate
if not config.registry.settings['server.etag.cache_buster']:
from .model.actions import last_update
config.registry.settings[
'server.etag.cache_buster'] = 'last_update:{0}'.format(
str(last_update()))
# Search Config ------------------------------------------------------------
import karakara.views.search
karakara.views.search.search_config = read_json(
config.registry.settings['karakara.search.view.config'])
assert karakara.views.search.search_config, 'search_config data required'
# WebSocket ----------------------------------------------------------------
class NullAuthEchoServerManager(object):
def recv(self, *args, **kwargs):
pass
socket_manager = NullAuthEchoServerManager()
# Do not activate websocket if in community mode
if config.registry.settings.get('karakara.server.mode') == 'comunity':
config.registry.settings['karakara.websocket.port'] = None
if config.registry.settings.get('karakara.websocket.port'):
def authenicator(key):
"""Only admin authenticated keys can connect to the websocket"""
request = Request({
'HTTP_COOKIE':
'{0}={1}'.format(
config.registry.settings['session.cookie_name'], key)
})
session_data = session_factory(request)
return session_data and session_data.get('admin')
try:
_socket_manager = AuthEchoServerManager(
authenticator=authenicator,
websocket_port=config.registry.
settings['karakara.websocket.port'],
tcp_port=config.registry.settings.get('karakara.tcp.port'),
)
_socket_manager.start()
socket_manager = _socket_manager
except OSError:
log.warn('Unable to setup websocket')
config.registry['socket_manager'] = socket_manager
# Login Providers ----------------------------------------------------------
from .views.comunity_login import social_login
social_login.user_store = ComunityUserStore()
login_providers = config.registry.settings.get('login.provider.enabled')
# Facebook
if 'facebook' in login_providers:
for settings_key in ('facebook.appid', 'facebook.secret'):
assert config.registry.settings.get(
settings_key
), 'To use facebook as a login provider appid and secret must be provided'
social_login.add_login_provider(
FacebookLogin(
appid=config.registry.settings.get('facebook.appid'),
secret=config.registry.settings.get('facebook.secret'),
permissions=config.registry.settings.get(
'facebook.permissions'),
))
# Firefox Persona (Deprecated technology but a useful reference)
#if 'persona' in login_providers:
# social_login.add_login_provider(PersonaLogin(
# site_url=config.registry.settings.get('server.url')
# ))
# No login provider
if not login_providers and config.registry.settings.get(
'karakara.server.mode') == 'development':
# Auto login if no service keys are provided
social_login.add_login_provider(NullLoginProvider())
social_login.user_store = NullComunityUserStore()
template_helpers.javascript_inline['comunity'] = social_login.html_includes
# Renderers ----------------------------------------------------------------
# AllanC - currently the auto_format decorator does all the formatting work
# it would be far preferable to use the pyramid renderer framework
# issue is, we want to set the renderer to be dynamic based on the url given
# I don't want to define EVERY method with loads of renderer tags
# and I don't want to define 5+ routes for every view callable with differnt formats
# We need a nice way of doing this in pyramid, and right now, after HOURS of trawling
# the doc and experimenting, I cant find one.
#from .renderers.auto_render_factory import AutoRendererFactory, handle_before_render
#config.add_renderer(None , AutoRendererFactory) #'renderers.auto_render_factory.auto_renderer_factory'
#config.add_renderer('.html', 'pyramid.mako_templating.renderer_factory')
#config.add_subscriber(handle_before_render , pyramid.events.BeforeRender) # maybe use this to set renderer?
# closeset ive seen
# http://zhuoqiang.me/a/restful-pyramid
# http://stackoverflow.com/questions/4633320/is-there-a-better-way-to-switch-between-html-and-json-output-in-pyramid
# Routes -------------------------------------------------------------------
# Static Routes
config.add_static_view(
name='ext', path=settings['static.externals']) #cache_max_age=3600
config.add_static_view(name='static',
path='karakara:{0}'.format(
settings["static.assets"])
) #cache_max_age=3600 # settings["static.assets"]
config.add_static_view(name='player', path=settings["static.player"])
# AllanC - it's official ... static route setup and generation is a mess in pyramid
#config.add_static_view(name=settings["static.media" ], path="karakara:media" )
config.add_static_view(name='files', path=settings["static.processed"])
# Routes
def append_format_pattern(route):
return re.sub(r'{(.*)}', r'{\1:[^/\.]+}',
route) + r'{spacer:[.]?}{format:(%s)?}' % '|'.join(
registered_formats())
config.add_route('home', append_format_pattern('/'))
config.add_route('track', append_format_pattern('/track/{id}'))
config.add_route('track_list', append_format_pattern('/track_list'))
config.add_route('track_import', append_format_pattern('/track_import'))
config.add_route('queue', append_format_pattern('/queue'))
config.add_route('priority_tokens',
append_format_pattern('/priority_tokens'))
config.add_route('fave', append_format_pattern('/fave'))
config.add_route('message', append_format_pattern('/message'))
config.add_route('admin_toggle', append_format_pattern('/admin'))
config.add_route('admin_lock', append_format_pattern('/admin_lock'))
config.add_route('remote', append_format_pattern('/remote'))
config.add_route('feedback', append_format_pattern('/feedback'))
config.add_route('settings', append_format_pattern('/settings'))
config.add_route('random_images', append_format_pattern('/random_images'))
config.add_route('inject_testdata',
append_format_pattern('/inject_testdata'))
config.add_route('stats', append_format_pattern('/stats'))
config.add_route('comunity', append_format_pattern('/comunity'))
config.add_route('comunity_login',
append_format_pattern('/comunity/login'))
config.add_route('comunity_logout',
append_format_pattern('/comunity/logout'))
config.add_route('comunity_list', append_format_pattern('/comunity/list'))
config.add_route('comunity_track',
append_format_pattern('/comunity/track/{id}'))
config.add_route('comunity_upload',
append_format_pattern('/comunity/upload'))
config.add_route('comunity_settings',
append_format_pattern('/comunity/settings'))
config.add_route('comunity_processmedia_log',
append_format_pattern('/comunity/processmedia_log'))
config.add_route('search_tags', '/search_tags/{tags:.*}')
config.add_route('search_list', '/search_list/{tags:.*}')
# Upload extras -----
#config.add_static_view(name=settings['upload.route.uploaded'], path=settings['upload.path']) # the 'upload' route above always matchs first
config.add_route('upload', '/upload{sep:/?}{name:.*}')
# Events -------------------------------------------------------------------
config.add_subscriber(add_localizer_to_request, pyramid.events.NewRequest)
config.add_subscriber(add_render_globals_to_template,
pyramid.events.BeforeRender)
# Return -------------------------------------------------------------------
config.scan(ignore='.tests')
config.scan('externals.lib.pyramid_helpers.views')
return config.make_wsgi_app()
def update_settings(settings, params):
for key, value in params.items():
fallback_type = type(settings.get(key)) if settings.get(key) != None else None
settings[key] = convert_str_with_type(value, fallback_type=fallback_type)
def update_settings(settings, params):
for key, value in params.items():
fallback_type = type(
settings.get(key)) if settings.get(key) != None else None
settings[key] = convert_str_with_type(value,
fallback_type=fallback_type)
def main(global_config, **settings):
"""
This function returns a Pyramid WSGI application.
"""
# Setup --------------------------------------------------------------------
# Db
init_DBSession(settings)
# Pyramid Global Settings
config = pyramid.config.Configurator(
settings=settings,
root_factory=TraversalGlobalRootFactory) # , autocommit=True
def assert_settings_keys(keys):
for settings_key in key:
assert config.registry.settings.get(settings_key)
# Register Additional Includes ---------------------------------------------
config.include(
'pyramid_mako'
) # The mako.directories value is updated in the scan for addons. We trigger the import here to include the correct folders.
# Reload on template change - Dedicated from pserve
#template_filenames = map(operator.attrgetter('absolute'), file_scan(config.registry.settings['mako.directories']))
#from pyramid.scripts.pserve import add_file_callback
#add_file_callback(lambda: template_filenames)
# Parse/Convert setting keys that have specified datatypes
# Environment variables; capitalized and separated by underscores can override a settings key.
# e.g.
# export KARAKARA_TEMPLATE_TITLE=Test
# can override 'karakara.template.title'
for key in config.registry.settings.keys():
value = os.getenv(
key.replace('.', '_').upper(), ''
) if config.registry.settings['karakara.server.mode'] != 'test' else ''
value = value or config.registry.settings[key]
config.registry.settings[key] = convert_str_with_type(value)
# Session identity
config.add_request_method(partial(
session_identity, session_keys={'id', 'admin', 'faves', 'user'}),
'session_identity',
reify=True)
# Setup Cache Manager config in view
setup_pyramid_cache_manager(config)
# Setup Autoformat view processor
setup_pyramid_autoformater(config)
@post_view_dict_augmentation.register_pre_render_decorator()
def add_paths_to_response_dict(request, response):
response['paths'] = {
'context': pyramid.traversal.resource_path(request.context),
'queue': '',
}
try:
queue_context = request.context.queue_context
if queue_context:
response['paths'].update(
template_helpers.paths_for_queue(queue_context.id))
except AttributeError:
pass
# i18n
config.add_translation_dirs(
config.registry.settings['i18n.translation_dirs'])
# Session Manager
session_settings = extract_subkeys(config.registry.settings, 'session.')
session_factory = SignedCookieSessionFactory(serializer=json_serializer,
**session_settings)
config.set_session_factory(session_factory)
from .model.actions import last_track_db_update
def _last_track_db_update(request):
return last_track_db_update()
# Track DB Version ---------------------------------------------------------
config.add_request_method(_last_track_db_update,
'last_track_db_update',
property=True,
reify=True)
# Cachebust etags ----------------------------------------------------------
# crude implementation; count the number of tags in db, if thats changed, the etags will invalidate
if not config.registry.settings['server.etag.cache_buster']:
config.registry.settings[
'server.etag.cache_buster'] = 'last_update:{0}'.format(
str(last_track_db_update()))
# TODO: Where is this used? How is this related to karakara.tracks.version?
# Global State -------------------------------------------------------------
config.registry.settings['karakara.tracks.version'] = random.randint(
0, 20000000)
# Search Config ------------------------------------------------------------
import karakara.views.queue_search
karakara.views.queue_search.search_config = read_json(
config.registry.settings['karakara.search.view.config'])
assert karakara.views.queue_search.search_config, 'search_config data required'
# LogEvent -----------------------------------------------------------------
log_event_logger = logging.getLogger('json_log_event')
def log_event(request, **data):
"""
It is expected that python's logging framework is used to output these
events to the correct destination.
Logstash can then read/process this log output for overview/stats
"""
event = data.get('event')
try:
event = request.matched_route.name
except Exception:
pass
try:
event = request.context.__name__
except Exception:
pass
data.update({
'event': event,
'session_id': request.session.get('id'),
'ip': request.environ.get('REMOTE_ADDR'),
'timestamp': now(),
})
log_event_logger.info(json_string(data))
config.add_request_method(log_event)
# WebSocket ----------------------------------------------------------------
class NullAuthEchoServerManager(object):
def recv(self, *args, **kwargs):
pass
socket_manager = NullAuthEchoServerManager()
if config.registry.settings.get('karakara.websocket.port'):
def authenticator(key):
"""Only admin authenticated keys can connect to the websocket"""
request = pyramid.request.Request({
'HTTP_COOKIE':
'{0}={1}'.format(
config.registry.settings['session.cookie_name'], key)
})
session_data = session_factory(request)
return session_data and session_data.get('admin')
def _int_or_none(setting_key):
return int(config.registry.settings.get(setting_key)
) if config.registry.settings.get(setting_key) else None
try:
_socket_manager = AuthEchoServerManager(
authenticator=authenticator,
websocket_port=_int_or_none('karakara.websocket.port'),
tcp_port=_int_or_none('karakara.tcp.port'),
)
_socket_manager.start()
socket_manager = _socket_manager
except OSError:
log.warn('Unable to setup websocket')
def send_websocket_message(request, message):
# TODO: This will have to be augmented with json and queue_id in future
socket_manager.recv(
message.encode('utf-8')) # TODO: ?um? new_line needed?
config.add_request_method(send_websocket_message)
#config.registry['socket_manager'] = socket_manager
# Login Providers ----------------------------------------------------------
from .views.comunity_login import social_login
social_login.user_store = ComunityUserStore()
login_providers = config.registry.settings.get('login.provider.enabled')
# Facebook
if 'facebook' in login_providers:
assert_settings_keys(
('login.facebook.appid', 'login.facebook.secret'),
message=
'To use facebook as a login provider appid and secret must be provided'
)
social_login.add_login_provider(
FacebookLogin(
appid=config.registry.settings.get('login.facebook.appid'),
secret=config.registry.settings.get('login.facebook.secret'),
permissions=config.registry.settings.get(
'login.facebook.permissions'),
))
# Google
if 'google' in login_providers:
social_login.add_login_provider(
GoogleLogin(client_secret_file=config.registry.settings.get(
'login.google.client_secret_file'), ))
# Firefox Persona (Deprecated technology but a useful reference)
#if 'persona' in login_providers:
# social_login.add_login_provider(PersonaLogin(
# site_url=config.registry.settings.get('server.url')
# ))
# No login provider
if not login_providers and config.registry.settings.get(
'karakara.server.mode') != 'test':
# Auto login if no service keys are provided
social_login.add_login_provider(NullLoginProvider())
social_login.user_store = NullComunityUserStore()
template_helpers.javascript_inline['comunity'] = social_login.html_includes
# KaraKara request additions -----------------------------------------------
from unittest.mock import patch
def call_sub_view(request, view_callable, acquire_cache_bucket_func):
"""
A wrapper for called view_callable's to allow subrequests to use correct cache_buckets
"""
if not hasattr(request, 'cache_bucket'):
# FFS - don't ask questions ... just ... (sigh) ... patch can ONLY patch existing attributes
setattr(request, 'cache_bucket', 'some placeholder s***e')
_cache_bucket = acquire_cache_bucket_func(request)
with patch.object(request, 'cache_bucket', _cache_bucket):
assert request.cache_bucket == _cache_bucket
return view_callable(request)['data']
config.add_request_method(call_sub_view)
from .model_logic.queue_logic import QueueLogic
config.add_request_method(QueueLogic, 'queue', reify=True)
# Routes -------------------------------------------------------------------
def settings_path(key):
path = os.path.join(os.getcwd(), config.registry.settings[key])
if not os.path.isdir(path):
log.error('Unable to add_static_view {key}:{path}'.format(
key=key, path=path)) #TODO: reaplce with formatstring
return path
# Static Routes
config.add_static_view(
name='ext',
path=settings_path('static.externals')) # cache_max_age=3600
config.add_static_view(
name='static',
path=settings_path('static.assets')) # cache_max_age=3600
config.add_static_view(name='player', path=settings_path('static.player'))
# AllanC - it's official ... static route setup and generation is a mess in pyramid
#config.add_static_view(name=settings["static.media" ], path="karakara:media" )
config.add_static_view(
name='files',
path=config.registry.settings['static.processmedia2.config']
['path_processed'])
# View Routes
config.add_route('inject_testdata', '/inject_testdata')
# Upload extras -----
#config.add_static_view(name=settings['upload.route.uploaded'], path=settings['upload.path']) # the 'upload' route above always matchs first
config.add_route('upload', '/upload{sep:/?}{name:.*}')
# Events -------------------------------------------------------------------
config.add_subscriber(add_localizer_to_request, pyramid.events.NewRequest)
config.add_subscriber(add_render_globals_to_template,
pyramid.events.BeforeRender)
# Tweens -------------------------------------------------------------------
if config.registry.settings.get(
'karakara.server.mode'
) == 'development' and config.registry.settings.get(
'karakara.server.postmortem'):
config.add_tween('karakara.postmortem_tween_factory')
# Return -------------------------------------------------------------------
config.scan(ignore='.tests')
config.scan('externals.lib.pyramid_helpers.views')
return config.make_wsgi_app()
def main(global_config, **settings):
"""
This function returns a Pyramid WSGI application.
"""
# Setup --------------------------------------------------------------------
# Db
init_DBSession(settings)
# Pyramid Global Settings
config = Configurator(settings=settings) # , autocommit=True
# Register Aditional Includes ---------------------------------------------
config.include('pyramid_mako') # The mako.directories value is updated in the scan for addons. We trigger the import here to include the correct folders.
# Reload on template change
template_filenames = map(operator.attrgetter('absolute'), file_scan(config.registry.settings['mako.directories']))
add_file_callback(lambda: template_filenames)
# Parse/Convert setting keys that have specifyed datatypes
for key in config.registry.settings.keys():
config.registry.settings[key] = convert_str_with_type(config.registry.settings[key])
# i18n
config.add_translation_dirs(config.registry.settings['i18n.translation_dirs'])
# Session Manager
session_settings = extract_subkeys(config.registry.settings, 'session.')
session_factory = SignedCookieSessionFactory(serializer=json_serializer, **session_settings)
config.set_session_factory(session_factory)
# Cachebust etags ----------------------------------------------------------
# crude implementation; count the number of tags in db, if thats changed, the etags will invalidate
if not config.registry.settings['server.etag.cache_buster']:
from .model.actions import last_update
config.registry.settings['server.etag.cache_buster'] = 'last_update:{0}'.format(str(last_update()))
# Search Config ------------------------------------------------------------
import karakara.views.search
karakara.views.search.search_config = read_json(config.registry.settings['karakara.search.view.config'])
# WebSocket ----------------------------------------------------------------
class NullAuthEchoServerManager(object):
def recv(self, *args, **kwargs):
pass
socket_manager = NullAuthEchoServerManager()
# Do not activate websocket if in community mode
if config.registry.settings.get('karakara.server.mode') == 'comunity':
config.registry.settings['karakara.websocket.port'] = None
if config.registry.settings.get('karakara.websocket.port'):
def authenicator(key):
"""Only admin authenticated keys can connect to the websocket"""
request = Request({'HTTP_COOKIE':'{0}={1}'.format(config.registry.settings['session.cookie_name'],key)})
session_data = session_factory(request)
return session_data and session_data.get('admin')
try:
_socket_manager = AuthEchoServerManager(
authenticator=authenicator,
websocket_port=config.registry.settings['karakara.websocket.port'],
tcp_port=config.registry.settings.get('karakara.tcp.port'),
)
_socket_manager.start()
socket_manager = _socket_manager
except OSError:
log.warn('Unable to setup websocket')
config.registry['socket_manager'] = socket_manager
# Login Providers ----------------------------------------------------------
from .views.comunity_login import social_login
social_login.user_store = ComunityUserStore()
login_providers = config.registry.settings.get('login.provider.enabled')
# Facebook
if 'facebook' in login_providers:
for settings_key in ('facebook.appid', 'facebook.secret'):
assert config.registry.settings.get(settings_key), 'To use facebook as a login provider appid and secret must be provided'
social_login.add_login_provider(FacebookLogin(
appid=config.registry.settings.get('facebook.appid'),
secret=config.registry.settings.get('facebook.secret'),
permissions=config.registry.settings.get('facebook.permissions'),
))
# Firefox Persona (Deprecated technology but a useful reference)
#if 'persona' in login_providers:
# social_login.add_login_provider(PersonaLogin(
# site_url=config.registry.settings.get('server.url')
# ))
# No login provider
if not login_providers and config.registry.settings.get('karakara.server.mode') == 'development':
# Auto login if no service keys are provided
social_login.add_login_provider(NullLoginProvider())
social_login.user_store = NullComunityUserStore()
template_helpers.javascript_inline['comunity'] = social_login.html_includes
# Renderers ----------------------------------------------------------------
# AllanC - currently the auto_format decorator does all the formatting work
# it would be far preferable to use the pyramid renderer framework
# issue is, we want to set the renderer to be dynamic based on the url given
# I don't want to define EVERY method with loads of renderer tags
# and I don't want to define 5+ routes for every view callable with differnt formats
# We need a nice way of doing this in pyramid, and right now, after HOURS of trawling
# the doc and experimenting, I cant find one.
#from .renderers.auto_render_factory import AutoRendererFactory, handle_before_render
#config.add_renderer(None , AutoRendererFactory) #'renderers.auto_render_factory.auto_renderer_factory'
#config.add_renderer('.html', 'pyramid.mako_templating.renderer_factory')
#config.add_subscriber(handle_before_render , pyramid.events.BeforeRender) # maybe use this to set renderer?
# closeset ive seen
# http://zhuoqiang.me/a/restful-pyramid
# http://stackoverflow.com/questions/4633320/is-there-a-better-way-to-switch-between-html-and-json-output-in-pyramid
# Routes -------------------------------------------------------------------
# Static Routes
config.add_static_view(name='ext' , path='../externals/static') #cache_max_age=3600 # settings["static.assets"]
config.add_static_view(name='static', path='karakara:{0}'.format(settings["static.assets"])) #cache_max_age=3600 # settings["static.assets"]
config.add_static_view(name='player', path=settings["static.player"])
# AllanC - it's official ... static route setup and generation is a mess in pyramid
#config.add_static_view(name=settings["static.media" ], path="karakara:media" )
config.add_static_view(name='files' , path=settings["static.processed"])
# Routes
def append_format_pattern(route):
return re.sub(r'{(.*)}', r'{\1:[^/\.]+}', route) + r'{spacer:[.]?}{format:(%s)?}' % '|'.join(registered_formats())
config.add_route('home' , append_format_pattern('/') )
config.add_route('track' , append_format_pattern('/track/{id}') )
config.add_route('track_list' , append_format_pattern('/track_list') )
config.add_route('queue' , append_format_pattern('/queue') )
config.add_route('priority_tokens', append_format_pattern('/priority_tokens'))
config.add_route('fave' , append_format_pattern('/fave') )
config.add_route('message' , append_format_pattern('/message') )
config.add_route('admin_toggle' , append_format_pattern('/admin') )
config.add_route('admin_lock' , append_format_pattern('/admin_lock') )
config.add_route('remote' , append_format_pattern('/remote') )
config.add_route('feedback' , append_format_pattern('/feedback') )
config.add_route('settings' , append_format_pattern('/settings') )
config.add_route('random_images' , append_format_pattern('/random_images') )
config.add_route('inject_testdata' , append_format_pattern('/inject_testdata') )
config.add_route('stats' , append_format_pattern('/stats') )
config.add_route('comunity' , append_format_pattern('/comunity') )
config.add_route('comunity_login', append_format_pattern('/comunity/login'))
config.add_route('comunity_logout', append_format_pattern('/comunity/logout'))
config.add_route('comunity_list' , append_format_pattern('/comunity/list') )
config.add_route('comunity_track', append_format_pattern('/comunity/track/{id}'))
config.add_route('comunity_upload', append_format_pattern('/comunity/upload'))
config.add_route('comunity_settings', append_format_pattern('/comunity/settings'))
config.add_route('comunity_processmedia_log', append_format_pattern('/comunity/processmedia_log'))
config.add_route('search_tags' , '/search_tags/{tags:.*}')
config.add_route('search_list' , '/search_list/{tags:.*}')
# Upload extras -----
#config.add_static_view(name=settings['upload.route.uploaded'], path=settings['upload.path']) # the 'upload' route above always matchs first
config.add_route('upload', '/upload{sep:/?}{name:.*}')
# Events -------------------------------------------------------------------
config.add_subscriber(add_localizer_to_request, pyramid.events.NewRequest)
config.add_subscriber(add_render_globals_to_template, pyramid.events.BeforeRender)
# Return -------------------------------------------------------------------
config.scan(ignore='.tests')
config.scan('externals.lib.pyramid_helpers.views')
return config.make_wsgi_app()
def main(global_config, **settings):
"""
This function returns a Pyramid WSGI application.
"""
# Setup --------------------------------------------------------------------
# Db
init_DBSession(settings)
# Pyramid Global Settings
config = Configurator(settings=settings) #, autocommit=True
# Register Aditional Includes ---------------------------------------------
config.include('pyramid_mako') # The mako.directories value is updated in the scan for addons. We trigger the import here to include the correct folders.
# Beaker Session Manager
session_factory = pyramid_beaker.session_factory_from_settings(settings)
config.set_session_factory(session_factory)
# Parse/Convert setting keys that have specifyed datatypes
for key in config.registry.settings.keys():
config.registry.settings[key] = convert_str_with_type(config.registry.settings[key])
# Cachebust etags ----------------------------------------------------------
# crude implementation; count the number of tags in db, if thats changed, the etags will invalidate
if not config.registry.settings['server.etag.cache_buster']:
from .model.actions import rough_db_hash
config.registry.settings['server.etag.cache_buster'] = rough_db_hash()
# Search Config ------------------------------------------------------------
import karakara.views.search
karakara.views.search.search_config = read_json(config.registry.settings['karakara.search.view.config'])
# WebSocket ----------------------------------------------------------------
def authenicator(key):
"""Only admin authenticated keys can connect to the websocket"""
session_data = session_factory(Request({'HTTP_COOKIE':'{0}={1}'.format(config.registry.settings['session.key'],key)}))
return session_data and session_data.get('admin')
socket_manager = AuthEchoServerManager(
authenticator=authenicator,
websocket_port=config.registry.settings['karakara.websocket.port'],
tcp_port =config.registry.settings.get('karakara.tcp.port'),
)
config.registry['socket_manager'] = socket_manager
socket_manager.start()
# Renderers ----------------------------------------------------------------
# AllanC - currently the auto_format decorator does all the formatting work
# it would be far preferable to use the pyramid renderer framework
# issue is, we want to set the renderer to be dynamic based on the url given
# I don't want to define EVERY method with loads of renderer tags
# and I don't want to define 5+ routes for every view callable with differnt formats
# We need a nice way of doing this in pyramid, and right now, after HOURS of trawling
# the doc and experimenting, I cant find one.
#from .renderers.auto_render_factory import AutoRendererFactory, handle_before_render
#config.add_renderer(None , AutoRendererFactory) #'renderers.auto_render_factory.auto_renderer_factory'
#config.add_renderer('.html', 'pyramid.mako_templating.renderer_factory')
#config.add_subscriber(handle_before_render , pyramid.events.BeforeRender) # maybe use this to set renderer?
# closeset ive seen
# http://zhuoqiang.me/a/restful-pyramid
# http://stackoverflow.com/questions/4633320/is-there-a-better-way-to-switch-between-html-and-json-output-in-pyramid
# Routes -------------------------------------------------------------------
# Static Routes
config.add_static_view(name='ext' , path='../externals/static') #cache_max_age=3600 # settings["static.assets"]
config.add_static_view(name='static', path='karakara:{0}'.format(settings["static.assets"])) #cache_max_age=3600 # settings["static.assets"]
config.add_static_view(name='player', path='karakara:{0}'.format(settings["static.player"]))
# AllanC - it's official ... static route setup and generation is a mess in pyramid
#config.add_static_view(name=settings["static.media" ], path="karakara:media" )
config.add_static_view(name='files' , path=settings["static.media"])
# Routes
def append_format_pattern(route):
return re.sub(r'{(.*)}', r'{\1:[^/\.]+}', route) + r'{spacer:[.]?}{format:(%s)?}' % '|'.join(registered_formats())
config.add_route('home' , append_format_pattern('/') )
config.add_route('track' , append_format_pattern('/track/{id}') )
config.add_route('track_list' , append_format_pattern('/track_list') )
config.add_route('queue' , append_format_pattern('/queue') )
config.add_route('fave' , append_format_pattern('/fave') )
config.add_route('admin_toggle' , append_format_pattern('/admin') )
config.add_route('admin_lock' , append_format_pattern('/admin_lock') )
config.add_route('remote' , append_format_pattern('/remote') )
config.add_route('feedback' , append_format_pattern('/feedback') )
config.add_route('settings' , append_format_pattern('/settings') )
config.add_route('random_images' , append_format_pattern('/random_images') )
config.add_route('inject_testdata' , append_format_pattern('/inject_testdata') )
config.add_route('stats' , append_format_pattern('/stats') )
config.add_route('comunity' , append_format_pattern('/comunity') )
config.add_route('comunity_login', append_format_pattern('/comunity/login'))
config.add_route('comunity_logout', append_format_pattern('/comunity/logout'))
config.add_route('comunity_list' , append_format_pattern('/comunity/list') )
config.add_route('comunity_track', append_format_pattern('/comunity/track/{id}'))
config.add_route('comunity_upload', append_format_pattern('/comunity/upload'))
config.add_route('search_tags' , '/search_tags/{tags:.*}')
config.add_route('search_list' , '/search_list/{tags:.*}')
config.add_route('upload', '/upload{sep:/?}{name:.*}')
config.add_route('uploaded', '/uploaded')
# Events -------------------------------------------------------------------
config.add_subscriber(add_template_helpers_to_event, pyramid.events.BeforeRender)
# Return -------------------------------------------------------------------
config.scan(ignore='.tests')
config.scan('externals.lib.pyramid.views')
return config.make_wsgi_app()
