mambax7 / newbb

class/PostHandler.php

<?php declare(strict_types=1);

namespace XoopsModules\Newbb;

/*
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 *
 * 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.
 */
//  ------------------------------------------------------------------------ //
//  Author: phppp (D.J., infomax@gmail.com)                                  //
//  URL: https://xoops.org                                                    //
//  Project: Article Project                                                 //
//  ------------------------------------------------------------------------ //

\defined('NEWBB_FUNCTIONS_INI') || require $GLOBALS['xoops']->path('modules/newbb/include/functions.ini.php');

/** @var TopicHandler $topicHandler */

/**
 * Class PostHandler
 */
class PostHandler extends \XoopsPersistableObjectHandler
{
    /**
     * @param \XoopsDatabase|null $db
     */
    public function __construct(\XoopsDatabase $db = null)
    {
        parent::__construct($db, 'newbb_posts', Post::class, 'post_id', 'subject');
    }

    /**
     * @param mixed $id
     * @param array $fields fields to fetch
     * @return \XoopsObject|null
     */
    public function get($id = null,  $fields = null): ?\XoopsObject //get($id)
    {
        $id    = (int)$id;
        $post  = null;
        $sql   = 'SELECT p.*, t.* FROM ' . $this->db->prefix('newbb_posts') . ' p LEFT JOIN ' . $this->db->prefix('newbb_posts_text') . ' t ON p.post_id=t.post_id WHERE p.post_id=' . $id;
        $result = $this->db->query($sql);
        if ($this->db->isResultSet($result)) {
            $array = $this->db->fetchArray($result);
            if ($array) {
                $post = $this->create(false);
                $post->assignVars($array);
            }
        }
        return $post;
    }

    /**
     * @param int                   $limit    Max number of objects to fetch
     * @param int                   $start    Which record to start at
     * @param \CriteriaElement|null $criteria {@link \CriteriaElement} to match
     * @param null                  $fields   variables to fetch

Are you sure the doc-type for parameter $fields is correct as it would always require null to be passed?

     * @param bool                  $asObject flag indicating as object, otherwise as array
     * @param int                   $topic_id Max number of objects to fetch
     * @param int                   $approved Which record to start at
     * @return array           of objects     {@link XoopsObject}
     */
    //    public function getByLimit($topic_id, $limit, $approved = 1)

//    public function &getByLimit($limit = 0, $start = 0, CriteriaElement $criteria = null, $fields = null, $asObject = true)
    public function &getByLimit(
         $limit = 0,
         $start = 0,
        \CriteriaElement $criteria = null,
         $fields = null,
         $asObject = true,
        int $topic_id = 0,
        int $approved = 1
    ): array {
        $sql    = 'SELECT p.*, t.*, tp.topic_status FROM '
                  . $this->db->prefix('newbb_posts')
                  . ' p LEFT JOIN '
                  . $this->db->prefix('newbb_posts_text')
                  . ' t ON p.post_id=t.post_id LEFT JOIN '
                  . $this->db->prefix('newbb_topics')
                  . ' tp ON tp.topic_id=p.topic_id WHERE p.topic_id='
                  . $topic_id
                  . ' AND p.approved ='
                  . $approved
                  . ' ORDER BY p.post_time DESC';
        $result = $this->db->query($sql, $limit, 0);
        $ret    = [];
        if ($this->db->isResultSet($result)) {
            while (false !== ($myrow = $this->db->fetchArray($result))) {
                $post = $this->create(false);
                $post->assignVars($myrow);

                $ret[$myrow['post_id']] = $post;
                unset($post);
            }
        }

        return $ret;
    }

    /**
     * @param Post $post
     * @return array
     */
    public function getPostForPDF(Post $post): array
    {
        return $post->getPostBody();
    }

    /**
     * @param Post $post
     * @return array
     */
    public function getPostForPrint(Post $post): array
    {
        return $post->getPostBody();
    }

