fix(config): Define all fallback in configuration.default.ini.

This commit is contained in:
Terry Geng 2022-02-01 20:51:39 -05:00
parent 5b632fd88f
commit a0eb5b39c3
8 changed files with 46 additions and 45 deletions

View File

@ -624,7 +624,7 @@ def cmd_help(bot, user, text, command, parameter):
def cmd_stop(bot, user, text, command, parameter): def cmd_stop(bot, user, text, command, parameter):
global log global log
if var.config.getboolean("bot", "clear_when_stop_in_oneshot", fallback=False) \ if var.config.getboolean("bot", "clear_when_stop_in_oneshot") \
and var.playlist.mode == 'one-shot': and var.playlist.mode == 'one-shot':
cmd_clear(bot, user, text, command, parameter) cmd_clear(bot, user, text, command, parameter)
else: else:
@ -1152,7 +1152,7 @@ def cmd_shortlist(bot, user, text, command, parameter):
def cmd_delete_from_library(bot, user, text, command, parameter): def cmd_delete_from_library(bot, user, text, command, parameter):
global song_shortlist, log global song_shortlist, log
if not var.config.getboolean("bot", "delete_allowed", fallback=True): if not var.config.getboolean("bot", "delete_allowed"):
bot.mumble.users[text.actor].send_text_message(tr('not_admin')) bot.mumble.users[text.actor].send_text_message(tr('not_admin'))
return return

View File

@ -49,7 +49,7 @@ language = en_US
logfile = logfile =
max_track_duration = 60 max_track_duration = 60
max_track_playlist = 20 max_track_playlist = 20
music_database_path = music_database_path = music.db
music_folder = music_folder/ music_folder = music_folder/
pip3_path = venv/bin/pip pip3_path = venv/bin/pip
playback_mode = one-shot playback_mode = one-shot
@ -62,9 +62,9 @@ target_version = git
tmp_folder = /tmp/ tmp_folder = /tmp/
tmp_folder_max_size = 10 tmp_folder_max_size = 10
username = botamusique username = botamusique
volume = 0.1 volume = 0.8
when_nobody_in_channel = nothing when_nobody_in_channel = nothing
youtube_query_cookie = youtube_query_cookie = {}
[webinterface] [webinterface]
access_address = http://127.0.0.1:8181 access_address = http://127.0.0.1:8181
@ -84,7 +84,7 @@ web_logfile =
[debug] [debug]
ffmpeg = False ffmpeg = False
mumble_connection = False mumble_connection = False
redirect_ffmpeg_log = True redirect_ffmpeg_log = False
youtube_dl = False youtube_dl = False
[radio] [radio]

View File

