Onionr/src/onionrcommands/parser/__init__.py

130 lines
4.4 KiB
Python
Raw Normal View History

"""Onionr - Private P2P Communication.
2019-07-30 18:13:10 +00:00
This module loads in the Onionr arguments and their help messages
2019-12-19 10:32:40 +00:00
"""
import sys
import os
import logger
import onionrexceptions
import onionrplugins
from onionrplugins import onionrpluginapi
from . import arguments, recommend
"""
2019-07-30 18:13:10 +00:00
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/>.
2019-12-19 10:32:40 +00:00
"""
2019-08-05 00:34:57 +00:00
2019-12-19 10:32:40 +00:00
def plugin_command(cmd):
"""Build a plugin command function name."""
2019-12-19 10:32:40 +00:00
return f'on_{cmd}_cmd'
2019-12-19 10:32:40 +00:00
def register_plugin_commands(cmd) -> bool:
"""Find a plugin command hook and execute it for a given cmd."""
plugin_cmd = plugin_command(cmd)
2019-08-05 00:34:57 +00:00
for pl in onionrplugins.get_enabled_plugins():
pl = onionrplugins.get_plugin(pl)
if hasattr(pl, plugin_cmd):
getattr(pl, plugin_cmd)(onionrpluginapi.PluginAPI)
2019-08-05 00:34:57 +00:00
return True
return False
2019-08-05 00:34:57 +00:00
2019-12-19 10:32:40 +00:00
def _show_term(msg: str):
logger.info(msg, terminal=True)
2019-07-30 18:13:10 +00:00
def register():
"""Register commands and handles help command processing."""
2019-12-19 10:32:40 +00:00
def get_help_message(cmd: str,
default: str = 'No help available for this command'):
"""Print help message for a given command, supports plugin commands."""
pl_cmd = plugin_command(cmd)
for pl in onionrplugins.get_enabled_plugins():
pl = onionrplugins.get_plugin(pl)
if hasattr(pl, pl_cmd):
try:
return getattr(pl, pl_cmd).onionr_help
except AttributeError:
pass
2019-12-19 10:32:40 +00:00
2019-08-29 22:17:47 +00:00
for i in arguments.get_arguments():
for _ in i:
2019-08-29 22:17:47 +00:00
try:
return arguments.get_help(cmd)
except AttributeError:
pass
2019-12-19 10:32:40 +00:00
return default # Return the help string
2019-08-29 22:17:47 +00:00
PROGRAM_NAME = "onionr"
2019-08-30 00:37:39 +00:00
# Get the command
2019-08-02 23:00:04 +00:00
try:
cmd = sys.argv[1]
except IndexError:
2019-08-30 00:37:39 +00:00
logger.debug("Detected Onionr run with no commands specified")
return
is_help_cmd = False
if cmd.replace('--', '').lower() == 'help':
is_help_cmd = True
try:
2019-12-19 10:32:40 +00:00
try:
if cmd not in ('start', 'details', 'show-details'):
os.chdir(os.environ['ORIG_ONIONR_RUN_DIR'])
except KeyError:
pass
2019-11-04 10:52:38 +00:00
try:
arguments.get_func(cmd)()
except KeyboardInterrupt:
pass
except onionrexceptions.NotFound:
if not register_plugin_commands(cmd) and not is_help_cmd:
recommend.recommend()
sys.exit(3)
2019-12-19 10:32:40 +00:00
if is_help_cmd:
2019-08-29 22:17:47 +00:00
try:
sys.argv[2]
except IndexError:
for i in arguments.get_arguments():
2019-12-19 10:32:40 +00:00
_show_term('%s <%s>: %s' % (PROGRAM_NAME, '/'.join(i),
get_help_message(i[0])))
for pl in onionrplugins.get_enabled_plugins():
pl = onionrplugins.get_plugin(pl)
if hasattr(pl, 'ONIONR_COMMANDS'):
print('')
try:
2019-12-19 10:32:40 +00:00
_show_term('%s commands:' % (pl.plugin_name,))
except AttributeError:
2019-12-19 10:32:40 +00:00
_show_term('%s commands:' % (pl.__name__,))
for plugin_cmd in pl.ONIONR_COMMANDS:
2019-12-19 10:32:40 +00:00
_show_term('%s %s: %s' %
(PROGRAM_NAME,
plugin_cmd,
get_help_message(plugin_cmd)),)
print('')
2019-08-29 22:17:47 +00:00
else:
try:
2019-12-19 10:32:40 +00:00
_show_term('%s %s: %s' % (PROGRAM_NAME,
sys.argv[2],
get_help_message(sys.argv[2])))
2019-08-29 22:17:47 +00:00
except KeyError:
2019-12-19 10:32:40 +00:00
logger.error('%s: command does not exist.' % [sys.argv[2]],
terminal=True)
2019-08-29 22:17:47 +00:00
sys.exit(3)
return