ntopng/include/Paginator.h

/*
 *
 * (C) 2013-25 - ntop.org
 *
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

#ifndef _PAGINATOR_H_
#define _PAGINATOR_H_

#include "ntop_includes.h"

class Paginator {
 protected:
  u_int16_t max_hits, to_skip;
  bool a2z_sort_order;
  bool detailed_results /* deprecated, use DetailsLevel instead */;
  char *sort_column, *country_filter, *host_filter, *client_filter,
      *server_filter, *wlan_ssid_filter;
  char *container_filter, *pod_filter;
  char *traffic_profile_filter;
  char *username_filter, *pidname_filter;
  int l7proto_filter_master_proto, l7proto_filter_app_proto;
  int l7category_filter;
  u_int16_t port_filter;
  int32_t local_network_filter;
  u_int16_t vlan_id_filter;
  u_int8_t ip_version /* Either 4 or 6 */;
  u_int8_t l4_protocol;
  int8_t unicast_traffic, unidirectional_traffic, alerted_flows, filtered_flows,
      periodic_flows;
  u_int32_t asn_filter, asn_src_filter, asn_dst_filter;
  u_int32_t deviceIP;
  u_int32_t inIndex, outIndex;
  int32_t iface_index_filter;
  u_int16_t pool_filter, alert_type_filter;
  AlertLevelGroup alert_type_severity_filter;
  u_int8_t *mac_filter, icmp_type, icmp_code, dscp_filter;
  DetailsLevel details_level;
  bool details_level_set;
  LocationPolicy client_mode;
  LocationPolicy server_mode;
  TcpFlowStateFilter tcp_flow_state_filter;
  transitAS transit_as;
#ifdef NTOPNG_PRO
  u_int8_t qoe_filter;
