diff --git a/check_process b/check_process deleted file mode 100644 index 97ba922..0000000 --- a/check_process +++ /dev/null @@ -1,25 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" -# path="/retroarch" -# admin="john" - is_public=1 - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - upgrade=1 from_commit=626e71c417ceb1b2481751fd5e2b0373c2b1b927 - backup_restore=1 - multi_instance=0 - change_url=1 -;;; Options -Email=misterl56@hotmail.com -Notification=none -;;; Upgrade options - ; commit=CommitHash - name=Name and date of the commit. - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& diff --git a/conf/retroarch.cron b/conf/retroarch.cron index fa09e6e..5b77ca3 100644 --- a/conf/retroarch.cron +++ b/conf/retroarch.cron @@ -1,2 +1,2 @@ #This script will update the core index every 5 minutes so that they are available in retroarch -*/5 * * * * root __FINAL_PATH__/indexer.sh > /dev/null 2>&1 +*/5 * * * * root __INSTALL_DIR__/indexer.sh > /dev/null 2>&1 diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 95% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md index da64a34..360f6d2 100644 --- a/doc/DISCLAIMER.md +++ b/doc/ADMIN.md @@ -9,4 +9,4 @@ Although you can upload a ROM at runtime, retroarch may have access to the ROMs * Cannot save game, in fact, cannot write at all... so configuration is lost each time you start again * No user management -* Some core are listed but not implemented : they do not work, the issue is from the upstream app. +* Some core are listed but not implemented : they do not work, the issue is from the upstream app. \ No newline at end of file diff --git a/doc/DISCLAIMER_fr.md b/doc/ADMIN_fr.md similarity index 100% rename from doc/DISCLAIMER_fr.md rename to doc/ADMIN_fr.md diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 787d095..0000000 --- a/manifest.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "name": "Retroarch Web Player", - "id": "retroarch", - "packaging_format": 1, - "description": { - "en": "Emulate videogames system and play videogames through your web browser", - "fr": "Emulez des consoles de jeux et jouer à ces jeux vidéos dans votre explorateur web" - }, - "version": "1.15.0~ynh2", - "url": "http://www.retroarch.com/", - "upstream": { - "license": "GPL-3.0-or-later", - "website": "http://www.retroarch.com/", - "demo": "https://web.libretro.com/", - "admindoc": "https://docs.libretro.com/", - "userdoc": "https://docs.libretro.com/", - "code": "https://github.com/libretro/RetroArch" - }, - "license": "GPL-3.0-or-later", - "maintainer": { - "name": "Krakinou", - "email": "misterl56@hotmail.com" - }, - "requirements": { - "yunohost": ">= 11.1.15" - }, - "multi_instance": false, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/retroarch", - "default": "/retroarch" - }, - { - "name": "is_public", - "type": "boolean", - "default": true, - "help": { - "en": "Yes will allow everyone to access the app without login to yunohost instance first", - "fr": "Oui autorisera n'importe qui à accéder à l'application sans s'identifier dans Yunohost" - } - } - ] - } -} diff --git a/manifest.toml b/manifest.toml index fcd0a8e..34eea0a 100644 --- a/manifest.toml +++ b/manifest.toml @@ -5,7 +5,7 @@ name = "Retroarch Web Player" description.en = "Emulate videogames system and play videogames through your web browser" description.fr = "Emulez des consoles de jeux et jouer à ces jeux vidéos dans votre explorateur web" -version = "1.15.0~ynh2" +version = "1.15.0~ynh3" maintainers = ["Krakinou"] @@ -16,15 +16,13 @@ demo = "https://web.libretro.com/" admindoc = "https://docs.libretro.com/" userdoc = "https://docs.libretro.com/" code = "https://github.com/libretro/RetroArch" -cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) -fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. [integration] -yunohost = ">= 11.1.15" +yunohost = ">= 11.1.18" architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"] multi_instance = false -ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials. -sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal. +ldap = "not_relevant" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials. +sso = "not_relevant" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal. disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... @@ -46,6 +44,15 @@ ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requiremen default = "visitors" [resources] + [resources.sources] + + [resources.sources.main] + url = "https://buildbot.libretro.com/stable/1.15.0/emscripten/RetroArch.7z" + sha256 = "ce4f8319850545478d9b18cb103de0234fc36a1b50788c82cfb0ca308e793914" + format = "whatever" + in_subdir = true + extract = false + [resources.system_user] [resources.install_dir] diff --git a/scripts/change_url b/scripts/change_url index b8c7ec8..d76cdb7 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,58 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN -#REMOVEME? old_path=$YNH_APP_OLD_PATH - -#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN -#REMOVEME? new_path=$YNH_APP_NEW_PATH - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 - -#REMOVEME? # Needed for helper "ynh_add_nginx_config" -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -#REMOVEME? ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=10 - -# Backup the current version of the app -#REMOVEME? ynh_backup_before_upgrade -#REMOVEME? ynh_clean_setup () { - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. -#REMOVEME? ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails -#REMOVEME? ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -#REMOVEME? change_domain=0 -#REMOVEME? if [ "$old_domain" != "$new_domain" ] -then - #REMOVEME? change_domain=1 -fi - -#REMOVEME? change_path=0 -#REMOVEME? if [ "$old_path" != "$new_path" ] -then - #REMOVEME? change_path=1 -fi #================================================= # STANDARD MODIFICATIONS @@ -71,41 +19,5 @@ ynh_script_progression --message="Updating NGINX web server configuration..." -- ynh_change_url_nginx_config -#REMOVEME? nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the NGINX config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original NGINX config file if modified -#REMOVEME? ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper -#REMOVEME? domain="$old_domain" -#REMOVEME? path="$new_path" - # Create a dedicated NGINX config -#REMOVEME? ynh_add_nginx_config -fi - -# Change the domain for NGINX -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location -#REMOVEME? ynh_delete_file_checksum --file="$nginx_conf_path" -#REMOVEME? mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location -#REMOVEME? ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi - -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload - -#================================================= -# END OF SCRIPT -#================================================= ynh_script_progression --message="Change of URL completed for $app" --last diff --git a/scripts/install b/scripts/install index d4974bf..bdc4014 100755 --- a/scripts/install +++ b/scripts/install @@ -9,66 +9,27 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -#REMOVEME? domain=$YNH_APP_ARG_DOMAIN -#REMOVEME? path=$YNH_APP_ARG_PATH -#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -#REMOVEME? ynh_script_progression --message="Validating installation parameters..." --weight=1 - -#REMOVEME? install_dir=/opt/yunohost/$app -#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=1 - -#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain -#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path - #================================================= # INSTALL DEPENDENCIES #================================================= -#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=13 +ynh_script_progression --message="Installing dependencies..." --weight=13 ynh_install_nodejs --nodejs_version=$nodejs_version ynh_use_nodejs ynh_npm install -g coffeescript -#REMOVEME? ynh_install_app_dependencies $pkg_dependencies - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=60 -#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir -# Download, check integrity, uncompress and patch the source from app.src # uncompress and patch done manually as 7z format is not supported ynh_setup_source --dest_dir="$install_dir" #7z archive not handled by ynh and no way to strip component, have to move it manually -7zr x $install_dir/retroarch.7z -o$install_dir +7zr x $install_dir/main -o$install_dir mv $install_dir/retroarch/* $install_dir/ -#REMOVEME? ynh_secure_remove --file="$install_dir/retroarch.7z" -#REMOVEME? ynh_secure_remove --file="$install_dir/retroarch" +ynh_secure_remove --file="$install_dir/main" +ynh_secure_remove --file="$install_dir/retroarch" touch $install_dir/analytics.js #https://github.com/libretro/RetroArch/issues/4539#issuecomment-473345195 @@ -104,7 +65,6 @@ chmod 644 "$cron_path" ynh_script_progression --message="Configuring NGINX web server..." --weight=3 #backup & Update nginx MIME type so wasm mime type is recognized - if [ !$(grep wasm /etc/nginx/mime.types) ]; then ynh_print_info "/etc/nginx/mime.types saved as /etc/nginx/mime.types.$app" cp /etc/nginx/mime.types /etc/nginx/mime.types.$app @@ -115,25 +75,10 @@ fi # Create a dedicated nginx config ynh_add_nginx_config -### For security reason, any app should set the permissions to www-data: before anything else. -### Then, if write authorization is needed, any access should be given only to directories -### that really need such authorization. - # Set permissions to app files -chown -R www-data: $install_dir +chown -R www-data:multimedia $install_dir # Requested so that multimedia group can see the Game folder : all parent folder should be readable by others -chmod 751 $install_dir - -#================================================= -# SETUP SSOWAT -#================================================= -#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary -#REMOVEME? if [ $is_public -eq 1 ] -then -#REMOVEME? ynh_permission_update --permission "main" --add visitors -fi +chmod 750 $install_dir #================================================= # SETUP INDEX @@ -148,14 +93,6 @@ cd $install_dir/assets/frontend/bundle/ cd $install_dir/assets/cores ../../indexer > .index-xhr -#================================================= -# RELOAD NGINX -#================================================= -#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload - - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index edfd3ab..82774e6 100755 --- a/scripts/remove +++ b/scripts/remove @@ -9,32 +9,15 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) - #================================================= # REMOVE DEPENDENCIES #================================================= -#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=7 +ynh_script_progression --message="Removing dependencies..." --weight=7 # Remove metapackage and its dependencies ynh_use_nodejs ynh_npm uninstall -g coffeescript ynh_remove_nodejs -#REMOVEME? ynh_remove_app_dependencies - -#================================================= -# REMOVE CRONJOB -#================================================= - -ynh_secure_remove --file="/etc/cron.d/$app" #================================================= # REMOVE MULTIMEDIA SYMBOLIC LINK @@ -43,14 +26,8 @@ ynh_script_progression --message="Removing Game folder..." --weight=1 # Remove the app directory securely ynh_secure_remove --file="/home/yunohost.multimedia/share/Game" +ynh_secure_remove --file="/etc/cron.d/$app" -#================================================= -# REMOVE APP MAIN DIR -#================================================= -#REMOVEME? ynh_script_progression --message="Removing app main directory..." --weight=1 - -# Remove the app directory securely -#REMOVEME? ynh_secure_remove --file="$install_dir" #================================================= # REMOVE NGINX CONFIGURATION @@ -59,7 +36,7 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- # Remove the dedicated nginx config ynh_remove_nginx_config -#REMOVEME? if [ "$(ynh_app_setting_get --app=$app --key=checksum__etc_nginx_mime.types)" == "$(md5sum "/etc/nginx/mime.types" | cut -d ' ' -f 1)" ]; then +if [ "$(ynh_app_setting_get --app=$app --key=checksum__etc_nginx_mime.types)" == "$(md5sum "/etc/nginx/mime.types" | cut -d ' ' -f 1)" ]; then #file has not changed, restore the previous mime.type rm /etc/nginx/mime.types mv /etc/nginx/mime.types.$app /etc/nginx/mime.types diff --git a/scripts/restore b/scripts/restore index 026101f..2118172 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,31 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading settings..." --weight=1 - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) -#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=1 - -#REMOVEME? test ! -d $install_dir \ - || ynh_die --message="There is already a directory: $install_dir " #================================================= # STANDARD RESTORATION STEPS @@ -60,27 +35,17 @@ ynh_script_progression --message="Restoring the app main directory..." --weight= ynh_restore_file --origin_path="$install_dir" -#================================================= -# RESTORE USER RIGHTS -#================================================= - -# Restore permissions on app files -chown -R www-data: $install_dir -# Requested so that multimedia group can see the Game folder : all parent folder should be readable by others -chmod 751 $install_dir - #================================================= # SPECIFIC RESTORATION #================================================= # REINSTALL DEPENDENCIES #================================================= -#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=5 +ynh_script_progression --message="Reinstalling dependencies..." --weight=5 # Define and install dependencies #Dependencies are not really required as this is just to unzip the 7z file -#REMOVEME? ynh_install_app_dependencies $pkg_dependencies #However, npm IS required to run the coffeescript -ynh_install_nodejs --nodejs_version=10 +ynh_install_nodejs --nodejs_version=$nodejs_version ynh_use_nodejs ynh_npm install -g coffeescript @@ -95,6 +60,15 @@ ynh_multimedia_addfolder --source_dir="$install_dir/assets/cores/Game" --dest_di ynh_add_config --template="../conf/README.GAME" --destination="$install_dir/assets/cores/Game/README" chmod 666 $install_dir/assets/cores/Game/README +#================================================= +# RESTORE USER RIGHTS +#================================================= + +# Restore permissions on app files +chown -R www-data:multimedia $install_dir +# Requested so that multimedia group can see the Game folder : all parent folder should be readable by others +chmod 750 $install_dir + #================================================= # RESTORE THE CRON FILE #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 0e76627..17bbff9 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,37 +9,12 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) -#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) -#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) - #================================================= # CHECK VERSION #================================================= upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -#REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=10 - -# Backup the current version of the app -#REMOVEME? ynh_backup_before_upgrade -#REMOVEME? ynh_clean_setup () { - # Restore it if the upgrade fails -#REMOVEME? ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -53,11 +28,10 @@ then # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$install_dir" #7z archive not handled by ynh and no way to strip component, have to move it manually - 7zr x $install_dir/retroarch.7z -o$install_dir + 7zr x $install_dir/main -o$install_dir #mv not working as target directory is not empty cp -R $install_dir/retroarch/* $install_dir/ -#REMOVEME? ynh_secure_remove --file="$install_dir/retroarch.7z" -#REMOVEME? ynh_secure_remove --file="$install_dir/retroarch" + ynh_secure_remove --file="$install_dir/main" touch $install_dir/analytics.js #https://github.com/libretro/RetroArch/issues/4539#issuecomment-473345195 #Get the indexer as exe so that folder w/ ROMs can be indexed chmod +x $install_dir/indexer @@ -97,11 +71,10 @@ ynh_add_nginx_config #================================================= # UPGRADE DEPENDENCIES #================================================= -#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=20 +ynh_script_progression --message="Upgrading dependencies..." --weight=20 # Define and install dependencies #Dependencies are not really required as this is just to unzip the 7z file -#REMOVEME? ynh_install_app_dependencies $pkg_dependencies #However, npm IS required to run the coffeescript ynh_install_nodejs --nodejs_version=$nodejs_version ynh_use_nodejs @@ -113,16 +86,9 @@ ynh_npm install -g coffeescript # Set permissions on app files #================================================= -chown -R www-data: $install_dir +chown -R www-data:multimedia $install_dir # Requested so that multimedia group can see the Game folder : all parent folder should be readable by others -chmod 751 $install_dir - -#================================================= -# RELOAD NGINX -#================================================= -#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload +chmod 750 $install_dir #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..0539bbf --- /dev/null +++ b/tests.toml @@ -0,0 +1,4 @@ +test_format = 1.0 + +[default] + test_upgrade_from.b7eb8ba.name = "1.15.0~ynh2"