\PONizer

PON devices management and monitoring implementation

Synopsis

class PONizer {

// constants
const SIGCACHE_PATH = OLTAttractor::SIGCACHE_PATH;
const SIGCACHE_EXT = OLTAttractor::SIGCACHE_EXT;
const DISTCACHE_PATH = OLTAttractor::DISTCACHE_PATH;
const DISTCACHE_EXT = OLTAttractor::DISTCACHE_EXT;
const ONUCACHE_PATH = OLTAttractor::ONUCACHE_PATH;
const ONUCACHE_EXT = OLTAttractor::ONUCACHE_EXT;
const INTCACHE_PATH = OLTAttractor::INTCACHE_PATH;
const INTCACHE_EXT = OLTAttractor::INTCACHE_EXT;
const INTDESCRCACHE_EXT = OLTAttractor::INTDESCRCACHE_EXT;
const FDBCACHE_PATH = OLTAttractor::FDBCACHE_PATH;
const FDBCACHE_EXT = OLTAttractor::FDBCACHE_EXT;
const DEREGCACHE_PATH = OLTAttractor::DEREGCACHE_PATH;
const DEREGCACHE_EXT = OLTAttractor::DEREGCACHE_EXT;
const UPTIME_PATH = OLTAttractor::UPTIME_PATH;
const UPTIME_EXT = OLTAttractor::UPTIME_EXT;
const TEMPERATURE_PATH = OLTAttractor::TEMPERATURE_PATH;
const TEMPERATURE_EXT = OLTAttractor::TEMPERATURE_EXT;
const MACDEVIDCACHE_PATH = OLTAttractor::MACDEVIDCACHE_PATH;
const MACDEVIDCACHE_EXT = OLTAttractor::MACDEVIDCACHE_EXT;
const ONUSIG_PATH = OLTAttractor::ONUSIG_PATH;
const POLL_PID = 'OLTPOLL_';
const POLL_STATS = 'exports/pondata/races/PONYRUN_';
const POLL_LOG = 'exports/oltpoll.log';
const SNMPCACHE = false;
const SNMPPORT = 161;
const TABLE_ONUS = 'pononu';
const TABLE_SWITCHES = 'switches';
const TABLE_ONUEXTUSERS = 'pononuextusers';
const KEY_ALLONU = 'ALLONU';
const KEY_ONUOLT = 'ONUOLTID_';
const KEY_ONULISTAJ = 'ONULISTAJ_';
const SNMP_TEMPLATES_PATH = 'config/snmptemplates/';
const SNMP_PRIVATE_TEMPLATES_PATH = 'documents/mysnmptemplates/';
const URL_ME = '?module=ponizer';
const URL_ONULIST = '?module=ponizer&onulist=true';
const URL_USERPROFILE = '?module=userprofile&username=';
const URL_SWITCH = '?module=switches&edit=';
const URL_ONU = '?module=ponizer&editonu=';
const ROUTE_GOTO_OLT = 'gotosomeoltid';
const COLOR_OK = '#005502';
const COLOR_AVG = '#FF5500';
const COLOR_BAD = '#AB0000';
const COLOR_NOSIG = '#000000';
const NO_SIGNAL = 'Offline';
const POLL_RUNNING = '🏁';

// members
protected array $allOnu = ;
protected array $onuMacIdList = ;
protected array $onuSerialIdList = ;
protected array $onuMacOltidList = ;
protected array $onuSerialOltidList = ;
protected array $allOnuExtUsers = ;
protected array $allModelsData = ;
protected array $allOltDevices = ;
protected array $allOltNames = ;
protected array $allOltModelIds = ;
protected array $allOltSnmp = ;
protected array $allOltIps = ;
protected array $allOltModels = ;
protected array $snmpTemplates = ;
protected array $signalCache = ;
protected array $distanceCache = ;
protected array $lastDeregCache = ;
protected array $onuIndexCache = ;
protected array $interfaceCache = ;
protected array $FDBCache = ;
protected array $onuMACDevIDCache = ;
protected array $uniOperStatsCache = ;
protected array $altCfg = ;
protected $snmp = '';
protected string $sup = '';
protected bool $EnableQuickOLTLinks = false;
protected bool $OLTIndividualRepollAJAX = false;
protected bool $ONUChartsSpoilerClosed = false;
protected bool $onuUknownUserByMACSearchShow = false;
protected integer $onuUknownUserByMACSearchIncrement = 0;
protected bool $onuUknownUserByMACSearchShowAlways = false;
protected bool $onuUknownUserByMACSearchTelepathy = false;
protected bool $ponizerUseTabUI = false;
protected string $onuMACValidateRegex = '/^([[:xdigit:]]{2}[\s:.-]?){5}[[:xdigit:]]{2}$/';
protected bool $validateONUMACEnabled = false;
protected boolean $replaceInvalidONUMACWithRandom = false;
protected bool $showPONIfaceDescrMainTab = false;
protected bool $showPONIfaceDescrStatsTab = false;
protected array $ponIfaceDescrCache = ;
protected $ubConfig = NULL;
protected array $hideOnuMac = ;
protected bool $ponIfDescribe = false;
protected bool $deferredLoadingFlag = false;
protected string $onuOfflineSignalLevel = '-9000';
public $ponInterfaces = '';
protected bool $ipColumnVisible = true;
protected bool $llidColVisibleUnknownONU = false;
protected bool $onuUniStatusEnabled = false;
protected bool $onuFDBShowLoginFlag = false;
protected bool $onuSerialCaseMode = 0;
protected array $existingOnuIdents = ;
protected $messages = '';
protected $cache = '';
protected integer $onuCacheTimeout = 0;
protected $oltData = '';
protected bool $supressOutput = false;
protected $onuDb = '';
protected $onuExtUsersDb = '';
protected $stardust = '';

// methods
public void __construct()
protected void loadAlter()
protected void initMessages()
protected void initOltAttractor()
protected void initOnuDb()
protected void initOnuExtUsersDb()
protected void initStarDust()
protected void loadOltDevices()
public array getAllOltDevices()
public array getAllOltIps()
public array getAllOltModelIds()
protected void loadOltModels()
protected void loadSnmpTemplates()
protected void initSNMP()
protected void initCache()
public int/bool getOnuIdByUser()
public array getOnuIdByUserAll()
protected array getOnuArrayByOltID()
public void pollOltSignal()
public void oltDevicesPolling()
protected bool isPollingNow()
protected array pollingStatsRead()
protected void pollingStatsUpdate()
public void logPoll()
protected bool isPollingLocked()
public string renderLogControls()
public string renderPollingLog()
public string renderOnuNavBar()
protected void loadOnu()
protected void loadOnuExtUsers()
public string getOltOnuCounts()
public array getOLTOverfilledInterfaces()
public int|array checkONUAssignment()
public array getAllOnu()
public int|0 getOnuIDbyIdent()
public array getUserByONUMAC()
protected void loadModels()
public array getAllModelsData()
protected string getModelName()
protected string getModelPorts()
public bool checkMacUnique()
public bool checkOnuUnique()
public void flushOnuCache()
public void flushOnuAjListCache()
public int|0 onuCreate()
public void onuSave()
public void onuAssign()
public void onuDelete()
protected string onuCreateForm()
public string onuRegisterForm()
protected string getSearchmacControl()
public string onuAssignForm()
protected array getOnuExtUsers()
public void deleteOnuExtUser()
protected string renderOnuExtUserForm()
public void createOnuExtUser()
public array getOnuData()
public array getOnuSignalLevelData()
protected string renderOnuSignalBig()
protected string renderOnuMiscStats()
protected string renderONUUniStats()
public void onuBurial()
public void onuResurrect()
public string onuEditForm()
protected string onuSignalHistory()
public string controls()
public string loadonuSignalHistory()
public string renderOnuList()
public string renderOltStats()
public string renderUnknownOnuList()
public string renderOnuFdbCache()
public string renderOltFdbList()
protected void loadSignalsCache()
protected void loadDistanceCache()
protected void loadLastDeregCache()
protected void loadInterfaceCache()
protected void loadPONIfaceDescrCache()
protected void loadFDBCache()
protected void loadUniOperStatsCache()
protected void fillONUIndexCache()
public array|string getUnknownONUMACList()
public void ajaxOnuUnknownData()
protected string getOltOnuRenderMode()
public void ajaxOnuData()
public void ajaxOltFdbData()
protected bool checkOnuOLTid()
protected bool checkOnuUserAssign()
public void ajaxFdbCacheList()
public void fixOnuOltAssigns()
public string renderCpeUserControls()
public array getAllONUSignalsById()
public static array getAllONUSignals()
public array getAllONUDeregReasons()
protected string getRandomMac()
public bool validateONUMAC()
protected string validatedMac()
protected array reviewDataSet()
public string renderOnuSearchForm()
public string renderOnuSearchResult()
protected string renderOnuArray()
public float|int|string getONURealtimeSignal()
public array getONUExtenInfo()
public bool|string getOLTUptime()
public string convertBDCOMTime()
public void checkONUAssignmentReply()
protected array getOnuUnknownAll()
public string renderBatchOnuRegList()
public string renderBatchOnuRegForm()
public string runBatchOnuRegister()

}

