367 lines
19 KiB
HTML
367 lines
19 KiB
HTML
<!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.7.4" />
|
|
<title>src.onionrcommands.onionrstatistics 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,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.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>src.onionrcommands.onionrstatistics</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
<p>Onionr - Private P2P Communication.</p>
|
|
<p>This module defines commands to show stats/details about the local node</p>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">"""Onionr - Private P2P Communication.
|
|
|
|
This module defines commands to show stats/details about the local node
|
|
"""
|
|
import os
|
|
import logger
|
|
from onionrblocks import onionrblockapi
|
|
from onionrblocks import onionrblacklist
|
|
from onionrutils import checkcommunicator, mnemonickeys
|
|
from utils import sizeutils, gethostname, getconsolewidth, identifyhome
|
|
from coredb import blockmetadb, keydb
|
|
import onionrcrypto
|
|
import config
|
|
from etc import onionrvalues
|
|
|
|
check_communicator = checkcommunicator.is_communicator_running
|
|
|
|
"""
|
|
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 <https://www.gnu.org/licenses/>.
|
|
"""
|
|
|
|
|
|
def show_stats():
|
|
"""Print/log statistic info about our Onionr install."""
|
|
try:
|
|
# define stats messages here
|
|
totalBlocks = len(blockmetadb.get_block_list())
|
|
home = identifyhome.identify_home()
|
|
totalBanned = len(onionrblacklist.OnionrBlackList().getList())
|
|
|
|
messages = {
|
|
# info about local client
|
|
'Onionr Daemon Status':
|
|
((logger.colors.fg.green + 'Online')
|
|
if check_communicator(timeout=9)
|
|
else logger.colors.fg.red + 'Offline'),
|
|
|
|
# file and folder size stats
|
|
'div1': True, # this creates a solid line across the screen, a div
|
|
'Total Block Size':
|
|
sizeutils.human_size(sizeutils.size(home + 'blocks/')),
|
|
'Total Plugin Size':
|
|
sizeutils.human_size(sizeutils.size(home + 'plugins/')),
|
|
'Log File Size':
|
|
sizeutils.human_size(sizeutils.size(home + 'output.log')),
|
|
|
|
# count stats
|
|
'div2': True,
|
|
'Known Peers (nodes)':
|
|
str(max(len(keydb.listkeys.list_adders()) - 1, 0)),
|
|
'Enabled Plugins':
|
|
str(len(config.get('plugins.enabled', list()))) + ' / ' +
|
|
str(len(os.listdir(home + 'plugins/'))),
|
|
'Stored Blocks': str(totalBlocks),
|
|
'Deleted Blocks': str(totalBanned)
|
|
}
|
|
|
|
# color configuration
|
|
colors = {
|
|
'title': logger.colors.bold,
|
|
'key': logger.colors.fg.lightgreen,
|
|
'val': logger.colors.fg.green,
|
|
'border': logger.colors.fg.lightblue,
|
|
|
|
'reset': logger.colors.reset
|
|
}
|
|
|
|
# pre-processing
|
|
maxlength = 0
|
|
width = getconsolewidth.get_console_width()
|
|
for key, val in messages.items():
|
|
if not (type(val) is bool and val is True):
|
|
maxlength = max(len(key), maxlength)
|
|
prewidth = maxlength + len(' | ')
|
|
groupsize = width - prewidth - len('[+] ')
|
|
|
|
# generate stats table
|
|
logger.info(colors['title'] + 'Onionr v%s Statistics' %
|
|
onionrvalues.ONIONR_VERSION + colors['reset'],
|
|
terminal=True)
|
|
logger.info(colors['border'] + '-' * (maxlength + 1) +
|
|
'+' + colors['reset'], terminal=True)
|
|
for key, val in messages.items():
|
|
if not (type(val) is bool and val is True):
|
|
val = [str(val)[i:i + groupsize]
|
|
for i in range(0, len(str(val)), groupsize)]
|
|
|
|
logger.info(colors['key'] + str(key).rjust(maxlength) +
|
|
colors['reset'] + colors['border'] +
|
|
' | ' + colors['reset'] + colors['val'] +
|
|
str(val.pop(0)) + colors['reset'], terminal=True)
|
|
|
|
for value in val:
|
|
logger.info(' ' * maxlength + colors['border'] + ' | ' +
|
|
colors['reset'] + colors['val'] + str(
|
|
value) + colors['reset'], terminal=True)
|
|
else:
|
|
logger.info(colors['border'] + '-' * (maxlength +
|
|
1) + '+' +
|
|
colors['reset'], terminal=True)
|
|
logger.info(colors['border'] + '-' * (maxlength + 1) +
|
|
'+' + colors['reset'], terminal=True)
|
|
except Exception as e: # pylint: disable=W0703
|
|
logger.error('Failed to generate statistics table. ' +
|
|
str(e), error=e, timestamp=False, terminal=True)
|
|
|
|
|
|
def show_details():
|
|
"""Print out details.
|
|
|
|
node transport address(es)
|
|
active user ID
|
|
active user ID in mnemonic form
|
|
"""
|
|
details = {
|
|
'Node Address': gethostname.get_hostname(),
|
|
'Public Key': onionrcrypto.pub_key.replace('=', ''),
|
|
'Human-readable Public Key': mnemonickeys.get_human_readable_ID()
|
|
}
|
|
|
|
for detail in details:
|
|
logger.info('%s%s: \n%s%s\n' % (logger.colors.fg.lightgreen,
|
|
detail, logger.colors.fg.green,
|
|
details[detail]), terminal=True)
|
|
|
|
|
|
show_details.onionr_help = "Shows relevant information " # type: ignore
|
|
show_details.onionr_help += "for your Onionr install: node " # type: ignore
|
|
show_details.onionr_help += "address, and active public key." # type: ignore
|
|
|
|
show_stats.onionr_help = "Shows statistics for your Onionr " # type: ignore
|
|
show_stats.onionr_help += "node. Slow if Onionr is not running" # type: ignore</code></pre>
|
|
</details>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-functions">Functions</h2>
|
|
<dl>
|
|
<dt id="src.onionrcommands.onionrstatistics.check_communicator"><code class="name flex">
|
|
<span>def <span class="ident">check_communicator</span></span>(<span>timeout=5, interval=0.1)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def is_communicator_running(timeout = 5, interval = 0.1):
|
|
try:
|
|
runcheck_file = filepaths.run_check_file
|
|
|
|
if not os.path.isfile(runcheck_file):
|
|
open(runcheck_file, 'w+').close()
|
|
|
|
starttime = time.time()
|
|
|
|
while True:
|
|
time.sleep(interval)
|
|
|
|
if not os.path.isfile(runcheck_file):
|
|
return True
|
|
elif time.time() - starttime >= timeout:
|
|
return False
|
|
except:
|
|
return False</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="src.onionrcommands.onionrstatistics.show_details"><code class="name flex">
|
|
<span>def <span class="ident">show_details</span></span>(<span>)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Print out details.</p>
|
|
<p>node transport address(es)
|
|
active user ID
|
|
active user ID in mnemonic form</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def show_details():
|
|
"""Print out details.
|
|
|
|
node transport address(es)
|
|
active user ID
|
|
active user ID in mnemonic form
|
|
"""
|
|
details = {
|
|
'Node Address': gethostname.get_hostname(),
|
|
'Public Key': onionrcrypto.pub_key.replace('=', ''),
|
|
'Human-readable Public Key': mnemonickeys.get_human_readable_ID()
|
|
}
|
|
|
|
for detail in details:
|
|
logger.info('%s%s: \n%s%s\n' % (logger.colors.fg.lightgreen,
|
|
detail, logger.colors.fg.green,
|
|
details[detail]), terminal=True)</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="src.onionrcommands.onionrstatistics.show_stats"><code class="name flex">
|
|
<span>def <span class="ident">show_stats</span></span>(<span>)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Print/log statistic info about our Onionr install.</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def show_stats():
|
|
"""Print/log statistic info about our Onionr install."""
|
|
try:
|
|
# define stats messages here
|
|
totalBlocks = len(blockmetadb.get_block_list())
|
|
home = identifyhome.identify_home()
|
|
totalBanned = len(onionrblacklist.OnionrBlackList().getList())
|
|
|
|
messages = {
|
|
# info about local client
|
|
'Onionr Daemon Status':
|
|
((logger.colors.fg.green + 'Online')
|
|
if check_communicator(timeout=9)
|
|
else logger.colors.fg.red + 'Offline'),
|
|
|
|
# file and folder size stats
|
|
'div1': True, # this creates a solid line across the screen, a div
|
|
'Total Block Size':
|
|
sizeutils.human_size(sizeutils.size(home + 'blocks/')),
|
|
'Total Plugin Size':
|
|
sizeutils.human_size(sizeutils.size(home + 'plugins/')),
|
|
'Log File Size':
|
|
sizeutils.human_size(sizeutils.size(home + 'output.log')),
|
|
|
|
# count stats
|
|
'div2': True,
|
|
'Known Peers (nodes)':
|
|
str(max(len(keydb.listkeys.list_adders()) - 1, 0)),
|
|
'Enabled Plugins':
|
|
str(len(config.get('plugins.enabled', list()))) + ' / ' +
|
|
str(len(os.listdir(home + 'plugins/'))),
|
|
'Stored Blocks': str(totalBlocks),
|
|
'Deleted Blocks': str(totalBanned)
|
|
}
|
|
|
|
# color configuration
|
|
colors = {
|
|
'title': logger.colors.bold,
|
|
'key': logger.colors.fg.lightgreen,
|
|
'val': logger.colors.fg.green,
|
|
'border': logger.colors.fg.lightblue,
|
|
|
|
'reset': logger.colors.reset
|
|
}
|
|
|
|
# pre-processing
|
|
maxlength = 0
|
|
width = getconsolewidth.get_console_width()
|
|
for key, val in messages.items():
|
|
if not (type(val) is bool and val is True):
|
|
maxlength = max(len(key), maxlength)
|
|
prewidth = maxlength + len(' | ')
|
|
groupsize = width - prewidth - len('[+] ')
|
|
|
|
# generate stats table
|
|
logger.info(colors['title'] + 'Onionr v%s Statistics' %
|
|
onionrvalues.ONIONR_VERSION + colors['reset'],
|
|
terminal=True)
|
|
logger.info(colors['border'] + '-' * (maxlength + 1) +
|
|
'+' + colors['reset'], terminal=True)
|
|
for key, val in messages.items():
|
|
if not (type(val) is bool and val is True):
|
|
val = [str(val)[i:i + groupsize]
|
|
for i in range(0, len(str(val)), groupsize)]
|
|
|
|
logger.info(colors['key'] + str(key).rjust(maxlength) +
|
|
colors['reset'] + colors['border'] +
|
|
' | ' + colors['reset'] + colors['val'] +
|
|
str(val.pop(0)) + colors['reset'], terminal=True)
|
|
|
|
for value in val:
|
|
logger.info(' ' * maxlength + colors['border'] + ' | ' +
|
|
colors['reset'] + colors['val'] + str(
|
|
value) + colors['reset'], terminal=True)
|
|
else:
|
|
logger.info(colors['border'] + '-' * (maxlength +
|
|
1) + '+' +
|
|
colors['reset'], terminal=True)
|
|
logger.info(colors['border'] + '-' * (maxlength + 1) +
|
|
'+' + colors['reset'], terminal=True)
|
|
except Exception as e: # pylint: disable=W0703
|
|
logger.error('Failed to generate statistics table. ' +
|
|
str(e), error=e, timestamp=False, terminal=True)</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="src.onionrcommands" href="index.html">src.onionrcommands</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-functions">Functions</a></h3>
|
|
<ul class="">
|
|
<li><code><a title="src.onionrcommands.onionrstatistics.check_communicator" href="#src.onionrcommands.onionrstatistics.check_communicator">check_communicator</a></code></li>
|
|
<li><code><a title="src.onionrcommands.onionrstatistics.show_details" href="#src.onionrcommands.onionrstatistics.show_details">show_details</a></code></li>
|
|
<li><code><a title="src.onionrcommands.onionrstatistics.show_stats" href="#src.onionrcommands.onionrstatistics.show_stats">show_stats</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.7.4</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> |