<?php

/**
 * Kunena Component
 *
 * @package       Kunena.Framework
 * @subpackage    User
 *
 * @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\User;

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

use Exception;
use Joomla\CMS\Date\Date;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\User\User;
use Joomla\CMS\User\UserFactoryInterface;
use Joomla\Database\DatabaseDriver;
use Joomla\Database\DatabaseInterface;
use Joomla\Database\Exception\ExecutionFailureException;
use Kunena\Forum\Libraries\Date\KunenaDate;
use Kunena\Forum\Libraries\Error\KunenaError;
use Kunena\Forum\Libraries\Exception\KunenaException;
use Kunena\Forum\Libraries\Factory\KunenaFactory;
use Kunena\Forum\Libraries\Tables\KunenaUserBans;
use stdClass;

/**
 * Class \Kunena\Forum\Libraries\User\Ban
 *
 * @property    int $id
 * @property    int $userid
 * @property    string  $ip
 * @property    int $blocked
 * @property    string $expiration
 * @property    int $created_by
 * @property    string $created_time
 * @property    string  $reason_private
 * @property    string  $reason_public
 * @property    int $modified_by
 * @property    string $modified_time 
 * @property    array   $comments 
 * @property    array  $params
 * @since   Kunena 6.0
 */
class KunenaBan
{
    /**
     * @var int
     * @since   Kunena 6.0
     */
    public int $id = 0;

    /**
     * @var int
     * @since   Kunena 6.0
     */
    public int $userid = 0;

    /**
     * @var string
     * @since   Kunena 6.0
     */
    public string $ip = '';

    /**
     * @var int
     * @since   Kunena 6.0
     */
    public int $blocked = 0;

    /**
     * @var string
     * @since   Kunena 6.0
     */
    public string $expiration = '';

    /**
     * @var int
     * @since   Kunena 6.0
     */
    public int $created_by = 0;

    /**
     * @var string
     * @since   Kunena 6.0
     */
    public string $created_time = '';

    /**
     * @var string
     * @since   Kunena 6.0
     */
    public string $reason_private = '';

    /**
     * @var string
     * @since   Kunena 6.0
     */
    public string $reason_public = '';

    /**
     * @var int
     * @since   Kunena 6.0
     */
    public int $modified_by = 0;

    /**
     * @var string
     * @since   Kunena 6.0
     */
    public string $modified_time = '';

    /**
     * @var array
     * @since   Kunena 6.0
     */
    public array $comments = [];

    /**
     * @var array
     * @since   Kunena 6.0
     */
    public array $params = [];

    /**
     * @return  void
     *
     * @since   Kunena 6.0
     */
    const ANY = 0;

    /**
     * @return  void
     *
     * @since   Kunena 6.0
     */
    const ACTIVE = 1;

    /**
     * @var     array|KunenaBan[]
     * @since   Kunena 6.0
     */
    protected static $_instances = [];

    /**
     * @var     array
     * @since   Kunena 6.0
     */
    protected static $_instancesByUserid = [];

    /**
     * @var     array
     * @since   Kunena 6.0
     */
    protected static $_instancesByIP = [];

    /**
     * @var     array
     * @since   Kunena 6.0
     */
    protected static $_useridcache = [];

    /**
     * @var     Date|null
     * @since   Kunena 6.0
     */
    protected static $_now = null;

    /**
     * @var     User|null
     * @since   Kunena 6.0
     */
    protected static $_my = null;

    /**
     * @var     DatabaseDriver|null
     * @since   Kunena 6.0
     */
    protected $_db = null;

    /**
     * @var     boolean
     * @since   Kunena 6.0
     */
    protected $_exists = false;

