Pamhyr2/src/Model/HydraulicStructures/HydraulicStructures.py

# HydraulicStructures.py -- Pamhyr
# Copyright (C) 2023  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

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

from Model.HydraulicStructures.Basic.HydraulicStructures import BasicHS
from Model.HydraulicStructures.Basic.Types import (
    NotDefined,
)

logger = logging.getLogger()

class HydraulicStructure(SQLSubModel):
    _sub_classes = [
        BasicHS,
    ]
    _id_cnt = 0

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

        self._status = status

        if id == -1:
            self.id = HydraulicStructure._id_cnt
        else:
            self.id = id

        self._name = name
        self._input_kp = None
        self._output_kp = None
        self._input_reach = None
        self._output_reach = None
        self._enabled = True
        self._data = []

        HydraulicStructure._id_cnt = max(HydraulicStructure._id_cnt + 1, self.id)

    @classmethod
    def _db_create(cls, execute):
        execute("""
          CREATE TABLE hydraulic_structures(
            id INTEGER NOT NULL PRIMARY KEY,
            name TEXT NOT NULL,
            enabled BOOLEAN NOT NULL,
            input_kp REAL NOT NULL,
            output_kp REAL NOT NULL,
            input_reach INTEGER,
            output_reach INTEGER,
            FOREIGN KEY(input_reach) REFERENCES river_reach(id),
            FOREIGN KEY(output_reach) REFERENCES river_reach(id)
          )
        """)

        return cls._create_submodel(execute)

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

        return True

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

        table = execute(
            "SELECT id, name, enabled, " +
            "input_kp, output_kp, " +
            "input_reach, output_reach " +
            "FROM hydraulic_structures "
        )

        for row in table:
            it = iter(row)

            hs_id = next(it)
            name = next(it)
            enabled = (next(it) == 1)
            input_kp = next(it)
            output_kp = next(it)
            input_reach_id = next(it)
            output_reach_id = next(it)

            hs = cls(
                id=hs_id,
                name=name,
                status=data['status']
            )

            hs.enabled = enabled
            hs.input_kp = input_kp
            hs.output_kp = output_kp

            hs.input_reach, hs.output_reach = reduce(
                lambda acc, n: (
                    n if n.id == input_reach_id else acc[0],
                    n if n.id == output_reach_id else acc[1]
                ),
                data["reachs"],
                [None, None]
            )

            data['hs_id'] = hs_id
            hs._data = BasicHS._db_load(execute, data)

            new.append(hs)

        return new

    def _db_save(self, execute, data=None):
        execute(f"DELETE FROM hydraulic_structures WHERE id = {self.id}")

        input_reach_id = -1
        if self._input_reach is not None:
            input_reach_id = self._input_reach.id

        output_reach_id = -1
        if self._output_reach is not None:
            output_reach_id = self._output_reach.id

        input_kp = -1
        if self.input_kp is not None:
            input_kp = self.input_kp

        output_kp = -1
        if self.output_kp is not None:
            output_kp = self.output_kp

        sql = (
            "INSERT INTO " +
            "hydraulic_structures(" +
            "  id, name, enabled, input_kp, output_kp, " +
            "  input_reach, output_reach" +
            ") " +
            "VALUES (" +
            f"{self.id}, '{self._db_format(self._name)}', " +
            f"{self._db_format(self.enabled)}, " +
            f"{input_kp}, {output_kp}, " +
            f"{input_reach_id}, {output_reach_id}" +
            ")"
        )
        execute(sql)

        data['hs_id'] = self.id
        for basic in self._data:
            basic._db_save(execute, data)

        return True

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

    @property
    def name(self):
        return self._name

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

    @property
    def input_kp(self):
        return self._input_kp

    @input_kp.setter
    def input_kp(self, input_kp):
        self._input_kp = input_kp
        self._status.modified()

    @property
    def output_kp(self):
        return self._output_kp

    @output_kp.setter
    def output_kp(self, output_kp):
        self._output_kp = output_kp
        self._status.modified()

    @property
    def enabled(self):
        return self._enabled

    @enabled.setter
    def enabled(self, enabled):
        self._enabled = enabled
        self._status.modified()

    @property
    def input_reach(self):
        return self._input_reach

    @input_reach.setter
    def input_reach(self, input_reach):
        self._input_reach = input_reach
        self._status.modified()

    @property
    def output_reach(self):
        return self._output_reach

    @output_reach.setter
    def output_reach(self, output_reach):
        self._output_reach = output_reach
        self._status.modified()

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

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

    def insert(self, index: int, value: BasicHS):
        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()