mirror of
https://github.com/evennia/evennia.git
synced 2026-03-26 09:46:32 +01:00
244 lines
No EOL
19 KiB
HTML
244 lines
No EOL
19 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.general_context — Evennia 1.0 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 1.0</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.general_context</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">Home page</a> </li>
|
|
<li><a href="https://github.com/evennia/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>Versions</h3>
|
|
<ul>
|
|
<li><a href="general_context.html">1.0 (main branch)</a></li>
|
|
<ul>
|
|
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for evennia.web.utils.general_context</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""</span>
|
|
<span class="sd">This file defines global variables that will always be available in a view</span>
|
|
<span class="sd">context without having to repeatedly include it.</span>
|
|
|
|
<span class="sd">For this to work, this file is included in the settings file, in the</span>
|
|
<span class="sd">TEMPLATES["OPTIONS"]["context_processors"] list.</span>
|
|
|
|
<span class="sd">"""</span>
|
|
|
|
|
|
<span class="kn">import</span> <span class="nn">os</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">get_evennia_version</span>
|
|
|
|
<span class="c1"># Setup lists of the most relevant apps so</span>
|
|
<span class="c1"># the adminsite becomes more readable.</span>
|
|
|
|
<span class="n">GAME_NAME</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">GAME_SLOGAN</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">SERVER_VERSION</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">SERVER_HOSTNAME</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">REGISTER_ENABLED</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">TELNET_ENABLED</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">TELNET_PORTS</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">TELNET_SSL_ENABLED</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">TELNET_SSL_PORTS</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">SSH_ENABLED</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">SSH_PORTS</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">WEBCLIENT_ENABLED</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">WEBSOCKET_CLIENT_ENABLED</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">WEBSOCKET_PORT</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">WEBSOCKET_URL</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">REST_API_ENABLED</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="n">ACCOUNT_RELATED</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"Accounts"</span><span class="p">]</span>
|
|
<span class="n">GAME_ENTITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"Objects"</span><span class="p">,</span> <span class="s2">"Scripts"</span><span class="p">,</span> <span class="s2">"Comms"</span><span class="p">,</span> <span class="s2">"Help"</span><span class="p">]</span>
|
|
<span class="n">GAME_SETUP</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"Permissions"</span><span class="p">,</span> <span class="s2">"Config"</span><span class="p">]</span>
|
|
<span class="n">CONNECTIONS</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"Irc"</span><span class="p">]</span>
|
|
<span class="n">WEBSITE</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"Flatpages"</span><span class="p">,</span> <span class="s2">"News"</span><span class="p">,</span> <span class="s2">"Sites"</span><span class="p">]</span>
|
|
|
|
|
|
<div class="viewcode-block" id="load_game_settings"><a class="viewcode-back" href="../../../../api/evennia.web.utils.general_context.html#evennia.web.utils.general_context.load_game_settings">[docs]</a><span class="k">def</span> <span class="nf">load_game_settings</span><span class="p">():</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Load and cache game settings.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">global</span> <span class="n">GAME_NAME</span><span class="p">,</span> <span class="n">GAME_SLOGAN</span><span class="p">,</span> <span class="n">SERVER_VERSION</span><span class="p">,</span> <span class="n">SERVER_HOSTNAME</span>
|
|
<span class="k">global</span> <span class="n">REGISTER_ENABLED</span>
|
|
<span class="k">global</span> <span class="n">TELNET_ENABLED</span><span class="p">,</span> <span class="n">TELNET_PORTS</span>
|
|
<span class="k">global</span> <span class="n">TELNET_SSL_ENABLED</span><span class="p">,</span> <span class="n">TELNET_SSL_PORTS</span>
|
|
<span class="k">global</span> <span class="n">SSH_ENABLED</span><span class="p">,</span> <span class="n">SSH_PORTS</span>
|
|
<span class="k">global</span> <span class="n">WEBCLIENT_ENABLED</span><span class="p">,</span> <span class="n">WEBSOCKET_CLIENT_ENABLED</span><span class="p">,</span> <span class="n">WEBSOCKET_PORT</span><span class="p">,</span> <span class="n">WEBSOCKET_URL</span>
|
|
<span class="k">global</span> <span class="n">REST_API_ENABLED</span>
|
|
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">GAME_NAME</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">SERVERNAME</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
|
|
<span class="n">GAME_NAME</span> <span class="o">=</span> <span class="s2">"Evennia"</span>
|
|
<span class="n">SERVER_VERSION</span> <span class="o">=</span> <span class="n">get_evennia_version</span><span class="p">()</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">GAME_SLOGAN</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">GAME_SLOGAN</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
|
|
<span class="n">GAME_SLOGAN</span> <span class="o">=</span> <span class="n">SERVER_VERSION</span>
|
|
<span class="n">SERVER_HOSTNAME</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">SERVER_HOSTNAME</span>
|
|
|
|
<span class="n">REGISTER_ENABLED</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">NEW_ACCOUNT_REGISTRATION_ENABLED</span>
|
|
|
|
<span class="n">TELNET_ENABLED</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">TELNET_ENABLED</span>
|
|
<span class="n">TELNET_PORTS</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">TELNET_PORTS</span>
|
|
<span class="n">TELNET_SSL_ENABLED</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">SSL_ENABLED</span>
|
|
<span class="n">TELNET_SSL_PORTS</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">SSL_PORTS</span>
|
|
|
|
<span class="n">SSH_ENABLED</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">SSH_ENABLED</span>
|
|
<span class="n">SSH_PORTS</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">SSH_PORTS</span>
|
|
|
|
<span class="n">WEBCLIENT_ENABLED</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">WEBCLIENT_ENABLED</span>
|
|
<span class="n">WEBSOCKET_CLIENT_ENABLED</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">WEBSOCKET_CLIENT_ENABLED</span>
|
|
<span class="c1"># if we are working through a proxy or uses docker port-remapping, the webclient port encoded</span>
|
|
<span class="c1"># in the webclient should be different than the one the server expects. Use the environment</span>
|
|
<span class="c1"># variable WEBSOCKET_CLIENT_PROXY_PORT if this is the case.</span>
|
|
<span class="n">WEBSOCKET_PORT</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
|
|
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"WEBSOCKET_CLIENT_PROXY_PORT"</span><span class="p">,</span> <span class="n">settings</span><span class="o">.</span><span class="n">WEBSOCKET_CLIENT_PORT</span><span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="c1"># this is determined dynamically by the client and is less of an issue</span>
|
|
<span class="n">WEBSOCKET_URL</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">WEBSOCKET_CLIENT_URL</span>
|
|
|
|
<span class="n">REST_API_ENABLED</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">REST_API_ENABLED</span></div>
|
|
|
|
|
|
<span class="n">load_game_settings</span><span class="p">()</span>
|
|
|
|
|
|
<span class="c1"># The main context processor function</span>
|
|
<div class="viewcode-block" id="general_context"><a class="viewcode-back" href="../../../../api/evennia.web.utils.general_context.html#evennia.web.utils.general_context.general_context">[docs]</a><span class="k">def</span> <span class="nf">general_context</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Returns common Evennia-related context stuff, which is automatically added</span>
|
|
<span class="sd"> to context of all views.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="n">account</span> <span class="o">=</span> <span class="kc">None</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="n">account</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span>
|
|
|
|
<span class="n">puppet</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="k">if</span> <span class="n">account</span> <span class="ow">and</span> <span class="n">request</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"puppet"</span><span class="p">):</span>
|
|
<span class="n">pk</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"puppet"</span><span class="p">))</span>
|
|
<span class="n">puppet</span> <span class="o">=</span> <span class="nb">next</span><span class="p">((</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">account</span><span class="o">.</span><span class="n">characters</span> <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">pk</span> <span class="o">==</span> <span class="n">pk</span><span class="p">),</span> <span class="kc">None</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="p">{</span>
|
|
<span class="s2">"account"</span><span class="p">:</span> <span class="n">account</span><span class="p">,</span>
|
|
<span class="s2">"puppet"</span><span class="p">:</span> <span class="n">puppet</span><span class="p">,</span>
|
|
<span class="s2">"game_name"</span><span class="p">:</span> <span class="n">GAME_NAME</span><span class="p">,</span>
|
|
<span class="s2">"game_slogan"</span><span class="p">:</span> <span class="n">GAME_SLOGAN</span><span class="p">,</span>
|
|
<span class="s2">"server_hostname"</span><span class="p">:</span> <span class="n">SERVER_HOSTNAME</span><span class="p">,</span>
|
|
<span class="s2">"evennia_userapps"</span><span class="p">:</span> <span class="n">ACCOUNT_RELATED</span><span class="p">,</span>
|
|
<span class="s2">"evennia_entityapps"</span><span class="p">:</span> <span class="n">GAME_ENTITIES</span><span class="p">,</span>
|
|
<span class="s2">"evennia_setupapps"</span><span class="p">:</span> <span class="n">GAME_SETUP</span><span class="p">,</span>
|
|
<span class="s2">"evennia_connectapps"</span><span class="p">:</span> <span class="n">CONNECTIONS</span><span class="p">,</span>
|
|
<span class="s2">"evennia_websiteapps"</span><span class="p">:</span> <span class="n">WEBSITE</span><span class="p">,</span>
|
|
<span class="s2">"register_enabled"</span><span class="p">:</span> <span class="n">REGISTER_ENABLED</span><span class="p">,</span>
|
|
<span class="s2">"telnet_enabled"</span><span class="p">:</span> <span class="n">TELNET_ENABLED</span><span class="p">,</span>
|
|
<span class="s2">"telnet_ports"</span><span class="p">:</span> <span class="n">TELNET_PORTS</span><span class="p">,</span>
|
|
<span class="s2">"telnet_ssl_enabled"</span><span class="p">:</span> <span class="n">TELNET_SSL_ENABLED</span><span class="p">,</span>
|
|
<span class="s2">"telnet_ssl_ports"</span><span class="p">:</span> <span class="n">TELNET_SSL_PORTS</span><span class="p">,</span>
|
|
<span class="s2">"ssh_enabled"</span><span class="p">:</span> <span class="n">SSH_ENABLED</span><span class="p">,</span>
|
|
<span class="s2">"ssh_ports"</span><span class="p">:</span> <span class="n">SSH_ENABLED</span><span class="p">,</span>
|
|
<span class="s2">"webclient_enabled"</span><span class="p">:</span> <span class="n">WEBCLIENT_ENABLED</span><span class="p">,</span>
|
|
<span class="s2">"websocket_enabled"</span><span class="p">:</span> <span class="n">WEBSOCKET_CLIENT_ENABLED</span><span class="p">,</span>
|
|
<span class="s2">"websocket_port"</span><span class="p">:</span> <span class="n">WEBSOCKET_PORT</span><span class="p">,</span>
|
|
<span class="s2">"websocket_url"</span><span class="p">:</span> <span class="n">WEBSOCKET_URL</span><span class="p">,</span>
|
|
<span class="s2">"rest_api_enabled"</span><span class="p">:</span> <span class="n">REST_API_ENABLED</span><span class="p">,</span>
|
|
<span class="p">}</span></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 1.0</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.general_context</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2022, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
</body>
|
|
</html> |