| 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 | import os |
| 18 | import logging |
| 19 | |
| 20 | from mediagoblin.routing import url_map, view_functions, add_route |
| 21 | |
| 22 | from werkzeug.wrappers import Request |
| 23 | from werkzeug.exceptions import HTTPException, NotFound |
| 24 | |
| 25 | from mediagoblin import meddleware, __version__ |
| 26 | from mediagoblin.tools import common, translate, template |
| 27 | from mediagoblin.tools.response import render_404 |
| 28 | from mediagoblin.tools.theme import register_themes |
| 29 | from mediagoblin.tools import request as mg_request |
| 30 | from mediagoblin.mg_globals import setup_globals |
| 31 | from mediagoblin.init.celery import setup_celery_from_config |
| 32 | from mediagoblin.init.plugins import setup_plugins |
| 33 | from mediagoblin.init import (get_jinja_loader, get_staticdirector, |
| 34 | setup_global_and_app_config, setup_locales, setup_workbench, setup_database, |
| 35 | setup_storage, setup_beaker_cache) |
| 36 | from mediagoblin.tools.pluginapi import PluginManager |
| 37 | |
| 38 | |
| 39 | _log = logging.getLogger(__name__) |
| 40 | |
| 41 | |
| 42 | class MediaGoblinApp(object): |
| 43 | """ |
| 44 | WSGI application of MediaGoblin |
| 45 | |
| 46 | ... this is the heart of the program! |
| 47 | """ |
| 48 | def __init__(self, config_path, setup_celery=True): |
| 49 | """ |
| 50 | Initialize the application based on a configuration file. |
| 51 | |
| 52 | Arguments: |
| 53 | - config_path: path to the configuration file we're opening. |
| 54 | - setup_celery: whether or not to setup celery during init. |
| 55 | (Note: setting 'celery_setup_elsewhere' also disables |
| 56 | setting up celery.) |
| 57 | """ |
| 58 | _log.info("GNU MediaGoblin %s main server starting", __version__) |
| 59 | _log.debug("Using config file %s", config_path) |
| 60 | ############## |
| 61 | # Setup config |
| 62 | ############## |
| 63 | |
| 64 | # Open and setup the config |
| 65 | global_config, app_config = setup_global_and_app_config(config_path) |
| 66 | |
| 67 | ########################################## |
| 68 | # Setup other connections / useful objects |
| 69 | ########################################## |
| 70 | |
| 71 | # load all available locales |
| 72 | setup_locales() |
| 73 | |
| 74 | # Set up plugins -- need to do this early so that plugins can |
| 75 | # affect startup. |
| 76 | _log.info("Setting up plugins.") |
| 77 | setup_plugins() |
| 78 | |
| 79 | # Set up the database |
| 80 | self.connection, self.db = setup_database() |
| 81 | |
| 82 | # Register themes |
| 83 | self.theme_registry, self.current_theme = register_themes(app_config) |
| 84 | |
| 85 | # Get the template environment |
| 86 | self.template_loader = get_jinja_loader( |
| 87 | app_config.get('local_templates'), |
| 88 | self.current_theme, |
| 89 | PluginManager().get_template_paths() |
| 90 | ) |
| 91 | |
| 92 | # Set up storage systems |
| 93 | self.public_store, self.queue_store = setup_storage() |
| 94 | |
| 95 | # set up routing |
| 96 | self.url_map = url_map |
| 97 | |
| 98 | for route in PluginManager().get_routes(): |
| 99 | _log.debug('adding plugin route: {0}'.format(route)) |
| 100 | add_route(*route) |
| 101 | |
| 102 | # set up staticdirector tool |
| 103 | self.staticdirector = get_staticdirector(app_config) |
| 104 | |
| 105 | # set up caching |
| 106 | self.cache = setup_beaker_cache() |
| 107 | |
| 108 | # Setup celery, if appropriate |
| 109 | if setup_celery and not app_config.get('celery_setup_elsewhere'): |
| 110 | if os.environ.get('CELERY_ALWAYS_EAGER', 'false').lower() == 'true': |
| 111 | setup_celery_from_config( |
| 112 | app_config, global_config, |
| 113 | force_celery_always_eager=True) |
| 114 | else: |
| 115 | setup_celery_from_config(app_config, global_config) |
| 116 | |
| 117 | ####################################################### |
| 118 | # Insert appropriate things into mediagoblin.mg_globals |
| 119 | # |
| 120 | # certain properties need to be accessed globally eg from |
| 121 | # validators, etc, which might not access to the request |
| 122 | # object. |
| 123 | ####################################################### |
| 124 | |
| 125 | setup_globals(app=self) |
| 126 | |
| 127 | # Workbench *currently* only used by celery, so this only |
| 128 | # matters in always eager mode :) |
| 129 | setup_workbench() |
| 130 | |
| 131 | # instantiate application meddleware |
| 132 | self.meddleware = [common.import_component(m)(self) |
| 133 | for m in meddleware.ENABLED_MEDDLEWARE] |
| 134 | |
| 135 | def call_backend(self, environ, start_response): |
| 136 | request = Request(environ) |
| 137 | |
| 138 | # Compatibility with django, use request.args preferrably |
| 139 | request.GET = request.args |
| 140 | |
| 141 | ## Routing / controller loading stuff |
| 142 | map_adapter = self.url_map.bind_to_environ(request.environ) |
| 143 | |
| 144 | # By using fcgi, mediagoblin can run under a base path |
| 145 | # like /mediagoblin/. request.path_info contains the |
| 146 | # path inside mediagoblin. If the something needs the |
| 147 | # full path of the current page, that should include |
| 148 | # the basepath. |
| 149 | # Note: urlgen and routes are fine! |
| 150 | request.full_path = environ["SCRIPT_NAME"] + request.path |
| 151 | # python-routes uses SCRIPT_NAME. So let's use that too. |
| 152 | # The other option would be: |
| 153 | # request.full_path = environ["SCRIPT_URL"] |
| 154 | |
| 155 | # Fix up environ for urlgen |
| 156 | # See bug: https://bitbucket.org/bbangert/routes/issue/55/cache_hostinfo-breaks-on-https-off |
| 157 | if environ.get('HTTPS', '').lower() == 'off': |
| 158 | environ.pop('HTTPS') |
| 159 | |
| 160 | ## Attach utilities to the request object |
| 161 | # Do we really want to load this via middleware? Maybe? |
| 162 | request.session = request.environ['beaker.session'] |
| 163 | # Attach self as request.app |
| 164 | # Also attach a few utilities from request.app for convenience? |
| 165 | request.app = self |
| 166 | |
| 167 | request.db = self.db |
| 168 | request.staticdirect = self.staticdirector |
| 169 | |
| 170 | request.locale = translate.get_locale_from_request(request) |
| 171 | request.template_env = template.get_jinja_env( |
| 172 | self.template_loader, request.locale) |
| 173 | |
| 174 | def build_proxy(endpoint, **kw): |
| 175 | try: |
| 176 | qualified = kw.pop('qualified') |
| 177 | except KeyError: |
| 178 | qualified = False |
| 179 | |
| 180 | return map_adapter.build( |
| 181 | endpoint, |
| 182 | values=dict(**kw), |
| 183 | force_external=qualified) |
| 184 | |
| 185 | request.urlgen = build_proxy |
| 186 | |
| 187 | mg_request.setup_user_in_request(request) |
| 188 | |
| 189 | try: |
| 190 | endpoint, url_values = map_adapter.match() |
| 191 | request.matchdict = url_values |
| 192 | except NotFound as exc: |
| 193 | return render_404(request)(environ, start_response) |
| 194 | except HTTPException as exc: |
| 195 | # exceptions that match() is documented to return: |
| 196 | # MethodNotAllowed, RequestRedirect TODO: need to handle ??? |
| 197 | return exc(environ, start_response) |
| 198 | |
| 199 | view_func = view_functions[endpoint] |
| 200 | |
| 201 | _log.debug('endpoint: {0} view_func: {1}'.format( |
| 202 | endpoint, |
| 203 | view_func)) |
| 204 | |
| 205 | # import the endpoint, or if it's already a callable, call that |
| 206 | if isinstance(view_func, unicode) \ |
| 207 | or isinstance(view_func, str): |
| 208 | controller = common.import_component(view_func) |
| 209 | else: |
| 210 | controller = view_func |
| 211 | |
| 212 | # pass the request through our meddleware classes |
| 213 | for m in self.meddleware: |
| 214 | response = m.process_request(request, controller) |
| 215 | if response is not None: |
| 216 | return response(environ, start_response) |
| 217 | |
| 218 | request.start_response = start_response |
| 219 | |
| 220 | # get the response from the controller |
| 221 | response = controller(request) |
| 222 | |
| 223 | # pass the response through the meddleware |
| 224 | for m in self.meddleware[::-1]: |
| 225 | m.process_response(request, response) |
| 226 | |
| 227 | return response(environ, start_response) |
| 228 | |
| 229 | def __call__(self, environ, start_response): |
| 230 | ## If more errors happen that look like unclean sessions: |
| 231 | # self.db.check_session_clean() |
| 232 | |
| 233 | try: |
| 234 | return self.call_backend(environ, start_response) |
| 235 | finally: |
| 236 | # Reset the sql session, so that the next request |
| 237 | # gets a fresh session |
| 238 | self.db.reset_after_request() |
| 239 | |
| 240 | |
| 241 | def paste_app_factory(global_config, **app_config): |
| 242 | configs = app_config['config'].split() |
| 243 | mediagoblin_config = None |
| 244 | for config in configs: |
| 245 | if os.path.exists(config) and os.access(config, os.R_OK): |
| 246 | mediagoblin_config = config |
| 247 | break |
| 248 | |
| 249 | if not mediagoblin_config: |
| 250 | raise IOError("Usable mediagoblin config not found.") |
| 251 | |
| 252 | mgoblin_app = MediaGoblinApp(mediagoblin_config) |
| 253 | |
| 254 | return mgoblin_app |