mambax7 / newbb

class/TopicHandler.php

<?php declare(strict_types=1);

namespace XoopsModules\Newbb;

/**
 * NewBB,  the forum module for XOOPS project
 *
 * @copyright      XOOPS Project (https://xoops.org)
 * @license        GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author         Taiwen Jiang (phppp or D.J.) <phppp@users.sourceforge.net>
 * @since          4.00
 */

use XoopsModules\Newbb\{
    Topic

This use statement conflicts with another class in this namespace, XoopsModules\Newbb\Topic. Consider defining an alias.

};
use XoopsModules\Tag\{
    Helper as TagHelper
};

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

/**
 * Class TopicHandler
 */
final class TopicHandler extends \XoopsPersistableObjectHandler
{
    /**
     * @param \XoopsDatabase|null $db
     */
    public function __construct(\XoopsDatabase $db = null)
    {
        parent::__construct($db, 'newbb_topics', Topic::class, 'topic_id', 'topic_title');
    }

    /**
     * @param mixed $id ID
     * @param null|array $fields  fields to fetch
     * @return mixed|null XoopsObject
     */
    public function get($id = null, $fields = null) //get($id, $var = null)
    {
        $var  = $fields;
        $ret  = null;

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

        $tags = $var;
        if (!empty($var) && \is_string($var)) {

The condition is_string($var) is always false.

            $tags = [$var];
        }
        if (!$topicObject = parent::get($id, $tags)) {
            return null;
        }
        $ret = $topicObject;
        if (!empty($var) && \is_string($var)) {

The condition is_string($var) is always false.

            $ret = @$topicObject->getVar($var);
        }

        return $ret;
    }

    /**
     * insert an object into the database
     *
     * @param  \XoopsObject $object {@link \XoopsObject} reference to object
     * @param  bool        $force  flag to force the query execution despite security settings
     * @return mixed       object ID
     */
    public function insert(\XoopsObject $object, $force = true)
    {
        $topic = $object;
        if (!$topic->getVar('topic_time')) {
            $topic->setVar('topic_time', \time());
        }
        if (!parent::insert($topic, $force) || !$topic->getVar('approved')) {
            return $topic->getVar('topic_id');
        }

        $newbbConfig = \newbbLoadConfig();
        if (!empty($newbbConfig['do_tag']) && \class_exists('XoopsModules\Tag\FormTag')) {
            $tagHandler = TagHelper::getInstance()->getHandler('Tag');
            if ($tagHandler) {

$tagHandler is of type XoopsModules\Tag\TagHandler, thus it always evaluated to true.

                $tagHandler->updateByItem($topic->getVar('topic_tags', 'n'), $topic->getVar('topic_id'), 'newbb');
            }
        }

        return $topic->getVar('topic_id');
    }

    /**
     * @param object|Topic $object
     * @param bool  $force
     * @return bool
     */
    public function approve(object $object, bool $force = false): bool
    {
        $topic_id = $object->getVar('topic_id');
        if ($force) {
            $sql = 'UPDATE ' . $this->db->prefix('newbb_topics') . " SET approved = -1 WHERE topic_id = {$topic_id}";
        } else {
            $sql = 'UPDATE ' . $this->db->prefix('newbb_topics') . " SET approved = 1 WHERE topic_id = {$topic_id}";
        }
        if (!$result = $this->db->queryF($sql)) {

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

            //xoops_error($this->db->error());
            return false;
        }
        $postHandler = Helper::getInstance()->getHandler('Post');
        $postsObject = $postHandler->getAll(new \Criteria('topic_id', $topic_id));
        foreach (\array_keys($postsObject) as $post_id) {
            $postHandler->approve($postsObject[$post_id]);
        }
        unset($postsObject);
        /** @var \XoopsModules\Newbb\StatsHandler $statsHandler */
        $statsHandler = Helper::getInstance()->getHandler('Stats');
        $statsHandler->update($object->getVar('forum_id'), 'topic');

        return true;
    }