Constants

Name	Value
SIGCACHE_PATH	OLTAttractor::SIGCACHE_PATH
SIGCACHE_EXT	OLTAttractor::SIGCACHE_EXT
DISTCACHE_PATH	OLTAttractor::DISTCACHE_PATH
DISTCACHE_EXT	OLTAttractor::DISTCACHE_EXT
ONUCACHE_PATH	OLTAttractor::ONUCACHE_PATH
ONUCACHE_EXT	OLTAttractor::ONUCACHE_EXT
INTCACHE_PATH	OLTAttractor::INTCACHE_PATH
INTCACHE_EXT	OLTAttractor::INTCACHE_EXT
INTDESCRCACHE_EXT	OLTAttractor::INTDESCRCACHE_EXT
FDBCACHE_PATH	OLTAttractor::FDBCACHE_PATH
FDBCACHE_EXT	OLTAttractor::FDBCACHE_EXT
DEREGCACHE_PATH	OLTAttractor::DEREGCACHE_PATH
DEREGCACHE_EXT	OLTAttractor::DEREGCACHE_EXT
UPTIME_PATH	OLTAttractor::UPTIME_PATH
UPTIME_EXT	OLTAttractor::UPTIME_EXT
TEMPERATURE_PATH	OLTAttractor::TEMPERATURE_PATH
TEMPERATURE_EXT	OLTAttractor::TEMPERATURE_EXT
MACDEVIDCACHE_PATH	OLTAttractor::MACDEVIDCACHE_PATH
MACDEVIDCACHE_EXT	OLTAttractor::MACDEVIDCACHE_EXT
ONUSIG_PATH	OLTAttractor::ONUSIG_PATH
POLL_PID	'OLTPOLL_'
POLL_STATS	'exports/pondata/races/PONYRUN_'
POLL_LOG	'exports/oltpoll.log'
SNMPCACHE	false
SNMPPORT	161
TABLE_ONUS	'pononu'
TABLE_SWITCHES	'switches'
TABLE_ONUEXTUSERS	'pononuextusers'
KEY_ALLONU	'ALLONU'
KEY_ONUOLT	'ONUOLTID_'
KEY_ONULISTAJ	'ONULISTAJ_'
SNMP_TEMPLATES_PATH	'config/snmptemplates/'
SNMP_PRIVATE_TEMPLATES_PATH	'documents/mysnmptemplates/'
URL_ME	'?module=ponizer'
URL_ONULIST	'?module=ponizer&onulist=true'
URL_USERPROFILE	'?module=userprofile&username='
URL_SWITCH	'?module=switches&edit='
URL_ONU	'?module=ponizer&editonu='
ROUTE_GOTO_OLT	'gotosomeoltid'
COLOR_OK	'#005502'
COLOR_AVG	'#FF5500'
COLOR_BAD	'#AB0000'
COLOR_NOSIG	'#000000'
NO_SIGNAL	'Offline'
POLL_RUNNING	'🏁'