    /**
     * @param int|Post $post
     * @param bool     $force
     * @return bool
     */
    public function approve(&$post, bool $force = false): bool
    {
        if (empty($post)) {
            return false;
        }
        if (\is_numeric($post)) {
            $post = $this->get($post);
        }

        $wasApproved = $post->getVar('approved');
        // irmtfan approve post if the approved = 0 (pending) or -1 (deleted)
        if (empty($force) && $wasApproved > 0) {
            return true;
        }
        $post->setVar('approved', 1);
        $this->insert($post, true);

It seems like $post can also be of type null; however, parameter $object of XoopsModules\Newbb\PostHandler::insert() does only seem to accept XoopsObject, maybe add an additional type check?

        /** @var TopicHandler $topicHandler */
        $topicHandler = Helper::getInstance()->getHandler('Topic');
        $topicObject  = $topicHandler->get($post->getVar('topic_id'));
        if ($topicObject->getVar('topic_last_post_id') < $post->getVar('post_id')) {
            $topicObject->setVar('topic_last_post_id', $post->getVar('post_id'));
        }
        if ($post->isTopic()) {

The method isTopic() does not exist on XoopsObject. It seems like you code against a sub-type of XoopsObject such as Post or XoopsModules\Newbb\Post.

            $topicObject->setVar('approved', 1);
        } else {
            $topicObject->setVar('topic_replies', $topicObject->getVar('topic_replies') + 1);
        }
        $topicHandler->insert($topicObject, true);

It seems like $topicObject can also be of type null; however, parameter $object of XoopsModules\Newbb\TopicHandler::insert() does only seem to accept XoopsObject, maybe add an additional type check?

        /** @var ForumHandler $forumHandler */
        $forumHandler = Helper::getInstance()->getHandler('Forum');
        $forumObject  = $forumHandler->get($post->getVar('forum_id'));
        if ($forumObject->getVar('forum_last_post_id') < $post->getVar('post_id')) {
            $forumObject->setVar('forum_last_post_id', $post->getVar('post_id'));
        }
        $forumObject->setVar('forum_posts', $forumObject->getVar('forum_posts') + 1);
        if ($post->isTopic()) {
            $forumObject->setVar('forum_topics', $forumObject->getVar('forum_topics') + 1);
        }
        $forumHandler->insert($forumObject, true);

        // Update user stats
        if ($post->getVar('uid') > 0) {
            /** @var \XoopsMemberHandler $memberHandler */
            $memberHandler = \xoops_getHandler('member');
            $poster        = $memberHandler->getUser($post->getVar('uid'));
            if (\is_object($poster) && $post->getVar('uid') == $poster->getVar('uid')) {
                $poster->setVar('posts', $poster->getVar('posts') + 1);
                $res = $memberHandler->insertUser($poster, true);

The assignment to $res is dead and can be removed.

                unset($poster);
            }
        }

        // Update forum stats
        /** @var StatsHandler $statsHandler */
        $statsHandler = Helper::getInstance()->getHandler('Stats');
        $statsHandler->update($post->getVar('forum_id'), 'post');

It seems like $post->getVar('forum_id') can also be of type array and array; however, parameter $id of XoopsModules\Newbb\StatsHandler::update() does only seem to accept integer|string, maybe add an additional type check?

        if ($post->isTopic()) {
            $statsHandler->update($post->getVar('forum_id'), 'topic');
        }

        return true;
    }