    /**
     * get previous/next topic
     *
     * @param int $topic_id     current topic ID
     * @param int $action
     *                          <ul>
     *                          <li> -1: previous </li>
     *                          <li> 0: current </li>
     *                          <li> 1: next </li>
     *                          </ul>
     * @param int $forum_id     the scope for moving
     *                          <ul>
     *                          <li> >0 : inside the forum </li>
     *                          <li> <= 0: global </li>
     *                          </ul>
     * @return \XoopsObject|null
     */
    public function &getByMove(int $topic_id, int $action, int $forum_id = 0)
    {
        $topic = null;
        if (!empty($action)) {
            $sql    = 'SELECT * FROM ' . $this->table . ' WHERE 1=1' . (($forum_id > 0) ? ' AND forum_id=' . (int)$forum_id : '') . ' AND topic_id ' . (($action > 0) ? '>' : '<') . (int)$topic_id . ' ORDER BY topic_id ' . (($action > 0) ? 'ASC' : 'DESC') . ' LIMIT 1';
            $result = $this->db->query($sql);
            if ($this->db->isResultSet($result)) {
                $row = $this->db->fetchArray($result);
                if ($row) {
                    $topic = $this->create(false);
                    $topic->assignVars($row);

                    return $topic;
                }
            }
        }
        $topic = $this->get($topic_id);

        return $topic;
    }

    /**
     * @param int $post_id
     * @return null|\XoopsObject
     */
    public function &getByPost(int $post_id): ?\XoopsObject
    {
        $topic  = null;
        $sql    = 'SELECT t.* FROM ' . $this->db->prefix('newbb_topics') . ' t, ' . $this->db->prefix('newbb_posts') . ' p
                WHERE t.topic_id = p.topic_id AND p.post_id = ' . (int)$post_id;
        $result = $this->db->query($sql);
        if (!$this->db->isResultSet($result)) {
            //xoops_error($this->db->error());
            return $topic;
        }
        $row   = $this->db->fetchArray($result);
        $topic = $this->create(false);
        $topic->assignVars($row);

        return $topic;
    }

    /**
     * @param Topic  $topic
     * @param string $type
     * @return int
     */
    public function getPostCount(Topic $topic, string $type = ''): int
    {
        switch ($type) {
            case 'pending':
                $approved = 0;
                break;
            case 'deleted':
                $approved = -1;
                break;
            default:
                $approved = 1;
                break;
        }
        $criteria = new \CriteriaCompo(new \Criteria('topic_id', $topic->getVar('topic_id')));

It seems like $topic->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', $approved));
        /** @var PostHandler $postHandler */
        $postHandler = Helper::getInstance()->getHandler('Post');
        $count       = $postHandler->getCount($criteria);

        return $count;
    }

    /**
     * @param int $topic_id
     * @return null|Post
     */
    public function &getTopPost(int $topic_id): ?Post
    {
        $post = null;
        $sql  = 'SELECT p.*, t.* FROM ' . $this->db->prefix('newbb_posts') . ' p,
            ' . $this->db->prefix('newbb_posts_text') . ' t
            WHERE
            p.topic_id = ' . $topic_id . ' AND p.pid = 0
            AND t.post_id = p.post_id';

        $result = $this->db->query($sql);
        if (!$this->db->isResultSet($result)) {
            //xoops_error($this->db->error());
            return $post;
        }
        /** @var PostHandler $postHandler */
        $postHandler = Helper::getInstance()->getHandler('Post');
        $myrow       = $this->db->fetchArray($result);
        /** @var Post $post */
        $post = $postHandler->create(false);
        $post->assignVars($myrow);

        return $post;
    }

    /**
     * @param int $topic_id
     * @return bool|int
     */
    public function getTopPostId(int $topic_id)
    {
        $sql    = 'SELECT MIN(post_id) AS post_id FROM ' . $this->db->prefix('newbb_posts') . ' WHERE topic_id = ' . $topic_id . ' AND pid = 0';
        $result = $this->db->query($sql);
        if (!$this->db->isResultSet($result)) {
//            \trigger_error("Query Failed! SQL: $sql- Error: " . $xoopsDB->error(), E_USER_ERROR);
            //xoops_error($this->db->error());
            return false;
        }
        [$post_id] = $this->db->fetchRow($result);

        return $post_id;
    }

    //Added by BigKev to get the next unread post ID based on the $lastreadpost_id
    /**
     * @param int $topic_id
     * @param int $lastreadpost_id
     * @return false|mixed
     */
    public function getNextPostId(int $topic_id, int $lastreadpost_id)
    {
        $sql    = 'SELECT MIN(post_id) AS post_id FROM ' . $this->db->prefix('newbb_posts') . ' WHERE topic_id = ' . $topic_id . ' AND post_id > ' . $lastreadpost_id . ' ORDER BY post_id LIMIT 1';
        $result = $this->db->query($sql);
        if (!$this->db->isResultSet($result)) {
            //            \trigger_error("Query Failed! SQL: $sql- Error: " . $xoopsDB->error(), E_USER_ERROR);
            //xoops_error($this->db->error());
            return false;
        }
        [$post_id] = $this->db->fetchRow($result);

        return $post_id;
    }

