def configure(settings: Config):
"""
| name | example | purpose |
| ---- | ------- | ------- |
| default\\_mode | on | Which mode to use in channels without a mode set. |
| known\\_good | sopel.chat,dftba.net | List of "known good" domains or regexes to consider trusted. This can save VT API calls. |
| vt\\_api\\_key | 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef | Optional VirusTotal API key to improve malicious URL detection |
| domain\\_blocklist\\_url | https://example.com/bad-hosts.txt | Optional hosts-file formatted domain blocklist to use instead of StevenBlack's. |
"""
settings.define_section("safety", SafetySection)
settings.safety.configure_setting(
"default_mode",
("Which mode should be used in channels that haven't specifically set one?"
"\n({})".format("/".join(SAFETY_MODES))),
default="on",
)
settings.safety.configure_setting(
'known_good',
"Enter any domains or regexes to consider trusted",
)
settings.safety.configure_setting(
'vt_api_key',
"Optionally, enter a VirusTotal API key to improve malicious URL "
"protection.\nOtherwise, only the configured hosts list will be used.",
)
settings.safety.configure_setting(
"domain_blocklist_url",
"Optionally, provide the URL for a hosts-file formatted domain "
"blocklist to use instead of StevenBlack's.",
)
def get_configuration(options):
"""Get or create a configuration object from ``options``.
:param options: argument parser's options
:type options: ``argparse.Namespace``
:return: a configuration object
:rtype: :class:`sopel.config.Config`
This may raise a :exc:`sopel.config.ConfigurationError` if the
configuration file is invalid.
.. seealso::
The configuration file is loaded by
:func:`~sopel.cli.run.utils.load_settings` or created using the
configuration wizard.
"""
try:
bot_config = utils.load_settings(options)
except ConfigurationNotFound as error:
print("Welcome to Sopel!\n"
"I can't seem to find the configuration file, "
"so let's generate it!\n")
config_path = error.filename
if not config_path.endswith('.cfg'):
config_path = config_path + '.cfg'
config_path = _create_config(config_path)
# try to reload it now that it's created
bot_config = Config(config_path)
bot_config._is_daemonized = options.daemonize
return bot_config
def configure(config: Config):
"""
| name | example | purpose |
| ---- | ------- | ------- |
| enable_auto_title | yes | Enable auto-title. |
| exclude | https?://git\\\\.io/.* | A list of regular expressions for URLs for which the title should not be shown. |
| exclusion\\_char | ! | A character (or string) which, when immediately preceding a URL, will stop the URL's title from being shown. |
| shorten\\_url\\_length | 72 | If greater than 0, the title fetcher will include a TinyURL version of links longer than this many characters. |
| enable\\_private\\_resolution | False | Enable requests to private and local network IP addresses. |
"""
config.define_section('url', UrlSection)
config.url.configure_setting('enable_auto_title', 'Enable auto-title?')
config.url.configure_setting(
'exclude',
'Enter regular expressions for each URL you would like to exclude.')
config.url.configure_setting(
'exclusion_char',
'Enter a character which can be prefixed to suppress URL titling')
config.url.configure_setting(
'shorten_url_length',
'Enter how many characters a URL should be before the bot puts a'
' shorter version of the URL in the title as a TinyURL link'
' (0 to disable)')
config.url.configure_setting(
'enable_private_resolution',
'Enable requests to private and local network IP addresses?')
def get_configuration(options):
"""Get an instance of configuration from options.
This may raise a ``sopel.config.ConfigurationError`` if the file is an
invalid configuration file.
"""
config_name = options.config or 'default'
config_path = find_config(DEFAULT_HOMEDIR, config_name)
if not os.path.isfile(config_path):
print("Welcome to Sopel!\n"
"I can't seem to find the configuration file, "
"so let's generate it!\n")
if not config_path.endswith('.cfg'):
config_path = config_path + '.cfg'
config_path = _create_config(config_path)
bot_config = Config(config_path)
bot_config._is_daemonized = options.daemonize
return bot_config
def get_configuration(options):
"""Get or create a configuration object from ``options``.
:param options: argument parser's options
:type options: ``argparse.Namespace``
:return: a configuration object
:rtype: :class:`sopel.config.Config`
This may raise a :exc:`sopel.config.ConfigurationError` if the
configuration file is invalid.
.. seealso::
The configuration file is loaded by
:func:`~sopel.cli.run.utils.load_settings` or created using the
configuration wizard.
"""
try:
bot_config = utils.load_settings(options)
except ConfigurationNotFound as error:
print(
"Welcome to Sopel!\n"
"I can't seem to find the configuration file, "
"so let's generate it!\n")
config_path = error.filename
if not config_path.endswith('.cfg'):
config_path = config_path + '.cfg'
config_path = _create_config(config_path)
# try to reload it now that it's created
bot_config = Config(config_path)
bot_config._is_daemonized = options.daemonize
return bot_config
def get_configuration(options):
"""Get an instance of configuration from options.
This may raise a ``sopel.config.ConfigurationError`` if the file is an
invalid configuration file.
"""
try:
bot_config = utils.load_settings(options)
except ConfigurationNotFound as error:
print(
"Welcome to Sopel!\n"
"I can't seem to find the configuration file, "
"so let's generate it!\n")
config_path = error.filename
if not config_path.endswith('.cfg'):
config_path = config_path + '.cfg'
config_path = _create_config(config_path)
# try to reload it now that it's created
bot_config = Config(config_path)
bot_config._is_daemonized = options.daemonize
return bot_config
def main(argv=None):
global homedir
# Step One: Parse The Command Line
try:
parser = argparse.ArgumentParser(description='Sopel IRC Bot',
usage='%(prog)s [options]')
parser.add_argument('-c', '--config', metavar='filename',
help='use a specific configuration file')
parser.add_argument("-d", '--fork', action="store_true",
dest="daemonize", help="Daemonize sopel")
parser.add_argument("-q", '--quit', action="store_true", dest="quit",
help="Gracefully quit Sopel")
parser.add_argument("-k", '--kill', action="store_true", dest="kill",
help="Kill Sopel")
parser.add_argument("-l", '--list', action="store_true",
dest="list_configs",
help="List all config files found")
parser.add_argument("-m", '--migrate', action="store_true",
dest="migrate_configs",
help="Migrate config files to the new format")
parser.add_argument('--quiet', action="store_true", dest="quiet",
help="Supress all output")
parser.add_argument('-w', '--configure-all', action='store_true',
dest='wizard', help='Run the configuration wizard.')
parser.add_argument('--configure-modules', action='store_true',
dest='mod_wizard', help=(
'Run the configuration wizard, but only for the '
'module configuration options.'))
parser.add_argument('-v', '--version', action="store_true",
dest="version", help="Show version number and exit")
opts = parser.parse_args()
# Step Two: "Do not run as root" checks.
try:
# Linux/Mac
if os.getuid() == 0 or os.geteuid() == 0:
stderr('Error: Do not run Sopel with root privileges.')
sys.exit(1)
except AttributeError:
# Windows
if os.environ.get("USERNAME") == "Administrator":
stderr('Error: Do not run Sopel as Administrator.')
sys.exit(1)
if opts.version:
py_ver = '%s.%s.%s' % (sys.version_info.major,
sys.version_info.minor,
sys.version_info.micro)
print('Sopel %s (running on python %s)' % (__version__, py_ver))
print('http://sopel.chat/')
return
elif opts.wizard:
_wizard('all', opts.config)
return
elif opts.mod_wizard:
_wizard('mod', opts.config)
return
if opts.list_configs:
configs = enumerate_configs()
print('Config files in ~/.sopel:')
if len(configs) is 0:
print('\tNone found')
else:
for config in configs:
print('\t%s' % config)
print('-------------------------')
return
config_name = opts.config or 'default'
configpath = find_config(config_name)
if not os.path.isfile(configpath):
print("Welcome to Sopel!\nI can't seem to find the configuration file, so let's generate it!\n")
if not configpath.endswith('.cfg'):
configpath = configpath + '.cfg'
_create_config(configpath)
configpath = find_config(config_name)
try:
config_module = Config(configpath)
except ConfigurationError as e:
stderr(e)
sys.exit(2)
if config_module.core.not_configured:
stderr('Bot is not configured, can\'t start')
# exit with code 2 to prevent auto restart on fail by systemd
sys.exit(2)
logfile = os.path.os.path.join(config_module.core.logdir, 'stdio.log')
config_module._is_daemonized = opts.daemonize
sys.stderr = tools.OutputRedirect(logfile, True, opts.quiet)
sys.stdout = tools.OutputRedirect(logfile, False, opts.quiet)
# Handle --quit, --kill and saving the PID to file
pid_dir = config_module.core.pid_dir
if opts.config is None:
pid_file_path = os.path.join(pid_dir, 'sopel.pid')
else:
basename = os.path.basename(opts.config)
if basename.endswith('.cfg'):
basename = basename[:-4]
pid_file_path = os.path.join(pid_dir, 'sopel-%s.pid' % basename)
if os.path.isfile(pid_file_path):
with open(pid_file_path, 'r') as pid_file:
try:
old_pid = int(pid_file.read())
except ValueError:
old_pid = None
if old_pid is not None and tools.check_pid(old_pid):
if not opts.quit and not opts.kill:
stderr('There\'s already a Sopel instance running with this config file')
stderr('Try using the --quit or the --kill options')
sys.exit(1)
elif opts.kill:
stderr('Killing the sopel')
os.kill(old_pid, signal.SIGKILL)
sys.exit(0)
elif opts.quit:
stderr('Signaling Sopel to stop gracefully')
if hasattr(signal, 'SIGUSR1'):
os.kill(old_pid, signal.SIGUSR1)
else:
os.kill(old_pid, signal.SIGTERM)
sys.exit(0)
elif old_pid is None or (not tools.check_pid(old_pid)
and (opts.kill or opts.quit)):
stderr('Sopel is not running!')
sys.exit(1)
elif opts.quit or opts.kill:
stderr('Sopel is not running!')
sys.exit(1)
if opts.daemonize:
child_pid = os.fork()
if child_pid is not 0:
sys.exit()
with open(pid_file_path, 'w') as pid_file:
pid_file.write(str(os.getpid()))
# Step Five: Initialise And Run sopel
run(config_module, pid_file_path)
except KeyboardInterrupt:
print("\n\nInterrupted")
os._exit(1)
def main(argv=None):
global homedir
# Step One: Parse The Command Line
try:
parser = optparse.OptionParser('%prog [options]')
parser.add_option('-c',
'--config',
metavar='filename',
help='use a specific configuration file')
parser.add_option("-d",
'--fork',
action="store_true",
dest="deamonize",
help="Deamonize sopel")
parser.add_option("-q",
'--quit',
action="store_true",
dest="quit",
help="Gracefully quit Sopel")
parser.add_option("-k",
'--kill',
action="store_true",
dest="kill",
help="Kill Sopel")
parser.add_option(
'--exit-on-error',
action="store_true",
dest="exit_on_error",
help="Exit immediately on every error instead of trying to recover"
)
parser.add_option("-l",
'--list',
action="store_true",
dest="list_configs",
help="List all config files found")
parser.add_option("-m",
'--migrate',
action="store_true",
dest="migrate_configs",
help="Migrate config files to the new format")
parser.add_option('--quiet',
action="store_true",
dest="quiet",
help="Supress all output")
parser.add_option('-w',
'--configure-all',
action='store_true',
dest='wizard',
help='Run the configuration wizard.')
parser.add_option(
'--configure-modules',
action='store_true',
dest='mod_wizard',
help=
'Run the configuration wizard, but only for the module configuration options.'
)
parser.add_option(
'--configure-database',
action='store_true',
dest='db_wizard',
help=
'Run the configuration wizard, but only for the database configuration options.'
)
opts, args = parser.parse_args(argv)
if opts.wizard:
wizard('all', opts.config)
return
elif opts.mod_wizard:
wizard('mod', opts.config)
return
elif opts.db_wizard:
wizard('db', opts.config)
return
check_python_version()
if opts.list_configs is not None:
configs = enumerate_configs()
print 'Archives de configuation:'
if len(configs[0]) is 0:
print u'\tJe n\'ai trouvé pas rien'
else:
for config in configs:
print '\t%s' % config
print '-------------------------'
return
config_name = opts.config or 'default'
configpath = find_config(config_name)
if not os.path.isfile(configpath):
print u"Welcome to JoikervgBot configuration wizard! -- ¡Bienvenido al asistente de configuración de JoikervgBot! -- Bienvenue à l'assistant de configuration de JoikervgBot!\n"
if not configpath.endswith('.cfg'):
configpath = configpath + '.cfg'
create_config(configpath)
configpath = find_config(config_name)
try:
config_module = Config(configpath)
except ConfigurationError as e:
stderr(e)
sys.exit(2)
if config_module.core.not_configured:
stderr(
u'The bot is not configured. -- El bot no está configurado. -- Le bot n\'est pas configuré.'
)
# exit with code 2 to prevent auto restart on fail by systemd
sys.exit(2)
if not config_module.has_option('core', 'homedir'):
config_module.dotdir = homedir
config_module.homedir = homedir
else:
homedir = config_module.core.homedir
config_module.dotdir = config_module.core.homedir
if not config_module.core.logdir:
config_module.core.logdir = os.path.join(homedir, 'logs')
logfile = os.path.os.path.join(config_module.logdir, 'stdio.log')
if not os.path.isdir(config_module.logdir):
os.mkdir(config_module.logdir)
if opts.exit_on_error:
config_module.exit_on_error = True
else:
config_module.exit_on_error = False
if opts.quiet is None:
opts.quiet = False
sys.stderr = tools.OutputRedirect(logfile, True, opts.quiet)
sys.stdout = tools.OutputRedirect(logfile, False, opts.quiet)
#Handle --quit, --kill and saving the PID to file
pid_dir = config_module.core.pid_dir or homedir
if opts.config is None:
pid_file_path = os.path.join(pid_dir, 'sopel.pid')
else:
basename = os.path.basename(opts.config)
if basename.endswith('.cfg'):
basename = basename[:-4]
pid_file_path = os.path.join(pid_dir, 'sopel-%s.pid' % basename)
if os.path.isfile(pid_file_path):
pid_file = open(pid_file_path, 'r')
old_pid = int(pid_file.read())
pid_file.close()
if tools.check_pid(old_pid):
if opts.quit is None and opts.kill is None:
stderr(
u'There is already a JoikervgBot running. -- Ya hay un bot ejecutándose. -- Il y a déjà un bot en fonctionnement.'
)
stderr(u'Try -- Intenta: --quit o --kill')
sys.exit(1)
elif opts.kill:
stderr(
u'Killing JoikervgBot. -- Matando a JoikervgBot. -- Tuent JoikervgBot.'
)
os.kill(old_pid, signal.SIGKILL)
sys.exit(0)
elif opts.quit:
stderr(
u'Quitting JoikervgBot. -- Desconectando a JoikervgBot. -- Déconnectant JoikervgBot.'
)
if hasattr(signal, 'SIGUSR1'):
os.kill(old_pid, signal.SIGUSR1)
else:
os.kill(old_pid, signal.SIGTERM)
sys.exit(0)
elif not tools.check_pid(old_pid) and (opts.kill or opts.quit):
stderr(
u'The bot is not running. -- El bot no se está ejecutando. -- Le bot n\'est pas en fonctionnement.'
)
sys.exit(1)
elif opts.quit is not None or opts.kill is not None:
stderr(
u'The bot is not running. -- El bot no se está ejecutando. -- Le bot n\'est pas en fonctionnement.'
)
sys.exit(1)
if opts.deamonize is not None:
child_pid = os.fork()
if child_pid is not 0:
sys.exit()
pid_file = open(pid_file_path, 'w')
pid_file.write(str(os.getpid()))
pid_file.close()
config_module.pid_file_path = pid_file_path
# Step Five: Initialise And Run sopel
run(config_module)
except KeyboardInterrupt:
print "\n\nKeyboard Interrupt"
os._exit(1)