commentrenderer.php

<?php
 
 
class XoopsCommentRenderer
{

    public $_tpl;
    public $_comments = null;
    public $_useIcons = true;
    public $_doIconCheck = false;
    public $_memberHandler;
    public $_statusText;

    public function __construct(&$tpl, $use_icons = true, $do_iconcheck = false)
    {
        $this->_tpl =& $tpl;
        $this->_useIcons = $use_icons;
        $this->_doIconCheck = $do_iconcheck;
        $this->_memberHandler =& xoops_gethandler('member');
        $this->_statusText = [XOOPS_COMMENT_PENDING => '<span style="text-decoration: none; font-weight: bold; color: #00ff00;">' . _CM_PENDING . '</span>', XOOPS_COMMENT_ACTIVE => '<span style="text-decoration: none; font-weight: bold; color: #ff0000;">' . _CM_ACTIVE . '</span>', XOOPS_COMMENT_HIDDEN => '<span style="text-decoration: none; font-weight: bold; color: #0000ff;">' . _CM_HIDDEN . '</span>'];
    }

    public function &instance(&$tpl, $use_icons = true, $do_iconcheck = false)
    {
        static $instance;
        if (!isset($instance)) {
            $instance = new XoopsCommentRenderer($tpl, $use_icons, $do_iconcheck);
        }
        return $instance;
    }

    public function setComments(&$comments_arr)
    {
        if (isset($this->_comments)) {
            unset($this->_comments);
        }
        $this->_comments =& $comments_arr;
    }

    public function renderFlatView($admin_view = false)
    {
        foreach ($this->_comments as $iValue) {
            if (false !== $this->_useIcons) {
                $title = $this->_getTitleIcon($iValue->getVar('com_icon')).'&nbsp;'. $iValue->getVar('com_title');
            } else {
                $title = $iValue->getVar('com_title');
            }
            $poster = $this->_getPosterArray($iValue->getVar('com_uid'));
            if (false !== $admin_view) {
                $text = $iValue->getVar('com_text')
                    .'<div style="text-align:right; margin-top: 2px; margin-bottom: 0px; margin-right: 2px;">'
                    ._CM_STATUS.': '.$this->_statusText[$iValue->getVar('com_status')].'<br>IP: <span style="font-weight: bold;">'
                    . $iValue->getVar('com_ip').'</span></div>';
            } else if (XOOPS_COMMENT_ACTIVE !== $iValue->getVar('com_status')) {
                continue;
            } else {
                $text = $iValue->getVar('com_text');
            }
            $this->_tpl->append('comments',
                [
                    'id' => $iValue->getVar('com_id'),
                    'title' => $title,
                    'text' => $text,
                    'date_posted' => formatTimestamp($iValue->getVar('com_created'), 'm'),
                    'date_modified' => formatTimestamp($iValue->getVar('com_modified'), 'm'),
                    'poster' => $poster
                ]
            );
        }
    }

