<?php
/**
 * This file is part of FacturaScripts
 * Copyright (C) 2017-2025  Carlos Garcia Gomez     <carlos@facturascripts.com>
 * Copyright (C) 2017       Francesc Pineda Segarra <francesc.pineda.segarra@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace FacturaScripts\Core\Model;

use FacturaScripts\Core\DataSrc\EstadosDocumentos;
use FacturaScripts\Core\Template\ModelClass;
use FacturaScripts\Core\Template\ModelTrait;
use FacturaScripts\Core\Tools;
use FacturaScripts\Core\Where;

/**
 * Define los estados y atributos de los documentos de compra y venta
 * (presupuestos, pedidos, albaranes y facturas).
 *
 * Cada estado pertenece a un tipo de documento (campo `tipodoc`) y controla:
 * - si el documento es editable o queda bloqueado,
 * - si actualiza el stock de los productos (`actualizastock`: 0 ninguno,
 *   1 suma, -1 resta, 2 suma y descuenta pendientes, -2 resta y descuenta),
 * - si al aplicarse genera otro documento del tipo indicado en `generadoc`
 *   (por ejemplo, pasar de presupuesto a pedido). En ese caso el estado
 *   no es editable ni puede actualizar stock: lo hará el documento destino.
 *
 * Solo puede existir un estado predeterminado por `tipodoc`, y éste debe ser
 * editable. Los estados marcados como `bloquear` no se pueden modificar ni
 * eliminar una vez guardados.
 *
 * @author Francesc Pineda Segarra <francesc.pineda.segarra@gmail.com>
 * @author Carlos García Gómez     <carlos@facturascripts.com>
 */
class EstadoDocumento extends ModelClass
{
    use ModelTrait;

    /** Indica si el estado está disponible para su uso. @var bool */
    public $activo;

    /** Define cómo modifica el documento el stock de los productos. @var int */
    public $actualizastock;

    /** Indica si el estado queda protegido frente a modificaciones y borrado. @var bool */
    public $bloquear;

    /** Color utilizado para representar el estado. @var string */
    public $color;

    /** Indica si los documentos con este estado se pueden editar. @var bool */
    public $editable;

    /** Tipo de documento que se genera al aplicar este estado. @var string */
    public $generadoc;

    /** Icono utilizado para representar el estado. @var string */
    public $icon;

    /** Identificador único del estado de documento. @var int */
    public $idestado;

    /** Nombre del estado de documento. @var string */
    public $nombre;

    /** Indica si es el estado predeterminado para su tipo de documento. @var bool */
    public $predeterminado;

    /** Tipo de documento al que pertenece el estado. @var string */
    public $tipodoc;

    public function clear(): void
    {
        parent::clear();
        $this->activo = true;
        $this->actualizastock = 0;
        $this->bloquear = false;
        $this->editable = true;
        $this->predeterminado = false;
    }

    public function clearCache(): void
    {
        parent::clearCache();
        EstadosDocumentos::clear();
    }

    public function delete(): bool
    {
        if ($this->bloquear) {
            Tools::log()->warning('locked');
            return false;
        }

        return parent::delete();
    }

    public function icon(): string
    {
        if (!empty($this->icon)) {
            return $this->icon;
        } elseif (!empty($this->generadoc)) {
            return 'fa-solid fa-check';
        }

        return $this->editable ? 'fa-solid fa-pen' : 'fa-solid fa-lock';
    }

    public static function primaryColumn(): string
    {
        return 'idestado';
    }

    public static function tableName(): string
    {
        return 'estados_documentos';
    }

    public function test(): bool
    {
        // escapamos el html
        $this->color = Tools::noHtml($this->color);
        $this->generadoc = Tools::noHtml($this->generadoc);
        $this->icon = Tools::noHtml($this->icon);
        $this->nombre = Tools::noHtml($this->nombre);
        $this->tipodoc = Tools::noHtml($this->tipodoc);

        // Comprobamos que el nombre no esté vacío
        if (empty($this->nombre) || empty($this->tipodoc)) {
            return false;
        }

        // si no está activo, no puede ser predeterminado
        if (!$this->activo) {
            $this->predeterminado = false;
        }

        // No permitimos que un estado predeterminado sea no editable.
        if ($this->predeterminado && false === $this->editable) {
            Tools::log()->error('non-editable-default-not-allowed');
            return false;
        }

        // si genera otro documento, no puede ser editable
        if (!empty($this->generadoc)) {
            $this->editable = false;

            if (in_array($this->tipodoc, ['FacturaCliente', 'FacturaProveedor'])) {
                Tools::log()->warning('invoices-cant-generate-new-docs');
                return false;
            }

            // si genera otro documento, no puede actualizar stock (lo hará el documento destino)
            if (!empty($this->actualizastock)) {
                Tools::log()->warning('status-with-generadoc-cant-update-stock');
                return false;
            }
        }

        return parent::test();
    }

    public function url(string $type = 'auto', string $list = 'EditSettings?activetab=List'): string
    {
        return parent::url($type, $list);
    }

    protected function onChange(string $field): bool
    {
        if ($this->bloquear && $this->getOriginal('bloquear')) {
            Tools::log()->warning('locked');
            return false;
        }

        if ($field === 'predeterminado') {
            return $this->onChangePredeterminado();
        }

        return parent::onChange($field);
    }

    protected function onChangePredeterminado(): bool
    {
        if ($this->predeterminado) {
            $sql = "UPDATE " . static::tableName() . " SET predeterminado = false"
                . " WHERE predeterminado = true"
                . " AND tipodoc = " . self::db()->var2str($this->tipodoc)
                . " AND idestado != " . self::db()->var2str($this->idestado) . ";";
            return self::db()->exec($sql);
        }

        // establecemos el primer estado como predeterminado
        $where = [
            Where::eq('editable', true),
            Where::eq('tipodoc', $this->tipodoc),
        ];
        foreach ($this->all($where) as $item) {
            $sql = "UPDATE " . static::tableName() . " SET predeterminado = true"
                . " WHERE idestado = " . self::db()->var2str($item->idestado) . ";";
            return self::db()->exec($sql);
        }

        return false;
    }

    protected function onDelete(): void
    {
        if ($this->predeterminado) {
            $where = [
                Where::eq('editable', true),
                Where::eq('tipodoc', $this->tipodoc),
            ];
            foreach ($this->all($where) as $item) {
                $sql = "UPDATE " . static::tableName() . " SET predeterminado = true"
                    . " WHERE idestado = " . self::db()->var2str($item->idestado) . ";";
                self::db()->exec($sql);
                break;
            }
        }
    }

    protected function onInsert(): void
    {
        if ($this->predeterminado) {
            $sql = "UPDATE " . static::tableName() . " SET predeterminado = false"
                . " WHERE predeterminado = true"
                . " AND tipodoc = " . self::db()->var2str($this->tipodoc)
                . " AND idestado != " . self::db()->var2str($this->idestado) . ";";
            self::db()->exec($sql);
        }
    }

    protected function saveInsert(): bool
    {
        if (empty($this->idestado)) {
            /**
             * postgresql no actualiza correctamente el serial al insertar los valores desde un csv.
             * Por eso usamos esto para obtener el nuevo id manualmente.
             */
            $this->idestado = $this->newCode();
        }

        return parent::saveInsert();
    }
}