    /**
     * Constructor
     *
     * @access  protected
     *
     * @param   null  $identifier  identifier
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function __construct($identifier = null)
    {
        if (self::$_now === null) {
            self::$_now = new Date();
        }

        if (self::$_my === null) {
            self::$_my = Factory::getApplication()->getIdentity();
        }

        // Always load the data -- if item does not exist: fill empty data
        $this->load($identifier);
        $this->_db = Factory::getContainer()->get('DatabaseDriver');
    }

    /**
     * Method to load a \Kunena\Forum\Libraries\User\Ban object by ban id
     *
     * @access          public
     *
     * @param   int  $id  The ban id of the item to load
     *
     * @return    boolean True on success
     *
     * @throws Exception
     * @since           Kunena 1.6
     */
    public function load($id): bool
    {
        // Create the user table object
        $table = $this->getTable();

        // Load the KunenaTableUser object based on the user id
        try {
            $exists = $table->load($id);
        } catch (Exception $e) {
            KunenaError::displayDatabaseError($e);
        }

        $this->bind($table->getProperties());
        $this->_exists = $exists;

        return (bool) $exists;
    }

    /**
     * Method to get the ban table object
     *
     * This function uses a static variable to store the table name of the user table to
     * it instantiates. You can call this function statically to set the table name if
     * needed.
     *
     * @access    public
     *
     * @param   string  $type    The user table name to be used
     * @param   string  $prefix  The user table prefix to be used
     *
     * @return    object  The user table object
     *
     * @since     Kunena 1.6
     */
    public function getTable($type = 'Kunena\\Forum\\Libraries\\Tables\\', $prefix = 'KunenaUserBans'): object
    {
        static $tabletype = null;

        // Set a custom table type is defined
        if ($tabletype === null || $type != $tabletype['name'] || $prefix != $tabletype['prefix']) {
            $tabletype['name']   = $type;
            $tabletype['prefix'] = $prefix;
        }

        // Create the user table object
        $db = Factory::getContainer()->get(DatabaseInterface::class);
        $tableObject = new KunenaUserBans($db);

        return $tableObject;
    }

    /**
     * @param   mixed  $data  data
     *
     * @return  void
     *
     * @since   Kunena 6.0
     */
    protected function bind($data): void
    {
        foreach ((array) $data as $property => $value) {
            if (!\is_null($value) && !\in_array($property, ['comments', 'params']))
                $this->$property = $value;
        }

        $this->comments = !empty($data['comments']) ? json_decode((string) $data['comments']) : [];
        $this->params   = !empty($data['params']) ? json_decode($data['params']) : [];
    }

    /**
     * Returns the global \Kunena\Forum\Libraries\User\Ban object, only creating it if it doesn't already exist.
     *
     * @access  public
     *
     * @param   null  $identifier  The ban object to be loaded
     *
     * @return \Kunena\Forum\Libraries\User\KunenaBan|null The ban object.
     *
     * @since   Kunena 1.6
     */
    public static function getInstance($identifier = null): ?KunenaBan
    {
        $c = __CLASS__;

        if (\intval($identifier) < 1) {
            return new $c();
        }

        if (!isset(self::$_instances[$identifier])) {
            $instance = new $c($identifier);
            self::storeInstance($instance);
        }

        return isset(self::$_instances[$identifier]) ? self::$_instances[$identifier] : null;
    }

    /**
     * @param   KunenaBan  $instance  instance
     *
     * @return  void
     *
     * @since   Kunena 6.0
     */
    private static function storeInstance(KunenaBan $instance): void
    {
        // Fill userid cache
        self::cacheUserid($instance->userid);
        self::cacheUserid($instance->created_by);
        self::cacheUserid($instance->modified_by);

        foreach ($instance->comments as $comment) {
            self::cacheUserid($comment->userid);
        }

        if ($instance->id) {
            self::$_instances[$instance->id] = $instance;
        }

        if ($instance->userid && ($instance->isEnabled() || !$instance->id)) {
            self::$_instancesByUserid[$instance->userid] = $instance;
        }

        if ($instance->ip && ($instance->isEnabled() || !$instance->id)) {
            self::$_instancesByIP[$instance->ip] = $instance;
        }
    }

