mediagoblin/util.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011 Free Software Foundation, Inc
   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
  17 import sys
  18
  19 import jinja2
  20 import mongokit
  21
  22 def get_jinja_env(user_template_path=None):
  23     """
  24     Set up the Jinja environment, possibly allowing for user
  25     overridden templates.
  26
  27     (In the future we may have another system for providing theming;
  28     for now this is good enough.)
  29     """
  30     if user_template_path:
  31         loader = jinja2.ChoiceLoader(
  32             [jinja2.FileSystemLoader(user_template_path),
  33              jinja2.PackageLoader('mediagoblin', 'templates')])
  34     else:
  35         loader = jinja2.PackageLoader('mediagoblin', 'templates')
  36
  37     return jinja2.Environment(loader=loader, autoescape=True)
  38
  39
  40 def setup_user_in_request(request):
  41     """
  42     Examine a request and tack on a request.user parameter if that's
  43     appropriate.
  44     """
  45     if not request.session.has_key('user_id'):
  46         request.user = None
  47         return
  48
  49     user = None
  50     user = request.app.db.User.one(
  51         {'_id': mongokit.ObjectId(request.session['user_id'])})
  52
  53     if not user:
  54         # Something's wrong... this user doesn't exist?  Invalidate
  55         # this session.
  56         request.session.invalidate()
  57
  58     request.user = user
  59
  60
  61 def import_component(import_string):
  62     """
  63     Import a module component defined by STRING.  Probably a method,
  64     class, or global variable.
  65
  66     Args:
  67      - import_string: a string that defines what to import.  Written
  68        in the format of "module1.module2:component"
  69     """
  70     module_name, func_name = import_string.split(':', 1)
  71     __import__(module_name)
  72     module = sys.modules[module_name]
  73     func = getattr(module, func_name)
  74     return func