mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 22:06:30 +01:00
183 lines
No EOL
11 KiB
HTML
183 lines
No EOL
11 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
<title>evennia.web.utils.middleware — Evennia 3.x 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" />
|
|
<link rel="next" title="evennia.web.utils.tests" href="evennia.web.utils.tests.html" />
|
|
<link rel="prev" title="evennia.web.utils.general_context" href="evennia.web.utils.general_context.html" />
|
|
</head><body>
|
|
|
|
|
|
<div class="admonition important">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
|
|
</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"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.web.utils.tests.html" title="evennia.web.utils.tests"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.web.utils.general_context.html" title="evennia.web.utils.general_context"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 3.x</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-4"><a href="evennia.web.html" >evennia.web</a> »</li>
|
|
<li class="nav-item nav-item-5"><a href="evennia.web.utils.html" accesskey="U">evennia.web.utils</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>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="evennia.web.utils.general_context.html"
|
|
title="previous chapter">evennia.web.utils.general_context</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="evennia.web.utils.tests.html"
|
|
title="next chapter">evennia.web.utils.tests</a></p>
|
|
<div role="note" aria-label="source link">
|
|
<!--h3>This Page</h3-->
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/api/evennia.web.utils.middleware.md.txt"
|
|
rel="nofollow">Show Page Source</a></li>
|
|
</ul>
|
|
</div><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">
|
|
|
|
<section id="module-evennia.web.utils.middleware">
|
|
<span id="evennia-web-utils-middleware"></span><h1>evennia.web.utils.middleware<a class="headerlink" href="#module-evennia.web.utils.middleware" title="Permalink to this headline">¶</a></h1>
|
|
<dl class="py class">
|
|
<dt id="evennia.web.utils.middleware.OriginIpMiddleware">
|
|
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.middleware.</code><code class="sig-name descname">OriginIpMiddleware</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">get_response</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#OriginIpMiddleware"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.OriginIpMiddleware" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>This Django Middleware simply sets the request.origin_ip attribute to what is
|
|
respected by the Evennia Server, taking into account settings.UPSTREAM_IPS.</p>
|
|
<dl class="py method">
|
|
<dt id="evennia.web.utils.middleware.OriginIpMiddleware.__init__">
|
|
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">get_response</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#OriginIpMiddleware.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.OriginIpMiddleware.__init__" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware">
|
|
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.middleware.</code><code class="sig-name descname">SharedLoginMiddleware</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">get_response</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>Handle the shared login between website and webclient.</p>
|
|
<dl class="py method">
|
|
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware.__init__">
|
|
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">get_response</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware.__init__" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware.make_shared_login">
|
|
<em class="property">classmethod </em><code class="sig-name descname">make_shared_login</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware.make_shared_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware.make_shared_login" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
|
|
|
|
</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="right" >
|
|
<a href="evennia.web.utils.tests.html" title="evennia.web.utils.tests"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="evennia.web.utils.general_context.html" title="evennia.web.utils.general_context"
|
|
>previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 3.x</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-4"><a href="evennia.web.html" >evennia.web</a> »</li>
|
|
<li class="nav-item nav-item-5"><a href="evennia.web.utils.html" >evennia.web.utils</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.web.utils.middleware</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div class="admonition important">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
|
|
</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> |