File data/comment/Renderer.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426:

<?php
//  ------------------------------------------------------------------------ //
//                XOOPS - PHP Content Management System                      //
//                    Copyright (c) 2000 XOOPS.org                           //
//                       <http://www.xoops.org/>                             //
//  ------------------------------------------------------------------------ //
//  This program is free software; you can redistribute it and/or modify     //
//  it under the terms of the GNU General Public License as published by     //
//  the Free Software Foundation; either version 2 of the License, or        //
//  (at your option) any later version.                                      //
//                                                                           //
//  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.  See the            //
//  GNU General Public License for more details.                             //
//                                                                           //
//  You should have received a copy of the GNU General Public License        //
//  along with this program; if not, write to the Free Software              //
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA //
//  ------------------------------------------------------------------------ //
// Author: Kazumi Ono (AKA onokazu)                                          //
// URL: http://www.xoops.org/ http://jp.xoops.org/  http://www.myweb.ne.jp/  //
// Project: The XOOPS Project (http://www.xoops.org/)                        //
// ------------------------------------------------------------------------- //
/**
 * Display comments
 *
 * @license     http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU General Public License (GPL)
 * @copyright   http://www.impresscms.org/ The ImpressCMS Project
 *
 * @category    ICMS
 * @package     Data
 * @subpackage  Comment
 * @version     SVN: $Id: Renderer.php 12313 2013-09-15 21:14:35Z skenow $
 */
/**
 * Display comments
 *
 * @copyright   copyright (c) 2000-2007 XOOPS.org
 *
 * @category    ICMS
 * @package     data
 * @subpackage  comment
 */
class icms_data_comment_Renderer {

    private $_tpl;
    private $_comments = NULL;
    private $_useIcons = TRUE;
    private $_doIconCheck = FALSE;
    private $_memberHandler;
    private $_statusText;

    /**
     * Constructor
     *
     * @param   object  &$tpl
     * @param   boolean $use_icons
     * @param   boolean $do_iconcheck
     */
    private function __construct(&$tpl, $use_icons = TRUE, $do_iconcheck = FALSE) {
        $this->_tpl =& $tpl;
        $this->_useIcons = $use_icons;
        $this->_doIconCheck = $do_iconcheck;
        $this->_memberHandler = icms::handler('icms_member');
        $this->_statusText = array(
            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>'
            );
    }

    /**
     * Access the only instance of this class
     *
     * @param   object  $tpl        reference to a {@link Smarty} object
     * @param   boolean $use_icons
     * @param   boolean $do_iconcheck
     * @return
     */
    static function &instance(&$tpl, $use_icons = TRUE, $do_iconcheck = FALSE) {
        static $instance;
        if (!isset($instance)) {
            $instance = new icms_data_comment_Renderer($tpl, $use_icons, $do_iconcheck);
        }
        return $instance;
    }

    /**
     * Accessor
     *
     * @param   object  &$comments_arr  array of {@link XoopsComment} objects
     */
    public function setComments(&$comments_arr) {
        if (isset($this->_comments)) {
            unset($this->_comments);
        }
        $this->_comments =& $comments_arr;
    }

    /**
     * Render the comments in flat view
     *
     * @param bool  $admin_view
     */
    public function renderFlatView($admin_view = FALSE) {
        $count = count($this->_comments);
        for ($i = 0; $i < $count; $i++) {
            if (FALSE != $this->_useIcons) {
                $title = $this->_getTitleIcon($this->_comments[$i]->getVar('com_icon')) . '&nbsp;' . $this->_comments[$i]->getVar('com_title');
            } else {
                $title = $this->_comments[$i]->getVar('com_title');
            }
            $poster = $this->_getPosterArray($this->_comments[$i]->getVar('com_uid'));
            if (FALSE != $admin_view) {
                $text = $this->_comments[$i]->getVar('com_text') . '<div style="text-align:right; margin-top: 2px; margin-bottom: 0px; margin-right: 2px;">' . _CM_STATUS . ': ' . $this->_statusText[$this->_comments[$i]->getVar('com_status')] . '<br />IP: <span style="font-weight: bold;">' . $this->_comments[$i]->getVar('com_ip') . '</span></div>';
            } else {
                // hide comments that are not active
                if (XOOPS_COMMENT_ACTIVE != $this->_comments[$i]->getVar('com_status')) {
                    continue;
                } else {
                    $text = $this->_comments[$i]->getVar('com_text');
                }
            }
            $this->_tpl->append('comments', array('id' => $this->_comments[$i]->getVar('com_id'), 'title' => $title, 'text' => $text, 'date_posted' => formatTimestamp($this->_comments[$i]->getVar('com_created'), 'm'), 'date_modified' => formatTimestamp($this->_comments[$i]->getVar('com_modified'), 'm'), 'poster' => $poster));
        }
    }

