XOOPS / XoopsCore25

htdocs/class/theme_blocks.php

<?php
/**
 * xos_logos_PageBuilder component class file
 *
 * 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.
 *
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 * @license             GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author              Skalpa Keo <skalpa@xoops.org>
 * @since               2.3.0
 * @package             kernel
 */

/**
 * This file cannot be requested directly
 */
defined('XOOPS_ROOT_PATH') || exit('Restricted access');

include_once $GLOBALS['xoops']->path('class/xoopsblock.php');
include_once $GLOBALS['xoops']->path('class/template.php');

/**
 * xos_logos_PageBuilder main class
 *
 * @package    xos_logos
 * @subpackage xos_logos_PageBuilder
 * @author     Skalpa Keo
 * @since      2.3.0
 */
class xos_logos_PageBuilder
{
    public $theme  = false;
    public $blocks = array();

    /**
     * xos_logos_PageBuilder::xoInit()
     *
     * @param array $options
     *
     * @return bool
     */
    public function xoInit($options = array())
    {
        $this->retrieveBlocks();
        if ($this->theme) {
            $this->theme->template->assignByRef('xoBlocks', $this->blocks);
        }

        return true;
    }

    /**
     * Called before a specific zone is rendered
     * @param string $zone
     */
    public function preRender($zone = '')
    {
    }

    /**
     * Called after a specific zone is rendered
     * @param string $zone
     */
    public function postRender($zone = '')
    {
    }

    /**
     * xos_logos_PageBuilder::retrieveBlocks()
     *
     * @return void
     */
    public function retrieveBlocks()
    {
        global $xoopsConfig;
        $xoopsPreload = XoopsPreload::getInstance();

        $startMod = ($xoopsConfig['startpage'] == '--') ? 'system' : $xoopsConfig['startpage'];
        if (isset($GLOBALS['xoopsModule']) && is_object($GLOBALS['xoopsModule'])) {
            list($mid, $dirname) = array(
                $GLOBALS['xoopsModule']->getVar('mid'),
                $GLOBALS['xoopsModule']->getVar('dirname'));
            $isStart = (substr($_SERVER['PHP_SELF'], -9) === 'index.php' && $xoopsConfig['startpage'] == $dirname && empty($_SERVER['QUERY_STRING']));
        } else {
            list($mid, $dirname) = array(
                0,
                'system');
            $isStart = !empty($GLOBALS['xoopsOption']['show_cblock']);
        }

        $groups = (isset($GLOBALS['xoopsUser']) && is_object($GLOBALS['xoopsUser'])) ? $GLOBALS['xoopsUser']->getGroups() : array(
            XOOPS_GROUP_ANONYMOUS);

        $oldzones = array(
            XOOPS_SIDEBLOCK_LEFT          => 'canvas_left',
            XOOPS_SIDEBLOCK_RIGHT         => 'canvas_right',
            XOOPS_CENTERBLOCK_LEFT        => 'page_topleft',
            XOOPS_CENTERBLOCK_CENTER      => 'page_topcenter',
            XOOPS_CENTERBLOCK_RIGHT       => 'page_topright',
            XOOPS_CENTERBLOCK_BOTTOMLEFT  => 'page_bottomleft',
            XOOPS_CENTERBLOCK_BOTTOM      => 'page_bottomcenter',
            XOOPS_CENTERBLOCK_BOTTOMRIGHT => 'page_bottomright',
            XOOPS_FOOTERBLOCK_LEFT        => 'footer_left',
            XOOPS_FOOTERBLOCK_RIGHT       => 'footer_right',
            XOOPS_FOOTERBLOCK_CENTER      => 'footer_center',
            XOOPS_FOOTERBLOCK_ALL         => 'footer_all');

        foreach ($oldzones as $zone) {
            $this->blocks[$zone] = array();
        }
        if ($this->theme) {
            $template =& $this->theme->template;
            $backup   = array(
                $template->caching,
                $template->cache_lifetime);
        } else {
            $template = null;
            $template = new XoopsTpl();
        }
        $xoopsblock = new XoopsBlock();
        $block_arr  = array();
        $block_arr  = $xoopsblock->getAllByGroupModule($groups, $mid, $isStart, XOOPS_BLOCK_VISIBLE);

The function XoopsBlock::getAllByGroupModule() has been deprecated: (This also appears, dead, in XoopsBlockHandler)

        $xoopsPreload->triggerEvent('core.class.theme_blocks.retrieveBlocks', array(&$this, &$template, &$block_arr));
        foreach ($block_arr as $block) {
            $side = $oldzones[$block->getVar('side')];
            if ($var = $this->buildBlock($block, $template)) {
                $this->blocks[$side][$var['id']] = $var;
            }
        }
        if ($this->theme) {
            list($template->caching, $template->cache_lifetime) = $backup;
        }
    }

