[[TOC(heading=Índice)]]

= API de funciones de Hidra =

== Descripción ==

El interfaz web Hidra utilizará 2 tipos principales de funciones:
 * Funciones C incluidas en el código del cliente y del servidor.
 * Funciones y ''scripts'' BASH ejecutables por el cliente.

El desarrollo de las funciones debe cumplir el siguiente estilo:
 * Todos los nombres de funciones y variables deben ser descriptivos y fáciles de recordar.
 * Nombres de funciones al estilo Rembo-C, sólo con las iniciales en mayúsculas.
 * Para evitar inconsistencias y para mantener la compatibilidad con EAC, los nombres del as funciones Hidra tendrán el prefijo '''hidra'''.
 * Las constantes y variables globales deben ir escritas en mayúsculas.
 * Debe incluirse toda la información necesaria en las cabeceras de las funciones (descripción, formato, salidas, notas, etc.).
 * Deben incluirse comentarios descriptivos en los bloques de código.
 * La función Hidra llamará a la función correspondiente EAC, siempre que exista esta última y que cumpla los requisitos de funcionamiento.
 * En el caso de que una función EAC no devuelva el formato adecuado para el gestor Hidra, deberá desarrollarse una nueva función equivalente.

== Funciones internas C ==

...

== Funciones BASH ==

=== Funciones básicas ===

 * [./hidraEnviron hidraEnviron]
 * [./hidraDisk hidraDisk]
 * [./hidraTypeFS hidraTypeFS]
 * LocalIP
 * LocalMAC
 * !LocalName
 * Path

=== Funciones de particiones ===

 * [./hidraListPrimaryPartitions hidraListPrimaryPartitions]
 * [./hidraListLogicalPartitions hidraListLogicalPartitions]
 * [./hidraListPartitions hidraListPartitions]
 * [./hidraCreatePrimaryPartitions hidraCreatePrimaryPartitions]
 * [./hidraCreateLogicalPartitions hidraCreateLogicalPartitions]
 * [./hidraFormat hidraFormat]
 * [./hidraMount hidraMount]
 * [./hidraUnmount hidraUnmount]
 * !CacheDetect
 * !CacheMount

=== Funciones de clonación ===

 * !MakeDiskSnapshot
 * !RestoreDiskSnapshot
 * MakeMBRSnapshot
 * RestoreMBRSnapshot
 * [./hidraCreateImageFromPartition hidraCreateImageFromPartition]
 * [./hidraRestorePartitionFromImage hidraRestorePartitionFromImage]
 * !MakeLinuxSnapshot
 * !RestoreLinuxSnapshot
 * MakeNTFSSnapshot
 * RestoreNTFSSnapshot
 * MBRBoot
 * [./hidraBoot hidraBoot]
 * !PowerOff
 * !ShutDown

=== Funciones de edición o modificación ===

 * !ReadRegistryValue
 * !EditRegistryValue
 * !ListRegistryKeys
 * !SetWindowsName

=== Funciones de inventario ===

 * [./hidraHardwareInfo hidraHardwareInfo]
 * [./hidraOSVersion hidraOSVersion]
 * !WindowsSoftware

== Tabla de mnemónicos de tipos de particiones ==

||Identificador||Mnemónico||Tipo de partición||
||00           ||EMPTY    ||Partición vacía no definida||
||05           ||EXTENDED ||Partición extendida que puede contener varias particiones lógicas||
||06, 0e       ||BIGDOS   ||FAT16||
||07           ||NTFS     ||NTFS||
||0b, 0c       ||VFAT     ||FAT32||
||16, 1e       ||HBIGDOS  ||FAT16 oculta||
||17           ||HNTFS    ||NTFS oculta||
||1b, 1c       ||HVFAT    ||FAT32 oculta||
||82           ||LINUX-SWAP||Paginación para Linux (''swap'')||
||83           ||EXT2, EXT3, EXT4, REISERFS, REISER4||Partición Linux tipo Ext2, Ext3 o Ext4||
||8e           ||LINUX-LVM||Partición de volumen lógico para Linux||
||a7           ||CACHE    ||Caché local para EAC (se formateará como Ext3)||.
||fd           ||RAID-EXT2, RAID-EXT3, RAID-EXT4||Partición RAID para Linux tipo Ext2, Ext3 o Ext4||
||-            ||UNKNOWN  ||Tipo de partición desconocido.||

== Tabla de códigos de error ==

||Código||Descripción||
||   0  ||Ejecución correcta sin error||
||   1  ||Llamada incorrecta a la función o parámetros incorrectos||
||   2  ||Fichero, directorio o dispositivo no encontrado o inaccesible||
||   3  ||Tipo de partición erróneo o no reconocido||
||   4  ||Programa o función desconocido o no ejecutable||