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: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 

<?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.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/ //
// Project: The XOOPS Project                                                //
// ------------------------------------------------------------------------- //
/**
 * Manage template files
 *
 * @copyright   http://www.impresscms.org/ The ImpressCMS Project
 * @license     LICENSE.txt
 * @category    ICMS
 * @package     View
 * @subpackage  Template
 * @version     SVN: $Id: Handler.php 12313 2013-09-15 21:14:35Z skenow $
 */

defined('ICMS_ROOT_PATH') or die("ImpressCMS root path not defined");

/**
 * Template file handler class.
 * This class is responsible for providing data access mechanisms to the data source
 * of template file class objects.
 *
 * @category    ICMS
 * @package     View
 * @subpackage  Template
 * @author      Kazumi Ono <onokazu@xoops.org>
 * @copyright   Copyright (c) 2000 XOOPS.org
 */
class icms_view_template_file_Handler extends icms_core_ObjectHandler {
    private $_prefetch_cache = array();

    /**
     * create a new template instance
     *
     * @see icms_view_template_file_Object
     * @param bool $isNew is the new tempate new??
     * @return object icms_view_template_file_Object {@link icms_view_template_file_Object} reference to the new template
     **/
    public function &create($isNew = true) {
        $tplfile = new icms_view_template_file_Object();
        if ($isNew) {
            $tplfile->setNew();
        }
        return $tplfile;
    }

    /**
     * gets a new template instance
     *
     * @see icms_view_template_file_Object
     * @param int $id ID of the template to get
     * @param bool $getsource would you like to get the source?
     * @return object icms_view_template_file_Object {@link icms_view_template_file_Object} reference to the new template
     **/
    public function &get($id, $getsource = false) {
        $tplfile = false;
        $id = (int) $id;
        if ($id > 0) {
            if (!$getsource) {
                $sql = "SELECT * FROM " . $this->db->prefix('tplfile') . " WHERE tpl_id='" . $id . "'";
            } else {
                $sql = "SELECT f.*, s.tpl_source FROM " . $this->db->prefix('tplfile')
                    . " f LEFT JOIN " . $this->db->prefix('tplsource')
                    . " s  ON s.tpl_id=f.tpl_id WHERE f.tpl_id='" . $id . "'";
            }
            if (!$result = $this->db->query($sql)) {
                return $tplfile;
            }
            $numrows = $this->db->getRowsNum($result);
            if ($numrows == 1) {
                $tplfile = new icms_view_template_file_Object();
                $tplfile->assignVars($this->db->fetchArray($result));
            }
        }
        return $tplfile;
    }

    /**
     * Loads Template source from DataBase
     *
     * @see icms_view_template_file_Object
     * @param object $tplfile {@link icms_view_template_file_Object} object of the template file to load
     * @return bool TRUE on success, FALSE if fail
     **/
    public function loadSource(&$tplfile) {
        /* As of PHP5.3.0, is_a() is no longer deprecated */
        if (!is_a($tplfile, 'icms_view_template_file_Object')) {
            return false;
        }

        if (!$tplfile->getVar('tpl_source')) {
            $sql = "SELECT tpl_source FROM " . $this->db->prefix('tplsource')
                . " WHERE tpl_id='" . $tplfile->getVar('tpl_id') . "'";
            if (!$result = $this->db->query($sql)) {
                return false;
            }
            $myrow = $this->db->fetchArray($result);
            $tplfile->assignVar('tpl_source', $myrow['tpl_source']);
        }
        return true;
    }