    /**
     * @param   int  $userid  userid
     *
     * @return  void
     *
     * @since   Kunena 6.0
     */
    private static function cacheUserid($userid): void
    {
        if ($userid > 0) {
            self::$_useridcache[$userid] = $userid;
        }
    }

    /**
     * @return  boolean
     *
     * @since   Kunena 6.0
     */
    public function isEnabled(): bool
    {
        if ($this->isLifetime()) {
            return true;
        }

        if ($this->expiration === null) {
            return false;
        }

        $expiration = new Date($this->expiration);

        if ($expiration->toUnix() > self::$_now->toUnix()) {
            return true;
        }

        return false;
    }

    /**
     * @return  boolean
     *
     * @since   Kunena 6.0
     */
    public function isLifetime(): bool
    {
        return $this->expiration == '9999-12-31 23:59:59';
    }

    /**
     * Returns the global \Kunena\Forum\Libraries\User\Ban object, only creating it if it doesn't already exist.
     *
     * @access  public
     *
     * @param   null  $identifier  The ban object to be loaded
     * @param   bool  $create      create
     *
     * @return \Kunena\Forum\Libraries\User\KunenaBan|null The ban object.
     *
     * @since   Kunena 1.6
     */
    public static function getInstanceByUserid($identifier = null, $create = false): ?KunenaBan
    {
        $c = __CLASS__;

        if (\intval($identifier) < 1) {
            return new $c();
        }

        if (!isset(self::$_instancesByUserid[$identifier])) {
            $instance = new $c();
            $instance->loadByUserid($identifier);
            self::storeInstance($instance);
        }

        return $create || !empty(self::$_instancesByUserid[$identifier]->id) ? self::$_instancesByUserid[$identifier] : null;
    }

    /**
     * Returns the global \Kunena\Forum\Libraries\User\Ban object, only creating it if it doesn't already exist.
     *
     * @access  public
     *
     * @param   null  $identifier  The ban object to be loaded
     * @param   bool  $create      create
     *
     * @return \Kunena\Forum\Libraries\User\KunenaBan|null The ban object.
     *
     * @since   Kunena 1.6
     */
    public static function getInstanceByIP($identifier = null, $create = false): ?KunenaBan
    {
        $c = __CLASS__;

        if (empty($identifier)) {
            return new $c();
        }

        if (!isset(self::$_instancesByIP[$identifier])) {
            $instance = new $c();
            $instance->loadByIP($identifier);
            self::storeInstance($instance);
        }

        return $create || !empty(self::$_instancesByIP[$identifier]->id) ? self::$_instancesByIP[$identifier] : null;
    }

    /**
     * @param   int  $start  start
     * @param   int  $limit  limit
     *
     * @return  array
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public static function getBannedUsers($start = 0, $limit = 50): array
    {
        $c   = __CLASS__;
        $db  = Factory::getContainer()->get('DatabaseDriver');
        $now = new Date();

        $query = $db->createQuery();
        $query->select(['b.*'])
            ->from($db->quoteName('#__kunena_users_banned', 'b'))
            ->innerJoin($db->quoteName('#__users', 'u') . ' ON ' . $db->quoteName('u.id') . ' = ' . $db->quoteName('b.userid'))
            ->where($db->quoteName('b.expiration') . ' = ' . $db->quote('9999-12-31 23:59:59'))
            ->orWhere($db->quoteName('b.expiration') . ' > ' . $db->quote($now->toSql()))
            ->order($db->quoteName('b.created_time') . ' DESC');
        $query->setLimit($limit, $start);
        $db->setQuery($query);

        try {
            $results = $db->loadAssocList();
        } catch (ExecutionFailureException $e) {
            KunenaError::displayDatabaseError($e);
        }

        $list = [];

        foreach ($results as $ban) {
            $instance = new $c();
            $instance->bind($ban);
            $instance->_exists = true;
            self::storeInstance($instance);
            $list[$instance->userid] = $instance;
        }

        return $list;
    }

    /**
     * @param   int  $userid  userid
     *
     * @return  array
     *
     * @throws Exception
     * @since   Kunena 6.0
     */
    public static function getUserHistory(int $userid): array
    {
        if (!$userid) {
            return [];
        }

        $c  = __CLASS__;
        $db = Factory::getContainer()->get('DatabaseDriver');

        $query = $db->createQuery();
        $query->select('*')
            ->from($db->quoteName('#__kunena_users_banned'))
            ->where($db->quoteName('userid') . ' = ' . $db->quote($userid))
            ->order($db->quoteName('id') . ' DESC');
        $db->setQuery($query);

        try {
            $results = $db->loadAssocList();
        } catch (ExecutionFailureException $e) {
            KunenaError::displayDatabaseError($e);
        }

        $list = [];

        foreach ($results as $ban) {
            $instance = new $c();
            $instance->bind($ban);
            $instance->_exists = true;
            self::storeInstance($instance);
            $list[] = $instance;
        }

        return $list;
    }