    public function renderThreadView(int $comment_id = 0, bool $admin_view, bool $show_nav = true)
    {
        include_once XOOPS_ROOT_PATH.'/class/tree.php';
        // construct comment tree
        $xot = new XoopsObjectTree($this->_comments, 'com_id', 'com_pid', 'com_rootid');
        $tree =& $xot->getTree();
 
        if (false !== $this->_useIcons) {
            $title = $this->_getTitleIcon($tree[$comment_id]['obj']->getVar('com_icon')).'&nbsp;'.$tree[$comment_id]['obj']->getVar('com_title');
        } else {
            $title = $tree[$comment_id]['obj']->getVar('com_title');
        }
        if (false !== $show_nav && 0 !== $tree[$comment_id]['obj']->getVar('com_pid')) {
            $this->_tpl->assign('lang_top', _CM_TOP);
            $this->_tpl->assign('lang_parent', _CM_PARENT);
            $this->_tpl->assign('show_threadnav', true);
        } else {
            $this->_tpl->assign('show_threadnav', false);
        }
        if (false !== $admin_view) {
            // admins can see all
            $text = $tree[$comment_id]['obj']->getVar('com_text')
                .'<div style="text-align:right; margin-top: 2px; margin-bottom: 0px; margin-right: 2px;">'
                ._CM_STATUS.': '
                .$this->_statusText[$tree[$comment_id]['obj']->getVar('com_status')]
                .'<br>IP: <span style="font-weight: bold;">'
                .$tree[$comment_id]['obj']->getVar('com_ip').'</span></div>';
        } else if (XOOPS_COMMENT_ACTIVE !== $tree[$comment_id]['obj']->getVar('com_status')) {
            // if there are any child comments, display them as root comments
            if (isset($tree[$comment_id]['child']) && !empty($tree[$comment_id]['child'])) {
                foreach ($tree[$comment_id]['child'] as $child_id) {
                    $this->renderThreadView($child_id, $admin_view, false);
                }
            }
            return;
        } else {
            $text = $tree[$comment_id]['obj']->getVar('com_text');
        }
        $replies = [];
        $this->_renderThreadReplies($tree, $comment_id, $replies, '&nbsp;&nbsp;', $admin_view);
        $show_replies = count($replies) > 0;
        $this->_tpl->append('comments',
            [
                'pid' => $tree[$comment_id]['obj']->getVar('com_pid'),
                'id' => $tree[$comment_id]['obj']->getVar('com_id'),
                'itemid' => $tree[$comment_id]['obj']->getVar('com_itemid'),
                'rootid' => $tree[$comment_id]['obj']->getVar('com_rootid'),
                'title' => $title, 'text' => $text,
                'date_posted' => formatTimestamp($tree[$comment_id]['obj']->getVar('com_created'), 'm'),
                'date_modified' => formatTimestamp($tree[$comment_id]['obj']->getVar('com_modified'), 'm'),
                'poster' => $this->_getPosterArray($tree[$comment_id]['obj']->getVar('com_uid')),
                'replies' => $replies, 'show_replies' => $show_replies
            ]
        );
    }

    public function _renderThreadReplies(array &$thread, int $key, array &$replies, string $prefix, bool $admin_view, int $depth = 0, string $current_prefix = '')
    {
        if ($depth > 0) {
            if (false !== $this->_useIcons) {
                $title = $this->_getTitleIcon($thread[$key]['obj']->getVar('com_icon')).'&nbsp;'.$thread[$key]['obj']->getVar('com_title');
            } else {
                $title = $thread[$key]['obj']->getVar('com_title');
            }
            $title = (false !== $admin_view) ? $title.' '.$this->_statusText[$thread[$key]['obj']->getVar('com_status')] : $title;
            $replies[] = [
                'id' => $key,
                'prefix' => $current_prefix,
                'date_posted' => formatTimestamp($thread[$key]['obj']->getVar('com_created'), 'm'),
                'title' => $title,
                'root_id' => $thread[$key]['obj']->getVar('com_rootid'),
                'status' => $this->_statusText[$thread[$key]['obj']->getVar('com_status')],
                'poster' => $this->_getPosterName($thread[$key]['obj']->getVar('com_uid'))
            ];
            $current_prefix .= $prefix;
        }
        if (isset($thread[$key]['child']) && !empty($thread[$key]['child'])) {
            $depth++;
            foreach ($thread[$key]['child'] as $childkey) {
                if (!$admin_view && XOOPS_COMMENT_ACTIVE !== $thread[$childkey]['obj']->getVar('com_status')) {
                    // skip this comment if it is not active and continue on processing its child comments instead
                    if (isset($thread[$childkey]['child']) && !empty($thread[$childkey]['child'])) {
                        foreach ($thread[$childkey]['child'] as $childchildkey) {
                            $this->_renderThreadReplies($thread, $childchildkey, $replies, $prefix, $admin_view, $depth);
                        }
                    }
                } else {
                    $this->_renderThreadReplies($thread, $childkey, $replies, $prefix, $admin_view, $depth, $current_prefix);
                }
            }
        }
    }

