1 # GNU MediaGoblin -- federated, autonomous media hosting
2 # Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS.
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/>.
17 from functools
import wraps
19 from urlparse
import urljoin
20 from werkzeug
.exceptions
import Forbidden
, NotFound
22 from mediagoblin
import mg_globals
as mgg
23 from mediagoblin
import messages
24 from mediagoblin
.db
.models
import MediaEntry
, User
25 from mediagoblin
.tools
.response
import redirect
, render_404
26 from mediagoblin
.tools
.translate
import pass_to_ugettext
as _
29 def require_active_login(controller
):
31 Require an active login from the user.
34 def new_controller_func(request
, *args
, **kwargs
):
36 request
.user
.status
== u
'needs_email_verification':
38 request
, 'mediagoblin.user_pages.user_home',
39 user
=request
.user
.username
)
40 elif not request
.user
or request
.user
.status
!= u
'active':
42 request
.urlgen('mediagoblin.auth.login',
46 return redirect(request
, 'mediagoblin.auth.login',
49 return controller(request
, *args
, **kwargs
)
51 return new_controller_func
53 def active_user_from_url(controller
):
54 """Retrieve User() from <user> URL pattern and pass in as url_user=...
56 Returns a 404 if no such active user has been found"""
58 def wrapper(request
, *args
, **kwargs
):
59 user
= User
.query
.filter_by(username
=request
.matchdict
['user']).first()
61 return render_404(request
)
63 return controller(request
, *args
, url_user
=user
, **kwargs
)
68 def user_may_delete_media(controller
):
70 Require user ownership of the MediaEntry to delete.
73 def wrapper(request
, *args
, **kwargs
):
74 uploader_id
= kwargs
['media'].uploader
75 if not (request
.user
.is_admin
or
76 request
.user
.id == uploader_id
):
79 return controller(request
, *args
, **kwargs
)
84 def user_may_alter_collection(controller
):
86 Require user ownership of the Collection to modify.
89 def wrapper(request
, *args
, **kwargs
):
90 creator_id
= request
.db
.User
.query
.filter_by(
91 username
=request
.matchdict
['user']).first().id
92 if not (request
.user
.is_admin
or
93 request
.user
.id == creator_id
):
96 return controller(request
, *args
, **kwargs
)
101 def uses_pagination(controller
):
103 Check request GET 'page' key for wrong values
106 def wrapper(request
, *args
, **kwargs
):
108 page
= int(request
.GET
.get('page', 1))
110 return render_404(request
)
112 return render_404(request
)
114 return controller(request
, page
=page
, *args
, **kwargs
)
119 def get_user_media_entry(controller
):
121 Pass in a MediaEntry based off of a url component
124 def wrapper(request
, *args
, **kwargs
):
125 user
= User
.query
.filter_by(username
=request
.matchdict
['user']).first()
131 # might not be a slug, might be an id, but whatever
132 media_slug
= request
.matchdict
['media']
134 # if it starts with id: it actually isn't a slug, it's an id.
135 if media_slug
.startswith(u
'id:'):
137 media
= MediaEntry
.query
.filter_by(
138 id=int(media_slug
[3:]),
140 uploader
=user
.id).first()
144 # no magical id: stuff? It's a slug!
145 media
= MediaEntry
.query
.filter_by(
148 uploader
=user
.id).first()
151 # Didn't find anything? Okay, 404.
154 return controller(request
, media
=media
, *args
, **kwargs
)
159 def get_user_collection(controller
):
161 Pass in a Collection based off of a url component
164 def wrapper(request
, *args
, **kwargs
):
165 user
= request
.db
.User
.query
.filter_by(
166 username
=request
.matchdict
['user']).first()
169 return render_404(request
)
171 collection
= request
.db
.Collection
.query
.filter_by(
172 slug
=request
.matchdict
['collection'],
173 creator
=user
.id).first()
175 # Still no collection? Okay, 404.
177 return render_404(request
)
179 return controller(request
, collection
=collection
, *args
, **kwargs
)
184 def get_user_collection_item(controller
):
186 Pass in a CollectionItem based off of a url component
189 def wrapper(request
, *args
, **kwargs
):
190 user
= request
.db
.User
.query
.filter_by(
191 username
=request
.matchdict
['user']).first()
194 return render_404(request
)
196 collection_item
= request
.db
.CollectionItem
.query
.filter_by(
197 id=request
.matchdict
['collection_item']).first()
199 # Still no collection item? Okay, 404.
200 if not collection_item
:
201 return render_404(request
)
203 return controller(request
, collection_item
=collection_item
, *args
, **kwargs
)
208 def get_media_entry_by_id(controller
):
210 Pass in a MediaEntry based off of a url component
213 def wrapper(request
, *args
, **kwargs
):
214 media
= MediaEntry
.query
.filter_by(
215 id=request
.matchdict
['media_id'],
216 state
=u
'processed').first()
217 # Still no media? Okay, 404.
219 return render_404(request
)
221 given_username
= request
.matchdict
.get('user')
222 if given_username
and (given_username
!= media
.get_uploader
.username
):
223 return render_404(request
)
225 return controller(request
, media
=media
, *args
, **kwargs
)
230 def get_workbench(func
):
231 """Decorator, passing in a workbench as kwarg which is cleaned up afterwards"""
234 def new_func(*args
, **kwargs
):
235 with mgg
.workbench_manager
.create() as workbench
:
236 return func(*args
, workbench
=workbench
, **kwargs
)
241 def allow_registration(controller
):
242 """ Decorator for if registration is enabled"""
244 def wrapper(request
, *args
, **kwargs
):
245 if not mgg
.app_config
["allow_registration"]:
246 messages
.add_message(
249 _('Sorry, registration is disabled on this instance.'))
250 return redirect(request
, "index")
252 return controller(request
, *args
, **kwargs
)
257 def auth_enabled(controller
):
258 """Decorator for if an auth plugin is enabled"""
260 def wrapper(request
, *args
, **kwargs
):
262 messages
.add_message(
265 _('Sorry, authentication is disabled on this instance.'))
266 return redirect(request
, 'index')
268 return controller(request
, *args
, **kwargs
)