    /**
     * @return  KunenaUser
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function getUser(): KunenaUser
    {
        return KunenaUserHelper::get((int) $this->userid);
    }

    /**
     * @return  KunenaUser
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function getCreator(): KunenaUser
    {
        return KunenaUserHelper::get((int) $this->created_by);
    }

    /**
     * @return  KunenaUser
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function getModifier(): KunenaUser
    {
        return KunenaUserHelper::get((int) $this->modified_by);
    }

    /**
     * Return ban creation date.
     *
     * @return  KunenaDate
     *
     * @since   Kunena 6.0
     */
    public function getCreationDate(): KunenaDate
    {
        return KunenaDate::getInstance($this->created_time);
    }

    /**
     * Return ban expiration date.
     *
     * @return  KunenaDate
     *
     * @since   Kunena 6.0
     */
    public function getExpirationDate(): KunenaDate
    {
        return KunenaDate::getInstance($this->expiration);
    }

    /**
     * Return ban modification date.
     *
     * @return  KunenaDate
     *
     * @since   Kunena 6.0
     */
    public function getModificationDate(): KunenaDate
    {
        return KunenaDate::getInstance($this->modified_time);
    }

    /**
     * @return  boolean
     *
     * @since   Kunena 6.0
     */
    public function exists(): bool
    {
        return $this->_exists;
    }

    /**
     * Method to load a \Kunena\Forum\Libraries\User\Ban object by user id
     *
     * @access  public
     *
     * @param   int  $userid  The user id of the user to load
     * @param   int  $mode    \Kunena\Forum\Libraries\User\Ban::ANY or \Kunena\Forum\Libraries\User\Ban::ACTIVE
     *
     * @return  boolean            True on success
     *
     * @since   Kunena 1.6
     */
    public function loadByUserid(int $userid, $mode = self::ACTIVE): bool
    {
        // Create the user table object
        $table = $this->getTable();

        // Load the KunenaTableUser object based on the user id
        $exists = $table->loadByUserid($userid, $mode);
        $this->bind($table->getProperties());
        $this->_exists = $exists;

        return $exists;
    }

    /**
     * Method to load a \Kunena\Forum\Libraries\User\Ban object by user id
     *
     * @access  public
     *
     * @param   string  $ip    ip
     * @param   int     $mode  \Kunena\Forum\Libraries\User\Ban::ANY or \Kunena\Forum\Libraries\User\Ban::ACTIVE
     *
     * @return  boolean  True on success
     *
     * @since   Kunena 1.6
     */
    public function loadByIP(string $ip, $mode = self::ACTIVE): bool
    {
        // Create the user table object
        $table = $this->getTable();

        // Load the KunenaTableUser object based on the user id
        $exists = $table->loadByIP($ip, $mode);
        $this->bind($table->getProperties());
        $this->_exists = $exists;

        return $exists;
    }

