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
21 from werkzeug
.urls
import url_quote
23 from mediagoblin
import mg_globals
as mgg
24 from mediagoblin
.db
.models
import MediaEntry
, User
25 from mediagoblin
.tools
.response
import redirect
, render_404
28 def require_active_login(controller
):
30 Require an active login from the user.
33 def new_controller_func(request
, *args
, **kwargs
):
35 request
.user
.status
== u
'needs_email_verification':
37 request
, 'mediagoblin.user_pages.user_home',
38 user
=request
.user
.username
)
39 elif not request
.user
or request
.user
.status
!= u
'active':
41 request
.urlgen('mediagoblin.auth.login',
45 return redirect(request
, 'mediagoblin.auth.login',
48 return controller(request
, *args
, **kwargs
)
50 return new_controller_func
52 def active_user_from_url(controller
):
53 """Retrieve User() from <user> URL pattern and pass in as url_user=...
55 Returns a 404 if no such active user has been found"""
57 def wrapper(request
, *args
, **kwargs
):
58 user
= User
.query
.filter_by(username
=request
.matchdict
['user']).first()
60 return render_404(request
)
62 return controller(request
, *args
, url_user
=user
, **kwargs
)
67 def user_may_delete_media(controller
):
69 Require user ownership of the MediaEntry to delete.
72 def wrapper(request
, *args
, **kwargs
):
73 uploader_id
= kwargs
['media'].uploader
74 if not (request
.user
.is_admin
or
75 request
.user
.id == uploader_id
):
78 return controller(request
, *args
, **kwargs
)
83 def user_may_alter_collection(controller
):
85 Require user ownership of the Collection to modify.
88 def wrapper(request
, *args
, **kwargs
):
89 creator_id
= request
.db
.User
.find_one(
90 {'username': request
.matchdict
['user']}).id
91 if not (request
.user
.is_admin
or
92 request
.user
.id == creator_id
):
95 return controller(request
, *args
, **kwargs
)
100 def uses_pagination(controller
):
102 Check request GET 'page' key for wrong values
105 def wrapper(request
, *args
, **kwargs
):
107 page
= int(request
.GET
.get('page', 1))
109 return render_404(request
)
111 return render_404(request
)
113 return controller(request
, page
=page
, *args
, **kwargs
)
118 def get_user_media_entry(controller
):
120 Pass in a MediaEntry based off of a url component
123 def wrapper(request
, *args
, **kwargs
):
124 user
= User
.query
.filter_by(username
=request
.matchdict
['user']).first()
130 # might not be a slug, might be an id, but whatever
131 media_slug
= request
.matchdict
['media']
133 # if it starts with id: it actually isn't a slug, it's an id.
134 if media_slug
.startswith(u
'id:'):
136 media
= MediaEntry
.query
.filter_by(
137 id=int(media_slug
[3:]),
139 uploader
=user
.id).first()
143 # no magical id: stuff? It's a slug!
144 media
= MediaEntry
.query
.filter_by(
147 uploader
=user
.id).first()
150 # Didn't find anything? Okay, 404.
153 return controller(request
, media
=media
, *args
, **kwargs
)
158 def get_user_collection(controller
):
160 Pass in a Collection based off of a url component
163 def wrapper(request
, *args
, **kwargs
):
164 user
= request
.db
.User
.find_one(
165 {'username': request
.matchdict
['user']})
168 return render_404(request
)
170 collection
= request
.db
.Collection
.find_one(
171 {'slug': request
.matchdict
['collection'],
174 # Still no collection? Okay, 404.
176 return render_404(request
)
178 return controller(request
, collection
=collection
, *args
, **kwargs
)
183 def get_user_collection_item(controller
):
185 Pass in a CollectionItem based off of a url component
188 def wrapper(request
, *args
, **kwargs
):
189 user
= request
.db
.User
.find_one(
190 {'username': request
.matchdict
['user']})
193 return render_404(request
)
195 collection_item
= request
.db
.CollectionItem
.find_one(
196 {'id': request
.matchdict
['collection_item'] })
198 # Still no collection item? Okay, 404.
199 if not collection_item
:
200 return render_404(request
)
202 return controller(request
, collection_item
=collection_item
, *args
, **kwargs
)
207 def get_media_entry_by_id(controller
):
209 Pass in a MediaEntry based off of a url component
212 def wrapper(request
, *args
, **kwargs
):
213 media
= MediaEntry
.query
.filter_by(
214 id=request
.matchdict
['media_id'],
215 state
=u
'processed').first()
216 # Still no media? Okay, 404.
218 return render_404(request
)
220 given_username
= request
.matchdict
.get('user')
221 if given_username
and (given_username
!= media
.get_uploader
.username
):
222 return render_404(request
)
224 return controller(request
, media
=media
, *args
, **kwargs
)
229 def get_workbench(func
):
230 """Decorator, passing in a workbench as kwarg which is cleaned up afterwards"""
233 def new_func(*args
, **kwargs
):
234 with mgg
.workbench_manager
.create() as workbench
:
235 return func(*args
, workbench
=workbench
, **kwargs
)