    /**
     * @param Topic  $topic
     * @param string $order
     * @param int    $perpage
     * @param int    $start
     * @param int    $post_id
     * @param string $type
     * @return array
     */
    public function &getAllPosts(Topic $topic, string $order = 'ASC', int $perpage = 10, int &$start = 0, int $post_id = 0, string $type = ''): array
    {
        $ret     = [];
        $perpage = ((int)$perpage > 0) ? (int)$perpage : (empty($GLOBALS['xoopsModuleConfig']['posts_per_page']) ? 10 : $GLOBALS['xoopsModuleConfig']['posts_per_page']);
        $start   = (int)$start;
        switch ($type) {
            case 'pending':
                $approveCriteria = ' AND p.approved = 0';
                break;
            case 'deleted':
                $approveCriteria = ' AND p.approved = -1';
                break;
            default:
                $approveCriteria = ' AND p.approved = 1';
                break;
        }

        if ($post_id) {
            if ('DESC' === $order) {
                $operator_for_position = '>';
            } else {
                $order                 = 'ASC';
                $operator_for_position = '<';
            }
            //$approveCriteria = ' AND approved = 1'; // any others?
            $sql    = 'SELECT COUNT(*) FROM ' . $this->db->prefix('newbb_posts') . ' AS p WHERE p.topic_id=' . (int)$topic->getVar('topic_id') . $approveCriteria . " AND p.post_id $operator_for_position $post_id";
            $result = $this->db->query($sql);
            if (!$this->db->isResultSet($result)) {
                //            \trigger_error("Query Failed! SQL: $sql- Error: " . $xoopsDB->error(), E_USER_ERROR);
                //xoops_error($this->db->error());
                return $ret;
            }
            [$position] = $this->db->fetchRow($result);
            $start = (int)($position / $perpage) * $perpage;
        }

        $sql    = 'SELECT p.*, t.* FROM ' . $this->db->prefix('newbb_posts') . ' p, ' . $this->db->prefix('newbb_posts_text') . ' t WHERE p.topic_id=' . $topic->getVar('topic_id') . ' AND p.post_id = t.post_id' . $approveCriteria . " ORDER BY p.post_id $order";
        $result = $this->db->query($sql, $perpage, $start);
        if (!$this->db->isResultSet($result)) {
            //xoops_error($this->db->error());
            return $ret;
        }
        $postHandler = Helper::getInstance()->getHandler('Post');
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $post = $postHandler->create(false);
            $post->assignVars($myrow);
            $ret[$myrow['post_id']] = $post;
            unset($post);
        }