    /**
     * xos_logos_PageBuilder::generateCacheId()
     *
     * @param  mixed $cache_id
     * @return mixed
     */
    public function generateCacheId($cache_id)
    {
        if ($this->theme) {
            $cache_id = $this->theme->generateCacheId($cache_id);
        }

        return $cache_id;
    }

    /**
     * xos_logos_PageBuilder::buildBlock()
     *
     * @param  mixed $xobject
     * @param  mixed $template
     * @return array|bool
     */
    public function buildBlock($xobject, &$template)
    {
        // The lame type workaround will change
        // bid is added temporarily as workaround for specific block manipulation
        $block = array(
            'id'      => $xobject->getVar('bid'),
            'module'  => $xobject->getVar('dirname'),
            'title'   => $xobject->getVar('title'),
            // 'name'        => strtolower( preg_replace( '/[^0-9a-zA-Z_]/', '', str_replace( ' ', '_', $xobject->getVar( 'name' ) ) ) ),
            'weight'  => $xobject->getVar('weight'),
            'lastmod' => $xobject->getVar('last_modified'));

        // title is a comment, don't show it
        if (0 === strpos($block['title'], '// ')) {
            $block['title'] = '';
        }

        $bcachetime = (int)$xobject->getVar('bcachetime');
        if (empty($bcachetime)) {
            $template->caching = 0;
        } else {
            $template->caching        = 2;
            $template->cache_lifetime = $bcachetime;
        }
        $template->setCompileId($xobject->getVar('dirname', 'n'));
        $tplName = ($tplName = $xobject->getVar('template')) ? "db:$tplName" : 'db:system_block_dummy.tpl';
        $cacheid = $this->generateCacheId('blk_' . $xobject->getVar('bid'));

        $xoopsLogger = XoopsLogger::getInstance();
        if (!$bcachetime || !$template->isCached($tplName, $cacheid)) {

            //Get theme metas
            if ($this->theme && $bcachetime) {
                foreach ($this->theme->metas as $type => $value) {
                    $old[$type] = $this->theme->metas[$type];
                }
            }

            //build block
            $xoopsLogger->addBlock($xobject->getVar('name'));
            if ($bresult = $xobject->buildBlock()) {
                $template->assign('block', $bresult);
                $block['content'] = $template->fetch($tplName, $cacheid);
            } else {
                $block = false;
            }

            //check if theme added new metas
            if ($this->theme && $bcachetime) {
                $metas = array();
                foreach ($this->theme->metas as $type => $value) {
                    $dif = array_diff_key($this->theme->metas[$type], $old[$type]);
                    if (count($dif)) {
                        $metas[$type] = $dif;
                    }
                }
                if (count($metas)) {
                    xoops_load('xoopscache');
                    $cache = XoopsCache::getInstance();
                    $cache->write($cacheid, $metas);
                }
            }
        } else {
            $xoopsLogger->addBlock($xobject->getVar('name'), true, $bcachetime);
            $block['content'] = $template->fetch($tplName, $cacheid);
        }

        //add block cached metas
        if ($this->theme && $bcachetime) {
            xoops_load('xoopscache');
            $cache = XoopsCache::getInstance();
            if ($metas = $cache->read($cacheid)) {
                foreach ($metas as $type => $value) {
                    $this->theme->metas[$type] = array_merge($this->theme->metas[$type], $metas[$type]);
                }
            }
        }

        $template->setCompileId();

        return $block;
    }
}