@ -163,7 +163,7 @@ def requires_auth(f):
bad_access_count[request.remote_addr] += 1 bad_access_count[request.remote_addr] += 1
log.info(f"web: bad token from ip {request.remote_addr}, " log.info(f"web: bad token from ip {request.remote_addr}, "
f"{bad_access_count[request.remote_addr]} attempts.") f"{bad_access_count[request.remote_addr]} attempts.")
if bad_access_count[request.remote_addr] > var.config.getint("webinterface", "max_attempts", fallback=10): if bad_access_count[request.remote_addr] > var.config.getint("webinterface", "max_attempts"):
banned_ip.append(request.remote_addr) banned_ip.append(request.remote_addr)
log.info(f"web: access banned for {request.remote_addr}") log.info(f"web: access banned for {request.remote_addr}")
else: else:
@ -464,7 +464,7 @@ def post():
var.music_db.manage_special_tags() var.music_db.manage_special_tags()
log.info("web: Local file cache refreshed.") log.info("web: Local file cache refreshed.")
elif action == "stop": elif action == "stop":
if var.config.getboolean("bot", "clear_when_stop_in_oneshot", fallback=False) \ if var.config.getboolean("bot", "clear_when_stop_in_oneshot") \
and var.playlist.mode == 'one-shot': and var.playlist.mode == 'one-shot':
var.bot.clear() var.bot.clear()
else: else:
@ -559,12 +559,12 @@ def library_info():
time.sleep(0.1) time.sleep(0.1)
tags = var.music_db.query_all_tags() tags = var.music_db.query_all_tags()
max_upload_file_size = util.parse_file_size(var.config.get("webinterface", "max_upload_file_size", fallback="30MB")) max_upload_file_size = util.parse_file_size(var.config.get("webinterface", "max_upload_file_size"))
return jsonify(dict( return jsonify(dict(
dirs=get_all_dirs(), dirs=get_all_dirs(),
upload_enabled=var.config.getboolean("webinterface", "upload_enabled", fallback=True) or var.bot.is_admin(user), upload_enabled=var.config.getboolean("webinterface", "upload_enabled") or var.bot.is_admin(user),
delete_allowed=var.config.getboolean("bot", "delete_allowed", fallback=True) or var.bot.is_admin(user), delete_allowed=var.config.getboolean("bot", "delete_allowed") or var.bot.is_admin(user),
tags=tags, tags=tags,
max_upload_file_size=max_upload_file_size max_upload_file_size=max_upload_file_size
)) ))
@ -609,7 +609,7 @@ def library():
return redirect("./", code=302) return redirect("./", code=302)
elif payload['action'] == 'delete': elif payload['action'] == 'delete':
if var.config.getboolean("bot", "delete_allowed", fallback=True): if var.config.getboolean("bot", "delete_allowed"):
items = dicts_to_items(var.music_db.query_music(condition)) items = dicts_to_items(var.music_db.query_music(condition))
for item in items: for item in items:
var.playlist.remove_by_id(item.id) var.playlist.remove_by_id(item.id)
@ -685,7 +685,7 @@ def library():
def upload(): def upload():
global log global log
if not var.config.getboolean("webinterface", "upload_enabled", fallback=True): if not var.config.getboolean("webinterface", "upload_enabled"):
abort(403) abort(403)
file = request.files['file'] file = request.files['file']

View File

@ -396,7 +396,7 @@ class AutoPlaylist(OneshotPlaylist):
self.mode = "autoplay" self.mode = "autoplay"
def refresh(self): def refresh(self):
dicts = var.music_db.query_random_music(var.config.getint("bot", "autoplay_length", fallback=5), dicts = var.music_db.query_random_music(var.config.getint("bot", "autoplay_length"),
Condition().and_not_sub_condition( Condition().and_not_sub_condition(
Condition().and_like('tags', "%don't autoplay,%"))) Condition().and_like('tags', "%don't autoplay,%")))

View File

@ -131,7 +131,7 @@ class URLItem(BaseItem):
} }
succeed = False succeed = False
with youtube_dl.YoutubeDL(ydl_opts) as ydl: with youtube_dl.YoutubeDL(ydl_opts) as ydl:
attempts = var.config.getint('bot', 'download_attempts', fallback=2) attempts = var.config.getint('bot', 'download_attempts')
for i in range(attempts): for i in range(attempts):
try: try:
info = ydl.extract_info(self.url, download=False) info = ydl.extract_info(self.url, download=False)
@ -175,16 +175,16 @@ class URLItem(BaseItem):
}] }]
} }
cookie = var.config.get('youtube_dl', 'cookie_file', fallback=None) cookie = var.config.get('youtube_dl', 'cookie_file')
if cookie: if cookie:
ydl_opts['cookiefile'] = var.config.get('youtube_dl', 'cookie_file', fallback=None) ydl_opts['cookiefile'] = var.config.get('youtube_dl', 'cookie_file')
user_agent = var.config.get('youtube_dl', 'user_agent', fallback=None) user_agent = var.config.get('youtube_dl', 'user_agent')
if user_agent: if user_agent:
youtube_dl.utils.std_headers['User-Agent'] = var.config.get('youtube_dl', 'user_agent') youtube_dl.utils.std_headers['User-Agent'] = var.config.get('youtube_dl', 'user_agent')
with youtube_dl.YoutubeDL(ydl_opts) as ydl: with youtube_dl.YoutubeDL(ydl_opts) as ydl:
attempts = var.config.getint('bot', 'download_attempts', fallback=2) attempts = var.config.getint('bot', 'download_attempts')
download_succeed = False download_succeed = False
for i in range(attempts): for i in range(attempts):
self.log.info("bot: download attempts %d / %d" % (i + 1, attempts)) self.log.info("bot: download attempts %d / %d" % (i + 1, attempts))

