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