    /**
     * Render the comments in thread view
     *
     * This method calls itself recursively
     *
     * @param integer $comment_id   Should be "0" when called by client
     * @param boolean $admin_view
     * @param boolean $show_nav
     */
    public function renderThreadView($comment_id = 0, $admin_view = FALSE, $show_nav = TRUE) {
        // construct comment tree
        $xot = new icms_ipf_Tree($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 && $tree[$comment_id]['obj']->getVar('com_pid') != 0) {
            $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 {
            // hide comments that are not active
            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 = array();
        $this->_renderThreadReplies($tree, $comment_id, $replies, '&nbsp;&nbsp;', $admin_view);
        $show_replies = (count($replies) > 0) ? TRUE : FALSE;
        $this->_tpl->append('comments',
            array('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
            )
        );
    }

    /**
     * Render replies to a thread
     *
     * @param   array   &$thread
     * @param   int     $key
     * @param   array   $replies
     * @param   string  $prefix
     * @param   bool    $admin_view
     * @param   integer $depth
     * @param   string  $current_prefix
     */
    private function _renderThreadReplies(&$thread, $key, &$replies, $prefix, $admin_view, $depth = 0, $current_prefix = '') {
        if ($depth > 0) {
            $simple_title = $thread[$key]['obj']->getVar('com_title');
            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[] = array(
                'id' => $key,
                'prefix' => $current_prefix,
                'date_posted' => formatTimestamp($thread[$key]['obj']->getVar('com_created'), 'm'),
                'simple_title' => $simple_title,
                '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 && $thread[$childkey]['obj']->getVar('com_status') != XOOPS_COMMENT_ACTIVE) {
                    // 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);
                }
            }
        }
    }

    /**
     * Render comments in nested view
     *
     * Danger: Recursive!
     *
     * @param integer $comment_id   Always "0" when called by client.
     * @param boolean $admin_view
     */
    public function renderNestView($comment_id = 0, $admin_view = FALSE) {
        $xot = new icms_ipf_Tree($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 {
            // skip this comment if it is not active and continue on processing its child comments instead
            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 = array();
        $this->_renderNestReplies($tree, $comment_id, $replies, 25, $admin_view);
        $this->_tpl->append('comments',
            array(
                '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
            )
        );
    }

    /**
     * Render replies in nested view
     *
     * @param   array   $thread
     * @param   int     $key
     * @param   array   $replies
     * @param   string  $prefix
     * @param   bool    $admin_view
     * @param   integer $depth
     */
    private function _renderNestReplies(&$thread, $key, &$replies, $prefix, $admin_view, $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[] = array(
                '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 = $prefix + 25;
        }
        if (isset($thread[$key]['child']) && !empty($thread[$key]['child'])) {
            $depth++;
            foreach ($thread[$key]['child'] as $childkey) {
                if (!$admin_view && $thread[$childkey]['obj']->getVar('com_status') != XOOPS_COMMENT_ACTIVE) {
                    // 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);
                }
            }
        }
    }


    /**
     * Get the name of the poster
     *
     * @param   int $poster_id
     * @return  string
     */
    private 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="' . ICMS_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['icmsConfig']['anonymous'];
        return $poster;
    }

    /**
     * Get an array with info about the poster
     *
     * @param   int $poster_id
     * @return  array
     */
    private 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="' . ICMS_URL . '/userinfo.php?uid=' . $poster['id'] . '">' . $com_poster->getVar('uname') . '</a>';
                $poster_rank = $com_poster->rank();
                $poster['rank_image'] = $poster_rank['image'];
                $poster['rank_title'] = $poster_rank['title'];
                $poster['avatar'] = $com_poster->gravatar();
                $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['icmsConfig']['anonymous'];
        $poster['rank_title'] = '';
        $poster['avatar'] = ICMS_UPLOAD_URL . '/blank.gif';
        $poster['regdate'] = '';
        $poster['from'] = '';
        $poster['postnum'] = 0;
        $poster['status'] = '';
        return $poster;
    }

    /**
     * Get the IMG tag for the title icon
     *
     * @param   string  $icon_image
     * @return  string  HTML IMG tag
     */
    private function _getTitleIcon($icon_image) {
        $icon_image = htmlspecialchars(trim($icon_image));
        if ($icon_image != '') {
            if (FALSE != $this->_doIconCheck) {
                if (!file_exists(ICMS_URL . '/images/subject/' . $icon_image)) {
                    return '<img src="' . ICMS_URL . '/images/icons/' . $GLOBALS["icmsConfig"]["language"] . '/no_posticon.gif" alt="" />';
                } else {
                    return '<img src="' . ICMS_URL . '/images/subject/' . $icon_image . '" alt="" />';
                }
            } else {
                return '<img src="' . ICMS_URL . '/images/subject/' . $icon_image . '" alt="" />';
            }
        }
        return '<img src="' . ICMS_URL . '/images/icons/' . $GLOBALS["icmsConfig"]["language"] . '/no_posticon.gif" alt="" />';
    }
}

Packages

Classes

Interfaces