#endif
 public:
  Paginator();
  virtual ~Paginator();
  virtual void readOptions(lua_State *L, int index);

  inline u_int16_t maxHits() const {
    return (min_val(max_hits, CONST_MAX_NUM_HITS));
  }
  inline u_int16_t toSkip() const { return (to_skip); }
  inline bool a2zSortOrder() const { return (a2z_sort_order); }
  inline char *sortColumn() const { return (sort_column); }
  inline bool detailedResults() const { return (detailed_results); }

  inline bool getDetailsLevel(DetailsLevel *f) const {
    if (details_level_set) {
      (*f) = details_level;
      return true;
    }
    return false;
  }

  inline bool countryFilter(char **f) const {
    if (country_filter) {
      (*f) = country_filter;
      return true;
    }
    return false;
  }

  inline bool wlanSSIDFilter(char **f) const {
    if (wlan_ssid_filter) {
      (*f) = wlan_ssid_filter;
      return true;
    }
    return false;
  }

  inline bool hostFilter(char **f) const {
    if (host_filter) {
      (*f) = host_filter;
      return true;
    }
    return false;
  }

  inline bool clientFilter(char **f) const {
    if (client_filter) {
      (*f) = client_filter;
      return true;
    }
    return false;
  }

  inline bool serverFilter(char **f) const {
    if (server_filter) {
      (*f) = server_filter;
      return true;
    }
    return false;
  }

  inline bool containerFilter(char **f) const {
    if (container_filter) {
      (*f) = container_filter;
      return true;
    }
    return false;
  }

  inline bool podFilter(char **f) const {
    if (pod_filter) {
      (*f) = pod_filter;
      return true;
    }
    return false;
  }

  inline bool usernameFilter(char **f) const {
    if (username_filter) {
      (*f) = username_filter;
      return true;
    }
    return false;
  }

  inline bool pidnameFilter(char **f) const {
    if (pidname_filter) {
      (*f) = pidname_filter;
      return true;
    }
    return false;
  }

  inline bool l7protoFilter(int *f_master_proto, int *f_app_proto) const {
    if ((l7proto_filter_master_proto >= 0) || (l7proto_filter_app_proto >= 0)) {
      /* In this way, only if the filter is selected, the filter is applied */
      *f_master_proto = (l7proto_filter_master_proto >= 0) ? l7proto_filter_master_proto : NDPI_PROTOCOL_UNKNOWN;
      *f_app_proto = (l7proto_filter_app_proto >= 0) ? l7proto_filter_app_proto : NDPI_PROTOCOL_UNKNOWN;
      return true;
    }

    return false;
  }

  inline bool l7categoryFilter(int *f) const {
    if (l7category_filter >= 0) {
      (*f) = l7category_filter;
      return true;
    }
    return false;
  }

  inline bool ifaceIndexFilter(int *f) const {
    if (iface_index_filter >= 0) {
      (*f) = iface_index_filter;
      return true;
    }
    return false;
  }

  inline bool trafficProfileFilter(char **f) const {
    if (traffic_profile_filter) {
      (*f) = traffic_profile_filter;
      return true;
    }
    return false;
  }

  inline bool portFilter(u_int16_t *f) const {
    if (port_filter) {
      (*f) = port_filter;
      return true;
    }
    return false;
  }

  inline bool localNetworkFilter(int32_t *f) const {
    if (local_network_filter <= CONST_MAX_NUM_NETWORKS) {
      (*f) = local_network_filter;
      return true;
    }
    return false;
  }

  inline bool vlanIdFilter(u_int16_t *f) const {
    if (vlan_id_filter != (u_int16_t)-1) {
      (*f) = vlan_id_filter;
      return true;
    }
    return false;
  }

  inline bool ipVersion(u_int8_t *f) const {
    if (ip_version) {
      (*f) = ip_version;
      return true;
    }
    return false;
  }

  inline bool L4Protocol(u_int8_t *f) const {
    if (l4_protocol) {
      (*f) = l4_protocol;
      return true;
    }
    return false;
  }

  inline bool deviceIpFilter(u_int32_t *f) const {
    if (deviceIP) {
      (*f) = deviceIP;
      return true;
    }
    return false;
  }

  inline bool inIndexFilter(u_int32_t *f) const {
    if (inIndex != (u_int32_t)-1) {
      (*f) = inIndex;
      return true;
    }
    return false;
  }

  inline bool outIndexFilter(u_int32_t *f) const {
    if (outIndex != (u_int32_t)-1) {
      (*f) = outIndex;
      return true;
    }
    return false;
  }

  inline bool poolFilter(u_int16_t *f) const {
    if (pool_filter != ((u_int16_t)-1)) {
      (*f) = pool_filter;
      return true;
    }
    return false;
  }

  inline bool flowStatusFilter(u_int16_t *f) const {
    if (alert_type_filter != ((u_int16_t)-1)) {
      (*f) = alert_type_filter;
      return true;
    }
    return false;
  }

  inline bool flowStatusFilter(AlertLevelGroup *f) const {
    if (alert_type_severity_filter != alert_level_group_none) {
      (*f) = alert_type_severity_filter;
      return true;
    }
    return false;
  }

  inline bool macFilter(u_int8_t **f) const {
    if (mac_filter) {
      (*f) = mac_filter;
      return true;
    }
    return false;
  }

  inline bool clientMode(LocationPolicy *f) const {
    if (client_mode) {
      (*f) = client_mode;
      return true;
    }
    return false;
  }

  inline bool serverMode(LocationPolicy *f) const {
    if (server_mode) {
      (*f) = server_mode;
      return true;
    }
    return false;
  }

  inline bool tcpFlowStateFilter(TcpFlowStateFilter *f) const {
    if (tcp_flow_state_filter) {
      (*f) = tcp_flow_state_filter;
      return true;
    }
    return false;
  }

  inline bool transitASFilter(transitAS *f) const {
    if (transit_as) {
      (*f) = transit_as;
      return true;
    }
    return false;
  }

  inline bool asnFilter(u_int32_t *f) const {
    if (asn_filter != (u_int32_t)-1) {
      (*f) = asn_filter;
      return true;
    }
    return false;
  }

  inline bool asnSrcFilter(u_int32_t *f) const {
    if (asn_src_filter != (u_int32_t)-1) {
      (*f) = asn_src_filter;
      return true;
    }
    return false;
  }

  inline bool asnDstFilter(u_int32_t *f) const {
    if (asn_dst_filter != (u_int32_t)-1) {
      (*f) = asn_dst_filter;
      return true;
    }
    return false;
  }

  inline bool icmpValue(u_int8_t *code, u_int8_t *typ) const {
    if ((icmp_type != u_int8_t(-1)) && (icmp_code != u_int8_t(-1))) {
      (*typ) = icmp_type;
      (*code) = icmp_code;
      return true;
    }
    return false;
  }

  inline bool dscpFilter(u_int8_t *f) const {
    if (dscp_filter != (u_int8_t)-1) {
      (*f) = dscp_filter;
      return true;
    }
    return false;
  }
#ifdef NTOPNG_PRO
  inline bool QoEFilter(u_int8_t *f) const {
    if (qoe_filter != (u_int8_t)-1) {
      (*f) = qoe_filter;
      return true;
    }
    return false;
  }
#endif

  inline bool unidirectionalTraffic(bool *f) const {
    if (unidirectional_traffic != -1) {
      (*f) = (unidirectional_traffic == 1) ? true : false;
      return true;
    }
    return false;
  }

  inline bool unicastTraffic(bool *f) const {
    if (unicast_traffic != -1) {
      (*f) = (unicast_traffic == 1) ? true : false;
      return true;
    }
    return false;
  }

  inline bool alertedFlows(bool *f) const {
    if (alerted_flows != -1) {
      (*f) = (alerted_flows == 1) ? true : false;
      return true;
    }
    return false;
  }

  inline bool periodicFlows(bool *f) const {
    if (periodic_flows != -1) {
      (*f) = (periodic_flows == 1) ? true : false;
      return true;
    }
    return false;
  }

  inline bool filteredFlows(bool *f) const {
    if (filtered_flows != -1) {
      (*f) = (filtered_flows == 1) ? true : false;
      return true;
    }
    return false;
  }
};

#endif