refs #521 - Modify sendFileUFTP.py

bin/sendFileUFTP.py

@@ -6,8 +6,10 @@ Este script envía mediante UFTP la imagen recibida como primer parámetro, al p
   a la velocidad de transferencia tambíén especificada en el segundo parámetro (la sintaxis de este parámetro es "puerto:ip:bitrate").
 Previamente, los clientes deben haberse puesto a escuchar en la IP Multicast correspondiente (tanto para envíos Multicast como para envíos Unicast).
 
-- Parámetros:
---------------
+Paquetes APT requeridos: "uftp"
+
+ Parámetros
+------------
 sys.argv[1] - Nombre completo de la imagen a enviar (con o sin ruta)
             - Ejemplo1: image1.img
             - Ejemplo2: /opt/opengnsys/images/image1.img
@@ -16,33 +18,42 @@ sys.argv[2] - Parámetros Multicast/Unicast (en formato "puerto:ip:bitrate")
             - Ejemplo1: 9000:239.194.17.2:100M
             - Ejemplo2: 9000:192.168.56.101:1G
 
-- Sintaxis:
+ Sintaxis
+----------
 ./sendFileUFTP.py image_name|/image_path/image_name port:ip:bitrate
 
-- Ejemplos:
+ Ejemplos
+ ---------
 ./sendFileUFTP.py image1.img 9000:239.194.17.2:100M
 ./sendFileUFTP.py /opt/opengnsys/images/image1.img 9000:192.168.56.101:1G
 """
 
+# --------------------------------------------------------------------------------------------
+#                                        IMPORTS
 # --------------------------------------------------------------------------------------------
 
 import os
 import sys
 import subprocess
 
+
+# --------------------------------------------------------------------------------------------
+#                                        VARIABLES
 # --------------------------------------------------------------------------------------------
 
 script_name = os.path.basename(__file__)
 repo_path = '/opt/opengnsys/images/'
-#REPO_IFACE = subprocess.getoutput('/opt/opengnsys/bin/getRepoIface') # Para poder ejecutar esto tengo que ejecutar el script con sudo, pero no sé si es necesario (de momento no lo estoy usando)
-#print(REPO_IFACE)
 log_file = '/opt/opengnsys/images/uftp.log'
 
+
+
+# --------------------------------------------------------------------------------------------
+#                                        FUNCTIONS
 # --------------------------------------------------------------------------------------------
 
 
 def show_help():
-    """ Imprime la ayuda (cuando se ejecuta el script con el parámetro "help").
+    """ Imprime la ayuda, cuando se ejecuta el script con el parámetro "help".
     """
     help_text = f"""
         Sintaxis: {script_name} image_name|/image_path/image_name port:ip:bitrate
@@ -52,18 +63,6 @@ def show_help():
     print(help_text)
 
 
-# Si se ejecuta el script con el parámetro "help", se muestra la ayuda, y se sale del script:
-if len(sys.argv) == 2 and sys.argv[1] == "help":
-    show_help()
-    sys.exit(0)
-
-
-# Si se ejecuta la función con más o menos de 2 parámetros, se muestra un mensaje de error, y se sale del script:
-if len(sys.argv) != 3:
-    print(f"{script_name} Error: Formato incorrecto: Se debe especificar 2 parámetros (image_name|/image_path/image_name port:ip:bitrate)")
-    sys.exit(1)
-
-
 def build_file_path():
     """ Construye la ruta completa al archivo a enviar
           (agregando "/opt/opengnsys/images/" si no se ha especificado en el parámetro).
@@ -76,12 +75,39 @@ def build_file_path():
     return file_path
 
 
+def calculate_bitrate(bitrate):
+    """ Calcula el valor de la variable "bitrate", en base a la letra especificada ("K", "M" o "G").
+        Luego elimina la letra y retorna el valor con tipo de datos "int".
+    """
+    bitrate = bitrate.lower()
+    if "m" in bitrate:
+        bitrate = int(bitrate.strip("m")) * 1024
+    elif "g" in bitrate:
+        bitrate = int(bitrate.strip("g")) * 1024 * 1024
+    else:
+        bitrate = int(bitrate.strip("k"))
+    return bitrate
+
+
+
+# --------------------------------------------------------------------------------------------
+#                                          MAIN
 # --------------------------------------------------------------------------------------------
 
 
 def main():
     """
     """
+    # Si se ejecuta el script con el parámetro "help", se muestra la ayuda, y se sale del script:
+    if len(sys.argv) == 2 and sys.argv[1] == "help":
+        show_help()
+        sys.exit(0)
+
+    # Si se ejecuta la función con más o menos de 2 parámetros, se muestra un mensaje de error, y se sale del script:
+    if len(sys.argv) != 3:
+        print(f"{script_name} Error: Formato incorrecto: Se debe especificar 2 parámetros (image_name|/image_path/image_name port:ip:bitrate)")
+        sys.exit(1)
+
     # Obtenemos la ruta completa al archivo a enviar:
     file_path = build_file_path()
 
@@ -100,15 +126,9 @@ def main():
     port, ip, bitrate = params
 
     # Calculamos el valor de la variable "bitrate", en base a la letra especificada (que luego eliminamos de la variable):
-    bitrate = bitrate.lower()
-    if "m" in bitrate:
-        bitrate = int(bitrate.strip("m")) * 1024
-    elif "g" in bitrate:
-        bitrate = int(bitrate.strip("g")) * 1024 * 1024
-    else:
-        bitrate = int(bitrate.strip("k"))
+    bitrate = calculate_bitrate(bitrate)
 
-    # Creamos una lista con el comando a enviar (esto es requerido por la función "subprocess.run"), e impimimos el comando con espacios:
+    # Creamos una lista con el comando a enviar (esto es requerido por la función "subprocess.run"), e imprimimos el comando con espacios:
     splitted_cmd = f"uftp -M {ip} -p {port} -L {log_file} -Y aes256-cbc -h sha256 -e rsa -c -K 1024 -R {bitrate} {file_path}".split()
 
     print(f"Sending command: {' '.join(splitted_cmd)}")
@@ -124,6 +144,7 @@ def main():
         print(f"Se ha producido un error inesperado: {error}")
 
 
+
 # --------------------------------------------------------------------------------------------
 
 if __name__ == "__main__":