mirror of
https://github.com/evennia/evennia.git
synced 2026-03-27 02:06:32 +01:00
365 lines
No EOL
39 KiB
HTML
365 lines
No EOL
39 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>django.contrib.auth.backends — Evennia latest 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" type="text/css" href="../../../../_static/pygments.css?v=d75fae25" />
|
|
<link rel="stylesheet" type="text/css" href="../../../../_static/nature.css?v=245aff17" />
|
|
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
|
<script src="../../../../_static/documentation_options.js?v=c6e86fd7"></script>
|
|
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<link rel="index" title="Index" href="../../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../../search.html" />
|
|
</head><body>
|
|
|
|
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<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 class="nav-item nav-item-0"><a href="../../../../index.html">Evennia latest</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../auth.html" accesskey="U">django.contrib.auth</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">django.contrib.auth.backends</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
|
|
<div class="documentwrapper">
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<search id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../../../../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</search>
|
|
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Links</h3>
|
|
<ul>
|
|
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
|
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
|
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
|
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
|
<li>
|
|
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
|
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
|
<a href="https://evennia.blogspot.com/">Blog</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for django.contrib.auth.backends</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">django.contrib.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_user_model</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.contrib.auth.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">Permission</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.db.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">Exists</span><span class="p">,</span> <span class="n">OuterRef</span><span class="p">,</span> <span class="n">Q</span>
|
|
|
|
<span class="n">UserModel</span> <span class="o">=</span> <span class="n">get_user_model</span><span class="p">()</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">BaseBackend</span><span class="p">:</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</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="kc">None</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_user</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_id</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="kc">None</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_user_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="nb">set</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_group_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="nb">set</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_all_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="p">{</span>
|
|
<span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">get_user_permissions</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="n">obj</span><span class="p">),</span>
|
|
<span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">get_group_permissions</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="n">obj</span><span class="p">),</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">has_perm</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">perm</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">perm</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_all_permissions</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span>
|
|
|
|
|
|
<div class="viewcode-block" id="ModelBackend">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">ModelBackend</span><span class="p">(</span><span class="n">BaseBackend</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Authenticates against settings.AUTH_USER_MODEL.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="ModelBackend.authenticate">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.authenticate">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">username</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="kc">None</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">username</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">username</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">UserModel</span><span class="o">.</span><span class="n">USERNAME_FIELD</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">username</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">password</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">return</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">user</span> <span class="o">=</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">_default_manager</span><span class="o">.</span><span class="n">get_by_natural_key</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">DoesNotExist</span><span class="p">:</span>
|
|
<span class="c1"># Run the default password hasher once to reduce the timing</span>
|
|
<span class="c1"># difference between an existing and a nonexistent user (#20760).</span>
|
|
<span class="n">UserModel</span><span class="p">()</span><span class="o">.</span><span class="n">set_password</span><span class="p">(</span><span class="n">password</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">user</span><span class="o">.</span><span class="n">check_password</span><span class="p">(</span><span class="n">password</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">user_can_authenticate</span><span class="p">(</span><span class="n">user</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">user</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ModelBackend.user_can_authenticate">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.user_can_authenticate">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">user_can_authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Reject users with is_active=False. Custom user models that don't have</span>
|
|
<span class="sd"> that attribute are allowed.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">user</span><span class="p">,</span> <span class="s2">"is_active"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span></div>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">_get_user_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">user_permissions</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">_get_group_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">):</span>
|
|
<span class="n">user_groups_field</span> <span class="o">=</span> <span class="n">get_user_model</span><span class="p">()</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">get_field</span><span class="p">(</span><span class="s2">"groups"</span><span class="p">)</span>
|
|
<span class="n">user_groups_query</span> <span class="o">=</span> <span class="s2">"group__</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">user_groups_field</span><span class="o">.</span><span class="n">related_query_name</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="n">Permission</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="o">**</span><span class="p">{</span><span class="n">user_groups_query</span><span class="p">:</span> <span class="n">user_obj</span><span class="p">})</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">_get_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">from_name</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return the permissions of `user_obj` from `from_name`. `from_name` can</span>
|
|
<span class="sd"> be either "group" or "user" to return permissions from</span>
|
|
<span class="sd"> `_get_group_permissions` or `_get_user_permissions` respectively.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">is_active</span> <span class="ow">or</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">is_anonymous</span> <span class="ow">or</span> <span class="n">obj</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">set</span><span class="p">()</span>
|
|
|
|
<span class="n">perm_cache_name</span> <span class="o">=</span> <span class="s2">"_</span><span class="si">%s</span><span class="s2">_perm_cache"</span> <span class="o">%</span> <span class="n">from_name</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="n">perm_cache_name</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">is_superuser</span><span class="p">:</span>
|
|
<span class="n">perms</span> <span class="o">=</span> <span class="n">Permission</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">perms</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_get_</span><span class="si">%s</span><span class="s2">_permissions"</span> <span class="o">%</span> <span class="n">from_name</span><span class="p">)(</span><span class="n">user_obj</span><span class="p">)</span>
|
|
<span class="n">perms</span> <span class="o">=</span> <span class="n">perms</span><span class="o">.</span><span class="n">values_list</span><span class="p">(</span><span class="s2">"content_type__app_label"</span><span class="p">,</span> <span class="s2">"codename"</span><span class="p">)</span><span class="o">.</span><span class="n">order_by</span><span class="p">()</span>
|
|
<span class="nb">setattr</span><span class="p">(</span>
|
|
<span class="n">user_obj</span><span class="p">,</span> <span class="n">perm_cache_name</span><span class="p">,</span> <span class="p">{</span><span class="s2">"</span><span class="si">%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">ct</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="k">for</span> <span class="n">ct</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">perms</span><span class="p">}</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="n">perm_cache_name</span><span class="p">)</span>
|
|
|
|
<div class="viewcode-block" id="ModelBackend.get_user_permissions">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.get_user_permissions">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_user_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return a set of permission strings the user `user_obj` has from their</span>
|
|
<span class="sd"> `user_permissions`.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_permissions</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="s2">"user"</span><span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ModelBackend.get_group_permissions">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.get_group_permissions">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_group_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return a set of permission strings the user `user_obj` has from the</span>
|
|
<span class="sd"> groups they belong.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_permissions</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="s2">"group"</span><span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ModelBackend.get_all_permissions">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.get_all_permissions">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_all_permissions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">is_active</span> <span class="ow">or</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">is_anonymous</span> <span class="ow">or</span> <span class="n">obj</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">set</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="s2">"_perm_cache"</span><span class="p">):</span>
|
|
<span class="n">user_obj</span><span class="o">.</span><span class="n">_perm_cache</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_all_permissions</span><span class="p">(</span><span class="n">user_obj</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">_perm_cache</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ModelBackend.has_perm">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.has_perm">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">has_perm</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">perm</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">is_active</span> <span class="ow">and</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">has_perm</span><span class="p">(</span><span class="n">user_obj</span><span class="p">,</span> <span class="n">perm</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ModelBackend.has_module_perms">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.has_module_perms">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">has_module_perms</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_obj</span><span class="p">,</span> <span class="n">app_label</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return True if user_obj has any permissions in the given app_label.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="n">user_obj</span><span class="o">.</span><span class="n">is_active</span> <span class="ow">and</span> <span class="nb">any</span><span class="p">(</span>
|
|
<span class="n">perm</span><span class="p">[:</span> <span class="n">perm</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s2">"."</span><span class="p">)]</span> <span class="o">==</span> <span class="n">app_label</span>
|
|
<span class="k">for</span> <span class="n">perm</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_all_permissions</span><span class="p">(</span><span class="n">user_obj</span><span class="p">)</span>
|
|
<span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ModelBackend.with_perm">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.with_perm">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">with_perm</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">perm</span><span class="p">,</span> <span class="n">is_active</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">include_superusers</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return users that have permission "perm". By default, filter out</span>
|
|
<span class="sd"> inactive users and include superusers.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">perm</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">app_label</span><span class="p">,</span> <span class="n">codename</span> <span class="o">=</span> <span class="n">perm</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
<span class="s2">"Permission name should be in the form "</span>
|
|
<span class="s2">"app_label.permission_codename."</span>
|
|
<span class="p">)</span>
|
|
<span class="k">elif</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">perm</span><span class="p">,</span> <span class="n">Permission</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
|
|
<span class="s2">"The `perm` argument must be a string or a permission instance."</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">obj</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">_default_manager</span><span class="o">.</span><span class="n">none</span><span class="p">()</span>
|
|
|
|
<span class="n">permission_q</span> <span class="o">=</span> <span class="n">Q</span><span class="p">(</span><span class="n">group__user</span><span class="o">=</span><span class="n">OuterRef</span><span class="p">(</span><span class="s2">"pk"</span><span class="p">))</span> <span class="o">|</span> <span class="n">Q</span><span class="p">(</span><span class="n">user</span><span class="o">=</span><span class="n">OuterRef</span><span class="p">(</span><span class="s2">"pk"</span><span class="p">))</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">perm</span><span class="p">,</span> <span class="n">Permission</span><span class="p">):</span>
|
|
<span class="n">permission_q</span> <span class="o">&=</span> <span class="n">Q</span><span class="p">(</span><span class="n">pk</span><span class="o">=</span><span class="n">perm</span><span class="o">.</span><span class="n">pk</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">permission_q</span> <span class="o">&=</span> <span class="n">Q</span><span class="p">(</span><span class="n">codename</span><span class="o">=</span><span class="n">codename</span><span class="p">,</span> <span class="n">content_type__app_label</span><span class="o">=</span><span class="n">app_label</span><span class="p">)</span>
|
|
|
|
<span class="n">user_q</span> <span class="o">=</span> <span class="n">Exists</span><span class="p">(</span><span class="n">Permission</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">permission_q</span><span class="p">))</span>
|
|
<span class="k">if</span> <span class="n">include_superusers</span><span class="p">:</span>
|
|
<span class="n">user_q</span> <span class="o">|=</span> <span class="n">Q</span><span class="p">(</span><span class="n">is_superuser</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">is_active</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">user_q</span> <span class="o">&=</span> <span class="n">Q</span><span class="p">(</span><span class="n">is_active</span><span class="o">=</span><span class="n">is_active</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">_default_manager</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">user_q</span><span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ModelBackend.get_user">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.utils.backends.html#evennia.web.utils.backends.ModelBackend.get_user">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_user</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_id</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">user</span> <span class="o">=</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">_default_manager</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">pk</span><span class="o">=</span><span class="n">user_id</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">DoesNotExist</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="kc">None</span>
|
|
<span class="k">return</span> <span class="n">user</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">user_can_authenticate</span><span class="p">(</span><span class="n">user</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span></div>
|
|
</div>
|
|
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">AllowAllUsersModelBackend</span><span class="p">(</span><span class="n">ModelBackend</span><span class="p">):</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">user_can_authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="kc">True</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">RemoteUserBackend</span><span class="p">(</span><span class="n">ModelBackend</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> This backend is to be used in conjunction with the ``RemoteUserMiddleware``</span>
|
|
<span class="sd"> found in the middleware module of this package, and is used when the server</span>
|
|
<span class="sd"> is handling authentication outside of Django.</span>
|
|
|
|
<span class="sd"> By default, the ``authenticate`` method creates ``User`` objects for</span>
|
|
<span class="sd"> usernames that don't already exist in the database. Subclasses can disable</span>
|
|
<span class="sd"> this behavior by setting the ``create_unknown_user`` attribute to</span>
|
|
<span class="sd"> ``False``.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="c1"># Create a User object if not already in the database?</span>
|
|
<span class="n">create_unknown_user</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">remote_user</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> The username passed as ``remote_user`` is considered trusted. Return</span>
|
|
<span class="sd"> the ``User`` object with the given username. Create a new ``User``</span>
|
|
<span class="sd"> object if ``create_unknown_user`` is ``True``.</span>
|
|
|
|
<span class="sd"> Return None if ``create_unknown_user`` is ``False`` and a ``User``</span>
|
|
<span class="sd"> object with the given username is not found in the database.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">remote_user</span><span class="p">:</span>
|
|
<span class="k">return</span>
|
|
<span class="n">created</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="n">user</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">username</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">clean_username</span><span class="p">(</span><span class="n">remote_user</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Note that this could be accomplished in one try-except clause, but</span>
|
|
<span class="c1"># instead we use get_or_create when creating unknown users since it has</span>
|
|
<span class="c1"># built-in safeguards for multiple threads.</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_unknown_user</span><span class="p">:</span>
|
|
<span class="n">user</span><span class="p">,</span> <span class="n">created</span> <span class="o">=</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">_default_manager</span><span class="o">.</span><span class="n">get_or_create</span><span class="p">(</span>
|
|
<span class="o">**</span><span class="p">{</span><span class="n">UserModel</span><span class="o">.</span><span class="n">USERNAME_FIELD</span><span class="p">:</span> <span class="n">username</span><span class="p">}</span>
|
|
<span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">user</span> <span class="o">=</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">_default_manager</span><span class="o">.</span><span class="n">get_by_natural_key</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">UserModel</span><span class="o">.</span><span class="n">DoesNotExist</span><span class="p">:</span>
|
|
<span class="k">pass</span>
|
|
<span class="n">user</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">configure_user</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">created</span><span class="o">=</span><span class="n">created</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">user</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">user_can_authenticate</span><span class="p">(</span><span class="n">user</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">clean_username</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Perform any cleaning on the "username" prior to using it to get or</span>
|
|
<span class="sd"> create the user object. Return the cleaned username.</span>
|
|
|
|
<span class="sd"> By default, return the username unchanged.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="n">username</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">configure_user</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">created</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Configure a user and return the updated user.</span>
|
|
|
|
<span class="sd"> By default, return the user unmodified.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="n">user</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">AllowAllUsersRemoteUserBackend</span><span class="p">(</span><span class="n">RemoteUserBackend</span><span class="p">):</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">user_can_authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="kc">True</span>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../../genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../../../index.html">Evennia latest</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../auth.html" >django.contrib.auth</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">django.contrib.auth.backends</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2024, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
</div>
|
|
</body>
|
|
</html> |