source: client/engine/File.lib @ eeade34

v1.2.0
Last change on this file since eeade34 was 62d6dd5, checked in by adv <adv@…>, 6 years ago

#853 Adapting File.lib library for doxygen

  • Property mode set to 100755
File size: 14.0 KB
Line 
1#!/bin/bash
2#/**
3#@file    File.lib
4#@brief   Librería o clase File
5#@class   File
6#@brief   Funciones para gestión de archivos y directorios.
7#@version 1.0.4
8#@warning License: GNU GPLv3+
9#*/
10
11
12#/**
13#         ogCalculateChecksum [ str_repo | int_ndisk int_npart ] path_filepath
14#@brief   Devuelve la suma de comprobación (checksum) de un fichero.
15#@param   path_filepath     camino del fichero (independiente de mayúsculas)
16#@param   str_repo          repositorio de ficheros
17#@param   int_ndisk         nº de orden del disco
18#@param   int_npartition    nº de orden de la partición
19#@return  hex_checksum      Checksum del fichero
20#@version 0.9.2 - Primera versión para OpenGnSys.
21#@author  Ramon Gomez, ETSII Universidad de Sevilla
22#@date    2010-07-24
23#@version 1.0.4 - Calcula solo el checksum del último MB del fichero.
24#@author  Ramon Gomez, ETSII Universidad de Sevilla
25#@date    2012-03-16
26#*/ ##
27function ogCalculateChecksum ()
28{
29# Variables locales.
30local FILE
31if [ "$*" == "help" ]; then
32    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_filepath" \
33           "$FUNCNAME REPO ubuntu.img  ==>  ef899299caf8b517ce36f1157a93d8bf"
34    return
35fi
36
37# Comprobar que existe el fichero y devolver sus datos.
38FILE=$(ogGetPath "$@")
39[ -n "$FILE" ] || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
40tail -c1M "$FILE" | md5sum -b 2>&1 | cut -f1 -d" "
41}
42
43
44#/**
45#         ogCompareChecksumFiles [ str_repo | int_ndisk int_npart ] path_source [ str_repo | int_ndisk int_npart ] path_target
46#@brief   Metafunción que compara las sumas de comprobación almacenadas de 2 ficheros.
47#@return  bool_compare   Valor de comparación.
48#@warning No es necesario especificar la extensión ".sum".
49#@version 0.9.2 - Primera versión para OpenGnSys.
50#@author  Ramon Gomez, ETSII Universidad de Sevilla
51#@date    2010-07-24
52#*/ ##
53function ogCompareChecksumFiles ()
54{
55# Variables locales.
56local ARGS SOURCE TARGET
57if [ "$*" == "help" ]; then
58    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_filepath" \
59           "if $FUNCNAME REPO ubuntu.img CACHE ubuntu.img; then ...;  fi"
60    return
61fi
62
63ARGS="$@"
64case "$1" in
65    /*)     # Camino completo.          */ (Comentrio Doxygen)
66        SOURCE=$(ogGetPath "$1")
67        shift ;;
68    [1-9]*) # ndisco npartición.
69        SOURCE=$(ogGetPath "$1" "$2" "$3")
70        shift 3 ;;
71    *)      # Otros: repo, cache, cdrom (no se permiten caminos relativos).
72        SOURCE=$(ogGetPath "$1" "$2")
73        shift 2 ;;
74esac
75TARGET=$(ogGetPath "$@")
76
77# Comparar los ficheros de checksum.
78test "$(cat "$SOURCE.sum" 2>/dev/null)" == "$(cat "$TARGET.sum" 2>/dev/null)"
79}
80
81
82#/**
83#         ogCalculateFullChecksum [ str_repo | int_ndisk int_npart ] path_filepath
84#@brief   Devuelve la suma COMPLETA de comprobación (checksum) de un fichero.
85#@param   path_filepath     camino del fichero (independiente de mayúsculas)
86#@param   str_repo          repositorio de ficheros
87#@param   int_ndisk         nº de orden del disco
88#@param   int_npartition    nº de orden de la partición
89#@return  hex_checksum      Checksum del fichero
90#@version 1.0.5 - Primera versión para OpenGnSys.
91#@author  Antonio Doblas Viso, EVLT Universidad de Málaga
92#@date    2014-07-09
93#*/ ##
94function ogCalculateFullChecksum ()
95{
96# Variables locales.
97local FILE
98if [ "$*" == "help" ]; then
99    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_filepath" \
100           "$FUNCNAME REPO ubuntu.img  ==>  ef899299caf8b517ce36f1157a93d8bf"
101    return
102fi
103
104# Comprobar que existe el fichero y devolver sus datos.
105FILE=$(ogGetPath "$@")
106[ -n "$FILE" ] || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
107#ADV
108md5sum "$FILE" -b 2>&1 | cut -f1 -d" "
109# tail -c1M "$FILE" | md5sum -b 2>&1 | cut -f1 -d" "
110}
111
112
113
114
115#/**
116#         ogCopyFile [ str_repo | int_ndisk int_npart ] path_source [ str_repo | int_ndisk int_npart ] path_target
117#@brief   Metafunción para copiar un fichero de sistema OpenGnSys a un directorio.
118#@see     ogGetPath
119#@return  Progreso de la copia.
120#@warning Deben existir tanto el fichero origen como el directorio destino.
121#@version 0.9 - Pruebas con OpenGnSys.
122#@author  Ramon Gomez, ETSII Universidad de Sevilla
123#@date    2009-10-20
124#@version 1.0.4 - Copiar usando rsync.
125#@author  Universidad de Huelva
126#@date    2012-07-06
127#*/ ##
128function ogCopyFile ()
129{
130# Variables locales.
131local ARGS SOURCE TARGET
132if [ "$*" == "help" ]; then
133    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_source [ str_repo | int_ndisk int_npartition ] path_target" \
134           "$FUNCNAME REPO newfile.txt 1 2 /tmp/newfile.txt"
135    return
136fi
137
138ARGS="$@"
139case "$1" in
140    /*)     # Camino completo.          */ (Comentrio Doxygen)
141        SOURCE="$(ogGetPath "$1")"
142        shift ;;
143    [1-9]*) # ndisco npartición.
144        SOURCE="$(ogGetPath "$1" "$2" "$3")"
145        shift 3 ;;
146    *)      # Otros: repo, cache, cdrom (no se permiten caminos relativos).
147        SOURCE="$(ogGetPath "$1" "$2")"
148        shift 2 ;;
149esac
150# Comprobar fichero origen y directorio destino.
151[ -n "$SOURCE" ] || ogRaiseError $OG_ERR_NOTFOUND "${ARGS% $*}" || return $?
152TARGET="$(ogGetPath "$@")"
153[ -n "$TARGET" ] || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
154# Copiar fichero (para evitar problemas de comunicaciones las copias se hacen con rsync en vez de cp).
155rsync --progress --inplace -avh "$SOURCE" "$TARGET"
156}
157
158
159#/**
160#         ogDeleteFile [ str_repo | int_ndisk int_npartition ] path_filepath
161#@brief   Metafunción que borra un fichero de un dispositivo.
162#@see     ogGetPath
163#@version 0.9 - Pruebas con OpenGnSys.
164#@author  Ramon Gomez, ETSII Universidad de Sevilla
165#@date    2009-09-29
166#*/ ##
167function ogDeleteFile ()
168{
169# Variables locales.
170local FILE
171if [ "$*" == "help" ]; then
172    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_file" \
173           "$FUNCNAME 1 2 /tmp/newfile.txt"
174    return
175fi
176
177# Comprobar que existe el fichero y borrarlo.
178FILE="$(ogGetPath "$@")"
179[ -n "$FILE" ] || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
180rm -f "$FILE" || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
181}
182
183
184#/**
185#         ogDeleteTree [ str_repo | int_ndisk int_npartition ] path_dirpath
186#@brief   Metafunción que borra todo un subárbol de directorios de un dispositivo.
187#@see     ogGetPath
188#@version 0.9 - Pruebas con OpenGnSys.
189#@author  Ramon Gomez, ETSII Universidad de Sevilla
190#@date    2009-09-29
191#*/ ##
192function ogDeleteTree ()
193{
194# Variables locales.
195local DIR
196if [ "$*" == "help" ]; then
197    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_dir" \
198           "$FUNCNAME 1 2 /tmp/newdir"
199    return
200fi
201
202# Comprobar que existe el directorio y borrarlo con su contenido.
203DIR="$(ogGetPath "$@")"
204[ -n "$DIR" ] || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
205rm -fr "$DIR" || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
206}
207
208
209#/**
210#         ogGetPath [ str_repo | int_ndisk int_npartition ] path_filepath
211#@brief   Inicia el proceso de arranque de un sistema de archivos.
212#@param   path_filepath   camino del fichero (independiente de mayúsculas)
213#@param   str_repo        repositorio de ficheros
214#@param   int_ndisk       nº de orden del disco
215#@param   int_npartition  nº de orden de la partición
216#@return  path_file - camino completo real del fichero.
217#@note    repo = { REPO, CACHE, CDROM }
218#@note    Requisitos: \c grep \c sed
219#@exception OG_ERR_FORMAT    Formato incorrecto.
220#@exception OG_ERR_NOTFOUND  Fichero o dispositivo no encontrado.
221#@exception OG_ERR_PARTITION Tipo de partición desconocido o no se puede montar.
222#@warning En caso de error, sólo devuelve el código y no da mensajes.
223#@todo    Terminar de definir parámetros para acceso a repositorios.
224#@version 0.1 -  Integracion para Opengnsys  -  HIDRA: CaminoWindows.sh; EAC: GetPath(), FormatSintaxSpacePath(), FormatSintaxBackSlashPath (),  en FileSystem.lib
225#@author Ramon Gomez, ETSII Universidad de Sevilla
226#@Date    2008/10/10
227#@author  Antonio J. Doblas Viso. Universidad de Malaga
228#@date    2008/10/27
229#@version 0.9 - Pruebas con OpenGnSys.
230#@author  Ramon Gomez, ETSII Universidad de Sevilla
231#@date    2009-09-15
232#@version 1.1.1 - Correccion comentarios autodocumentacion doxygen .
233#@author  Antonio J. Doblas Viso. Universidad de Malaga
234#@date    2018-07-05
235#*/ ##
236
237function ogGetPath ()
238{
239# Variables locales.
240local MNTDIR FILE PREVFILE FILEPATH CURRENTDIR
241
242# Si se solicita, mostrar ayuda.
243if [ "$*" == "help" ]; then
244    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_filepath" \
245           "$FUNCNAME \"/mnt/sda1/windows/system32\"  ==>  /mnt/sda1/WINDOWS/System32" \
246           "$FUNCNAME REPO /etc/fstab  ==>  /opt/opengnsys/images/etc/fstab" \
247           "$FUNCNAME 1 1 \"/windows/system32\"  ==>  /mnt/sda1/WINDOWS/System32"
248    return
249fi
250
251# Procesar camino según el número de parámetros.
252case $# in
253    1)  FILE="$1" ;;
254    2)  case "${1^^}" in
255            REPO)
256                FILE="$OGIMG/$2" ;;
257            CACHE)
258                MNTDIR="$(ogMountCache)" || return $?
259                FILE="$MNTDIR/$OGIMG/$2" ;;
260            CDROM)
261                MNTDIR="$(ogMountCdrom)" || return $?
262                FILE="$MNTDIR/$2" ;;
263            *)  ogRaiseError $OG_ERR_FORMAT
264                return $? ;;
265        esac ;;
266    3)  MNTDIR="$(ogMount $1 $2)" || return $?
267        FILE="$MNTDIR/$3" ;;
268    *)  ogRaiseError $OG_ERR_FORMAT
269        return $? ;;
270esac
271
272# Eliminar caracteres \c / duplicados y finales.
273       
274FILE="$(echo $FILE|sed -e 's/\(\/\)*\1/\//g; s/\/$//')"
275# Comprobar si existe el fichero para reducir tiempos.
276if [ -e "$FILE" ]; then
277    FILEPATH="$FILE"
278else
279    # Buscar el nombre correcto en cada subdirectorio del camino.
280    FILEPATH="/"
281
282    while [ "$FILE" != "$PREVFILE" ]; do
283        FILEPATH="$(ls -d "${FILEPATH%/}/${FILE%%/*}" 2>/dev/null || find "$FILEPATH" -maxdepth 1 -iname "${FILE%%/*}" -print 2>/dev/null)" #*/ (Comentario Doxygen)
284        PREVFILE="$FILE"
285        FILE="${FILE#*/}" 
286    done
287   
288fi
289[ -n "$FILEPATH" ] && echo "$FILEPATH"
290return 0
291}
292
293
294#/**
295#         ogGetParentPath [ str_repo | int_ndisk int_npartition ] path_filepath
296#@brief   Metafunción que devuelve el camino del directorio padre.
297#@see     ogGetPath
298#@version 0.9 - Pruebas con OpenGnSys.
299#@author  Ramon Gomez, ETSII Universidad de Sevilla
300#@date    2009-09-29
301#*/ ##
302
303function ogGetParentPath ()
304{
305local PARENT
306if [ "$*" == "help" ]; then
307    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_filepath" \
308           "$FUNCNAME \"/mnt/sda1/windows/system32\"  ==>  /mnt/sda1/WINDOWS" \
309           "$FUNCNAME REPO /etc/fstab  ==>  /opt/opengnsys/images/etc" \
310           "$FUNCNAME 1 1 \"/windows/system32\"  ==>  /mnt/sda1/WINDOWS"
311    return
312fi
313
314case $# in
315    1)  PARENT="$(dirname "$1")" ;;
316    2)  PARENT="$1 $(dirname "/$2")" ;;
317    3)  PARENT="$1 $2 $(dirname "/$3")" ;;
318    *)  ogRaiseError $OG_ERR_FORMAT
319        return $? ;;
320esac
321ogGetPath $PARENT
322}
323
324
325#/**
326#         ogIsNewerFile [ str_repo | int_ndisk int_npart ] path_source [ str_repo | int_ndisk int_npart ] path_target
327#@brief   Metafunción que indica se un fichero es más nuevo que otro.
328#@see     ogGetPath
329#@return  Código de salida: 0 - nuevo, 1 - antiguo o error
330#@warning Deben existir tanto el fichero origen como el destino.
331#@version 0.9.2 - Primera versión para OpenGnSys.
332#@author  Ramon Gomez, ETSII Universidad de Sevilla
333#@date    2010-07-24
334#@version 1.0.1 - Devolver falso en caso de error.
335#@author  Ramon Gomez, ETSII Universidad de Sevilla
336#@date    2011-05-18
337#*/ ##
338function ogIsNewerFile ()
339{
340# Variables locales.
341local ARGS SOURCE TARGET
342# Si se solicita, mostrar ayuda.
343if [ "$*" == "help" ]; then
344    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_source [ str_repo | int_ndisk int_npartition ] path_target" \
345           "if $FUNCNAME REPO ubuntu.img CACHE ubuntu.img; then ...  fi"
346    return
347fi
348
349ARGS="$@"
350case "$1" in
351    /*)     # Camino completo.          */ (Comentrio Doxygen)
352        SOURCE="$(ogGetPath "$1")"
353        shift ;;
354    [1-9]*) # ndisco npartición.
355        SOURCE="$(ogGetPath "$1" "$2" "$3")"
356        shift 3 ;;
357    *)      # Otros: repo, cache, cdrom (no se permiten caminos relativos).
358        SOURCE="$(ogGetPath "$1" "$2")"
359        shift 2 ;;
360esac
361# Comprobar que existen los ficheros origen y destino.
362[ -n "$SOURCE" ] || ogRaiseError $OG_ERR_NOTFOUND "${ARGS% $*}" || return 1
363TARGET=$(ogGetPath "$@")
364[ -n "$TARGET" ] || ogRaiseError $OG_ERR_NOTFOUND "$*" || return 1
365# Devolver si el primer fichero se ha modificado después que el segundo.
366test "$SOURCE" -nt "$TARGET"
367}
368
369
370#/**
371#         ogMakeChecksumFile [ str_repo | int_ndisk int_npart ] path_filepath
372#@brief   Metafunción que guarda el valor de comprobación de un fichero.
373#@see     ogCalculateChecksum
374#@warning Genera un fichero con extensión ".sum".
375#@version 0.9.2 - Primera versión para OpenGnSys.
376#@author  Ramon Gomez, ETSII Universidad de Sevilla
377#@date    2010-07-24
378#*/ ##
379function ogMakeChecksumFile ()
380{
381# Variables locales.
382local FILE
383if [ "$*" == "help" ]; then
384    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_filepath" \
385           "$FUNCNAME REPO ubuntu.img"
386    return
387fi
388
389# Comprobar que existe el fichero y guardar su checksum.
390FILE="$(ogGetPath "$@")"
391[ -n "$FILE" ] || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
392ogCalculateChecksum "$FILE" > "$FILE.sum"
393}
394
395
396#/**
397#         ogMakeDir [ str_repo | int_ndisk int_npartition ] path_dirpath
398#@brief   Metafunción que crea un subdirectorio vacío en un dispositivo.
399#@see     ogGetParentPath
400#@version 0.1 -  Integracion para Opengnsys  -   HIDRA: CrearDirectorio.sh, EAC: MkdirPath() en FileSystem.lib
401#@author Ramon Gomez, ETSII Universidad de Sevilla
402#@Date    2008/10/10
403#@author  Antonio J. Doblas Viso. Universidad de Malaga
404#@date    2008/10/27
405#@version 0.9 - Pruebas con OpenGnSys.
406#@author  Ramon Gomez, ETSII Universidad de Sevilla
407#@date    2009-09-29
408#*/ ##
409function ogMakeDir ()
410{
411local PARENT DIR
412if [ "$*" == "help" ]; then
413    ogHelp "$FUNCNAME" "$FUNCNAME [ str_repo | int_ndisk int_npartition ] path_dir" \
414           "$FUNCNAME 1 2 /tmp/newdir"
415    return
416fi
417
418PARENT="$(ogGetParentPath "$@")" || return $?
419DIR="$(basename "${!#}")"
420mkdir -p "$PARENT/$DIR" || ogRaiseError $OG_ERR_NOTFOUND "$*" || return $?
421}
422 
Note: See TracBrowser for help on using the repository browser.