Members

protected

$EnableQuickOLTLinks — bool
Are QuickOLTLinks enabled?
$FDBCache — array
Contains FDB indexes cache as id=>mac
$OLTIndividualRepollAJAX — bool
Are OLTs polled individually via AJAX?
$ONUChartsSpoilerClosed — bool
Is PON signal history charts spoiler initially closed?
$allModelsData — array
OLT models data as id=>model data array
$allOltDevices — array
All available OLT devices as id=>ip - location
$allOltIps — array
OLT devices IPs as id=>ip
$allOltModelIds — array
Contains all OLT devices id=>modelId mappings
$allOltModels — array
Available OLT models as id=>modelname + snmptemplate + ports
$allOltNames — array
All available OLT devices locations as id=>location
$allOltSnmp — array
OLT devices snmp data as id=>snmp data array
$allOnu — array
All available ONU devices as id=>onudata
$allOnuExtUsers — array
Contains array of additional ONU users as id=>binddata
$altCfg — array
System alter.ini config stored as key=>value
$cache —
System caching object placeholder

$deferredLoadingFlag — bool
Deferred loading flag
$distanceCache — array
Contains current ONU signal cache data as mac=>distance
$existingOnuIdents — array
Contains all busy ONU MAC/serials as lowercase onuIdent=>onuId
$hideOnuMac — array
Array of MAC address of ONU devices which will be hidden from unknown ONU list
$interfaceCache — array
Contains ONU indexes cache as mac=>interface
$ipColumnVisible — bool
IP column rendering flag
$lastDeregCache — array
Contains current ONU last dereg reasons cache data as mac=>last dereg reason
$llidColVisibleUnknownONU — bool
Placeholder for PON_UKNKOWN_ONU_LLID_SHOW alter.ini option
$messages —
System message helper object placeholder

