aboutsummaryrefslogtreecommitdiff
path: root/tool/setup.py
diff options
context:
space:
mode:
Diffstat (limited to 'tool/setup.py')
-rwxr-xr-xtool/setup.py342
1 files changed, 223 insertions, 119 deletions
diff --git a/tool/setup.py b/tool/setup.py
index 15f956c..8781fcf 100755
--- a/tool/setup.py
+++ b/tool/setup.py
@@ -7,22 +7,40 @@ import pwd
import grp
import sys
import argparse
+import typing
+import shutil
+import urllib.request
+from rich.console import Console
+from rich.prompt import Prompt, Confirm
+
+console = Console()
+
+
+def print_order(number: int, total: int, *, console=console) -> None:
+ console.print(f"\[{number}/{total}]", end=" ", style="green")
+
parser = argparse.ArgumentParser(
description="Crupest server all-in-one setup script. Have fun play with it!")
-parser.add_argument("action", choices=["setup", "download-tools", "clear"], default="setup", nargs="?",
- help="choose what to do, 'setup' for everything needed to run server, 'download-tools' for downloading other needed tools for setup, 'clear' for deleting everything so you can restart.")
-parser.add_argument("--include-data-dir", action="store_true",
- default=False, help="include data dir when clear")
-args = parser.parse_args()
+subparsers = parser.add_subparsers(dest="action")
+
+setup_parser = subparsers .add_parser(
+ "setup", help="Do everything necessary to setup the server.")
-if args.action != 'clear' and args.include_data_dir:
- print("Warning: --include-data-dir is only used when clear, ignored.")
+download_tools_parser = subparsers .add_parser(
+ "download-tools", help="Download some extra tools to manage the server.")
-print("Nice to see you!\n")
+clear_parser = subparsers .add_parser(
+ "clear", help="Delete existing data so you can make a fresh start.")
+clear_parser.add_argument("-D", "--include-data-dir", action="store_true",
+ default=False, help="Also delete the data directory.")
+
+args = parser.parse_args()
+
+console.print("Nice to see you! :waving_hand:", style="cyan")
# get script dir in relative path
-script_dir = os.path.dirname(__file__)
+script_dir = os.path.relpath(os.path.dirname(__file__))
project_dir = os.path.normpath(os.path.join(script_dir, "../"))
template_dir = os.path.join(project_dir, "template")
data_dir = os.path.join(project_dir, "data")
@@ -32,24 +50,30 @@ tool_dir = os.path.join(project_dir, "tool")
def download_tools():
SCRIPTS = [("docker-mailserver setup script", "docker-mailserver-setup.sh",
"https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/setup.sh")]
- for script in SCRIPTS:
+ for index, script in enumerate(SCRIPTS):
+ number = index + 1
+ total = len(SCRIPTS)
+ print_order(number, total)
name, filename, url = script
path = os.path.join(tool_dir, filename)
skip = False
if os.path.exists(path):
- print(f"{name} already exists, download and overwrite? (y/N)", end=" ")
- if input() != "y":
+ overwrite = Confirm.ask(
+ f"[cyan]{name}[/] already exists, download and overwrite?", default=False)
+ if not overwrite:
skip = True
else:
- print(f"Download {name} to {path}? (Y/n)", end=" ")
- if input() == "n":
+ download = Confirm.ask(
+ f"Download [cyan]{name}[/] to [magenta]{path}[/]?", default=True)
+ if not download:
skip = True
if not skip:
- print(f"Downloading {name}...")
- os.system(f"curl -s {url} > {path} && chmod +x {path}")
- print(f"Downloaded {name} to {path}.")
+ console.print(f"Downloading {name}...")
+ urllib.request.urlretrieve(url, path)
+ os.chmod(path, 0o755)
+ console.print(f"Downloaded {name} to {path}.", style="green")
else:
- print(f"Skipped {name}.")
+ console.print(f"Skipped {name}.", style="yellow")
if args.action == 'download-tools':
@@ -66,11 +90,12 @@ template_name_list = [os.path.basename(f)[:-len('.template')] for f in os.listdi
if args.action == "clear":
# check root if we have to delete data dir
if args.include_data_dir and os.path.exists(data_dir) and os.geteuid() != 0:
- print("You need to be root to delete data dir.")
+ console.print("You need to be root to delete data dir.", style="red")
sys.exit(1)
- print("Are you sure you want to delete everything? all your data will be lost! (y/N)", end=" ")
- if input() == "y":
+ to_delete = Confirm.ask(
+ "[yellow]Are you sure you want to delete everything? all your data will be lost![/]", default=False)
+ if to_delete:
files_to_delete = []
for template_name in template_name_list:
f = os.path.join(project_dir, template_name)
@@ -80,94 +105,159 @@ if args.action == "clear":
delete_data_dir = args.include_data_dir and os.path.exists(data_dir)
if len(files_to_delete) == 0:
- print("Nothing to delete. We are safe!")
+ console.print("Nothing to delete. We are safe!", style="green")
exit(0)
- print("Here are the files to delete:")
+ console.print("Here are the files to delete:")
for f in files_to_delete:
- print(f)
+ console.print(f, style="magenta")
if delete_data_dir:
- print(data_dir + " (data dir)")
+ console.print(data_dir + " (data dir)", style="magenta")
- print("Are you sure you want to delete them? (y/N)", end=" ")
- if input() == "y":
+ to_delete = Confirm.ask(
+ "[yellow]Are you sure you want to delete them?[/]", default=False)
+ if to_delete:
for f in files_to_delete:
os.remove(f)
if delete_data_dir:
- os.rmdir(data_dir)
- print("Your workspace is clean now! However config file is still there! See you!")
+ # recursively delete data dir
+ shutil.rmtree(data_dir)
+ console.print(
+ "Your workspace is clean now! However config file is still there! See you!", style="green")
exit(0)
-print("I have found following template files:")
+console.print(
+ f"I have found following template files in [magenta]{template_dir}[/]:", style="green")
for filename in template_name_list:
- print(filename)
-print("")
-
-required_config_key_list = [
- ("CRUPEST_DOMAIN", lambda: input("Please input your domain name:")),
- ("CRUPEST_EMAIL", lambda: input("Please input your email address:")),
- ("CRUPEST_USER", lambda: pwd.getpwuid(os.getuid()).pw_name),
- ("CRUPEST_GROUP", lambda: grp.getgrgid(os.getgid()).gr_name),
- ("CRUPEST_UID", lambda: str(os.getuid())),
- ("CRUPEST_GID", lambda: str(os.getgid())),
- ("CRUPEST_HALO_DB_PASSWORD", lambda: os.urandom(8).hex()),
- ("CRUPEST_IN_CHINA", lambda: "false")
-]
+ console.print(f"- [magenta]{filename}.template[/]")
-required_config_value_generator_map = dict(required_config_key_list)
-required_config_keys = set([key for key, _ in required_config_key_list])
+class ConfigVar:
+ def __init__(self, name: str, description: str, default_value_generator: typing.Callable[[], str] | str):
+ """Create a config var.
-sub_regex = re.compile(r"\{\{\s*([a-zA-Z0-9_]+?)\s*\}\}")
-var_set = set()
-for template in os.listdir(template_dir):
- if not template.endswith(".template"):
- continue
- with open(os.path.join(template_dir, template), "r") as f:
- content = f.read()
- match_list = sub_regex.finditer(content)
- for match in match_list:
+ Args:
+ name (str): The name of the config var.
+ description (str): The description of the config var.
+ default_value_generator (typing.Callable([], str) | str): The default value generator of the config var. If it is a string, it will be used as the input prompt and let user input the value.
+ """
+ self.name = name
+ self.description = description
+ self.default_value_generator = default_value_generator
+
+ def get_default_value(self):
+ if isinstance(self.default_value_generator, str):
+ return Prompt.ask(self.default_value_generator, console=console)
+ else:
+ return self.default_value_generator()
+
+
+config_var_list: list[ConfigVar] = [
+ ConfigVar("CRUPEST_DOMAIN", "domain name",
+ "Please input your domain name:"),
+ # ConfigVar("CRUPEST_EMAIL", "admin email address",
+ # "Please input your email address:"),
+ ConfigVar("CRUPEST_USER", "your system account username",
+ lambda: pwd.getpwuid(os.getuid()).pw_name),
+ ConfigVar("CRUPEST_GROUP", "your system account group name",
+ lambda: grp.getgrgid(os.getgid()).gr_name),
+ ConfigVar("CRUPEST_UID", "your system account uid",
+ lambda: str(os.getuid())),
+ ConfigVar("CRUPEST_GID", "your system account gid",
+ lambda: str(os.getgid())),
+ ConfigVar("CRUPEST_HALO_DB_PASSWORD",
+ "password for halo h2 database, once used never change it", lambda: os.urandom(8).hex()),
+ ConfigVar("CRUPEST_IN_CHINA",
+ "set to true if you are in China, some network optimization will be applied", lambda: "false")
+]
+
+config_var_name_set = set([config_var.name for config_var in config_var_list])
+
+
+class Template:
+
+ def __init__(self, template_path: str, var_prefix: str = "CRUPEST"):
+ if len(var_prefix) != 0 and re.fullmatch(r"^[a-zA-Z_][a-zA-Z0-9_]*$", var_prefix) is None:
+ raise ValueError("Invalid var prefix.")
+ self.template_path = template_path
+ self.template_name = os.path.basename(
+ template_path)[:-len(".template")]
+ with open(template_path, "r") as f:
+ self.template = f.read()
+ self.var_prefix = var_prefix
+ self.__var_regex = re.compile(r"\$(" + var_prefix + r"_[a-zA-Z0-9_]+)")
+ self.__var_brace_regex = re.compile(
+ r"\$\{\s*(" + var_prefix + r"_[a-zA-Z0-9_]+)\s*\}")
+ var_set = set()
+ for match in self.__var_regex.finditer(self.template):
+ var_set.add(match.group(1))
+ for match in self.__var_brace_regex.finditer(self.template):
var_set.add(match.group(1))
+ self.var_set = var_set
+
+ def generate(self, config: dict[str, str]) -> str:
+ result = self.template
+ for var in self.var_set:
+ if var not in config:
+ raise ValueError(f"Missing config var {var}.")
+ result = result.replace("$" + var, config[var])
+ re.sub(r"\$\{\s*" + var + r"\s*\}", config[var], result)
+ return result
+
+
+template_list: list[Template] = []
+config_var_name_set_in_template = set()
+for template_path in os.listdir(template_dir):
+ if not template_path.endswith(".template"):
+ continue
+ template = Template(os.path.join(template_dir, template_path))
+ template_list.append(template)
+ config_var_name_set_in_template.update(template.var_set)
-print("I have found following variables needed in templates:")
-for var in var_set:
- print(var, end=" ")
-print("")
+console.print(
+ "I have found following variables needed in templates:", style="green")
+for key in config_var_name_set_in_template:
+ console.print(key, end=" ", style="magenta")
+console.print("")
# check vars
-if not var_set == required_config_keys:
- print("The variables needed in templates are not same to the explicitly declared ones! There must be something wrong.")
- print("The explicitly declared ones are:")
- for var in required_config_keys:
- print(var, end=" ")
- print("Try to check template files and edit the var list at the head of this script. Aborted! See you next time!")
+if not config_var_name_set_in_template == config_var_name_set:
+ console.print(
+ "The variables needed in templates are not same to the explicitly declared ones! There must be something wrong.", style="red")
+ console.print("The explicitly declared ones are:")
+ for key in config_var_name_set:
+ console.print(key, end=" ", style="magenta")
+ console.print(
+ "\nTry to check template files and edit the var list at the head of this script. Aborted! See you next time!")
exit(1)
-print("Now let's check if they are already generated...")
+console.print("Now let's check if they are already generated...")
conflict = False
# check if there exists any generated files
for filename in template_name_list:
if os.path.exists(os.path.join(project_dir, filename)):
- print(f"Found {filename}")
+ console.print(f"Found [magenta]{filename}[/]")
conflict = True
if conflict:
- print("It seems there are some files already generated. Do you want to overwrite them? (y/N)")
- if input() != "y":
- print("Great! Check the existing files and see you next time!")
+ to_overwrite = Confirm.ask(
+ "It seems there are some files already generated. Do you want to overwrite them?", console=console, default=False)
+ if not to_overwrite:
+ console.print(
+ "Great! Check the existing files and see you next time!", style="green")
exit()
else:
print("No conflict found. Let's go on!\n")
-print("Check for existing config file...")
+console.print("Check for existing config file...")
config_path = os.path.join(data_dir, "config")
-def parse_config(str):
+def parse_config(str: str) -> dict:
config = {}
for line_number, line in enumerate(str.splitlines()):
# check if it's a comment
@@ -175,8 +265,9 @@ def parse_config(str):
continue
# check if there is a '='
if line.find("=") == -1:
- print(
- f"Invalid config file. Please check line {line_number + 1}. There is even no '='! Aborted!")
+ console.print(
+ f"Invalid config file. Please check line {line_number + 1}. There is even no '='! Aborted!", style="red")
+ raise ValueError("Invalid config file.")
# split at first '='
key, value = line.split("=", 1)
key = key.strip()
@@ -185,21 +276,22 @@ def parse_config(str):
return config
-def config_to_str(config):
+def config_to_str(config: dict) -> str:
return "\n".join([f"{key}={value}" for key, value in config.items()])
-def print_config(config):
- print(config_to_str(config))
+def print_config(config: dict) -> None:
+ for key, value in config.items():
+ console.print(f"[magenta]{key}[/] = [cyan]{value}")
# check if there exists a config file
if not os.path.exists(config_path):
config = {}
- print("No existing config file found. Don't worry. Let's create one!")
- for key, default_generator in required_config_key_list:
- if default_generator is not None:
- config[key] = default_generator()
+ console.print(
+ "No existing config file found. Don't worry. Let's create one!", style="green")
+ for config_var in config_var_list:
+ config[config_var.name] = config_var.get_default_value()
config_content = config_to_str(config)
# create data dir if not exist
if not os.path.exists(data_dir):
@@ -207,67 +299,79 @@ if not os.path.exists(config_path):
# write config file
with open(config_path, "w") as f:
f.write(config_content)
- print(
- f"Everything else is auto generated. The config file is written into {config_path}. You had better keep it well. And here is the content:")
- print(config_content)
- print("If you think it's not ok, you can stop here and edit it. Or let's go on? (Y/n)")
- if input() == "n":
- print("Great! Check the config file and see you next time!")
+ console.print(
+ f"Everything else is auto generated. The config file is written into [magenta]{config_path}[/]. You had better keep it well. And here is the content:", style="green")
+ print_config(config)
+ is_ok = Confirm.ask(
+ "If you think it's not ok, you can stop here and edit it. Or let's go on?", console=console, default=True)
+ if not is_ok:
+ console.print(
+ "Great! Check the config file and see you next time!", style="green")
exit()
else:
- print("Looks like you have already had a config file. Let's check the content:")
+ console.print(
+ "Looks like you have already had a config file. Let's check the content:", style="green")
with open(config_path, "r") as f:
content = f.read()
config = parse_config(content)
print_config(config)
- missed_keys = []
- for required_key in required_config_keys:
- if required_key not in config:
- missed_keys.append(required_key)
-
- if len(missed_keys) > 0:
- print(
- "Oops! It seems you have missed some keys in your config file. Let's add them!")
- for key in missed_keys:
- config[key] = required_config_value_generator_map[key]()
+ missed_config_vars = []
+ for config_var in config_var_list:
+ if config_var.name not in config:
+ missed_config_vars.append(config_var)
+
+ if len(missed_config_vars) > 0:
+ console.print(
+ "Oops! It seems you have missed some keys in your config file. Let's add them!", style="green")
+ for config_var in missed_config_vars:
+ config[config_var.name] = config_var.get_default_value()
content = config_to_str(config)
with open(config_path, "w") as f:
f.write(content)
- print("Here is the new config, it has been written out:")
- print(content)
- print("Is it good enough? (Y/n)")
- if input() == "n":
- print("Great! Check the config file and see you next time!")
+ console.print(
+ f"Here is the new config, it has been written out to [magenta]{config_path}[/]:")
+ print_config(config)
+ good_enough = Confirm.ask("Is it good enough?",
+ console=console, default=True)
+ if not good_enough:
+ console.print(
+ "Great! Check the config file and see you next time!", style="green")
exit()
-print("Finally, everything is ready. Let's generate the files:")
+console.print(
+ "Finally, everything is ready. Let's generate the files:", style="green")
# generate files
-for filename in template_name_list:
- print(f"Generating {filename}...")
- with open(os.path.join(template_dir, filename + ".template"), "r") as f:
- content = f.read()
- content = sub_regex.sub(lambda m: config[m.group(1)], content)
- with open(os.path.join(project_dir, filename), "w") as f:
- f.write(content)
-
-print()
+for index, template in enumerate(template_list):
+ number = index + 1
+ total = len(template_list)
+ print_order(number, total)
+ console.print(
+ f"Generating [magenta]{template.template_name}[/]...")
+ content = template.generate(config)
+ with open(os.path.join(project_dir, filename), "w") as f:
+ f.write(content)
if not os.path.exists(os.path.join(data_dir, "code-server")):
os.mkdir(os.path.join(data_dir, "code-server"))
- print("I also create data dir for code-server. Because letting docker create it would result in permission problem.")
+ console.print(
+ "I also create data dir for code-server. Because letting docker create it would result in permission problem.", style="green")
else:
code_server_stat = os.stat(os.path.join(data_dir, "code-server"))
if code_server_stat.st_uid == 0 or code_server_stat.st_gid == 0:
- print("WARNING: The owner of data dir for code-server is root. This may cause permission problem. You had better change it. Want me help you? (Y/n)")
- if input() != "n":
+ console.print(
+ "WARNING: The owner of data dir for code-server is root. This may cause permission problem. You had better change it.", style="yellow")
+ to_fix = Confirm.ask(
+ "Do you want me to help you fix it?", console=console, default=True)
+ if to_fix:
os.system(
f"sudo chown -R {os.getuid()}:{os.getgid()} {os.path.join(data_dir, 'code-server')}")
-print()
-print("🍻All done! By the way, would you like to download some scripts to do some extra setup like creating email user? (Y/n)")
-if input() == "n":
- print("Great! See you next time!")
+console.print(":beers: All done!", style="green")
+to_download_tools = Confirm.ask(
+ "By the way, would you like to download some scripts to do some extra setup like creating email user?", console=console, default=True)
+if not to_download_tools:
+ console.print("Great! See you next time!", style="green")
exit()
download_tools()
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-21 18:16:40 +0000