    public function renderNestView(int $comment_id = 0, bool $admin_view)
    {
        include_once XOOPS_ROOT_PATH.'/class/tree.php';
        $xot = new XoopsObjectTree($this->_comments, 'com_id', 'com_pid', 'com_rootid');
        $tree =& $xot->getTree();
        if (false !== $this->_useIcons) {
            $title = $this->_getTitleIcon($tree[$comment_id]['obj']->getVar('com_icon')).'&nbsp;'.$tree[$comment_id]['obj']->getVar('com_title');
        } else {
            $title = $tree[$comment_id]['obj']->getVar('com_title');
        }
        if (false !== $admin_view) {
            $text = $tree[$comment_id]['obj']->getVar('com_text')
                .'<div style="text-align:right; margin-top: 2px; margin-bottom: 0px; margin-right: 2px;">'
                ._CM_STATUS.': '.$this->_statusText[$tree[$comment_id]['obj']->getVar('com_status')]
                .'<br>IP: <span style="font-weight: bold;">'
                .$tree[$comment_id]['obj']->getVar('com_ip').'</span></div>';
        } else if (XOOPS_COMMENT_ACTIVE !== $tree[$comment_id]['obj']->getVar('com_status')) {
            // if there are any child comments, display them as root comments
            if (isset($tree[$comment_id]['child']) && !empty($tree[$comment_id]['child'])) {
                foreach ($tree[$comment_id]['child'] as $child_id) {
                    $this->renderNestView($child_id, $admin_view);
                }
            }
            return;
        } else {
            $text = $tree[$comment_id]['obj']->getVar('com_text');
        }
        $replies = [];
        $this->_renderNestReplies($tree, $comment_id, $replies, 25, $admin_view);
        $this->_tpl->append('comments', [
            'pid' => $tree[$comment_id]['obj']->getVar('com_pid'),
                'id' => $tree[$comment_id]['obj']->getVar('com_id'),
                'itemid' => $tree[$comment_id]['obj']->getVar('com_itemid'),
                'rootid' => $tree[$comment_id]['obj']->getVar('com_rootid'),
                'title' => $title, 'text' => $text,
                'date_posted' => formatTimestamp($tree[$comment_id]['obj']->getVar('com_created'), 'm'),
                'date_modified' => formatTimestamp($tree[$comment_id]['obj']->getVar('com_modified'), 'm'),
                'poster' => $this->_getPosterArray($tree[$comment_id]['obj']->getVar('com_uid')),
                'replies' => $replies
            ]
        );
    }