$oltData —
Contains instance of OltAttractor

$onuCacheTimeout — int
Onu data caching timeout

$onuDb —
ONUs database abstraction layer

$onuExtUsersDb —
ONUs database abstraction layer

$onuFDBShowLoginFlag — bool
Shows user login in ONU FDB flag
$onuIndexCache — array
Contains ONU indexes cache as mac=>oltid
$onuMACDevIDCache — array
Contains ONU devices indexes cache as mac => devID
$onuMACValidateRegex — string
Placeholder for onu MAC validation regex
$onuMacIdList — array
List for mac = id
$onuMacOltidList — array
List for mac = oltid
$onuOfflineSignalLevel — string
Placeholder for PON_ONU_OFFLINE_SIGNAL alter.ini option
$onuSerialCaseMode — bool
Placeholder for PON_ONU_SERIAL_CASE_MODE alter.ini option 0 - no case convert 1 - lowercase 2 - uppercase
$onuSerialIdList — array
List for serial = id
$onuSerialOltidList — array
List for serial = oltid
$onuUknownUserByMACSearchIncrement — string
Increment for user search by MAC telepathy for unknown ONU registering form
$onuUknownUserByMACSearchShow — bool
Is user search by MAC for unknown ONU registering form enabled?
$onuUknownUserByMACSearchShowAlways — bool
Is user search by MAC for unknown ONU registering form enabled mandatory?
$onuUknownUserByMACSearchTelepathy — bool
Is user search by MAC telepathy for unknown ONU registering form enabled?
$onuUniStatusEnabled — bool
Placeholder for PON_ONU_UNI_STATUS_ENABLED alter.ini option
$ponIfDescribe — bool
OLT intefaces manual descriptions flag
$ponIfaceDescrCache — array
Contains OLT PON interfaces description as $oltID => array($cleanIfaceName => $ifaceDescr)
$ponizerUseTabUI — bool
Is tab UI for ponizer active?
$replaceInvalidONUMACWithRandom — string
Replace ONU's MAC if invalid with a random one?
$showPONIfaceDescrMainTab — bool
Show PON interfaces descriptions in main ONU list tab if present?
$showPONIfaceDescrStatsTab — bool
Show PON interfaces descriptions in OLT stats tab if present?
$signalCache — array
Contains current ONU signal cache data as mac=>signal
$snmp —
SNMPHelper object instance