View File

@ -15,16 +15,16 @@ def get_playlist_info(url, start_index=0, user=""):
'verbose': var.config.getboolean('debug', 'youtube_dl') 'verbose': var.config.getboolean('debug', 'youtube_dl')
} }
cookie = var.config.get('youtube_dl', 'cookie_file', fallback=None) cookie = var.config.get('youtube_dl', 'cookie_file')
if cookie: if cookie:
ydl_opts['cookiefile'] = var.config.get('youtube_dl', 'cookie_file', fallback=None) ydl_opts['cookiefile'] = var.config.get('youtube_dl', 'cookie_file')
user_agent = var.config.get('youtube_dl', 'user_agent', fallback=None) user_agent = var.config.get('youtube_dl', 'user_agent')
if user_agent: if user_agent:
youtube_dl.utils.std_headers['User-Agent'] = var.config.get('youtube_dl', 'user_agent') youtube_dl.utils.std_headers['User-Agent'] = var.config.get('youtube_dl', 'user_agent')
with youtube_dl.YoutubeDL(ydl_opts) as ydl: with youtube_dl.YoutubeDL(ydl_opts) as ydl:
attempts = var.config.getint('bot', 'download_attempts', fallback=2) attempts = var.config.getint('bot', 'download_attempts')
for i in range(attempts): for i in range(attempts):
items = [] items = []
try: try:

View File

