\Envy

Equipment configuration backup aka Envy implementation

Synopsis

class Envy {

• // constants
• const URL_ME = '?module=envy';
• const TMP_PATH = 'exports/';
• const SCRIPT_PREFIX = 'ENVYSCRIPT_';
• const DL_PREFIX = 'ENVYCONFIG_';
• const ROUTE_SCRIPTS = 'scriptsmgr';
• const ROUTE_DEVICES = 'devicesmgr';
• const ROUTE_DIFF = 'diff';
• const ROUTE_SCRIPT_CREATE = 'scriptcreate';
• const ROUTE_SCRIPT_EDIT = 'scriptedit';
• const ROUTE_DEVICE_CREATE = 'devicecreate';
• const ROUTE_DEVICE_EDIT = 'deviceedit';
• const ROUTE_ARCHVIEW = 'viewarchiveid';
• const ROUTE_ARCHALL = 'archiveall';
• const ROUTE_ARCHIVE_AJ = 'ajarchive';
• const ROUTE_FILTER = 'devicefilter';
• const ROUTE_CLEANUP = 'cleanuparchive';
• const ENVYPROC_PID = 'ENVYPROC_';
• // members
• protected  $ubConfig = '';
• protected array $billCfg = ;
• protected array $altCfg = ;
• protected array $allModels = ;
• protected array $allDevices = ;
• protected array $allScripts = ;
• protected arrays $allSwitches = ;
• protected array $allConfigs = ;
• protected  $devices = '';
• protected  $scripts = '';
• protected  $archive = '';
• protected  $messages = '';
• protected  $stardust = '';
• protected bool $cmirrFlag = false;
• // methods
• public void __construct()
• protected  loadConfigs()
• protected void loadAlter()
• protected void initMessages()
• protected void initDevices()
• protected void initScrips()
• protected void initArchive()
• protected void initStarDust()
• protected bool isProcessLocked()
• protected void processStatsUpdate()
• protected void loadDevices()
• protected void loadScripts()
• protected void loadDeviceModels()
• protected void loadSwitches()
• protected void loadArchive()
• public string renderScriptCreateForm()
• public string renderScriptEditForm()
• public void/string createScript()
• public void/string saveScript()
• public void/string deleteScript()
• public string renderScriptsList()
• public string renderControls()
• public string renderDeviceCreateForm()
• public string renderDeviceEditForm()
• public string createDevice()
• public void/string saveDevice()
• public void/string deleteDevice()
• protected string getLastConfigDate()
• public string renderDevicesList()
• protected string parseMacro()
• public string runDeviceScript()
• public string previewScriptsResult()
• public string renderArchiveFilterForm()
• public string renderArchive()
• public void getAjArchive()
• protected void/string storeArchiveData()
• public void/string deleteArchiveRecord()
• public string renderArchiveRecordConfig()
• public void downloadArchiveRecordConfig()
• public void procStoreArchiveData()
• public void storeArchiveAllDevices()
• public string renderDiffForm()
• public string renderDiff()
• public void cleanupArchive()
}


Constants

Name	Value
URL_ME	'?module=envy'
TMP_PATH	'exports/'
SCRIPT_PREFIX	'ENVYSCRIPT_'
DL_PREFIX	'ENVYCONFIG_'
ROUTE_SCRIPTS	'scriptsmgr'
ROUTE_DEVICES	'devicesmgr'
ROUTE_DIFF	'diff'
ROUTE_SCRIPT_CREATE	'scriptcreate'
ROUTE_SCRIPT_EDIT	'scriptedit'
ROUTE_DEVICE_CREATE	'devicecreate'
ROUTE_DEVICE_EDIT	'deviceedit'
ROUTE_ARCHVIEW	'viewarchiveid'
ROUTE_ARCHALL	'archiveall'
ROUTE_ARCHIVE_AJ	'ajarchive'
ROUTE_FILTER	'devicefilter'
ROUTE_CLEANUP	'cleanuparchive'
ENVYPROC_PID	'ENVYPROC_'

Members

protected

• $allConfigs — array
  Contains all available previously stored device configs from db as id=>recordData
• $allDevices — array
  Contains filtered devices which need to be backuped as switchid=>data
• $allModels — array
  Contains all available devices models
• $allScripts — array
  Contains available envy-scripts as modelid=>data
• $allSwitches — arrays
  Contain all available switches as switchid=>data
• $altCfg — array
  System alter.ini config stored as key=>value
• $archive —
  Envy archive data model placeholder
• $billCfg — array
  Contains system billing.ini config as key=>value
• $cmirrFlag — bool
  Is CodeMirror editor enabled flag
• $devices —
  Envy devices data model placeholder
• $messages —
  System messages helper object placeholder
• $scripts —
  Envy scripts data model placeholder
• $stardust —
  Contains process manager instance
• $ubConfig —
  Contains system ubillingConfig object instance

Methods

protected

• getLastConfigDate() — Returns last envy-device configuration date
• initArchive() — Creates new archive data model instance
• initDevices() — Creates new devices data model instance
• initMessages() — Creates new message helper instance
• initScrips() — Creates new scrips data model instance
• initStarDust() — Inits process manager
• isProcessLocked() — Performs check of Switch envy process lock via DB.
• loadAlter() — Loads system alter.ini config into private data property and sets some flags
• loadArchive() — Loads existing archive records from database
• loadConfigs() — Loads all required configs into protected props
• loadDeviceModels() — Loads available device models from database
• loadDevices() — Loads all available envy devices from database for further usage
• loadScripts() — Loads all available envy scripts from database for further usage
• loadSwitches() — Loads all existing swithes directory from database into protected prop
• parseMacro() — Returns deivice polling script with preprocessed macro data
• processStatsUpdate() — Updates some Switch process stats
• storeArchiveData() — Saves device config data into archive

public

• __construct() — Creates new envy sin instance
• cleanupArchive() — Deletes all records from archive except the last one for each of envy-devices
• createDevice() — Creates new device in database
• createScript() — Creates new envy script preset in database
• deleteArchiveRecord() — Deletes existing archive record from daabase
• deleteDevice() — Deletes existing envy device from database
• deleteScript() — Deletes existing envy script from database
• downloadArchiveRecordConfig() — Downloads record file
• getAjArchive() — Renders background JSON data for existing configs archive
• previewScriptsResult() — Renders script results preview
• procStoreArchiveData() — Start process for get and store config data
• renderArchive() — Renders previously envy data arhive container
• renderArchiveFilterForm() — Renders form for filtering some envy-device in archive
• renderArchiveRecordConfig() — Returns device config saved in some archive record
• renderControls() — Renders default controls panel for module
• renderDeviceCreateForm() — Renders new device creation form
• renderDeviceEditForm() — Renders device editing form for existing envy-device
• renderDevicesList() — Renders available envy-devices with some their params
• renderDiff() — Compares some two existing configs from archive and displays diff results
• renderDiffForm() — Renders diff search form
• renderScriptCreateForm() — Renders envy-script creation form
• renderScriptEditForm() — Renders envy-script editing form
• renderScriptsList() — Renders available envy scripts and some controls
• runDeviceScript() — Runs envy script for some envy device and returns script result
• saveDevice() — Catches device editing request and saves changes in database
• saveScript() — Saves changes in envy script
• storeArchiveAllDevices() — Stores all available envy-devices configs into archive