X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=mediagoblin%2Fdecorators.py;h=804fab7e17e3c3cd8d89d9528feeb84061bb86b9;hb=a89df96132a897b1ac31da8719cd6dc0d621cc13;hp=c2fe3f9fdbf0bd7db962e197589b0f1c6e8aadfc;hpb=ec8f66bd650e580eae67ad97fbc81776365d84f2;p=mediagoblin.git diff --git a/mediagoblin/decorators.py b/mediagoblin/decorators.py index c2fe3f9f..804fab7e 100644 --- a/mediagoblin/decorators.py +++ b/mediagoblin/decorators.py @@ -1,5 +1,5 @@ # GNU MediaGoblin -- federated, autonomous media hosting -# Copyright (C) 2011 Free Software Foundation, Inc +# Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by @@ -14,111 +14,223 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . +from functools import wraps -from bson.errors import InvalidId -from webob import exc +from urlparse import urljoin +from werkzeug.exceptions import Forbidden, NotFound +from werkzeug.urls import url_quote -from mediagoblin.util import redirect -from mediagoblin.db.util import ObjectId - - -def _make_safe(decorator, original): - """ - Copy the function data from the old function to the decorator. - """ - decorator.__name__ = original.__name__ - decorator.__dict__ = original.__dict__ - decorator.__doc__ = original.__doc__ - return decorator +from mediagoblin import mg_globals as mgg +from mediagoblin.db.models import MediaEntry, User +from mediagoblin.tools.response import redirect, render_404 def require_active_login(controller): """ Require an active login from the user. """ + @wraps(controller) def new_controller_func(request, *args, **kwargs): if request.user and \ request.user.get('status') == u'needs_email_verification': - return redirect(request, - 'mediagoblin.auth.verify_email_notice') + return redirect( + request, 'mediagoblin.user_pages.user_home', + user=request.user.username) elif not request.user or request.user.get('status') != u'active': - return exc.HTTPFound( - location="%s?next=%s" % ( - request.urlgen("mediagoblin.auth.login"), - request.path_info)) + next_url = urljoin( + request.urlgen('mediagoblin.auth.login', + qualified=True), + request.url) + + return redirect(request, 'mediagoblin.auth.login', + next=url_quote(next_url)) return controller(request, *args, **kwargs) - return _make_safe(new_controller_func, controller) + return new_controller_func + +def active_user_from_url(controller): + """Retrieve User() from URL pattern and pass in as url_user=... + + Returns a 404 if no such active user has been found""" + @wraps(controller) + def wrapper(request, *args, **kwargs): + user = User.query.filter_by(username=request.matchdict['user']).first() + if user is None: + return render_404(request) + + return controller(request, *args, url_user=user, **kwargs) + + return wrapper + + +def user_may_delete_media(controller): + """ + Require user ownership of the MediaEntry to delete. + """ + @wraps(controller) + def wrapper(request, *args, **kwargs): + uploader_id = kwargs['media'].uploader + if not (request.user.is_admin or + request.user.id == uploader_id): + raise Forbidden() + + return controller(request, *args, **kwargs) + + return wrapper + + +def user_may_alter_collection(controller): + """ + Require user ownership of the Collection to modify. + """ + @wraps(controller) + def wrapper(request, *args, **kwargs): + creator_id = request.db.User.find_one( + {'username': request.matchdict['user']}).id + if not (request.user.is_admin or + request.user.id == creator_id): + raise Forbidden() + + return controller(request, *args, **kwargs) + + return wrapper def uses_pagination(controller): """ Check request GET 'page' key for wrong values """ + @wraps(controller) def wrapper(request, *args, **kwargs): try: page = int(request.GET.get('page', 1)) if page < 0: - return exc.HTTPNotFound() + return render_404(request) except ValueError: - return exc.HTTPNotFound() + return render_404(request) return controller(request, page=page, *args, **kwargs) - return _make_safe(wrapper, controller) + return wrapper def get_user_media_entry(controller): """ Pass in a MediaEntry based off of a url component """ + @wraps(controller) def wrapper(request, *args, **kwargs): - user = request.db.User.find_one( - {'username': request.matchdict['user']}) - + user = User.query.filter_by(username=request.matchdict['user']).first() if not user: - return exc.HTTPNotFound() + raise NotFound() - media = request.db.MediaEntry.find_one( - {'slug': request.matchdict['media'], - 'state': 'processed', - 'uploader': user['_id']}) + media = MediaEntry.query.filter_by( + slug = request.matchdict['media'], + state = u'processed', + uploader = user.id).first() - # no media via slug? Grab it via ObjectId if not media: + # no media via slug? Grab it via object id try: - media = request.db.MediaEntry.find_one( - {'_id': ObjectId(request.matchdict['media']), - 'state': 'processed', - 'uploader': user['_id']}) - except InvalidId: - return exc.HTTPNotFound() + media = MediaEntry.query.filter_by( + id = int(request.matchdict['media']), + state = u'processed', + uploader = user.id).first() + except ValueError: + # media "id" was no int + raise NotFound() - # Still no media? Okay, 404. - if not media: - return exc.HTTPNotFound() + if not media: + # no media by that id? Okay, 404. + raise NotFound() return controller(request, media=media, *args, **kwargs) - return _make_safe(wrapper, controller) + return wrapper + + +def get_user_collection(controller): + """ + Pass in a Collection based off of a url component + """ + @wraps(controller) + def wrapper(request, *args, **kwargs): + user = request.db.User.find_one( + {'username': request.matchdict['user']}) + + if not user: + return render_404(request) + + collection = request.db.Collection.find_one( + {'slug': request.matchdict['collection'], + 'creator': user.id}) + + # Still no collection? Okay, 404. + if not collection: + return render_404(request) + + return controller(request, collection=collection, *args, **kwargs) + + return wrapper + + +def get_user_collection_item(controller): + """ + Pass in a CollectionItem based off of a url component + """ + @wraps(controller) + def wrapper(request, *args, **kwargs): + user = request.db.User.find_one( + {'username': request.matchdict['user']}) + + if not user: + return render_404(request) + + collection = request.db.Collection.find_one( + {'slug': request.matchdict['collection'], + 'creator': user.id}) + + collection_item = request.db.CollectionItem.find_one( + {'id': request.matchdict['collection_item'] }) + + # Still no collection item? Okay, 404. + if not collection_item: + return render_404(request) + + return controller(request, collection_item=collection_item, *args, **kwargs) + + return wrapper + def get_media_entry_by_id(controller): """ Pass in a MediaEntry based off of a url component """ + @wraps(controller) def wrapper(request, *args, **kwargs): - try: - media = request.db.MediaEntry.find_one( - {'_id': ObjectId(request.matchdict['media']), - 'state': 'processed'}) - except InvalidId: - return exc.HTTPNotFound() - + media = MediaEntry.query.filter_by( + id=request.matchdict['media_id'], + state=u'processed').first() # Still no media? Okay, 404. if not media: - return exc.HTTPNotFound() + return render_404(request) + + given_username = request.matchdict.get('user') + if given_username and (given_username != media.get_uploader.username): + return render_404(request) return controller(request, media=media, *args, **kwargs) - return _make_safe(wrapper, controller) + return wrapper + + +def get_workbench(func): + """Decorator, passing in a workbench as kwarg which is cleaned up afterwards""" + + @wraps(func) + def new_func(*args, **kwargs): + with mgg.workbench_manager.create() as workbench: + return func(*args, workbench=workbench, **kwargs) + + return new_func