$snmpTemplates — array
Contains available SNMP templates for OLT modelids as modelId=>snmpTemplateData

$stardust —
Contains process manager instance

$sup — string
Prepared HTML for asterisk determining mandatory form field

$supressOutput — bool
Quiet mode flag
$ubConfig —
Placeholder for UbillingConfig object

$uniOperStatsCache — array
Contains ONU UNI ports cache as MAC/Serial => (EtherPort => Status)

$validateONUMACEnabled — bool
Perform ONU MAC validation against $onuMACValidateRegex?

public

$ponInterfaces —
PON interfaces object placeholder

Methods

protected

checkOnuOLTid() — Checks is ONU really associated with some OLT
checkOnuUserAssign() — Checks is ONU associated with some login or not
fillONUIndexCache() — Fills onuIndexCache array
getModelName() — Returns model name by its id
getModelPorts() — Returns model ports count by its id
getOltOnuRenderMode() — Returns state of ONU_RENDER_MODE misc section option for some olt, if it exists.
getOnuArrayByOltID() — Returns array of ONUs assigned on some OLT
getOnuExtUsers() — Returns array of additional ONU assigned users
getOnuUnknownAll() — Returns filtered array of unknown ONUs as mac/serial=>oltId
getRandomMac() — Just generates random MAC address to replace invalid ONU MAC
getSearchmacControl() — returns vendor by MAC search control if this enabled in config
initCache() — Inits system caching engine
initMessages() — Inits system messages helper for further usage
initOltAttractor() — Inits anonymous OLT attractor instance for further usage
initOnuDb() — Inits ONUs database abstraction layer
initOnuExtUsersDb() — Inits ONUs additional users database abstraction layer
initSNMP() — Creates single instance of SNMPHelper object
initStarDust() — Inits process manager
isPollingLocked() — Performs check of OLT polling lock via DB.
isPollingNow() — Fast check some OLT for running collector process.
loadAlter() — Loads system alter.ini config into private data property
loadDistanceCache() — Loads ONU distance cache
loadFDBCache() — Loads OLT FDB cache
loadInterfaceCache() — Loads ONU interface cache
loadLastDeregCache() — Loads ONU last dereg reasons cache
loadModels() — Loads available device models from database
loadOltDevices() — Loads all available devices set as OLT
loadOltModels() — Loads all available snmp models data into private data property
loadOnu() — Loads avaliable ONUs from database into private data property
loadOnuExtUsers() — Loads avaliable ONUs additional users bindings from database into private data property
loadPONIfaceDescrCache() — Loads available OLTs PON interfaces descriptions
loadSignalsCache() — Loads existing signal cache from FS
loadSnmpTemplates() — Performs SNMP templates preprocessing for OLT devices
loadUniOperStatsCache()
onuCreateForm() — Returns ONU creation form
onuSignalHistory() — Renders ONU signal history chart
pollingStatsRead() — Returns polling stats for some OLT
pollingStatsUpdate() — Updates some OLT polling stats
renderONUUniStats() — Renders ONU UNI port operational status if available
renderOnuArray() — Renders ONU Array just as table list with some controls
renderOnuExtUserForm() — Renders additional user creation form
renderOnuMiscStats() — Renders ONU interface, distance and last dereg reason if available
renderOnuSignalBig() — Returns styled current ONU signal
reviewDataSet() — Performs validation of some data set if required as onuMac=>someValue
validatedMac() — Returns validated MAC or replaces it with random one

public

