ui/qt/models/atap_data_model.h

   1 /** @file
   2  *
   3  * Wireshark - Network traffic analyzer
   4  * By Gerald Combs <gerald@wireshark.org>
   5  * Copyright 1998 Gerald Combs
   6  *
   7  * SPDX-License-Identifier: GPL-2.0-or-later
   8  */
   9
  10 #ifndef ATAP_DATA_MODEL_H
  11 #define ATAP_DATA_MODEL_H
  12
  13 #include "config.h"
  14
  15 #include <epan/tap.h>
  16 #include <epan/conversation.h>
  17 #include <epan/conversation_table.h>
  18
  19 #include <QAbstractListModel>
  20
  21 /**
  22  * @brief DataModel for tap user data
  23  *
  24  * This datamodel provides the management for all tap data for the conversation
  25  * and endpoint dialogs. It predominantly is implemented to work with conversation
  26  * tap data. The management of displaying and correctly presenting the information
  27  * is done in the corresponding type classes
  28  *
  29  * @see EndpointDataModel
  30  * @see ConversationDataModel
  31  */
  32 class ATapDataModel : public QAbstractListModel
  33 {
  34     Q_OBJECT
  35 public:
  36
  37     enum {
  38         DISPLAY_FILTER = Qt::UserRole,
  39         UNFORMATTED_DISPLAYDATA,
  40 #ifdef HAVE_MAXMINDDB
  41         GEODATA_AVAILABLE,
  42         GEODATA_LOOKUPTABLE,
  43         GEODATA_ADDRESS,
  44 #endif
  45         TIMELINE_DATA,
  46         ENDPOINT_DATATYPE,
  47         PROTO_ID,
  48         CONVERSATION_ID,
  49         ROW_IS_FILTERED,
  50         DATA_ADDRESS_TYPE,
  51         DATA_IPV4_INTEGER,
  52         DATA_IPV6_LIST,
  53     };
  54
  55     typedef enum {
  56         DATAMODEL_ENDPOINT,
  57         DATAMODEL_CONVERSATION,
  58         DATAMODEL_UNKNOWN
  59     } dataModelType;
  60
  61     conv_hash_t hash_;
  62
  63     /**
  64      * @brief Construct a new ATapDataModel object
  65      *
  66      * The tap will not be created automatically, but must be enabled by calling enableTap
  67      *
  68      * @param type an element of dataModelType. Either DATAMODEL_ENDPOINT or DATAMODEL_CONVERSATION are supported
  69      *   at this time
  70      * @param protoId the protocol id for which the tap is created
  71      * @param filter a potential filter to be used for the tap
  72      * @param parent the parent for the class
  73      *
  74      * @see enableTap
  75      */
  76     explicit ATapDataModel(dataModelType type, int protoId, QString filter, QObject *parent = nullptr);
  77     virtual ~ATapDataModel();
  78
  79     /**
  80      * @brief Number of rows under the given parent in this model, which
  81      * is the total number of rows for the empty QModelIndex, and 0 for
  82      * any valid parent index (as no row has children; this is a flat table.)
  83      *
  84      * @param parent index of parent, QModelIndex() for the root
  85      * @return int the number of rows under the parent
  86      */
  87     int rowCount(const QModelIndex &parent = QModelIndex()) const;
  88
  89     virtual int columnCount(const QModelIndex &parent = QModelIndex()) const = 0;
  90     virtual QVariant headerData(int section, Qt::Orientation orientation = Qt::Horizontal, int role = Qt::DisplayRole) const = 0;
  91     virtual QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) const = 0;
  92
  93     /**
  94      * @brief Returns the name for the tap being used
  95      *
  96      * @return QString the tap name, normally identical with the protocol name
  97      */
  98     QString tap() const;
  99
 100     /**
 101      * @brief The protocol id for the tap
 102      *
 103      * @return int the id given in the constructor
 104      */
 105     int protoId() const;
 106
 107     /**
 108      * @brief Set the filter string.
 109      *
 110      * A set filter can be reset by providing an empty string
 111      *
 112      * @param filter the filter for the tap
 113      */
 114     void setFilter(QString filter);
 115
 116     /**
 117      * @brief Return a filter set for the model
 118      *
 119      * @return QString the filter string for the model
 120      */
 121     QString filter() const;
 122
 123     /**
 124      * @brief Is the model set to resolve names in address and ports columns
 125      *
 126      * @return true yes, names will be resolved
 127      * @return false no they won't
 128      */
 129     bool resolveNames() const;
 130
 131     /**
 132      * @brief Enable or disable if names should be resolved
 133      *
 134      * @param resolve true if names should be resolved
 135      */
 136     void setResolveNames(bool resolve);
 137
 138     /**
 139      * @brief Does the model allow names to be resolved
 140      *
 141      * @return true yes, names may be resolved (set via setResolveNames)
 142      * @return false no, they won't be resolved
 143      *
 144      * @see setResolveNames
 145      * @see resolveNames
 146      */
 147     bool allowsNameResolution() const;
 148
 149     /**
 150      * @brief Use absolute time for any column supporting it
 151      *
 152      * @param absolute true to use absolute time values
 153      */
 154     void useAbsoluteTime(bool absolute);
 155
 156     /**
 157      * @brief Use nanosecond timestamps if requested
 158      *
 159      * @param nanoseconds use nanosecond timestamps if required and requested
 160      */
 161     void useNanosecondTimestamps(bool nanoseconds);
 162
 163     /**
 164      * @brief Are ports hidden for this model
 165      *
 166      * @return true the ports are hidden
 167      * @return false the ports are not hidden
 168      */
 169     bool portsAreHidden() const;
 170
 171     /**
 172      * @brief A total column is filled
 173      *
 174      * @return true if the column is filled
 175      * @return false the column is empty
 176      */
 177     bool showTotalColumn() const;
 178
 179     /**
 180      * @brief Enable tapping in this model.
 181      *
 182      * This will register the tap listener with the corresponding packet function.
 183      * @note if the tap has not been disabled, this method will do nothing
 184      *
 185      * @return true the tap has been enabled
 186      * @return false the tap has not been enabled
 187      */
 188     bool enableTap();
 189
 190     /**
 191      * @brief Disable the tapping for this model
 192      */
 193     void disableTap();
 194
 195     /**
 196      * @brief Return the model type
 197      *
 198      * @return dataModelType
 199      */
 200     dataModelType modelType() const;
 201
 202     conv_hash_t * hash();
 203
 204     /**
 205      * @brief Update the flags
 206      */
 207     void updateFlags(unsigned flag);
 208
 209 #ifdef HAVE_MAXMINDDB
 210     /**
 211      * @brief Does this model have geoip data available
 212      *
 213      * @return true it has
 214      * @return false it has not
 215      */
 216     bool hasGeoIPData();
 217 #endif
 218
 219 signals:
 220     void tapListenerChanged(bool enable);
 221
 222 protected:
 223
 224     static void tapReset(void *tapdata);
 225     static void tapDraw(void *tap_data);
 226
 227     virtual tap_packet_cb conversationPacketHandler();
 228
 229     void resetData();
 230     void updateData(GArray * data);
 231
 232     dataModelType _type;
 233     GArray * storage_;
 234     QString _filter;
 235
 236     bool _absoluteTime;
 237     bool _nanoseconds;
 238     bool _resolveNames;
 239     bool _disableTap;
 240
 241     double _minRelStartTime;
 242     double _maxRelStopTime;
 243
 244     unsigned _tapFlags;
 245
 246     register_ct_t* registerTable() const;
 247
 248 private:
 249     int _protoId;
 250
 251 };
 252
 253 class EndpointDataModel : public ATapDataModel
 254 {
 255     Q_OBJECT
 256 public:
 257
 258     typedef enum
 259     {
 260         ENDP_COLUMN_ADDR,
 261         ENDP_COLUMN_PORT,
 262         ENDP_COLUMN_PACKETS,
 263         ENDP_COLUMN_BYTES,
 264         ENDP_COLUMN_PACKETS_TOTAL,
 265         ENDP_COLUMN_BYTES_TOTAL,
 266         ENDP_COLUMN_PKT_AB,
 267         ENDP_COLUMN_BYTES_AB,
 268         ENDP_COLUMN_PKT_BA,
 269         ENDP_COLUMN_BYTES_BA,
 270         ENDP_NUM_COLUMNS,
 271         ENDP_COLUMN_GEO_COUNTRY = ENDP_NUM_COLUMNS,
 272         ENDP_COLUMN_GEO_CITY,
 273         ENDP_COLUMN_GEO_LATITUDE,
 274         ENDP_COLUMN_GEO_LONGITUDE,
 275         ENDP_COLUMN_GEO_AS_NUM,
 276         ENDP_COLUMN_GEO_AS_ORG,
 277         ENDP_NUM_GEO_COLUMNS
 278     } endpoint_column_type_e;
 279
 280     explicit EndpointDataModel(int protoId, QString filter, QObject *parent = nullptr);
 281
 282     int columnCount(const QModelIndex &parent = QModelIndex()) const;
 283     QVariant headerData(int section, Qt::Orientation orientation = Qt::Horizontal, int role = Qt::DisplayRole) const;
 284     QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) const;
 285
 286 };
 287
 288 class ConversationDataModel : public ATapDataModel
 289 {
 290     Q_OBJECT
 291 public:
 292
 293     typedef enum {
 294         CONV_COLUMN_SRC_ADDR,
 295         CONV_COLUMN_SRC_PORT,
 296         CONV_COLUMN_DST_ADDR,
 297         CONV_COLUMN_DST_PORT,
 298         CONV_COLUMN_PACKETS,
 299         CONV_COLUMN_BYTES,
 300         CONV_COLUMN_CONV_ID,
 301         CONV_COLUMN_PACKETS_TOTAL,
 302         CONV_COLUMN_BYTES_TOTAL,
 303         CONV_COLUMN_PKT_AB,
 304         CONV_COLUMN_BYTES_AB,
 305         CONV_COLUMN_PKT_BA,
 306         CONV_COLUMN_BYTES_BA,
 307         CONV_COLUMN_START,
 308         CONV_COLUMN_DURATION,
 309         CONV_COLUMN_BPS_AB,
 310         CONV_COLUMN_BPS_BA,
 311         CONV_NUM_COLUMNS,
 312         CONV_INDEX_COLUMN = CONV_NUM_COLUMNS
 313     } conversation_column_type_e;
 314
 315     typedef enum {
 316         CONV_TCP_EXT_COLUMN_A = CONV_INDEX_COLUMN,
 317         CONV_TCP_EXT_NUM_COLUMNS,
 318         CONV_TCP_EXT_INDEX_COLUMN = CONV_TCP_EXT_NUM_COLUMNS
 319     } conversation_tcp_ext_column_type_e;
 320
 321     explicit ConversationDataModel(int protoId, QString filter, QObject *parent = nullptr);
 322
 323     int columnCount(const QModelIndex &parent = QModelIndex()) const;
 324     QVariant headerData(int section, Qt::Orientation orientation = Qt::Horizontal, int role = Qt::DisplayRole) const;
 325     QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) const;
 326
 327     void doDataUpdate();
 328
 329     conv_item_t * itemForRow(int row);
 330
 331     /**
 332      * @brief Show the conversation id if available
 333      *
 334      * @return true a conversation id exists
 335      * @return false none available
 336      */
 337     bool showConversationId(int row = 0) const;
 338
 339 };
 340
 341 #endif // ATAP_DATA_MODEL_H