Pamhyr2/src/Model/Reservoir/Reservoir.py

# Reservoir.py -- Pamhyr
# Copyright (C) 2023-2024  INRAE
#
# 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, see <https://www.gnu.org/licenses/>.

# -*- coding: utf-8 -*-

import logging

from Model.Tools.PamhyrDB import SQLSubModel
from Model.Scenario import Scenario

logger = logging.getLogger()


class Data(SQLSubModel):
    _sub_classes = []

    def __init__(self, id: int = -1, status=None):
        super(Data, self).__init__(id)
        self._status = status

        self._data = []

    @classmethod
    def _db_create(cls, execute, ext=""):
        execute(f"""
          CREATE TABLE reservoir_data{ext}(
            {cls.create_db_add_pamhyr_id()},
            ind INTEGER NOT NULL,
            elevation REAL NOT NULL,
            surface REAL NOT NULL,
            reservoir INTEGER,
            {Scenario.create_db_add_scenario()},
            {Scenario.create_db_add_scenario_fk()},
            FOREIGN KEY(reservoir) REFERENCES reservoir(pamhyr_id),
            PRIMARY KEY(pamhyr_id, scenario)
          )
        """)

        return cls._create_submodel(execute)

    @classmethod
    def _db_update(cls, execute, version, data=None):
        major, minor, release = version.strip().split(".")

        if major == minor == "0":
            cls._db_update_to_0_1_0(execute, data)

        return cls._update_submodel(execute, version, data)

    @classmethod
    def _db_update_to_0_1_0(cls, execute, data):
        table = "reservoir_data"
        reservoirs = data['id2pid']['reservoir']

        cls.update_db_add_pamhyr_id(
            execute, table,
            data=data
        )
        Scenario.update_db_add_scenario(execute, table)

        cls._db_create(execute, ext="_tmp")
        execute(
            f"INSERT INTO {table} " +
            "(pamhyr_id, ind, elevation, surface, reservoir, scenario) " +
            "SELECT pamhyr_id, ind, elevation, surface, reservoir, scenario " +
            f"FROM {table}"
        )

        execute(f"DROP TABLE {table}")
        execute(f"ALTER TABLE {table}_tmp RENAME TO {table}")

        cls._db_update_to_0_1_0_set_reservoir_pid(execute, table, reservoirs)

    @classmethod
    def _db_update_to_0_1_0_set_reservoir_pid(cls, execute, table, reservoirs):
        bcs = execute(
            f"SELECT pamhyr_id, reservoir FROM {table}"
        )

        for row in bcs:
            it = iter(row)
            pid = next(it)
            reservoir_id = next(it)

            execute(
                f"UPDATE {table} " +
                f"SET reservoir = {reservoirs[reservoir_id]}, " +
                f"WHERE pamhyr_id = {pid}"
            )

    @classmethod
    def _db_load(cls, execute, data=None):
        new = []
        reseroire = data["reservoir"]

        values = execute(
            "SELECT pamhyr_id, ind, elevation, surface " +
            "FROM reservoir_data " +
            f"WHERE reservoir = {reseroire.pamhyr_id} " +
            "ORDER BY ind ASC"
        )

        for v in values:
            it = iter(v)

            pid = next(it)
            ind = next(it)
            elevation = next(it)
            surface = next(it)

            nd = cls(
                id=pid, status=data['status']
            )
            nd._data = [elevation, surface]

            new.append(nd)

        return new

    def _db_save(self, execute, data=None):
        pid = self._pamhyr_id
        ind = data["ind"]
        elevation = self._db_format(str(self[0]))
        surface = self._db_format(str(self[1]))
        bc = data["bc"]

        execute(
            "INSERT INTO " +
            "reservoir_data " +
            "(pamhyr_id, ind, elevation, surface, reservoir) " +
            "VALUES (" +
            f"{pid}, {ind}, '{elevation}', {surface}, " +
            f"{reservoir._pamhyr_id}" +
            ")"
        )

    def __getitem__(self, key):
        return self._data[key]

    def __setitem__(self, key, value):
        self._data[key] = float(value)