__construct() — Creates new PONizer object instance
ajaxFdbCacheList() — Renders json for current all OLT FDB list
ajaxOltFdbData() — Renders json formatted data for jquery data tables list
ajaxOnuData() — Renders json formatted data for jquery data tables list with ONU signals list
ajaxOnuUnknownData() — Renders json formatted data about unregistered ONU
checkMacUnique() — Check ONU MAC address unique or not?
checkONUAssignment() — Returns int for ONU has or has not some of subscribers login assignment May return array with status, login and OLT location and IP
checkONUAssignmentReply() — Performs reply on ONU assigment check
checkOnuUnique() — Check ONU MAC address or Serial unique or not?
controls() — Returns default list controls
convertBDCOMTime() — Tries to make BDCOM Reg/Dereg dates human readable
createOnuExtUser() — Creates new ONU additional user binding
deleteOnuExtUser() — Deletes existing user binding to ONU by user Id
fixOnuOltAssigns() — Automatically fixes ONU to OLT associations due the actual FDB cache data
flushOnuAjListCache() — Flushes some OLT precached list
flushOnuCache() — Flushes all ONU related cache keys
getAllModelsData() — Getter for allModelsData array
getAllONUDeregReasons() — Return all of last dereg reasons as userLogin=>deregReason[raw/styled]
getAllONUSignals() — Returns ONU signals array like: $userLogin => $onuSignal
getAllONUSignalsById() — Returns ONU signals array like: $onuId => $onuSignal
getAllOltDevices() — Getter for allOltDevices array
getAllOltIps() — Retrieves all OLT IP addresses.
getAllOltModelIds() — Retrieves all OLT model IDs.
getAllOnu() — Getter for loaded ONU devices as id=>onuData
getOLTOverfilledInterfaces() — Returns OLT PON interfaces with ONU count at or above port capacity limit as array oltid/ip/name/interface/count
getOLTUptime() — Tries to return the current "realtime" OLT uptime value
getONUExtenInfo() — Tries to return some of the extended "realtime" ONU info, like Tx signal, last reg/dereg time, alive time
getONURealtimeSignal() — Tries to return the current "realtime" ONU signal value
getOltOnuCounts() — Returns Available OLT devices ONU counts
getOnuData() — Returns existing ONU data or empty array if it not exists
getOnuIDbyIdent() — Returns ONU ID by ONU MAC or serial
getOnuIdByUser() — Try to detect ONU id by assigned users login
getOnuIdByUserAll() — Trys to detect all ONU IDs by assigned users login as idx=>onuId
getOnuSignalLevelData() — Returns some ONU signal level as array with following keys: raw/color/type/styled/isoffline
getUnknownONUMACList() — Returns array of unknown ONUs MACs which can be filtered by OLT ID and returned just like simple array or formed HTML selector ready to use on web page
getUserByONUMAC() — Performs search in nethosts for a MAC and a login linked to it
loadonuSignalHistory() — Returns ONU signal history chart
logPoll() — Performs logging of OLT polling
oltDevicesPolling() — Performs available OLT devices polling. Use only in remote API.
onuAssign() — Assigns exinsting ONU with some login
onuAssignForm() — Renders ONU assigning form
onuBurial() — Performs burial of some ONU
onuCreate() — Creates new ONU in database and returns it Id or 0 if action fails
onuDelete() — Deletes onu from database by its ID
onuEditForm() — Returns ONU edit form aka "ONU profile"
onuRegisterForm() — Returns ONU fast registration form
onuResurrect() — Performs resurrection of some buried ONU
onuSave() — Saves ONU changes into database
pollOltSignal() — Performs OLT device polling via PON HAL instance
renderBatchOnuRegForm() — Renders batch unknown ONU registration form
renderBatchOnuRegList() — Renders batch unknown ONU registration list
renderCpeUserControls() — Returns ONU create and assign form for user profile module
renderLogControls() — Returns some polllog viewer controls
renderOltFdbList() — Renders OLT FDB list container
renderOltStats() — Renders OLT stats
renderOnuFdbCache() — Returns current FDB cache list container with controls
renderOnuList() — Renders available ONU JQDT list container
renderOnuNavBar() — Renders some ONUs navigation list
renderOnuSearchForm() — Renders ONU search form
renderOnuSearchResult() — Catches ONU search request and renders some result
renderPollingLog() — Renders last lines from OLT polling log
renderUnknownOnuList() — Renders unknown ONU list container
runBatchOnuRegister() — Performs batch unknown ONUs registration
validateONUMAC() — Validate ONUs MAC against regex and return bool value