Pamhyr2/src/Model/WeatherParameters/WeatherParameters.py

# WeatherParameters.py -- Pamhyr
# Copyright (C) 2023-2025  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 tools import (
    trace, timer,
    old_pamhyr_date_to_timestamp,
    date_iso_to_timestamp,
    date_dmy_to_timestamp,
)

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

logger = logging.getLogger()


class Data(SQLSubModel):
    _sub_classes = []

    def __init__(self,
                 data0, data1,
                 id: int = -1,
                 types=[float, float],
                 status=None,
                 owner_scenario=-1):
        super(Data, self).__init__(
            id=id, status=status,
            owner_scenario=owner_scenario
        )

        self._types = types
        self._data = [data0, data1]

    @classmethod
    def _db_create(cls, execute, ext=""):
        execute(f"""
          CREATE TABLE weather_parameters_data{ext} (
            {cls.create_db_add_pamhyr_id()},
            deleted BOOLEAN NOT NULL DEFAULT FALSE,
            ind INTEGER NOT NULL,
            data0 TEXT NOT NULL,
            data1 TEXT NOT NULL,
            wp INTEGER,
            {Scenario.create_db_add_scenario()},
            {Scenario.create_db_add_scenario_fk()},
            FOREIGN KEY(wp) REFERENCES weather_parameters(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 == "0" and (int(minor) < 2 or
                             (int(minor) == 2 and int(release) < 7)):
            if not cls.is_table_exists(execute, "air_temperature_data"):
                cls._db_create(execute)

        return cls._update_submodel(execute, version, data)

    @classmethod
    def _db_load(cls, execute, data=None):
        new = []
        wp = data["wp"]
        status = data['status']
        scenario = data["scenario"]
        loaded = data['loaded_pid']

        if scenario is None:
            return new

        values = execute(
            "SELECT pamhyr_id, deleted, " +
            "data0, data1, scenario " +
            "FROM weather_parameters_data " +
            f"WHERE wp = {wp._pamhyr_id} " +
            f"AND scenario = {scenario.id} " +
            f"AND pamhyr_id NOT IN ({', '.join(map(str, loaded))}) " +
            "ORDER BY ind ASC"
        )

        for v in values:
            it = iter(v)

            pid = next(it)
            deleted = next(it)
            data0 = wp._types[0](next(it))
            data1 = wp._types[1](next(it))
            owner_scenario = next(it)

            nd = cls(
                data0, data1,
                id=pid,
                types=wp._types,
                status=status,
                owner_scenario=owner_scenario
            )
            if deleted:
                nd.set_as_deleted()

            loaded.add(pid)
            new.append(nd)

        data["scenario"] = scenario.parent
        new += cls._db_load(execute, data)
        data["scenario"] = scenario

        return new

    def _db_save(self, execute, data=None):
        pid = self._pamhyr_id
        ind = data["ind"]
        data0 = self._db_format(str(self[0]))
        data1 = self._db_format(str(self[1]))
        wp = data["wp"]

        execute(
            "INSERT INTO " +
            "weather_parameters_data (pamhyr_id, deleted, ind, " +
            "data0, data1, wp, scenario) " +
            f"VALUES ({pid}, {self._db_format(self.is_deleted())}, " +
            f"{ind}, '{self._db_format(data0)}', {self._db_format(data1)}, " +
            f"{wp._pamhyr_id}, {self._status.scenario_id}" +
            ")"
        )

        return True

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

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


class WeatherParametersDefault(SQLSubModel):
    def __init__(self, type: str, value: float = 0.0,
                 id: int = -1, status=None, owner_scenario=-1):
        super(WeatherParametersDefault, self).__init__(
            id=id, status=status,
            owner_scenario=owner_scenario
        )

        self._type = type
        self._value = float(value)

    @classmethod
    def _db_load(cls, execute, data=None):
        new = []
        status = data['status']
        scenario = data["scenario"]
        loaded = data['loaded_pid']

        if scenario is None:
            return new

        table = execute(
            "SELECT pamhyr_id, type, value, scenario " +
            "FROM weather_parameters_default " +
            f"WHERE scenario = {scenario.id} " +
            f"AND pamhyr_id NOT IN ({', '.join(map(str, loaded))}) "
        )

        for row in table:
            it = iter(row)

            pid = next(it)
            type = next(it)
            value = next(it)
            owner_scenario = next(it)

            wp_default = cls(
                type=type,
                value=value,
                id=pid,
                status=status,
                owner_scenario=owner_scenario
            )

            loaded.add(pid)
            new.append(wp_default)

        data["scenario"] = scenario.parent
        new += cls._db_load(execute, data)
        data["scenario"] = scenario

        return new

    def _db_save(self, execute, data=None):
        if not self.must_be_saved():
            return True

        execute(
            "INSERT INTO " +
            "weather_parameters_default(" +
            "pamhyr_id, type, value, scenario) " +
            "VALUES (" +
            f"{self.id}, '{self._db_format(self._type)}', {self._value}, " +
            f"{self._status.scenario_id}" +
            ")"
        )

        return True

    @property
    def type(self):
        return self._type

    @property
    def value(self):
        return self._value

    @value.setter
    def value(self, value):
        self._value = float(value)
        self.modified()


class WeatherParameters(SQLSubModel):
    _sub_classes = [Data]

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

        self._name = name
        self._type = ""
        self._reach = None
        self._begin_section = None
        self._end_section = None
        self._data = []
        self._header = []
        self._types = [float, float]

    @classmethod
    def _db_create(cls, execute, ext=""):
        execute(f"""
          CREATE TABLE weather_parameters{ext}(
            {cls.create_db_add_pamhyr_id()},
            deleted BOOLEAN NOT NULL DEFAULT FALSE,
            name TEXT NOT NULL,
            type TEXT NOT NULL,
            reach INTEGER,
            begin_section INTEGER,
            end_section INTEGER,
            {Scenario.create_db_add_scenario()},
            {Scenario.create_db_add_scenario_fk()},
            FOREIGN KEY(reach) REFERENCES river_reach(pamhyr_id),
            FOREIGN KEY(begin_section)
            REFERENCES geometry_profileXYZ(pamhyr_id),
            FOREIGN KEY(end_section)
            REFERENCES geometry_profileXYZ(pamhyr_id),
            PRIMARY KEY(pamhyr_id, scenario)
          )
        """)

        execute(f"""
          CREATE TABLE weather_parameters_default{ext}(
            {cls.create_db_add_pamhyr_id()},
            type TEXT NOT NULL,
            value FLOAT NOT NULL,
            {Scenario.create_db_add_scenario()},
            {Scenario.create_db_add_scenario_fk()},
            primary KEY(pamhyr_id, scenario)
          )
        """)

        if ext == "_tmp":
            return True

        return cls._create_submodel(execute)

    @classmethod
    def _get_ctor_from_type(cls, t):
        from Model.WeatherParameters.WeatherParametersTypes import (
            NotDefined, WeatherParam, AirTemperature, SpecificHumidity,
            GlobalRadiation, ReferenceWindSpeed, GroundwaterTemperature,
            GroundwaterFlowRate, Albedo, ShadingCoefficient, CloudCoverFraction
        )

        res = NotDefined
        if t == "WP":
            res = WeatherParam
        elif t == "AT":
            res = AirTemperature
        elif t == "SH":
            res = SpecificHumidity
        elif t == "GR":
            res = GlobalRadiation
        elif t == "RWS":
            res = ReferenceWindSpeed
        elif t == "GT":
            res = GroundwaterTemperature
        elif t == "GFR":
            res = GroundwaterFlowRate
        elif t == "ALB":
            res = Albedo
        elif t == "SC":
            res = ShadingCoefficient
        elif t == "CCF":
            res = CloudCoverFraction
        else:
            res = NotDefined
        return res

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

        if major == "0" and (int(minor) < 2 or
                             (int(minor) == 2 and int(release) < 7)):
            if not cls.is_table_exists(execute, "air_temperature"):
                cls._db_create(execute)
                created = True

        if not cls.is_table_exists(execute, "weather_parameters_default"):
            execute(f"""
              CREATE TABLE weather_parameters_default(
                {cls.create_db_add_pamhyr_id()},
                type TEXT NOT NULL,
                value FLOAT NOT NULL,
                {Scenario.create_db_add_scenario()},
                {Scenario.create_db_add_scenario_fk()},
                primary KEY(pamhyr_id, scenario)
              )
            """)

        if not created:
            return cls._update_submodel(execute, version, data)

        return True

    @classmethod
    def _db_load(cls, execute, data=None):
        new = []
        status = data['status']
        edges = data["edges"]
        scenario = data["scenario"]
        loaded = data['loaded_pid']

        if scenario is None:
            return new

        table = execute(
            "SELECT pamhyr_id, deleted, name, type, " +
            "reach, begin_section, end_section, scenario " +
            "FROM weather_parameters " +
            f"WHERE scenario = {scenario.id} " +
            f"AND pamhyr_id NOT IN ({', '.join(map(str, loaded))}) "
        )

        for row in table:
            it = iter(row)

            pid = next(it)
            deleted = next(it)
            name = next(it)
            t = next(it)
            reach = next(it)
            b_section = next(it)
            e_section = next(it)
            owner_scenario = next(it)

            ctor = cls._get_ctor_from_type(t)
            wp = ctor(
                id=pid, name=name,
                status=status,
                owner_scenario=owner_scenario
            )
            wp.reach = None
            wp._begin_section = None
            wp._end_section = None

            if reach not in (-1, None):
                wp.reach = next(
                    (edge for edge in edges if edge.id == reach), None
                )
                profiles = (
                    wp.reach.reach.profiles
                    if wp.reach is not None else []
                )
                wp._begin_section = next(
                    (profile for profile in profiles
                     if profile.id == b_section), None
                )
                wp._end_section = next(
                    (profile for profile in profiles
                     if profile.id == e_section), None
                )

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

            loaded.add(pid)
            new.append(wp)

        data["scenario"] = scenario.parent
        new += cls._db_load(execute, data)
        data["scenario"] = scenario

        return new

    def _db_save(self, execute, data=None):
        if not self.must_be_saved():
            return True

        data["wp"] = self

        execute(
            "DELETE FROM weather_parameters_data " +
            f"WHERE wp = {self._pamhyr_id} " +
            f"AND scenario = {self._status.scenario_id}"
        )

        reach = None
        begin_section = None
        end_section = None

        if self._reach is not None:
            reach = self._reach._pamhyr_id
            begin_section = self._begin_section._pamhyr_id
            end_section = self._end_section._pamhyr_id

        execute(
            "INSERT INTO " +
            "weather_parameters(" +
            "pamhyr_id, deleted, name, type, " +
            "reach, begin_section, end_section, scenario) " +
            "VALUES (" +
            f"{self.id},  {self._db_format(self.is_deleted())}, " +
            f"'{self._db_format(self._name)}', " +
            f"'{self._db_format(self._type)}', {reach}, " +
            f"{begin_section}, {end_section}, " +
            f"{self._status.scenario_id}" +
            ")"
        )

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

            d._db_save(execute, data)

            ind += 1

        return True

    def _data_traversal(self,
                        predicate=lambda obj, data: True,
                        modifier=lambda obj, data: None,
                        data={}):
        if predicate(self, data):
            modifier(self, data)

        for d in self._data:
            d._data_traversal(predicate, modifier, data)

    def __len__(self):
        return len(
            list(
                filter(
                    lambda el: not el.is_deleted(),
                    self._data
                )
            )
        )

    @classmethod
    def compatibility(cls):
        return ["liquid", "solid", "suspenssion"]

    @classmethod
    def time_convert(cls, data):
        if type(data) is str:
            if data.count("-") == 2:
                return date_iso_to_timestamp(data)
            if data.count("/") == 2:
                return date_dmy_to_timestamp(data)
            if data.count(":") == 3:
                return old_pamhyr_date_to_timestamp(data)
            if data.count(":") == 2:
                return old_pamhyr_date_to_timestamp("00:" + data)
            if data.count(".") == 1:
                return round(float(data))

        return int(data)

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

        return self._name

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

    @property
    def type(self):
        return self._type

    @property
    def reach(self):
        return self._reach

    @reach.setter
    def reach(self, reach):
        self._reach = reach
        self._begin_section = None
        self._end_section = None

        if reach is not None:
            profiles = reach.reach.profiles
            if profiles:
                self._begin_section = profiles[0]
                self._end_section = profiles[-1]

        self.modified()

    def has_reach(self):
        return self._reach is not None

    @property
    def begin_rk(self):
        if self._begin_section is None:
            return 0

        return self._begin_section.rk

    @property
    def begin_section(self):
        return self._begin_section

    @begin_section.setter
    def begin_section(self, section):
        self._begin_section = section
        self.modified()

    @property
    def end_rk(self):
        if self._end_section is None:
            return 0

        return self._end_section.rk

    @property
    def end_section(self):
        return self._end_section

    @end_section.setter
    def end_section(self, section):
        self._end_section = section
        self.modified()

    @property
    def header(self):
        return self._header.copy()

    @property
    def data(self):
        return list(
            filter(
                lambda el: not el.is_deleted(),
                self._data
            )
        )

    def get_type_column(self, column):
        if 0 <= column < 2:
            return self._types[column]
        return None

    @property
    def _default_0(self):
        return self._types[0](0)

    @property
    def _default_1(self):
        return self._types[1](0.0)

    def is_define(self):
        return self._data is not None

    def new_from_data(self, header, data):
        new_0 = self._default_0
        new_1 = self._default_1

        def convert(column, value, default):
            if value.strip() == "":
                return default
            return self._types[column](value.replace(",", "."))

        if len(header) != 0:
            for i in [0, 1]:
                for j in range(len(header)):
                    if self._header[i] == header[j] and j < len(data):
                        if i == 0:
                            new_0 = convert(i, data[j], new_0)
                        else:
                            new_1 = convert(i, data[j], new_1)
        else:
            if len(data) > 0:
                new_0 = convert(0, data[0], new_0)
            if len(data) > 1:
                new_1 = convert(1, data[1], new_1)

        return Data(new_0, new_1, status=self._status)

    def add(self, index: int):
        value = Data(self._default_0, self._default_1, status=self._status)
        self.insert(index, value)
        return value

    def insert(self, index: int, value):
        visible_data = self.data
        if index < len(visible_data):
            index = self._data.index(visible_data[index])
        else:
            index = len(self._data)
        self._data.insert(index, value)
        self.modified()

    def set_data_value(self, value, column, data):
        value[column] = self._types[column](data)
        self.modified()

    def set_deleted(self, values, deleted):
        for value in values:
            if deleted:
                value.set_as_deleted()
            else:
                value.set_as_not_deleted()
        self.modified()

    def reorder(self, values):
        values = iter(values)
        self._data = [
            value if value.is_deleted() else next(values)
            for value in self._data
        ]
        self.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.modified()

    def set_as_deleted_i(self, indexes):
        for i in indexes:
            self._data[i].set_as_deleted()
        self.modified()

    def set_as_not_deleted_i(self, indexes):
        for i in indexes:
            self._data[i].set_as_not_deleted()
        self.modified()

    def delete(self, els):
        self._data = list(
            filter(
                lambda e: e not in els,
                self.data
            )
        )
        self.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.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):
        self.set_data_value(self.get_i(index), column, value)

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

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

    @timer
    def convert(self, cls):
        new = cls(name=self.name, status=self._status)
        new.reach = self.reach
        new.begin_section = self.begin_section
        new.end_section = self.end_section

        for i, _ in enumerate(self.data):
            new.add(i)

        for i in [0, 1]:
            for j in [0, 1]:
                if self._header[i] == new.header[j]:
                    for ind, v in self.data:
                        try:
                            new._set_i_c_v(ind, j, v[i])
                        except Exception as e:
                            logger.info(e)

        self.modified()
        return new

    def move_up(self, index):
        if 0 < index < len(self):
            data = self.data
            data[index - 1], data[index] = data[index], data[index - 1]
            self.reorder(data)

    def move_down(self, index):
        if 0 <= index < len(self) - 1:
            data = self.data
            data[index], data[index + 1] = data[index + 1], data[index]
            self.reorder(data)