    /**
     * @param   null  $public   public
     * @param   null  $private  private
     *
     * @return  void
     *
     * @since   Kunena 6.0
     */
    public function setReason($public = null, $private = null): void
    {
        $set = false;

        if ($public !== null && $public != $this->reason_public) {
            $this->reason_public = (string) $public;
            $set                 = true;
        }

        if ($private !== null && $private != $this->reason_private) {
            $this->reason_private = (string) $private;
            $set                  = true;
        }

        if ($this->_exists && $set) {
            $this->modified_time = self::$_now->toSql();
            $this->modified_by   = self::$_my->id;
        }
    }

    /**
     * Do the ban for the specified user from site or forum
     *
     * @param   null    $userid          userid
     * @param   null    $ip              The address IP of the user
     * @param   bool    $banlevel        Set if the user from forum or from site, from forum is set to 0 and from site is set to 1
     * @param   null    $expiration      The expiration date of the ban, if no date is specified the ban is set for lifetime
     * @param   string  $reason_private  The private reason
     * @param   string  $reason_public   The public reason
     * @param   string  $comment         Set a comment for others moderators
     *
     * @return void
     * @since Kunena 1.6
     */
    public function ban($userid = null, $ip = null, $banlevel = 0, $expiration = null, $reason_private = '', $reason_public = '', $comment = ''): void
    {
        $this->userid  = \intval($userid) > 0 ? (int) $userid : null;
        $this->ip      = $ip ? (string) $ip : '';
        $this->blocked = (int) $banlevel;
        $this->setExpiration($expiration);
        $this->reason_private = (string) $reason_private;
        $this->reason_public  = (string) $reason_public;

        if (!empty($comment)) {
            $this->addComment($comment);
        }
    }

    /**
     * @param   mixed   $expiration  expiration
     * @param   string  $comment     comment
     *
     * @return  void
     *
     * @since   Kunena 6.0
     */
    public function setExpiration($expiration, $comment = ''): void
    {
        // Cannot change expiration if ban is not enabled
        if (!$this->isEnabled() && $this->id) {
            return;
        }

        if (!$expiration || $expiration == '0000-00-00 00:00:00') {
            $this->expiration = '9999-12-31 23:59:59';
        } else {
            $date             = new Date($expiration);
            $this->expiration = $date->toUnix() > self::$_now->toUnix() ? $date->toSql() : self::$_now->toSql();
        }

        if ($this->_exists) {
            $this->modified_time = self::$_now->toSql();
            $this->modified_by   = self::$_my->id;
        }

        if (!empty($comment)) {
           $this->addComment($comment);
        }
    }

    /**
     * @param   string  $comment  comment
     *
     * @return  void
     *
     * @since   Kunena 6.0
     */
    public function addComment(string $comment): void
    {
        if (\is_string($comment) && !empty($comment)) {
            $c                = new stdClass();
            $c->userid        = self::$_my->id;
            $c->time          = self::$_now->toSql();
            $c->comment       = $comment;
            $this->comments[] = $c;
        }
    }

    /**
     * @param   string  $comment  comment
     *
     * @return  void
     *
     * @since   Kunena 6.0
     */
    public function unBan($comment = ''): void
    {
        // Cannot change expiration if ban is not enabled
        if (!$this->isEnabled()) {
            return;
        }

        $this->expiration    = self::$_now->toSql();
        $this->modified_time = self::$_now->toSql();
        $this->modified_by   = self::$_my->id;

        if (!empty($comment)) {
            $this->addComment($comment);
        }
    }

