mirror of
https://github.com/evennia/evennia.git
synced 2026-03-29 03:57:17 +02:00
208 lines
No EOL
16 KiB
HTML
208 lines
No EOL
16 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>evennia.web.utils.middleware — Evennia latest documentation</title>
|
|
<link rel="stylesheet" href="../../../../_static/nature.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
|
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
|
<script src="../../../../_static/jquery.js"></script>
|
|
<script src="../../../../_static/underscore.js"></script>
|
|
<script src="../../../../_static/doctools.js"></script>
|
|
<script src="../../../../_static/language_data.js"></script>
|
|
<link rel="shortcut icon" href="../../../../_static/favicon.ico"/>
|
|
<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="../../../evennia.html" accesskey="U">evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.web.utils.middleware</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
|
|
<div class="documentwrapper">
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<p class="logo"><a href="../../../../index.html">
|
|
<img class="logo" src="../../../../_static/evennia_logo.png" alt="Logo"/>
|
|
</a></p>
|
|
<div 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" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>$('#searchbox').show(0);</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>
|
|
<h3>Doc Versions</h3>
|
|
<ul>
|
|
|
|
<li><a href="middleware.html">latest (main branch)</a></li>
|
|
|
|
<li><a href="../../3.x/index.html">v3.0.0 branch (outdated)</a></li>
|
|
|
|
<li><a href="../../2.x/index.html">v2.0.0 branch (outdated)</a></li>
|
|
|
|
<li><a href="../../1.x/index.html">v1.0.0 branch (outdated)</a></li>
|
|
|
|
<li><a href="../../0.x/index.html">v0.9.5 branch (outdated)</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for evennia.web.utils.middleware</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span> <span class="nn">django.contrib.auth</span> <span class="kn">import</span> <span class="n">authenticate</span><span class="p">,</span> <span class="n">login</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">evennia.accounts.models</span> <span class="kn">import</span> <span class="n">AccountDB</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">ip_from_request</span><span class="p">,</span> <span class="n">logger</span>
|
|
|
|
|
|
<div class="viewcode-block" id="OriginIpMiddleware"><a class="viewcode-back" href="../../../../api/evennia.web.utils.middleware.html#evennia.web.utils.middleware.OriginIpMiddleware">[docs]</a><span class="k">class</span> <span class="nc">OriginIpMiddleware</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> This Django Middleware simply sets the request.origin_ip attribute to what is</span>
|
|
<span class="sd"> respected by the Evennia Server, taking into account settings.UPSTREAM_IPS.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="OriginIpMiddleware.__init__"><a class="viewcode-back" href="../../../../api/evennia.web.utils.middleware.html#evennia.web.utils.middleware.OriginIpMiddleware.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">get_response</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">get_response</span> <span class="o">=</span> <span class="n">get_response</span></div>
|
|
|
|
<span class="k">def</span> <span class="fm">__call__</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">request</span><span class="o">.</span><span class="n">origin_ip</span> <span class="o">=</span> <span class="n">ip_from_request</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">request</span><span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="SharedLoginMiddleware"><a class="viewcode-back" href="../../../../api/evennia.web.utils.middleware.html#evennia.web.utils.middleware.SharedLoginMiddleware">[docs]</a><span class="k">class</span> <span class="nc">SharedLoginMiddleware</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Handle the shared login between website and webclient.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="SharedLoginMiddleware.__init__"><a class="viewcode-back" href="../../../../api/evennia.web.utils.middleware.html#evennia.web.utils.middleware.SharedLoginMiddleware.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">get_response</span><span class="p">):</span>
|
|
<span class="c1"># One-time configuration and initialization.</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">get_response</span> <span class="o">=</span> <span class="n">get_response</span></div>
|
|
|
|
<span class="k">def</span> <span class="fm">__call__</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="c1"># Code to be executed for each request before</span>
|
|
<span class="c1"># the view (and later middleware) are called.</span>
|
|
|
|
<span class="c1"># Synchronize credentials between webclient and website</span>
|
|
<span class="c1"># Must be performed *before* rendering the view (issue #1723)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">make_shared_login</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Process view</span>
|
|
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Code to be executed for each request/response after</span>
|
|
<span class="c1"># the view is called.</span>
|
|
|
|
<span class="c1"># Return processed view</span>
|
|
<span class="k">return</span> <span class="n">response</span>
|
|
|
|
<div class="viewcode-block" id="SharedLoginMiddleware.make_shared_login"><a class="viewcode-back" href="../../../../api/evennia.web.utils.middleware.html#evennia.web.utils.middleware.SharedLoginMiddleware.make_shared_login">[docs]</a> <span class="nd">@classmethod</span>
|
|
<span class="k">def</span> <span class="nf">make_shared_login</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
|
|
<span class="n">csession</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">session</span>
|
|
<span class="n">account</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span>
|
|
<span class="n">website_uid</span> <span class="o">=</span> <span class="n">csession</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"website_authenticated_uid"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
|
<span class="n">webclient_uid</span> <span class="o">=</span> <span class="n">csession</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"webclient_authenticated_uid"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">csession</span><span class="o">.</span><span class="n">session_key</span><span class="p">:</span>
|
|
<span class="c1"># this is necessary to build the sessid key</span>
|
|
<span class="n">csession</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
|
|
|
|
<span class="k">if</span> <span class="n">account</span><span class="o">.</span><span class="n">is_authenticated</span><span class="p">:</span>
|
|
<span class="c1"># Logged into website</span>
|
|
<span class="k">if</span> <span class="n">website_uid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="c1"># fresh website login (just from login page)</span>
|
|
<span class="n">csession</span><span class="p">[</span><span class="s2">"website_authenticated_uid"</span><span class="p">]</span> <span class="o">=</span> <span class="n">account</span><span class="o">.</span><span class="n">id</span>
|
|
<span class="k">if</span> <span class="n">webclient_uid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="c1"># auto-login web client</span>
|
|
<span class="n">csession</span><span class="p">[</span><span class="s2">"webclient_authenticated_uid"</span><span class="p">]</span> <span class="o">=</span> <span class="n">account</span><span class="o">.</span><span class="n">id</span>
|
|
|
|
<span class="k">elif</span> <span class="n">webclient_uid</span><span class="p">:</span>
|
|
<span class="c1"># Not logged into website, but logged into webclient</span>
|
|
<span class="k">if</span> <span class="n">website_uid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">csession</span><span class="p">[</span><span class="s2">"website_authenticated_uid"</span><span class="p">]</span> <span class="o">=</span> <span class="n">account</span><span class="o">.</span><span class="n">id</span>
|
|
<span class="n">account</span> <span class="o">=</span> <span class="n">AccountDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">webclient_uid</span><span class="p">)</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="c1"># calls our custom authenticate, in web/utils/backend.py</span>
|
|
<span class="n">authenticate</span><span class="p">(</span><span class="n">autologin</span><span class="o">=</span><span class="n">account</span><span class="p">)</span>
|
|
<span class="n">login</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">account</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
|
|
<span class="n">logger</span><span class="o">.</span><span class="n">log_trace</span><span class="p">()</span>
|
|
|
|
<span class="k">if</span> <span class="n">csession</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"webclient_authenticated_uid"</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
|
|
<span class="c1"># set a nonce to prevent the webclient from erasing the webclient_authenticated_uid value</span>
|
|
<span class="n">csession</span><span class="p">[</span><span class="s2">"webclient_authenticated_nonce"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
|
<span class="n">csession</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"webclient_authenticated_nonce"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span>
|
|
<span class="p">)</span>
|
|
<span class="c1"># wrap around to prevent integer overflows</span>
|
|
<span class="k">if</span> <span class="n">csession</span><span class="p">[</span><span class="s2">"webclient_authenticated_nonce"</span><span class="p">]</span> <span class="o">></span> <span class="mi">32</span><span class="p">:</span>
|
|
<span class="n">csession</span><span class="p">[</span><span class="s2">"webclient_authenticated_nonce"</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span></div></div>
|
|
</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="../../../evennia.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.web.utils.middleware</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2023, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
</body>
|
|
</html> |