/*

 *

 * (C) 2019-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 _OTHER_ALERTABLE_ENTITY_H_

#define _OTHER_ALERTABLE_ENTITY_H_

#include "ntop_includes.h"

class NetworkInterface;

class OtherAlertableEntity : public AlertableEntity {

 private:

 protected:

  /*

    Creating multiple maps guarantees that periodic scripts at different

    granularities do not interfere each other and thus that they can run

    concurrently without locking.

    However while alert_cache is accessed only by the alert engine and thus it

    is "thread-safe" as concurrent scripts (i.e. at different granularities)

    cannot call it, engaged_alerts needs to be protected as

    - it can be called by the Lua GUI

    - it can be called by the alert engine

    In order to save memory, the std::map key is a hash 32 bit and not the

    original string. Considered the number of entries this is a good

    tradeoff with no false positives considered the limited value

    cardinality.

  */

  std::map<u_int32_t /* std::string */, std::string> alert_cache[MAX_NUM_PERIODIC_SCRIPTS];

  std::map<u_int32_t /* std::string */, Alert> engaged_alerts[MAX_NUM_PERIODIC_SCRIPTS];

  void getAlertsByPeriodicity(lua_State *vm, ScriptPeriodicity p,

                            AlertType type_filter, AlertLevel severity_filter,

                            AlertRole role_filter, u_int *idx);

 public:

  OtherAlertableEntity(NetworkInterface *alert_iface, AlertEntity entity);

  virtual ~OtherAlertableEntity();

  /*

    getAlertCachedValue and setAlertCacheValue as thread safe as they are

    invoked only by periodic scripts and are not accessed by the GUI lua methods

  */

  inline std::string getAlertCachedValue(std::string key, ScriptPeriodicity p) {

    std::map<u_int32_t /* std::string */, std::string>::iterator it = alert_cache[(u_int)p].find(ndpi_hash_string(key.c_str()));

    return ((it != alert_cache[(u_int)p].end()) ? it->second : std::string(""));

  }

  inline void setAlertCacheValue(std::string key, std::string value,

                                 ScriptPeriodicity p) {

    alert_cache[(u_int)p][ndpi_hash_string(key.c_str())] = value;

  }

  bool triggerAlert(lua_State *vm, std::string key, ScriptPeriodicity p,

                    time_t now, u_int32_t score, AlertType alert_id,

                    const char *subtype, const char *json, const char *ip, 

                    const char *name, u_int16_t port);

  bool releaseAlert(lua_State *vm, std::string key, ScriptPeriodicity p,

                    time_t now);

  void luaAlert(lua_State *vm, const Alert *alert, ScriptPeriodicity p) const;

  void countAlerts(grouped_alerts_counters *counters);

  void getAlerts(lua_State *vm, ScriptPeriodicity p, AlertType type_filter,

                 AlertLevel severity_filter, AlertRole role_filter, u_int *idx);

};

#endif