mirror of
https://github.com/YunoHost/apps.git
synced 2024-09-03 20:06:07 +02:00
Add script to autopatch apps for helpers 2.1
This commit is contained in:
Alexandre Aubin
parent
b72f2a2da8
commit
99f44f9ff1
1 changed files with 269 additions and 0 deletions
269
tools/helpers2.1/convert_to_helpers_2.1.py
Normal file
269
tools/helpers2.1/convert_to_helpers_2.1.py
Normal file
|
|
@ -0,0 +1,269 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
import argparse
|
||||
import os
|
||||
import re
|
||||
|
||||
|
||||
def cleanup():
|
||||
|
||||
comment_blocks_to_cleanup = [
|
||||
r"#=+\s*\n# GENERIC START\S*\s*\n#=+\s*\n# IMPORT GENERIC HELPERS\n#=+\s*\n",
|
||||
r"#=+\s*\n# EXPERIMENTAL HELPERS\s*\n#=+\s*\n",
|
||||
r"#=+\s*\n# FUTURE OFFICIAL HELPERS\s*\n#=+\s*\n",
|
||||
r"#=+\s*\n# PERSONAL HELPERS\s*\n#=+\s*\n",
|
||||
r"#=+\s*\n# GENERIC FINALIZATION\s*\n",
|
||||
r"#=+\s*\n# GENERIC FINALISATION\s*\n",
|
||||
r"#=+\s*\n# STANDARD MODIFICATIONS\s*\n",
|
||||
r"#=+\s*\n# STANDARD UPGRADE STEPS\s*\n",
|
||||
r"#=+\s*\n# SPECIFIC UPGRADE\s*\n",
|
||||
r"#=+\s*\n# CHECK VERSION\s*\n#=+\s*\n",
|
||||
r"#=+\s*\n# DECLARE DATA AND CONF FILES TO BACKUP\s*\n#=+\s*\n",
|
||||
]
|
||||
|
||||
removememaybes = [
|
||||
"ynh_legacy_permissions_exists",
|
||||
"ynh_legacy_permissions_delete_all",
|
||||
"ynh_webpath_available",
|
||||
"ynh_webpath_register",
|
||||
"ynh_psql_test_if_first_run",
|
||||
"ynh_backup_before_upgrade",
|
||||
"ynh_restore_upgradebackup",
|
||||
"ynh_find_port",
|
||||
"ynh_port_available",
|
||||
"ynh_require_ram",
|
||||
"--ignore_swap",
|
||||
"--only_swap",
|
||||
"ynh_print_log",
|
||||
"ynh_print_OFF",
|
||||
"ynh_print_ON",
|
||||
"fpm_usage=low",
|
||||
"fpm_usage=\"low\"",
|
||||
"fpm_footprint=low",
|
||||
"fpm_footprint=\"low\"",
|
||||
"fpm_free_footprint=",
|
||||
]
|
||||
|
||||
replaces = [
|
||||
# Unecessary exec_warn_less
|
||||
(r"ynh_exec_warn_less ynh_secure_remove", "ynh_secure_remove"),
|
||||
(r"ynh_exec_warn_less ynh_systemd_action", "ynh_systemd_action"),
|
||||
(r"ynh_exec_warn_less ynh_install_nodejs", "ynh_install_nodejs"),
|
||||
(r"ynh_exec_warn_less ynh_install_go", "ynh_install_go"),
|
||||
(r"ynh_exec_warn_less ynh_install_ruby", "ynh_install_ruby"),
|
||||
# Setting get/set
|
||||
(r" ?--app=? ?\"?\$app\"?", ""),
|
||||
# Misc
|
||||
(r"ynh_validate_ip4", "ynh_validate_ip --family=4"),
|
||||
(r"ynh_validate_ip4", "ynh_validate_ip --family=6"),
|
||||
(r"\$\(ynh_get_debian_release\)", "$YNH_DEBIAN_VERSION"),
|
||||
(r"ynh_read_manifest --manifest\S*", "ynh_read_manifest"),
|
||||
(r"--manifest_key", "--key"),
|
||||
(r"--weight=1$", ""),
|
||||
(r"COMMON VARIABLES", "COMMON VARIABLES AND CUSTOM HELPERS"),
|
||||
(r"ynh_string_random ([0-9])", "ynh_string_random --length=\\1"),
|
||||
# ynh_setup_source
|
||||
(r"--full_replace=1", "--full_replace"),
|
||||
(r"sources/patches", "patches"),
|
||||
(r"sources/extra_files/app", "sources"),
|
||||
(r"sources/extra_files", "sources"),
|
||||
# Logging
|
||||
(r"ynh_print_err", "ynh_print_warn"),
|
||||
(r"ynh_exec_quiet ?", ""),
|
||||
(r"ynh_exec_fully_quiet ?", ""),
|
||||
(r"ynh_exec_warn_less", "ynh_hide_warnings"),
|
||||
# rm
|
||||
(r"ynh_secure_remove( --file=?)? ?", "ynh_safe_rm "),
|
||||
# Conf / templating
|
||||
(r"__NAME__", "__APP__"),
|
||||
(r"__NAMETOCHANGE__", "__APP__"),
|
||||
(r"ynh_render_template", "# FIXME -> ynh_add_config --jinja"),
|
||||
(r'--template="../conf/', '--template="'),
|
||||
(r'--template="../conf/', '--template="'),
|
||||
# Upgrade stuff
|
||||
(r"ynh_compare_current_package_version.*lt.*version\s?=?\"?([0-9\.]+~ynh[0-9])\"?", "ynh_app_upgrading_from_version_before"),
|
||||
(r"ynh_compare_current_package_version.*le.*version\s?=?\"?([0-9\.]+~ynh[0-9])\"?", "ynh_app_upgrading_from_version_before_or_equal_to"),
|
||||
(r"upgrade_type=\S*", ""),
|
||||
('\[\s+"?\$upgrade_type"?\s+==\s+"?UPGRADE_APP"? ]', "ynh_app_upstream_version_changed"),
|
||||
# Backup/store
|
||||
(r"ynh_restore\s*$", "ynh_restore_everything"),
|
||||
# -> Specific trick to remove the --not_mandatory here, but replace it with || true for the other occurences
|
||||
(r'ynh_restore_file --origin_path="\$data_dir" \S*', 'ynh_restore "$data_dir"'),
|
||||
(r"ynh_restore_file", "ynh_restore"),
|
||||
(r"--src_path=?", ""),
|
||||
(r"--origin_path=?", ""),
|
||||
(r"--is_big\S*", ""),
|
||||
(r"--not_mandatory", "|| true"),
|
||||
# Fail2ban
|
||||
(r"--max_retry=\S*", ""),
|
||||
(r"--ports\S*", ""),
|
||||
(r"ynh_add_fail2ban_config --use_template", "ynh_add_fail2ban_config"),
|
||||
# MySQL/Postgresql
|
||||
(r"ynh_mysql_dump_db \S*\$db_name\"?\s", "ynh_mysql_dump_db "),
|
||||
(r"ynh_psql_dump_db \S*\$db_name\"?\s", "ynh_psql_dump_db "),
|
||||
(r"ynh_mysql_connect_as [^<\\]*\s", "ynh_mysql_execute "),
|
||||
(r"ynh_mysql_execute_as_root \"", "ynh_mysql_execute_as_root --sql=\""),
|
||||
# PHP / composer
|
||||
(r" ?--phpversion=\S*", ""),
|
||||
(r" ?--composerversion=\S*", ""),
|
||||
(r" ?--usage=\S*", ""),
|
||||
(r" ?--footprint=\S*", ""),
|
||||
(r"YNH_COMPOSER_VERSION=", "composer_version="),
|
||||
(r' --workdir="\$install_dir"', ""),
|
||||
(r'--workdir=\$install_dir ', ""),
|
||||
(r'phpversion', "php_version"),
|
||||
(r'PHPVERSION', "PHP_VERSION"),
|
||||
# Nodejs
|
||||
(r"NODEJS_VERSION=", "nodejs_version="),
|
||||
(r"ynh_install_nodejs \S*", "ynh_install_nodejs"),
|
||||
(r"ynh_use_nodejs", "# REMOVEME? ynh_use_nodejs"),
|
||||
(r'"?\$ynh_node_load_PATH"?', ""),
|
||||
(r'"?\$ynh_node_load_path"?', ""),
|
||||
(r'"?\$?ynh_npm"?', "npm"),
|
||||
(r'"?\$?ynh_node"?', "node"),
|
||||
(r'(export )?COREPACK_ENABLE_DOWNLOAD_PROMPT=0', ""),
|
||||
(r'env\s+npm', "npm"),
|
||||
(r'env\s+pnpm', "pnpm"),
|
||||
(r'env\s+yarn', "yarn"),
|
||||
(r'env\s+corepack', "corepack"),
|
||||
# Ruby
|
||||
(r"RUBY_VERSION=", "ruby_version="),
|
||||
(r"ynh_install_ruby \S*", "ynh_install_ruby"),
|
||||
(r"ynh_use_ruby", "# REMOVEME? ynh_use_ruby"),
|
||||
(r'"?\$ynh_ruby_load_PATH"?', ""),
|
||||
(r'"?\$ynh_ruby_load_path"?', ""),
|
||||
(r'"?\$?ynh_ruby"?', "ruby"),
|
||||
(r'"?\$?ynh_gem"?', "gem"),
|
||||
# Go
|
||||
(r"^\s*GO_VERSION=", "go_version="),
|
||||
(r"ynh_install_go \S*", "ynh_install_go"),
|
||||
(r"ynh_use_go", "# REMOVEME? ynh_use_go"),
|
||||
(r'"?\$?ynh_go"?', "go"),
|
||||
# Mongodb
|
||||
(r"YNH_MONGO_VERSION", "mongo_version"),
|
||||
(r"ynh_install_mongo \S*", "ynh_install_mongo"),
|
||||
# ynh_replace_string
|
||||
(r"ynh_replace_string", "ynh_replace"),
|
||||
(r"--match_string", "--match"),
|
||||
(r"--replace_string", "--replace"),
|
||||
(r"--target_file", "--file"),
|
||||
# Systemd
|
||||
(r'--log_path="/var/log/\$app/\$app.log"', ""),
|
||||
(r"--service_name", "--service"),
|
||||
# Logrotate
|
||||
(r"ynh_use_logrotate", "ynh_add_logrotate_config"),
|
||||
(r"ynh_remove_logrotate", "ynh_remove_logrotate_config"),
|
||||
(r"--specific_user\S*", ""),
|
||||
(r"--logfile=?", ""),
|
||||
(r" ?--non-?append", ""),
|
||||
# Exec as / sudo
|
||||
(r'ynh_exec_as "?\$app"?( env)?', "ynh_exec_as_app"),
|
||||
(r'sudo -u "?\$app"?( env)?', "ynh_exec_as_app"),
|
||||
# Cringy messages?
|
||||
("Modifying a config file...", "Updating configuration..."),
|
||||
("Adding a configuration file...", "Adding $app's configuration..."),
|
||||
("Restoring the systemd configuration...", "Restoring $app's systemd service..."),
|
||||
("Configuring a systemd service...", "Configuring $app's systemd service..."),
|
||||
("Stopping a systemd service...", "Stopping $app's systemd service..."),
|
||||
("Starting a systemd service...", "Starting $app's systemd service..."),
|
||||
# Trailing spaces
|
||||
(r"\s+$", "\n"),
|
||||
]
|
||||
|
||||
conf_replaces = [
|
||||
(r"__NAME__", "__APP__"),
|
||||
(r"__NAMETOCHANGE__", "__APP__"),
|
||||
("__YNH_NODE__", "node"),
|
||||
("__YNH_NPM__", "npm"),
|
||||
("__YNH_NODE_LOAD_PATH__", "PATH=__PATH_WITH_NODEJS__"),
|
||||
("__YNH_RUBY_LOAD_PATH__", "PATH=__PATH_WITH_RUBY__"),
|
||||
("__YNH_GO_LOAD_PATH__", "PATH=__PATH_WITH_GO__"),
|
||||
("__YNH_RUBY__", "ruby"),
|
||||
("__PHPVERSION__", "__PHP_VERSION__"),
|
||||
]
|
||||
|
||||
replaces = [(re.compile(pattern, flags=re.M), replace) for pattern, replace in replaces]
|
||||
comment_blocks_to_cleanup = [re.compile(pattern, flags=re.M) for pattern in comment_blocks_to_cleanup]
|
||||
|
||||
for s in [
|
||||
"_common.sh",
|
||||
"install",
|
||||
"remove",
|
||||
"upgrade",
|
||||
"backup",
|
||||
"restore",
|
||||
"change_url",
|
||||
"config",
|
||||
]:
|
||||
|
||||
script = f"scripts/{s}"
|
||||
|
||||
if not os.path.exists(script):
|
||||
continue
|
||||
|
||||
content = open(script).read()
|
||||
|
||||
if s == "remove":
|
||||
content = re.sub(r'(ynh_secure_remove .*/var/log/\$app.*)', r"#REMOVEME? (Apps should not remove their log dir during remove ... this should only happen if --purge is used, and be handled by the core...) \1", content)
|
||||
|
||||
for pattern in comment_blocks_to_cleanup:
|
||||
content = pattern.sub("", content)
|
||||
|
||||
for pattern, replace in replaces:
|
||||
content = pattern.sub(replace, content)
|
||||
|
||||
for remove in removememaybes:
|
||||
content = content.replace(remove, r"#REMOVEME? " + remove)
|
||||
|
||||
# Remove trailing spaces, for some reason we gotta have re.M flag ...
|
||||
#content = re.sub(r"\s+$", "\n", content, flags=re.M)
|
||||
|
||||
open(script, "w").write(content)
|
||||
|
||||
for pattern, replace in conf_replaces:
|
||||
os.system(f"sed 's@{pattern}@{replace}@g' -i $(find conf/ -type f)")
|
||||
|
||||
git_cmds = [
|
||||
"git rm --quiet sources/extra_files/*/.gitignore 2>/dev/null",
|
||||
"git rm --quiet sources/patches/.gitignore 2>/dev/null",
|
||||
"git mv sources/extra_files/* sources/",
|
||||
"git mv sources/app/* sources/",
|
||||
"git mv sources/patches patches/",
|
||||
"test -e conf/app.sh && git rm --quiet conf/app.src",
|
||||
"test -e check_process && git rm --quiet check_process",
|
||||
"test -e scripts/actions && git rm -rf --quiet scripts/actions",
|
||||
"test -e config_panel.json && git rm --quiet config_panel.json",
|
||||
"test -e config_panel.toml.example && git rm --quiet config_panel.toml.example",
|
||||
"git rm $(find ./ -name .DS_Store) 2>/dev/null",
|
||||
"grep -q '\*\~' .gitignore || echo '*~' >> .gitignore",
|
||||
"grep -q '\~.sw\[op\]' .gitignore || echo '~.sw[op]' >> .gitignore",
|
||||
"grep -q '\.DS_Store' .gitignore || echo '.DS_Store' >> .gitignore",
|
||||
"git add .gitignore",
|
||||
]
|
||||
|
||||
for cmd in git_cmds:
|
||||
os.system(cmd)
|
||||
|
||||
# If there's a config panel but the only options are the stupid php usage/footprint stuff
|
||||
if os.path.exists("config_panel.toml") and os.system(r"grep -oE '^\s*\[\S+\.\S+\.\S+]' config_panel.toml | grep -qv php_fpm_config") == 1:
|
||||
os.system("git rm -f config_panel.toml")
|
||||
os.system("git rm -f scripts/config")
|
||||
|
||||
# Add helpers_version = '2.1' after yunohost requirement in manifest
|
||||
os.system('sed -i \'/^yunohost =/a helpers_version = "2.1"\' manifest.toml')
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Attempt to automatically apply changes to use YunoHost helpers v2.1 on a v2 app"
|
||||
)
|
||||
parser.add_argument("app_path", help="Path to the app to convert")
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
if not os.path.exists(args.app_path + "/manifest.toml"):
|
||||
raise Exception("There is no manifest.toml. Is this really an app directory ?")
|
||||
|
||||
os.chdir(args.app_path)
|
||||
|
||||
cleanup()
|
||||
Loading…
Add table
Reference in a new issue