local_device.clj

(ns bacure.local-device
  (:require [bacure.coerce :as c]
            [bacure.coerce.obj :as c-obj]
            [bacure.coerce.type.constructed]
            [bacure.coerce.type.enumerated]
            [bacure.coerce.type.error]
            [bacure.coerce.type.primitive]
            [bacure.events :as events]
            [bacure.local-save :as save]
            [bacure.network :as net]
            [bacure.serial-connection :as serial]
            [bacure.state :as state]
            [clojure.tools.logging :as log]
            [com.climate.claypoole :as claypoole])
  (:import (com.serotonin.bacnet4j LocalDevice)
           (com.serotonin.bacnet4j.npdu.ip IpNetwork)
           (com.serotonin.bacnet4j.transport DefaultTransport)
           (java.net InetSocketAddress)))

(comment
  :bacure.coerce.type.constructed/side-effect
  :bacure.coerce.type.enumerated/side-effect
  :bacure.coerce.type.error/side-effect
  :bacure.coerce.type.primitive/side-effect)

;; we store all the local devices with their device-id as the key.

(defn list-local-devices []
  (keys @state/local-devices))

(defn get-local-device
  "Return the local-device associated with the device-id. If device-id
  is nil, simply return the first found."
  [device-id]

  (state/get-local-device device-id))

(defn local-device-object
  "Return the local-device bacnet4j object associated with the
  device-id. If device-id is nil, simply return the first found."
  [device-id]
  (state/get-in-local-device device-id [:bacnet4j-local-device]))


(defn default-transport [network]
  (DefaultTransport. network))


(defn- get-all-device-properties [ldo]
  (-> (into {} (for [p (c-obj/properties-by-option :device :all)]
                 [p (-> (.get ldo (c/clojure->bacnet :property-identifier p))
                        (c/bacnet->clojure))]))
      ;; don't care about those properties for now
      (dissoc :tags :active-vt-sessions :active-cov-subscriptions :reliability-evaluation-inhibit :active-cov-multiple-subscriptions
              :align-intervals :device-address-binding :daylight-savings-status :event-detection-enable :restart-notification-recipients)))

(defn get-configs
  "Return a map of the local-device configurations"
  [local-device-id]
  (when-let [ldo (local-device-object local-device-id)]
    (get-all-device-properties ldo)))

(defn get-local-device-id
  "Given a local device object, return the device ID."
  [device-object]
  (->> (c/clojure->bacnet :property-identifier :object-identifier)
       (.get device-object)
       (.getInstanceNumber)))

(defn- update-config!
  "Will update the given local-device config."
  [local-device-id property-identifier value]
  (let [ldo (local-device-object local-device-id)]
    (.writePropertyInternal ldo
                            (c/clojure->bacnet :property-identifier property-identifier)
                            (c-obj/encode-property-value :device property-identifier value))))

(defn update-configs!
  "Given a map of properties, will update the local-device. Return the
  device configs. Please note that many properties CANNOT be changed
  while the device is initialized (:object-identifier for example) and
  will simply be discarded." [local-device-id properties-smap]
  (let [valid-properties (-> (keys (dissoc (get-configs local-device-id) :object-list))
                             (conj :description :object-name)) ;; what are the keys we should expect
        filtered-properties (select-keys properties-smap valid-properties)]
    ;; filter out any properties we are not expecting. This allows the
    ;; user to give a map containing other values.
    (doseq [[property-identifier value] filtered-properties]
      (update-config! local-device-id property-identifier value))
    ;; get the newly updated configs
    (get-configs local-device-id)))


(def default-configs
  "Some default configurations for device creation."
  {:network-type           :ipv4
   :device-id              1338
   :reuse-address          true
   :local-network-number   0
   :local-address          IpNetwork/DEFAULT_BIND_IP
   :port                   IpNetwork/DEFAULT_PORT
   :model-name             "Bacure"
   :vendor-identifier      697
   :apdu-timeout           6000
   :number-of-apdu-retries 2
   :broadcast-address      (net/get-broadcast-address (net/get-any-ip))
   :description            (str "BACnet device running on the open source Bacure stack. "
                                "See https://github.com/Frozenlock/bacure for details.")
   :vendor-name            "HVAC.IO"})