    /**
     * Method to save the \Kunena\Forum\Libraries\User\Ban object to the database
     *
     * @access  public
     *
     * @param   boolean  $updateOnly  Save the object only if not a new ban
     *
     * @return  boolean True on success
     *
     * @throws  Exception
     * @since   Kunena 1.6
     */
    public function save($updateOnly = false): bool
    {
        try {
            $this->canBan();
        } catch (Exception $e) {
            throw new KunenaException($e->getMessage());
        }

        if (!$this->id) {
            // If we have new ban, add creation date and user if they do not exist
            if (!$this->created_time) {
                $now                = new Date();
                $this->created_time = $now->toSql();
            }

            if (!$this->created_by) {
                $my               = Factory::getApplication()->getIdentity();
                $this->created_by = $my->id;
            }
        }

        // Create the user table object
        $table = $this->getTable();

        $data = [
            'id'             => $this->id,
            'userid'         => $this->userid,
            'ip'             => $this->ip,
            'blocked'        => $this->blocked,
            'expiration'     => $this->expiration ?: null,
            'created_by'     => $this->created_by,
            'created_time'   => $this->created_time,
            'reason_private' => $this->reason_private,
            'reason_public'  => $this->reason_public,
            'modified_by'    => $this->modified_by,
            'modified_time'  => $this->modified_time ?: null,
            'comments'       => json_encode($this->comments),
            'params'         => json_encode($this->params),
        ];

        $table->bind($data);

        // Check and store the object.
        try {
            $table->check();
        } catch (Exception $e) {
            throw new KunenaException($e->getMessage());
        }

        // Are we creating a new ban
        $isnew = !$this->_exists;

        // If we aren't allowed to create new ban, return
        if ($isnew && $updateOnly) {
            return true;
        }

        if (!$isnew) {
            $table->exists(true);
        }

        if ($this->userid) {
            $user = Factory::getContainer()->get(UserFactoryInterface::class)->loadUserById($this->userid);

            // Change user block also in Joomla
            if (!$user) {
                throw new KunenaException("User {$this->userid} does not exist!");

                return false;
            }

            $banlevel = 0;

            if ($this->isEnabled()) {
                $banlevel = $this->blocked;

                $app = Factory::getApplication();
                $app->logout((int) $this->userid);
            }

            if ($user->block != $banlevel) {
                $user->block = $banlevel;
                $user->save();
            }

            // Change user state also in #__kunena_users
            $profile         = KunenaFactory::getUser($this->userid);
            $profile->banned = $this->expiration;
            $profile->save(true);
        }

        // Store the ban data in the database
        try {
            $result = $table->store();
        } catch (Exception $e) {
            throw new KunenaException($e->getMessage());
        }

        // Set the id for the \Kunena\Forum\Libraries\User\Ban object in case we created a new ban.
        if ($result && $isnew) {
            $this->load($table->id);
            self::storeInstance($this);
        }

        return $result;
    }

    /**
     * @return  boolean
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function canBan(): bool
    {
        $userid = $this->userid;
        $me     = KunenaUserHelper::getMyself();
        $user   = KunenaUserHelper::get($userid);

        if (!$me->isModerator()) {
            throw new KunenaException(Text::_('COM_KUNENA_MODERATION_ERROR_NOT_MODERATOR'));
        }

        if (!$user->exists()) {
            throw new KunenaException(Text::_('COM_KUNENA_LIB_USER_BAN_ERROR_NOT_USER', $userid));
        }

        if ($userid == $me->userid) {
            throw new KunenaException(Text::_('COM_KUNENA_LIB_USER_BAN_ERROR_YOURSELF'));
        }

        if ($user->isAdmin()) {
            throw new KunenaException(Text::sprintf('COM_KUNENA_LIB_USER_BAN_ERROR_ADMIN', $user->getName()));
        }

        if ($user->isModerator() && !$me->isAdmin()) {
            throw new KunenaException(Text::sprintf('COM_KUNENA_LIB_USER_BAN_ERROR_MODERATOR', $user->getName()));
        }

        return true;
    }

    /**
     * Method to delete the \Kunena\Forum\Libraries\User\Ban object from the database
     *
     * @access  public
     *
     * @return  boolean  True on success
     *
     * @since   Kunena 1.6
     */
    public function delete(): bool
    {
        // Create the user table object
        $table = $this->getTable();

        try {
            $result = $table->delete($this->id);
        } catch (Exception $e) {
            throw new KunenaException($e->getMessage());
        }

        return $result;
    }
}