mambax7 / newbb

include/search.inc.php

<?php declare(strict_types=1);

/**
 * 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>, irmtfan <irmtfan@users.sourceforge.net>
 * @since          4.3
 */

use XoopsModules\Newbb\{
    Helper,
    ForumHandler,
    Post,
    PostHandler
};

/** @var Helper $helper */
/** @var ForumHandler $forumHandler */
/** @var PostHandler $postHandler */
/** @var Post $post */

// completely rewrite by irmtfan - remove hardcode database access, solve order issues, add post_text & topic_id, add highlight and reduce queries

require_once $GLOBALS['xoops']->path('modules/newbb/include/functions.ini.php');

/**
 * @param array               $queryarray
 * @param string              $andor
 * @param int                 $limit
 * @param int                 $offset
 * @param int                 $userid
 * @param int|string|mixed[]  $forums
 * @param int|string          $sortby
 * @param string              $searchin
 * @param \CriteriaCompo|null $criteriaExtra
 *
 * @return (mixed|string)[][]
 *
 * @psalm-return array<0|positive-int, array{topic_id: mixed, link: string, title: mixed, time: mixed, forum_name: string, forum_link: string, post_text: mixed, uid: mixed, poster: mixed|string}>
 */
function newbb_search(
    array $queryarray,
    string $andor,
    int $limit,
    int $offset,
    int $userid,
    $forums = 0,
    $sortby = 0,
    string $searchin = 'both',
    \CriteriaCompo $criteriaExtra = null
): array {
    $criteriaPermissions = null;
    global $myts, $xoopsDB;
    // irmtfan - in XOOPSCORE/search.php $GLOBALS['xoopsModuleConfig'] is not set
    if (!isset($GLOBALS['xoopsModuleConfig'])) {
        $GLOBALS['xoopsModuleConfig'] = newbbLoadConfig();
    }
    // irmtfan - in XOOPSCORE/search.php $xoopsModule is not set
    if (!is_object($GLOBALS['xoopsModule']) && is_object($GLOBALS['module'])
        && 'newbb' === $GLOBALS['module']->getVar('dirname')) {
        $GLOBALS['xoopsModule'] = $GLOBALS['module'];
    }

    $forumHandler = Helper::getInstance()->getHandler('Forum');
    $validForums  = $forumHandler->getIdsByValues($forums); // can we use view permission? $forumHandler->getIdsByValues($forums, "view")

It seems like $forums can also be of type string; however, parameter $values of XoopsModules\Newbb\ForumHandler::getIdsByValues() does only seem to accept XoopsModules\Newbb\text|array|integer, maybe add an additional type check?

    $criteriaPost = new \CriteriaCompo();
    $criteriaPost->add(new \Criteria('p.approved', 1), 'AND'); // only active posts

    $forum_list = []; // get forum lists just for forum names
    if ((is_countable($validForums) ? count($validForums) : 0) > 0) {
        $criteriaPermissions = new \CriteriaCompo();
        $criteriaPermissions->add(new \Criteria('p.forum_id', '(' . implode(',', $validForums) . ')', 'IN'), 'AND');
        $forum_list = $forumHandler->getAll(new \Criteria('forum_id', '(' . implode(', ', $validForums) . ')', 'IN'), ['forum_name'], false);
    }

    if (is_numeric($userid) && 0 !== $userid) {
        $criteriaUser = new \CriteriaCompo();
        $criteriaUser->add(new \Criteria('p.uid', $userid), 'OR');
    } elseif ($userid && is_array($userid)) {
        $userid       = array_map('\intval', $userid);
        $criteriaUser = new \CriteriaCompo();
        $criteriaUser->add(new \Criteria('p.uid', '(' . implode(',', $userid) . ')', 'IN'), 'OR');
    }

    $count = 0;
    if (is_array($queryarray)) {

The condition is_array($queryarray) is always true.

        $count = count($queryarray);
    }
    $highlightKey = '';
    if ($count > 0) {
        $criteriaKeywords = new \CriteriaCompo();
        foreach ($queryarray as $queryTerm) {
            $termCriteria  = new \CriteriaCompo();
            $queryTermLike = '%' . $xoopsDB->escape($queryTerm) . '%';
            if ('title' === $searchin || 'both' === $searchin) {
                $termCriteria->add(new \Criteria('p.subject', $queryTermLike, 'LIKE'), 'OR');
            }
            if ('text' === $searchin || 'both' === $searchin) {
                $termCriteria->add(new \Criteria('t.post_text', $queryTermLike, 'LIKE'), 'OR');
            }
            $criteriaKeywords->add($termCriteria, $andor);
        }
        // add highlight keywords to post links
        $highlightKey = '&keywords=' . implode(' ', $queryarray);
        $highlightKey = str_replace(' ', '+', $highlightKey);
    }
    $criteria = new \CriteriaCompo();
    $criteria->add($criteriaPost, 'AND');
    if (null !== $criteriaPermissions) {
        $criteria->add($criteriaPermissions, 'AND');
    }
    if (isset($criteriaUser)) {
        $criteria->add($criteriaUser, 'AND');
    }
    if (isset($criteriaKeywords)) {
        $criteria->add($criteriaKeywords, 'AND');
    }
    if (isset($criteriaExtra)) {
        $criteria->add($criteriaExtra, 'AND');
    }
    //$criteria->setLimit($limit); // no need for this
    //$criteria->setStart($offset); // no need for this

    if (empty($sortby)) {
        $sortby = 'p.post_time';
    }
    $criteria->setSort($sortby);
    $order = 'ASC';
    if ('p.post_time' === $sortby) {
        $order = 'DESC';
    }
    $criteria->setOrder($order);

    $postHandler = Helper::getInstance()->getHandler('Post');
    $posts       = $postHandler->getPostsByLimit($criteria, $limit, $offset);

    $ret = [];
    $i   = 0;
    foreach (array_keys($posts) as $id) {
        $post                  = $posts[$id];
        $post_data             = $post->getPostBody();
        $ret[$i]['topic_id']   = $post->getVar('topic_id');
        $ret[$i]['link']       = XOOPS_URL . '/modules/newbb/viewtopic.php?post_id=' . $post->getVar('post_id') . $highlightKey; // add highlight key
        $ret[$i]['title']      = $post_data['subject'];
        $ret[$i]['time']       = $post_data['date'];
        $ret[$i]['forum_name'] = htmlspecialchars((string)$forum_list[$post->getVar('forum_id')]['forum_name'], ENT_QUOTES | ENT_HTML5);
        $ret[$i]['forum_link'] = XOOPS_URL . '/modules/newbb/viewforum.php?forum=' . $post->getVar('forum_id');
        $ret[$i]['post_text']  = $post_data['text'];
        $ret[$i]['uid']        = $post->getVar('uid');
        $ret[$i]['poster']     = $post->getVar('uid') ? '<a href="' . XOOPS_URL . '/userinfo.php?uid=' . $ret[$i]['uid'] . '">' . $post_data['author'] . '</a>' : $post_data['author'];
        ++$i;
    }

    return $ret;
}