    /**
     * @param \XoopsObject $object Post Object
     * @param bool $force
     * @return bool|int
     */
    public function insert(\XoopsObject $object, $force = true) //insert(&$object, $force = true)
    {
        /** @var Post $post */
        $post        = $object;
        $topicObject = null;
        // Set the post time
        // The time should be "publish" time. To be adjusted later
        if (!$post->getVar('post_time')) {
            $post->setVar('post_time', \time());
        }

        $topicHandler = Helper::getInstance()->getHandler('Topic');
        // Verify the topic ID
        $topic_id = $post->getVar('topic_id');
        if ($topic_id) {
            $topicObject = $topicHandler->get($topic_id);
            // Invalid topic OR the topic is no approved and the post is not top post
            if (!$topicObject//    || (!$post->isTopic() && $topicObject->getVar("approved") < 1)
            ) {
                return false;
            }
        }
        if (empty($topic_id)) {
            $post->setVar('topic_id', 0);
            $post->setVar('pid', 0);
            $post->setNew();
            $topicObject = $topicHandler->create();
        }
        $textHandler    = Helper::getInstance()->getHandler('Text');
        $post_text_vars = ['post_text', 'post_edit', 'dohtml', 'doxcode', 'dosmiley', 'doimage', 'dobr'];
        if ($post->isNew()) {
            if (!$topic_id = $post->getVar('topic_id')) {
                $topicObject->setVar('topic_title', $post->getVar('subject', 'n'));
                $topicObject->setVar('topic_poster', $post->getVar('uid'));
                $topicObject->setVar('forum_id', $post->getVar('forum_id'));
                $topicObject->setVar('topic_time', $post->getVar('post_time'));
                $topicObject->setVar('poster_name', $post->getVar('poster_name'));
                $topicObject->setVar('approved', $post->getVar('approved'));

                if (!$topic_id = $topicHandler->insert($topicObject, $force)) {

It seems like $topicObject can also be of type null; however, parameter $object of XoopsModules\Newbb\TopicHandler::insert() does only seem to accept XoopsObject, maybe add an additional type check?

                    $post->deleteAttachment();
                    $post->setErrors('insert topic error');

                    //xoops_error($topicObject->getErrors());
                    return false;
                }
                $post->setVar('topic_id', $topic_id);

                $pid = 0;

The assignment to $pid is dead and can be removed.

                $post->setVar('pid', 0);
            } elseif (!$post->getVar('pid')) {
                $pid = $topicHandler->getTopPostId($topic_id);
                $post->setVar('pid', $pid);
            }

            $textObject = $textHandler->create();
            foreach ($post_text_vars as $key) {
                $textObject->vars[$key] = $post->vars[$key];
            }
            $post->destroyVars($post_text_vars);

            //            if (!$postId = parent::insert($post, $force)) {
            //                return false;
            //            }

            if (!$postId = parent::insert($post, $force)) {
                return false;
            }
            $post->unsetNew();

            $textObject->setVar('post_id', $postId);
            if (!$textHandler->insert($textObject, $force)) {
                $this->myDelete($post);
                $post->setErrors('post text insert error');

                //xoops_error($textObject->getErrors());
                return false;
            }
            if ($post->getVar('approved') > 0) {
                $this->approve($post, true);
            }
            $post->setVar('post_id', $postId);
        } else {
            if ($post->isTopic()) {
                if ($post->getVar('subject') !== $topicObject->getVar('topic_title')) {
                    $topicObject->setVar('topic_title', $post->getVar('subject', 'n'));
                }
                if ($post->getVar('approved') !== $topicObject->getVar('approved')) {
                    $topicObject->setVar('approved', $post->getVar('approved'));
                }
                $topicObject->setDirty();
                if (!$result = $topicHandler->insert($topicObject, $force)) {

The assignment to $result is dead and can be removed.

                    $post->setErrors('update topic error');

                    //xoops_error($topicObject->getErrors());
                    return false;
                }
            }
            $textObject = $textHandler->get($post->getVar('post_id'));
            $textObject->setDirty();
            foreach ($post_text_vars as $key) {
                $textObject->vars[$key] = $post->vars[$key];
            }
            $post->destroyVars($post_text_vars);
            if (!$postId = parent::insert($post, $force)) {

The assignment to $postId is dead and can be removed.

                //xoops_error($post->getErrors());
                return false;
            }
            $post->unsetNew();

            if (!$textHandler->insert($textObject, $force)) {
                $post->setErrors('update post text error');

                //xoops_error($textObject->getErrors());
                return false;
            }
        }

        return $post->getVar('post_id');
    }

    /**
     * @param Post $post Post Object
     * @param bool $isDeleteOne
     * @param bool $force
     * @return bool
     */
    public function myDelete(Post $post, bool $isDeleteOne = true, bool $force = false): bool
    {
        if (!\is_object($post) || 0 == $post->getVar('post_id')) {
            return false;
        }

        if ($isDeleteOne) {
            if ($post->isTopic()) {
                $criteria = new \CriteriaCompo(new \Criteria('topic_id', $post->getVar('topic_id')));

It seems like $post->getVar('topic_id') can also be of type array and array; however, parameter $value of Criteria::__construct() does only seem to accept string, maybe add an additional type check?

                $criteria->add(new \Criteria('approved', 1));
                $criteria->add(new \Criteria('pid', '0', '>'));
                if ($this->getPostCount($criteria) > 0) {
                    return false;
                }
            }

            return $this->delete($post, $force);
        }
        require_once $GLOBALS['xoops']->path('class/xoopstree.php');
        $mytree = new Tree($this->db->prefix('newbb_posts'), 'post_id', 'pid');
        $arr    = $mytree->getAllChild($post->getVar('post_id'));
        // irmtfan - delete childs in a reverse order
        for ($i = (is_countable($arr) ? \count($arr) : 0) - 1; $i >= 0; $i--) {

It seems like $arr can also be of type mixed; however, parameter $value of count() does only seem to accept Countable|array, maybe add an additional type check?

            /** @var Post $childpost */
            $childpost = $this->create(false);
            $childpost->assignVars($arr[$i]);
            $this->delete($childpost, $force);
            unset($childpost);
        }
        $this->delete($post, $force);

        return true;
    }