(defn- get-sane-configs-map
  [configs-map]
  {:pre [(#{:ipv4 :mstp} (:network-type configs-map))]}
  (let [device-id (or (:device-id configs-map)
                      (last (:object-identifier configs-map))
                      (:device-id default-configs))]
    (assoc configs-map
           :device-id device-id
           :broadcast-address (or (:broadcast-address configs-map)
                                  (net/get-broadcast-address (or (:local-address configs-map) (net/get-any-ip))))
           :object-name (or (:object-name configs-map) (str "Bacure device "device-id)))))

(declare terminate!)

(defn- get-transport
  [network configs-map]
  (let [tp (default-transport network)]
    (when-let [retries (:number-of-apdu-retries configs-map)]
      (.setRetries tp retries))
    (when-let [timeout (:apdu-timeout configs-map)]
      (.setTimeout tp timeout))
    (when-let [seg-timeout (:adpu-seg-timeout configs-map)]
      (.setSegTimeout tp seg-timeout))
    tp))

(defn add-listener!
  [local-device-id listener]
  (when-let [ldo (local-device-object local-device-id)]
    (some-> (local-device-object local-device-id)
            (.getEventHandler)
            (.addListener listener))))

(defn new-local-device!
  "Create a new device and return its ID. (A device is required to
  communicate over the BACnet network.). Use the function 'initialize'
  and 'terminate' to bind and unbind the device to the BACnet port. If
  needed, the initial configurations are associated with the
  keyword :init-configs inside the local-device map.'

  See README for more information about how to specify configs-map."
  ([] (new-local-device! nil))
  ([configs-map]
   (let [configs (->> configs-map
                      (merge default-configs)
                      get-sane-configs-map)
         {:keys [device-id broadcast-address port local-address com-port]} configs
         serial-connection (if (some? com-port)
                             (serial/get-opened-serial-connection! configs))
         network (case (:network-type configs)
                   :ipv4 (doto (net/ip-network-builder configs)
                           (.enableBBMD))
                   :mstp (net/create-mstp-network configs))

         tp      (get-transport network configs)
         ld      (LocalDevice. device-id tp)]

     (when (get-local-device device-id)
       (terminate! device-id))

     ;; add the new local-device (and its configuration) into the
     ;; local devices table.
     (state/assoc-local-device! device-id
                                {:bacnet4j-local-device ld
                                 :serial-connection serial-connection
                                 :remote-devices {}
                                 :remote-objects {}
                                 :cov-events {}
                                 :-threadpool (claypoole/priority-threadpool
                                               20 :name (str "bacnet-"device-id))
                                 :init-configs (merge configs
                                                      {:device-id device-id
                                                       :broadcast-address broadcast-address
                                                       :port port
                                                       :local-address local-address})})
     (update-configs! device-id configs)

     (add-listener! device-id (events/unconfirmed-event-listener device-id))

     device-id)))

;;;;;;

(defn local-objects
  "Return a list of all the local objects."
  ([] (local-objects nil))
  ([device-id]
   (some->> (local-device-object device-id)
            (.getLocalObjects)
            (map c/bacnet->clojure))))

(defn -next-instance
  [objects object-type]
  (->> (for [o objects
             :let [[o-type o-inst] (:object-identifier o)]
             :when (= o-type object-type)]
         o-inst)
       (cons -1)
       (apply max)
       (inc)))

(defn object
  "Return a local object"
  ([object-identifier] (object nil object-identifier))
  ([device-id object-identifier]
   (some-> (local-device-object device-id)
           (.getObject (c/clojure->bacnet :object-identifier object-identifier)))))

(defn update-object!
  ([object-map] (update-object! nil object-map))
  ([device-id object-map]
   (let [oid (:object-identifier object-map)
         bacnet-object (object device-id oid)]
     (doseq [[p-id v] object-map]
       (.writePropertyInternal bacnet-object
                               (c/clojure->bacnet :property-identifier p-id)
                               (c-obj/encode-property-value (first oid) p-id v)))
     (c/bacnet->clojure bacnet-object))))

(defn add-object!
  "Add the object map to the local device. Returns an object map."
  ([object-map] (add-object! nil object-map))
  ([device-id object-map]
   (let [ldo (local-device-object device-id)
         new-oid (or (:object-identifier object-map)
                     (let [o-type (:object-type object-map)]
                       [o-type (-next-instance (local-objects device-id) o-type)]))
         new-object-map (assoc object-map :object-identifier new-oid)
         bacnet-object (c/clojure->bacnet :bacnet-object (c-obj/bacnet-object-with-local-device new-object-map ldo))]
     (.addObject ldo bacnet-object)
     ;; Update additional properties (name, description, etc.)
     (update-object! device-id new-object-map))))

(defn remove-object!
  ([object-identifier] (remove-object! nil object-identifier))
  ([device-id object-identifier]
   (let [object-type (first object-identifier)]
     (assert (not= object-type :device) "Can't remove the device object."))
   (some-> (local-device-object device-id)
           (.removeObject (c/clojure->bacnet :object-identifier object-identifier)))))

(defn remove-all-objects!
  "Remove all the objects (except the local device itself)."
  ([] (remove-all-objects! nil))
  ([device-id]
   (doseq [{:keys [object-identifier]} (local-objects device-id)
           :when (not= (first object-identifier) :device)]
     (remove-object! device-id object-identifier))))



;;;;;;

(defn register-as-foreign-device
  "Register the local device as a foreign device in a device located
  on another network. Will block until the registration is completed
  or the request times out.

  The time-to-live is the time in minutes after which we should be
  removed from the foreign device table (if we don't re-register).

  Re-registration are handled automatically.

  Throws a BACnet exception if timeout, a NAK is received, the device
  is already registered or if the request couldn't be sent."
  ([target-ip-or-hostname target-port time-to-live]
   (register-as-foreign-device nil target-ip-or-hostname target-port time-to-live))

  ([local-device-id target-ip-or-hostname target-port time-to-live]
   (some-> (local-device-object local-device-id)
           (.getNetwork)
           (.registerAsForeignDevice
            (java.net.InetSocketAddress. target-ip-or-hostname target-port) time-to-live))))

(defn unregister-as-foreign-device
  "Unregister as a foreign device. Should be done automatically when
  terminating a local device."
  ([] (unregister-as-foreign-device nil))

  ([local-device-id]
   (some-> (local-device-object local-device-id)
           (.getNetwork)
           (.unregisterAsForeignDevice))))

(defn maybe-register-as-foreign-device!
  "Try to register the device if the key ':foreign-device-target' is
  present in the configuration "
  [local-device-id]
  (when-let [fdt (some-> (get-local-device local-device-id)
                         :init-configs
                         :foreign-device-target)]
    (let [{:keys [host port]} fdt]
      (when (and host port)
        (try
          (register-as-foreign-device host port 3600)
          (catch Exception e))))))


(defn i-am-broadcast!
  "Send an 'I am' broadcast on the network."
  ([] (i-am-broadcast! nil))
  ([local-device-id]
   (let [ldo (local-device-object local-device-id)]
     (->> (.getIAm ldo)
          (.sendGlobalBroadcast ldo)))))


(defn initialize!
  "Initialize the local device. This will bind it to it's port (most
  likely 47808), send a WhoIsRequest and load any programs available
  for the local-device. The port will remain unavailable until the
  device is terminated. Once terminated, you should discard the device
  and create a new one if needed.

  For more information on the local-device 'programs' operations, see
  the bacure.local-save namespace.

  Return true if initializing (binding to port) is successful."
  ([] (initialize! nil))
  ([local-device-id]
   (let [ldo (local-device-object local-device-id)]
     ;; try to bind to the bacnet port
     (if (.isInitialized ldo)
       (log/info "The local device is already initialized.")
       (let [port (or (:port (get-configs local-device-id)) 47808)
             port-bind (try (do (.initialize ldo) true)
                            (catch java.net.BindException e
                              (do (log/error (str "The BACnet port ("port") is already bound to another "
                                                  "software.\n\t Please close the other software and try again.\n"))
                                  (throw e))))]
         ;; once we have the port, load the local programs
         (try (save/load-program)  ;; Anything in the program will be executed.
              (catch Exception e (log/error (str "Uh oh... couldn't load the local device program:\n"
                                                 (.getMessage e)))))
         ;; return true if we are bound to the port
         port-bind)))))

(defn- close-serial-connection-for-device!
  "Closes any serial connection referred to by the given device, if it both exists
  and is open."
  [local-device-id]
  (some-> (get-local-device local-device-id)
          (get-in [:init-configs :com-port])
          serial/ensure-connection-closed!))

(defn terminate!
  "Terminate the local device, freeing any bound port in the process. Close its
  serial connection if it exists afterwards. (If we don't terminate the device
  first, and it's got an MS/TP node, it'll try to access a closed serial
  connection in its MS/TP node thread and it'll throw angrily.)"
  ([] (terminate! nil))
  ([local-device-id]
   (some-> (get-local-device local-device-id)
           :-threadpool
           claypoole/shutdown)
   (let [ldo (local-device-object local-device-id)]
     (when (.isInitialized ldo)
       (.terminate ldo)))
   (close-serial-connection-for-device! local-device-id)))

(defn terminate-all!
  "Terminate all local devices."
  []
  (doseq [ld-id (list-local-devices)]
    (terminate! ld-id)))

(defn- replace-object-identifier-by-device-id
  "Replace any object-identifier key by a device-id.

  If a device-id is already present, use it.
  Otherwise fallback on the device-id provided inside the object-identifier.

  Why? Bacure mostly uses 'device-id' for simplicity. However this can
  cause issues if an object-identifier is already present in a
  configuration map."
  [config]
  (let [device-id (or (:device-id config)
                      (second (:object-identifier config)))]
    (if device-id
      (-> config
          (dissoc :object-identifier)
          (assoc :device-id device-id))
      config)))

(defn local-device-backup
  "Get the necessary information to create a local device backup."
  ([] (local-device-backup nil))
  ([local-device-id]
   (some-> (:init-configs (get-local-device local-device-id))
           (merge (get-configs local-device-id))
           (replace-object-identifier-by-device-id)
           ;; Also save the local objects except the :device.
           (assoc :local-objects (->> (local-objects local-device-id)
                                      (remove #(= (:object-type %) :device)))))))



;; ;; eventually we should be able to add programs in the local device

(defn reset-local-device!
  "Terminate the local device and discard it. Replace it with a new
  local device, and apply the same configurations as the previous one.
  If a map with new configurations is provided, it will be merged with
  the old config.

  (reset-local-device {:device-id 1112})
  ---> reset the device and change the device id."
  ([] (reset-local-device! nil nil))
  ([config-or-id] (if (map? config-or-id)
                    (reset-local-device! (:device-id config-or-id) config-or-id)
                    (reset-local-device! config-or-id nil)))
  ([local-device-id new-config]
   (if-not (get-local-device local-device-id)
     ;; if we don't have a local device available, create one.
     (do (new-local-device! (merge {:device-id local-device-id} new-config))
         (initialize! local-device-id)
         (doseq [obj (:local-objects new-config)]
           (add-object! local-device-id obj)))
     ;; when we already have a local device, backup its configs, merge
     ;; them with the newly provided one and restart the device.
     (let [backup (local-device-backup local-device-id)
           config (merge backup new-config)]
       (terminate! local-device-id)
       (new-local-device! (merge backup new-config))
       (initialize! local-device-id)
       (doseq [obj (:local-objects config)]
         (add-object! local-device-id obj))))))

(defn clear!
  "Destroy all traces of one local-device."
  [local-device-id]

  (terminate! local-device-id)
  (state/dissoc-local-device! local-device-id))

(defn clear-all!
  "Destroy all traces of all local-devices."
  []
  (terminate-all!)
  (state/clear-local-devices!))

(defn  save-local-device-backup!
  "Save the device backup on a local file and return the config map."[]
  (save/save-configs (local-device-backup)))
;; eventually it would be nice to implement the BACnet backup procedure.


(defn load-local-device-backup!
  "Load the local-device backup file and reset it with this new
  configuration."
  ([local-device-id] (load-local-device-backup! local-device-id nil))
  ([local-device-id new-configs]
   (-> (save/get-configs)
       (merge new-configs)
       (replace-object-identifier-by-device-id)
       (reset-local-device!))))

(defn- set-communication-state!
  ([state] (set-communication-state! state nil 1))

  ([state minutes] (set-communication-state! state nil minutes))

  ([state local-device-id minutes]
   (-> (local-device-object local-device-id)
       (.setCommunicationControl (c/clojure->bacnet :enable-disable state) minutes))))

(def disable-communications! (partial set-communication-state! :disable))
(def enable-communications! (partial set-communication-state! :enable))


;; ================================================================
;; Test helpers
;; ================================================================

(defmacro with-temp-devices
  "Execute body with a temporary set of local-devices. Useful for tests.
  Warning: uses `with-redefs`, don't use concurrently (ex: pmap)."
  [& body]
  `(let [ret# (with-redefs [state/local-devices (atom {})]
                (try (let [ret# (do ~@body)]
                       (if (seq? ret#)         ; Prevent result from being lazy
                         (doall ret#)
                         ret#))
                     (catch Exception e#
                       ^{:type ::e} {:e e#})
                     (finally (terminate-all!))))]
     (if (= (type ret#) ::e)
       (throw (:e ret#))
       ret#)))

(defn local-test-devices!
  "Generate multiple devices with a unique IP address.
  (127.0.0.1, 127.0.0.2, etc.)

  They don't bind to anylocal (\"0.0.0.0\") and thus won't
  automatically receive broadcasts.

  You probably want to register them as foreign devices or use
  `remote-device/local-registered-test-devices!` instead."
  [qty port]
  (let [ids-and-addr (for [i (range 1 (inc qty))]
                       {:id i :ip-address (str "127.0.0."i)})]
    (doseq [m ids-and-addr]
      (let [id (:id m)]
        (new-local-device!
         {:port              port
          :device-id         id
          :local-address     (:ip-address m)
          :broadcast-address "127.0.0.255"})
        (initialize! id)))
    ids-and-addr))