@ -40,12 +40,12 @@ class MumbleBot:
signal.signal(signal.SIGINT, self.ctrl_caught) signal.signal(signal.SIGINT, self.ctrl_caught)
self.cmd_handle = {} self.cmd_handle = {}
self.stereo = var.config.getboolean('bot', 'stereo', fallback=True) self.stereo = var.config.getboolean('bot', 'stereo')
if args.channel: if args.channel:
self.channel = args.channel self.channel = args.channel
else: else:
self.channel = var.config.get("server", "channel", fallback=None) self.channel = var.config.get("server", "channel")
var.user = args.user var.user = args.user
var.is_proxified = var.config.getboolean( var.is_proxified = var.config.getboolean(
@ -137,7 +137,7 @@ class MumbleBot:
# ====== Volume ====== # ====== Volume ======
self.volume_helper = util.VolumeHelper() self.volume_helper = util.VolumeHelper()
_volume = var.config.getfloat('bot', 'volume', fallback=0.8) _volume = var.config.getfloat('bot', 'volume')
if var.db.has_option('bot', 'volume'): if var.db.has_option('bot', 'volume'):
_volume = var.db.getfloat('bot', 'volume') _volume = var.db.getfloat('bot', 'volume')
self.volume_helper.set_volume(_volume) self.volume_helper.set_volume(_volume)
@ -148,14 +148,14 @@ class MumbleBot:
self.last_volume_cycle_time = time.time() self.last_volume_cycle_time = time.time()
self._ducking_volume = 0 self._ducking_volume = 0
_ducking_volume = var.config.getfloat("bot", "ducking_volume", fallback=0.50) _ducking_volume = var.config.getfloat("bot", "ducking_volume")
_ducking_volume = var.db.getfloat("bot", "ducking_volume", fallback=_ducking_volume) _ducking_volume = var.db.getfloat("bot", "ducking_volume", fallback=_ducking_volume)
self.volume_helper.set_ducking_volume(_ducking_volume) self.volume_helper.set_ducking_volume(_ducking_volume)
self.ducking_threshold = var.config.getfloat("bot", "ducking_threshold", fallback=5000) self.ducking_threshold = var.config.getfloat("bot", "ducking_threshold")
self.ducking_threshold = var.db.getfloat("bot", "ducking_threshold", fallback=self.ducking_threshold) self.ducking_threshold = var.db.getfloat("bot", "ducking_threshold", fallback=self.ducking_threshold)
if not var.db.has_option("bot", "ducking") and var.config.getboolean("bot", "ducking", fallback=False) \ if not var.db.has_option("bot", "ducking") and var.config.getboolean("bot", "ducking") \
or var.config.getboolean("bot", "ducking"): or var.config.getboolean("bot", "ducking"):
self.is_ducking = True self.is_ducking = True
self.mumble.callbacks.set_callback(pymumble.constants.PYMUMBLE_CLBK_SOUNDRECEIVED, self.mumble.callbacks.set_callback(pymumble.constants.PYMUMBLE_CLBK_SOUNDRECEIVED,
@ -165,7 +165,7 @@ class MumbleBot:
assert var.config.get("bot", "when_nobody_in_channel") in ['pause', 'pause_resume', 'stop', 'nothing', ''], \ assert var.config.get("bot", "when_nobody_in_channel") in ['pause', 'pause_resume', 'stop', 'nothing', ''], \
"Unknown action for when_nobody_in_channel" "Unknown action for when_nobody_in_channel"
if var.config.get("bot", "when_nobody_in_channel", fallback='') in ['pause', 'pause_resume', 'stop']: if var.config.get("bot", "when_nobody_in_channel") in ['pause', 'pause_resume', 'stop']:
user_change_callback = \ user_change_callback = \
lambda user, action: threading.Thread(target=self.users_changed, lambda user, action: threading.Thread(target=self.users_changed,
args=(user, action), daemon=True).start() args=(user, action), daemon=True).start()
@ -177,7 +177,7 @@ class MumbleBot:
self._display_rms = False self._display_rms = False
self._max_rms = 0 self._max_rms = 0
self.redirect_ffmpeg_log = var.config.getboolean('debug', 'redirect_ffmpeg_log', fallback=True) self.redirect_ffmpeg_log = var.config.getboolean('debug', 'redirect_ffmpeg_log')
if var.config.getboolean("bot", "auto_check_update"): if var.config.getboolean("bot", "auto_check_update"):
def check_update(): def check_update():
@ -202,8 +202,8 @@ class MumbleBot:
self.log.info( self.log.info(
"\nSIGINT caught, quitting, {} more to kill".format(2 - self.nb_exit)) "\nSIGINT caught, quitting, {} more to kill".format(2 - self.nb_exit))
if var.config.getboolean('bot', 'save_playlist', fallback=True) \ if var.config.getboolean('bot', 'save_playlist') \
and var.config.get("bot", "save_music_library", fallback=True): and var.config.get("bot", "save_music_library"):
self.log.info("bot: save playlist into database") self.log.info("bot: save playlist into database")
var.playlist.save() var.playlist.save()
@ -235,7 +235,7 @@ class MumbleBot:
self.mumble.users.myself.comment(var.config.get('bot', 'comment')) self.mumble.users.myself.comment(var.config.get('bot', 'comment'))
def set_avatar(self): def set_avatar(self):
avatar_path = var.config.get('bot', 'avatar', fallback=None) avatar_path = var.config.get('bot', 'avatar')
if avatar_path: if avatar_path:
with open(avatar_path, 'rb') as avatar_file: with open(avatar_path, 'rb') as avatar_file:
@ -598,8 +598,8 @@ class MumbleBot:
if self.exit: if self.exit:
self._loop_status = "exited" self._loop_status = "exited"
if var.config.getboolean('bot', 'save_playlist', fallback=True) \ if var.config.getboolean('bot', 'save_playlist') \
and var.config.get("bot", "save_music_library", fallback=True): and var.config.get("bot", "save_music_library"):
self.log.info("bot: save playlist into database") self.log.info("bot: save playlist into database")
var.playlist.save() var.playlist.save()
@ -841,7 +841,7 @@ if __name__ == '__main__':
if logfile: if logfile:
print(f"Redirecting stdout and stderr to log file: {logfile}") print(f"Redirecting stdout and stderr to log file: {logfile}")
handler = logging.handlers.RotatingFileHandler(logfile, mode='a', maxBytes=10240, backupCount=3) # Rotate after 10KB, leave 3 old logs handler = logging.handlers.RotatingFileHandler(logfile, mode='a', maxBytes=10240, backupCount=3) # Rotate after 10KB, leave 3 old logs
if var.config.getboolean("bot", "redirect_stderr", fallback=False): if var.config.getboolean("bot", "redirect_stderr"):
sys.stderr = util.LoggerIOWrapper(bot_logger, logging.INFO, sys.stderr = util.LoggerIOWrapper(bot_logger, logging.INFO,
fallback_io_buffer=sys.stderr.buffer) fallback_io_buffer=sys.stderr.buffer)
else: else:
@ -862,13 +862,13 @@ if __name__ == '__main__':
sanitized_username = "".join([x if x.isalnum() else "_" for x in username]) sanitized_username = "".join([x if x.isalnum() else "_" for x in username])
var.settings_db_path = args.db if args.db is not None else util.solve_filepath( var.settings_db_path = args.db if args.db is not None else util.solve_filepath(
config.get("bot", "database_path", fallback="") or f"settings-{sanitized_username}.db") config.get("bot", "database_path") or f"settings-{sanitized_username}.db")
var.music_db_path = args.music_db if args.music_db is not None else util.solve_filepath( var.music_db_path = args.music_db if args.music_db is not None else util.solve_filepath(
config.get("bot", "music_database_path", fallback="") or "music.db") config.get("bot", "music_database_path"))
var.db = SettingsDatabase(var.settings_db_path) var.db = SettingsDatabase(var.settings_db_path)
if var.config.get("bot", "save_music_library", fallback=True): if var.config.get("bot", "save_music_library"):
var.music_db = MusicDatabase(var.music_db_path) var.music_db = MusicDatabase(var.music_db_path)
else: else:
var.music_db = MusicDatabase(":memory:") var.music_db = MusicDatabase(":memory:")
@ -889,7 +889,7 @@ if __name__ == '__main__':
if args.lang: if args.lang:
lang = args.lang lang = args.lang
else: else:
lang = var.config.get('bot', 'language', fallback='en_US') lang = var.config.get('bot', 'language')
if lang not in supported_languages: if lang not in supported_languages:
raise KeyError(f"Unsupported language {lang}") raise KeyError(f"Unsupported language {lang}")
@ -901,7 +901,7 @@ if __name__ == '__main__':
# ====================== # ======================
var.cache = MusicCache(var.music_db) var.cache = MusicCache(var.music_db)
if var.config.getboolean("bot", "refresh_cache_on_startup", fallback=True): if var.config.getboolean("bot", "refresh_cache_on_startup"):
var.cache.build_dir_cache() var.cache.build_dir_cache()
# ====================== # ======================
@ -911,7 +911,7 @@ if __name__ == '__main__':
if var.db.has_option("playlist", "playback_mode"): if var.db.has_option("playlist", "playback_mode"):
playback_mode = var.db.get('playlist', 'playback_mode') playback_mode = var.db.get('playlist', 'playback_mode')
else: else:
playback_mode = var.config.get('bot', 'playback_mode', fallback="one-shot") playback_mode = var.config.get('bot', 'playback_mode')
if playback_mode in ["one-shot", "repeat", "random", "autoplay"]: if playback_mode in ["one-shot", "repeat", "random", "autoplay"]:
var.playlist = media.playlist.get_playlist(playback_mode) var.playlist = media.playlist.get_playlist(playback_mode)
@ -925,7 +925,7 @@ if __name__ == '__main__':
command.register_all_commands(var.bot) command.register_all_commands(var.bot)
# load playlist # load playlist
if var.config.getboolean('bot', 'save_playlist', fallback=True): if var.config.getboolean('bot', 'save_playlist'):
var.bot_logger.info("bot: load playlist from previous session") var.bot_logger.info("bot: load playlist from previous session")
var.playlist.load() var.playlist.load()

View File

@ -323,7 +323,8 @@ def youtube_search(query):
import json import json
try: try:
cookie = json.loads(var.config.get('bot', 'youtube_query_cookie', fallback='{}')) cookie_json = var.config.get('bot', 'youtube_query_cookie')
cookie = json.loads(cookie_json if cookie_json else '{}')
r = requests.get("https://www.youtube.com/results", cookies=cookie, r = requests.get("https://www.youtube.com/results", cookies=cookie,
params={'search_query': query}, timeout=5) params={'search_query': query}, timeout=5)
result_json_match = re.findall(r">var ytInitialData = (.*?);</script>", r.text) result_json_match = re.findall(r">var ytInitialData = (.*?);</script>", r.text)