    /**
     * @param \XoopsObject $object
     * @param bool         $force
     * @return bool
     */
    public function delete(\XoopsObject $object, $force = false): bool
    {
        global $xoopsModule;

        $post = $object;

        if (!\is_object($post) || 0 == $post->getVar('post_id')) {
            return false;
        }

        /* Set active post as deleted */
        if ($post->getVar('approved') > 0 && empty($force)) {
            $sql = 'UPDATE ' . $this->db->prefix('newbb_posts') . ' SET approved = -1 WHERE post_id = ' . $post->getVar('post_id');
            if (!$result = $this->db->queryF($sql)) {

The assignment to $result is dead and can be removed.

            }
            /* delete pending post directly */
        } else {
            $sql = \sprintf('DELETE FROM `%s` WHERE post_id = %u', $this->db->prefix('newbb_posts'), $post->getVar('post_id'));

It seems like $post->getVar('post_id') can also be of type array and array; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

            if (!$result = $this->db->queryF($sql)) {
                $post->setErrors('delete post error: ' . $sql);

                return false;
            }
            $post->deleteAttachment();

The method deleteAttachment() does not exist on XoopsObject. It seems like you code against a sub-type of XoopsObject such as Post or XoopsModules\Newbb\Post.

            $sql = \sprintf('DELETE FROM `%s` WHERE post_id = %u', $this->db->prefix('newbb_posts_text'), $post->getVar('post_id'));
            if (!$result = $this->db->queryF($sql)) {
                $post->setErrors('Could not remove post text: ' . $sql);

                return false;
            }
        }

        if ($post->isTopic()) {
            $topicHandler = Helper::getInstance()->getHandler('Topic');
            /** @var Topic $topicObject */
            $topicObject = $topicHandler->get($post->getVar('topic_id'));
            if (\is_object($topicObject) && $topicObject->getVar('approved') > 0 && empty($force)) {
                $topiccount_toupdate = 1;

The assignment to $topiccount_toupdate is dead and can be removed.

                $topicObject->setVar('approved', -1);
                $topicHandler->insert($topicObject);
                \xoops_notification_deletebyitem($xoopsModule->getVar('mid'), 'thread', $post->getVar('topic_id'));
            } else {
                if (\is_object($topicObject)) {
                    if ($topicObject->getVar('approved') > 0) {
                        \xoops_notification_deletebyitem($xoopsModule->getVar('mid'), 'thread', $post->getVar('topic_id'));
                    }

                    $poll_id = $topicObject->getVar('poll_id');
                    // START irmtfan poll_module
                    $topicObject->deletePoll($poll_id);
                    // END irmtfan poll_module
                }

                $sql = \sprintf('DELETE FROM `%s` WHERE topic_id = %u', $this->db->prefix('newbb_topics'), $post->getVar('topic_id'));
                if (!$result = $this->db->queryF($sql)) {
                    //xoops_error($this->db->error());
                }
                $sql = \sprintf('DELETE FROM `%s` WHERE topic_id = %u', $this->db->prefix('newbb_votedata'), $post->getVar('topic_id'));
                if (!$result = $this->db->queryF($sql)) {
                    //xoops_error($this->db->error());
                }
            }
        } else {
            $sql = 'UPDATE ' . $this->db->prefix('newbb_topics') . ' t
                            LEFT JOIN ' . $this->db->prefix('newbb_posts') . ' p ON p.topic_id = t.topic_id
                            SET t.topic_last_post_id = p.post_id
                            WHERE t.topic_last_post_id = ' . $post->getVar('post_id') . '
                                    AND p.post_id = (SELECT MAX(post_id) FROM ' . $this->db->prefix('newbb_posts') . ' WHERE topic_id=t.topic_id)';
            if (!$result = $this->db->queryF($sql)) {
            }
        }

        $postcount_toupdate = $post->getVar('approved');

        if ($postcount_toupdate > 0) {
            // Update user stats
            if ($post->getVar('uid') > 0) {
                /** @var \XoopsMemberHandler $memberHandler */
                $memberHandler = \xoops_getHandler('member');
                $poster        = $memberHandler->getUser($post->getVar('uid'));
                if (\is_object($poster) && $post->getVar('uid') == $poster->getVar('uid')) {
                    $poster->setVar('posts', $poster->getVar('posts') - 1);
                    $res = $memberHandler->insertUser($poster, true);

The assignment to $res is dead and can be removed.

                    unset($poster);
                }
            }
            // irmtfan - just update the pid for approved posts when the post is not topic (pid=0)
            if (!$post->isTopic()) {
                $sql = 'UPDATE ' . $this->db->prefix('newbb_posts') . ' SET pid = ' . $post->getVar('pid') . ' WHERE approved=1 AND pid=' . $post->getVar('post_id');
                if (!$result = $this->db->queryF($sql)) {
                    //xoops_error($this->db->error());
                }
            }
        }

        return true;
    }