class Reservoir(SQLSubModel):
    _sub_classes = [Data]

    def __init__(self, id: int = -1,
                 name: str = "",
                 status=None):
        super(Reservoir, self).__init__(id)

        self._status = status

        self._name = name
        self._node = None
        self._data = []

    @classmethod
    def _db_create(cls, execute, ext=""):
        execute(f"""
          CREATE TABLE reservoir{ext} (
            {cls.create_db_add_pamhyr_id()},
            name TEXT NOT NULL,
            node INTEGER,
            {Scenario.create_db_add_scenario()},
            {Scenario.create_db_add_scenario_fk()},
            FOREIGN KEY(node) REFERENCES river_node(pamhyr_id),
            PRIMARY KEY(pamhyr_id, scenario)
          )
        """)

        return cls._create_submodel(execute)

    @classmethod
    def _db_update(cls, execute, version, data=None):
        major, minor, release = version.strip().split(".")
        if major == minor == "0":
            if int(release) < 5:
                cls._db_create(execute)

            cls._db_update_to_0_1_0(execute, data)

        return cls._update_submodel(execute, version, data)

    @classmethod
    def _db_update_to_0_1_0(cls, execute, data):
        table = "reservoir"
        nodes = data['id2pid']['river_node']

        cls.update_db_add_pamhyr_id(
            execute, table,
            data=data
        )
        Scenario.update_db_add_scenario(execute, table)

        cls._db_create(execute, ext="_tmp")
        execute(
            f"INSERT INTO {table} " +
            "(pamhyr_id, name, node, scenario) " +
            "SELECT pamhyr_id, name, node, scenario " +
            f"FROM {table}"
        )

        execute(f"DROP TABLE {table}")
        execute(f"ALTER TABLE {table}_tmp RENAME TO {table}")

        cls._db_update_to_0_1_0_set_node_pid(execute, table, nodes)

    @classmethod
    def _db_load(cls, execute, data=None):
        new = []

        table = execute(
            "SELECT pamhyr_id, name, node " +
            "FROM reservoir "
        )

        for row in table:
            it = iter(row)

            id = next(it)
            name = next(it)
            node_id = next(it)

            new_reservoir = cls(id, name, status=data["status"])

            new_reservoir._node = None
            if node_id != -1:
                new_reservoir._node = next(
                    filter(
                        lambda n: n.id == node_id, data["nodes"]
                    )
                )

            data["reservoir"] = new_reservoir
            new_reservoir._data = Data._db_load(
                execute, data=data
            )

            new.append(new_reservoir)

        return new

    def _db_save(self, execute, data=None):
        execute(
            "DELETE FROM reservoir " +
            f"WHERE pamhyr_id = {self.pamhyr_id}"
        )
        execute(
            "DELETE FROM reservoir_data " +
            f"WHERE reservoir = {self.pamhyr_id}"
        )

        node_id = 'NULL'
        if self._node is not None:
            node_id = self._node.pamhyr_id

        sql = (
            "INSERT INTO " +
            "reservoir(id, name, node) " +
            "VALUES (" +
            f"{self.pamhyr_id}, '{self._db_format(self._name)}', " +
            f"{node_id}" +
            ")"
        )
        execute(sql)

        ind = 0
        for d in self._data:
            data["ind"] = ind

            d._db_save(execute, data)

            ind += 1

        return True

    def __len__(self):
        return len(self._data)

    @property
    def name(self):
        if self._name == "":
            return f"Reservoir #{self.pamhyr_id}"

        return self._name

    @name.setter
    def name(self, name):
        self._name = name
        self._status.modified()

    @property
    def node(self):
        return self._node

    @node.setter
    def node(self, node):
        self._node = node
        self._status.modified()

    def has_node(self):
        return self._node is not None

    @property
    def data(self):
        return self._data.copy()

    @property
    def _default_elevation(self):
        return 0.0

    @property
    def _default_surface(self):
        return 0.0

    def is_define(self):
        return len(self._data) != 0

    def new_from_data(self, data):

        try:
            new_0 = float(data[0])
            new_1 = float(data[1])
        except Exception as e:
            logger.error(e)
            new_0 = None
            new_1 = None

        return (new_0, new_1)

    def add(self, index: int):
        value = (self._default_elevation, self._default_surface)
        self._data.insert(index, value)
        self._status.modified()
        return value

    def insert(self, index: int, value):
        self._data.insert(index, value)
        self._status.modified()

    def delete_i(self, indexes):
        self._data = list(
            map(
                lambda e: e[1],
                filter(
                    lambda e: e[0] not in indexes,
                    enumerate(self.data)
                )
            )
        )
        self._status.modified()

    def delete(self, els):
        self._data = list(
            filter(
                lambda e: e not in els,
                self.data
            )
        )
        self._status.modified()

    def sort(self, _reverse=False, key=None):
        if key is None:
            self._data.sort(reverse=_reverse)
        else:
            self._data.sort(reverse=_reverse, key=key)
        self._status.modified()

    def get_i(self, index):
        return self.data[index]

    def get_range(self, _range):
        lst = []
        for r in _range:
            lst.append(r)
        return lst

    def _set_i_c_v(self, index, column, value):
        v = list(self._data[index])
        v[column] = value
        self._data[index] = tuple(v)
        self._status.modified()

    def set_i_elevation(self, index: int, value):
        self._set_i_c_v(index, 0, value)

    def set_i_surface(self, index: int, value):
        self._set_i_c_v(index, 1, value)

    def move_up(self, index):
        if index < len(self):
            next = index - 1
            d = self._data
            d[index], d[next] = d[next], d[index]
            self._status.modified()

    def move_down(self, index):
        if index >= 0:
            prev = index + 1
            d = self._data
            d[index], d[prev] = d[prev], d[index]
            self._status.modified()