    /**
     * Inserts Template into the DataBase
     *
     * @see icms_view_template_file_Object
     * @param object $tplfile {@link icms_view_template_file_Object} object of the template file to load
     * @return bool TRUE on success, FALSE if fail
     **/
    public function insert(&$tplfile) {
        /* As of PHP5.3.0, is_a() is no longer deprecated */
        if (!is_a($tplfile, 'icms_view_template_file_Object')) {
            return false;
        }
        if (!$tplfile->isDirty()) {
            return true;
        }
        if (!$tplfile->cleanVars()) {
            return false;
        }
        foreach ( $tplfile->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        if ($tplfile->isNew()) {
            $tpl_id = $this->db->genId('tpltpl_file_id_seq');
            $sql = sprintf(
                "INSERT INTO %s (tpl_id, tpl_module, tpl_refid, tpl_tplset, tpl_file, tpl_desc, tpl_lastmodified, tpl_lastimported, tpl_type)
                VALUES ('%u', %s, '%u', %s, %s, %s, '%u', '%u', %s)",
                $this->db->prefix('tplfile'),
                (int) ($tpl_id),
                $this->db->quoteString($tpl_module),
                (int) $tpl_refid,
                $this->db->quoteString($tpl_tplset),
                $this->db->quoteString($tpl_file),
                $this->db->quoteString($tpl_desc),
                (int) $tpl_lastmodified,
                (int) $tpl_lastimported,
                $this->db->quoteString($tpl_type)
            );
            if (!$result = $this->db->query($sql)) {
                return false;
            }
            if (empty($tpl_id)) {
                $tpl_id = $this->db->getInsertId();
            }
            if (isset($tpl_source) && $tpl_source != '') {
                $sql = sprintf("INSERT INTO %s (tpl_id, tpl_source)
                    VALUES ('%u', %s)",
                    $this->db->prefix('tplsource'),
                    (int) $tpl_id,
                    $this->db->quoteString($tpl_source)
                );
                if (!$result = $this->db->query($sql)) {
                    $this->db->query(sprintf("DELETE FROM %s WHERE tpl_id = '%u'",
                        $this->db->prefix('tplfile'), (int) $tpl_id)
                    );
                    return false;
                }
            }
            $tplfile->assignVar('tpl_id', $tpl_id);
        } else {
            $sql = sprintf(
                "UPDATE %s SET tpl_tplset = %s, tpl_file = %s, tpl_desc = %s, tpl_lastimported = '%u', tpl_lastmodified = '%u' WHERE tpl_id = '%u'",
                $this->db->prefix('tplfile'),
                $this->db->quoteString($tpl_tplset),
                $this->db->quoteString($tpl_file),
                $this->db->quoteString($tpl_desc),
                (int) $tpl_lastimported,
                (int) $tpl_lastmodified,
                (int) $tpl_id
            );
            if (!$result = $this->db->query($sql)) {
                return false;
            }
            if (isset($tpl_source) && $tpl_source != '') {
                $sql = sprintf("UPDATE %s SET tpl_source = %s WHERE tpl_id = '%u'",
                    $this->db->prefix('tplsource'),
                    $this->db->quoteString($tpl_source),
                    (int) $tpl_id
                );
                if (!$result = $this->db->query($sql)) {
                    return false;
                }
            }
        }
        return true;
    }

    /**
     * forces Template source into the DataBase
     * @param object $tplfile {@link icms_view_template_file_Object} object of the template file to load
     * @return bool TRUE on success, FALSE if fail
     **/
    public function forceUpdate(&$tplfile) {
        /* As of PHP5.3.0, is_a() is no longer deprecated */
        if (!is_a($tplfile, 'icms_view_template_file_Object')) {
            return false;
        }
        if (!$tplfile->isDirty()) {
            return true;
        }
        if (!$tplfile->cleanVars()) {
            return false;
        }
        foreach ( $tplfile->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        if (!$tplfile->isNew()) {
            $sql = sprintf("UPDATE %s SET tpl_tplset = %s, tpl_file = %s, tpl_desc = %s, tpl_lastimported = '%u', tpl_lastmodified = '%u' WHERE tpl_id = '%u'", $this->db->prefix('tplfile'), $this->db->quoteString($tpl_tplset), $this->db->quoteString($tpl_file), $this->db->quoteString($tpl_desc), (int) ($tpl_lastimported), (int) ($tpl_lastmodified), (int) ($tpl_id));
            if (!$result = $this->db->queryF($sql)) {
                return false;
            }
            if (isset($tpl_source) && $tpl_source != '') {
                $sql = sprintf("UPDATE %s SET tpl_source = %s WHERE tpl_id = '%u'", $this->db->prefix('tplsource'), $this->db->quoteString($tpl_source), (int) ($tpl_id));
                if (!$result = $this->db->queryF($sql)) {
                    return false;
                }
            }
            return true;
        } else {
            return false;
        }
    }

    /**
     * Deletes Template from the DataBase
     * @param object $tplfile {@link icms_view_template_file_Object} object of the template file to load
     * @return bool TRUE on success, FALSE if fail
     **/
    public function delete(&$tplfile) {
        /* As of PHP5.3.0, is_a() is no longer deprecated */
        if (!is_a($tplfile, 'icms_view_template_file_Object')) {
            return false;
        }
        $id = (int) ($tplfile->getVar('tpl_id'));
        $sql = sprintf("DELETE FROM %s WHERE tpl_id = '%u'", $this->db->prefix('tplfile'), $id);
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        $sql = sprintf("DELETE FROM %s WHERE tpl_id = '%u'", $this->db->prefix('tplsource'), $id);
        $this->db->query($sql);
        return true;
    }

    /**
     * retrieve array of {@link icms_view_template_file_Object}s meeting certain conditions
     * @param object $criteria {@link icms_db_criteria_Element} with conditions for the blocks
     * @param bool $id_as_key should the tplfile's tpl_id be the key for the returned array?
     * @return array {@link icms_view_template_file_Object}s matching the conditions
     **/
    public function getObjects($criteria = null, $getsource = false, $id_as_key = false) {
        $ret = array();
        $limit = $start = 0;
        if ($getsource) {
            $sql = "SELECT f.*, s.tpl_source FROM " . $this->db->prefix('tplfile')
                . " f LEFT JOIN " . $this->db->prefix('tplsource') . " s ON s.tpl_id=f.tpl_id";
        } else {
            $sql = "SELECT * FROM " . $this->db->prefix('tplfile');
        }
        if (isset($criteria) && is_subclass_of($criteria, 'icms_db_criteria_Element')) {
            $sql .= " " . $criteria->renderWhere() . " ORDER BY tpl_refid";
            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $result = $this->db->query($sql, $limit, $start);
        if (!$result) {
            return $ret;
        }
        while ($myrow = $this->db->fetchArray($result)) {
            $tplfile = new icms_view_template_file_Object();
            $tplfile->assignVars($myrow);
            if (!$id_as_key) {
                $ret[] =& $tplfile;
            } else {
                $ret[$myrow['tpl_id']] =& $tplfile;
            }
            unset($tplfile);
        }
        return $ret;
    }

    /**
     * Count some tplfiles
     *
     * @param   object  $criteria   {@link icms_db_criteria_Element}
     * @return  int
     **/
    public function getCount($criteria = null)  {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('tplfile');
        if (isset($criteria) && is_subclass_of($criteria, 'icms_db_criteria_Element')) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result =& $this->db->query($sql)) {
            return 0;
        }
        list($count) = $this->db->fetchRow($result);
        return $count;
    }

    /**
     * Count some tplfiles for a module
     *
     * @param   string  $tplset Template Set
     * @return  array $ret containing number of templates in the tpl_set or empty array if fails
     **/
    public function getModuleTplCount($tplset) {
        $ret = array();
        $sql = "SELECT tpl_module, COUNT(tpl_id) AS count FROM " . $this->db->prefix('tplfile')
            . " WHERE tpl_tplset='" . $tplset . "' GROUP BY tpl_module";
        $result = $this->db->query($sql);
        if (!$result) {
            return $ret;
        }
        while ($myrow = $this->db->fetchArray($result)) {
            if ($myrow['tpl_module'] != '') {
                $ret[$myrow['tpl_module']] = $myrow['count'];
            }
        }
        return $ret;
    }

    /**
     * find tplfiles matching criteria
     *
     * @param   string  $tplset             template set
     * @param   string  $type               template type
     * @param   int     $refid              ref id
     * @param   string  $module             module
     * @param   string  $file               template file
     * @param   bool    $getsource = false  get source or not
     * @return  array $ret containing number of templates in the tpl_set or empty array if fails
     **/
    public function find($tplset = null, $type = null, $refid = null, $module = null, $file = null, $getsource = false) {
        $criteria = new icms_db_criteria_Compo();
        if (isset($tplset)) {
            $criteria->add(new icms_db_criteria_Item('tpl_tplset', $tplset));
        }
        if (isset($module)) {
            $criteria->add(new icms_db_criteria_Item('tpl_module', $module));
        }
        if (isset($refid)) {
            $criteria->add(new icms_db_criteria_Item('tpl_refid', $refid));
        }
        if (isset($file)) {
            $criteria->add(new icms_db_criteria_Item('tpl_file', $file));
        }
        if (isset($type)) {
            if (is_array($type)) {
                $criteria2 = new icms_db_criteria_Compo();
                foreach ( $type as $t) {
                    $criteria2->add(new icms_db_criteria_Item('tpl_type', $t), 'OR');
                }
                $criteria->add($criteria2);
            } else {
                $criteria->add(new icms_db_criteria_Item('tpl_type', $type));
            }
        }
        return $this->getObjects($criteria, $getsource, false);
    }

    /**
     * Does the template exist in the database in the template set
     *
     * @param   string  $tplname        template name
     * @param   string  $tplset_name    template set name
     * @return  bool true if exists, false if not
     **/
    public function templateExists($tplname, $tplset_name) {
        $criteria = new icms_db_criteria_Compo(new icms_db_criteria_Item('tpl_file', trim($tplname)));
        $criteria->add(new icms_db_criteria_Item('tpl_tplset', trim($tplset_name)));
        if ($this->getCount($criteria) > 0) {
            return true;
        }
        return false;
    }

    /**
     * Prefetch blocks to reduce the amount of queries required by Smarty to generate all blocks
     * This function is called exclusively in icms_view_PageBuilder
     *
     * @global  array   $icmsConfig     icms configuration array
     * @param   array   $block_arr      array of blocks to prefetch
     * @return  bool                    false if there are no blocks to prefetch, otherwise true
     */
    public function prefetchBlocks(&$block_arr) {
        global $icmsConfig;

        if (count($block_arr) == 0) return false;
        $tplNames = array();

        /**
         * @todo As soon as the criteria object is capable of rendering complex conditions,
         * this should be converted into the criteria approach
         */
        $sql = "SELECT f.*, s.tpl_source FROM " . $this->db->prefix("tplfile") . " f "
             . "LEFT JOIN " . $this->db->prefix("tplsource") . " s ON s.tpl_id=f.tpl_id "
             . "WHERE (tpl_tplset = '" . $icmsConfig["template_set"] . "' "
             // always load the default templates as a fallback
             . "OR tpl_tplset = 'default') AND (";

        foreach ($block_arr as $block) {
            $tplName = ($tplName = $block->getVar("template")) ? "$tplName" : "system_block_dummy.html";
            $tplNames[] = "tpl_file = '" . $tplName . "'";
        }
        $sql .= implode(" OR ", $tplNames);
        $sql .= ") ORDER BY tpl_refid";

        $result = $this->db->query($sql);
        if (!$result) return false;
        while ($myrow = $this->db->fetchArray($result)) {
            $tplfile = new icms_view_template_file_Object();
            $tplfile->assignVars($myrow);
            $this->_prefetch_cache[] =& $tplfile;
            unset($tplfile);
        }
        return true;
    }

    /**
     * Return a prefetched block. This function only works if prefetchBlocks was called in advance.
     * This function is used in the user function smarty_resource_db_tplinfo().
     *
     * @param   str     $tplset     template set that's currently in use
     * @param   str     $tpl_name   name of the template
     * @return  array               array of templates (just one item)
     */
    public function getPrefetchedBlock($tplset, $tpl_name) {
        foreach($this->_prefetch_cache as $block) {
            if ($block->getVar("tpl_tplset") == $tplset && $block->getVar("tpl_file") == $tpl_name) {
                return array($block);
            }
        }

        /**
         * try to get the template from the default template set (we've also prefetched it) if the
         * template set is different from default
         */
        if ($tplset != 'default') {
            foreach($this->_prefetch_cache as $block) {
                if ($block->getVar("tpl_tplset") == "default" && $block->getVar("tpl_file") == $tpl_name) {
                    return array($block);
                }
            }
        }

        /**
         * In case nothing was found, the following fallback tries to read the template again.
         * This is the case for all non-block templates since blocks are prefetched before the
         * content template(s) are required.
         * To avoid further queries for the same block, we're adding it to the cache
         */
        $blocks = $this->find($tplset, null, null, null, $tpl_name, true);
        array_merge($this->_prefetch_cache, $blocks);
        return $blocks;
    }
}