        return $ret;
    }

    /**
     * @param array $postArray
     * @param int   $pid
     * @return mixed
     */
    public function &getPostTree(array $postArray, int $pid = 0)
    {
        $postsArray = null;
        //        require_once $GLOBALS['xoops']->path('modules/newbb/class/Tree.php');
        $newbbTree = new Tree('newbb_posts');
        $newbbTree->setPrefix('&nbsp;&nbsp;');
        $newbbTree->setPostArray($postArray);
        $newbbTree->getPostTree($postsArray, $pid);

        return $postsArray;
    }

    /**
     * @param Topic $topic
     * @param array $postArray
     * @return array
     */
    public function showTreeItem(Topic $topic, array &$postArray): array
    {
        global $viewtopic_users, $myts;

        $postArray['post_time'] = \newbbFormatTimestamp($postArray['post_time']);

        if (!empty($postArray['icon'])) {
            $postArray['icon'] = '<img src="' . XOOPS_URL . '/images/subject/' . \htmlspecialchars((string)$postArray['icon'], \ENT_QUOTES | \ENT_HTML5) . '" alt="" >';
        } else {
            $postArray['icon'] = '<a name="' . $postArray['post_id'] . '"><img src="' . XOOPS_URL . '/images/icons/no_posticon.gif" alt="" ></a>';
        }

        $postArray['subject'] = '<a href="viewtopic.php?viewmode=thread&amp;topic_id=' . $topic->getVar('topic_id') . '&amp;forum=' . $postArray['forum_id'] . '&amp;post_id=' . $postArray['post_id'] . '">' . $postArray['subject'] . '</a>';

        $isActiveUser = false;

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

        if (isset($viewtopic_users[$postArray['uid']]['name'])) {
            $postArray['poster'] = $viewtopic_users[$postArray['uid']]['name'];
            if ($postArray['uid'] > 0) {
                $postArray['poster'] = '<a href="' . XOOPS_URL . '/userinfo.php?uid=' . $postArray['uid'] . '">' . $viewtopic_users[$postArray['uid']]['name'] . '</a>';
            }
        } else {
            $postArray['poster'] = empty($postArray['poster_name']) ? \htmlspecialchars((string)$GLOBALS['xoopsConfig']['anonymous'], \ENT_QUOTES | \ENT_HTML5) : $postArray['poster_name'];
        }

        return $postArray;
    }

    /**
     * @param Topic $topic
     * @param bool  $isApproved
     * @return array
     */
    public function getAllPosters(Topic $topic, bool $isApproved = true): array
    {
        $ret = [];
        $sql = 'SELECT DISTINCT uid FROM ' . $this->db->prefix('newbb_posts') . '  WHERE topic_id=' . $topic->getVar('topic_id') . ' AND uid>0';
        if ($isApproved) {
            $sql .= ' AND approved = 1';
        }
        $result = $this->db->query($sql);
        if ($this->db->isResultSet($result)) {
            while (false !== ($myrow = $this->db->fetchArray($result))) {
                $ret[] = $myrow['uid'];
            }
        }

        return $ret;
    }

    /**
     * @param \XoopsObject $object Topic
     * @param bool               $force
     * @return bool
     */
    public function delete(\XoopsObject $object, $force = true): bool
    {
        $topic = $object;
        $topicId = \is_object($topic) ? $topic->getVar('topic_id') : (int)$topic;
        if (empty($topicId)) {
            return false;
        }
        $postObject = $this->getTopPost($topicId);
        /** @var PostHandler $postHandler */
        $postHandler = Helper::getInstance()->getHandler('Post');
        $postHandler->myDelete($postObject, false, $force);

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

        $newbbConfig = \newbbLoadConfig();
        /** @var \XoopsModules\Tag\TagHandler $tagHandler */
        if (!empty($newbbConfig['do_tag']) && \class_exists('TagFormTag') && $tagHandler = TagHelper::getInstance()->getHandler('Tag')) { //@xoops_getModuleHandler('tag', 'tag', true)) {
            $tagHandler->updateByItem([], $topicId, 'newbb');
        }

        return true;
    }

    // get permission
    // parameter: $type: 'post', 'view',  'reply', 'edit', 'delete', 'addpoll', 'vote', 'attach'
    // $gperm_names = "'forum_can_post', 'forum_can_view', 'forum_can_reply', 'forum_can_edit', 'forum_can_delete', 'forum_can_addpoll', 'forum_can_vote', 'forum_can_attach', 'forum_can_noapprove'";

    /**
     * @param int|Forum $forum
     * @param int|null  $topic_locked
     * @param string    $type
     * @return bool
     */
    public function getPermission($forum, ?int $topic_locked = null, string $type = 'view'): bool
    {
        $topic_locked ??= 0;
        static $_cachedTopicPerms;
        require_once \dirname(__DIR__) . '/include/functions.user.php';
        if (\newbbIsAdmin($forum)) {
            return true;
        }

        $forum_id = \is_object($forum) ? $forum->getVar('forum_id') : (int)$forum;
        if ($forum_id < 1) {
            return false;
        }

        if ($topic_locked && 'view' !== $type) {
            $permission = false;
        } else {
            /** var PermissionHandler $permHandler */
            $permHandler = Helper::getInstance()->getHandler('Permission');
            $permission  = $permHandler->getPermission('forum', $type, $forum_id);
        }

        return $permission;
    }

    /**
     * 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('topic_time', '0'), true, true);
        parent::cleanOrphan($this->db->prefix('newbb_forums'), 'forum_id');
        parent::cleanOrphan($this->db->prefix('newbb_posts'), 'topic_id');

        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', '<='));
        $crit_expire->add(new \Criteria('topic_time', \time() - (int)$expire, '<'));

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

    // START irmtfan - rewrite topic synchronization function. add pid sync and remove hard-code db access
    /**
     * @param mixed $object
     * @param bool                         $force
     * @return bool
     */
    public function synchronization($object = null, bool $force = true): bool
    {
        if (!\is_object($object)) {
            $object = $this->get((int)$object);
        }
        if (!\is_object($object) || !$object->getVar('topic_id')) {
            return false;
        }

        /** @var PostHandler $postHandler */
        $postHandler = Helper::getInstance()->getHandler('Post');
        $criteria    = new \CriteriaCompo();
        $criteria->add(new \Criteria('topic_id', (string)$object->getVar('topic_id')), 'AND');
        $criteria->add(new \Criteria('approved', '1'), 'AND');
        $post_ids = $postHandler->getIds($criteria);
        if (empty($post_ids)) {
            return false;
        }
        $last_post     = \max($post_ids);
        $top_post      = \min($post_ids);
        $topic_replies = (is_countable($post_ids) ? \count($post_ids) : 0) - 1;
        if ($object->getVar('topic_last_post_id') != $last_post) {
            $object->setVar('topic_last_post_id', $last_post);
        }
        if ($object->getVar('topic_replies') != $topic_replies) {
            $object->setVar('topic_replies', $topic_replies);
        }
        $b1 = $this->insert($object, $force);
        $criteria->add(new \Criteria('post_id', $top_post, '<>'), 'AND');
        $criteria->add(new \Criteria('pid', '(' . \implode(', ', $post_ids) . ')', 'NOT IN'), 'AND');
        $b2       = $postHandler->updateAll('pid', $top_post, $criteria, $force);
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('post_id', $top_post, '='), 'AND');
        $b3 = $postHandler->updateAll('pid', 0, $criteria, $force);

        return ($b1 && $b2 && $b3);
    }

    // END irmtfan - rewrite topic synchronization function. add pid sync and remove hard-code db access
    // START irmtfan getActivePolls

    /**
     * get all active poll modules in the current xoops installtion.
     * @return array $pollDirs = array($dirname1=>$dirname1, $dirname2=>$dirname2, ...) dirnames of all active poll modules
     */
    public function getActivePolls(): array
    {
        $pollDirs = [];
        $allDirs  = \xoops_getActiveModules();
        foreach ($allDirs as $dirname) {
            // pollresults.php file is exist in all xoopspoll versions and umfrage versions
            if (\file_exists($GLOBALS['xoops']->path('modules/' . $dirname . '/pollresults.php'))) {
                $pollDirs[$dirname] = $dirname;
            }
        }

        return $pollDirs;
    }

    // END irmtfan getActivePolls

    // START irmtfan findPollModule

    /**
     * find poll module that is in used in the current newbb installtion.
     * @param array $pollDirs  dirnames of all active poll modules
     * @return bool|string | true | false
     *                         $dir_def: dirname of poll module that is in used in the current newbb installtion.
     *                         true: no poll module is installed | newbb has no topic with poll | newbb has no topic
     *                         false: errors (see below xoops_errors)
     */
    public function findPollModule(array $pollDirs = [])
    {
        $dir_def = '';
        if (empty($pollDirs)) {
            $pollDirs = $this->getActivePolls();
        }
        if (empty($pollDirs)) {
            return true;
        }
        // if only one active poll module still we need to check!!!
        //if(count($pollDirs) === 1) return end($pollDirs);
        $topicPollObjs = $this->getAll(new \Criteria('topic_haspoll', '1'), ['topic_id', 'poll_id']);
        if (empty($topicPollObjs)) {
            return true;
        } // no poll or no topic!!!
        foreach ($topicPollObjs as $tObj) {
            $poll_idInMod = 0;
            foreach ($pollDirs as $dirname) {
                $pollObj = $tObj->getPoll($tObj->getVar('poll_id'), $dirname);
                if (\is_object($pollObj) && ($pollObj->getVar('poll_id') == $tObj->getVar('poll_id'))) {
                    ++$poll_idInMod;
                    $dir_def = $dirname;
                }
            }
            // Only one poll module should has this poll_id
            // if 0 there is an error
            if (0 == $poll_idInMod) {
                \xoops_error("Error: Cannot find poll module for poll_id='{$tObj->getVar('poll_id')}'");

                return false;
            }
            // if 1 => $dir_def is correct
            if (1 == $poll_idInMod) {
                return $dir_def;
            }
            // if more than 1 continue
        }
        // if there is some topics but no module or more than one module have polls
        \xoops_error(\_MD_NEWBB_ERROR_POLL_MODULE_NOT_FOUND);

        return false;
    }
    // END irmtfan findPollModule
}