<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>horizon.decorators — Horizon 2012.2.3 documentation</title>
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/tweaks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2012.2.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/jquery.tweet.js"></script>
<link rel="top" title="Horizon 2012.2.3 documentation" href="../../index.html" />
<link rel="up" title="horizon" href="../horizon.html" />
</head>
<body>
<div id="header">
<h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
<li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for horizon.decorators</h1><div class="highlight"><pre>
<span class="c"># vim: tabstop=4 shiftwidth=4 softtabstop=4</span>
<span class="c"># Copyright 2012 United States Government as represented by the</span>
<span class="c"># Administrator of the National Aeronautics and Space Administration.</span>
<span class="c"># All Rights Reserved.</span>
<span class="c">#</span>
<span class="c"># Copyright 2012 CRS4</span>
<span class="c">#</span>
<span class="c"># Licensed under the Apache License, Version 2.0 (the "License"); you may</span>
<span class="c"># not use this file except in compliance with the License. You may obtain</span>
<span class="c"># a copy of the License at</span>
<span class="c">#</span>
<span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c">#</span>
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c"># distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span>
<span class="c"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span>
<span class="c"># License for the specific language governing permissions and limitations</span>
<span class="c"># under the License.</span>
<span class="sd">"""</span>
<span class="sd">General-purpose decorators for use with Horizon.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">functools</span>
<span class="kn">from</span> <span class="nn">django.utils.decorators</span> <span class="kn">import</span> <span class="n">available_attrs</span>
<span class="kn">from</span> <span class="nn">django.utils.translation</span> <span class="kn">import</span> <span class="n">ugettext</span> <span class="k">as</span> <span class="n">_</span>
<span class="kn">from</span> <span class="nn">horizon.exceptions</span> <span class="kn">import</span> <span class="n">NotAuthorized</span><span class="p">,</span> <span class="n">NotAuthenticated</span>
<span class="k">def</span> <span class="nf">_current_component</span><span class="p">(</span><span class="n">view_func</span><span class="p">,</span> <span class="n">dashboard</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">panel</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">""" Sets the currently-active dashboard and/or panel on the request. """</span>
<span class="nd">@functools.wraps</span><span class="p">(</span><span class="n">view_func</span><span class="p">,</span> <span class="n">assigned</span><span class="o">=</span><span class="n">available_attrs</span><span class="p">(</span><span class="n">view_func</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">dec</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">dashboard</span><span class="p">:</span>
<span class="n">request</span><span class="o">.</span><span class="n">horizon</span><span class="p">[</span><span class="s">'dashboard'</span><span class="p">]</span> <span class="o">=</span> <span class="n">dashboard</span>
<span class="k">if</span> <span class="n">panel</span><span class="p">:</span>
<span class="n">request</span><span class="o">.</span><span class="n">horizon</span><span class="p">[</span><span class="s">'panel'</span><span class="p">]</span> <span class="o">=</span> <span class="n">panel</span>
<span class="k">return</span> <span class="n">view_func</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">dec</span>
<div class="viewcode-block" id="require_auth"><a class="viewcode-back" href="../../sourcecode/horizon/horizon.decorators.html#horizon.decorators.require_auth">[docs]</a><span class="k">def</span> <span class="nf">require_auth</span><span class="p">(</span><span class="n">view_func</span><span class="p">):</span>
<span class="sd">""" Performs user authentication check.</span>
<span class="sd"> Similar to Django's `login_required` decorator, except that this throws</span>
<span class="sd"> :exc:`~horizon.exceptions.NotAuthenticated` exception if the user is not</span>
<span class="sd"> signed-in.</span>
<span class="sd"> """</span>
<span class="nd">@functools.wraps</span><span class="p">(</span><span class="n">view_func</span><span class="p">,</span> <span class="n">assigned</span><span class="o">=</span><span class="n">available_attrs</span><span class="p">(</span><span class="n">view_func</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">dec</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">is_authenticated</span><span class="p">():</span>
<span class="k">return</span> <span class="n">view_func</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">NotAuthenticated</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"Please log in to continue."</span><span class="p">))</span>
<span class="k">return</span> <span class="n">dec</span>
</div>
<div class="viewcode-block" id="require_perms"><a class="viewcode-back" href="../../sourcecode/horizon/horizon.decorators.html#horizon.decorators.require_perms">[docs]</a><span class="k">def</span> <span class="nf">require_perms</span><span class="p">(</span><span class="n">view_func</span><span class="p">,</span> <span class="n">required</span><span class="p">):</span>
<span class="sd">""" Enforces permission-based access controls.</span>
<span class="sd"> :param list required: A tuple of permission names, all of which the request</span>
<span class="sd"> user must possess in order access the decorated view.</span>
<span class="sd"> Example usage::</span>
<span class="sd"> from horizon.decorators import require_perms</span>
<span class="sd"> @require_perms(['foo.admin', 'foo.member'])</span>
<span class="sd"> def my_view(request):</span>
<span class="sd"> ...</span>
<span class="sd"> Raises a :exc:`~horizon.exceptions.NotAuthorized` exception if the</span>
<span class="sd"> requirements are not met.</span>
<span class="sd"> """</span>
<span class="c"># We only need to check each permission once for a view, so we'll use a set</span>
<span class="n">current_perms</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">view_func</span><span class="p">,</span> <span class="s">'_required_perms'</span><span class="p">,</span> <span class="nb">set</span><span class="p">([]))</span>
<span class="n">view_func</span><span class="o">.</span><span class="n">_required_perms</span> <span class="o">=</span> <span class="n">current_perms</span> <span class="o">|</span> <span class="nb">set</span><span class="p">(</span><span class="n">required</span><span class="p">)</span>
<span class="nd">@functools.wraps</span><span class="p">(</span><span class="n">view_func</span><span class="p">,</span> <span class="n">assigned</span><span class="o">=</span><span class="n">available_attrs</span><span class="p">(</span><span class="n">view_func</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">dec</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">is_authenticated</span><span class="p">():</span>
<span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">has_perms</span><span class="p">(</span><span class="n">view_func</span><span class="o">.</span><span class="n">_required_perms</span><span class="p">):</span>
<span class="k">return</span> <span class="n">view_func</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">NotAuthorized</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">"You are not authorized to access </span><span class="si">%s</span><span class="s">"</span><span class="p">)</span>
<span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="c"># If we don't have any permissions, just return the original view.</span>
<span class="k">if</span> <span class="n">required</span><span class="p">:</span>
<span class="k">return</span> <span class="n">dec</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">view_func</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">Horizon 2012.2.3 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../horizon.html" accesskey="U">horizon</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, OpenStack, LLC.
Last updated on Feb 08, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
