Implemented seperate access rights for reading Agent data, SNMP data and taking scree...
[public/netxms.git] / src / server / include / nms_objects.h
1 /*
2 ** NetXMS - Network Management System
3 ** Copyright (C) 2003-2017 Victor Kirhenshtein
4 **
5 ** This program is free software; you can redistribute it and/or modify
6 ** it under the terms of the GNU General Public License as published by
7 ** the Free Software Foundation; either version 2 of the License, or
8 ** (at your option) any later version.
9 **
10 ** This program is distributed in the hope that it will be useful,
11 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ** GNU General Public License for more details.
14 **
15 ** You should have received a copy of the GNU General Public License
16 ** along with this program; if not, write to the Free Software
17 ** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 **
19 ** File: nms_objects.h
20 **
21 **/
22
23 #ifndef _nms_objects_h_
24 #define _nms_objects_h_
25
26 #include <nms_agent.h>
27 #include <netxms_maps.h>
28 #include <geolocation.h>
29 #include <jansson.h>
30 #include "nxcore_jobs.h"
31 #include "nms_topo.h"
32
33 /**
34 * Forward declarations of classes
35 */
36 class ClientSession;
37 class Queue;
38 class DataCollectionTarget;
39
40 /**
41 * Global variables used by inline methods
42 */
43 extern UINT32 g_dwDiscoveryPollingInterval;
44 extern UINT32 g_dwStatusPollingInterval;
45 extern UINT32 g_dwConfigurationPollingInterval;
46 extern UINT32 g_dwRoutingTableUpdateInterval;
47 extern UINT32 g_dwTopologyPollingInterval;
48 extern UINT32 g_dwConditionPollingInterval;
49 extern UINT32 g_instancePollingInterval;
50 extern INT16 g_defaultAgentCacheMode;
51
52 /**
53 * Utility functions used by inline methods
54 */
55 bool NXCORE_EXPORTABLE ExecuteQueryOnObject(DB_HANDLE hdb, UINT32 objectId, const TCHAR *query);
56
57 /**
58 * Constants
59 */
60 #define MAX_INTERFACES 4096
61 #define MAX_ATTR_NAME_LEN 128
62 #define INVALID_INDEX 0xFFFFFFFF
63
64 /**
65 * Last events
66 */
67 #define MAX_LAST_EVENTS 8
68
69 #define LAST_EVENT_NODE_DOWN 0
70 #define LAST_EVENT_AGENT_DOWN 1
71
72 /**
73 * Built-in object IDs
74 */
75 #define BUILTIN_OID_NETWORK 1
76 #define BUILTIN_OID_SERVICEROOT 2
77 #define BUILTIN_OID_TEMPLATEROOT 3
78 #define BUILTIN_OID_ZONE0 4
79 #define BUILTIN_OID_POLICYROOT 5
80 #define BUILTIN_OID_NETWORKMAPROOT 6
81 #define BUILTIN_OID_DASHBOARDROOT 7
82 #define BUILTIN_OID_BUSINESSSERVICEROOT 9
83
84 /**
85 * "All zones" pseudo-ID
86 */
87 #define ALL_ZONES ((UINT32)0xFFFFFFFF)
88
89 class AgentTunnel;
90
91 /**
92 * Extended agent connection
93 */
94 class NXCORE_EXPORTABLE AgentConnectionEx : public AgentConnection
95 {
96 protected:
97 UINT32 m_nodeId;
98 AgentTunnel *m_tunnel;
99 AgentTunnel *m_proxyTunnel;
100
101 virtual AbstractCommChannel *createChannel();
102 virtual void onTrap(NXCPMessage *msg);
103 virtual void onSyslogMessage(NXCPMessage *pMsg);
104 virtual void onDataPush(NXCPMessage *msg);
105 virtual void onFileMonitoringData(NXCPMessage *msg);
106 virtual void onSnmpTrap(NXCPMessage *pMsg);
107 virtual UINT32 processCollectedData(NXCPMessage *msg);
108 virtual UINT32 processBulkCollectedData(NXCPMessage *request, NXCPMessage *response);
109 virtual bool processCustomMessage(NXCPMessage *msg);
110
111 virtual ~AgentConnectionEx();
112
113 public:
114 AgentConnectionEx(UINT32 nodeId, const InetAddress& ipAddr, WORD port = AGENT_LISTEN_PORT, int authMethod = AUTH_NONE, const TCHAR *secret = NULL, bool allowCompression = true);
115 AgentConnectionEx(UINT32 nodeId, AgentTunnel *tunnel, int authMethod = AUTH_NONE, const TCHAR *secret = NULL, bool allowCompression = true);
116
117 UINT32 deployPolicy(AgentPolicy *policy);
118 UINT32 uninstallPolicy(AgentPolicy *policy);
119
120 void setTunnel(AgentTunnel *tunnel);
121
122 using AgentConnection::setProxy;
123 void setProxy(AgentTunnel *tunnel, int authMethod, const TCHAR *secret);
124 };
125
126 /**
127 * Poller types
128 */
129 enum PollerType
130 {
131 POLLER_TYPE_STATUS = 0,
132 POLLER_TYPE_CONFIGURATION = 1,
133 POLLER_TYPE_INSTANCE_DISCOVERY = 2,
134 POLLER_TYPE_ROUTING_TABLE = 3,
135 POLLER_TYPE_DISCOVERY = 4,
136 POLLER_TYPE_BUSINESS_SERVICE = 5,
137 POLLER_TYPE_CONDITION = 6,
138 POLLER_TYPE_TOPOLOGY = 7
139 };
140
141 /**
142 * Poller information
143 */
144 class NXCORE_EXPORTABLE PollerInfo
145 {
146 private:
147 PollerType m_type;
148 NetObj *m_object;
149 TCHAR m_status[128];
150
151 public:
152 PollerInfo(PollerType type, NetObj *object) { m_type = type; m_object = object; _tcscpy(m_status, _T("awaiting execution")); }
153 ~PollerInfo();
154
155 PollerType getType() const { return m_type; }
156 NetObj *getObject() const { return m_object; }
157 const TCHAR *getStatus() const { return m_status; }
158
159 void startExecution() { _tcscpy(m_status, _T("started")); }
160 void setStatus(const TCHAR *status) { nx_strncpy(m_status, status, 128); }
161 };
162
163 /**
164 * Status poll types
165 */
166 enum StatusPollType
167 {
168 POLL_ICMP_PING = 0,
169 POLL_SNMP = 1,
170 POLL_NATIVE_AGENT =2
171 };
172
173 /**
174 * Auto bind/apply decisions
175 */
176 enum AutoBindDecision
177 {
178 AutoBindDecision_Ignore = -1,
179 AutoBindDecision_Unbind = 0,
180 AutoBindDecision_Bind = 1
181 };
182
183 /**
184 * Zone types
185 */
186 #define ZONE_TYPE_PASSIVE 0
187 #define ZONE_TYPE_ACTIVE 1
188
189 /**
190 * Template update types
191 */
192 #define APPLY_TEMPLATE 0
193 #define REMOVE_TEMPLATE 1
194
195 /**
196 * Queued template update information
197 */
198 struct TEMPLATE_UPDATE_INFO
199 {
200 int updateType;
201 Template *pTemplate;
202 UINT32 targetId;
203 bool removeDCI;
204 };
205
206 /**
207 * Object index element
208 */
209 struct INDEX_ELEMENT
210 {
211 QWORD key;
212 NetObj *object;
213 };
214
215 /**
216 * Object index
217 */
218 class NXCORE_EXPORTABLE ObjectIndex
219 {
220 private:
221 int m_size;
222 int m_allocated;
223 INDEX_ELEMENT *m_elements;
224 RWLOCK m_lock;
225
226 int findElement(QWORD key);
227
228 public:
229 ObjectIndex();
230 ~ObjectIndex();
231
232 bool put(QWORD key, NetObj *object);
233 void remove(QWORD key);
234 NetObj *get(QWORD key);
235 NetObj *find(bool (*comparator)(NetObj *, void *), void *data);
236 ObjectArray<NetObj> *findObjects(bool (*comparator)(NetObj *, void *), void *data);
237
238 int size();
239 ObjectArray<NetObj> *getObjects(bool updateRefCount, bool (*filter)(NetObj *, void *) = NULL, void *userData = NULL);
240
241 void forEach(void (*callback)(NetObj *, void *), void *data);
242 };
243
244 struct InetAddressIndexEntry;
245
246 /**
247 * Object index by IP address
248 */
249 class NXCORE_EXPORTABLE InetAddressIndex
250 {
251 private:
252 InetAddressIndexEntry *m_root;
253 RWLOCK m_lock;
254
255 public:
256 InetAddressIndex();
257 ~InetAddressIndex();
258
259 bool put(const InetAddress& addr, NetObj *object);
260 bool put(const InetAddressList *addrList, NetObj *object);
261 void remove(const InetAddress& addr);
262 void remove(const InetAddressList *addrList);
263 NetObj *get(const InetAddress& addr);
264 NetObj *find(bool (*comparator)(NetObj *, void *), void *data);
265
266 int size();
267 ObjectArray<NetObj> *getObjects(bool updateRefCount, bool (*filter)(NetObj *, void *) = NULL, void *userData = NULL);
268
269 void forEach(void (*callback)(const InetAddress&, NetObj *, void *), void *data);
270 };
271
272 /**
273 * Node component
274 */
275 class Component
276 {
277 protected:
278 UINT32 m_index;
279 UINT32 m_class;
280 UINT32 m_ifIndex;
281 TCHAR *m_name;
282 TCHAR *m_description;
283 TCHAR *m_model;
284 TCHAR *m_serial;
285 TCHAR *m_vendor;
286 TCHAR *m_firmware;
287 UINT32 m_parentIndex;
288 ObjectArray<Component> m_childs;
289
290 public:
291 Component(UINT32 index, const TCHAR *name);
292 virtual ~Component();
293
294 UINT32 updateFromSnmp(SNMP_Transport *snmp);
295 void buildTree(ObjectArray<Component> *elements);
296
297 UINT32 getIndex() { return m_index; }
298 UINT32 getParentIndex() { return m_parentIndex; }
299 NXSL_Array *getChildrenForNXSL();
300
301 UINT32 getClass() { return m_class; }
302 const TCHAR *getFirmware() { return m_firmware; }
303 const TCHAR *getModel() { return m_model; }
304 const TCHAR *getName() { return m_name; }
305 const TCHAR *getSerial() { return m_serial; }
306 const TCHAR *getVendor() { return m_vendor; }
307
308 UINT32 fillMessage(NXCPMessage *msg, UINT32 baseId);
309
310 void print(CONSOLE_CTX console, int level);
311 };
312
313 /**
314 * Node component tree
315 */
316 class ComponentTree : public RefCountObject
317 {
318 private:
319 Component *m_root;
320
321 public:
322 ComponentTree(Component *root);
323 virtual ~ComponentTree();
324
325 void fillMessage(NXCPMessage *msg, UINT32 baseId);
326 void print(CONSOLE_CTX console) { if (m_root != NULL) m_root->print(console, 0); }
327
328 bool isEmpty() { return m_root == NULL; }
329 Component *getRoot() { return m_root; }
330 };
331
332 /**
333 * Software package information
334 */
335 class SoftwarePackage
336 {
337 private:
338 TCHAR *m_name;
339 TCHAR *m_version;
340 TCHAR *m_vendor;
341 time_t m_date;
342 TCHAR *m_url;
343 TCHAR *m_description;
344
345 SoftwarePackage();
346
347 public:
348 ~SoftwarePackage();
349
350 void fillMessage(NXCPMessage *msg, UINT32 baseId) const;
351
352 const TCHAR *getName() const { return m_name; }
353 const TCHAR *getVersion() const { return m_version; }
354
355 static SoftwarePackage *createFromTableRow(const Table *table, int row);
356 };
357
358 /**
359 * Summary table flags
360 */
361 #define SUMMARY_TABLE_MULTI_INSTANCE 0x0001
362 #define SUMMARY_TABLE_TABLE_DCI_SOURCE 0x0002
363
364 /**
365 * Summary table column flags
366 */
367 #define COLUMN_DEFINITION_REGEXP_MATCH 0x0001
368 #define COLUMN_DEFINITION_MULTIVALUED 0x0002
369
370 /**
371 * Column definition for DCI summary table
372 */
373 class NXCORE_EXPORTABLE SummaryTableColumn
374 {
375 public:
376 TCHAR m_name[MAX_DB_STRING];
377 TCHAR m_dciName[MAX_PARAM_NAME];
378 UINT32 m_flags;
379 TCHAR m_separator[16];
380
381 SummaryTableColumn(NXCPMessage *msg, UINT32 baseId);
382 SummaryTableColumn(TCHAR *configStr);
383
384 void createExportRecord(String &xml, int id);
385 };
386
387 /**
388 * DCI summary table class
389 */
390 class NXCORE_EXPORTABLE SummaryTable
391 {
392 private:
393 INT32 m_id;
394 uuid m_guid;
395 TCHAR m_title[MAX_DB_STRING];
396 UINT32 m_flags;
397 ObjectArray<SummaryTableColumn> *m_columns;
398 TCHAR *m_filterSource;
399 NXSL_VM *m_filter;
400 AggregationFunction m_aggregationFunction;
401 time_t m_periodStart;
402 time_t m_periodEnd;
403 TCHAR m_menuPath[MAX_DB_STRING];
404 TCHAR m_tableDciName[MAX_PARAM_NAME];
405
406 SummaryTable(INT32 id, DB_RESULT hResult);
407
408 public:
409 static SummaryTable *loadFromDB(INT32 id, UINT32 *rcc);
410
411 SummaryTable(NXCPMessage *msg);
412 ~SummaryTable();
413
414 bool filter(DataCollectionTarget *node);
415 Table *createEmptyResultTable();
416
417 int getNumColumns() const { return m_columns->size(); }
418 SummaryTableColumn *getColumn(int index) const { return m_columns->get(index); }
419 AggregationFunction getAggregationFunction() const { return m_aggregationFunction; }
420 const TCHAR *getTableDciName() const { return m_tableDciName; }
421 time_t getPeriodStart() const { return m_periodStart; }
422 time_t getPeriodEnd() const { return m_periodEnd; }
423 bool isMultiInstance() const { return (m_flags & SUMMARY_TABLE_MULTI_INSTANCE) ? true : false; }
424 bool isTableDciSource() const { return (m_flags & SUMMARY_TABLE_TABLE_DCI_SOURCE) ? true : false; }
425
426 void createExportRecord(String &xml) const;
427 };
428
429 /**
430 * Object-associated URL
431 */
432 class NXCORE_EXPORTABLE ObjectUrl
433 {
434 private:
435 UINT32 m_id;
436 TCHAR *m_url;
437 TCHAR *m_description;
438
439 public:
440 ObjectUrl(NXCPMessage *msg, UINT32 baseId);
441 ObjectUrl(DB_RESULT hResult, int row);
442 ~ObjectUrl();
443
444 void fillMessage(NXCPMessage *msg, UINT32 baseId);
445
446 UINT32 getId() const { return m_id; }
447 const TCHAR *getUrl() const { return m_url; }
448 const TCHAR *getDescription() const { return m_description; }
449
450 json_t *toJson() const;
451 };
452
453 /**
454 * Base class for network objects
455 */
456 class NXCORE_EXPORTABLE NetObj
457 {
458 private:
459 static void onObjectDeleteCallback(NetObj *object, void *data);
460
461 void getFullChildListInternal(ObjectIndex *list, bool eventSourceOnly);
462
463 protected:
464 UINT32 m_id;
465 uuid m_guid;
466 time_t m_timestamp; // Last change time stamp
467 UINT32 m_dwRefCount; // Number of references. Object can be destroyed only when this counter is zero
468 TCHAR m_name[MAX_OBJECT_NAME];
469 TCHAR *m_comments; // User comments
470 int m_status;
471 int m_statusCalcAlg; // Status calculation algorithm
472 int m_statusPropAlg; // Status propagation algorithm
473 int m_fixedStatus; // Status if propagation is "Fixed"
474 int m_statusShift; // Shift value for "shifted" status propagation
475 int m_statusTranslation[4];
476 int m_statusSingleThreshold;
477 int m_statusThresholds[4];
478 UINT32 m_flags;
479 UINT32 m_runtimeFlags;
480 UINT32 m_state;
481 bool m_isModified;
482 bool m_isDeleted;
483 bool m_isHidden;
484 bool m_isSystem;
485 bool m_maintenanceMode;
486 UINT64 m_maintenanceEventId;
487 uuid m_image;
488 MUTEX m_mutexProperties; // Object data access mutex
489 MUTEX m_mutexRefCount; // Reference counter access mutex
490 RWLOCK m_rwlockParentList; // Lock for parent list
491 RWLOCK m_rwlockChildList; // Lock for child list
492 GeoLocation m_geoLocation;
493 PostalAddress *m_postalAddress;
494 ClientSession *m_pollRequestor;
495 UINT32 m_submapId; // Map object which should be open on drill-down request
496 IntegerArray<UINT32> *m_dashboards; // Dashboards associated with this object
497 ObjectArray<ObjectUrl> *m_urls; // URLs associated with this object
498
499 ObjectArray<NetObj> *m_childList; // Array of pointers to child objects
500 ObjectArray<NetObj> *m_parentList; // Array of pointers to parent objects
501
502 AccessList *m_accessList;
503 bool m_inheritAccessRights;
504 MUTEX m_mutexACL;
505
506 IntegerArray<UINT32> *m_trustedNodes;
507
508 StringMap m_customAttributes;
509 StringObjectMap<ModuleData> *m_moduleData;
510
511 void lockProperties() const { MutexLock(m_mutexProperties); }
512 void unlockProperties() const { MutexUnlock(m_mutexProperties); }
513 void lockACL() { MutexLock(m_mutexACL); }
514 void unlockACL() { MutexUnlock(m_mutexACL); }
515 void lockParentList(bool writeLock)
516 {
517 if (writeLock)
518 RWLockWriteLock(m_rwlockParentList, INFINITE);
519 else
520 RWLockReadLock(m_rwlockParentList, INFINITE);
521 }
522 void unlockParentList() { RWLockUnlock(m_rwlockParentList); }
523 void lockChildList(bool writeLock)
524 {
525 if (writeLock)
526 RWLockWriteLock(m_rwlockChildList, INFINITE);
527 else
528 RWLockReadLock(m_rwlockChildList, INFINITE);
529 }
530 void unlockChildList() { RWLockUnlock(m_rwlockChildList); }
531
532 void setModified(bool notify = true); // Used to mark object as modified
533
534 bool loadACLFromDB(DB_HANDLE hdb);
535 bool saveACLToDB(DB_HANDLE hdb);
536 bool loadCommonProperties(DB_HANDLE hdb);
537 bool saveCommonProperties(DB_HANDLE hdb);
538 bool loadTrustedNodes(DB_HANDLE hdb);
539 bool saveTrustedNodes(DB_HANDLE hdb);
540 bool executeQueryOnObject(DB_HANDLE hdb, const TCHAR *query) { return ExecuteQueryOnObject(hdb, m_id, query); }
541
542 virtual void prepareForDeletion();
543 virtual void onObjectDelete(UINT32 dwObjectId);
544
545 virtual void fillMessageInternal(NXCPMessage *msg);
546 virtual void fillMessageInternalStage2(NXCPMessage *msg);
547 virtual UINT32 modifyFromMessageInternal(NXCPMessage *msg);
548
549 void addLocationToHistory();
550 bool isLocationTableExists(DB_HANDLE hdb);
551 bool createLocationHistoryTable(DB_HANDLE hdb);
552
553 public:
554 NetObj();
555 virtual ~NetObj();
556
557 virtual int getObjectClass() const { return OBJECT_GENERIC; }
558 virtual const TCHAR *getObjectClassName() const;
559
560 UINT32 getId() const { return m_id; }
561 const TCHAR *getName() const { return m_name; }
562 int getStatus() const { return m_status; }
563 UINT32 getState() const { return m_state; }
564 UINT32 getRuntimeFlags() const { return m_runtimeFlags; }
565 UINT32 getFlags() const { return m_flags; }
566 int getPropagatedStatus();
567 time_t getTimeStamp() const { return m_timestamp; }
568 const uuid& getGuid() const { return m_guid; }
569 const TCHAR *getComments() const { return CHECK_NULL_EX(m_comments); }
570
571 const GeoLocation& getGeoLocation() const { return m_geoLocation; }
572 void setGeoLocation(const GeoLocation& geoLocation) { lockProperties(); m_geoLocation = geoLocation; setModified(); unlockProperties(); }
573
574 const PostalAddress *getPostalAddress() const { return m_postalAddress; }
575 void setPostalAddress(PostalAddress * addr) { lockProperties(); delete m_postalAddress; m_postalAddress = addr; setModified(); unlockProperties(); }
576
577 const uuid& getMapImage() { return m_image; }
578 void setMapImage(const uuid& image) { lockProperties(); m_image = image; setModified(); unlockProperties(); }
579
580 bool isModified() const { return m_isModified; }
581 bool isDeleted() const { return m_isDeleted; }
582 bool isOrphaned() const { return m_parentList->size() == 0; }
583 bool isEmpty() const { return m_childList->size() == 0; }
584
585 bool isSystem() const { return m_isSystem; }
586 void setSystemFlag(bool flag) { m_isSystem = flag; }
587 void setFlag(UINT32 flag) { lockProperties(); m_flags |= flag; setModified(); unlockProperties(); }
588 void clearFlag(UINT32 flag) { lockProperties(); m_flags &= ~flag; setModified(); unlockProperties(); }
589
590 UINT32 getRefCount();
591 void incRefCount();
592 void decRefCount();
593
594 bool isChild(UINT32 id);
595 bool isTrustedNode(UINT32 id);
596
597 void addChild(NetObj *object); // Add reference to child object
598 void addParent(NetObj *object); // Add reference to parent object
599
600 void deleteChild(NetObj *object); // Delete reference to child object
601 void deleteParent(NetObj *object); // Delete reference to parent object
602
603 void deleteObject(NetObj *initiator = NULL); // Prepare object for deletion
604
605 bool isHidden() { return m_isHidden; }
606 void hide();
607 void unhide();
608 void markAsModified() { lockProperties(); setModified(); unlockProperties(); } // external API to mark object as modified
609
610 virtual bool saveToDatabase(DB_HANDLE hdb);
611 virtual bool saveRuntimeData(DB_HANDLE hdb);
612 virtual bool deleteFromDatabase(DB_HANDLE hdb);
613 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
614 virtual void linkObjects();
615
616 void setId(UINT32 dwId) { m_id = dwId; setModified(); }
617 void generateGuid() { m_guid = uuid::generate(); }
618 void setName(const TCHAR *pszName) { nx_strncpy(m_name, pszName, MAX_OBJECT_NAME); setModified(); }
619 void resetStatus() { m_status = STATUS_UNKNOWN; setModified(); }
620 void setComments(TCHAR *text); /* text must be dynamically allocated */
621
622 bool isInMaintenanceMode() const { return m_maintenanceMode; }
623 UINT64 getMaintenanceEventId() const { return m_maintenanceEventId; }
624 virtual void enterMaintenanceMode();
625 virtual void leaveMaintenanceMode();
626
627 void fillMessage(NXCPMessage *msg);
628 UINT32 modifyFromMessage(NXCPMessage *msg);
629
630 virtual void postModify();
631
632 void commentsToMessage(NXCPMessage *pMsg);
633
634 virtual void setMgmtStatus(BOOL bIsManaged);
635 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
636
637 UINT32 getUserRights(UINT32 dwUserId);
638 BOOL checkAccessRights(UINT32 dwUserId, UINT32 dwRequiredRights);
639 void dropUserAccess(UINT32 dwUserId);
640
641 void addChildNodesToList(ObjectArray<Node> *nodeList, UINT32 dwUserId);
642 void addChildDCTargetsToList(ObjectArray<DataCollectionTarget> *dctList, UINT32 dwUserId);
643
644 const TCHAR *getCustomAttribute(const TCHAR *name) { return m_customAttributes.get(name); }
645 void setCustomAttribute(const TCHAR *name, const TCHAR *value) { m_customAttributes.set(name, value); setModified(); }
646 void setCustomAttributePV(const TCHAR *name, TCHAR *value) { m_customAttributes.setPreallocated(_tcsdup(name), value); setModified(); }
647 void deleteCustomAttribute(const TCHAR *name) { m_customAttributes.remove(name); setModified(); }
648 NXSL_Value *getCustomAttributesForNXSL() const;
649
650 virtual NXSL_Value *createNXSLObject();
651
652 ModuleData *getModuleData(const TCHAR *module);
653 void setModuleData(const TCHAR *module, ModuleData *data);
654
655 ObjectArray<NetObj> *getParentList(int typeFilter);
656 ObjectArray<NetObj> *getChildList(int typeFilter);
657 ObjectArray<NetObj> *getFullChildList(bool eventSourceOnly, bool updateRefCount);
658
659 NetObj *findChildObject(const TCHAR *name, int typeFilter);
660 Node *findChildNode(const InetAddress& addr);
661
662 int getChildCount() { return m_childList->size(); }
663 int getParentCount() { return m_parentList->size(); }
664
665 virtual NXSL_Array *getParentsForNXSL();
666 virtual NXSL_Array *getChildrenForNXSL();
667
668 virtual bool showThresholdSummary();
669 virtual bool isEventSource();
670 virtual bool isDataCollectionTarget();
671
672 void setStatusCalculation(int method, int arg1 = 0, int arg2 = 0, int arg3 = 0, int arg4 = 0);
673 void setStatusPropagation(int method, int arg1 = 0, int arg2 = 0, int arg3 = 0, int arg4 = 0);
674
675 void sendPollerMsg(UINT32 dwRqId, const TCHAR *pszFormat, ...);
676
677 virtual json_t *toJson();
678
679 // Debug methods
680 const TCHAR *dbgGetParentList(TCHAR *szBuffer);
681 const TCHAR *dbgGetChildList(TCHAR *szBuffer);
682
683 static const TCHAR *getObjectClassName(int objectClass);
684 };
685
686 /**
687 * Get object's reference count
688 */
689 inline UINT32 NetObj::getRefCount()
690 {
691 UINT32 dwRefCount;
692
693 MutexLock(m_mutexRefCount);
694 dwRefCount = m_dwRefCount;
695 MutexUnlock(m_mutexRefCount);
696 return dwRefCount;
697 }
698
699 /**
700 * Increment object's reference count
701 */
702 inline void NetObj::incRefCount()
703 {
704 MutexLock(m_mutexRefCount);
705 m_dwRefCount++;
706 MutexUnlock(m_mutexRefCount);
707 }
708
709 /**
710 * Decrement object's reference count
711 */
712 inline void NetObj::decRefCount()
713 {
714 MutexLock(m_mutexRefCount);
715 if (m_dwRefCount > 0)
716 m_dwRefCount--;
717 MutexUnlock(m_mutexRefCount);
718 }
719
720 /**
721 * Data collection template class
722 */
723 class NXCORE_EXPORTABLE Template : public NetObj
724 {
725 protected:
726 ObjectArray<DCObject> *m_dcObjects;
727 int m_dciLockStatus;
728 UINT32 m_dwVersion;
729 bool m_dciListModified;
730 TCHAR m_szCurrDCIOwner[MAX_SESSION_NAME];
731 TCHAR *m_applyFilterSource;
732 NXSL_Program *m_applyFilter;
733 RWLOCK m_dciAccessLock;
734
735 virtual void prepareForDeletion();
736
737 virtual void fillMessageInternal(NXCPMessage *pMsg);
738 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
739
740 virtual void onDataCollectionChange();
741
742 void loadItemsFromDB(DB_HANDLE hdb);
743 void destroyItems();
744 void updateInstanceDiscoveryItems(DCItem *dci);
745
746 void lockDciAccess(bool writeLock) { if (writeLock) { RWLockWriteLock(m_dciAccessLock, INFINITE); } else { RWLockReadLock(m_dciAccessLock, INFINITE); } }
747 void unlockDciAccess() { RWLockUnlock(m_dciAccessLock); }
748
749 void deleteChildDCIs(UINT32 dcObjectId);
750 void destroyItem(DCObject *object, int index);
751
752 public:
753 Template();
754 Template(const TCHAR *pszName);
755 Template(ConfigEntry *config);
756 virtual ~Template();
757
758 virtual int getObjectClass() const { return OBJECT_TEMPLATE; }
759
760 virtual bool saveToDatabase(DB_HANDLE hdb);
761 virtual bool deleteFromDatabase(DB_HANDLE hdb);
762 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
763
764 virtual json_t *toJson();
765
766 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
767
768 int getVersionMajor() { return m_dwVersion >> 16; }
769 int getVersionMinor() { return m_dwVersion & 0xFFFF; }
770
771 int getItemCount() { return m_dcObjects->size(); }
772 bool addDCObject(DCObject *object, bool alreadyLocked = false);
773 bool updateDCObject(UINT32 dwItemId, NXCPMessage *pMsg, UINT32 *pdwNumMaps, UINT32 **ppdwMapIndex, UINT32 **ppdwMapId);
774 bool deleteDCObject(UINT32 dcObjectId, bool needLock);
775 bool setItemStatus(UINT32 dwNumItems, UINT32 *pdwItemList, int iStatus);
776 int getItemType(UINT32 dwItemId);
777 DCObject *getDCObjectById(UINT32 itemId, bool lock = true);
778 DCObject *getDCObjectByGUID(const uuid& guid, bool lock = true);
779 DCObject *getDCObjectByTemplateId(UINT32 tmplItemId);
780 DCObject *getDCObjectByIndex(int index);
781 DCObject *getDCObjectByName(const TCHAR *name);
782 DCObject *getDCObjectByDescription(const TCHAR *description);
783 NXSL_Value *getAllDCObjectsForNXSL(const TCHAR *name, const TCHAR *description);
784 bool lockDCIList(int sessionId, const TCHAR *pszNewOwner, TCHAR *pszCurrOwner);
785 bool unlockDCIList(int sessionId);
786 void setDCIModificationFlag() { m_dciListModified = true; }
787 void sendItemsToClient(ClientSession *pSession, UINT32 dwRqId);
788 bool isLockedBySession(int sessionId) { return m_dciLockStatus == sessionId; }
789 IntegerArray<UINT32> *getDCIEventsList();
790 StringSet *getDCIScriptList();
791
792 BOOL applyToTarget(DataCollectionTarget *pNode);
793 AutoBindDecision isApplicable(DataCollectionTarget *object);
794 bool isAutoApplyEnabled() { return (m_flags & TF_AUTO_APPLY) ? true : false; }
795 bool isAutoRemoveEnabled() { return ((m_flags & (TF_AUTO_APPLY | TF_AUTO_REMOVE)) == (TF_AUTO_APPLY | TF_AUTO_REMOVE)) ? true : false; }
796 void setAutoApplyFilter(const TCHAR *filter);
797 void queueUpdate();
798 void queueRemoveFromTarget(UINT32 targetId, bool removeDCI);
799
800 void createExportRecord(String &str);
801 void updateFromImport(ConfigEntry *config);
802
803 bool enumDCObjects(bool (* pfCallback)(DCObject *, UINT32, void *), void *pArg);
804 void associateItems();
805
806 UINT32 getLastValues(NXCPMessage *msg, bool objectTooltipOnly, bool overviewOnly, bool includeNoValueObjects);
807 };
808
809 class Cluster;
810
811 /**
812 * Interface class
813 */
814 class NXCORE_EXPORTABLE Interface : public NetObj
815 {
816 protected:
817 UINT32 m_parentInterfaceId;
818 UINT32 m_index;
819 BYTE m_macAddr[MAC_ADDR_LENGTH];
820 InetAddressList m_ipAddressList;
821 TCHAR m_description[MAX_DB_STRING]; // Interface description - value of ifDescr for SNMP, equals to name for NetXMS agent
822 TCHAR m_alias[MAX_DB_STRING]; // Interface alias - value of ifAlias for SNMP, empty for NetXMS agent
823 UINT32 m_type;
824 UINT32 m_mtu;
825 UINT64 m_speed;
826 UINT32 m_bridgePortNumber; // 802.1D port number
827 UINT32 m_slotNumber; // Vendor/device specific slot number
828 UINT32 m_portNumber; // Vendor/device specific port number
829 UINT32 m_peerNodeId; // ID of peer node object, or 0 if unknown
830 UINT32 m_peerInterfaceId; // ID of peer interface object, or 0 if unknown
831 LinkLayerProtocol m_peerDiscoveryProtocol; // Protocol used to discover peer node
832 INT16 m_adminState; // interface administrative state
833 INT16 m_operState; // interface operational state
834 INT16 m_pendingOperState;
835 INT16 m_confirmedOperState;
836 INT16 m_dot1xPaeAuthState; // 802.1x port auth state
837 INT16 m_dot1xBackendAuthState; // 802.1x backend auth state
838 UINT64 m_lastDownEventId;
839 int m_pendingStatus;
840 int m_statusPollCount;
841 int m_operStatePollCount;
842 int m_requiredPollCount;
843 UINT32 m_zoneUIN;
844 UINT32 m_pingTime;
845 time_t m_pingLastTimeStamp;
846 int m_ifTableSuffixLen;
847 UINT32 *m_ifTableSuffix;
848
849 void icmpStatusPoll(UINT32 rqId, UINT32 nodeIcmpProxy, Cluster *cluster, InterfaceAdminState *adminState, InterfaceOperState *operState);
850 void paeStatusPoll(UINT32 rqId, SNMP_Transport *pTransport, Node *node);
851
852 protected:
853 virtual void onObjectDelete(UINT32 dwObjectId);
854
855 virtual void fillMessageInternal(NXCPMessage *pMsg);
856 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
857
858 void setExpectedStateInternal(int state);
859
860 public:
861 Interface();
862 Interface(const InetAddressList& addrList, UINT32 zoneUIN, bool bSyntheticMask);
863 Interface(const TCHAR *name, const TCHAR *descr, UINT32 index, const InetAddressList& addrList, UINT32 ifType, UINT32 zoneUIN);
864 virtual ~Interface();
865
866 virtual int getObjectClass() const { return OBJECT_INTERFACE; }
867 virtual bool saveToDatabase(DB_HANDLE hdb);
868 virtual bool deleteFromDatabase(DB_HANDLE hdb);
869 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
870
871 virtual NXSL_Value *createNXSLObject();
872
873 virtual json_t *toJson();
874
875 Node *getParentNode();
876 UINT32 getParentNodeId();
877 UINT32 getParentInterfaceId() const { return m_parentInterfaceId; }
878
879 const InetAddressList *getIpAddressList() { return &m_ipAddressList; }
880 const InetAddress& getFirstIpAddress();
881 UINT32 getZoneUIN() const { return m_zoneUIN; }
882 UINT32 getIfIndex() const { return m_index; }
883 UINT32 getIfType() const { return m_type; }
884 UINT32 getMTU() const { return m_mtu; }
885 UINT64 getSpeed() const { return m_speed; }
886 UINT32 getBridgePortNumber() const { return m_bridgePortNumber; }
887 UINT32 getSlotNumber() const { return m_slotNumber; }
888 UINT32 getPortNumber() const { return m_portNumber; }
889 UINT32 getPeerNodeId() const { return m_peerNodeId; }
890 UINT32 getPeerInterfaceId() const { return m_peerInterfaceId; }
891 LinkLayerProtocol getPeerDiscoveryProtocol() const { return m_peerDiscoveryProtocol; }
892 int getExpectedState() const { return (int)((m_flags & IF_EXPECTED_STATE_MASK) >> 28); }
893 int getAdminState() const { return (int)m_adminState; }
894 int getOperState() const { return (int)m_operState; }
895 int getConfirmedOperState() const { return (int)m_confirmedOperState; }
896 int getDot1xPaeAuthState() const { return (int)m_dot1xPaeAuthState; }
897 int getDot1xBackendAuthState() const { return (int)m_dot1xBackendAuthState; }
898 const TCHAR *getDescription() const { return m_description; }
899 const TCHAR *getAlias() const { return m_alias; }
900 const BYTE *getMacAddr() const { return m_macAddr; }
901 int getIfTableSuffixLen() const { return m_ifTableSuffixLen; }
902 const UINT32 *getIfTableSuffix() const { return m_ifTableSuffix; }
903 UINT32 getPingTime();
904 bool isSyntheticMask() const { return (m_flags & IF_SYNTHETIC_MASK) ? true : false; }
905 bool isPhysicalPort() const { return (m_flags & IF_PHYSICAL_PORT) ? true : false; }
906 bool isLoopback() const { return (m_flags & IF_LOOPBACK) ? true : false; }
907 bool isManuallyCreated() const { return (m_flags & IF_CREATED_MANUALLY) ? true : false; }
908 bool isExcludedFromTopology() const { return (m_flags & (IF_EXCLUDE_FROM_TOPOLOGY | IF_LOOPBACK)) ? true : false; }
909 bool isFake() const { return (m_index == 1) &&
910 (m_type == IFTYPE_OTHER) &&
911 !_tcscmp(m_name, _T("unknown")); }
912 bool isSubInterface() const { return m_parentInterfaceId != 0; }
913
914 UINT64 getLastDownEventId() const { return m_lastDownEventId; }
915 void setLastDownEventId(UINT64 id) { m_lastDownEventId = id; }
916
917 void setMacAddr(const BYTE *macAddr, bool updateMacDB);
918 void setIpAddress(const InetAddress& addr);
919 void setBridgePortNumber(UINT32 bpn) { m_bridgePortNumber = bpn; setModified(); }
920 void setSlotNumber(UINT32 slot) { m_slotNumber = slot; setModified(); }
921 void setPortNumber(UINT32 port) { m_portNumber = port; setModified(); }
922 void setPhysicalPortFlag(bool isPhysical) { if (isPhysical) m_flags |= IF_PHYSICAL_PORT; else m_flags &= ~IF_PHYSICAL_PORT; setModified(); }
923 void setManualCreationFlag(bool isManual) { if (isManual) m_flags |= IF_CREATED_MANUALLY; else m_flags &= ~IF_CREATED_MANUALLY; setModified(); }
924 void setPeer(Node *node, Interface *iface, LinkLayerProtocol protocol, bool reflection);
925 void clearPeer() { lockProperties(); m_peerNodeId = 0; m_peerInterfaceId = 0; m_peerDiscoveryProtocol = LL_PROTO_UNKNOWN; setModified(); unlockProperties(); }
926 void setDescription(const TCHAR *descr) { lockProperties(); nx_strncpy(m_description, descr, MAX_DB_STRING); setModified(); unlockProperties(); }
927 void setAlias(const TCHAR *alias) { lockProperties(); nx_strncpy(m_alias, alias, MAX_DB_STRING); setModified(); unlockProperties(); }
928 void addIpAddress(const InetAddress& addr);
929 void deleteIpAddress(InetAddress addr);
930 void setNetMask(const InetAddress& addr);
931 void setMTU(int mtu) { m_mtu = mtu; setModified(); }
932 void setSpeed(UINT64 speed) { m_speed = speed; setModified(); }
933 void setIfTableSuffix(int len, const UINT32 *suffix) { lockProperties(); safe_free(m_ifTableSuffix); m_ifTableSuffixLen = len; m_ifTableSuffix = (len > 0) ? (UINT32 *)nx_memdup(suffix, len * sizeof(UINT32)) : NULL; setModified(); unlockProperties(); }
934 void setParentInterface(UINT32 parentInterfaceId) { m_parentInterfaceId = parentInterfaceId; setModified(); }
935
936 void updateZoneUIN();
937
938 void statusPoll(ClientSession *session, UINT32 rqId, Queue *eventQueue, Cluster *cluster, SNMP_Transport *snmpTransport, UINT32 nodeIcmpProxy);
939
940 UINT32 wakeUp();
941 void setExpectedState(int state) { lockProperties(); setExpectedStateInternal(state); unlockProperties(); }
942 void setExcludeFromTopology(bool excluded);
943 void updatePingData();
944 };
945
946 /**
947 * Network service class
948 */
949 class NXCORE_EXPORTABLE NetworkService : public NetObj
950 {
951 protected:
952 int m_serviceType; // SSH, POP3, etc.
953 Node *m_hostNode; // Pointer to node object which hosts this service
954 UINT32 m_pollerNode; // ID of node object which is used for polling
955 // If 0, m_pHostNode->m_dwPollerNode will be used
956 UINT16 m_proto; // Protocol (TCP, UDP, etc.)
957 UINT16 m_port; // TCP or UDP port number
958 InetAddress m_ipAddress;
959 TCHAR *m_request; // Service-specific request
960 TCHAR *m_response; // Service-specific expected response
961 int m_pendingStatus;
962 int m_pollCount;
963 int m_requiredPollCount;
964 UINT32 m_responseTime; // Response time from last poll
965
966 virtual void onObjectDelete(UINT32 dwObjectId);
967
968 virtual void fillMessageInternal(NXCPMessage *pMsg);
969 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
970
971 public:
972 NetworkService();
973 NetworkService(int iServiceType, WORD wProto, WORD wPort,
974 TCHAR *pszRequest, TCHAR *pszResponse,
975 Node *pHostNode = NULL, UINT32 dwPollerNode = 0);
976 virtual ~NetworkService();
977
978 virtual int getObjectClass() const { return OBJECT_NETWORKSERVICE; }
979
980 virtual json_t *toJson();
981
982 virtual bool saveToDatabase(DB_HANDLE hdb);
983 virtual bool deleteFromDatabase(DB_HANDLE hdb);
984 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
985
986 void statusPoll(ClientSession *session, UINT32 rqId, Node *pollerNode, Queue *eventQueue);
987
988 UINT32 getResponseTime() { return m_responseTime; }
989 };
990
991 /**
992 * VPN connector class
993 */
994 class NXCORE_EXPORTABLE VPNConnector : public NetObj
995 {
996 protected:
997 UINT32 m_dwPeerGateway; // Object ID of peer gateway
998 ObjectArray<InetAddress> *m_localNetworks;
999 ObjectArray<InetAddress> *m_remoteNetworks;
1000
1001 virtual void fillMessageInternal(NXCPMessage *pMsg);
1002 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
1003
1004 Node *getParentNode();
1005
1006 public:
1007 VPNConnector();
1008 VPNConnector(bool hidden);
1009 virtual ~VPNConnector();
1010
1011 virtual int getObjectClass() const { return OBJECT_VPNCONNECTOR; }
1012
1013 virtual json_t *toJson();
1014
1015 virtual bool saveToDatabase(DB_HANDLE hdb);
1016 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1017 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
1018
1019 bool isLocalAddr(const InetAddress& addr);
1020 bool isRemoteAddr(const InetAddress& addr);
1021 UINT32 getPeerGatewayId() const { return m_dwPeerGateway; }
1022 InetAddress getPeerGatewayAddr();
1023 };
1024
1025 /**
1026 * Data collection proxy information structure
1027 */
1028 struct ProxyInfo
1029 {
1030 UINT32 proxyId;
1031 NXCPMessage *msg;
1032 UINT32 fieldId;
1033 UINT32 count;
1034 UINT32 nodeInfoFieldId;
1035 UINT32 nodeInfoCount;
1036 };
1037
1038 /**
1039 * Common base class for all objects capable of collecting data
1040 */
1041 class NXCORE_EXPORTABLE DataCollectionTarget : public Template
1042 {
1043 protected:
1044 IntegerArray<UINT32> *m_deletedItems;
1045 IntegerArray<UINT32> *m_deletedTables;
1046 UINT32 m_pingTime;
1047 time_t m_pingLastTimeStamp;
1048 time_t m_lastConfigurationPoll;
1049 time_t m_lastStatusPoll;
1050 time_t m_lastInstancePoll;
1051 MUTEX m_hPollerMutex;
1052
1053 void pollerLock() { MutexLock(m_hPollerMutex); }
1054 void pollerUnlock() { MutexUnlock(m_hPollerMutex); }
1055
1056 virtual void fillMessageInternal(NXCPMessage *pMsg);
1057 virtual void fillMessageInternalStage2(NXCPMessage *pMsg);
1058 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
1059
1060 virtual bool isDataCollectionDisabled();
1061 virtual void updatePingData();
1062
1063 virtual void statusPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1064 virtual void configurationPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1065 virtual void instanceDiscoveryPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1066
1067 virtual StringMap *getInstanceList(DCObject *dco);
1068 void doInstanceDiscovery(UINT32 requestId);
1069 bool updateInstances(DCObject *root, StringMap *instances, UINT32 requestId);
1070
1071 NetObj *objectFromParameter(const TCHAR *param);
1072
1073 NXSL_VM *runDataCollectionScript(const TCHAR *param, DataCollectionTarget *targetObject);
1074
1075 void applyUserTemplates();
1076 void updateContainerMembership();
1077
1078 void getItemDciValuesSummary(SummaryTable *tableDefinition, Table *tableData);
1079 void getTableDciValuesSummary(SummaryTable *tableDefinition, Table *tableData);
1080
1081 void addProxyDataCollectionElement(ProxyInfo *info, const DCObject *dco);
1082 void addProxySnmpTarget(ProxyInfo *info, const Node *node);
1083 virtual void collectProxyInfo(ProxyInfo *info);
1084 static void collectProxyInfoCallback(NetObj *object, void *data);
1085
1086 public:
1087 DataCollectionTarget();
1088 DataCollectionTarget(const TCHAR *name);
1089 virtual ~DataCollectionTarget();
1090
1091 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1092
1093 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
1094 virtual bool isDataCollectionTarget();
1095
1096 virtual void enterMaintenanceMode();
1097 virtual void leaveMaintenanceMode();
1098
1099 virtual UINT32 getInternalItem(const TCHAR *param, size_t bufSize, TCHAR *buffer);
1100 virtual UINT32 getScriptItem(const TCHAR *param, size_t bufSize, TCHAR *buffer, DataCollectionTarget *targetObject);
1101 virtual UINT32 getScriptTable(const TCHAR *param, Table **result, DataCollectionTarget *targetObject);
1102
1103 virtual UINT32 getEffectiveSourceNode(DCObject *dco);
1104
1105 virtual json_t *toJson();
1106
1107 UINT32 getListFromScript(const TCHAR *param, StringList **list, DataCollectionTarget *targetObject);
1108 UINT32 getStringMapFromScript(const TCHAR *param, StringMap **map, DataCollectionTarget *targetObject);
1109
1110 UINT32 getTableLastValues(UINT32 dciId, NXCPMessage *msg);
1111 UINT32 getThresholdSummary(NXCPMessage *msg, UINT32 baseId);
1112 UINT32 getPerfTabDCIList(NXCPMessage *pMsg);
1113 void getDciValuesSummary(SummaryTable *tableDefinition, Table *tableData);
1114
1115 void updateDciCache();
1116 void updateDCItemCacheSize(UINT32 dciId, UINT32 conditionId = 0);
1117 void cleanDCIData(DB_HANDLE hdb);
1118 void queueItemsForPolling();
1119 bool processNewDCValue(DCObject *dco, time_t currTime, const void *value);
1120 void scheduleItemDataCleanup(UINT32 dciId);
1121 void scheduleTableDataCleanup(UINT32 dciId);
1122
1123 bool applyTemplateItem(UINT32 dwTemplateId, DCObject *dcObject);
1124 void cleanDeletedTemplateItems(UINT32 dwTemplateId, UINT32 dwNumItems, UINT32 *pdwItemList);
1125 virtual void unbindFromTemplate(UINT32 dwTemplateId, bool removeDCI);
1126
1127 virtual bool isEventSource();
1128
1129 int getMostCriticalDCIStatus();
1130
1131 UINT32 getPingTime();
1132
1133 void statusPollWorkerEntry(PollerInfo *poller);
1134 void statusPollWorkerEntry(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1135 void statusPollPollerEntry(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1136 virtual bool isReadyForStatusPoll();
1137 void lockForStatusPoll();
1138 void unlockForStatusPoll();
1139
1140 void configurationPollWorkerEntry(PollerInfo *poller);
1141 void configurationPollWorkerEntry(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1142 virtual bool isReadyForConfigurationPoll();
1143 void lockForConfigurationPoll();
1144 void unlockForConfigurationPoll();
1145
1146 void instanceDiscoveryPollWorkerEntry(PollerInfo *poller);
1147 void instanceDiscoveryPollWorkerEntry(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1148 virtual bool isReadyForInstancePoll();
1149 void lockForInstancePoll();
1150 void unlockForInstancePoll();
1151
1152 void executeHookScript(const TCHAR *hookName);
1153 };
1154
1155 inline bool DataCollectionTarget::isReadyForInstancePoll()
1156 {
1157 if (m_isDeleted)
1158 return false;
1159 return (m_status != STATUS_UNMANAGED) &&
1160 (!(m_flags & DCF_DISABLE_CONF_POLL)) &&
1161 (!(m_runtimeFlags & DCDF_QUEUED_FOR_INSTANCE_POLL)) &&
1162 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
1163 (m_runtimeFlags & DCDF_CONFIGURATION_POLL_PASSED) &&
1164 ((UINT32)(time(NULL) - m_lastInstancePoll) > g_instancePollingInterval);
1165
1166 }
1167
1168 inline void DataCollectionTarget::lockForInstancePoll()
1169 {
1170 lockProperties();
1171 m_runtimeFlags |= DCDF_QUEUED_FOR_INSTANCE_POLL;
1172 unlockProperties();
1173 }
1174
1175 inline void DataCollectionTarget::unlockForInstancePoll()
1176 {
1177 lockProperties();
1178 m_runtimeFlags &= ~DCDF_QUEUED_FOR_INSTANCE_POLL;
1179 unlockProperties();
1180 }
1181
1182 inline bool DataCollectionTarget::isReadyForConfigurationPoll()
1183 {
1184
1185 if (m_isDeleted)
1186 return false;
1187 if (m_runtimeFlags & DCDF_FORCE_CONFIGURATION_POLL)
1188 {
1189 m_runtimeFlags &= ~DCDF_FORCE_CONFIGURATION_POLL;
1190 return true;
1191 }
1192 return (m_status != STATUS_UNMANAGED) &&
1193 (!(m_flags & DCF_DISABLE_CONF_POLL)) &&
1194 (!(m_runtimeFlags & DCDF_QUEUED_FOR_CONFIGURATION_POLL)) &&
1195 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
1196 ((UINT32)(time(NULL) - m_lastConfigurationPoll) > g_dwConfigurationPollingInterval);
1197 }
1198
1199 inline void DataCollectionTarget::lockForConfigurationPoll()
1200 {
1201 lockProperties();
1202 m_runtimeFlags |= DCDF_QUEUED_FOR_CONFIGURATION_POLL;
1203 unlockProperties();
1204 }
1205
1206 inline void DataCollectionTarget::unlockForConfigurationPoll()
1207 {
1208 lockProperties();
1209 m_runtimeFlags &= ~DCDF_QUEUED_FOR_CONFIGURATION_POLL;
1210 unlockProperties();
1211 }
1212
1213 inline bool DataCollectionTarget::isReadyForStatusPoll()
1214 {
1215 if (m_isDeleted)
1216 return false;
1217 if (m_runtimeFlags & DCDF_FORCE_STATUS_POLL)
1218 {
1219 m_runtimeFlags &= ~DCDF_FORCE_STATUS_POLL;
1220 return true;
1221 }
1222 return (m_status != STATUS_UNMANAGED) &&
1223 (!(m_flags & DCF_DISABLE_STATUS_POLL)) &&
1224 (!(m_runtimeFlags & DCDF_QUEUED_FOR_STATUS_POLL)) &&
1225 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
1226 ((UINT32)(time(NULL) - m_lastStatusPoll) > g_dwStatusPollingInterval);
1227 }
1228 inline void DataCollectionTarget::lockForStatusPoll()
1229 {
1230 lockProperties();
1231 m_runtimeFlags |= DCDF_QUEUED_FOR_STATUS_POLL;
1232 unlockProperties();
1233 }
1234
1235 inline void DataCollectionTarget::unlockForStatusPoll()
1236 {
1237 lockProperties();
1238 m_runtimeFlags &= ~DCDF_QUEUED_FOR_STATUS_POLL;
1239 unlockProperties();
1240 }
1241
1242 /**
1243 * Mobile device class
1244 */
1245 class NXCORE_EXPORTABLE MobileDevice : public DataCollectionTarget
1246 {
1247 protected:
1248 time_t m_lastReportTime;
1249 TCHAR *m_deviceId;
1250 TCHAR *m_vendor;
1251 TCHAR *m_model;
1252 TCHAR *m_serialNumber;
1253 TCHAR *m_osName;
1254 TCHAR *m_osVersion;
1255 TCHAR *m_userId;
1256 LONG m_batteryLevel;
1257 InetAddress m_ipAddress;
1258
1259 virtual void fillMessageInternal(NXCPMessage *pMsg);
1260 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
1261
1262 public:
1263 MobileDevice();
1264 MobileDevice(const TCHAR *name, const TCHAR *deviceId);
1265 virtual ~MobileDevice();
1266
1267 virtual int getObjectClass() const { return OBJECT_MOBILEDEVICE; }
1268
1269 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
1270 virtual bool saveToDatabase(DB_HANDLE hdb);
1271 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1272
1273 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
1274
1275 virtual NXSL_Value *createNXSLObject();
1276
1277 virtual json_t *toJson();
1278
1279 void updateSystemInfo(NXCPMessage *msg);
1280 void updateStatus(NXCPMessage *msg);
1281
1282 const TCHAR *getDeviceId() { return CHECK_NULL_EX(m_deviceId); }
1283 const TCHAR *getVendor() { return CHECK_NULL_EX(m_vendor); }
1284 const TCHAR *getModel() { return CHECK_NULL_EX(m_model); }
1285 const TCHAR *getSerialNumber() { return CHECK_NULL_EX(m_serialNumber); }
1286 const TCHAR *getOsName() { return CHECK_NULL_EX(m_osName); }
1287 const TCHAR *getOsVersion() { return CHECK_NULL_EX(m_osVersion); }
1288 const TCHAR *getUserId() { return CHECK_NULL_EX(m_userId); }
1289 const LONG getBatteryLevel() { return m_batteryLevel; }
1290
1291 virtual UINT32 getInternalItem(const TCHAR *param, size_t bufSize, TCHAR *buffer);
1292
1293 virtual bool isReadyForStatusPoll() { return false; }
1294 virtual bool isReadyForConfigurationPoll() { return false; }
1295 virtual bool isReadyForInstancePoll() { return false; }
1296 };
1297
1298 /**
1299 * Access point class
1300 */
1301 class NXCORE_EXPORTABLE AccessPoint : public DataCollectionTarget
1302 {
1303 protected:
1304 UINT32 m_index;
1305 InetAddress m_ipAddress;
1306 UINT32 m_nodeId;
1307 BYTE m_macAddr[MAC_ADDR_LENGTH];
1308 TCHAR *m_vendor;
1309 TCHAR *m_model;
1310 TCHAR *m_serialNumber;
1311 ObjectArray<RadioInterfaceInfo> *m_radioInterfaces;
1312 AccessPointState m_apState;
1313 AccessPointState m_prevState;
1314
1315 virtual void fillMessageInternal(NXCPMessage *pMsg);
1316 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
1317
1318 virtual void updatePingData();
1319
1320 public:
1321 AccessPoint();
1322 AccessPoint(const TCHAR *name, UINT32 index, const BYTE *macAddr);
1323 virtual ~AccessPoint();
1324
1325 virtual int getObjectClass() const { return OBJECT_ACCESSPOINT; }
1326
1327 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
1328 virtual bool saveToDatabase(DB_HANDLE hdb);
1329 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1330
1331 virtual json_t *toJson();
1332
1333 void statusPollFromController(ClientSession *session, UINT32 rqId, Queue *eventQueue, Node *controller, SNMP_Transport *snmpTransport);
1334
1335 UINT32 getIndex() { return m_index; }
1336 const BYTE *getMacAddr() { return m_macAddr; }
1337 const InetAddress& getIpAddress() { return m_ipAddress; }
1338 bool isMyRadio(int rfIndex);
1339 bool isMyRadio(const BYTE *macAddr);
1340 void getRadioName(int rfIndex, TCHAR *buffer, size_t bufSize);
1341 AccessPointState getState() { return m_apState; }
1342 Node *getParentNode();
1343
1344 void attachToNode(UINT32 nodeId);
1345 void setIpAddress(const InetAddress& addr) { lockProperties(); m_ipAddress = addr; setModified(); unlockProperties(); }
1346 void updateRadioInterfaces(const ObjectArray<RadioInterfaceInfo> *ri);
1347 void updateInfo(const TCHAR *vendor, const TCHAR *model, const TCHAR *serialNumber);
1348 void updateState(AccessPointState state);
1349
1350 virtual bool isReadyForStatusPoll() { return false; }
1351 virtual bool isReadyForConfigurationPoll() { return false; }
1352 virtual bool isReadyForInstancePoll() { return false; }
1353 };
1354
1355 /**
1356 * Cluster class
1357 */
1358 class NXCORE_EXPORTABLE Cluster : public DataCollectionTarget
1359 {
1360 protected:
1361 UINT32 m_dwClusterType;
1362 ObjectArray<InetAddress> *m_syncNetworks;
1363 UINT32 m_dwNumResources;
1364 CLUSTER_RESOURCE *m_pResourceList;
1365 UINT32 m_zoneUIN;
1366
1367 virtual void fillMessageInternal(NXCPMessage *pMsg);
1368 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
1369
1370 virtual void onDataCollectionChange();
1371
1372 virtual void statusPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1373 virtual void configurationPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1374
1375 UINT32 getResourceOwnerInternal(UINT32 id, const TCHAR *name);
1376
1377 public:
1378 Cluster();
1379 Cluster(const TCHAR *pszName, UINT32 zoneUIN);
1380 virtual ~Cluster();
1381
1382 virtual int getObjectClass() const { return OBJECT_CLUSTER; }
1383 virtual bool saveToDatabase(DB_HANDLE hdb);
1384 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1385 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
1386 virtual bool showThresholdSummary();
1387
1388 virtual bool isReadyForInstancePoll() { return false; }
1389
1390 virtual void unbindFromTemplate(UINT32 dwTemplateId, bool removeDCI);
1391
1392 virtual NXSL_Value *createNXSLObject();
1393
1394 virtual json_t *toJson();
1395
1396 bool isSyncAddr(const InetAddress& addr);
1397 bool isVirtualAddr(const InetAddress& addr);
1398 bool isResourceOnNode(UINT32 dwResource, UINT32 dwNode);
1399 UINT32 getResourceOwner(UINT32 resourceId) { return getResourceOwnerInternal(resourceId, NULL); }
1400 UINT32 getResourceOwner(const TCHAR *resourceName) { return getResourceOwnerInternal(0, resourceName); }
1401 UINT32 getZoneUIN() const { return m_zoneUIN; }
1402
1403 UINT32 collectAggregatedData(DCItem *item, TCHAR *buffer);
1404 UINT32 collectAggregatedData(DCTable *table, Table **result);
1405
1406 NXSL_Array *getNodesForNXSL();
1407 };
1408
1409 /**
1410 * Chassis (represents physical chassis)
1411 */
1412 class NXCORE_EXPORTABLE Chassis : public DataCollectionTarget
1413 {
1414 protected:
1415 UINT32 m_controllerId;
1416 INT16 m_rackHeight;
1417 INT16 m_rackPosition;
1418 UINT32 m_rackId;
1419 uuid m_rackImage;
1420
1421 virtual void fillMessageInternal(NXCPMessage *msg);
1422 virtual UINT32 modifyFromMessageInternal(NXCPMessage *request);
1423
1424 virtual void onDataCollectionChange();
1425 virtual void collectProxyInfo(ProxyInfo *info);
1426
1427 void updateRackBinding();
1428 void updateControllerBinding();
1429
1430 public:
1431 Chassis();
1432 Chassis(const TCHAR *name, UINT32 controllerId);
1433 virtual ~Chassis();
1434
1435 virtual int getObjectClass() const { return OBJECT_CHASSIS; }
1436 virtual bool saveToDatabase(DB_HANDLE hdb);
1437 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1438 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
1439 virtual void linkObjects();
1440 virtual bool showThresholdSummary();
1441 virtual UINT32 getEffectiveSourceNode(DCObject *dco);
1442
1443 virtual bool isReadyForStatusPoll() { return false; }
1444 virtual bool isReadyForConfigurationPoll() { return false; }
1445 virtual bool isReadyForInstancePoll() { return false; }
1446
1447 virtual NXSL_Value *createNXSLObject();
1448
1449 virtual json_t *toJson();
1450
1451 UINT32 getControllerId() const { return m_controllerId; }
1452 UINT32 getRackId() const { return m_rackId; }
1453 INT16 getRackHeight() const { return m_rackHeight; }
1454 INT16 getRackPosition() const { return m_rackPosition; }
1455 bool bindUnderController() { return (m_flags & CHF_BIND_UNDER_CONTROLLER) ? true : false; }
1456
1457 void setBindUnderController(bool doBind);
1458 };
1459
1460 /**
1461 * Sensor communication protocol type
1462 */
1463 #define SENSOR_PROTO_UNKNOWN 0
1464 #define COMM_LORAWAN 1
1465 #define COMM_DLMS 2
1466
1467 /**
1468 * Sensor device class
1469 */
1470 #define SENSOR_CLASS_UNKNOWN 0
1471 #define SENSOR_UPS 1
1472 #define SENSOR_WATER_METER 2
1473 #define SENSOR_ELECTR_METER 3
1474
1475 /**
1476 * Mobile device class
1477 */
1478 class NXCORE_EXPORTABLE Sensor : public DataCollectionTarget
1479 {
1480 protected:
1481 MacAddress m_macAddress;
1482 UINT32 m_deviceClass; // Internal device class UPS, meeter
1483 TCHAR *m_vendor; //Vendoer name lorawan...
1484 UINT32 m_commProtocol; // lorawan, dlms, dlms throuht other protocols
1485 TCHAR *m_xmlConfig; //protocol specific configuration
1486 TCHAR *m_xmlRegConfig; //protocol specific registration configuration (cannot be changed afterwards)
1487 TCHAR *m_serialNumber; //Device serial number
1488 TCHAR *m_deviceAddress; //in case lora - lorawan id
1489 TCHAR *m_metaType;//brief type hot water, elecrticety
1490 TCHAR *m_description; //brief description
1491 time_t m_lastConnectionTime;
1492 UINT32 m_frameCount; //zero when no info
1493 INT32 m_signalStrenght; //+1 when no information(cannot be +)
1494 INT32 m_signalNoise; //*10 from origin number //MAX_INT32 when no value
1495 UINT32 m_frequency; //*10 from origin number // 0 when no value
1496 UINT32 m_proxyNodeId;
1497
1498 virtual void fillMessageInternal(NXCPMessage *msg);
1499 virtual UINT32 modifyFromMessageInternal(NXCPMessage *request);
1500
1501 virtual void statusPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1502 virtual void configurationPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1503
1504 Sensor(TCHAR *name, UINT32 flags, MacAddress macAddress, UINT32 deviceClass, TCHAR *vendor,
1505 UINT32 commProtocol, TCHAR *xmlRegConfig, TCHAR *xmlConfig, TCHAR *serialNumber, TCHAR *deviceAddress,
1506 TCHAR *metaType, TCHAR *description, UINT32 proxyNode);
1507 static Sensor *registerLoraDevice(Sensor *sensor);
1508
1509 public:
1510 Sensor();
1511
1512 virtual ~Sensor();
1513 static Sensor *createSensor(TCHAR *name, NXCPMessage *msg);
1514
1515 virtual int getObjectClass() const { return OBJECT_SENSOR; }
1516 const TCHAR *getXmlConfig() const { return m_xmlConfig; }
1517 const TCHAR *getXmlRegConfig() const { return m_xmlRegConfig; }
1518 UINT32 getProxyNodeId() const { return m_proxyNodeId; }
1519 const TCHAR *getDeviceAddress() const { return m_deviceAddress; }
1520 const MacAddress getMacAddress() const { return m_macAddress; }
1521 time_t getLastContact() const { return m_lastConnectionTime; }
1522 UINT32 getSensorClass() const { return m_deviceClass; }
1523 const TCHAR *getVendor() const { return m_vendor; }
1524 UINT32 getCommProtocol() const { return m_commProtocol; }
1525 const TCHAR *getSerialNumber() const { return m_serialNumber; }
1526 const TCHAR *getMetaType() const { return m_metaType; }
1527 const TCHAR *getDescription() const { return m_description; }
1528 UINT32 getFrameCount() const { return m_frameCount; }
1529
1530 StringMap *getInstanceList(DCObject *dco);
1531
1532 UINT32 getItemFromAgent(const TCHAR *szParam, UINT32 dwBufSize, TCHAR *szBuffer);
1533 UINT32 getListFromAgent(const TCHAR *name, StringList **list);
1534
1535 void setProvisoned() { m_state |= SSF_PROVISIONED; }
1536
1537 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
1538 virtual bool saveToDatabase(DB_HANDLE hdb);
1539 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1540
1541 virtual NXSL_Value *createNXSLObject();
1542 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
1543 void calculateStatus(BOOL bForcedRecalc = FALSE);
1544
1545 virtual json_t *toJson();
1546
1547 AgentConnectionEx *getAgentConnection();
1548
1549 void checkDlmsConverterAccessibility();
1550 void prepareDlmsDciParameters(String &parameter);
1551 void prepareLoraDciParameters(String &parameter);
1552
1553 virtual void prepareForDeletion();
1554 };
1555
1556 class Subnet;
1557 struct ProxyInfo;
1558
1559 /**
1560 * Node subtypes
1561 */
1562 enum NodeType
1563 {
1564 NODE_TYPE_UNKNOWN = 0,
1565 NODE_TYPE_PHYSICAL = 1,
1566 NODE_TYPE_VIRTUAL = 2,
1567 NODE_TYPE_CONTROLLER = 3
1568 };
1569
1570 /**
1571 * Node agent compression modes
1572 */
1573 enum NodeAgentCompressionMode
1574 {
1575 NODE_AGENT_COMPRESSION_DEFAULT = 0,
1576 NODE_AGENT_COMPRESSION_ENABLED = 1,
1577 NODE_AGENT_COMPRESSION_DISABLED = 2
1578 };
1579
1580 /**
1581 * Routing loop event information
1582 */
1583 class RoutingLoopEvent
1584 {
1585 private:
1586 InetAddress m_address;
1587 UINT32 m_nodeId;
1588 UINT64 m_eventId;
1589
1590 public:
1591 RoutingLoopEvent(const InetAddress& address, UINT32 nodeId, UINT64 eventId)
1592 {
1593 m_address = address;
1594 m_nodeId = nodeId;
1595 m_eventId = eventId;
1596 }
1597
1598 const InetAddress& getAddress() const { return m_address; }
1599 UINT32 getNodeId() const { return m_nodeId; }
1600 UINT64 getEventId() const { return m_eventId; }
1601 };
1602
1603 /**
1604 * Proxy types
1605 */
1606 enum ProxyType
1607 {
1608 SNMP_PROXY = 0,
1609 SENSOR_PROXY = 1,
1610 MAX_PROXY_TYPE = 2
1611 };
1612
1613 /**
1614 * Node
1615 */
1616 class NXCORE_EXPORTABLE Node : public DataCollectionTarget
1617 {
1618 friend class Subnet;
1619
1620 private:
1621 /**
1622 * Delete agent connection
1623 */
1624 void deleteAgentConnection()
1625 {
1626 if (m_agentConnection != NULL)
1627 {
1628 m_agentConnection->decRefCount();
1629 m_agentConnection = NULL;
1630 }
1631 }
1632
1633 void onSnmpProxyChange(UINT32 oldProxy);
1634
1635 static void onDataCollectionChangeAsyncCallback(void *arg);
1636
1637 protected:
1638 InetAddress m_ipAddress;
1639 TCHAR m_primaryName[MAX_DNS_NAME];
1640 uuid m_tunnelId;
1641 UINT32 m_capabilities;
1642 NodeType m_type;
1643 TCHAR m_subType[MAX_NODE_SUBTYPE_LENGTH];
1644 int m_iPendingStatus;
1645 int m_iPollCount;
1646 int m_iRequiredPollCount;
1647 UINT32 m_zoneUIN;
1648 UINT16 m_agentPort;
1649 INT16 m_agentAuthMethod;
1650 INT16 m_agentCacheMode;
1651 INT16 m_agentCompressionMode; // agent compression mode (enabled/disabled/default)
1652 TCHAR m_szSharedSecret[MAX_SECRET_LENGTH];
1653 INT16 m_iStatusPollType;
1654 INT16 m_snmpVersion;
1655 UINT16 m_snmpPort;
1656 UINT16 m_nUseIfXTable;
1657 SNMP_SecurityContext *m_snmpSecurity;
1658 TCHAR m_agentVersion[MAX_AGENT_VERSION_LEN];
1659 TCHAR m_platformName[MAX_PLATFORM_NAME_LEN];
1660 TCHAR m_snmpObjectId[MAX_OID_LEN * 4];
1661 TCHAR *m_sysDescription; // Agent's System.Uname or SNMP sysDescr
1662 TCHAR *m_sysName; // SNMP sysName
1663 TCHAR *m_sysLocation; // SNMP sysLocation
1664 TCHAR *m_sysContact; // SNMP sysContact
1665 TCHAR *m_lldpNodeId; // lldpLocChassisId combined with lldpLocChassisIdSubtype, or NULL for non-LLDP nodes
1666 ObjectArray<LLDP_LOCAL_PORT_INFO> *m_lldpLocalPortInfo;
1667 NetworkDeviceDriver *m_driver;
1668 DriverData *m_driverData;
1669 ObjectArray<AgentParameterDefinition> *m_paramList; // List of supported parameters
1670 ObjectArray<AgentTableDefinition> *m_tableList; // List of supported tables
1671 time_t m_lastDiscoveryPoll;
1672 time_t m_lastTopologyPoll;
1673 time_t m_lastRTUpdate;
1674 time_t m_failTimeSNMP;
1675 time_t m_failTimeAgent;
1676 time_t m_downSince;
1677 time_t m_bootTime;
1678 time_t m_agentUpTime;
1679 time_t m_lastAgentCommTime;
1680 time_t m_lastAgentConnectAttempt;
1681 MUTEX m_hAgentAccessMutex;
1682 MUTEX m_hSmclpAccessMutex;
1683 MUTEX m_mutexRTAccess;
1684 MUTEX m_mutexTopoAccess;
1685 AgentConnectionEx *m_agentConnection;
1686 ObjectLock<AgentConnectionEx> *m_proxyConnections;
1687 SMCLP_Connection *m_smclpConnection;
1688 UINT64 m_lastAgentTrapId; // ID of last received agent trap
1689 UINT64 m_lastAgentPushRequestId; // ID of last received agent push request
1690 UINT32 m_lastSNMPTrapId;
1691 UINT64 m_lastSyslogMessageId; // ID of last received syslog message
1692 UINT32 m_pollerNode; // Node used for network service polling
1693 UINT32 m_agentProxy; // Node used as proxy for agent connection
1694 UINT32 m_snmpProxy; // Node used as proxy for SNMP requests
1695 UINT32 m_icmpProxy; // Node used as proxy for ICMP ping
1696 UINT64 m_lastEvents[MAX_LAST_EVENTS];
1697 ObjectArray<RoutingLoopEvent> *m_routingLoopEvents;
1698 ROUTING_TABLE *m_pRoutingTable;
1699 ForwardingDatabase *m_fdb;
1700 LinkLayerNeighbors *m_linkLayerNeighbors;
1701 VlanList *m_vlans;
1702 VrrpInfo *m_vrrpInfo;
1703 ObjectArray<WirelessStationInfo> *m_wirelessStations;
1704 int m_adoptedApCount;
1705 int m_totalApCount;
1706 BYTE m_baseBridgeAddress[MAC_ADDR_LENGTH]; // Bridge base address (dot1dBaseBridgeAddress in bridge MIB)
1707 NetworkMapObjectList *m_topology;
1708 time_t m_topologyRebuildTimestamp;
1709 ServerJobQueue *m_jobQueue;
1710 ComponentTree *m_components; // Hardware components
1711 ObjectArray<SoftwarePackage> *m_softwarePackages; // installed software packages
1712 ObjectArray<WinPerfObject> *m_winPerfObjects; // Windows performance objects
1713 AgentConnection *m_fileUpdateConn;
1714 INT16 m_rackHeight;
1715 INT16 m_rackPosition;
1716 UINT32 m_rackId;
1717 uuid m_rackImage;
1718 UINT32 m_chassisId;
1719 INT64 m_syslogMessageCount;
1720 INT64 m_snmpTrapCount;
1721 TCHAR m_sshLogin[MAX_SSH_LOGIN_LEN];
1722 TCHAR m_sshPassword[MAX_SSH_PASSWORD_LEN];
1723 UINT32 m_sshProxy;
1724 UINT32 m_portNumberingScheme;
1725 UINT32 m_portRowCount;
1726
1727 virtual void statusPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1728 virtual void configurationPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1729 virtual void topologyPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1730 virtual void routingTablePoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1731
1732 virtual bool isDataCollectionDisabled();
1733 virtual void collectProxyInfo(ProxyInfo *info);
1734
1735 virtual void prepareForDeletion();
1736 virtual void onObjectDelete(UINT32 dwObjectId);
1737
1738 virtual void fillMessageInternal(NXCPMessage *pMsg);
1739 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
1740
1741 virtual void updatePingData();
1742
1743 virtual void onDataCollectionChange();
1744
1745 virtual StringMap *getInstanceList(DCObject *dco);
1746
1747 void agentLock() { MutexLock(m_hAgentAccessMutex); }
1748 void agentUnlock() { MutexUnlock(m_hAgentAccessMutex); }
1749
1750 void smclpLock() { MutexLock(m_hSmclpAccessMutex); }
1751 void smclpUnlock() { MutexUnlock(m_hSmclpAccessMutex); }
1752
1753 void routingTableLock() { MutexLock(m_mutexRTAccess); }
1754 void routingTableUnlock() { MutexUnlock(m_mutexRTAccess); }
1755
1756 BOOL checkSNMPIntegerValue(SNMP_Transport *pTransport, const TCHAR *pszOID, int nValue);
1757 void checkOSPFSupport(SNMP_Transport *pTransport);
1758 void addVrrpInterfaces(InterfaceList *ifList);
1759 BOOL resolveName(BOOL useOnlyDNS);
1760 void setPrimaryIPAddress(const InetAddress& addr);
1761
1762 bool setAgentProxy(AgentConnectionEx *conn);
1763 bool isAgentCompressionAllowed();
1764
1765 UINT32 getInterfaceCount(Interface **ppInterface);
1766
1767 void checkInterfaceNames(InterfaceList *pIfList);
1768 bool filterInterface(InterfaceInfo *info);
1769 Subnet *createSubnet(InetAddress& baseAddr, bool syntheticMask);
1770 void checkAgentPolicyBinding(AgentConnection *conn);
1771 void updatePrimaryIpAddr();
1772 bool confPollAgent(UINT32 dwRqId);
1773 bool confPollSnmp(UINT32 dwRqId);
1774 NodeType detectNodeType();
1775 bool updateSoftwarePackages(PollerInfo *poller, UINT32 requestId);
1776 bool querySnmpSysProperty(SNMP_Transport *snmp, const TCHAR *oid, const TCHAR *propName, UINT32 pollRqId, TCHAR **value);
1777 void checkBridgeMib(SNMP_Transport *pTransport);
1778 void checkIfXTable(SNMP_Transport *pTransport);
1779 bool checkNetworkPath(UINT32 requestId);
1780 bool checkNetworkPathLayer2(UINT32 requestId, bool secondPass);
1781 bool checkNetworkPathLayer3(UINT32 requestId, bool secondPass);
1782 bool checkNetworkPathElement(UINT32 nodeId, const TCHAR *nodeType, bool isProxy, UINT32 requestId, bool secondPass);
1783
1784 void syncDataCollectionWithAgent(AgentConnectionEx *conn);
1785
1786 bool updateInterfaceConfiguration(UINT32 rqid, int maskBits);
1787 bool deleteDuplicateInterfaces(UINT32 rqid);
1788 void updatePhysicalContainerBinding(int containerClass, UINT32 containerId);
1789
1790 bool connectToAgent(UINT32 *error = NULL, UINT32 *socketError = NULL, bool *newConnection = NULL, bool forceConnect = false);
1791 void setLastAgentCommTime() { m_lastAgentCommTime = time(NULL); }
1792
1793 void buildIPTopologyInternal(NetworkMapObjectList &topology, int nDepth, UINT32 seedObject, bool vpnLink, bool includeEndNodes);
1794
1795 public:
1796 Node();
1797 Node(const InetAddress& addr, UINT32 flags, UINT32 capabilities, UINT32 agentProxy, UINT32 snmpProxy, UINT32 icmpProxy, UINT32 sshProxy, UINT32 zoneUIN);
1798 virtual ~Node();
1799
1800 virtual int getObjectClass() const { return OBJECT_NODE; }
1801
1802 virtual bool saveToDatabase(DB_HANDLE hdb);
1803 virtual bool saveRuntimeData(DB_HANDLE hdb);
1804 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1805 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
1806
1807 virtual bool isReadyForStatusPoll();
1808 virtual bool isReadyForDiscoveryPoll();
1809 virtual bool isReadyForRoutePoll();
1810 virtual bool isReadyForTopologyPoll();
1811
1812 virtual NXSL_Value *createNXSLObject();
1813
1814 virtual json_t *toJson();
1815
1816 TCHAR *expandText(const TCHAR *textTemplate, StringMap *inputFields, const TCHAR *userName);
1817
1818 Cluster *getMyCluster();
1819
1820 const InetAddress& getIpAddress() const { return m_ipAddress; }
1821 UINT32 getZoneUIN() const { return m_zoneUIN; }
1822 NodeType getType() const { return m_type; }
1823 const TCHAR *getSubType() const { return m_subType; }
1824
1825 UINT32 getCapabilities() { return m_capabilities; }
1826 void setCapabilitie(UINT32 flag) { lockProperties(); m_capabilities |= flag; setModified(); unlockProperties(); }
1827 void clearCapabilities(UINT32 flag) { lockProperties(); m_capabilities &= ~flag; setModified(); unlockProperties(); }
1828 void setLocalMgmtFlag() { m_capabilities |= NC_IS_LOCAL_MGMT; }
1829 void clearLocalMgmtFlag() { m_capabilities &= ~NC_IS_LOCAL_MGMT; }
1830
1831 void setType(NodeType type, const TCHAR *subType) { lockProperties(); m_type = type; nx_strncpy(m_subType, subType, MAX_NODE_SUBTYPE_LENGTH); unlockProperties(); }
1832
1833 bool isSNMPSupported() const { return m_capabilities & NC_IS_SNMP ? true : false; }
1834 bool isNativeAgent() const { return m_capabilities & NC_IS_NATIVE_AGENT ? true : false; }
1835 bool isBridge() const { return m_capabilities & NC_IS_BRIDGE ? true : false; }
1836 bool isRouter() const { return m_capabilities & NC_IS_ROUTER ? true : false; }
1837 bool isLocalManagement() const { return m_capabilities & NC_IS_LOCAL_MGMT ? true : false; }
1838 bool isPerVlanFdbSupported() const { return (m_driver != NULL) ? m_driver->isPerVlanFdbSupported() : false; }
1839 bool isWirelessController() const { return m_capabilities & NC_IS_WIFI_CONTROLLER ? true : false; }
1840
1841 const TCHAR *getAgentVersion() const { return m_agentVersion; }
1842 const TCHAR *getPlatformName() const { return m_platformName; }
1843 INT16 getSNMPVersion() const { return m_snmpVersion; }
1844 UINT16 getSNMPPort() const { return m_snmpPort; }
1845 const TCHAR *getSNMPObjectId() const { return m_snmpObjectId; }
1846 const TCHAR *getSysName() const { return CHECK_NULL_EX(m_sysName); }
1847 const TCHAR *getSysDescription() const { return CHECK_NULL_EX(m_sysDescription); }
1848 const TCHAR *getSysContact() const { return CHECK_NULL_EX(m_sysContact); }
1849 const TCHAR *getSysLocation() const { return CHECK_NULL_EX(m_sysLocation); }
1850 time_t getBootTime() const { return m_bootTime; }
1851 const TCHAR *getLLDPNodeId() const { return m_lldpNodeId; }
1852 const BYTE *getBridgeId() const { return m_baseBridgeAddress; }
1853 const TCHAR *getDriverName() const { return (m_driver != NULL) ? m_driver->getName() : _T("GENERIC"); }
1854 UINT16 getAgentPort() const { return m_agentPort; }
1855 INT16 getAgentAuthMethod() const { return m_agentAuthMethod; }
1856 INT16 getAgentCacheMode() const { return (m_state & NSF_CACHE_MODE_NOT_SUPPORTED) ? AGENT_CACHE_OFF : ((m_agentCacheMode == AGENT_CACHE_DEFAULT) ? g_defaultAgentCacheMode : m_agentCacheMode); }
1857 const TCHAR *getSharedSecret() const { return m_szSharedSecret; }
1858 UINT32 getRackId() const { return m_rackId; }
1859 INT16 getRackHeight() const { return m_rackHeight; }
1860 INT16 getRackPosition() const { return m_rackPosition; }
1861 bool hasFileUpdateConnection() const { lockProperties(); bool result = (m_fileUpdateConn != NULL); unlockProperties(); return result; }
1862 UINT32 getIcmpProxy() const { return m_icmpProxy; }
1863 const TCHAR *getSshLogin() const { return m_sshLogin; }
1864 const TCHAR *getSshPassword() const { return m_sshPassword; }
1865 UINT32 getSshProxy() const { return m_sshProxy; }
1866 time_t getLastAgentCommTime() const { return m_lastAgentCommTime; }
1867 const TCHAR *getPrimaryName() const { return m_primaryName; }
1868 const uuid& getTunnelId() const { return m_tunnelId; }
1869 void setNewTunnelBindFlag() { m_runtimeFlags |= NDF_NEW_TUNNEL_BIND; }
1870 void removeNewTunnelBindFlag() { m_runtimeFlags &= ~NDF_NEW_TUNNEL_BIND; }
1871
1872 bool isDown() { return (m_state & DCSF_UNREACHABLE) ? true : false; }
1873 time_t getDownTime() const { return m_downSince; }
1874
1875 void addInterface(Interface *pInterface) { addChild(pInterface); pInterface->addParent(this); }
1876 Interface *createNewInterface(InterfaceInfo *ifInfo, bool manuallyCreated, bool fakeInterface);
1877 Interface *createNewInterface(const InetAddress& ipAddr, BYTE *macAddr, bool fakeInterface);
1878 void deleteInterface(Interface *iface);
1879
1880 void setPrimaryName(const TCHAR *name) { nx_strncpy(m_primaryName, name, MAX_DNS_NAME); }
1881 void setAgentPort(UINT16 port) { m_agentPort = port; }
1882 void setSnmpPort(UINT16 port) { m_snmpPort = port; }
1883 void setSshCredentials(const TCHAR *login, const TCHAR *password);
1884 void changeIPAddress(const InetAddress& ipAddr);
1885 void changeZone(UINT32 newZone);
1886 void setTunnelId(const uuid& tunnelId);
1887 void setFileUpdateConnection(AgentConnection *conn);
1888 void clearDataCollectionConfigFromAgent(AgentConnectionEx *conn);
1889 void forceSyncDataCollectionConfig();
1890 void relatedNodeDataCollectionChanged() { onDataCollectionChange(); }
1891
1892 ARP_CACHE *getArpCache();
1893 InterfaceList *getInterfaceList();
1894 Interface *findInterfaceByIndex(UINT32 ifIndex);
1895 Interface *findInterfaceByName(const TCHAR *name);
1896 Interface *findInterfaceByMAC(const BYTE *macAddr);
1897 Interface *findInterfaceByIP(const InetAddress& addr);
1898 Interface *findInterfaceBySlotAndPort(UINT32 slot, UINT32 port);
1899 Interface *findBridgePort(UINT32 bridgePortNumber);
1900 AccessPoint *findAccessPointByMAC(const BYTE *macAddr);
1901 AccessPoint *findAccessPointByBSSID(const BYTE *bssid);
1902 AccessPoint *findAccessPointByRadioId(int rfIndex);
1903 ObjectArray<WirelessStationInfo> *getWirelessStations();
1904 bool isMyIP(const InetAddress& addr);
1905 void getInterfaceStatusFromSNMP(SNMP_Transport *pTransport, UINT32 dwIndex, int ifTableSuffixLen, UINT32 *ifTableSuffix, InterfaceAdminState *adminState, InterfaceOperState *operState);
1906 void getInterfaceStatusFromAgent(UINT32 dwIndex, InterfaceAdminState *adminState, InterfaceOperState *operState);
1907 ROUTING_TABLE *getRoutingTable();
1908 ROUTING_TABLE *getCachedRoutingTable() { return m_pRoutingTable; }
1909 LinkLayerNeighbors *getLinkLayerNeighbors();
1910 VlanList *getVlans();
1911 bool getNextHop(const InetAddress& srcAddr, const InetAddress& destAddr, InetAddress *nextHop, InetAddress *route, UINT32 *ifIndex, bool *isVpn, TCHAR *name);
1912 bool getOutwardInterface(const InetAddress& destAddr, InetAddress *srcAddr, UINT32 *srcIfIndex);
1913 ComponentTree *getComponents();
1914 bool getLldpLocalPortInfo(UINT32 idType, BYTE *id, size_t idLen, LLDP_LOCAL_PORT_INFO *port);
1915 void showLLDPInfo(CONSOLE_CTX console);
1916
1917 void setRecheckCapsFlag() { m_runtimeFlags |= NDF_RECHECK_CAPABILITIES; }
1918 void setDiscoveryPollTimeStamp();
1919 void topologyPollWorkerEntry(PollerInfo *poller);
1920 void topologyPollWorkerEntry(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1921 void resolveVlanPorts(VlanList *vlanList);
1922 void updateInterfaceNames(ClientSession *pSession, UINT32 dwRqId);
1923 void routingTablePollWorkerEntry(PollerInfo *poller);
1924 void routingTablePollWorkerEntry(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1925 void checkSubnetBinding();
1926 AccessPointState getAccessPointState(AccessPoint *ap, SNMP_Transport *snmpTransport);
1927 void setChassis(UINT32 chassisId);
1928
1929 void lockForDiscoveryPoll();
1930 void lockForRoutePoll();
1931 void lockForTopologyPoll();
1932 void forceConfigurationPoll() { m_runtimeFlags |= DCDF_FORCE_CONFIGURATION_POLL; }
1933
1934 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
1935
1936 bool checkAgentTrapId(UINT64 id);
1937 bool checkSNMPTrapId(UINT32 id);
1938 bool checkSyslogMessageId(UINT64 id);
1939 bool checkAgentPushRequestId(UINT64 id);
1940
1941 bool connectToSMCLP();
1942
1943 virtual UINT32 getInternalItem(const TCHAR *param, size_t bufSize, TCHAR *buffer);
1944
1945 UINT32 getItemFromSNMP(WORD port, const TCHAR *param, size_t bufSize, TCHAR *buffer, int interpretRawValue);
1946 UINT32 getTableFromSNMP(WORD port, const TCHAR *oid, ObjectArray<DCTableColumn> *columns, Table **table);
1947 UINT32 getListFromSNMP(WORD port, const TCHAR *oid, StringList **list);
1948 UINT32 getOIDSuffixListFromSNMP(WORD port, const TCHAR *oid, StringMap **values);
1949 UINT32 getItemFromCheckPointSNMP(const TCHAR *szParam, UINT32 dwBufSize, TCHAR *szBuffer);
1950 UINT32 getItemFromAgent(const TCHAR *szParam, UINT32 dwBufSize, TCHAR *szBuffer);
1951 UINT32 getTableFromAgent(const TCHAR *name, Table **table);
1952 UINT32 getListFromAgent(const TCHAR *name, StringList **list);
1953 UINT32 getItemForClient(int iOrigin, UINT32 userId, const TCHAR *pszParam, TCHAR *pszBuffer, UINT32 dwBufSize);
1954 UINT32 getTableForClient(const TCHAR *name, Table **table);
1955 UINT32 getItemFromSMCLP(const TCHAR *param, UINT32 bufSize, TCHAR *buffer);
1956
1957 virtual NXSL_Array *getParentsForNXSL();
1958 virtual NXSL_Array *getTemplatesForNXSL();
1959 NXSL_Array *getInterfacesForNXSL();
1960
1961 void openParamList(ObjectArray<AgentParameterDefinition> **paramList);
1962 void closeParamList() { unlockProperties(); }
1963
1964 void openTableList(ObjectArray<AgentTableDefinition> **tableList);
1965 void closeTableList() { unlockProperties(); }
1966
1967 AgentConnectionEx *createAgentConnection(bool sendServerId = false);
1968 AgentConnectionEx *acquireProxyConnection(ProxyType type, bool validate = false);
1969 SNMP_Transport *createSnmpTransport(WORD port = 0, const TCHAR *context = NULL);
1970 SNMP_SecurityContext *getSnmpSecurityContext() const;
1971 UINT32 getEffectiveSnmpProxy() const;
1972
1973 void writeParamListToMessage(NXCPMessage *pMsg, WORD flags);
1974 void writeWinPerfObjectsToMessage(NXCPMessage *msg);
1975 void writePackageListToMessage(NXCPMessage *msg);
1976 void writeWsListToMessage(NXCPMessage *msg);
1977
1978 UINT32 wakeUp();
1979
1980 void addService(NetworkService *pNetSrv) { addChild(pNetSrv); pNetSrv->addParent(this); }
1981 UINT32 checkNetworkService(UINT32 *pdwStatus, const InetAddress& ipAddr, int iServiceType, WORD wPort = 0,
1982 WORD wProto = 0, TCHAR *pszRequest = NULL, TCHAR *pszResponse = NULL, UINT32 *responseTime = NULL);
1983
1984 UINT64 getLastEventId(int index) { return ((index >= 0) && (index < MAX_LAST_EVENTS)) ? m_lastEvents[index] : 0; }
1985 void setLastEventId(int index, UINT64 eventId) { if ((index >= 0) && (index < MAX_LAST_EVENTS)) m_lastEvents[index] = eventId; }
1986 void setRoutingLoopEvent(const InetAddress& address, UINT32 nodeId, UINT64 eventId);
1987
1988 UINT32 callSnmpEnumerate(const TCHAR *pszRootOid,
1989 UINT32 (* pHandler)(SNMP_Variable *, SNMP_Transport *, void *), void *pArg, const TCHAR *context = NULL);
1990
1991 NetworkMapObjectList *getL2Topology();
1992 NetworkMapObjectList *buildL2Topology(UINT32 *pdwStatus, int radius, bool includeEndNodes);
1993 ForwardingDatabase *getSwitchForwardingDatabase();
1994 NetObj *findConnectionPoint(UINT32 *localIfId, BYTE *localMacAddr, int *type);
1995 void addHostConnections(LinkLayerNeighbors *nbs);
1996 void addExistingConnections(LinkLayerNeighbors *nbs);
1997
1998 NetworkMapObjectList *buildIPTopology(UINT32 *pdwStatus, int radius, bool includeEndNodes);
1999
2000 ServerJobQueue *getJobQueue() { return m_jobQueue; }
2001 int getJobCount(const TCHAR *type = NULL) { return m_jobQueue->getJobCount(type); }
2002
2003 DriverData *getDriverData() { return m_driverData; }
2004 void setDriverData(DriverData *data) { m_driverData = data; }
2005
2006 void incSyslogMessageCount();
2007 void incSnmpTrapCount();
2008
2009 static const TCHAR *typeName(NodeType type);
2010 };
2011
2012 /**
2013 * Set timestamp of last discovery poll to current time
2014 */
2015 inline void Node::setDiscoveryPollTimeStamp()
2016 {
2017 m_lastDiscoveryPoll = time(NULL);
2018 m_runtimeFlags &= ~NDF_QUEUED_FOR_DISCOVERY_POLL;
2019 }
2020
2021 inline bool Node::isReadyForStatusPoll()
2022 {
2023 if (m_isDeleted)
2024 return false;
2025 if (m_runtimeFlags & DCDF_FORCE_STATUS_POLL)
2026 {
2027 m_runtimeFlags &= ~DCDF_FORCE_STATUS_POLL;
2028 return true;
2029 }
2030 return (m_status != STATUS_UNMANAGED) &&
2031 (!(m_flags & DCF_DISABLE_STATUS_POLL)) &&
2032 (!(m_runtimeFlags & DCDF_QUEUED_FOR_STATUS_POLL)) &&
2033 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
2034 (getMyCluster() == NULL) &&
2035 ((UINT32)(time(NULL) - m_lastStatusPoll) > g_dwStatusPollingInterval);
2036 }
2037
2038 inline bool Node::isReadyForDiscoveryPoll()
2039 {
2040 if (m_isDeleted)
2041 return false;
2042 return (g_flags & AF_ENABLE_NETWORK_DISCOVERY) &&
2043 (m_status != STATUS_UNMANAGED) &&
2044 (!(m_flags & NF_DISABLE_DISCOVERY_POLL)) &&
2045 (!(m_runtimeFlags & NDF_QUEUED_FOR_DISCOVERY_POLL)) &&
2046 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
2047 (m_runtimeFlags & DCDF_CONFIGURATION_POLL_PASSED) &&
2048 ((UINT32)(time(NULL) - m_lastDiscoveryPoll) > g_dwDiscoveryPollingInterval);
2049 }
2050
2051 inline bool Node::isReadyForRoutePoll()
2052 {
2053 if (m_isDeleted)
2054 return false;
2055 return (m_status != STATUS_UNMANAGED) &&
2056 (!(m_flags & NF_DISABLE_ROUTE_POLL)) &&
2057 (!(m_runtimeFlags & NDF_QUEUED_FOR_ROUTE_POLL)) &&
2058 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
2059 (m_runtimeFlags & DCDF_CONFIGURATION_POLL_PASSED) &&
2060 ((UINT32)(time(NULL) - m_lastRTUpdate) > g_dwRoutingTableUpdateInterval);
2061 }
2062
2063 inline bool Node::isReadyForTopologyPoll()
2064 {
2065 if (m_isDeleted)
2066 return false;
2067 return (m_status != STATUS_UNMANAGED) &&
2068 (!(m_flags & NF_DISABLE_TOPOLOGY_POLL)) &&
2069 (!(m_runtimeFlags & NDF_QUEUED_FOR_TOPOLOGY_POLL)) &&
2070 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
2071 (m_runtimeFlags & DCDF_CONFIGURATION_POLL_PASSED) &&
2072 ((UINT32)(time(NULL) - m_lastTopologyPoll) > g_dwTopologyPollingInterval);
2073 }
2074
2075 inline void Node::lockForDiscoveryPoll()
2076 {
2077 lockProperties();
2078 m_runtimeFlags |= NDF_QUEUED_FOR_DISCOVERY_POLL;
2079 unlockProperties();
2080 }
2081
2082 inline void Node::lockForTopologyPoll()
2083 {
2084 lockProperties();
2085 m_runtimeFlags |= NDF_QUEUED_FOR_TOPOLOGY_POLL;
2086 unlockProperties();
2087 }
2088
2089 inline void Node::lockForRoutePoll()
2090 {
2091 lockProperties();
2092 m_runtimeFlags |= NDF_QUEUED_FOR_ROUTE_POLL;
2093 unlockProperties();
2094 }
2095
2096 /**
2097 * Subnet
2098 */
2099 class NXCORE_EXPORTABLE Subnet : public NetObj
2100 {
2101 friend void Node::buildIPTopologyInternal(NetworkMapObjectList &topology, int nDepth, UINT32 seedSubnet, bool vpnLink, bool includeEndNodes);
2102
2103 protected:
2104 InetAddress m_ipAddress;
2105 UINT32 m_zoneUIN;
2106 bool m_bSyntheticMask;
2107
2108 virtual void prepareForDeletion();
2109
2110 virtual void fillMessageInternal(NXCPMessage *pMsg);
2111
2112 void buildIPTopologyInternal(NetworkMapObjectList &topology, int nDepth, UINT32 seedNode, bool includeEndNodes);
2113
2114 public:
2115 Subnet();
2116 Subnet(const InetAddress& addr, UINT32 zoneUIN, bool bSyntheticMask);
2117 virtual ~Subnet();
2118
2119 virtual int getObjectClass() const { return OBJECT_SUBNET; }
2120
2121 virtual bool saveToDatabase(DB_HANDLE hdb);
2122 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2123 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2124
2125 virtual json_t *toJson();
2126
2127 void addNode(Node *node) { addChild(node); node->addParent(this); calculateCompoundStatus(TRUE); }
2128
2129 virtual bool showThresholdSummary();
2130
2131 const InetAddress& getIpAddress() const { return m_ipAddress; }
2132 UINT32 getZoneUIN() const { return m_zoneUIN; }
2133 bool isSyntheticMask() const { return m_bSyntheticMask; }
2134
2135 void setCorrectMask(const InetAddress& addr);
2136
2137 bool findMacAddress(const InetAddress& ipAddr, BYTE *macAddr);
2138
2139 UINT32 *buildAddressMap(int *length);
2140 };
2141
2142 /**
2143 * Universal root object
2144 */
2145 class NXCORE_EXPORTABLE UniversalRoot : public NetObj
2146 {
2147 using NetObj::loadFromDatabase;
2148
2149 public:
2150 UniversalRoot();
2151 virtual ~UniversalRoot();
2152
2153 virtual bool saveToDatabase(DB_HANDLE hdb);
2154 void loadFromDatabase(DB_HANDLE hdb);
2155 virtual void linkObjects();
2156 void linkObject(NetObj *pObject) { addChild(pObject); pObject->addParent(this); }
2157 };
2158
2159 /**
2160 * Service root
2161 */
2162 class NXCORE_EXPORTABLE ServiceRoot : public UniversalRoot
2163 {
2164 public:
2165 ServiceRoot();
2166 virtual ~ServiceRoot();
2167
2168 virtual int getObjectClass() const { return OBJECT_SERVICEROOT; }
2169
2170 virtual bool showThresholdSummary();
2171 };
2172
2173 /**
2174 * Template root
2175 */
2176 class NXCORE_EXPORTABLE TemplateRoot : public UniversalRoot
2177 {
2178 public:
2179 TemplateRoot();
2180 virtual ~TemplateRoot();
2181
2182 virtual int getObjectClass() const { return OBJECT_TEMPLATEROOT; }
2183 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2184 };
2185
2186 /**
2187 * Generic container object
2188 */
2189 class NXCORE_EXPORTABLE Container : public NetObj
2190 {
2191 private:
2192 UINT32 *m_pdwChildIdList;
2193 UINT32 m_dwChildIdListSize;
2194
2195 protected:
2196 NXSL_Program *m_bindFilter;
2197 TCHAR *m_bindFilterSource;
2198
2199 virtual void fillMessageInternal(NXCPMessage *msg);
2200 virtual UINT32 modifyFromMessageInternal(NXCPMessage *request);
2201
2202 void setAutoBindFilterInternal(const TCHAR *script);
2203
2204 public:
2205 Container();
2206 Container(const TCHAR *pszName, UINT32 dwCategory);
2207 virtual ~Container();
2208
2209 virtual int getObjectClass() const { return OBJECT_CONTAINER; }
2210
2211 virtual bool saveToDatabase(DB_HANDLE hdb);
2212 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2213 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2214 virtual void linkObjects();
2215
2216 virtual bool showThresholdSummary();
2217
2218 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2219
2220 virtual json_t *toJson();
2221
2222 virtual NXSL_Value *createNXSLObject();
2223
2224 void linkObject(NetObj *pObject) { addChild(pObject); pObject->addParent(this); }
2225
2226 AutoBindDecision isSuitableForObject(NetObj *object);
2227 bool isAutoBindEnabled() const { return (m_flags & CF_AUTO_BIND) ? true : false; }
2228 bool isAutoUnbindEnabled() const { return ((m_flags & (CF_AUTO_BIND | CF_AUTO_UNBIND)) == (CF_AUTO_BIND | CF_AUTO_UNBIND)) ? true : false; }
2229 const TCHAR *getAutoBindScriptSource() const { return m_bindFilterSource; }
2230
2231 void setAutoBindFilter(const TCHAR *script) { lockProperties(); setAutoBindFilterInternal(script); unlockProperties(); }
2232 void setAutoBindMode(bool doBind, bool doUnbind);
2233 };
2234
2235 /**
2236 * Template group object
2237 */
2238 class NXCORE_EXPORTABLE TemplateGroup : public Container
2239 {
2240 public:
2241 TemplateGroup() : Container() { }
2242 TemplateGroup(const TCHAR *pszName) : Container(pszName, 0) { m_status = STATUS_NORMAL; }
2243 virtual ~TemplateGroup() { }
2244
2245 virtual int getObjectClass() const { return OBJECT_TEMPLATEGROUP; }
2246 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2247
2248 virtual bool showThresholdSummary();
2249 };
2250
2251 /**
2252 * Rack object
2253 */
2254 class NXCORE_EXPORTABLE Rack : public Container
2255 {
2256 protected:
2257 int m_height; // Rack height in units
2258 bool m_topBottomNumbering;
2259
2260 virtual void fillMessageInternal(NXCPMessage *pMsg);
2261 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2262
2263 public:
2264 Rack();
2265 Rack(const TCHAR *name, int height);
2266 virtual ~Rack();
2267
2268 virtual int getObjectClass() const { return OBJECT_RACK; }
2269
2270 virtual bool saveToDatabase(DB_HANDLE hdb);
2271 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2272 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2273
2274 virtual json_t *toJson();
2275 };
2276
2277 /**
2278 * Zone object
2279 */
2280 class NXCORE_EXPORTABLE Zone : public NetObj
2281 {
2282 protected:
2283 UINT32 m_uin;
2284 UINT32 m_proxyNodeId;
2285 InetAddressIndex *m_idxNodeByAddr;
2286 InetAddressIndex *m_idxInterfaceByAddr;
2287 InetAddressIndex *m_idxSubnetByAddr;
2288
2289 virtual void fillMessageInternal(NXCPMessage *msg);
2290 virtual UINT32 modifyFromMessageInternal(NXCPMessage *request);
2291
2292 public:
2293 Zone();
2294 Zone(UINT32 uin, const TCHAR *name);
2295 virtual ~Zone();
2296
2297 virtual int getObjectClass() const { return OBJECT_ZONE; }
2298
2299 virtual bool saveToDatabase(DB_HANDLE hdb);
2300 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2301 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2302
2303 virtual bool showThresholdSummary();
2304
2305 virtual NXSL_Value *createNXSLObject();
2306
2307 virtual json_t *toJson();
2308
2309 UINT32 getUIN() const { return m_uin; }
2310 UINT32 getProxyNodeId() const { return m_proxyNodeId; }
2311
2312 void addSubnet(Subnet *pSubnet) { addChild(pSubnet); pSubnet->addParent(this); }
2313
2314 void addToIndex(Subnet *subnet) { m_idxSubnetByAddr->put(subnet->getIpAddress(), subnet); }
2315 void addToIndex(Interface *iface) { m_idxInterfaceByAddr->put(iface->getIpAddressList(), iface); }
2316 void addToIndex(const InetAddress& addr, Interface *iface) { m_idxInterfaceByAddr->put(addr, iface); }
2317 void addToIndex(Node *node) { m_idxNodeByAddr->put(node->getIpAddress(), node); }
2318 void removeFromIndex(Subnet *subnet) { m_idxSubnetByAddr->remove(subnet->getIpAddress()); }
2319 void removeFromIndex(Interface *iface);
2320 void removeFromInterfaceIndex(const InetAddress& addr) { m_idxInterfaceByAddr->remove(addr); }
2321 void removeFromIndex(Node *node) { m_idxNodeByAddr->remove(node->getIpAddress()); }
2322 void updateInterfaceIndex(const InetAddress& oldIp, const InetAddress& newIp, Interface *iface);
2323 Subnet *getSubnetByAddr(const InetAddress& ipAddr) { return (Subnet *)m_idxSubnetByAddr->get(ipAddr); }
2324 Interface *getInterfaceByAddr(const InetAddress& ipAddr) { return (Interface *)m_idxInterfaceByAddr->get(ipAddr); }
2325 Node *getNodeByAddr(const InetAddress& ipAddr) { return (Node *)m_idxNodeByAddr->get(ipAddr); }
2326 Subnet *findSubnet(bool (*comparator)(NetObj *, void *), void *data) { return (Subnet *)m_idxSubnetByAddr->find(comparator, data); }
2327 Interface *findInterface(bool (*comparator)(NetObj *, void *), void *data) { return (Interface *)m_idxInterfaceByAddr->find(comparator, data); }
2328 Node *findNode(bool (*comparator)(NetObj *, void *), void *data) { return (Node *)m_idxNodeByAddr->find(comparator, data); }
2329 void forEachSubnet(void (*callback)(const InetAddress& addr, NetObj *, void *), void *data) { m_idxSubnetByAddr->forEach(callback, data); }
2330 ObjectArray<NetObj> *getSubnets(bool updateRefCount) { return m_idxSubnetByAddr->getObjects(updateRefCount); }
2331 void dumpInterfaceIndex(CONSOLE_CTX console);
2332 void dumpNodeIndex(CONSOLE_CTX console);
2333 void dumpSubnetIndex(CONSOLE_CTX console);
2334 };
2335
2336 /**
2337 * Entire network
2338 */
2339 class NXCORE_EXPORTABLE Network : public NetObj
2340 {
2341 using NetObj::loadFromDatabase;
2342
2343 public:
2344 Network();
2345 virtual ~Network();
2346
2347 virtual int getObjectClass() const { return OBJECT_NETWORK; }
2348 virtual bool saveToDatabase(DB_HANDLE hdb);
2349
2350 virtual bool showThresholdSummary();
2351
2352 void AddSubnet(Subnet *pSubnet) { addChild(pSubnet); pSubnet->addParent(this); }
2353 void AddZone(Zone *pZone) { addChild(pZone); pZone->addParent(this); }
2354 void loadFromDatabase(DB_HANDLE hdb);
2355 };
2356
2357 /**
2358 * Condition
2359 */
2360 class NXCORE_EXPORTABLE ConditionObject : public NetObj
2361 {
2362 protected:
2363 UINT32 m_dciCount;
2364 INPUT_DCI *m_dciList;
2365 TCHAR *m_scriptSource;
2366 NXSL_VM *m_script;
2367 UINT32 m_activationEventCode;
2368 UINT32 m_deactivationEventCode;
2369 UINT32 m_sourceObject;
2370 int m_activeStatus;
2371 int m_inactiveStatus;
2372 bool m_isActive;
2373 time_t m_lastPoll;
2374 bool m_queuedForPolling;
2375
2376 virtual void fillMessageInternal(NXCPMessage *pMsg);
2377 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2378
2379 public:
2380 ConditionObject();
2381 ConditionObject(bool hidden);
2382 virtual ~ConditionObject();
2383
2384 virtual int getObjectClass() const { return OBJECT_CONDITION; }
2385
2386 virtual bool saveToDatabase(DB_HANDLE hdb);
2387 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2388 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2389
2390 virtual json_t *toJson();
2391
2392 void lockForPoll();
2393 void doPoll(PollerInfo *poller);
2394 void check();
2395
2396 bool isReadyForPoll()
2397 {
2398 return ((m_status != STATUS_UNMANAGED) &&
2399 (!m_queuedForPolling) && (!m_isDeleted) &&
2400 ((UINT32)time(NULL) - (UINT32)m_lastPoll > g_dwConditionPollingInterval));
2401 }
2402
2403 int getCacheSizeForDCI(UINT32 itemId, bool noLock);
2404 };
2405
2406 /**
2407 * Generic agent policy object
2408 */
2409 class NXCORE_EXPORTABLE AgentPolicy : public NetObj
2410 {
2411 protected:
2412 UINT32 m_version;
2413 int m_policyType;
2414
2415 BOOL savePolicyCommonProperties(DB_HANDLE hdb);
2416
2417 virtual void fillMessageInternal(NXCPMessage *pMsg);
2418 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2419
2420 public:
2421 AgentPolicy(int type);
2422 AgentPolicy(const TCHAR *name, int type);
2423
2424 virtual int getObjectClass() const { return OBJECT_AGENTPOLICY; }
2425
2426 virtual bool saveToDatabase(DB_HANDLE hdb);
2427 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2428 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2429
2430 virtual json_t *toJson();
2431
2432 virtual bool createDeploymentMessage(NXCPMessage *msg);
2433 virtual bool createUninstallMessage(NXCPMessage *msg);
2434
2435 void linkNode(Node *node) { addChild(node); node->addParent(this); }
2436 void unlinkNode(Node *node) { deleteChild(node); node->deleteParent(this); }
2437 };
2438
2439 /**
2440 * Agent config policy object
2441 */
2442 class NXCORE_EXPORTABLE AgentPolicyConfig : public AgentPolicy
2443 {
2444 protected:
2445 TCHAR *m_fileContent;
2446
2447 virtual void fillMessageInternal(NXCPMessage *pMsg);
2448 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2449
2450 public:
2451 AgentPolicyConfig();
2452 AgentPolicyConfig(const TCHAR *name);
2453 virtual ~AgentPolicyConfig();
2454
2455 virtual int getObjectClass() const { return OBJECT_AGENTPOLICY_CONFIG; }
2456
2457 virtual bool saveToDatabase(DB_HANDLE hdb);
2458 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2459 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2460
2461 virtual json_t *toJson();
2462
2463 virtual bool createDeploymentMessage(NXCPMessage *msg);
2464 virtual bool createUninstallMessage(NXCPMessage *msg);
2465 };
2466
2467 /**
2468 * Log parser configuration policy object
2469 */
2470 class NXCORE_EXPORTABLE AgentPolicyLogParser : public AgentPolicy
2471 {
2472 protected:
2473 TCHAR *m_fileContent;
2474
2475 virtual void fillMessageInternal(NXCPMessage *pMsg);
2476 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2477 public:
2478 AgentPolicyLogParser();
2479 AgentPolicyLogParser(const TCHAR *name);
2480 virtual ~AgentPolicyLogParser();
2481
2482 virtual int getObjectClass() const { return OBJECT_AGENTPOLICY_LOGPARSER; }
2483
2484 virtual bool saveToDatabase(DB_HANDLE hdb);
2485 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2486 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2487
2488 virtual json_t *toJson();
2489
2490 virtual bool createDeploymentMessage(NXCPMessage *msg);
2491 virtual bool createUninstallMessage(NXCPMessage *msg);
2492 };
2493
2494 /**
2495 * Policy group object
2496 */
2497 class NXCORE_EXPORTABLE PolicyGroup : public Container
2498 {
2499 public:
2500 PolicyGroup() : Container() { }
2501 PolicyGroup(const TCHAR *pszName) : Container(pszName, 0) { }
2502 virtual ~PolicyGroup() { }
2503
2504 virtual int getObjectClass() const { return OBJECT_POLICYGROUP; }
2505 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2506
2507 virtual bool showThresholdSummary();
2508 };
2509
2510 /**
2511 * Policy root
2512 */
2513 class NXCORE_EXPORTABLE PolicyRoot : public UniversalRoot
2514 {
2515 public:
2516 PolicyRoot();
2517 virtual ~PolicyRoot();
2518
2519 virtual int getObjectClass() const { return OBJECT_POLICYROOT; }
2520 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2521 };
2522
2523 /**
2524 * Network map root
2525 */
2526 class NXCORE_EXPORTABLE NetworkMapRoot : public UniversalRoot
2527 {
2528 public:
2529 NetworkMapRoot();
2530 virtual ~NetworkMapRoot();
2531
2532 virtual int getObjectClass() const { return OBJECT_NETWORKMAPROOT; }
2533 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2534 };
2535
2536 /**
2537 * Network map group object
2538 */
2539 class NXCORE_EXPORTABLE NetworkMapGroup : public Container
2540 {
2541 public:
2542 NetworkMapGroup() : Container() { }
2543 NetworkMapGroup(const TCHAR *pszName) : Container(pszName, 0) { }
2544 virtual ~NetworkMapGroup() { }
2545
2546 virtual int getObjectClass() const { return OBJECT_NETWORKMAPGROUP; }
2547 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2548
2549 virtual bool showThresholdSummary();
2550 };
2551
2552 /**
2553 * Network map object
2554 */
2555 class NXCORE_EXPORTABLE NetworkMap : public NetObj
2556 {
2557 protected:
2558 int m_mapType;
2559 IntegerArray<UINT32> *m_seedObjects;
2560 int m_discoveryRadius;
2561 int m_layout;
2562 int m_backgroundColor;
2563 int m_defaultLinkColor;
2564 int m_defaultLinkRouting;
2565 int m_objectDisplayMode;
2566 uuid m_background;
2567 double m_backgroundLatitude;
2568 double m_backgroundLongitude;
2569 int m_backgroundZoom;
2570 UINT32 m_nextElementId;
2571 ObjectArray<NetworkMapElement> *m_elements;
2572 ObjectArray<NetworkMapLink> *m_links;
2573 TCHAR *m_filterSource;
2574 NXSL_VM *m_filter;
2575
2576 virtual void fillMessageInternal(NXCPMessage *pMsg);
2577 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2578
2579 void updateObjects(NetworkMapObjectList *objects);
2580 UINT32 objectIdFromElementId(UINT32 eid);
2581 UINT32 elementIdFromObjectId(UINT32 eid);
2582
2583 void setFilter(const TCHAR *filter);
2584
2585 public:
2586 NetworkMap();
2587 NetworkMap(int type, IntegerArray<UINT32> *seeds);
2588 virtual ~NetworkMap();
2589
2590 virtual int getObjectClass() const { return OBJECT_NETWORKMAP; }
2591 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2592
2593 virtual bool saveToDatabase(DB_HANDLE hdb);
2594 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2595 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2596
2597 virtual void onObjectDelete(UINT32 dwObjectId);
2598
2599 virtual json_t *toJson();
2600
2601 void updateContent();
2602
2603 int getBackgroundColor() { return m_backgroundColor; }
2604 void setBackgroundColor(int color) { m_backgroundColor = color; }
2605
2606 bool isAllowedOnMap(NetObj *object);
2607 };
2608
2609 /**
2610 * Dashboard tree root
2611 */
2612 class NXCORE_EXPORTABLE DashboardRoot : public UniversalRoot
2613 {
2614 public:
2615 DashboardRoot();
2616 virtual ~DashboardRoot();
2617
2618 virtual int getObjectClass() const { return OBJECT_DASHBOARDROOT; }
2619 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2620 };
2621
2622 /**
2623 * Dashboard element
2624 */
2625 class NXCORE_EXPORTABLE DashboardElement
2626 {
2627 public:
2628 int m_type;
2629 TCHAR *m_data;
2630 TCHAR *m_layout;
2631
2632 DashboardElement() { m_data = NULL; m_layout = NULL; }
2633 ~DashboardElement() { free(m_data); free(m_layout); }
2634
2635 json_t *toJson()
2636 {
2637 json_t *root = json_object();
2638 json_object_set_new(root, "type", json_integer(m_type));
2639 json_object_set_new(root, "data", json_string_t(m_data));
2640 json_object_set_new(root, "layout", json_string_t(m_layout));
2641 return root;
2642 }
2643 };
2644
2645 /**
2646 * Dashboard object
2647 */
2648 class NXCORE_EXPORTABLE Dashboard : public Container
2649 {
2650 protected:
2651 int m_numColumns;
2652 UINT32 m_options;
2653 ObjectArray<DashboardElement> *m_elements;
2654
2655 virtual void fillMessageInternal(NXCPMessage *pMsg);
2656 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2657
2658 public:
2659 Dashboard();
2660 Dashboard(const TCHAR *name);
2661 virtual ~Dashboard();
2662
2663 virtual int getObjectClass() const { return OBJECT_DASHBOARD; }
2664 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2665
2666 virtual bool saveToDatabase(DB_HANDLE hdb);
2667 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2668 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2669
2670 virtual json_t *toJson();
2671
2672 virtual bool showThresholdSummary();
2673 };
2674
2675 /**
2676 * Dashboard group object
2677 */
2678 class NXCORE_EXPORTABLE DashboardGroup : public Container
2679 {
2680 public:
2681 DashboardGroup() : Container() { }
2682 DashboardGroup(const TCHAR *pszName) : Container(pszName, 0) { }
2683 virtual ~DashboardGroup() { }
2684
2685 virtual int getObjectClass() const { return OBJECT_DASHBOARDGROUP; }
2686 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2687
2688 virtual bool showThresholdSummary();
2689 };
2690
2691 /**
2692 * SLM check object
2693 */
2694 class NXCORE_EXPORTABLE SlmCheck : public NetObj
2695 {
2696 protected:
2697 static NXSL_VariableSystem m_nxslConstants;
2698
2699 Threshold *m_threshold;
2700 enum CheckType { check_undefined = 0, check_script = 1, check_threshold = 2 } m_type;
2701 TCHAR *m_script;
2702 NXSL_VM *m_pCompiledScript;
2703 TCHAR m_reason[256];
2704 bool m_isTemplate;
2705 UINT32 m_templateId;
2706 UINT32 m_currentTicketId;
2707
2708 virtual void onObjectDelete(UINT32 objectId);
2709
2710 virtual void fillMessageInternal(NXCPMessage *pMsg);
2711 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2712
2713 void setScript(const TCHAR *script);
2714 UINT32 getOwnerId();
2715 NXSL_Value *getNodeObjectForNXSL();
2716 bool insertTicket();
2717 void closeTicket();
2718 void setReason(const TCHAR *reason) { nx_strncpy(m_reason, CHECK_NULL_EX(reason), 256); }
2719 void compileScript();
2720
2721 public:
2722 SlmCheck();
2723 SlmCheck(const TCHAR *name, bool isTemplate);
2724 SlmCheck(SlmCheck *tmpl);
2725 virtual ~SlmCheck();
2726
2727 static void init();
2728
2729 virtual int getObjectClass() const { return OBJECT_SLMCHECK; }
2730
2731 virtual bool saveToDatabase(DB_HANDLE hdb);
2732 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2733 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2734
2735 virtual void postModify();
2736
2737 void execute();
2738 void updateFromTemplate(SlmCheck *tmpl);
2739
2740 bool isTemplate() { return m_isTemplate; }
2741 UINT32 getTemplateId() { return m_templateId; }
2742 const TCHAR *getReason() { return m_reason; }
2743 };
2744
2745 /**
2746 * Service container - common logic for BusinessService, NodeLink and BusinessServiceRoot
2747 */
2748 class NXCORE_EXPORTABLE ServiceContainer : public Container
2749 {
2750 enum Period { DAY, WEEK, MONTH };
2751
2752 protected:
2753 time_t m_prevUptimeUpdateTime;
2754 int m_prevUptimeUpdateStatus;
2755 double m_uptimeDay;
2756 double m_uptimeWeek;
2757 double m_uptimeMonth;
2758 INT32 m_downtimeDay;
2759 INT32 m_downtimeWeek;
2760 INT32 m_downtimeMonth;
2761 INT32 m_prevDiffDay;
2762 INT32 m_prevDiffWeek;
2763 INT32 m_prevDiffMonth;
2764
2765 static INT32 logRecordId;
2766 static INT32 getSecondsInMonth();
2767 static INT32 getSecondsInPeriod(Period period) { return period == MONTH ? getSecondsInMonth() : (period == WEEK ? (3600 * 24 * 7) : (3600 * 24)); }
2768 static INT32 getSecondsSinceBeginningOf(Period period, time_t *beginTime = NULL);
2769
2770 virtual void fillMessageInternal(NXCPMessage *pMsg);
2771 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2772
2773 void initServiceContainer();
2774 BOOL addHistoryRecord();
2775 double getUptimeFromDBFor(Period period, INT32 *downtime);
2776
2777 public:
2778 ServiceContainer();
2779 ServiceContainer(const TCHAR *pszName);
2780
2781 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2782 virtual bool saveToDatabase(DB_HANDLE hdb);
2783 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2784
2785 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2786 virtual void setStatus(int newStatus);
2787
2788 virtual bool showThresholdSummary();
2789
2790 void initUptimeStats();
2791 void updateUptimeStats(time_t currentTime = 0, BOOL updateChilds = FALSE);
2792 };
2793
2794 /**
2795 * Business service root
2796 */
2797 class NXCORE_EXPORTABLE BusinessServiceRoot : public ServiceContainer
2798 {
2799 using ServiceContainer::loadFromDatabase;
2800
2801 public:
2802 BusinessServiceRoot();
2803 virtual ~BusinessServiceRoot();
2804
2805 virtual int getObjectClass() const { return OBJECT_BUSINESSSERVICEROOT; }
2806
2807 virtual bool saveToDatabase(DB_HANDLE hdb);
2808 void loadFromDatabase(DB_HANDLE hdb);
2809
2810 virtual void linkObjects();
2811
2812 void linkObject(NetObj *pObject) { addChild(pObject); pObject->addParent(this); }
2813 };
2814
2815 /**
2816 * Business service object
2817 */
2818 class NXCORE_EXPORTABLE BusinessService : public ServiceContainer
2819 {
2820 protected:
2821 bool m_busy;
2822 bool m_pollingDisabled;
2823 time_t m_lastPollTime;
2824 int m_lastPollStatus;
2825
2826 virtual void prepareForDeletion();
2827
2828 virtual void fillMessageInternal(NXCPMessage *pMsg);
2829 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2830
2831 public:
2832 BusinessService();
2833 BusinessService(const TCHAR *name);
2834 virtual ~BusinessService();
2835
2836 virtual int getObjectClass() const { return OBJECT_BUSINESSSERVICE; }
2837
2838 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2839 virtual bool saveToDatabase(DB_HANDLE hdb);
2840 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2841
2842 bool isReadyForPolling();
2843 void lockForPolling();
2844 void poll(PollerInfo *poller);
2845 void poll(ClientSession *pSession, UINT32 dwRqId, PollerInfo *poller);
2846
2847 void getApplicableTemplates(ServiceContainer *target, ObjectArray<SlmCheck> *templates);
2848 };
2849
2850 /**
2851 * Node link object for business service
2852 */
2853 class NXCORE_EXPORTABLE NodeLink : public ServiceContainer
2854 {
2855 protected:
2856 UINT32 m_nodeId;
2857
2858 virtual void onObjectDelete(UINT32 dwObjectId);
2859
2860 virtual void fillMessageInternal(NXCPMessage *pMsg);
2861 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2862
2863 void applyTemplate(SlmCheck *tmpl);
2864
2865 public:
2866 NodeLink();
2867 NodeLink(const TCHAR *name, UINT32 nodeId);
2868 virtual ~NodeLink();
2869
2870 virtual int getObjectClass() const { return OBJECT_NODELINK; }
2871
2872 virtual bool saveToDatabase(DB_HANDLE hdb);
2873 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2874 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2875
2876 void execute();
2877 void applyTemplates();
2878
2879 UINT32 getNodeId() { return m_nodeId; }
2880 };
2881
2882 /**
2883 * Get IP address for object
2884 */
2885 inline const InetAddress& GetObjectIpAddress(NetObj *object)
2886 {
2887 if (object->getObjectClass() == OBJECT_NODE)
2888 return ((Node *)object)->getIpAddress();
2889 if (object->getObjectClass() == OBJECT_SUBNET)
2890 return ((Subnet *)object)->getIpAddress();
2891 if (object->getObjectClass() == OBJECT_ACCESSPOINT)
2892 return ((AccessPoint *)object)->getIpAddress();
2893 if (object->getObjectClass() == OBJECT_INTERFACE)
2894 return ((Interface *)object)->getIpAddressList()->getFirstUnicastAddress();
2895 return InetAddress::INVALID;
2896 }
2897
2898 /**
2899 * Functions
2900 */
2901 void ObjectsInit();
2902
2903 void NXCORE_EXPORTABLE NetObjInsert(NetObj *object, bool newObject, bool importedObject);
2904 void NetObjDeleteFromIndexes(NetObj *object);
2905 void NetObjDelete(NetObj *object);
2906
2907 void UpdateInterfaceIndex(const InetAddress& oldIpAddr, const InetAddress& newIpAddr, Interface *iface);
2908 ComponentTree *BuildComponentTree(Node *node, SNMP_Transport *snmp);
2909
2910 void NXCORE_EXPORTABLE MacDbAddAccessPoint(AccessPoint *ap);
2911 void NXCORE_EXPORTABLE MacDbAddInterface(Interface *iface);
2912 void NXCORE_EXPORTABLE MacDbAddObject(const BYTE *macAddr, NetObj *object);
2913 void NXCORE_EXPORTABLE MacDbRemove(const BYTE *macAddr);
2914 NetObj NXCORE_EXPORTABLE *MacDbFind(const BYTE *macAddr);
2915
2916 NetObj NXCORE_EXPORTABLE *FindObjectById(UINT32 dwId, int objClass = -1);
2917 NetObj NXCORE_EXPORTABLE *FindObjectByName(const TCHAR *name, int objClass = -1);
2918 NetObj NXCORE_EXPORTABLE *FindObjectByGUID(const uuid& guid, int objClass = -1);
2919 NetObj NXCORE_EXPORTABLE *FindObject(bool (* comparator)(NetObj *, void *), void *userData, int objClass = -1);
2920 const TCHAR NXCORE_EXPORTABLE *GetObjectName(DWORD id, const TCHAR *defaultName);
2921 Template NXCORE_EXPORTABLE *FindTemplateByName(const TCHAR *pszName);
2922 Node NXCORE_EXPORTABLE *FindNodeByIP(UINT32 zoneUIN, const InetAddress& ipAddr);
2923 Node NXCORE_EXPORTABLE *FindNodeByIP(UINT32 zoneUIN, const InetAddressList *ipAddrList);
2924 Node NXCORE_EXPORTABLE *FindNodeByMAC(const BYTE *macAddr);
2925 Node NXCORE_EXPORTABLE *FindNodeByBridgeId(const BYTE *bridgeId);
2926 Node NXCORE_EXPORTABLE *FindNodeByLLDPId(const TCHAR *lldpId);
2927 Node NXCORE_EXPORTABLE *FindNodeBySysName(const TCHAR *sysName);
2928 ObjectArray<NetObj> *FindNodesByHostname(TCHAR *hostname, UINT32 zoneUIN);
2929 Interface NXCORE_EXPORTABLE *FindInterfaceByIP(UINT32 zoneUIN, const InetAddress& ipAddr);
2930 Interface NXCORE_EXPORTABLE *FindInterfaceByMAC(const BYTE *macAddr);
2931 Interface NXCORE_EXPORTABLE *FindInterfaceByDescription(const TCHAR *description);
2932 Subnet NXCORE_EXPORTABLE *FindSubnetByIP(UINT32 zoneUIN, const InetAddress& ipAddr);
2933 Subnet NXCORE_EXPORTABLE *FindSubnetForNode(UINT32 zoneUIN, const InetAddress& nodeAddr);
2934 MobileDevice NXCORE_EXPORTABLE *FindMobileDeviceByDeviceID(const TCHAR *deviceId);
2935 AccessPoint NXCORE_EXPORTABLE *FindAccessPointByMAC(const BYTE *macAddr);
2936 UINT32 NXCORE_EXPORTABLE FindLocalMgmtNode();
2937 Zone NXCORE_EXPORTABLE *FindZoneByUIN(UINT32 zoneUIN);
2938 UINT32 FindUnusedZoneUIN();
2939 bool NXCORE_EXPORTABLE IsClusterIP(UINT32 zoneUIN, const InetAddress& ipAddr);
2940 bool NXCORE_EXPORTABLE IsParentObject(UINT32 object1, UINT32 object2);
2941
2942 BOOL LoadObjects();
2943 void DumpObjects(CONSOLE_CTX pCtx, const TCHAR *filter);
2944
2945 bool NXCORE_EXPORTABLE CreateObjectAccessSnapshot(UINT32 userId, int objClass);
2946
2947 void DeleteUserFromAllObjects(UINT32 dwUserId);
2948
2949 bool IsValidParentClass(int childClass, int parentClass);
2950 bool IsAgentPolicyObject(NetObj *object);
2951 bool IsEventSource(int objectClass);
2952
2953 int DefaultPropagatedStatus(int iObjectStatus);
2954 int GetDefaultStatusCalculation(int *pnSingleThreshold, int **ppnThresholds);
2955
2956 PollerInfo *RegisterPoller(PollerType type, NetObj *object);
2957 void ShowPollers(CONSOLE_CTX console);
2958
2959 /**
2960 * Global variables
2961 */
2962 extern Network NXCORE_EXPORTABLE *g_pEntireNet;
2963 extern ServiceRoot NXCORE_EXPORTABLE *g_pServiceRoot;
2964 extern TemplateRoot NXCORE_EXPORTABLE *g_pTemplateRoot;
2965 extern PolicyRoot NXCORE_EXPORTABLE *g_pPolicyRoot;
2966 extern NetworkMapRoot NXCORE_EXPORTABLE *g_pMapRoot;
2967 extern DashboardRoot NXCORE_EXPORTABLE *g_pDashboardRoot;
2968 extern BusinessServiceRoot NXCORE_EXPORTABLE *g_pBusinessServiceRoot;
2969
2970 extern UINT32 NXCORE_EXPORTABLE g_dwMgmtNode;
2971 extern BOOL g_bModificationsLocked;
2972 extern Queue g_templateUpdateQueue;
2973
2974 extern ObjectIndex NXCORE_EXPORTABLE g_idxObjectById;
2975 extern InetAddressIndex NXCORE_EXPORTABLE g_idxSubnetByAddr;
2976 extern InetAddressIndex NXCORE_EXPORTABLE g_idxInterfaceByAddr;
2977 extern InetAddressIndex NXCORE_EXPORTABLE g_idxNodeByAddr;
2978 extern ObjectIndex NXCORE_EXPORTABLE g_idxZoneByUIN;
2979 extern ObjectIndex NXCORE_EXPORTABLE g_idxNodeById;
2980 extern ObjectIndex NXCORE_EXPORTABLE g_idxChassisById;
2981 extern ObjectIndex NXCORE_EXPORTABLE g_idxClusterById;
2982 extern ObjectIndex NXCORE_EXPORTABLE g_idxMobileDeviceById;
2983 extern ObjectIndex NXCORE_EXPORTABLE g_idxAccessPointById;
2984 extern ObjectIndex NXCORE_EXPORTABLE g_idxConditionById;
2985 extern ObjectIndex NXCORE_EXPORTABLE g_idxServiceCheckById;
2986 extern ObjectIndex NXCORE_EXPORTABLE g_idxSensorById;
2987
2988 #endif /* _nms_objects_h_ */