Onionr/docs/html/onionr/onionrcommands/daemonlaunch.html

352 lines
17 KiB
HTML
Raw Normal View History

2019-09-23 23:20:14 +00:00
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.6.3" />
<title>onionr.onionrcommands.daemonlaunch API documentation</title>
<meta name="description" content="Onionr - Private P2P Communication …" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>onionr.onionrcommands.daemonlaunch</code></h1>
</header>
<section id="section-intro">
<p>Onionr - Private P2P Communication</p>
<p>launch the api servers and communicator</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#39;&#39;&#39;
Onionr - Private P2P Communication
launch the api servers and communicator
&#39;&#39;&#39;
&#39;&#39;&#39;
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
&#39;&#39;&#39;
import os, time, sys, platform, sqlite3, signal
from threading import Thread
import toomanyobjs
import config, apiservers, logger, communicator
from onionrplugins import onionrevents as events
from netcontroller import NetController
from onionrutils import localcommand
import filepaths
from coredb import daemonqueue
from etc import onionrvalues, cleanup
from onionrcrypto import getourkeypair
from utils import hastor, logoheader
from . import version
import serializeddata
def _proper_shutdown():
localcommand.local_command(&#39;shutdown&#39;)
sys.exit(1)
def daemon():
&#39;&#39;&#39;
Starts the Onionr communication daemon
&#39;&#39;&#39;
if not hastor.has_tor():
logger.error(&#34;Tor is not present in system path or Onionr directory&#34;, terminal=True)
sys.exit(1)
# remove runcheck if it exists
if os.path.isfile(filepaths.run_check_file):
logger.debug(&#39;Runcheck file found on daemon start, deleting in advance.&#39;)
os.remove(filepaths.run_check_file)
# Create shared object
shared_state = toomanyobjs.TooMany()
Thread(target=shared_state.get(apiservers.ClientAPI).start, daemon=True, name=&#39;client HTTP API&#39;).start()
Thread(target=shared_state.get(apiservers.PublicAPI).start, daemon=True, name=&#39;public HTTP API&#39;).start()
shared_state.get(serializeddata.SerializedData)
shared_state.share_object() # share the parent object to the threads
apiHost = &#39;&#39;
while apiHost == &#39;&#39;:
try:
with open(filepaths.public_API_host_file, &#39;r&#39;) as hostFile:
apiHost = hostFile.read()
except FileNotFoundError:
pass
time.sleep(0.5)
logger.raw(&#39;&#39;, terminal=True)
# print nice header thing :)
if config.get(&#39;general.display_header&#39;, True):
logoheader.header()
version.version(verbosity = 5, function = logger.info)
logger.debug(&#39;Python version %s&#39; % platform.python_version())
if onionrvalues.DEVELOPMENT_MODE:
logger.warn(&#39;Development mode enabled&#39;, timestamp = False, terminal=True)
net = NetController(config.get(&#39;client.public.port&#39;, 59497), apiServerIP=apiHost)
shared_state.add(net)
logger.info(&#39;Tor is starting...&#39;, terminal=True)
if not net.startTor():
localcommand.local_command(&#39;shutdown&#39;)
sys.exit(1)
if len(net.myID) &gt; 0 and config.get(&#39;general.security_level&#39;, 1) == 0:
logger.debug(&#39;Started .onion service: %s&#39; % (logger.colors.underline + net.myID))
else:
logger.debug(&#39;.onion service disabled&#39;)
logger.info(&#39;Using public key: %s&#39; % (logger.colors.underline + getourkeypair.get_keypair()[0][:52]))
try:
time.sleep(1)
except KeyboardInterrupt:
_proper_shutdown()
events.event(&#39;init&#39;, threaded = False)
events.event(&#39;daemon_start&#39;)
communicator.startCommunicator(shared_state)
localcommand.local_command(&#39;shutdown&#39;)
net.killTor()
try:
time.sleep(5) # Time to allow threads to finish, if not any &#34;daemon&#34; threads will be slaughtered http://docs.python.org/library/threading.html#threading.Thread.daemon
except KeyboardInterrupt:
pass
cleanup.delete_run_files()
def _ignore_sigint(sig, frame):
&#39;&#39;&#39;This space intentionally left blank&#39;&#39;&#39;
return
def kill_daemon():
&#39;&#39;&#39;
Shutdown the Onionr daemon (communicator)
&#39;&#39;&#39;
logger.warn(&#39;Stopping the running daemon...&#39;, timestamp = False, terminal=True)
try:
events.event(&#39;daemon_stop&#39;)
net = NetController(config.get(&#39;client.port&#39;, 59496))
try:
daemonqueue.daemon_queue_add(&#39;shutdown&#39;)
except sqlite3.OperationalError:
pass
net.killTor()
except Exception as e:
logger.error(&#39;Failed to shutdown daemon: &#39; + str(e), error = e, timestamp = False, terminal=True)
return
kill_daemon.onionr_help = &#34;Gracefully stops the Onionr API servers&#34;
def start(input: bool = False, override: bool = False):
&#34;&#34;&#34;If no lock file, make one and start onionr, error if there is and its not overridden&#34;&#34;&#34;
if os.path.exists(&#39;.onionr-lock&#39;) and not override:
logger.fatal(&#39;Cannot start. Daemon is already running, or it did not exit cleanly.\n(if you are sure that there is not a daemon running, delete .onionr-lock &amp; try again).&#39;, terminal=True)
else:
if not onionrvalues.DEVELOPMENT_MODE:
lockFile = open(&#39;.onionr-lock&#39;, &#39;w&#39;)
lockFile.write(&#39;&#39;)
lockFile.close()
daemon()
if not onionrvalues.DEVELOPMENT_MODE:
try:
os.remove(&#39;.onionr-lock&#39;)
except FileNotFoundError:
pass
start.onionr_help = &#34;Start Onionr node (public and clients API servers)&#34;</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="onionr.onionrcommands.daemonlaunch.daemon"><code class="name flex">
<span>def <span class="ident">daemon</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Starts the Onionr communication daemon</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def daemon():
&#39;&#39;&#39;
Starts the Onionr communication daemon
&#39;&#39;&#39;
if not hastor.has_tor():
logger.error(&#34;Tor is not present in system path or Onionr directory&#34;, terminal=True)
sys.exit(1)
# remove runcheck if it exists
if os.path.isfile(filepaths.run_check_file):
logger.debug(&#39;Runcheck file found on daemon start, deleting in advance.&#39;)
os.remove(filepaths.run_check_file)
# Create shared object
shared_state = toomanyobjs.TooMany()
Thread(target=shared_state.get(apiservers.ClientAPI).start, daemon=True, name=&#39;client HTTP API&#39;).start()
Thread(target=shared_state.get(apiservers.PublicAPI).start, daemon=True, name=&#39;public HTTP API&#39;).start()
shared_state.get(serializeddata.SerializedData)
shared_state.share_object() # share the parent object to the threads
apiHost = &#39;&#39;
while apiHost == &#39;&#39;:
try:
with open(filepaths.public_API_host_file, &#39;r&#39;) as hostFile:
apiHost = hostFile.read()
except FileNotFoundError:
pass
time.sleep(0.5)
logger.raw(&#39;&#39;, terminal=True)
# print nice header thing :)
if config.get(&#39;general.display_header&#39;, True):
logoheader.header()
version.version(verbosity = 5, function = logger.info)
logger.debug(&#39;Python version %s&#39; % platform.python_version())
if onionrvalues.DEVELOPMENT_MODE:
logger.warn(&#39;Development mode enabled&#39;, timestamp = False, terminal=True)
net = NetController(config.get(&#39;client.public.port&#39;, 59497), apiServerIP=apiHost)
shared_state.add(net)
logger.info(&#39;Tor is starting...&#39;, terminal=True)
if not net.startTor():
localcommand.local_command(&#39;shutdown&#39;)
sys.exit(1)
if len(net.myID) &gt; 0 and config.get(&#39;general.security_level&#39;, 1) == 0:
logger.debug(&#39;Started .onion service: %s&#39; % (logger.colors.underline + net.myID))
else:
logger.debug(&#39;.onion service disabled&#39;)
logger.info(&#39;Using public key: %s&#39; % (logger.colors.underline + getourkeypair.get_keypair()[0][:52]))
try:
time.sleep(1)
except KeyboardInterrupt:
_proper_shutdown()
events.event(&#39;init&#39;, threaded = False)
events.event(&#39;daemon_start&#39;)
communicator.startCommunicator(shared_state)
localcommand.local_command(&#39;shutdown&#39;)
net.killTor()
try:
time.sleep(5) # Time to allow threads to finish, if not any &#34;daemon&#34; threads will be slaughtered http://docs.python.org/library/threading.html#threading.Thread.daemon
except KeyboardInterrupt:
pass
cleanup.delete_run_files()</code></pre>
</details>
</dd>
<dt id="onionr.onionrcommands.daemonlaunch.kill_daemon"><code class="name flex">
<span>def <span class="ident">kill_daemon</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Shutdown the Onionr daemon (communicator)</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def kill_daemon():
&#39;&#39;&#39;
Shutdown the Onionr daemon (communicator)
&#39;&#39;&#39;
logger.warn(&#39;Stopping the running daemon...&#39;, timestamp = False, terminal=True)
try:
events.event(&#39;daemon_stop&#39;)
net = NetController(config.get(&#39;client.port&#39;, 59496))
try:
daemonqueue.daemon_queue_add(&#39;shutdown&#39;)
except sqlite3.OperationalError:
pass
net.killTor()
except Exception as e:
logger.error(&#39;Failed to shutdown daemon: &#39; + str(e), error = e, timestamp = False, terminal=True)
return</code></pre>
</details>
</dd>
<dt id="onionr.onionrcommands.daemonlaunch.start"><code class="name flex">
<span>def <span class="ident">start</span></span>(<span>input=False, override=False)</span>
</code></dt>
<dd>
<section class="desc"><p>If no lock file, make one and start onionr, error if there is and its not overridden</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def start(input: bool = False, override: bool = False):
&#34;&#34;&#34;If no lock file, make one and start onionr, error if there is and its not overridden&#34;&#34;&#34;
if os.path.exists(&#39;.onionr-lock&#39;) and not override:
logger.fatal(&#39;Cannot start. Daemon is already running, or it did not exit cleanly.\n(if you are sure that there is not a daemon running, delete .onionr-lock &amp; try again).&#39;, terminal=True)
else:
if not onionrvalues.DEVELOPMENT_MODE:
lockFile = open(&#39;.onionr-lock&#39;, &#39;w&#39;)
lockFile.write(&#39;&#39;)
lockFile.close()
daemon()
if not onionrvalues.DEVELOPMENT_MODE:
try:
os.remove(&#39;.onionr-lock&#39;)
except FileNotFoundError:
pass</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="onionr.onionrcommands" href="index.html">onionr.onionrcommands</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="onionr.onionrcommands.daemonlaunch.daemon" href="#onionr.onionrcommands.daemonlaunch.daemon">daemon</a></code></li>
<li><code><a title="onionr.onionrcommands.daemonlaunch.kill_daemon" href="#onionr.onionrcommands.daemonlaunch.kill_daemon">kill_daemon</a></code></li>
<li><code><a title="onionr.onionrcommands.daemonlaunch.start" href="#onionr.onionrcommands.daemonlaunch.start">start</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.3</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>