mirror of
https://github.com/evennia/evennia.git
synced 2026-03-25 09:16:32 +01:00
238 lines
No EOL
16 KiB
HTML
238 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.server.models — Evennia 1.0-dev 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-dev</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.server.models</a></li>
|
|
</ul>
|
|
<div class="develop">develop branch</div>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for evennia.server.models</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""</span>
|
|
|
|
<span class="sd">Server Configuration flags</span>
|
|
|
|
<span class="sd">This holds persistent server configuration flags.</span>
|
|
|
|
<span class="sd">Config values should usually be set through the</span>
|
|
<span class="sd">manager's conf() method.</span>
|
|
|
|
<span class="sd">"""</span>
|
|
<span class="kn">from</span> <span class="nn">django.db</span> <span class="kn">import</span> <span class="n">models</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.idmapper.models</span> <span class="kn">import</span> <span class="n">WeakSharedMemoryModel</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">logger</span><span class="p">,</span> <span class="n">utils</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.dbserialize</span> <span class="kn">import</span> <span class="n">to_pickle</span><span class="p">,</span> <span class="n">from_pickle</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.server.manager</span> <span class="kn">import</span> <span class="n">ServerConfigManager</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">picklefield</span>
|
|
|
|
|
|
<span class="c1"># ------------------------------------------------------------</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># ServerConfig</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># ------------------------------------------------------------</span>
|
|
|
|
|
|
<div class="viewcode-block" id="ServerConfig"><a class="viewcode-back" href="../../../api/evennia.server.models.html#evennia.server.models.ServerConfig">[docs]</a><span class="k">class</span> <span class="nc">ServerConfig</span><span class="p">(</span><span class="n">WeakSharedMemoryModel</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> On-the fly storage of global settings.</span>
|
|
|
|
<span class="sd"> Properties defined on ServerConfig:</span>
|
|
|
|
<span class="sd"> - key: Main identifier</span>
|
|
<span class="sd"> - value: Value stored in key. This is a pickled storage.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="c1">#</span>
|
|
<span class="c1"># ServerConfig database model setup</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># These database fields are all set using their corresponding properties,</span>
|
|
<span class="c1"># named same as the field, but without the db_* prefix.</span>
|
|
|
|
<span class="c1"># main name of the database entry</span>
|
|
<span class="n">db_key</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">64</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="c1"># config value</span>
|
|
<span class="c1"># db_value = models.BinaryField(blank=True)</span>
|
|
|
|
<span class="n">db_value</span> <span class="o">=</span> <span class="n">picklefield</span><span class="o">.</span><span class="n">PickledObjectField</span><span class="p">(</span>
|
|
<span class="s2">"value"</span><span class="p">,</span>
|
|
<span class="n">null</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
|
<span class="n">help_text</span><span class="o">=</span><span class="s2">"The data returned when the config value is accessed. Must be "</span>
|
|
<span class="s2">"written as a Python literal if editing through the admin "</span>
|
|
<span class="s2">"interface. Attribute values which are not Python literals "</span>
|
|
<span class="s2">"cannot be edited through the admin interface."</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="n">objects</span> <span class="o">=</span> <span class="n">ServerConfigManager</span><span class="p">()</span>
|
|
<span class="n">_is_deleted</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="c1"># Wrapper properties to easily set database fields. These are</span>
|
|
<span class="c1"># @property decorators that allows to access these fields using</span>
|
|
<span class="c1"># normal python operations (without having to remember to save()</span>
|
|
<span class="c1"># etc). So e.g. a property 'attr' has a get/set/del decorator</span>
|
|
<span class="c1"># defined that allows the user to do self.attr = value,</span>
|
|
<span class="c1"># value = self.attr and del self.attr respectively (where self</span>
|
|
<span class="c1"># is the object in question).</span>
|
|
|
|
<span class="c1"># key property (wraps db_key)</span>
|
|
<span class="c1"># @property</span>
|
|
<span class="k">def</span> <span class="nf">__key_get</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="s2">"Getter. Allows for value = self.key"</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_key</span>
|
|
|
|
<span class="c1"># @key.setter</span>
|
|
<span class="k">def</span> <span class="nf">__key_set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="s2">"Setter. Allows for self.key = value"</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">db_key</span> <span class="o">=</span> <span class="n">value</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
|
|
|
|
<span class="c1"># @key.deleter</span>
|
|
<span class="k">def</span> <span class="nf">__key_del</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="s2">"Deleter. Allows for del self.key. Deletes entry."</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
|
|
|
|
<span class="n">key</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">__key_get</span><span class="p">,</span> <span class="n">__key_set</span><span class="p">,</span> <span class="n">__key_del</span><span class="p">)</span>
|
|
|
|
<span class="c1"># value property (wraps db_value)</span>
|
|
<span class="c1"># @property</span>
|
|
<span class="k">def</span> <span class="nf">__value_get</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="s2">"Getter. Allows for value = self.value"</span>
|
|
<span class="k">return</span> <span class="n">from_pickle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_value</span><span class="p">,</span> <span class="n">db_obj</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span>
|
|
|
|
<span class="c1"># @value.setter</span>
|
|
<span class="k">def</span> <span class="nf">__value_set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="s2">"Setter. Allows for self.value = value"</span>
|
|
<span class="k">if</span> <span class="n">utils</span><span class="o">.</span><span class="n">has_parent</span><span class="p">(</span><span class="s2">"django.db.models.base.Model"</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="c1"># we have to protect against storing db objects.</span>
|
|
<span class="n">logger</span><span class="o">.</span><span class="n">log_err</span><span class="p">(</span><span class="s2">"ServerConfig cannot store db objects! (</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="n">value</span><span class="p">)</span>
|
|
<span class="k">return</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">db_value</span> <span class="o">=</span> <span class="n">to_pickle</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
|
|
|
|
<span class="c1"># @value.deleter</span>
|
|
<span class="k">def</span> <span class="nf">__value_del</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="s2">"Deleter. Allows for del self.value. Deletes entry."</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
|
|
|
|
<span class="n">value</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">__value_get</span><span class="p">,</span> <span class="n">__value_set</span><span class="p">,</span> <span class="n">__value_del</span><span class="p">)</span>
|
|
|
|
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
|
|
<span class="s2">"Define Django meta options"</span>
|
|
<span class="n">verbose_name</span> <span class="o">=</span> <span class="s2">"Server Config value"</span>
|
|
<span class="n">verbose_name_plural</span> <span class="o">=</span> <span class="s2">"Server Config values"</span>
|
|
|
|
<span class="c1">#</span>
|
|
<span class="c1"># ServerConfig other methods</span>
|
|
<span class="c1">#</span>
|
|
<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="s2">"<</span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
|
|
|
|
<div class="viewcode-block" id="ServerConfig.store"><a class="viewcode-back" href="../../../api/evennia.server.models.html#evennia.server.models.ServerConfig.store">[docs]</a> <span class="k">def</span> <span class="nf">store</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Wrap the storage.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> key (str): The name of this store.</span>
|
|
<span class="sd"> value (str): The data to store with this `key`.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">value</span></div></div>
|
|
</pre></div>
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<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="models.html">1.0-dev (develop branch)</a></li>
|
|
<li><a href="../../../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></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-dev</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.server.models</a></li>
|
|
</ul>
|
|
<div class="develop">develop branch</div>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2020, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
</body>
|
|
</html> |