module.php

Go to the documentation of this file.

<?php
use Xoops\Core\Database\Connection;
use Xoops\Core\Kernel\Criteria;
use Xoops\Core\Kernel\CriteriaElement;
use Xoops\Core\Kernel\XoopsObject;
use Xoops\Core\Kernel\XoopsPersistableObjectHandler;

class XoopsModule extends XoopsObject
{
    public $modinfo;

    public $adminmenu;
    private $_msg = array();
        
        protected $xoops_url;
        protected $xoops_root_path;

    public function __construct()
    {
        $this->initVar('mid', XOBJ_DTYPE_INT, null, false);
        $this->initVar('name', XOBJ_DTYPE_TXTBOX, null, true, 150);
        $this->initVar('version', XOBJ_DTYPE_INT, 100, false);
        $this->initVar('last_update', XOBJ_DTYPE_INT, null, false);
        $this->initVar('weight', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('isactive', XOBJ_DTYPE_INT, 1, false);
        $this->initVar('dirname', XOBJ_DTYPE_OTHER, null, true);
        $this->initVar('hasmain', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('hasadmin', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('hassearch', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('hasconfig', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('hascomments', XOBJ_DTYPE_INT, 0, false);
        // RMV-NOTIFY
        $this->initVar('hasnotification', XOBJ_DTYPE_INT, 0, false);
                
                $this->xoops_url = \XoopsBaseConfig::get('url');
                $this->xoops_root_path = \XoopsBaseConfig::get('root-path');
    }

    public function loadInfoAsVar($dirname, $verbose = true)
    {
        $dirname = basename($dirname);
        if (!isset($this->modinfo)) {
            $this->loadInfo($dirname, $verbose);
        }
        $this->setVar('name', $this->modinfo['name'], true);
        $this->setVar('version', intval(100 * ($this->modinfo['version'] + 0.001)), true);
        $this->setVar('dirname', $this->modinfo['dirname'], true);
        $hasmain = (isset($this->modinfo['hasMain']) && $this->modinfo['hasMain'] == 1) ? 1 : 0;
        $hasadmin = (isset($this->modinfo['hasAdmin']) && $this->modinfo['hasAdmin'] == 1) ? 1 : 0;
        $hassearch = (isset($this->modinfo['hasSearch']) && $this->modinfo['hasSearch'] == 1) ? 1 : 0;
        $hasconfig = ((isset($this->modinfo['config']) && is_array($this->modinfo['config'])) || ! empty($this->modinfo['hasComments'])) ? 1 : 0;
        $hascomments = (isset($this->modinfo['hasComments']) && $this->modinfo['hasComments'] == 1) ? 1 : 0;
        // RMV-NOTIFY
        $hasnotification = (isset($this->modinfo['hasNotification']) && $this->modinfo['hasNotification'] == 1) ? 1 : 0;
        $this->setVar('hasmain', $hasmain);
        $this->setVar('hasadmin', $hasadmin);
        $this->setVar('hassearch', $hassearch);
        $this->setVar('hasconfig', $hasconfig);
        $this->setVar('hascomments', $hascomments);
        // RMV-NOTIFY
        $this->setVar('hasnotification', $hasnotification);
    }

    public function setMessage($str)
    {
        $this->_msg[] = trim($str);
    }

    public function getMessages()
    {
        return $this->_msg;
    }

    public function setInfo($name, $value)
    {
        if (empty($name)) {
            $this->modinfo = $value;
        } else {
            $this->modinfo[$name] = $value;
        }
        return true;
    }

    public function getInfo($name = null)
    {
        if (!isset($this->modinfo)) {
            $this->loadInfo($this->getVar('dirname'));
        }
        if (isset($name)) {
            if (isset($this->modinfo[$name])) {
                return $this->modinfo[$name];
            }
            $return = false;
            return $return;
        }
        return $this->modinfo;
    }

    public function mainLink()
    {
        if ($this->getVar('hasmain') == 1) {
            $ret = '<a href="' . $this->xoops_url . '/modules/' . $this->getVar('dirname') . '/">' . $this->getVar('name') . '</a>';
            return $ret;
        }
        return false;
    }

    public function subLink()
    {
        $ret = array();
        if ($this->getInfo('sub') && is_array($this->getInfo('sub'))) {
            foreach ($this->getInfo('sub') as $submenu) {
                $ret[] = array(
                    'name' => $submenu['name'] ,
                    'url' => $submenu['url']);
            }
        }
        return $ret;
    }

    public function loadAdminMenu()
    {
                $file = $this->xoops_root_path . '/modules/' . $this->getInfo('dirname') . '/' . $this->getInfo('adminmenu');
        if ($this->getInfo('adminmenu') && $this->getInfo('adminmenu') != '' && XoopsLoad::fileExists($file)) {
            $adminmenu = array();
            include $file;
            $this->adminmenu = $adminmenu;
        }
    }

    public function getAdminMenu()
    {
        if (!isset($this->adminmenu)) {
            $this->loadAdminMenu();
        }
        return $this->adminmenu;
    }

    public function loadInfo($dirname, $verbose = true)
    {
        static $modVersions;
        if (empty($dirname)) {
            return false;
        }
        $dirname = basename($dirname);
        if (isset($modVersions[$dirname])) {
            $this->modinfo = $modVersions[$dirname];
            return true;
        }
        $xoops = xoops::getInstance();
        $dirname = basename($dirname);
        $xoops->loadLanguage('modinfo', $dirname);
        $xoops->loadLocale($dirname);

        if (!XoopsLoad::fileExists($file = $xoops->path('modules/' . $dirname . '/xoops_version.php'))) {
            if (false != $verbose) {
                echo "Module File for $dirname Not Found!";
            }
            return false;
        }
        $modversion = array();
        include $file;
        $modVersions[$dirname] = $modversion;
        $this->modinfo = $modVersions[$dirname];
        return true;
    }

    public function search($term = '', $andor = 'AND', $limit = 0, $offset = 0, $userid = 0)
    {
        return false;
    }

    public function id($format = 'n')
    {
        return $this->getVar('mid', $format);
    }

    public function mid($format = '')
    {
        return $this->getVar('mid', $format);
    }

    public function name($format = '')
    {
        return $this->getVar('name', $format);
    }

    public function version($format = '')
    {
        return $this->getVar('version', $format);
    }

    public function last_update($format = '')
    {
        return $this->getVar('last_update', $format);
    }

    public function weight($format = '')
    {
        return $this->getVar('weight', $format);
    }

    public function isactive($format = '')
    {
        return $this->getVar('isactive', $format);
    }

    public function dirname($format = '')
    {
        return $this->getVar('dirname', $format);
    }

    public function hasmain($format = '')
    {
        return $this->getVar('hasmain', $format);
    }

    public function hasadmin($format = '')
    {
        return $this->getVar('hasadmin', $format);
    }

    public function hassearch($format = '')
    {
        return $this->getVar('hassearch', $format);
    }

    public function hasconfig($format = '')
    {
        return $this->getVar('hasconfig', $format);
    }

    public function hascomments($format = '')
    {
        return $this->getVar('hascomments', $format);
    }

    public function hasnotification($format = '')
    {
        return $this->getVar('hasnotification', $format);
    }

    public function getByDirName($dirname)
    {
        return Xoops::getInstance()->getModuleByDirname($dirname);
    }
}

class XoopsModuleHandler extends XoopsPersistableObjectHandler
{
    private $_cachedModule_mid = array();

    private $_cachedModule_dirname = array();

    public function __construct(Connection $db = null)
    {
        parent::__construct($db, 'modules', 'XoopsModule', 'mid', 'dirname');
    }

    function getById($id = null)
    {
        $id = intval($id);
        if ($id > 0) {
            if (!empty($this->_cachedModule_mid[$id])) {
                return $this->_cachedModule_mid[$id];
            } else {
                $module = parent::get($id);
                if (!is_object($module)) {
                    return false;
                }
                $this->_cachedModule_mid[$id] = $module;
                $this->_cachedModule_dirname[$module->getVar('dirname')] = $module;
                return $module;
            }
        }
        return false;
    }

    public function getByDirname($dirname)
    {
        $dirname = basename(trim($dirname));

        if (!empty($this->_cachedModule_dirname[$dirname])) {
            return $this->_cachedModule_dirname[$dirname];
        } else {
            $criteria = new Criteria('dirname', $dirname);
            $modules = $this->getObjectsArray($criteria);
            if (count($modules) == 1 && is_object($modules[0])) {
                $module = $modules[0];
            } else {
                return false;
            }
            /* @var $module XoopsModule */
            $this->_cachedModule_dirname[$dirname] = $module;
            $this->_cachedModule_mid[$module->getVar('mid')] = $module;
            return $module;
        }
    }

    public function insertModule(XoopsModule &$module)
    {
        if (!parent::insert($module)) {
            return false;
        }

        $dirname = $module->getVar('dirname');
        $mid = $module->getVar('mid');

        if (!empty($this->_cachedModule_dirname[$dirname])) {
            unset($this->_cachedModule_dirname[$dirname]);
        }
        if (!empty($this->_cachedModule_mid[$mid])) {
            unset($this->_cachedModule_mid[$mid]);
        }
        return true;
    }

    public function deleteModule(XoopsModule &$module)
    {
        if (!parent::delete($module)) {
            return false;
        }

        $mid = $module->getVar('mid');
        $dirname = $module->getVar('dirname');

        // delete admin and read permissions assigned for this module
        $qb = $this->db2->createXoopsQueryBuilder();
        $eb = $qb->expr();
        $qb ->deletePrefix('group_permission')
            ->where(
                $eb->orX(
                    $eb->eq('gperm_name', $eb->literal('module_admin')),
                    $eb->eq('gperm_name', $eb->literal('module_read'))
                )
            )
            ->andWhere($eb->eq('gperm_itemid', ':itemid'))
            ->setParameter(':itemid', $mid, \PDO::PARAM_INT);
        $result = $qb->execute();

        $qb->resetQueryParts(); // reset
        $qb ->select('block_id')
            ->fromPrefix('block_module_link', null)
            ->where($eb->eq('module_id', ':mid'))
            ->setParameter(':mid', $mid, \PDO::PARAM_INT);
        $result = $qb->execute();
        $block_id_arr = array();
        while ($myrow = $result->fetch(PDO::FETCH_ASSOC)) {
            array_push($block_id_arr, $myrow['block_id']);
        }

        foreach ($block_id_arr as $i) {
            $qb->resetQueryParts(); // reset
            $qb ->select('COUNT(*)')
                ->fromPrefix('block_module_link', null)
                ->where($eb->ne('module_id', ':mid'))
                ->setParameter(':mid', $mid, \PDO::PARAM_INT)
                ->andWhere($eb->eq('block_id', ':bid'))
                ->setParameter(':bid', $i, \PDO::PARAM_INT);
            $result = $qb->execute();
            $count = $result->fetchColumn(0);

            if ($count > 0) {
                // this block has other entries, so delete the entry for this module
                $qb->resetQueryParts(); // reset
                $qb ->deletePrefix('block_module_link')
                    ->where($eb->eq('module_id', ':mid'))
                    ->setParameter(':mid', $mid, \PDO::PARAM_INT)
                    ->andWhere($eb->eq('block_id', ':bid'))
                    ->setParameter(':bid', $i, \PDO::PARAM_INT)
                    ->execute();
            } else {
                // this block doesnt have other entries, so disable the block and let it show on top page only. otherwise, this block will not display anymore on block admin page!
                $qb->resetQueryParts(); // reset
                $qb ->updatePrefix('newblocks')
                    ->set('visible', ':notvisible')
                    ->where($eb->eq('bid', ':bid'))
                    ->setParameter(':bid', $i, \PDO::PARAM_INT)
                    ->setParameter(':notvisible', 0, \PDO::PARAM_INT)
                    ->execute();

                $qb->resetQueryParts(); // reset
                $qb ->updatePrefix('block_module_link')
                    ->set('module_id', ':nomid')
                    ->where($eb->eq('module_id', ':mid'))
                    ->setParameter(':mid', $mid, \PDO::PARAM_INT)
                    ->setParameter(':nomid', -1, \PDO::PARAM_INT)
                    ->execute();
            }
        }

        if (!empty($this->_cachedModule_dirname[$dirname])) {
            unset($this->_cachedModule_dirname[$dirname]);
        }
        if (!empty($this->_cachedModule_mid[$mid])) {
            unset($this->_cachedModule_mid[$mid]);
        }
        $cache = \Xoops::getInstance()->cache();
        $cache->delete("system/module/id/{$mid}");
        $cache->delete("system/module/dirname/{$dirname}");
        $cache->delete("module/{$dirname}");
        return true;
    }

    public function getObjectsArray(CriteriaElement $criteria = null, $id_as_key = false)
    {
        $ret = array();
        $qb = $this->db2->createXoopsQueryBuilder();
        $qb->select('*')->fromPrefix('modules', null);
        if (isset($criteria) && ($criteria instanceof CriteriaElement)) {
            $criteria->setSort('weight');
            $criteria->renderQb($qb);
            $qb->addOrderBy('mid', 'ASC');
        }
        try {
            if (!$result = $qb->execute()) {
                return $ret;
            }
        } catch (Exception $e) {
            return $ret;
        }
        while ($myrow = $result->fetch(PDO::FETCH_ASSOC)) {
            $module = new XoopsModule();
            $module->assignVars($myrow);
            if (!$id_as_key) {
                $ret[] = $module;
            } else {
                $ret[$myrow['mid']] = $module;
            }
            unset($module);
        }
        return $ret;
    }

    public function getNameList(CriteriaElement $criteria = null, $dirname_as_key = false)
    {
        $ret = array();
        $modules = $this->getObjectsArray($criteria, true);
        foreach (array_keys($modules) as $i) {
            if (!$dirname_as_key) {
                $ret[$i] = $modules[$i]->getVar('name');
            } else {
                $ret[$modules[$i]->getVar('dirname')] = $modules[$i]->getVar('name');
            }
        }
        return $ret;
    }
}