mgvazquez/scabblibrary

Librería de bash

ScabbLibrary (v1.2)

Scabblibrary, es una pequeña libreria de funciones escritas en bash que nos facilita diversas tareas a la hora de escribir nuestros scripts. El archivo template_script.tar.gz contiene un template de script bash basado en Scabblibrary, junto con su correspondiente archivo de configuracion el cual se carga automaticamente el invocar el script (el archivo .config, debe tener el mismo nombre que el archivo del script).

Indice

• Funciones
  • chkPath();
  • chkProcess();
  • chkScriptIntegrity();
  • chkScriptVersion();
  • chkSsh();
  • chkSum();
  • debug();
  • doQuestionAndReadAnswer();
  • doQuestionAndReadSimpleAnswer();
  • getEnvironment();
  • getHour();
  • getSubstring();
  • gotConnected();
  • linexy();
  • log();
  • remplaceString();
  • rotateFile();
  • sendMail();
  • toLower();
  • toUpper();
• Variables
  • Generales
    • LIBRARY_VERSION
    • LIBRARY_FILE
    • LIBRARY_PATH
    • SCRIPT_FILE
    • SCRIPT_PATH
    • SCRIPT_CFG_FILE
    • SCRIPT_TITLE
    • TEMP_PATH
    • DATE
    • HOST_NAME
  • Tipograficas
    • ESC_CHAR
    • FONT_TP
    • FONT_FG
    • FONT_BG
  • Conectividad
    • CHKCONNECTION
    • GOTCONNECTED
  • Notificaciones
    • SEND_MAIL_NOTIFICATION
  • Logging
    • STDOUT_ENABLE
    • DEBUG_ENABLE
    • LOG_ENABLE
    • LOG_PATH
    • LOG_FILE
  • Otros
    • VERSION_CHECK
    • INTEGRITY_CHECK
    • WGET_TRIES
    • WGET_TIMEOUT
    • WGET_OPTIONS
    • WGET_DEBUG

---

Funciones

• chkPath();

  Chequea que el path indicado exista(1), tenga permisos de escritura(2) y permisos de lectura(3).

  chkPath "path a verificar"

• chkProcess();

  Chequea que exista al menos una instancia del proceso indicado. En caso de que exista al menos una devuelve 0, en caso contrario 1.

  chkProcess "nombre del proceso"

• chkScriptIntegrity();

  Realiza un checksum del script en el cual se esta instanciando (se puede especificar) contra un archivo '.sha' con el mismo nombre del script, para verificar que el mismo no haya sido alterado.
  Al ejecutarse sin parametros, utiliza valida el escript el cual se instancio; y busca el archivo '.sha' en el path por defecto '/var/tmp'.
  Puede ser deshabilitado seteando la variable $INTEGRITY_CHECK en false.

  chkScriptIntegrity "archivo a validar" "path del .sha"

• chkScriptVersion();

• chkSsh();

• chkSum();

• debug();

• doQuestionAndReadAnswer();

• doQuestionAndReadSimpleAnswer();

• getEnvironment();

• getHour();

• getSubstring();

• gotConnected();

• linexy();

• log();

• remplaceString();

• rotateFile();

• sendMail();

• toLower();

• toUpper();

Variables

Generales

• LIBRARY_VERSION (string)
• LIBRARY_FILE (string)
• LIBRARY_PATH (string)
• SCRIPT_FILE (string)
• SCRIPT_PATH (string)
• SCRIPT_CFG_FILE (string)
• SCRIPT_TITLE (string)
• TEMP_PATH (string)
• DATE (string)
• HOST_NAME (string)

Tipograficas

• ESC_CHAR (string)
• FONT_TP (array - String)
• FONT_FG (array - String)
• FONT_BG (array - String)

Conectividad

• CHKCONNECTION (boolean)
• GOTCONNECTED (boolean)

Notificaciones (Mail)

• SEND_MAIL_NOTIFICATION (boolean)

Logging

• STDOUT_ENABLE (boolean)
• DEBUG_ENABLE (boolean)
• LOG_ENABLE (boolean)
• LOG_PATH (string)
• LOG_FILE (string)

Otros

• VERSION_CHECK (boolean)
• INTEGRITY_CHECK (boolean)
• WGET_TRIES (int)
• WGET_TIMEOUT (int)
• WGET_OPTIONS (string)
• WGET_DEBUG (sting)

---