mediagoblin/init/__init__.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 from beaker.cache import CacheManager
  18 from beaker.util import parse_cache_config_options
  19 import jinja2
  20
  21 from mediagoblin.tools import staticdirect
  22 from mediagoblin.tools.translate import set_available_locales
  23 from mediagoblin.init.config import (
  24     read_mediagoblin_config, generate_validation_report)
  25 from mediagoblin import mg_globals
  26 from mediagoblin.mg_globals import setup_globals
  27 from mediagoblin.db.open import setup_connection_and_db_from_config, \
  28     check_db_migrations_current, load_models
  29 from mediagoblin.workbench import WorkbenchManager
  30 from mediagoblin.storage import storage_system_from_config
  31
  32
  33 class Error(Exception):
  34     pass
  35
  36
  37 class ImproperlyConfigured(Error):
  38     pass
  39
  40
  41 def setup_locales():
  42     """Checks which language translations are available and sets them"""
  43     set_available_locales()
  44
  45
  46 def setup_global_and_app_config(config_path):
  47     global_config, validation_result = read_mediagoblin_config(config_path)
  48     app_config = global_config['mediagoblin']
  49     # report errors if necessary
  50     validation_report = generate_validation_report(
  51         global_config, validation_result)
  52     if validation_report:
  53         raise ImproperlyConfigured(validation_report)
  54
  55     setup_globals(
  56         app_config=app_config,
  57         global_config=global_config)
  58
  59     return global_config, app_config
  60
  61
  62 def setup_database():
  63     app_config = mg_globals.app_config
  64
  65     # Load all models for media types (plugins, ...)
  66     load_models(app_config)
  67
  68     # Set up the database
  69     db = setup_connection_and_db_from_config(app_config)
  70
  71     check_db_migrations_current(db)
  72
  73     setup_globals(database=db)
  74
  75     return db
  76
  77
  78 def get_jinja_loader(user_template_path=None, current_theme=None,
  79                      plugin_template_paths=None):
  80     """
  81     Set up the Jinja template loaders, possibly allowing for user
  82     overridden templates.
  83
  84     (In the future we may have another system for providing theming;
  85     for now this is good enough.)
  86     """
  87     path_list = []
  88
  89     # Add user path first--this takes precedence over everything.
  90     if user_template_path is not None:
  91         path_list.append(jinja2.FileSystemLoader(user_template_path))
  92
  93     # Any theme directories in the registry
  94     if current_theme and current_theme.get('templates_dir'):
  95         path_list.append(
  96             jinja2.FileSystemLoader(
  97                 current_theme['templates_dir']))
  98
  99     # Add plugin template paths next--takes precedence over
 100     # core templates.
 101     if plugin_template_paths is not None:
 102         path_list.extend((jinja2.FileSystemLoader(path)
 103                           for path in plugin_template_paths))
 104
 105     # Add core templates last.
 106     path_list.append(jinja2.PackageLoader('mediagoblin', 'templates'))
 107
 108     return jinja2.ChoiceLoader(path_list)
 109
 110
 111 def get_staticdirector(app_config):
 112     # At minimum, we need the direct_remote_path
 113     if not 'direct_remote_path' in app_config \
 114             or not 'theme_web_path' in app_config:
 115         raise ImproperlyConfigured(
 116             "direct_remote_path and theme_web_path must be provided")
 117
 118     direct_domains = {None: app_config['direct_remote_path'].strip()}
 119     direct_domains['theme'] = app_config['theme_web_path'].strip()
 120
 121     return staticdirect.StaticDirect(
 122         direct_domains)
 123
 124
 125 def setup_storage():
 126     global_config = mg_globals.global_config
 127
 128     key_short = 'publicstore'
 129     key_long = "storage:" + key_short
 130     public_store = storage_system_from_config(global_config[key_long])
 131
 132     key_short = 'queuestore'
 133     key_long = "storage:" + key_short
 134     queue_store = storage_system_from_config(global_config[key_long])
 135
 136     setup_globals(
 137         public_store=public_store,
 138         queue_store=queue_store)
 139
 140     return public_store, queue_store
 141
 142
 143 def setup_workbench():
 144     app_config = mg_globals.app_config
 145
 146     workbench_manager = WorkbenchManager(app_config['workbench_path'])
 147
 148     setup_globals(workbench_manager=workbench_manager)
 149
 150
 151 def setup_beaker_cache():
 152     """
 153     Setup the Beaker Cache manager.
 154     """
 155     cache_config = mg_globals.global_config['beaker.cache']
 156     cache_config = dict(
 157         [(u'cache.%s' % key, value)
 158          for key, value in cache_config.iteritems()])
 159     cache = CacheManager(**parse_cache_config_options(cache_config))
 160     setup_globals(cache=cache)
 161     return cache