added macro DISABLE_COPY_CTOR; minor refactoring
[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 MAX_PROXY_TYPE = 2
1634 };
1635
1636 /**
1637 * Node
1638 */
1639 class NXCORE_EXPORTABLE Node : public DataCollectionTarget
1640 {
1641 friend class Subnet;
1642
1643 private:
1644 /**
1645 * Delete agent connection
1646 */
1647 void deleteAgentConnection()
1648 {
1649 if (m_agentConnection != NULL)
1650 {
1651 m_agentConnection->decRefCount();
1652 m_agentConnection = NULL;
1653 }
1654 }
1655
1656 void onSnmpProxyChange(UINT32 oldProxy);
1657
1658 static void onDataCollectionChangeAsyncCallback(void *arg);
1659
1660 protected:
1661 InetAddress m_ipAddress;
1662 TCHAR m_primaryName[MAX_DNS_NAME];
1663 uuid m_tunnelId;
1664 UINT32 m_capabilities;
1665 NodeType m_type;
1666 TCHAR m_subType[MAX_NODE_SUBTYPE_LENGTH];
1667 int m_pendingState;
1668 UINT32 m_pollCountAgent;
1669 UINT32 m_pollCountSNMP;
1670 UINT32 m_pollCountAllDown;
1671 UINT32 m_requiredPollCount;
1672 UINT32 m_zoneUIN;
1673 UINT16 m_agentPort;
1674 INT16 m_agentAuthMethod;
1675 INT16 m_agentCacheMode;
1676 INT16 m_agentCompressionMode; // agent compression mode (enabled/disabled/default)
1677 TCHAR m_szSharedSecret[MAX_SECRET_LENGTH];
1678 INT16 m_iStatusPollType;
1679 INT16 m_snmpVersion;
1680 UINT16 m_snmpPort;
1681 UINT16 m_nUseIfXTable;
1682 SNMP_SecurityContext *m_snmpSecurity;
1683 TCHAR m_agentVersion[MAX_AGENT_VERSION_LEN];
1684 TCHAR m_platformName[MAX_PLATFORM_NAME_LEN];
1685 TCHAR m_snmpObjectId[MAX_OID_LEN * 4];
1686 TCHAR *m_sysDescription; // Agent's System.Uname or SNMP sysDescr
1687 TCHAR *m_sysName; // SNMP sysName
1688 TCHAR *m_sysLocation; // SNMP sysLocation
1689 TCHAR *m_sysContact; // SNMP sysContact
1690 TCHAR *m_lldpNodeId; // lldpLocChassisId combined with lldpLocChassisIdSubtype, or NULL for non-LLDP nodes
1691 ObjectArray<LLDP_LOCAL_PORT_INFO> *m_lldpLocalPortInfo;
1692 NetworkDeviceDriver *m_driver;
1693 DriverData *m_driverData;
1694 ObjectArray<AgentParameterDefinition> *m_paramList; // List of supported parameters
1695 ObjectArray<AgentTableDefinition> *m_tableList; // List of supported tables
1696 time_t m_lastDiscoveryPoll;
1697 time_t m_lastTopologyPoll;
1698 time_t m_lastRTUpdate;
1699 time_t m_failTimeSNMP;
1700 time_t m_failTimeAgent;
1701 time_t m_downSince;
1702 time_t m_bootTime;
1703 time_t m_agentUpTime;
1704 time_t m_lastAgentCommTime;
1705 time_t m_lastAgentConnectAttempt;
1706 MUTEX m_hAgentAccessMutex;
1707 MUTEX m_hSmclpAccessMutex;
1708 MUTEX m_mutexRTAccess;
1709 MUTEX m_mutexTopoAccess;
1710 AgentConnectionEx *m_agentConnection;
1711 ObjectLock<AgentConnectionEx> *m_proxyConnections;
1712 SMCLP_Connection *m_smclpConnection;
1713 UINT64 m_lastAgentTrapId; // ID of last received agent trap
1714 UINT64 m_lastAgentPushRequestId; // ID of last received agent push request
1715 UINT32 m_lastSNMPTrapId;
1716 UINT64 m_lastSyslogMessageId; // ID of last received syslog message
1717 UINT32 m_pollerNode; // Node used for network service polling
1718 UINT32 m_agentProxy; // Node used as proxy for agent connection
1719 UINT32 m_snmpProxy; // Node used as proxy for SNMP requests
1720 UINT32 m_icmpProxy; // Node used as proxy for ICMP ping
1721 UINT64 m_lastEvents[MAX_LAST_EVENTS];
1722 ObjectArray<RoutingLoopEvent> *m_routingLoopEvents;
1723 ROUTING_TABLE *m_pRoutingTable;
1724 ForwardingDatabase *m_fdb;
1725 LinkLayerNeighbors *m_linkLayerNeighbors;
1726 VlanList *m_vlans;
1727 VrrpInfo *m_vrrpInfo;
1728 ObjectArray<WirelessStationInfo> *m_wirelessStations;
1729 int m_adoptedApCount;
1730 int m_totalApCount;
1731 BYTE m_baseBridgeAddress[MAC_ADDR_LENGTH]; // Bridge base address (dot1dBaseBridgeAddress in bridge MIB)
1732 NetworkMapObjectList *m_topology;
1733 time_t m_topologyRebuildTimestamp;
1734 ServerJobQueue *m_jobQueue;
1735 ComponentTree *m_components; // Hardware components
1736 ObjectArray<SoftwarePackage> *m_softwarePackages; // installed software packages
1737 ObjectArray<WinPerfObject> *m_winPerfObjects; // Windows performance objects
1738 AgentConnection *m_fileUpdateConn;
1739 INT16 m_rackHeight;
1740 INT16 m_rackPosition;
1741 UINT32 m_rackId;
1742 uuid m_rackImage;
1743 UINT32 m_chassisId;
1744 INT64 m_syslogMessageCount;
1745 INT64 m_snmpTrapCount;
1746 TCHAR m_sshLogin[MAX_SSH_LOGIN_LEN];
1747 TCHAR m_sshPassword[MAX_SSH_PASSWORD_LEN];
1748 UINT32 m_sshProxy;
1749 UINT32 m_portNumberingScheme;
1750 UINT32 m_portRowCount;
1751
1752 virtual void statusPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1753 virtual void configurationPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1754 virtual void topologyPoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1755 virtual void routingTablePoll(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1756
1757 virtual bool isDataCollectionDisabled();
1758 virtual void collectProxyInfo(ProxyInfo *info);
1759
1760 virtual void prepareForDeletion();
1761 virtual void onObjectDelete(UINT32 dwObjectId);
1762
1763 virtual void fillMessageInternal(NXCPMessage *pMsg);
1764 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
1765
1766 virtual void updatePingData();
1767
1768 virtual void onDataCollectionChange();
1769
1770 virtual StringMap *getInstanceList(DCObject *dco);
1771
1772 void agentLock() { MutexLock(m_hAgentAccessMutex); }
1773 void agentUnlock() { MutexUnlock(m_hAgentAccessMutex); }
1774
1775 void smclpLock() { MutexLock(m_hSmclpAccessMutex); }
1776 void smclpUnlock() { MutexUnlock(m_hSmclpAccessMutex); }
1777
1778 void routingTableLock() { MutexLock(m_mutexRTAccess); }
1779 void routingTableUnlock() { MutexUnlock(m_mutexRTAccess); }
1780
1781 BOOL checkSNMPIntegerValue(SNMP_Transport *pTransport, const TCHAR *pszOID, int nValue);
1782 void checkOSPFSupport(SNMP_Transport *pTransport);
1783 void addVrrpInterfaces(InterfaceList *ifList);
1784 BOOL resolveName(BOOL useOnlyDNS);
1785 void setPrimaryIPAddress(const InetAddress& addr);
1786
1787 bool setAgentProxy(AgentConnectionEx *conn);
1788 bool isAgentCompressionAllowed();
1789
1790 UINT32 getInterfaceCount(Interface **ppInterface);
1791
1792 void checkInterfaceNames(InterfaceList *pIfList);
1793 bool filterInterface(InterfaceInfo *info);
1794 Subnet *createSubnet(InetAddress& baseAddr, bool syntheticMask);
1795 void checkAgentPolicyBinding(AgentConnection *conn);
1796 void updatePrimaryIpAddr();
1797 bool confPollAgent(UINT32 dwRqId);
1798 bool confPollSnmp(UINT32 dwRqId);
1799 NodeType detectNodeType();
1800 bool updateSoftwarePackages(PollerInfo *poller, UINT32 requestId);
1801 bool querySnmpSysProperty(SNMP_Transport *snmp, const TCHAR *oid, const TCHAR *propName, UINT32 pollRqId, TCHAR **value);
1802 void checkBridgeMib(SNMP_Transport *pTransport);
1803 void checkIfXTable(SNMP_Transport *pTransport);
1804 bool checkNetworkPath(UINT32 requestId);
1805 bool checkNetworkPathLayer2(UINT32 requestId, bool secondPass);
1806 bool checkNetworkPathLayer3(UINT32 requestId, bool secondPass);
1807 bool checkNetworkPathElement(UINT32 nodeId, const TCHAR *nodeType, bool isProxy, UINT32 requestId, bool secondPass);
1808
1809 void syncDataCollectionWithAgent(AgentConnectionEx *conn);
1810
1811 bool updateInterfaceConfiguration(UINT32 rqid, int maskBits);
1812 bool deleteDuplicateInterfaces(UINT32 rqid);
1813 void updatePhysicalContainerBinding(int containerClass, UINT32 containerId);
1814
1815 bool connectToAgent(UINT32 *error = NULL, UINT32 *socketError = NULL, bool *newConnection = NULL, bool forceConnect = false);
1816 void setLastAgentCommTime() { m_lastAgentCommTime = time(NULL); }
1817
1818 void buildIPTopologyInternal(NetworkMapObjectList &topology, int nDepth, UINT32 seedObject, bool vpnLink, bool includeEndNodes);
1819
1820 public:
1821 Node();
1822 Node(const InetAddress& addr, UINT32 flags, UINT32 capabilities, UINT32 agentProxy, UINT32 snmpProxy, UINT32 icmpProxy, UINT32 sshProxy, UINT32 zoneUIN);
1823 virtual ~Node();
1824
1825 virtual int getObjectClass() const { return OBJECT_NODE; }
1826
1827 virtual bool saveToDatabase(DB_HANDLE hdb);
1828 virtual bool saveRuntimeData(DB_HANDLE hdb);
1829 virtual bool deleteFromDatabase(DB_HANDLE hdb);
1830 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
1831
1832 virtual bool isReadyForStatusPoll();
1833 virtual bool isReadyForDiscoveryPoll();
1834 virtual bool isReadyForRoutePoll();
1835 virtual bool isReadyForTopologyPoll();
1836
1837 virtual NXSL_Value *createNXSLObject();
1838
1839 virtual json_t *toJson();
1840
1841 Cluster *getMyCluster();
1842
1843 const InetAddress& getIpAddress() const { return m_ipAddress; }
1844 UINT32 getZoneUIN() const { return m_zoneUIN; }
1845 NodeType getType() const { return m_type; }
1846 const TCHAR *getSubType() const { return m_subType; }
1847
1848 UINT32 getCapabilities() { return m_capabilities; }
1849 void setCapabilities(UINT32 flag) { lockProperties(); m_capabilities |= flag; setModified(MODIFY_NODE_PROPERTIES); unlockProperties(); }
1850 void clearCapabilities(UINT32 flag) { lockProperties(); m_capabilities &= ~flag; setModified(MODIFY_NODE_PROPERTIES); unlockProperties(); }
1851 void setLocalMgmtFlag() { setCapabilities(NC_IS_LOCAL_MGMT); }
1852 void clearLocalMgmtFlag() { clearCapabilities(NC_IS_LOCAL_MGMT); }
1853
1854 void setType(NodeType type, const TCHAR *subType) { lockProperties(); m_type = type; nx_strncpy(m_subType, subType, MAX_NODE_SUBTYPE_LENGTH); unlockProperties(); }
1855
1856 bool isSNMPSupported() const { return m_capabilities & NC_IS_SNMP ? true : false; }
1857 bool isNativeAgent() const { return m_capabilities & NC_IS_NATIVE_AGENT ? true : false; }
1858 bool isBridge() const { return m_capabilities & NC_IS_BRIDGE ? true : false; }
1859 bool isRouter() const { return m_capabilities & NC_IS_ROUTER ? true : false; }
1860 bool isLocalManagement() const { return m_capabilities & NC_IS_LOCAL_MGMT ? true : false; }
1861 bool isPerVlanFdbSupported() const { return (m_driver != NULL) ? m_driver->isPerVlanFdbSupported() : false; }
1862 bool isWirelessController() const { return m_capabilities & NC_IS_WIFI_CONTROLLER ? true : false; }
1863
1864 const TCHAR *getAgentVersion() const { return m_agentVersion; }
1865 const TCHAR *getPlatformName() const { return m_platformName; }
1866 INT16 getSNMPVersion() const { return m_snmpVersion; }
1867 UINT16 getSNMPPort() const { return m_snmpPort; }
1868 const TCHAR *getSNMPObjectId() const { return m_snmpObjectId; }
1869 const TCHAR *getSysName() const { return CHECK_NULL_EX(m_sysName); }
1870 const TCHAR *getSysDescription() const { return CHECK_NULL_EX(m_sysDescription); }
1871 const TCHAR *getSysContact() const { return CHECK_NULL_EX(m_sysContact); }
1872 const TCHAR *getSysLocation() const { return CHECK_NULL_EX(m_sysLocation); }
1873 time_t getBootTime() const { return m_bootTime; }
1874 const TCHAR *getLLDPNodeId() const { return m_lldpNodeId; }
1875 const BYTE *getBridgeId() const { return m_baseBridgeAddress; }
1876 const TCHAR *getDriverName() const { return (m_driver != NULL) ? m_driver->getName() : _T("GENERIC"); }
1877 UINT16 getAgentPort() const { return m_agentPort; }
1878 INT16 getAgentAuthMethod() const { return m_agentAuthMethod; }
1879 INT16 getAgentCacheMode() const { return (m_state & NSF_CACHE_MODE_NOT_SUPPORTED) ? AGENT_CACHE_OFF : ((m_agentCacheMode == AGENT_CACHE_DEFAULT) ? g_defaultAgentCacheMode : m_agentCacheMode); }
1880 const TCHAR *getSharedSecret() const { return m_szSharedSecret; }
1881 UINT32 getRackId() const { return m_rackId; }
1882 INT16 getRackHeight() const { return m_rackHeight; }
1883 INT16 getRackPosition() const { return m_rackPosition; }
1884 bool hasFileUpdateConnection() const { lockProperties(); bool result = (m_fileUpdateConn != NULL); unlockProperties(); return result; }
1885 UINT32 getIcmpProxy() const { return m_icmpProxy; }
1886 const TCHAR *getSshLogin() const { return m_sshLogin; }
1887 const TCHAR *getSshPassword() const { return m_sshPassword; }
1888 UINT32 getSshProxy() const { return m_sshProxy; }
1889 time_t getLastAgentCommTime() const { return m_lastAgentCommTime; }
1890 const TCHAR *getPrimaryName() const { return m_primaryName; }
1891 const uuid& getTunnelId() const { return m_tunnelId; }
1892 void setNewTunnelBindFlag() { m_runtimeFlags |= NDF_NEW_TUNNEL_BIND; }
1893 void removeNewTunnelBindFlag() { m_runtimeFlags &= ~NDF_NEW_TUNNEL_BIND; }
1894
1895 bool isDown() { return (m_state & DCSF_UNREACHABLE) ? true : false; }
1896 time_t getDownTime() const { return m_downSince; }
1897
1898 void addInterface(Interface *pInterface) { addChild(pInterface); pInterface->addParent(this); }
1899 Interface *createNewInterface(InterfaceInfo *ifInfo, bool manuallyCreated, bool fakeInterface);
1900 Interface *createNewInterface(const InetAddress& ipAddr, BYTE *macAddr, bool fakeInterface);
1901 void deleteInterface(Interface *iface);
1902
1903 void setPrimaryName(const TCHAR *name) { nx_strncpy(m_primaryName, name, MAX_DNS_NAME); }
1904 void setAgentPort(UINT16 port) { m_agentPort = port; }
1905 void setSnmpPort(UINT16 port) { m_snmpPort = port; }
1906 void setSshCredentials(const TCHAR *login, const TCHAR *password);
1907 void changeIPAddress(const InetAddress& ipAddr);
1908 void changeZone(UINT32 newZone);
1909 void setTunnelId(const uuid& tunnelId);
1910 void setFileUpdateConnection(AgentConnection *conn);
1911 void clearDataCollectionConfigFromAgent(AgentConnectionEx *conn);
1912 void forceSyncDataCollectionConfig();
1913 void relatedNodeDataCollectionChanged() { onDataCollectionChange(); }
1914
1915 ARP_CACHE *getArpCache();
1916 InterfaceList *getInterfaceList();
1917 Interface *findInterfaceByIndex(UINT32 ifIndex);
1918 Interface *findInterfaceByName(const TCHAR *name);
1919 Interface *findInterfaceByMAC(const BYTE *macAddr);
1920 Interface *findInterfaceByIP(const InetAddress& addr);
1921 Interface *findInterfaceBySlotAndPort(UINT32 slot, UINT32 port);
1922 Interface *findBridgePort(UINT32 bridgePortNumber);
1923 AccessPoint *findAccessPointByMAC(const BYTE *macAddr);
1924 AccessPoint *findAccessPointByBSSID(const BYTE *bssid);
1925 AccessPoint *findAccessPointByRadioId(int rfIndex);
1926 ObjectArray<WirelessStationInfo> *getWirelessStations();
1927 bool isMyIP(const InetAddress& addr);
1928 void getInterfaceStatusFromSNMP(SNMP_Transport *pTransport, UINT32 dwIndex, int ifTableSuffixLen, UINT32 *ifTableSuffix, InterfaceAdminState *adminState, InterfaceOperState *operState);
1929 void getInterfaceStatusFromAgent(UINT32 dwIndex, InterfaceAdminState *adminState, InterfaceOperState *operState);
1930 ROUTING_TABLE *getRoutingTable();
1931 ROUTING_TABLE *getCachedRoutingTable() { return m_pRoutingTable; }
1932 LinkLayerNeighbors *getLinkLayerNeighbors();
1933 VlanList *getVlans();
1934 bool getNextHop(const InetAddress& srcAddr, const InetAddress& destAddr, InetAddress *nextHop, InetAddress *route, UINT32 *ifIndex, bool *isVpn, TCHAR *name);
1935 bool getOutwardInterface(const InetAddress& destAddr, InetAddress *srcAddr, UINT32 *srcIfIndex);
1936 ComponentTree *getComponents();
1937 bool getLldpLocalPortInfo(UINT32 idType, BYTE *id, size_t idLen, LLDP_LOCAL_PORT_INFO *port);
1938 void showLLDPInfo(CONSOLE_CTX console);
1939
1940 void setRecheckCapsFlag() { m_runtimeFlags |= NDF_RECHECK_CAPABILITIES; }
1941 void setDiscoveryPollTimeStamp();
1942 void topologyPollWorkerEntry(PollerInfo *poller);
1943 void topologyPollWorkerEntry(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1944 void resolveVlanPorts(VlanList *vlanList);
1945 void updateInterfaceNames(ClientSession *pSession, UINT32 dwRqId);
1946 void routingTablePollWorkerEntry(PollerInfo *poller);
1947 void routingTablePollWorkerEntry(PollerInfo *poller, ClientSession *session, UINT32 rqId);
1948 void checkSubnetBinding();
1949 AccessPointState getAccessPointState(AccessPoint *ap, SNMP_Transport *snmpTransport);
1950 void setChassis(UINT32 chassisId);
1951
1952 void lockForDiscoveryPoll();
1953 void lockForRoutePoll();
1954 void lockForTopologyPoll();
1955 void forceConfigurationPoll() { m_runtimeFlags |= DCDF_FORCE_CONFIGURATION_POLL; }
1956
1957 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
1958
1959 bool checkAgentTrapId(UINT64 id);
1960 bool checkSNMPTrapId(UINT32 id);
1961 bool checkSyslogMessageId(UINT64 id);
1962 bool checkAgentPushRequestId(UINT64 id);
1963
1964 bool connectToSMCLP();
1965
1966 virtual UINT32 getInternalItem(const TCHAR *param, size_t bufSize, TCHAR *buffer);
1967
1968 UINT32 getItemFromSNMP(WORD port, const TCHAR *param, size_t bufSize, TCHAR *buffer, int interpretRawValue);
1969 UINT32 getTableFromSNMP(WORD port, const TCHAR *oid, ObjectArray<DCTableColumn> *columns, Table **table);
1970 UINT32 getListFromSNMP(WORD port, const TCHAR *oid, StringList **list);
1971 UINT32 getOIDSuffixListFromSNMP(WORD port, const TCHAR *oid, StringMap **values);
1972 UINT32 getItemFromCheckPointSNMP(const TCHAR *szParam, UINT32 dwBufSize, TCHAR *szBuffer);
1973 UINT32 getItemFromAgent(const TCHAR *szParam, UINT32 dwBufSize, TCHAR *szBuffer);
1974 UINT32 getTableFromAgent(const TCHAR *name, Table **table);
1975 UINT32 getListFromAgent(const TCHAR *name, StringList **list);
1976 UINT32 getItemForClient(int iOrigin, UINT32 userId, const TCHAR *pszParam, TCHAR *pszBuffer, UINT32 dwBufSize);
1977 UINT32 getTableForClient(const TCHAR *name, Table **table);
1978 UINT32 getItemFromSMCLP(const TCHAR *param, UINT32 bufSize, TCHAR *buffer);
1979
1980 virtual NXSL_Array *getParentsForNXSL();
1981 virtual NXSL_Array *getTemplatesForNXSL();
1982 NXSL_Array *getInterfacesForNXSL();
1983
1984 void openParamList(ObjectArray<AgentParameterDefinition> **paramList);
1985 void closeParamList() { unlockProperties(); }
1986
1987 void openTableList(ObjectArray<AgentTableDefinition> **tableList);
1988 void closeTableList() { unlockProperties(); }
1989
1990 AgentConnectionEx *createAgentConnection(bool sendServerId = false);
1991 AgentConnectionEx *acquireProxyConnection(ProxyType type, bool validate = false);
1992 SNMP_Transport *createSnmpTransport(WORD port = 0, const TCHAR *context = NULL);
1993 SNMP_SecurityContext *getSnmpSecurityContext() const;
1994 UINT32 getEffectiveSnmpProxy() const;
1995
1996 void writeParamListToMessage(NXCPMessage *pMsg, WORD flags);
1997 void writeWinPerfObjectsToMessage(NXCPMessage *msg);
1998 void writePackageListToMessage(NXCPMessage *msg);
1999 void writeWsListToMessage(NXCPMessage *msg);
2000
2001 UINT32 wakeUp();
2002
2003 void addService(NetworkService *pNetSrv) { addChild(pNetSrv); pNetSrv->addParent(this); }
2004 UINT32 checkNetworkService(UINT32 *pdwStatus, const InetAddress& ipAddr, int iServiceType, WORD wPort = 0,
2005 WORD wProto = 0, TCHAR *pszRequest = NULL, TCHAR *pszResponse = NULL, UINT32 *responseTime = NULL);
2006
2007 UINT64 getLastEventId(int index) { return ((index >= 0) && (index < MAX_LAST_EVENTS)) ? m_lastEvents[index] : 0; }
2008 void setLastEventId(int index, UINT64 eventId) { if ((index >= 0) && (index < MAX_LAST_EVENTS)) m_lastEvents[index] = eventId; }
2009 void setRoutingLoopEvent(const InetAddress& address, UINT32 nodeId, UINT64 eventId);
2010
2011 UINT32 callSnmpEnumerate(const TCHAR *pszRootOid,
2012 UINT32 (* pHandler)(SNMP_Variable *, SNMP_Transport *, void *), void *pArg, const TCHAR *context = NULL);
2013
2014 NetworkMapObjectList *getL2Topology();
2015 NetworkMapObjectList *buildL2Topology(UINT32 *pdwStatus, int radius, bool includeEndNodes);
2016 ForwardingDatabase *getSwitchForwardingDatabase();
2017 NetObj *findConnectionPoint(UINT32 *localIfId, BYTE *localMacAddr, int *type);
2018 void addHostConnections(LinkLayerNeighbors *nbs);
2019 void addExistingConnections(LinkLayerNeighbors *nbs);
2020
2021 NetworkMapObjectList *buildIPTopology(UINT32 *pdwStatus, int radius, bool includeEndNodes);
2022
2023 ServerJobQueue *getJobQueue() { return m_jobQueue; }
2024 int getJobCount(const TCHAR *type = NULL) { return m_jobQueue->getJobCount(type); }
2025
2026 DriverData *getDriverData() { return m_driverData; }
2027 void setDriverData(DriverData *data) { m_driverData = data; }
2028
2029 void incSyslogMessageCount();
2030 void incSnmpTrapCount();
2031
2032 static const TCHAR *typeName(NodeType type);
2033
2034 UINT32 getRequiredPolls() const { return m_requiredPollCount; }
2035 };
2036
2037 /**
2038 * Set timestamp of last discovery poll to current time
2039 */
2040 inline void Node::setDiscoveryPollTimeStamp()
2041 {
2042 m_lastDiscoveryPoll = time(NULL);
2043 m_runtimeFlags &= ~NDF_QUEUED_FOR_DISCOVERY_POLL;
2044 }
2045
2046 inline bool Node::isReadyForStatusPoll()
2047 {
2048 if (m_isDeleted)
2049 return false;
2050 if (m_runtimeFlags & DCDF_FORCE_STATUS_POLL)
2051 {
2052 m_runtimeFlags &= ~DCDF_FORCE_STATUS_POLL;
2053 return true;
2054 }
2055 return (m_status != STATUS_UNMANAGED) &&
2056 (!(m_flags & DCF_DISABLE_STATUS_POLL)) &&
2057 (!(m_runtimeFlags & DCDF_QUEUED_FOR_STATUS_POLL)) &&
2058 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
2059 (getMyCluster() == NULL) &&
2060 ((UINT32)(time(NULL) - m_lastStatusPoll) > g_dwStatusPollingInterval);
2061 }
2062
2063 inline bool Node::isReadyForDiscoveryPoll()
2064 {
2065 if (m_isDeleted)
2066 return false;
2067 return (g_flags & AF_ENABLE_NETWORK_DISCOVERY) &&
2068 (m_status != STATUS_UNMANAGED) &&
2069 (!(m_flags & NF_DISABLE_DISCOVERY_POLL)) &&
2070 (!(m_runtimeFlags & NDF_QUEUED_FOR_DISCOVERY_POLL)) &&
2071 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
2072 (m_runtimeFlags & DCDF_CONFIGURATION_POLL_PASSED) &&
2073 ((UINT32)(time(NULL) - m_lastDiscoveryPoll) > g_dwDiscoveryPollingInterval);
2074 }
2075
2076 inline bool Node::isReadyForRoutePoll()
2077 {
2078 if (m_isDeleted)
2079 return false;
2080 return (m_status != STATUS_UNMANAGED) &&
2081 (!(m_flags & NF_DISABLE_ROUTE_POLL)) &&
2082 (!(m_runtimeFlags & NDF_QUEUED_FOR_ROUTE_POLL)) &&
2083 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
2084 (m_runtimeFlags & DCDF_CONFIGURATION_POLL_PASSED) &&
2085 ((UINT32)(time(NULL) - m_lastRTUpdate) > g_dwRoutingTableUpdateInterval);
2086 }
2087
2088 inline bool Node::isReadyForTopologyPoll()
2089 {
2090 if (m_isDeleted)
2091 return false;
2092 return (m_status != STATUS_UNMANAGED) &&
2093 (!(m_flags & NF_DISABLE_TOPOLOGY_POLL)) &&
2094 (!(m_runtimeFlags & NDF_QUEUED_FOR_TOPOLOGY_POLL)) &&
2095 (!(m_runtimeFlags & DCDF_DELETE_IN_PROGRESS)) &&
2096 (m_runtimeFlags & DCDF_CONFIGURATION_POLL_PASSED) &&
2097 ((UINT32)(time(NULL) - m_lastTopologyPoll) > g_dwTopologyPollingInterval);
2098 }
2099
2100 inline void Node::lockForDiscoveryPoll()
2101 {
2102 lockProperties();
2103 m_runtimeFlags |= NDF_QUEUED_FOR_DISCOVERY_POLL;
2104 unlockProperties();
2105 }
2106
2107 inline void Node::lockForTopologyPoll()
2108 {
2109 lockProperties();
2110 m_runtimeFlags |= NDF_QUEUED_FOR_TOPOLOGY_POLL;
2111 unlockProperties();
2112 }
2113
2114 inline void Node::lockForRoutePoll()
2115 {
2116 lockProperties();
2117 m_runtimeFlags |= NDF_QUEUED_FOR_ROUTE_POLL;
2118 unlockProperties();
2119 }
2120
2121 /**
2122 * Subnet
2123 */
2124 class NXCORE_EXPORTABLE Subnet : public NetObj
2125 {
2126 friend void Node::buildIPTopologyInternal(NetworkMapObjectList &topology, int nDepth, UINT32 seedSubnet, bool vpnLink, bool includeEndNodes);
2127
2128 protected:
2129 InetAddress m_ipAddress;
2130 UINT32 m_zoneUIN;
2131 bool m_bSyntheticMask;
2132
2133 virtual void prepareForDeletion();
2134
2135 virtual void fillMessageInternal(NXCPMessage *pMsg);
2136
2137 void buildIPTopologyInternal(NetworkMapObjectList &topology, int nDepth, UINT32 seedNode, bool includeEndNodes);
2138
2139 public:
2140 Subnet();
2141 Subnet(const InetAddress& addr, UINT32 zoneUIN, bool bSyntheticMask);
2142 virtual ~Subnet();
2143
2144 virtual int getObjectClass() const { return OBJECT_SUBNET; }
2145
2146 virtual bool saveToDatabase(DB_HANDLE hdb);
2147 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2148 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2149
2150 virtual json_t *toJson();
2151
2152 void addNode(Node *node) { addChild(node); node->addParent(this); calculateCompoundStatus(TRUE); }
2153
2154 virtual bool showThresholdSummary();
2155
2156 const InetAddress& getIpAddress() const { return m_ipAddress; }
2157 UINT32 getZoneUIN() const { return m_zoneUIN; }
2158 bool isSyntheticMask() const { return m_bSyntheticMask; }
2159
2160 void setCorrectMask(const InetAddress& addr);
2161
2162 bool findMacAddress(const InetAddress& ipAddr, BYTE *macAddr);
2163
2164 UINT32 *buildAddressMap(int *length);
2165 };
2166
2167 /**
2168 * Universal root object
2169 */
2170 class NXCORE_EXPORTABLE UniversalRoot : public NetObj
2171 {
2172 using NetObj::loadFromDatabase;
2173
2174 public:
2175 UniversalRoot();
2176 virtual ~UniversalRoot();
2177
2178 virtual bool saveToDatabase(DB_HANDLE hdb);
2179 void loadFromDatabase(DB_HANDLE hdb);
2180 virtual void linkObjects();
2181 void linkObject(NetObj *pObject) { addChild(pObject); pObject->addParent(this); }
2182 };
2183
2184 /**
2185 * Service root
2186 */
2187 class NXCORE_EXPORTABLE ServiceRoot : public UniversalRoot
2188 {
2189 public:
2190 ServiceRoot();
2191 virtual ~ServiceRoot();
2192
2193 virtual int getObjectClass() const { return OBJECT_SERVICEROOT; }
2194
2195 virtual bool showThresholdSummary();
2196 };
2197
2198 /**
2199 * Template root
2200 */
2201 class NXCORE_EXPORTABLE TemplateRoot : public UniversalRoot
2202 {
2203 public:
2204 TemplateRoot();
2205 virtual ~TemplateRoot();
2206
2207 virtual int getObjectClass() const { return OBJECT_TEMPLATEROOT; }
2208 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2209 };
2210
2211 /**
2212 * Generic container object
2213 */
2214 class NXCORE_EXPORTABLE Container : public NetObj
2215 {
2216 private:
2217 UINT32 *m_pdwChildIdList;
2218 UINT32 m_dwChildIdListSize;
2219
2220 protected:
2221 NXSL_Program *m_bindFilter;
2222 TCHAR *m_bindFilterSource;
2223
2224 virtual void fillMessageInternal(NXCPMessage *msg);
2225 virtual UINT32 modifyFromMessageInternal(NXCPMessage *request);
2226
2227 void setAutoBindFilterInternal(const TCHAR *script);
2228
2229 public:
2230 Container();
2231 Container(const TCHAR *pszName, UINT32 dwCategory);
2232 virtual ~Container();
2233
2234 virtual int getObjectClass() const { return OBJECT_CONTAINER; }
2235
2236 virtual bool saveToDatabase(DB_HANDLE hdb);
2237 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2238 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2239 virtual void linkObjects();
2240
2241 virtual bool showThresholdSummary();
2242
2243 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2244
2245 virtual json_t *toJson();
2246
2247 virtual NXSL_Value *createNXSLObject();
2248
2249 void linkObject(NetObj *pObject) { addChild(pObject); pObject->addParent(this); }
2250
2251 AutoBindDecision isSuitableForObject(NetObj *object);
2252 bool isAutoBindEnabled() const { return (m_flags & CF_AUTO_BIND) ? true : false; }
2253 bool isAutoUnbindEnabled() const { return ((m_flags & (CF_AUTO_BIND | CF_AUTO_UNBIND)) == (CF_AUTO_BIND | CF_AUTO_UNBIND)) ? true : false; }
2254 const TCHAR *getAutoBindScriptSource() const { return m_bindFilterSource; }
2255
2256 void setAutoBindFilter(const TCHAR *script) { lockProperties(); setAutoBindFilterInternal(script); unlockProperties(); }
2257 void setAutoBindMode(bool doBind, bool doUnbind);
2258 };
2259
2260 /**
2261 * Template group object
2262 */
2263 class NXCORE_EXPORTABLE TemplateGroup : public Container
2264 {
2265 public:
2266 TemplateGroup() : Container() { }
2267 TemplateGroup(const TCHAR *pszName) : Container(pszName, 0) { m_status = STATUS_NORMAL; }
2268 virtual ~TemplateGroup() { }
2269
2270 virtual int getObjectClass() const { return OBJECT_TEMPLATEGROUP; }
2271 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2272
2273 virtual bool showThresholdSummary();
2274 };
2275
2276 /**
2277 * Rack object
2278 */
2279 class NXCORE_EXPORTABLE Rack : public Container
2280 {
2281 protected:
2282 int m_height; // Rack height in units
2283 bool m_topBottomNumbering;
2284
2285 virtual void fillMessageInternal(NXCPMessage *pMsg);
2286 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2287
2288 public:
2289 Rack();
2290 Rack(const TCHAR *name, int height);
2291 virtual ~Rack();
2292
2293 virtual int getObjectClass() const { return OBJECT_RACK; }
2294
2295 virtual bool saveToDatabase(DB_HANDLE hdb);
2296 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2297 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2298
2299 virtual json_t *toJson();
2300 };
2301
2302 /**
2303 * Zone object
2304 */
2305 class NXCORE_EXPORTABLE Zone : public NetObj
2306 {
2307 protected:
2308 UINT32 m_uin;
2309 UINT32 m_proxyNodeId;
2310 InetAddressIndex *m_idxNodeByAddr;
2311 InetAddressIndex *m_idxInterfaceByAddr;
2312 InetAddressIndex *m_idxSubnetByAddr;
2313
2314 virtual void fillMessageInternal(NXCPMessage *msg);
2315 virtual UINT32 modifyFromMessageInternal(NXCPMessage *request);
2316
2317 public:
2318 Zone();
2319 Zone(UINT32 uin, const TCHAR *name);
2320 virtual ~Zone();
2321
2322 virtual int getObjectClass() const { return OBJECT_ZONE; }
2323
2324 virtual bool saveToDatabase(DB_HANDLE hdb);
2325 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2326 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2327
2328 virtual bool showThresholdSummary();
2329
2330 virtual NXSL_Value *createNXSLObject();
2331
2332 virtual json_t *toJson();
2333
2334 UINT32 getUIN() const { return m_uin; }
2335 UINT32 getProxyNodeId() const { return m_proxyNodeId; }
2336
2337 void addSubnet(Subnet *pSubnet) { addChild(pSubnet); pSubnet->addParent(this); }
2338
2339 void addToIndex(Subnet *subnet) { m_idxSubnetByAddr->put(subnet->getIpAddress(), subnet); }
2340 void addToIndex(Interface *iface) { m_idxInterfaceByAddr->put(iface->getIpAddressList(), iface); }
2341 void addToIndex(const InetAddress& addr, Interface *iface) { m_idxInterfaceByAddr->put(addr, iface); }
2342 void addToIndex(Node *node) { m_idxNodeByAddr->put(node->getIpAddress(), node); }
2343 void removeFromIndex(Subnet *subnet) { m_idxSubnetByAddr->remove(subnet->getIpAddress()); }
2344 void removeFromIndex(Interface *iface);
2345 void removeFromInterfaceIndex(const InetAddress& addr) { m_idxInterfaceByAddr->remove(addr); }
2346 void removeFromIndex(Node *node) { m_idxNodeByAddr->remove(node->getIpAddress()); }
2347 void updateInterfaceIndex(const InetAddress& oldIp, const InetAddress& newIp, Interface *iface);
2348 Subnet *getSubnetByAddr(const InetAddress& ipAddr) { return (Subnet *)m_idxSubnetByAddr->get(ipAddr); }
2349 Interface *getInterfaceByAddr(const InetAddress& ipAddr) { return (Interface *)m_idxInterfaceByAddr->get(ipAddr); }
2350 Node *getNodeByAddr(const InetAddress& ipAddr) { return (Node *)m_idxNodeByAddr->get(ipAddr); }
2351 Subnet *findSubnet(bool (*comparator)(NetObj *, void *), void *data) { return (Subnet *)m_idxSubnetByAddr->find(comparator, data); }
2352 Interface *findInterface(bool (*comparator)(NetObj *, void *), void *data) { return (Interface *)m_idxInterfaceByAddr->find(comparator, data); }
2353 Node *findNode(bool (*comparator)(NetObj *, void *), void *data) { return (Node *)m_idxNodeByAddr->find(comparator, data); }
2354 void forEachSubnet(void (*callback)(const InetAddress& addr, NetObj *, void *), void *data) { m_idxSubnetByAddr->forEach(callback, data); }
2355 ObjectArray<NetObj> *getSubnets(bool updateRefCount) { return m_idxSubnetByAddr->getObjects(updateRefCount); }
2356 void dumpInterfaceIndex(CONSOLE_CTX console);
2357 void dumpNodeIndex(CONSOLE_CTX console);
2358 void dumpSubnetIndex(CONSOLE_CTX console);
2359 };
2360
2361 /**
2362 * Entire network
2363 */
2364 class NXCORE_EXPORTABLE Network : public NetObj
2365 {
2366 using NetObj::loadFromDatabase;
2367
2368 public:
2369 Network();
2370 virtual ~Network();
2371
2372 virtual int getObjectClass() const { return OBJECT_NETWORK; }
2373 virtual bool saveToDatabase(DB_HANDLE hdb);
2374
2375 virtual bool showThresholdSummary();
2376
2377 void AddSubnet(Subnet *pSubnet) { addChild(pSubnet); pSubnet->addParent(this); }
2378 void AddZone(Zone *pZone) { addChild(pZone); pZone->addParent(this); }
2379 void loadFromDatabase(DB_HANDLE hdb);
2380 };
2381
2382 /**
2383 * Condition
2384 */
2385 class NXCORE_EXPORTABLE ConditionObject : public NetObj
2386 {
2387 protected:
2388 UINT32 m_dciCount;
2389 INPUT_DCI *m_dciList;
2390 TCHAR *m_scriptSource;
2391 NXSL_VM *m_script;
2392 UINT32 m_activationEventCode;
2393 UINT32 m_deactivationEventCode;
2394 UINT32 m_sourceObject;
2395 int m_activeStatus;
2396 int m_inactiveStatus;
2397 bool m_isActive;
2398 time_t m_lastPoll;
2399 bool m_queuedForPolling;
2400
2401 virtual void fillMessageInternal(NXCPMessage *pMsg);
2402 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2403
2404 public:
2405 ConditionObject();
2406 ConditionObject(bool hidden);
2407 virtual ~ConditionObject();
2408
2409 virtual int getObjectClass() const { return OBJECT_CONDITION; }
2410
2411 virtual bool saveToDatabase(DB_HANDLE hdb);
2412 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2413 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2414
2415 virtual json_t *toJson();
2416
2417 void lockForPoll();
2418 void doPoll(PollerInfo *poller);
2419 void check();
2420
2421 bool isReadyForPoll()
2422 {
2423 return ((m_status != STATUS_UNMANAGED) &&
2424 (!m_queuedForPolling) && (!m_isDeleted) &&
2425 ((UINT32)time(NULL) - (UINT32)m_lastPoll > g_dwConditionPollingInterval));
2426 }
2427
2428 int getCacheSizeForDCI(UINT32 itemId, bool noLock);
2429 };
2430
2431 /**
2432 * Generic agent policy object
2433 */
2434 class NXCORE_EXPORTABLE AgentPolicy : public NetObj
2435 {
2436 protected:
2437 UINT32 m_version;
2438 int m_policyType;
2439
2440 bool savePolicyCommonProperties(DB_HANDLE hdb);
2441
2442 virtual void fillMessageInternal(NXCPMessage *pMsg);
2443 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2444
2445 public:
2446 AgentPolicy(int type);
2447 AgentPolicy(const TCHAR *name, int type);
2448
2449 virtual int getObjectClass() const { return OBJECT_AGENTPOLICY; }
2450
2451 virtual bool saveToDatabase(DB_HANDLE hdb);
2452 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2453 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2454
2455 virtual json_t *toJson();
2456
2457 virtual bool createDeploymentMessage(NXCPMessage *msg);
2458 virtual bool createUninstallMessage(NXCPMessage *msg);
2459
2460 void linkNode(Node *node) { addChild(node); node->addParent(this); }
2461 void unlinkNode(Node *node) { deleteChild(node); node->deleteParent(this); }
2462 };
2463
2464 /**
2465 * Agent config policy object
2466 */
2467 class NXCORE_EXPORTABLE AgentPolicyConfig : public AgentPolicy
2468 {
2469 protected:
2470 TCHAR *m_fileContent;
2471
2472 virtual void fillMessageInternal(NXCPMessage *pMsg);
2473 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2474
2475 public:
2476 AgentPolicyConfig();
2477 AgentPolicyConfig(const TCHAR *name);
2478 virtual ~AgentPolicyConfig();
2479
2480 virtual int getObjectClass() const { return OBJECT_AGENTPOLICY_CONFIG; }
2481
2482 virtual bool saveToDatabase(DB_HANDLE hdb);
2483 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2484 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2485
2486 virtual json_t *toJson();
2487
2488 virtual bool createDeploymentMessage(NXCPMessage *msg);
2489 virtual bool createUninstallMessage(NXCPMessage *msg);
2490 };
2491
2492 /**
2493 * Log parser configuration policy object
2494 */
2495 class NXCORE_EXPORTABLE AgentPolicyLogParser : public AgentPolicy
2496 {
2497 protected:
2498 TCHAR *m_fileContent;
2499
2500 virtual void fillMessageInternal(NXCPMessage *pMsg);
2501 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2502 public:
2503 AgentPolicyLogParser();
2504 AgentPolicyLogParser(const TCHAR *name);
2505 virtual ~AgentPolicyLogParser();
2506
2507 virtual int getObjectClass() const { return OBJECT_AGENTPOLICY_LOGPARSER; }
2508
2509 virtual bool saveToDatabase(DB_HANDLE hdb);
2510 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2511 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2512
2513 virtual json_t *toJson();
2514
2515 virtual bool createDeploymentMessage(NXCPMessage *msg);
2516 virtual bool createUninstallMessage(NXCPMessage *msg);
2517 };
2518
2519 /**
2520 * Policy group object
2521 */
2522 class NXCORE_EXPORTABLE PolicyGroup : public Container
2523 {
2524 public:
2525 PolicyGroup() : Container() { }
2526 PolicyGroup(const TCHAR *pszName) : Container(pszName, 0) { }
2527 virtual ~PolicyGroup() { }
2528
2529 virtual int getObjectClass() const { return OBJECT_POLICYGROUP; }
2530 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2531
2532 virtual bool showThresholdSummary();
2533 };
2534
2535 /**
2536 * Policy root
2537 */
2538 class NXCORE_EXPORTABLE PolicyRoot : public UniversalRoot
2539 {
2540 public:
2541 PolicyRoot();
2542 virtual ~PolicyRoot();
2543
2544 virtual int getObjectClass() const { return OBJECT_POLICYROOT; }
2545 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2546 };
2547
2548 /**
2549 * Network map root
2550 */
2551 class NXCORE_EXPORTABLE NetworkMapRoot : public UniversalRoot
2552 {
2553 public:
2554 NetworkMapRoot();
2555 virtual ~NetworkMapRoot();
2556
2557 virtual int getObjectClass() const { return OBJECT_NETWORKMAPROOT; }
2558 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2559 };
2560
2561 /**
2562 * Network map group object
2563 */
2564 class NXCORE_EXPORTABLE NetworkMapGroup : public Container
2565 {
2566 public:
2567 NetworkMapGroup() : Container() { }
2568 NetworkMapGroup(const TCHAR *pszName) : Container(pszName, 0) { }
2569 virtual ~NetworkMapGroup() { }
2570
2571 virtual int getObjectClass() const { return OBJECT_NETWORKMAPGROUP; }
2572 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2573
2574 virtual bool showThresholdSummary();
2575 };
2576
2577 /**
2578 * Network map object
2579 */
2580 class NXCORE_EXPORTABLE NetworkMap : public NetObj
2581 {
2582 protected:
2583 int m_mapType;
2584 IntegerArray<UINT32> *m_seedObjects;
2585 int m_discoveryRadius;
2586 int m_layout;
2587 int m_backgroundColor;
2588 int m_defaultLinkColor;
2589 int m_defaultLinkRouting;
2590 int m_objectDisplayMode;
2591 uuid m_background;
2592 double m_backgroundLatitude;
2593 double m_backgroundLongitude;
2594 int m_backgroundZoom;
2595 UINT32 m_nextElementId;
2596 ObjectArray<NetworkMapElement> *m_elements;
2597 ObjectArray<NetworkMapLink> *m_links;
2598 TCHAR *m_filterSource;
2599 NXSL_VM *m_filter;
2600
2601 virtual void fillMessageInternal(NXCPMessage *pMsg);
2602 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2603
2604 void updateObjects(NetworkMapObjectList *objects);
2605 UINT32 objectIdFromElementId(UINT32 eid);
2606 UINT32 elementIdFromObjectId(UINT32 eid);
2607
2608 void setFilter(const TCHAR *filter);
2609
2610 public:
2611 NetworkMap();
2612 NetworkMap(int type, IntegerArray<UINT32> *seeds);
2613 virtual ~NetworkMap();
2614
2615 virtual int getObjectClass() const { return OBJECT_NETWORKMAP; }
2616 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2617
2618 virtual bool saveToDatabase(DB_HANDLE hdb);
2619 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2620 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2621
2622 virtual void onObjectDelete(UINT32 dwObjectId);
2623
2624 virtual json_t *toJson();
2625
2626 void updateContent();
2627
2628 int getBackgroundColor() { return m_backgroundColor; }
2629 void setBackgroundColor(int color) { m_backgroundColor = color; }
2630
2631 bool isAllowedOnMap(NetObj *object);
2632 };
2633
2634 /**
2635 * Dashboard tree root
2636 */
2637 class NXCORE_EXPORTABLE DashboardRoot : public UniversalRoot
2638 {
2639 public:
2640 DashboardRoot();
2641 virtual ~DashboardRoot();
2642
2643 virtual int getObjectClass() const { return OBJECT_DASHBOARDROOT; }
2644 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2645 };
2646
2647 /**
2648 * Dashboard element
2649 */
2650 class NXCORE_EXPORTABLE DashboardElement
2651 {
2652 public:
2653 int m_type;
2654 TCHAR *m_data;
2655 TCHAR *m_layout;
2656
2657 DashboardElement() { m_data = NULL; m_layout = NULL; }
2658 ~DashboardElement() { free(m_data); free(m_layout); }
2659
2660 json_t *toJson()
2661 {
2662 json_t *root = json_object();
2663 json_object_set_new(root, "type", json_integer(m_type));
2664 json_object_set_new(root, "data", json_string_t(m_data));
2665 json_object_set_new(root, "layout", json_string_t(m_layout));
2666 return root;
2667 }
2668 };
2669
2670 /**
2671 * Dashboard object
2672 */
2673 class NXCORE_EXPORTABLE Dashboard : public Container
2674 {
2675 protected:
2676 int m_numColumns;
2677 UINT32 m_options;
2678 ObjectArray<DashboardElement> *m_elements;
2679
2680 virtual void fillMessageInternal(NXCPMessage *pMsg);
2681 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2682
2683 public:
2684 Dashboard();
2685 Dashboard(const TCHAR *name);
2686 virtual ~Dashboard();
2687
2688 virtual int getObjectClass() const { return OBJECT_DASHBOARD; }
2689 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2690
2691 virtual bool saveToDatabase(DB_HANDLE hdb);
2692 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2693 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2694
2695 virtual json_t *toJson();
2696
2697 virtual bool showThresholdSummary();
2698 };
2699
2700 /**
2701 * Dashboard group object
2702 */
2703 class NXCORE_EXPORTABLE DashboardGroup : public Container
2704 {
2705 public:
2706 DashboardGroup() : Container() { }
2707 DashboardGroup(const TCHAR *pszName) : Container(pszName, 0) { }
2708 virtual ~DashboardGroup() { }
2709
2710 virtual int getObjectClass() const { return OBJECT_DASHBOARDGROUP; }
2711 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2712
2713 virtual bool showThresholdSummary();
2714 };
2715
2716 /**
2717 * SLM check object
2718 */
2719 class NXCORE_EXPORTABLE SlmCheck : public NetObj
2720 {
2721 protected:
2722 static NXSL_VariableSystem m_nxslConstants;
2723
2724 Threshold *m_threshold;
2725 enum CheckType { check_undefined = 0, check_script = 1, check_threshold = 2 } m_type;
2726 TCHAR *m_script;
2727 NXSL_VM *m_pCompiledScript;
2728 TCHAR m_reason[256];
2729 bool m_isTemplate;
2730 UINT32 m_templateId;
2731 UINT32 m_currentTicketId;
2732
2733 virtual void onObjectDelete(UINT32 objectId);
2734
2735 virtual void fillMessageInternal(NXCPMessage *pMsg);
2736 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2737
2738 void setScript(const TCHAR *script);
2739 UINT32 getOwnerId();
2740 NXSL_Value *getNodeObjectForNXSL();
2741 bool insertTicket();
2742 void closeTicket();
2743 void setReason(const TCHAR *reason) { nx_strncpy(m_reason, CHECK_NULL_EX(reason), 256); }
2744 void compileScript();
2745
2746 public:
2747 SlmCheck();
2748 SlmCheck(const TCHAR *name, bool isTemplate);
2749 SlmCheck(SlmCheck *tmpl);
2750 virtual ~SlmCheck();
2751
2752 static void init();
2753
2754 virtual int getObjectClass() const { return OBJECT_SLMCHECK; }
2755
2756 virtual bool saveToDatabase(DB_HANDLE hdb);
2757 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2758 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2759
2760 virtual void postModify();
2761
2762 void execute();
2763 void updateFromTemplate(SlmCheck *tmpl);
2764
2765 bool isTemplate() { return m_isTemplate; }
2766 UINT32 getTemplateId() { return m_templateId; }
2767 const TCHAR *getReason() { return m_reason; }
2768 };
2769
2770 /**
2771 * Service container - common logic for BusinessService, NodeLink and BusinessServiceRoot
2772 */
2773 class NXCORE_EXPORTABLE ServiceContainer : public Container
2774 {
2775 enum Period { DAY, WEEK, MONTH };
2776
2777 protected:
2778 time_t m_prevUptimeUpdateTime;
2779 int m_prevUptimeUpdateStatus;
2780 double m_uptimeDay;
2781 double m_uptimeWeek;
2782 double m_uptimeMonth;
2783 INT32 m_downtimeDay;
2784 INT32 m_downtimeWeek;
2785 INT32 m_downtimeMonth;
2786 INT32 m_prevDiffDay;
2787 INT32 m_prevDiffWeek;
2788 INT32 m_prevDiffMonth;
2789
2790 static INT32 logRecordId;
2791 static INT32 getSecondsInMonth();
2792 static INT32 getSecondsInPeriod(Period period) { return period == MONTH ? getSecondsInMonth() : (period == WEEK ? (3600 * 24 * 7) : (3600 * 24)); }
2793 static INT32 getSecondsSinceBeginningOf(Period period, time_t *beginTime = NULL);
2794
2795 virtual void fillMessageInternal(NXCPMessage *pMsg);
2796 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2797
2798 void initServiceContainer();
2799 BOOL addHistoryRecord();
2800 double getUptimeFromDBFor(Period period, INT32 *downtime);
2801
2802 public:
2803 ServiceContainer();
2804 ServiceContainer(const TCHAR *pszName);
2805
2806 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2807 virtual bool saveToDatabase(DB_HANDLE hdb);
2808 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2809
2810 virtual void calculateCompoundStatus(BOOL bForcedRecalc = FALSE);
2811 virtual void setStatus(int newStatus);
2812
2813 virtual bool showThresholdSummary();
2814
2815 void initUptimeStats();
2816 void updateUptimeStats(time_t currentTime = 0, BOOL updateChilds = FALSE);
2817 };
2818
2819 /**
2820 * Business service root
2821 */
2822 class NXCORE_EXPORTABLE BusinessServiceRoot : public ServiceContainer
2823 {
2824 using ServiceContainer::loadFromDatabase;
2825
2826 public:
2827 BusinessServiceRoot();
2828 virtual ~BusinessServiceRoot();
2829
2830 virtual int getObjectClass() const { return OBJECT_BUSINESSSERVICEROOT; }
2831
2832 virtual bool saveToDatabase(DB_HANDLE hdb);
2833 void loadFromDatabase(DB_HANDLE hdb);
2834
2835 virtual void linkObjects();
2836
2837 void linkObject(NetObj *pObject) { addChild(pObject); pObject->addParent(this); }
2838 };
2839
2840 /**
2841 * Business service object
2842 */
2843 class NXCORE_EXPORTABLE BusinessService : public ServiceContainer
2844 {
2845 protected:
2846 bool m_busy;
2847 bool m_pollingDisabled;
2848 time_t m_lastPollTime;
2849 int m_lastPollStatus;
2850
2851 virtual void prepareForDeletion();
2852
2853 virtual void fillMessageInternal(NXCPMessage *pMsg);
2854 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2855
2856 public:
2857 BusinessService();
2858 BusinessService(const TCHAR *name);
2859 virtual ~BusinessService();
2860
2861 virtual int getObjectClass() const { return OBJECT_BUSINESSSERVICE; }
2862
2863 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2864 virtual bool saveToDatabase(DB_HANDLE hdb);
2865 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2866
2867 bool isReadyForPolling();
2868 void lockForPolling();
2869 void poll(PollerInfo *poller);
2870 void poll(ClientSession *pSession, UINT32 dwRqId, PollerInfo *poller);
2871
2872 void getApplicableTemplates(ServiceContainer *target, ObjectArray<SlmCheck> *templates);
2873 };
2874
2875 /**
2876 * Node link object for business service
2877 */
2878 class NXCORE_EXPORTABLE NodeLink : public ServiceContainer
2879 {
2880 protected:
2881 UINT32 m_nodeId;
2882
2883 virtual void onObjectDelete(UINT32 dwObjectId);
2884
2885 virtual void fillMessageInternal(NXCPMessage *pMsg);
2886 virtual UINT32 modifyFromMessageInternal(NXCPMessage *pRequest);
2887
2888 void applyTemplate(SlmCheck *tmpl);
2889
2890 public:
2891 NodeLink();
2892 NodeLink(const TCHAR *name, UINT32 nodeId);
2893 virtual ~NodeLink();
2894
2895 virtual int getObjectClass() const { return OBJECT_NODELINK; }
2896
2897 virtual bool saveToDatabase(DB_HANDLE hdb);
2898 virtual bool deleteFromDatabase(DB_HANDLE hdb);
2899 virtual bool loadFromDatabase(DB_HANDLE hdb, UINT32 id);
2900
2901 void execute();
2902 void applyTemplates();
2903
2904 UINT32 getNodeId() { return m_nodeId; }
2905 };
2906
2907 /**
2908 * Get IP address for object
2909 */
2910 inline const InetAddress& GetObjectIpAddress(NetObj *object)
2911 {
2912 if (object->getObjectClass() == OBJECT_NODE)
2913 return ((Node *)object)->getIpAddress();
2914 if (object->getObjectClass() == OBJECT_SUBNET)
2915 return ((Subnet *)object)->getIpAddress();
2916 if (object->getObjectClass() == OBJECT_ACCESSPOINT)
2917 return ((AccessPoint *)object)->getIpAddress();
2918 if (object->getObjectClass() == OBJECT_INTERFACE)
2919 return ((Interface *)object)->getIpAddressList()->getFirstUnicastAddress();
2920 return InetAddress::INVALID;
2921 }
2922
2923 /**
2924 * Functions
2925 */
2926 void ObjectsInit();
2927
2928 void NXCORE_EXPORTABLE NetObjInsert(NetObj *object, bool newObject, bool importedObject);
2929 void NetObjDeleteFromIndexes(NetObj *object);
2930 void NetObjDelete(NetObj *object);
2931
2932 void UpdateInterfaceIndex(const InetAddress& oldIpAddr, const InetAddress& newIpAddr, Interface *iface);
2933 ComponentTree *BuildComponentTree(Node *node, SNMP_Transport *snmp);
2934
2935 void NXCORE_EXPORTABLE MacDbAddAccessPoint(AccessPoint *ap);
2936 void NXCORE_EXPORTABLE MacDbAddInterface(Interface *iface);
2937 void NXCORE_EXPORTABLE MacDbAddObject(const BYTE *macAddr, NetObj *object);
2938 void NXCORE_EXPORTABLE MacDbRemove(const BYTE *macAddr);
2939 NetObj NXCORE_EXPORTABLE *MacDbFind(const BYTE *macAddr);
2940
2941 NetObj NXCORE_EXPORTABLE *FindObjectById(UINT32 dwId, int objClass = -1);
2942 NetObj NXCORE_EXPORTABLE *FindObjectByName(const TCHAR *name, int objClass = -1);
2943 NetObj NXCORE_EXPORTABLE *FindObjectByGUID(const uuid& guid, int objClass = -1);
2944 NetObj NXCORE_EXPORTABLE *FindObject(bool (* comparator)(NetObj *, void *), void *userData, int objClass = -1);
2945 const TCHAR NXCORE_EXPORTABLE *GetObjectName(DWORD id, const TCHAR *defaultName);
2946 Template NXCORE_EXPORTABLE *FindTemplateByName(const TCHAR *pszName);
2947 Node NXCORE_EXPORTABLE *FindNodeByIP(UINT32 zoneUIN, const InetAddress& ipAddr);
2948 Node NXCORE_EXPORTABLE *FindNodeByIP(UINT32 zoneUIN, const InetAddressList *ipAddrList);
2949 Node NXCORE_EXPORTABLE *FindNodeByMAC(const BYTE *macAddr);
2950 Node NXCORE_EXPORTABLE *FindNodeByBridgeId(const BYTE *bridgeId);
2951 Node NXCORE_EXPORTABLE *FindNodeByLLDPId(const TCHAR *lldpId);
2952 Node NXCORE_EXPORTABLE *FindNodeBySysName(const TCHAR *sysName);
2953 ObjectArray<NetObj> *FindNodesByHostname(TCHAR *hostname, UINT32 zoneUIN);
2954 Interface NXCORE_EXPORTABLE *FindInterfaceByIP(UINT32 zoneUIN, const InetAddress& ipAddr);
2955 Interface NXCORE_EXPORTABLE *FindInterfaceByMAC(const BYTE *macAddr);
2956 Interface NXCORE_EXPORTABLE *FindInterfaceByDescription(const TCHAR *description);
2957 Subnet NXCORE_EXPORTABLE *FindSubnetByIP(UINT32 zoneUIN, const InetAddress& ipAddr);
2958 Subnet NXCORE_EXPORTABLE *FindSubnetForNode(UINT32 zoneUIN, const InetAddress& nodeAddr);
2959 MobileDevice NXCORE_EXPORTABLE *FindMobileDeviceByDeviceID(const TCHAR *deviceId);
2960 AccessPoint NXCORE_EXPORTABLE *FindAccessPointByMAC(const BYTE *macAddr);
2961 UINT32 NXCORE_EXPORTABLE FindLocalMgmtNode();
2962 Zone NXCORE_EXPORTABLE *FindZoneByUIN(UINT32 zoneUIN);
2963 UINT32 FindUnusedZoneUIN();
2964 bool NXCORE_EXPORTABLE IsClusterIP(UINT32 zoneUIN, const InetAddress& ipAddr);
2965 bool NXCORE_EXPORTABLE IsParentObject(UINT32 object1, UINT32 object2);
2966
2967 BOOL LoadObjects();
2968 void DumpObjects(CONSOLE_CTX pCtx, const TCHAR *filter);
2969
2970 bool NXCORE_EXPORTABLE CreateObjectAccessSnapshot(UINT32 userId, int objClass);
2971
2972 void DeleteUserFromAllObjects(UINT32 dwUserId);
2973
2974 bool IsValidParentClass(int childClass, int parentClass);
2975 bool IsAgentPolicyObject(NetObj *object);
2976 bool IsEventSource(int objectClass);
2977
2978 int DefaultPropagatedStatus(int iObjectStatus);
2979 int GetDefaultStatusCalculation(int *pnSingleThreshold, int **ppnThresholds);
2980
2981 PollerInfo *RegisterPoller(PollerType type, NetObj *object);
2982 void ShowPollers(CONSOLE_CTX console);
2983
2984 /**
2985 * Global variables
2986 */
2987 extern Network NXCORE_EXPORTABLE *g_pEntireNet;
2988 extern ServiceRoot NXCORE_EXPORTABLE *g_pServiceRoot;
2989 extern TemplateRoot NXCORE_EXPORTABLE *g_pTemplateRoot;
2990 extern PolicyRoot NXCORE_EXPORTABLE *g_pPolicyRoot;
2991 extern NetworkMapRoot NXCORE_EXPORTABLE *g_pMapRoot;
2992 extern DashboardRoot NXCORE_EXPORTABLE *g_pDashboardRoot;
2993 extern BusinessServiceRoot NXCORE_EXPORTABLE *g_pBusinessServiceRoot;
2994
2995 extern UINT32 NXCORE_EXPORTABLE g_dwMgmtNode;
2996 extern BOOL g_bModificationsLocked;
2997 extern Queue g_templateUpdateQueue;
2998
2999 extern ObjectIndex NXCORE_EXPORTABLE g_idxObjectById;
3000 extern InetAddressIndex NXCORE_EXPORTABLE g_idxSubnetByAddr;
3001 extern InetAddressIndex NXCORE_EXPORTABLE g_idxInterfaceByAddr;
3002 extern InetAddressIndex NXCORE_EXPORTABLE g_idxNodeByAddr;
3003 extern ObjectIndex NXCORE_EXPORTABLE g_idxZoneByUIN;
3004 extern ObjectIndex NXCORE_EXPORTABLE g_idxNodeById;
3005 extern ObjectIndex NXCORE_EXPORTABLE g_idxNetMapById;
3006 extern ObjectIndex NXCORE_EXPORTABLE g_idxChassisById;
3007 extern ObjectIndex NXCORE_EXPORTABLE g_idxClusterById;
3008 extern ObjectIndex NXCORE_EXPORTABLE g_idxMobileDeviceById;
3009 extern ObjectIndex NXCORE_EXPORTABLE g_idxAccessPointById;
3010 extern ObjectIndex NXCORE_EXPORTABLE g_idxConditionById;
3011 extern ObjectIndex NXCORE_EXPORTABLE g_idxServiceCheckById;
3012 extern ObjectIndex NXCORE_EXPORTABLE g_idxSensorById;
3013
3014 #endif /* _nms_objects_h_ */