    // START irmtfan enhance getPostCount when there is join (read_mode = 2)
    /**
     * @param \CriteriaElement|\CriteriaCompo|null $criteria
     * @param string|null                          $join
     * @return int|null
     */
    public function getPostCount(\CriteriaElement $criteria = null, string $join = null): ?int
    {
        // if not join get the count from XOOPS/class/model/stats as before
        if (empty($join)) {
            return $this->getCount($criteria);
        }

        $sql = 'SELECT COUNT(*) as count' . ' FROM ' . $this->db->prefix('newbb_posts') . ' AS p' . ' LEFT JOIN ' . $this->db->prefix('newbb_posts_text') . ' AS t ON t.post_id = p.post_id';
        // LEFT JOIN
        $sql .= $join;
        // WHERE
         if (\is_object($criteria) && \is_subclass_of($criteria, \CriteriaElement::class)) {
            $sql .= ' ' . $criteria->renderWhere();

The method renderWhere() does not exist on CriteriaElement. Did you maybe mean render()?

        }
        $result = $this->db->query($sql);
        if (!$this->db->isResultSet($result)) {
            //xoops_error($this->db->error().'<br>'.$sql);
            return null;
        }
        $myrow = $this->db->fetchArray($result);
        $count = (int)$myrow['count'];

        return $count;
    }

    // END irmtfan enhance getPostCount when there is join (read_mode = 2)
    /*
     * TODO: combining viewtopic.php
     */
    /**
     * @param \CriteriaElement|\CriteriaCompo|null $criteria
     * @param int                                  $limit
     * @param int                                  $start
     * @param string|null                          $join
     * @return array
     */
    public function getPostsByLimit(\CriteriaElement $criteria = null, int $limit = 1, int $start = 0, ?string $join = null): array
    {
        $ret = [];
        $sql = 'SELECT p.*, t.* ' . ' FROM ' . $this->db->prefix('newbb_posts') . ' AS p' . ' LEFT JOIN ' . $this->db->prefix('newbb_posts_text') . ' AS t ON t.post_id = p.post_id';
        if (!empty($join)) {
            $sql .= $join;
        }
         if (\is_object($criteria) && \is_subclass_of($criteria, \CriteriaElement::class)) {
            $sql .= ' ' . $criteria->renderWhere();
            if ('' !== $criteria->getSort()) {
                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
            }
        }
        $result = $this->db->query($sql, $limit, $start);
        if ($this->db->isResultSet($result)) {
            while (false !== ($myrow = $this->db->fetchArray($result))) {
                $post = $this->create(false);
                $post->assignVars($myrow);
                $ret[$myrow['post_id']] = $post;
                unset($post);
            }
        }

        return $ret;
    }

    /**
     * @return bool
     */
    public function synchronization(): bool
    {
        //$this->cleanOrphan();
        return true;
    }

    /**
     * clean orphan items from database
     *
     * @param string $table_link
     * @param string $field_link
     * @param string $field_object
     * @return bool   true on success
     */
    public function cleanOrphan($table_link = '', $field_link = '', $field_object = ''): bool //cleanOrphan()
    {
        $this->deleteAll(new \Criteria('post_time', '0'), true, true);
        parent::cleanOrphan($this->db->prefix('newbb_topics'), 'topic_id');
        parent::cleanOrphan($this->db->prefix('newbb_posts_text'), 'post_id');

        $sql = 'DELETE FROM ' . $this->db->prefix('newbb_posts_text') . ' WHERE (post_id NOT IN ( SELECT DISTINCT post_id FROM ' . $this->table . ') )';
        if (!$result = $this->db->queryF($sql)) {

The assignment to $result is dead and can be removed.

            //xoops_error($this->db->error());
            return false;
        }

        return true;
    }

    /**
     * clean expired objects from database
     *
     * @param int $expire time limit for expiration
     * @return bool true on success
     */
    public function cleanExpires(int $expire = 0): bool
    {
        // irmtfan if 0 no cleanup look include/plugin.php
        if (!\func_num_args()) {
            $newbbConfig = \newbbLoadConfig();
            $expire      = isset($newbbConfig['pending_expire']) ? (int)$newbbConfig['pending_expire'] : 7;
            $expire      *= 24 * 3600; // days to seconds
        }
        if (empty($expire)) {
            return false;
        }
        $crit_expire = new \CriteriaCompo(new \Criteria('approved', '0', '<='));
        //if (!empty($expire)) {
        $crit_expire->add(new \Criteria('post_time', \time() - (int)$expire, '<'));

        //}
        return $this->deleteAll($crit_expire, true/*, true*/);
    }
}