1 # GNU MediaGoblin -- federated, autonomous media hosting
2 # Copyright (C) 2011 Free Software Foundation, Inc
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.
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.
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/>.
21 from webob
import Request
, exc
23 from mediagoblin
import routing
, util
, storage
, staticdirect
24 from mediagoblin
.init
.config
import (
25 read_mediagoblin_config
, generate_validation_report
)
26 from mediagoblin
.db
.open import setup_connection_and_db_from_config
27 from mediagoblin
.mg_globals
import setup_globals
28 from mediagoblin
.init
.celery
import setup_celery_from_config
29 from mediagoblin
.init
import get_jinja_loader
30 from mediagoblin
.workbench
import WorkbenchManager
33 class Error(Exception): pass
34 class ImproperlyConfigured(Error
): pass
37 class MediaGoblinApp(object):
39 WSGI application of MediaGoblin
41 ... this is the heart of the program!
43 def __init__(self
, config_path
, setup_celery
=True):
45 Initialize the application based on a configuration file.
48 - config_path: path to the configuration file we're opening.
49 - setup_celery: whether or not to setup celery during init.
50 (Note: setting 'celery_setup_elsewhere' also disables
57 # Open and setup the config
58 global_config
, validation_result
= read_mediagoblin_config(config_path
)
59 app_config
= global_config
['mediagoblin']
60 # report errors if necessary
61 validation_report
= generate_validation_report(
62 global_config
, validation_result
)
64 raise ImproperlyConfigured(validation_report
)
66 ##########################################
67 # Setup other connections / useful objects
68 ##########################################
71 self
.connection
, self
.db
= setup_connection_and_db_from_config(
74 # Get the template environment
75 self
.template_loader
= get_jinja_loader(
76 app_config
.get('user_template_path'))
78 # Set up storage systems
79 self
.public_store
= storage
.storage_system_from_config(
80 app_config
, 'publicstore')
81 self
.queue_store
= storage
.storage_system_from_config(
82 app_config
, 'queuestore')
85 self
.routing
= routing
.get_mapper()
87 # set up staticdirector tool
88 if app_config
.has_key('direct_remote_path'):
89 self
.staticdirector
= staticdirect
.RemoteStaticDirect(
90 app_config
['direct_remote_path'].strip())
91 elif app_config
.has_key('direct_remote_paths'):
92 direct_remote_path_lines
= app_config
[
93 'direct_remote_paths'].strip().splitlines()
94 self
.staticdirector
= staticdirect
.MultiRemoteStaticDirect(
95 dict([line
.strip().split(' ', 1)
96 for line
in direct_remote_path_lines
]))
98 raise ImproperlyConfigured(
99 "One of direct_remote_path or "
100 "direct_remote_paths must be provided")
102 # Setup celery, if appropriate
103 if setup_celery
and not app_config
.get('celery_setup_elsewhere'):
104 if os
.environ
.get('CELERY_ALWAYS_EAGER'):
105 setup_celery_from_config(
106 app_config
, global_config
,
107 force_celery_always_eager
=True)
109 setup_celery_from_config(app_config
, global_config
)
111 #######################################################
112 # Insert appropriate things into mediagoblin.mg_globals
114 # certain properties need to be accessed globally eg from
115 # validators, etc, which might not access to the request
117 #######################################################
120 app_config
=app_config
,
121 global_config
=global_config
,
123 # TODO: No need to set these two up as globals, we could
124 # just read them out of mg_globals.app_config
125 email_sender_address
=app_config
['email_sender_address'],
126 email_debug_mode
=app_config
['email_debug_mode'],
128 # Actual, useful to everyone objects
130 db_connection
=self
.connection
,
132 public_store
=self
.public_store
,
133 queue_store
=self
.queue_store
,
134 workbench_manager
=WorkbenchManager(app_config
['workbench_path']))
136 def __call__(self
, environ
, start_response
):
137 request
= Request(environ
)
138 path_info
= request
.path_info
140 ## Routing / controller loading stuff
141 route_match
= self
.routing
.match(path_info
)
144 if route_match
is None:
145 # Try to do see if we have a match with a trailing slash
146 # added and if so, redirect
147 if not path_info
.endswith('/') \
148 and request
.method
== 'GET' \
149 and self
.routing
.match(path_info
+ '/'):
150 new_path_info
= path_info
+ '/'
152 new_path_info
= '%s?%s' % (
153 new_path_info
, urllib
.urlencode(request
.GET
))
154 redirect
= exc
.HTTPFound(location
=new_path_info
)
155 return request
.get_response(redirect
)(environ
, start_response
)
157 # Okay, no matches. 404 time!
158 return exc
.HTTPNotFound()(environ
, start_response
)
160 controller
= util
.import_component(route_match
['controller'])
161 request
.start_response
= start_response
163 ## Attach utilities to the request object
164 request
.matchdict
= route_match
165 request
.urlgen
= routes
.URLGenerator(self
.routing
, environ
)
166 # Do we really want to load this via middleware? Maybe?
167 request
.session
= request
.environ
['beaker.session']
168 # Attach self as request.app
169 # Also attach a few utilities from request.app for convenience?
171 request
.locale
= util
.get_locale_from_request(request
)
173 request
.template_env
= util
.get_jinja_env(
174 self
.template_loader
, request
.locale
)
176 request
.staticdirect
= self
.staticdirector
178 util
.setup_user_in_request(request
)
180 return controller(request
)(environ
, start_response
)
183 def paste_app_factory(global_config
, **app_config
):
184 mgoblin_app
= MediaGoblinApp(app_config
['config'])