    public function _renderNestReplies(array &$thread, int $key, array &$replies, string $prefix, bool $admin_view, int $depth = 0)
    {
        if ($depth > 0) {
            if (false !== $this->_useIcons) {
                $title = $this->_getTitleIcon($thread[$key]['obj']->getVar('com_icon')).'&nbsp;'.$thread[$key]['obj']->getVar('com_title');
            } else {
                $title = $thread[$key]['obj']->getVar('com_title');
            }
            $text = (false !== $admin_view) ? $thread[$key]['obj']->getVar('com_text')
                .'<div style="text-align:right; margin-top: 2px; margin-right: 2px;">'
                ._CM_STATUS.': '.$this->_statusText[$thread[$key]['obj']->getVar('com_status')]
                .'<br>IP: <span style="font-weight: bold;">'
                .$thread[$key]['obj']->getVar('com_ip')
                .'</span></div>' : $thread[$key]['obj']->getVar('com_text');
            $replies[] = [
                'id' => $key,
                'prefix' => $prefix,
                'pid' => $thread[$key]['obj']->getVar('com_pid'),
                'itemid' => $thread[$key]['obj']->getVar('com_itemid'),
                'rootid' => $thread[$key]['obj']->getVar('com_rootid'),
                'title' => $title,
                'text' => $text,
                'date_posted' => formatTimestamp($thread[$key]['obj']->getVar('com_created'), 'm'),
                'date_modified' => formatTimestamp($thread[$key]['obj']->getVar('com_modified'), 'm'),
                'poster' => $this->_getPosterArray($thread[$key]['obj']->getVar('com_uid'))
            ];
 
            $prefix += 25;
        }
        if (isset($thread[$key]['child']) && !empty($thread[$key]['child'])) {
            $depth++;
            foreach ($thread[$key]['child'] as $childkey) {
                if (!$admin_view && XOOPS_COMMENT_ACTIVE !== $thread[$childkey]['obj']->getVar('com_status')) {
                    // skip this comment if it is not active and continue on processing its child comments instead
                    if (isset($thread[$childkey]['child']) && !empty($thread[$childkey]['child'])) {
                        foreach ($thread[$childkey]['child'] as $childchildkey) {
                            $this->_renderNestReplies($thread, $childchildkey, $replies, $prefix, $admin_view, $depth);
                        }
                    }
                } else {
                    $this->_renderNestReplies($thread, $childkey, $replies, $prefix, $admin_view, $depth);
                }
            }
        }
    }
 

 
    public function _getPosterName($poster_id)
    {
        $poster['id'] = (int)$poster_id;
        if ($poster['id'] > 0) {
            $com_poster =& $this->_memberHandler->getUser($poster_id);
            if (is_object($com_poster)) {
                $poster['uname'] = '<a href="'.XOOPS_URL.'/userinfo.php?uid='.$poster['id'].'">'.$com_poster->getVar('uname').'</a>';
                return $poster;
            }
        }
        $poster['id'] = 0; // to cope with deleted user accounts
        $poster['uname'] = $GLOBALS['xoopsConfig']['anonymous'];
        return $poster;
    }

    public function _getPosterArray($poster_id)
    {
        $poster['id'] = (int)$poster_id;
        if ($poster['id'] > 0) {
            $com_poster =& $this->_memberHandler->getUser($poster['id']);
            if (is_object($com_poster)) {
                $poster['uname'] = '<a href="'.XOOPS_URL.'/userinfo.php?uid='.$poster['id'].'">'.$com_poster->getVar('uname').'</a>';
                $poster_rank = $com_poster->rank();
                $poster['rank_image'] = ('' !== $poster_rank['image']) ? $poster_rank['image'] : 'blank.gif';
                $poster['rank_title'] = $poster_rank['title'];
                $poster['avatar'] = $com_poster->getVar('user_avatar');
                $poster['regdate'] = formatTimestamp($com_poster->getVar('user_regdate'), 's');
                $poster['from'] = $com_poster->getVar('user_from');
                $poster['postnum'] = $com_poster->getVar('posts');
                $poster['status'] = $com_poster->isOnline() ? _CM_ONLINE : '';
                return $poster;
            }
        }
        $poster['id'] = 0; // to cope with deleted user accounts
        $poster['uname'] = $GLOBALS['xoopsConfig']['anonymous'];
        $poster['rank_title'] = '';
        $poster['avatar'] = 'blank.gif';
        $poster['regdate'] = '';
        $poster['from'] = '';
        $poster['postnum'] = 0;
        $poster['status'] = '';
        return $poster;
    }

    public function _getTitleIcon($icon_image)
    {
        $icon_image = trim($icon_image);
        if ('' !== $icon_image) {
            $icon_image = htmlspecialchars($icon_image);
            if ((false !== $this->_doIconCheck) && !file_exists(XOOPS_URL . '/images/subject/' . $icon_image)) {
                return '<img src="'.XOOPS_URL.'/images/icons/no_posticon.svg" alt="" />';
            }
 
            return '<img src="'.XOOPS_URL.'/images/subject/'.$icon_image.'" alt="" />';
        }
        return '<img src="'.XOOPS_URL.'/images/icons/no_posticon.svg" alt="" />';
    }
}