-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
run.py
1114 lines (958 loc) · 38.7 KB
/
run.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
import argparse
import asyncio
import importlib.util
import json
import logging
import os
import pathlib
import shutil
import signal
import ssl
import subprocess
import sys
import textwrap
import time
from base64 import b64decode
from typing import Any, Callable, Coroutine, Dict, List, Optional, Tuple, Union
from musicbot.constants import (
DEFAULT_LOGS_KEPT,
DEFAULT_LOGS_ROTATE_FORMAT,
MAXIMUM_LOGS_LIMIT,
)
from musicbot.constants import VERSION as BOTVERSION
from musicbot.exceptions import (
HelpfulError,
RestartCode,
RestartSignal,
TerminateSignal,
)
from musicbot.utils import (
rotate_log_files,
set_logging_level,
set_logging_max_kept_logs,
set_logging_rotate_date_format,
setup_loggers,
shutdown_loggers,
)
# protect dependency import from stopping the launcher
try:
from aiohttp.client_exceptions import ClientConnectorCertificateError
except ImportError:
pass
log = logging.getLogger("musicbot.launcher")
class GIT:
@classmethod
def works(cls, raise_instead: bool = False) -> bool:
"""
Checks for output from git --version to verify git can be run.
:param: raise_instead: Return True on success but raise Runtime error otherwise.
:raises: RuntimeError if `raise_instead` is set True.
"""
try:
git_bin = shutil.which("git")
if not git_bin:
if raise_instead:
raise RuntimeError(
"Cannot locate `git` executable in environment path."
)
return False
return bool(subprocess.check_output([git_bin, "--version"]))
except (
OSError,
ValueError,
PermissionError,
FileNotFoundError,
subprocess.CalledProcessError,
) as e:
if raise_instead:
raise RuntimeError(
f"Cannot execute `git` commands due to an error: {str(e)}"
) from e
return False
@classmethod
def show_branch(cls) -> str:
"""
Runs `git rev-parse --abbrev-ref HEAD` to get the current branch name.
Will return an empty string if running the command fails.
"""
try:
git_bin = shutil.which("git")
if not git_bin:
log.warning("Could not find git executable.")
return ""
gitbytes = subprocess.check_output(
[git_bin, "rev-parse", "--abbrev-ref", "HEAD"],
stderr=subprocess.STDOUT,
)
branch = gitbytes.decode("utf8").strip()
return branch
except (OSError, ValueError, subprocess.CalledProcessError):
return ""
@classmethod
def check_updates(cls) -> Tuple[str, str]:
"""
Runs `git fetch --dry-run` and extracts the commit IDs.
If the command fails or no commit IDs are found, this
will return empty strings rather than raise errors.
"""
branch = cls.show_branch()
if not branch:
return ("", "")
try:
commit_at = ""
commit_to = ""
git_bin = shutil.which("git")
if not git_bin:
return ("", "")
gitbytes = subprocess.check_output([git_bin, "fetch", "--dry-run"])
lines = gitbytes.decode("utf8").split("\n")
for line in lines:
parts = line.split()
if branch in parts:
commits = line.strip().split(" ", maxsplit=1)[0]
commit_at, commit_to = commits.split("..")
break
return (commit_at, commit_to)
except (OSError, ValueError, subprocess.CalledProcessError):
return ("", "")
@classmethod
def run_upgrade_pull(cls) -> None:
"""Runs `git pull` in the current working directory."""
cls.works(raise_instead=True)
log.info("Attempting to upgrade with `git pull` on current path.")
try:
git_bin = shutil.which("git")
if not git_bin:
raise FileNotFoundError("Could not locate `git` executable on path.")
raw_data = subprocess.check_output([git_bin, "pull"])
git_data = raw_data.decode("utf8").strip()
log.info("Result of git pull: %s", git_data)
except (
OSError,
UnicodeError,
PermissionError,
FileNotFoundError,
subprocess.CalledProcessError,
):
log.exception("Upgrade failed, you need to run `git pull` manually.")
class PIP:
@classmethod
def run(cls, command: str, check_output: bool = False) -> Union[bytes, int]:
"""Runs a pip command using `sys.exectutable -m pip` through subprocess.
Given `command` is split before it is passed, so quoted items will not work.
"""
if not cls.works():
raise RuntimeError("Cannot execute pip.")
try:
return cls.run_python_m(command.split(), check_output=check_output)
except subprocess.CalledProcessError as e:
return e.returncode
except (OSError, PermissionError, FileNotFoundError):
log.exception("Error using -m method")
return 0
@classmethod
def run_python_m(
cls, args: List[str], check_output: bool = False, quiet: bool = True
) -> Union[bytes, int]:
"""
Use subprocess check_call or check_output to run a pip module
command using the `args` as additional arguments to pip.
The returned value of the call is returned from this method.
:param: check_output: Use check_output rather than check_call.
"""
cmd_args = [sys.executable, "-m", "pip"] + args
if check_output:
if quiet:
return subprocess.check_output(cmd_args, stderr=subprocess.DEVNULL)
return subprocess.check_output(cmd_args)
if quiet:
return subprocess.check_call(cmd_args, stdout=subprocess.DEVNULL)
return subprocess.check_call(cmd_args)
@classmethod
def run_install(
cls, cmd: str, quiet: bool = False, check_output: bool = False
) -> Union[bytes, int]:
"""
Runs pip install command and returns the command exist status.
:param: cmd: a string of arguments passed to `pip install`.
:param: quiet: attempt to silence output using -q command flag.
:param: check_output: return command output instead of exit code.
"""
q_flag = "-q " if quiet else ""
return cls.run(f"install {q_flag}{cmd}", check_output)
@classmethod
def works(cls) -> bool:
"""Checks for output from pip --version to verify pip can be run."""
try:
rcode = cls.run_python_m(["--version"])
if rcode == 0:
return True
return False
except subprocess.CalledProcessError:
log.exception("PIP failed while calling sub-process.")
return False
except PermissionError:
log.exception("PIP failed due to Permissions Error.")
return False
except FileNotFoundError:
log.exception(
"PIP failed due to missing Python executable? (%s)",
sys.executable,
)
return False
except OSError:
log.exception("PIP failed due to OSError.")
return False
@classmethod
def check_updates(cls) -> List[Dict[str, Any]]:
"""
Runs `pip install -U -r ./requirements.txt --quiet --dry-run --report -`
and returns the number of packages that could be updated.
"""
updata = cls.run_install(
"-U -r ./requirements.txt --quiet --dry-run --report -",
check_output=True,
)
try:
if isinstance(updata, bytes):
pip_data = json.loads(updata)
ilist = pip_data.get("install", [])
if not isinstance(ilist, list):
return []
return ilist
except json.JSONDecodeError:
log.warning("Could not decode pip update report JSON.")
return []
@classmethod
def run_upgrade_requirements(
cls,
get_output: bool = False,
quiet: bool = True,
) -> Union[str, int]:
"""
Uses a subprocess call to run python using sys.executable.
Runs `pip install --no-warn-script-location --no-input -U -r ./requirements.txt`
This method attempts to catch all exceptions and ensure a return value.
:param: get_output: Return the process output rather than its exit code.
If set True, and an exception is caught, this will return the string "[[ProcessException]]"
If set False and an exception is caught, this will return int -255
:returns: process exit code, where 0 is assumed success.
"""
if not cls.works():
raise RuntimeError("Cannot locate or execute python -m pip")
log.info(
"Attempting to upgrade with `pip install --upgrade -r requirements.txt` on current path..."
)
try:
raw_data = cls.run_python_m(
[
"install",
"--no-warn-script-location",
"--no-input",
"-U",
"-r",
"requirements.txt",
],
check_output=get_output,
quiet=quiet,
)
if isinstance(raw_data, bytes):
pip_data = raw_data.decode("utf8").strip()
log.info("Result of pip upgrade:\n%s", pip_data)
if get_output:
return pip_data
if isinstance(raw_data, int):
log.info("Result exit code from pip upgrade: %s", raw_data)
return raw_data
# if somehow raw_data is not int or bytes.
if get_output:
return "[[OutputTypeException]]"
return -255
except (
PermissionError,
FileNotFoundError,
OSError,
UnicodeError,
subprocess.CalledProcessError,
):
log.exception(
"Upgrade failed to execute or we could not understand the output"
)
log.warning(
"You may need to run `pip install --upgrade -r requirements.txt` manually."
)
if get_output:
return "[[ProcessException]]"
return -255
def bugger_off(msg: str = "Press enter to continue . . .", code: int = 1) -> None:
"""Make the console wait for the user to press enter/return."""
input(msg)
sys.exit(code)
def sanity_checks(args: argparse.Namespace) -> None:
"""
Run a collection of pre-startup checks to either automatically correct
issues or inform the user of how to correct them.
:param: optional: Toggle optional start up checks.
"""
log.info("Starting sanity checks")
"""Required Checks"""
# Make sure we're on Python 3.8+
req_ensure_py3()
# Make sure we're in a writable env
req_ensure_env()
# Make our folders if needed
pathlib.Path("data").mkdir(exist_ok=True)
# For rewrite only
req_check_deps()
log.info("Required checks passed.")
"""Optional Checks"""
if not args.do_start_checks:
return
# Check disk usage
opt_check_disk_space()
# Display an update check, if enabled.
if not args.no_update_check:
opt_check_updates()
else:
log.info("Skipped checking for updates.")
log.info("Optional checks passed.")
def req_ensure_py3() -> None:
"""
Verify the current running version of Python and attempt to find a
suitable minimum version in the system if the running version is too old.
"""
log.info("Checking for Python 3.8+")
if sys.version_info < (3, 8):
log.warning(
"Python 3.8+ is required. This version is %s", sys.version.split()[0]
)
log.warning("Attempting to locate Python 3.8...")
# Should we look for other versions than min-ver?
pycom = None
if sys.platform.startswith("win"):
pycom = shutil.which("py.exe")
if not pycom:
log.warning("Could not locate py.exe")
try:
subprocess.check_output([pycom, "-3.8", '-c "exit()"'])
pycom = f"{pycom} -3.8"
except (
OSError,
PermissionError,
FileNotFoundError,
subprocess.CalledProcessError,
):
log.warning("Could not execute `py.exe -3.8` ")
pycom = None
if pycom:
log.info("Python 3 found. Launching bot...")
os.system(f"start cmd /k {pycom} run.py")
sys.exit(0)
else:
log.info('Trying "python3.8"')
pycom = shutil.which("python3.8")
if not pycom:
log.warning("Could not locate python3.8 on path.")
try:
subprocess.check_output([pycom, '-c "exit()"'])
except (
OSError,
PermissionError,
FileNotFoundError,
subprocess.CalledProcessError,
):
pycom = None
if pycom:
log.info(
"\nPython 3.8 found. Re-launching bot using: %s run.py\n", pycom
)
os.execlp(pycom, pycom, "run.py")
log.critical(
"Could not find Python 3.8 or higher. Please run the bot using Python 3.8"
)
bugger_off()
else:
log.info("Python version: %s", sys.version)
def req_check_deps() -> None:
"""
Check that we have the required dependency modules at the right versions.
"""
try:
import discord # pylint: disable=import-outside-toplevel
if discord.version_info.major < 2:
log.critical(
"This version of MusicBot requires a newer version of discord.py. "
"Your version is %s. Try running update.py.",
discord.__version__,
)
bugger_off()
except ImportError:
# if we can't import discord.py, an error will be thrown later down the line anyway
pass
except AttributeError:
# if the user has a library like dpytest installed but discord.py is missing somehow.
pass
def req_ensure_env() -> None:
"""
Inspect the environment variables, validating and updating values where needed.
"""
log.info("Ensuring we're in the right environment")
if os.environ.get("APP_ENV") != "docker" and not os.path.isdir(
b64decode("LmdpdA==").decode("utf-8")
):
log.critical(
b64decode(
"Qm90IHdhc24ndCBpbnN0YWxsZWQgdXNpbmcgR2l0LiBSZWluc3RhbGwgdXNpbmcgaHR0cDovL2JpdC5seS9tdXNpY2JvdGRvY3Mu"
).decode("utf-8")
)
bugger_off()
try:
if not os.path.isdir("config"):
raise RuntimeError('folder "config" not found')
if not os.path.isdir("musicbot"):
raise RuntimeError('folder "musicbot" not found')
if not os.path.isfile("musicbot/__init__.py"):
raise RuntimeError("musicbot folder is not a Python module")
if not importlib.util.find_spec("musicbot"):
raise RuntimeError("musicbot module is not importable")
except RuntimeError as e:
log.critical("Failed environment check, %s", e)
bugger_off()
try:
os.mkdir("musicbot-test-folder")
except (
OSError,
FileExistsError,
PermissionError,
IsADirectoryError,
):
log.critical("Current working directory does not seem to be writable")
log.critical("Please move the bot to a folder that is writable")
bugger_off()
finally:
shutil.rmtree("musicbot-test-folder", True)
if sys.platform.startswith("win"):
# TODO: this should probably be conditional, in favor of system installed exe.
log.info("Adding local bins/ folder to path")
os.environ["PATH"] += ";" + os.path.abspath("bin/")
sys.path.append(os.path.abspath("bin/")) # might as well
def opt_check_disk_space(warnlimit_mb: int = 200) -> None:
"""
Performs and optional check of system disk storage space to warn the
user if the bot might gobble that remaining space with downloads later.
"""
if shutil.disk_usage(".").free < warnlimit_mb * 1024 * 2:
log.warning(
"Less than %sMB of free space remains on this device",
warnlimit_mb,
)
def opt_check_updates() -> None:
"""
Runs a collection of git and pip commands and logs if updates are available.
"""
log.info("\nChecking for updates to MusicBot or dependencies...")
needs_update = False
if GIT.works():
git_branch = GIT.show_branch()
commit_at, commit_to = GIT.check_updates()
if commit_at and commit_to:
log.warning(
"MusicBot updates are available through `git` command.\n"
"Your current branch is: %s\n"
"The latest commit ID is: %s",
git_branch,
commit_to,
)
needs_update = True
else:
log.info("No MusicBot updates available via `git` command.")
else:
log.warning(
"Could not check for updates using `git` commands. You should check manually."
)
if PIP.works():
install_pkgs = PIP.check_updates()
package_count = len(install_pkgs)
if package_count:
pkg_list = "The following packages can be updated:\n"
for pkg in install_pkgs:
pkg_meta = pkg.get("metadata", {})
pkg_name = pkg_meta.get("name", "")
pkg_ver = pkg_meta.get("version", "")
if pkg_name:
pkg_list += f" {pkg_name} to version: {pkg_ver}\n"
log.warning(
"There may be updates for dependency packages. "
"PIP reports %s package(s) could be installed.\n%s",
package_count,
pkg_list,
)
needs_update = True
else:
log.info("No dependency updates available via `pip` command.")
else:
log.warning(
"Could not check for updates using `pip` commands. You should check manually."
)
if needs_update:
log.info(
"You can run a guided update by using the command:\n %s ./update.py",
sys.executable,
)
def parse_cli_args() -> argparse.Namespace:
"""
Parse command line arguments and do reasonable checks and assignments.
:returns: Command line arguments parsed via argparse.
"""
# define a few custom arg validators.
def kept_logs_int(value: str) -> int:
"""Validator for log rotation limits."""
try:
val = int(value)
if val > MAXIMUM_LOGS_LIMIT:
raise ValueError("Value is above the maximum limit.")
if val <= -1:
raise ValueError("Value must not be negative.")
return val
except (TypeError, ValueError) as e:
raise argparse.ArgumentTypeError(
f"Value for Max Logs Kept must be a number from 0 to {MAXIMUM_LOGS_LIMIT}",
) from e
def log_levels_int(level_name: str) -> int:
"""Validator for log level name to existing level int."""
level_name = level_name.upper()
try:
val = getattr(logging, level_name, None)
if not isinstance(val, int):
raise TypeError(f"Log level '{level_name}' is not available.")
return val
except (TypeError, ValueError) as e:
raise argparse.ArgumentTypeError(
"Log Level must be one of: CRITICAL, ERROR, WARNING, INFO, DEBUG, "
"VOICEDEBUG, FFMPEG, NOISY, or EVERYTHING",
) from e
ap = argparse.ArgumentParser(
formatter_class=argparse.RawDescriptionHelpFormatter,
description=textwrap.dedent(
"""\
Launch a music playing discord bot built using discord.py, youtubeDL, and ffmpeg.
Available via Github:
https://github.com/Just-Some-Bots/MusicBot
"""
),
epilog=textwrap.dedent(
"""\
For more help and support with this bot, join our discord:
https://discord.gg/bots
This software is provided under the MIT License.
See the `LICENSE` text file for complete details.
"""
),
)
# Show Version and exit option.
ap.add_argument(
"-V",
"--version",
dest="show_version",
action="store_true",
help="Print the MusicBot version information and exit.",
)
# No Startup Checks option.
ap.add_argument(
"--no-checks",
dest="do_start_checks",
action="store_false",
help="Skip all optional startup checks, including the update check.",
)
# Skip disk checks option.
ap.add_argument(
"--no-disk-check",
dest="no_disk_check",
action="store_true",
help="Skip only the disk space check at startup.",
)
# Skip update checks option.
ap.add_argument(
"--no-update-check",
dest="no_update_check",
action="store_true",
help="Skip only the update check at startup.",
)
# Disable dependency install on error option.
ap.add_argument(
"--no-install-deps",
dest="no_install_deps",
action="store_true",
help="Disable MusicBot from trying to install dependencies when it cannot import them.",
)
# Log related options.
ap.add_argument(
"--logs-kept",
dest="keep_n_logs",
default=DEFAULT_LOGS_KEPT,
type=kept_logs_int,
help=f"Specify how many log files to keep, between 0 and {MAXIMUM_LOGS_LIMIT} inclusive."
f" (Default: {DEFAULT_LOGS_KEPT})",
)
ap.add_argument(
"--log-level",
dest="log_level",
default="NOTSET",
type=log_levels_int,
help="Override the log level settings set in config. Must be one of: "
"CRITICAL, ERROR, WARNING, INFO, DEBUG, VOICEDEBUG, FFMPEG, "
"NOISY, or EVERYTHING (Default: NOTSET)",
)
ap.add_argument(
"--log-rotate-fmt",
dest="old_log_fmt",
default=DEFAULT_LOGS_ROTATE_FORMAT,
type=str,
help="Override the default date format used when rotating log files. "
"This should contain values compatible with strftime(). "
f"(Default: '{DEFAULT_LOGS_ROTATE_FORMAT.replace('%', '%%')}')",
)
# TODO: maybe more arguments for other things:
# --config-dir force this directory for config data (all files)
# --config-file load config from this file, but default for other configs.
args = ap.parse_args()
# Show version and exit.
if args.show_version:
print(f"Just-Some-Bots/MusicBot\nVersion: {BOTVERSION}\n")
sys.exit(0)
if -1 < args.keep_n_logs <= MAXIMUM_LOGS_LIMIT:
set_logging_max_kept_logs(args.keep_n_logs)
if args.log_level != logging.NOTSET:
set_logging_level(args.log_level, override=True)
if args.old_log_fmt != DEFAULT_LOGS_ROTATE_FORMAT:
set_logging_rotate_date_format(args.old_log_fmt)
return args
def setup_signal_handlers(
loop: asyncio.AbstractEventLoop,
callback: Callable[
[signal.Signals, asyncio.AbstractEventLoop], Coroutine[Any, Any, None]
],
) -> None:
"""
This function registers signal handlers with the event loop to help it close
with more grace when various OS signals are sent to this process.
"""
if os.name == "nt":
return
def handle_signal(sig: signal.Signals, loop: asyncio.AbstractEventLoop) -> None:
"""Creates and asyncio task to handle the signal on the event loop."""
asyncio.create_task(callback(sig, loop), name=f"Signal_{sig.name}")
# Linux/Unix signals we should clean up for.
sigs = [signal.SIGTERM, signal.SIGINT, signal.SIGHUP]
for sig in sigs:
loop.add_signal_handler(sig, handle_signal, sig, loop)
# set a flag to prevent adding more of the same handlers on soft restart.
setattr(loop, "_sig_handler_set", True)
def respawn_bot_process() -> None:
"""
Use a platform dependent method to restart the bot process, without
an external process/service manager.
This uses the sys.executable and sys.argv to restart the bot.
This function attempts to make sure all buffers are flushed and logging
is shut down before restarting the new process.
On Linux/Unix-style OS this will use sys.execlp to replace the process
while keeping the existing PID.
On Windows OS this will use subprocess.Popen to create a new console
where the new bot is started, with a new PID, and exit this instance.
"""
exec_args = [sys.executable] + sys.argv
shutdown_loggers()
rotate_log_files()
sys.stdout.flush()
sys.stderr.flush()
logging.shutdown()
if os.name == "nt":
# On Windows, this creates a new process window that dies when the script exits.
# Seemed like the best way to avoid a pile of processes While keeping clean output in the shell.
# There is seemingly no way to get the same effect as os.exec* on unix here in windows land.
# The moment we end our existing instance, control is returned to the starting shell.
subprocess.Popen( # pylint: disable=consider-using-with
exec_args,
creationflags=subprocess.CREATE_NEW_CONSOLE, # type: ignore[attr-defined]
)
print("Opened a new MusicBot instance. This terminal can be safely closed!")
sys.exit(0)
else:
# On Unix/Linux/Mac this should immediately replace the current program.
# No new PID, and the babies all get thrown out with the bath. Kinda dangerous...
# We need to make sure files and things are closed before we do this.
os.execlp(exec_args[0], *exec_args)
def set_console_title() -> None:
"""
Attempts to set the console window title using the current version string.
On windows, this method will try to enable ANSI Escape codes by enabling
virtual terminal processing or by calling an empty sub-shell.
"""
# On windows, if colorlog isn't loaded already, ANSI escape codes probably
# wont work like we expect them to.
# This code attempts to solve that using ctypes and cursed windows-isms.
# or if that fails (it shouldn't) it falls back to another cursed trick.
if os.name == "nt":
try:
# if colorama fails to import we can assume setup_logs didn't load it.
import colorama # type: ignore[import-untyped]
# if it works, then great, one less thing to worry about right???
colorama.just_fix_windows_console()
except ImportError:
# This might only work for Win 10+
from ctypes import windll # type: ignore[attr-defined]
k32 = windll.kernel32
# For info on SetConsoleMode, see:
# https://learn.microsoft.com/en-us/windows/console/setconsolemode
# For info on GetStdHandle, see:
# https://learn.microsoft.com/en-us/windows/console/getstdhandle
try:
k32.SetConsoleMode(k32.GetStdHandle(-11), 7)
except Exception: # pylint: disable=broad-exception-caught
# If it didn't work, fall back to this cursed trick...
# Since console -does- support ANSI escapes, but turns them off,
# This sort of beats the current console buffer over the head with
# the sub-shell's and then cannot disable the mode in parent shell.
try:
# No version info for this, testing needed.
os.system("")
except Exception: # pylint: disable=broad-exception-caught
# if this failed too, we're just out of luck.
pass
# Update the console title, ignore if it fails.
try:
sys.stdout.write(f"\x1b]2;MusicBot {BOTVERSION}\x07")
except (TypeError, OSError):
pass
def main() -> None:
"""
All of the MusicBot starts here.
"""
# Attempt to set console title.
set_console_title()
# take care of loggers right away
setup_loggers()
# parse arguments before any logs, so --help does not make an empty log.
cli_args = parse_cli_args()
# Log file creation is deferred until this first write.
log.info("Loading MusicBot version: %s", BOTVERSION)
log.info("Log opened: %s", time.ctime())
# Check if run.py is in the current working directory.
run_py_dir = os.path.dirname(os.path.realpath(__file__))
if run_py_dir != os.getcwd():
# if not, verify musicbot and .git folders exists and change directory.
run_mb_dir = pathlib.Path(run_py_dir).joinpath("musicbot")
run_git_dir = pathlib.Path(run_py_dir).joinpath(".git")
if run_mb_dir.is_dir() and run_git_dir.is_dir():
log.warning("Changing working directory to: %s", run_py_dir)
os.chdir(run_py_dir)
else:
log.critical(
"Cannot start the bot! You started `run.py` in the wrong directory"
" and we could not locate `musicbot` and `.git` folders to verify"
" a new directory location."
)
log.error(
"For best results, start `run.py` from the same folder you cloned MusicBot into.\n"
"If you did not use git to clone the repository, you are strongly urged to."
)
time.sleep(3) # make sure they see the message.
sys.exit(127)
# Handle startup checks, if they haven't been skipped.
sanity_checks(cli_args)
exit_signal: Union[RestartSignal, TerminateSignal, None] = None
event_loop: Optional[asyncio.AbstractEventLoop] = None
tried_requirementstxt: bool = False
use_certifi: bool = False
retries: int = 0
max_wait_time: int = 60
while True:
# Maybe I need to try to import stuff first, then actually import stuff
# It'd save me a lot of pain with all that awful exception type checking
m = None
try:
# Prevent re-import of MusicBot
if "MusicBot" not in dir():
from musicbot.bot import ( # pylint: disable=import-outside-toplevel
MusicBot,
)
# py3.8 made ProactorEventLoop default on windows.
# py3.12 deprecated using get_event_loop(), we need new_event_loop().
event_loop = asyncio.new_event_loop()
asyncio.set_event_loop(event_loop)
# init some of bot, but don't run it yet.
m = MusicBot(use_certifi=use_certifi)
# register system signal handlers with the event loop.
if not getattr(event_loop, "_sig_handler_set", False):
setup_signal_handlers(event_loop, m.on_os_signal)
# let the MusicBot run free!
event_loop.run_until_complete(m.run_musicbot())
retries = 0
except (ssl.SSLCertVerificationError, ClientConnectorCertificateError) as e:
# For aiohttp, we need to look at the cause.
if isinstance(e, ClientConnectorCertificateError) and isinstance(
e.__cause__, ssl.SSLCertVerificationError
):
e = e.__cause__
else:
log.critical(
"Certificate error is not a verification error, not trying certifi and exiting."
)
log.exception("Here is the exact error, it could be a bug.")
break
# In case the local trust store does not have the cert locally, we can try certifi.
# We don't want to patch working systems with a third-party trust chain outright.
# These verify_code values come from OpenSSL: https://www.openssl.org/docs/man1.0.2/man1/verify.html
if e.verify_code == 20: # X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
if use_certifi: # already tried it.
log.exception(
"Could not get Issuer Certificate even with certifi!\n"
"Try running: %s -m pip install --upgrade certifi ",
sys.executable,
)
log.warning(
"To easily add a certificate to Windows trust store, \n"
"you can open the failing site in Microsoft Edge or IE...\n"
)
break
log.warning(
"Could not get Issuer Certificate from default trust store, trying certifi instead."
)
use_certifi = True
retries += 1
continue
except SyntaxError:
if "-dirty" in BOTVERSION:
log.exception("Syntax error (version is dirty, did you edit the code?)")
else:
log.exception("Syntax error (this is a bug, not your fault)")
break
except (AttributeError, ImportError) as e:
# In case a discord extension is installed but discord.py isn't.
if isinstance(e, AttributeError):
if "module 'discord'" not in str(e):
raise
if cli_args.no_install_deps:
helpfulerr = HelpfulError(
preface="Cannot start MusicBot due to an error!",
issue=(
f"Error: {str(e)}\n"
"This is an error importing MusicBot or a dependency package."
),
solution=(
"You need to manually install dependency packages via pip.\n"
"Or launch without `--no-install-deps` and MusicBot will try to install them for you."
),
footnote=(
"You have the `--no-install-deps` option set."
"Normally MusicBot attempts "
),
)
log.error(str(helpfulerr))
break
if not PIP.works():
log.critical(
"MusicBot could not import dependency modules and we cannot run `pip` automatically!\n"
"You will need to manually install `pip` package for your version of python.\n"
)
log.warning(
"If you already installed `pip` but still get this error:\n"
" - Check that you installed it for this python version: %s\n"
" - Check installed packages are accessible to the user running MusicBot",
sys.version.split(maxsplit=1)[0],
)
break