mediagoblin/api/decorators.py

   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 from functools import wraps
  17
  18 from mediagoblin.decorators import require_active_login
  19 from mediagoblin.tools.response import json_response
  20
  21 def user_has_privilege(privilege_name):
  22     """
  23     Requires that a user have a particular privilege in order to access a page.
  24     In order to require that a user have multiple privileges, use this
  25     decorator twice on the same view. This decorator also makes sure that the
  26     user is not banned, or else it redirects them to the "You are Banned" page.
  27
  28         :param privilege_name       A unicode object that is that represents
  29                                         the privilege object. This object is
  30                                         the name of the privilege, as assigned
  31                                         in the Privilege.privilege_name column
  32     """
  33
  34     def user_has_privilege_decorator(controller):
  35         @wraps(controller)
  36         @require_active_login
  37         def wrapper(request, *args, **kwargs):
  38             if not request.user.has_privilege(privilege_name):
  39                 error = "User '{0}' needs '{1}' privilege".format(
  40                     request.user.username,
  41                     privilege_name
  42                 )
  43                 return json_response({"error": error}, status=403)
  44
  45             return controller(request, *args, **kwargs)
  46
  47         return wrapper
  48     return user_has_privilege_decorator