forked from Archives/searxng
[enh] settings.yml: add use_default_settings option
This change is backward compatible with the existing configurations. If a settings.yml loaded from an user defined location (SEARX_SETTINGS_PATH or /etc/searx/settings.yml), then this settings can relied on the default settings.yml with this option: user_default_settings:Truedependabot/pip/master/sphinx-6.1.3
parent
6ada5bac60
commit
1cfe7f2a75
@ -0,0 +1,91 @@
|
|||||||
|
import collections.abc
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
from searx.exceptions import SearxSettingsException
|
||||||
|
from os import environ
|
||||||
|
from os.path import dirname, join, abspath, isfile
|
||||||
|
|
||||||
|
|
||||||
|
searx_dir = abspath(dirname(__file__))
|
||||||
|
|
||||||
|
|
||||||
|
def check_settings_yml(file_name):
|
||||||
|
if isfile(file_name):
|
||||||
|
return file_name
|
||||||
|
else:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def load_yaml(file_name):
|
||||||
|
try:
|
||||||
|
with open(file_name, 'r', encoding='utf-8') as settings_yaml:
|
||||||
|
settings = yaml.safe_load(settings_yaml)
|
||||||
|
if not isinstance(settings, dict) or len(settings) == 0:
|
||||||
|
raise SearxSettingsException('Empty file', file_name)
|
||||||
|
return settings
|
||||||
|
except IOError as e:
|
||||||
|
raise SearxSettingsException(e, file_name)
|
||||||
|
except yaml.YAMLError as e:
|
||||||
|
raise SearxSettingsException(e, file_name)
|
||||||
|
|
||||||
|
|
||||||
|
def get_default_settings_path():
|
||||||
|
return check_settings_yml(join(searx_dir, 'settings.yml'))
|
||||||
|
|
||||||
|
|
||||||
|
def get_user_settings_path():
|
||||||
|
# find location of settings.yml
|
||||||
|
if 'SEARX_SETTINGS_PATH' in environ:
|
||||||
|
# if possible set path to settings using the
|
||||||
|
# enviroment variable SEARX_SETTINGS_PATH
|
||||||
|
return check_settings_yml(environ['SEARX_SETTINGS_PATH'])
|
||||||
|
else:
|
||||||
|
# if not, get it from searx code base or last solution from /etc/searx
|
||||||
|
return check_settings_yml('/etc/searx/settings.yml')
|
||||||
|
|
||||||
|
|
||||||
|
def update_dict(d, u):
|
||||||
|
for k, v in u.items():
|
||||||
|
if isinstance(v, collections.abc.Mapping):
|
||||||
|
d[k] = update_dict(d.get(k, {}), v)
|
||||||
|
else:
|
||||||
|
d[k] = v
|
||||||
|
return d
|
||||||
|
|
||||||
|
|
||||||
|
def update_settings(default_settings, user_settings):
|
||||||
|
for k, v in user_settings.items():
|
||||||
|
if k == 'use_default_settings':
|
||||||
|
continue
|
||||||
|
elif k == 'engines':
|
||||||
|
default_engines = default_settings[k]
|
||||||
|
default_engines_dict = dict((definition['name'], definition) for definition in default_engines)
|
||||||
|
default_settings[k] = [update_dict(default_engines_dict[definition['name']], definition)
|
||||||
|
for definition in v]
|
||||||
|
else:
|
||||||
|
update_dict(default_settings[k], v)
|
||||||
|
|
||||||
|
return default_settings
|
||||||
|
|
||||||
|
|
||||||
|
def load_settings(load_user_setttings=True):
|
||||||
|
default_settings_path = get_default_settings_path()
|
||||||
|
user_settings_path = get_user_settings_path()
|
||||||
|
if user_settings_path is None or not load_user_setttings:
|
||||||
|
# no user settings
|
||||||
|
return (load_yaml(default_settings_path),
|
||||||
|
'load the default settings from {}'.format(default_settings_path))
|
||||||
|
|
||||||
|
# user settings
|
||||||
|
user_settings = load_yaml(user_settings_path)
|
||||||
|
if user_settings.get('use_default_settings'):
|
||||||
|
# the user settings are merged with the default configuration
|
||||||
|
default_settings = load_yaml(default_settings_path)
|
||||||
|
update_settings(default_settings, user_settings)
|
||||||
|
return (default_settings,
|
||||||
|
'merge the default settings ( {} ) and the user setttings ( {} )'
|
||||||
|
.format(default_settings_path, user_settings_path))
|
||||||
|
|
||||||
|
# the user settings, fully replace the default configuration
|
||||||
|
return (user_settings,
|
||||||
|
'load the user settings from {}'.format(user_settings_path))
|
@ -0,0 +1,98 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
# set path
|
||||||
|
from sys import path
|
||||||
|
from os.path import realpath, dirname, join
|
||||||
|
path.append(realpath(dirname(realpath(__file__)) + '/../'))
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
import string
|
||||||
|
import ruamel.yaml
|
||||||
|
import secrets
|
||||||
|
import collections
|
||||||
|
from ruamel.yaml.scalarstring import SingleQuotedScalarString, DoubleQuotedScalarString
|
||||||
|
from searx.settings import load_settings, check_settings_yml, get_default_settings_path
|
||||||
|
from searx.exceptions import SearxSettingsException
|
||||||
|
|
||||||
|
|
||||||
|
RANDOM_STRING_LETTERS = string.ascii_lowercase + string.digits + string.ascii_uppercase
|
||||||
|
|
||||||
|
|
||||||
|
def get_random_string():
|
||||||
|
r = [secrets.choice(RANDOM_STRING_LETTERS) for _ in range(64)]
|
||||||
|
return ''.join(r)
|
||||||
|
|
||||||
|
|
||||||
|
def main(prog_arg):
|
||||||
|
yaml = ruamel.yaml.YAML()
|
||||||
|
yaml.preserve_quotes = True
|
||||||
|
yaml.indent(mapping=4, sequence=1, offset=2)
|
||||||
|
user_settings_path = prog_args.get('user-settings-yaml')
|
||||||
|
|
||||||
|
try:
|
||||||
|
default_settings, _ = load_settings(False)
|
||||||
|
if check_settings_yml(user_settings_path):
|
||||||
|
with open(user_settings_path, 'r', encoding='utf-8') as f:
|
||||||
|
user_settings = yaml.load(f.read())
|
||||||
|
new_user_settings = False
|
||||||
|
else:
|
||||||
|
user_settings = yaml.load('use_default_settings: True')
|
||||||
|
new_user_settings = True
|
||||||
|
except SearxSettingsException as e:
|
||||||
|
sys.stderr.write(str(e))
|
||||||
|
return
|
||||||
|
|
||||||
|
if not new_user_settings and not user_settings.get('use_default_settings'):
|
||||||
|
sys.stderr.write('settings.yml already exists and use_default_settings is not True')
|
||||||
|
return
|
||||||
|
|
||||||
|
user_settings['use_default_settings'] = True
|
||||||
|
use_default_settings_comment = "settings based on " + get_default_settings_path()
|
||||||
|
user_settings.yaml_add_eol_comment(use_default_settings_comment, 'use_default_settings')
|
||||||
|
|
||||||
|
if user_settings.get('server', {}).get('secret_key') in [None, 'ultrasecretkey']:
|
||||||
|
user_settings.setdefault('server', {})['secret_key'] = DoubleQuotedScalarString(get_random_string())
|
||||||
|
|
||||||
|
user_engines = user_settings.get('engines')
|
||||||
|
if user_engines:
|
||||||
|
has_user_engines = True
|
||||||
|
user_engines_dict = dict((definition['name'], definition) for definition in user_engines)
|
||||||
|
else:
|
||||||
|
has_user_engines = False
|
||||||
|
user_engines_dict = {}
|
||||||
|
user_engines = []
|
||||||
|
|
||||||
|
# remove old engines
|
||||||
|
if prog_arg.get('add-engines') or has_user_engines:
|
||||||
|
default_engines_dict = dict((definition['name'], definition) for definition in default_settings['engines'])
|
||||||
|
for i, engine in enumerate(user_engines):
|
||||||
|
if engine['name'] not in default_engines_dict:
|
||||||
|
del user_engines[i]
|
||||||
|
|
||||||
|
# add new engines
|
||||||
|
if prog_arg.get('add-engines'):
|
||||||
|
for engine in default_settings.get('engines', {}):
|
||||||
|
if engine['name'] not in user_engines_dict:
|
||||||
|
user_engines.append({'name': engine['name']})
|
||||||
|
user_settings['engines'] = user_engines
|
||||||
|
|
||||||
|
# output
|
||||||
|
if prog_arg.get('dry-run'):
|
||||||
|
yaml.dump(user_settings, sys.stdout)
|
||||||
|
else:
|
||||||
|
with open(user_settings_path, 'w', encoding='utf-8') as f:
|
||||||
|
yaml.dump(user_settings, f)
|
||||||
|
|
||||||
|
|
||||||
|
def parse_args():
|
||||||
|
parser = argparse.ArgumentParser(description='Update user settings.yml')
|
||||||
|
parser.add_argument('--add-engines', dest='add-engines', default=False, action='store_true', help='Add new engines')
|
||||||
|
parser.add_argument('--dry-run', dest='dry-run', default=False, action='store_true', help='Dry run')
|
||||||
|
parser.add_argument('user-settings-yaml', type=str)
|
||||||
|
return vars(parser.parse_args())
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
prog_args = parse_args()
|
||||||
|
main(prog_args)
|
Loading…
Reference in New Issue