<?php

/**
 * Kunena Component
 *
 * @package       Kunena.Framework
 * @subpackage    Tables
 *
 * @copyright     Copyright (C) 2008 - @currentyear@ Kunena Team. All rights reserved.
 * @license       https://www.gnu.org/copyleft/gpl.html GNU/GPL
 * @link          https://www.kunena.org
 **/

namespace Kunena\Forum\Libraries\Tables;

\defined('_JEXEC') or die();

use Exception;
use Joomla\CMS\Language\Text;
use Joomla\Database\DatabaseDriver;
use Joomla\Database\Exception\ExecutionFailureException;
use Joomla\Registry\Registry;
use Kunena\Forum\Libraries\Error\KunenaError;
use RuntimeException;
use UnexpectedValueException;

/**
 * Kunena Categories
 * Provides access to the #__kunena_categories table
 *
 * @since   Kunena 6.0
 */
class TableKunenaCategories extends KunenaTable
{
    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $id = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $parentid = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $name = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $alias = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $icon = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $icon_id = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $locked = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $accesstype = null;

    /**
     * @var     integer
     * @since   Kunena 6.0
     */
    public int $access;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $pubAccess = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $pubRecurse = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $adminAccess = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $adminRecurse = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $ordering = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $published = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $channels = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $checked_out = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $checked_out_time = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $review = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $allowAnonymous = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $postAnonymous = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $hits = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $description = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $headerdesc = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $class_sfx = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $allowPolls = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $topicOrdering = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $iconset = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $numTopics = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $numPosts = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $last_topic_id = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $last_post_id = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $last_post_time = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $params = null;

    /**
     * @var     null
     * @since   Kunena 5.1.0
     */
    public $topictemplate = null;

    /**
     * @param   DatabaseDriver  $db  Database driver
     *
     * @since   Kunena 6.0
     */
    public function __construct($db)
    {
        parent::__construct('#__kunena_categories', 'id', $db);
    }

    /**
     * @param   null  $id     id
     * @param   bool  $reset  reset
     *
     * @return  boolean
     *
     * @since   Kunena 6.0
     *
     * @throws  Exception
     */
    public function load($id = null, $reset = true): bool
    {
        $this->_exists = false;
        $k             = $this->_tbl_key;

        // Get the id to load.
        if ($id !== null) {
            $this->$k = $id;
        }

        // Reset the table.
        if ($reset) {
            $this->reset();
        }

        // Check for a valid id to load.
        if ($this->$k === null || \intval($this->$k) < 1) {
            $this->$k = 0;

            return false;
        }

        // Load the data.
        $query = $this->_db->createQuery()
            ->select('*')
            ->from($this->_db->quoteName('#__kunena_categories'))
            ->where($this->_db->quoteName('id') . ' = ' . $this->_db->quote($this->$k));
        $this->_db->setQuery($query);

        try {
            $data = $this->_db->loadAssoc();
        } catch (ExecutionFailureException $e) {
            KunenaError::displayDatabaseError($e);

            return false;
        }

        if (!$data) {
            $this->$k = 0;

            return false;
        }

        $this->_exists = true;

        // Bind the data to the table.
        $this->bind($data);

        return $this->_exists;
    }

    /**
     * @param   mixed   $array   array
     * @param   string  $ignore  ignore
     *
     * @return  boolean
     *
     * @since   Kunena 6.0
     */
    public function bind($array, $ignore = ''): bool
    {
        if (\is_object($array)) {
            $array = get_object_vars($array);
        }

        if (isset($array['params']) && !\is_string($array['params'])) {
            if ($array['params'] instanceof Registry) {
                $registry = $array['params'];
            } elseif (\is_array($array['params'])) {
                $registry = new Registry();
                $registry->loadArray($array['params']);
            } else {
                $registry = new Registry();
            }

            $array['params'] = (string) $registry;
        }

        return parent::bind($array, $ignore);
    }

    /**
     * @return  boolean
     *
     * @since   Kunena 6.0
     *
     * @throws  Exception
     */
    public function check(): bool
    {
        if ($this->id && $this->parentid) {
            if ($this->id == $this->parentid) {
                throw new RuntimeException(Text::_('COM_KUNENA_FORUM_SAME_ERR'));
            }

            if ($this->isChild($this->parentid)) {
                throw new RuntimeException(Text::_('COM_KUNENA_FORUM_OWNCHILD_ERR'));
            }
        }

        $this->name = trim($this->name);

        if (!$this->name) {
            throw new UnexpectedValueException(Text::_('COM_KUNENA_LIB_TABLE_CATEGORIES_ERROR_NO_NAME'));
        }

        if ($this->params instanceof Registry) {
            $this->params = $this->params->toString();
        }

        return true;
    }

    // Check if given forum is one of its own childs

    /**
     * @param   integer  $id  id
     *
     * @return  false|integer
     *
     * @since   Kunena 6.0
     *
     * @throws Exception
     */
    public function isChild($id)
    {
        // FIXME: when we have category cache, replace this code
        if ($id > 0) {
            $query = $this->_db->createQuery()
                ->select(['id', 'parentid'])
                ->from($this->_db->quoteName('#__kunena_categories'));
            $this->_db->setQuery($query);

            try {
                $list = $this->_db->loadObjectList('id');
            } catch (ExecutionFailureException $e) {
                KunenaError::displayDatabaseError($e);

                return false;
            }

            $recurse = [];

            while ($id) {
                if (\in_array($id, $recurse)) {
                    throw new Exception(\get_class($this) . Text::_('COM_KUNENA_RECURSION'));

                    return 0;
                }

                $recurse[] = $id;

                if (!isset($list[$id])) {
                    throw new Exception(\get_class($this) . Text::_('COM_KUNENA_LIB_TABLE_CATEGORIES_ERROR_INVALID'));

                    return 0;
                }

                $id = $list[$id]->parentid;

                if ($id != 0 && $id == $this->id) {
                    return 1;
                }
            }
        }

        return 0;
    }

    /**
     * @param   string  $where  where
     *
     * @return bool
     *
     * @since   Kunena 6.0
     */
    public function reOrder($where = ''): bool
    {
        if (!$where) {
            $query = $this->_db->createQuery()
                ->select($this->_db->quoteName('parentid'))
                ->from($this->_db->quoteName('#__kunena_categories'))
                ->group($this->_db->quoteName('parentid'));
            $this->_db->setQuery($query);

            $parents = $this->_db->loadColumn();
            $success = true;

            foreach ($parents as $parentid) {
                $success &= parent::reOrder("parentid={$this->_db->quote($parentid)}");
            }

            return $success;
        }

        return parent::reOrder($where);
    }

    /**
     * @param   bool  $updateNulls  update
     *
     * @return  boolean
     *
     * @since   Kunena 6.0
     *
     * @throws  Exception
     */
    public function store($updateNulls = false): bool
    {
        return parent::store($updateNulls);
    }
}