From 365d0b25af9f2012621550b585d7a74614291ea8 Mon Sep 17 00:00:00 2001
From: Alexandre Aubin <alex.aubin@mailoo.org>
Date: Mon, 27 May 2024 20:19:25 +0200
Subject: [PATCH] helpers 2.1: drop ynh_find_port, ynh_port_available,
 ynh_validate_ip4/6, keep only ynh_validate_ip

---
 helpers/helpers.v2.1.d/network | 127 ---------------------------------
 helpers/helpers.v2.1.d/utils   |  31 ++++++++
 2 files changed, 31 insertions(+), 127 deletions(-)
 delete mode 100644 helpers/helpers.v2.1.d/network

diff --git a/helpers/helpers.v2.1.d/network b/helpers/helpers.v2.1.d/network
deleted file mode 100644
index c7acf2cce..000000000
--- a/helpers/helpers.v2.1.d/network
+++ /dev/null
@@ -1,127 +0,0 @@
-#!/bin/bash
-
-# Find a free port and return it
-#
-# [packagingv1]
-#
-# usage: ynh_find_port --port=begin_port
-# | arg: -p, --port=    - port to start to search
-# | ret: the port number
-#
-# example: port=$(ynh_find_port --port=8080)
-#
-# Requires YunoHost version 2.6.4 or higher.
-ynh_find_port() {
-    # ============ Argument parsing =============
-    local -A args_array=([p]=port=)
-    local port
-    ynh_handle_getopts_args "$@"
-    # ===========================================
-
-    test -n "$port" || ynh_die --message="The argument of ynh_find_port must be a valid port."
-    while ! ynh_port_available --port=$port; do
-        port=$((port + 1))
-    done
-    echo $port
-}
-
-# Test if a port is available
-#
-# [packagingv1]
-#
-# usage: ynh_find_port --port=XYZ
-# | arg: -p, --port=    - port to check
-# | ret: 0 if the port is available, 1 if it is already used by another process.
-#
-# example: ynh_port_available --port=1234 || ynh_die --message="Port 1234 is needs to be available for this app"
-#
-# Requires YunoHost version 3.8.0 or higher.
-ynh_port_available() {
-    # ============ Argument parsing =============
-    local -A args_array=([p]=port=)
-    local port
-    ynh_handle_getopts_args "$@"
-    # ===========================================
-
-    # Check if the port is free
-    if ss --numeric --listening --tcp --udp | awk '{print$5}' | grep --quiet --extended-regexp ":$port$"; then
-        return 1
-    # This is to cover (most) case where an app is using a port yet ain't currently using it for some reason (typically service ain't up)
-    elif grep -q "port: '$port'" /etc/yunohost/apps/*/settings.yml; then
-        return 1
-    else
-        return 0
-    fi
-}
-
-# Validate an IP address
-#
-# [internal]
-#
-# usage: ynh_validate_ip --family=family --ip_address=ip_address
-# | ret: 0 for valid ip addresses, 1 otherwise
-#
-# example: ynh_validate_ip 4 111.222.333.444
-#
-# Requires YunoHost version 2.2.4 or higher.
-ynh_validate_ip() {
-    # http://stackoverflow.com/questions/319279/how-to-validate-ip-address-in-python#319298
-
-    # ============ Argument parsing =============
-    local -A args_array=([f]=family= [i]=ip_address=)
-    local family
-    local ip_address
-    ynh_handle_getopts_args "$@"
-    # ===========================================
-
-    [ "$family" == "4" ] || [ "$family" == "6" ] || return 1
-
-    python3 /dev/stdin <<EOF
-import socket
-import sys
-family = { "4" : socket.AF_INET, "6" : socket.AF_INET6 }
-try:
-    socket.inet_pton(family["$family"], "$ip_address")
-except socket.error:
-    sys.exit(1)
-sys.exit(0)
-EOF
-}
-
-# Validate an IPv4 address
-#
-# usage: ynh_validate_ip4 --ip_address=ip_address
-# | arg: -i, --ip_address=     - the ipv4 address to check
-# | ret: 0 for valid ipv4 addresses, 1 otherwise
-#
-# example: ynh_validate_ip4 111.222.333.444
-#
-# Requires YunoHost version 2.2.4 or higher.
-ynh_validate_ip4() {
-    # ============ Argument parsing =============
-    local -A args_array=([i]=ip_address=)
-    local ip_address
-    ynh_handle_getopts_args "$@"
-    # ===========================================
-
-    ynh_validate_ip --family=4 --ip_address=$ip_address
-}
-
-# Validate an IPv6 address
-#
-# usage: ynh_validate_ip6 --ip_address=ip_address
-# | arg: -i, --ip_address=  - the ipv6 address to check
-# | ret: 0 for valid ipv6 addresses, 1 otherwise
-#
-# example: ynh_validate_ip6 2000:dead:beef::1
-#
-# Requires YunoHost version 2.2.4 or higher.
-ynh_validate_ip6() {
-    # ============ Argument parsing =============
-    local -A args_array=([i]=ip_address=)
-    local ip_address
-    ynh_handle_getopts_args "$@"
-    # ===========================================
-
-    ynh_validate_ip --family=6 --ip_address=$ip_address
-}
diff --git a/helpers/helpers.v2.1.d/utils b/helpers/helpers.v2.1.d/utils
index 627124bb6..5c3e2b2f6 100644
--- a/helpers/helpers.v2.1.d/utils
+++ b/helpers/helpers.v2.1.d/utils
@@ -1037,3 +1037,34 @@ int_to_bool() {
 toml_to_json() {
     python3 -c 'import toml, json, sys; print(json.dumps(toml.load(sys.stdin)))'
 }
+
+# Validate an IP address
+#
+# usage: ynh_validate_ip --family=family --ip_address=ip_address
+# | ret: 0 for valid ip addresses, 1 otherwise
+#
+# example: ynh_validate_ip 4 111.222.333.444
+#
+# Requires YunoHost version 2.2.4 or higher.
+ynh_validate_ip() {
+    # ============ Argument parsing =============
+    local -A args_array=([f]=family= [i]=ip_address=)
+    local family
+    local ip_address
+    ynh_handle_getopts_args "$@"
+    # ===========================================
+
+    [ "$family" == "4" ] || [ "$family" == "6" ] || return 1
+
+    # http://stackoverflow.com/questions/319279/how-to-validate-ip-address-in-python#319298
+    python3 /dev/stdin <<EOF
+import socket
+import sys
+family = { "4" : socket.AF_INET, "6" : socket.AF_INET6 }
+try:
+    socket.inet_pton(family["$family"], "$ip_address")
+except socket.error:
+    sys.exit(1)
+sys.exit(0)
+EOF
+}