Legacy_Module.class.php

<?php

class Legacy_AbstractModule
{
    public $mAttributes = [];

    public $mXoopsModule = null;

    public $mModuleConfig = [];

    public $mCacheInfo = null;

    public $mRender = null;

    public function __construct(&$module, $loadConfig=true)
    {
        $this->setXoopsModule($module);
 
        if ($loadConfig && (1 == $module->get('hasconfig') || 1 == $module->get('hascomments') || 1 == $module->get('hasnotification'))) {
            $handler =& xoops_gethandler('config');
            $this->setModuleConfig($handler->getConfigsByCat(0, $module->get('mid')));
        }
    }

    public function setAttribute($key, $value)
    {
        $this->mAttributes[$key] = $value;
    }

    public function hasAttribute($key)
    {
        return isset($this->mAttributes[$key]);
    }

    public function getAttribute($key)
    {
        return $this->mAttributes[$key] ?? null;
    }

    public function setXoopsModule(&$xoopsModule)
    {
        $this->mXoopsModule =& $xoopsModule;
    }

    public function &getXoopsModule()
    {
        return $this->mXoopsModule;
    }

    public function setModuleConfig($config)
    {
        $this->mModuleConfig = $config;
    }

    public function getModuleConfig(string $key = null)
    {
        if (null == $key) {
            return $this->mModuleConfig;
        }
 
        return $this->mModuleConfig[$key] ?? null;
    }

    public function &getCacheInfo()
    {
        if (!is_object($this->mCacheInfo)) {
            $this->_createCacheInfo();
        }
 
        return $this->mCacheInfo;
    }

    public function _createCacheInfo()
    {
        $this->mCacheInfo = new Legacy_ModuleCacheInformation();
        $this->mCacheInfo->mURL = xoops_getenv('REQUEST_URI');
        $this->mCacheInfo->setModule($this->mXoopsModule);
    }

    public function &getRenderTarget()
    {
        if (null == $this->mRender) {
            $this->_createRenderTarget();
        }
 
        return $this->mRender;
    }

    public function _createRenderTarget()
    {
        $renderSystem =& $this->getRenderSystem();
 
        $this->mRender =& $renderSystem->createRenderTarget('main');
        if (null !== $this->mXoopsModule) {
            $this->mRender->setAttribute('legacy_module', $this->mXoopsModule->get('dirname'));
        }
    }

    public function getRenderSystemName()
    {
        $root =& XCube_Root::getSingleton();
        return $root->mContext->mBaseRenderSystemName;
    }

    public function &getRenderSystem()
    {
        $root =& XCube_Root::getSingleton();
        $renderSystem =& $root->getRenderSystem($this->getRenderSystemName());
 
        return $renderSystem;
    }

    public function isActive()
    {
        if (!is_object($this->mXoopsModule)) {  //< FIXME
            return false;
        }
 
        //return $this->mXoopsModule->get('isactive') ? true : false;
        return (bool)$this->mXoopsModule->get('isactive');
    }

    public function isEnableCache()
    {
        if ('POST' == xoops_getenv('REQUEST_METHOD')) {
            return false;
        }
 
        $root =& XCube_Root::getSingleton();
 
        return is_object($this->mXoopsModule) && !empty($root->mContext->mXoopsConfig['module_cache'][$this->mXoopsModule->get('mid')]);
    }

    public function &createCacheInfo()
    {
        $this->mCacheInfo = new Legacy_ModuleCacheInformation();
        $this->mCacheInfo->mURL = xoops_getenv('REQUEST_URI');
        $this->mCacheInfo->setModule($this->mXoopsModule);
 
        return $this->mCacheInfo;
    }

    public function startup()
    {
    }

    public function doActionSearch(&$searchArgs)
    {
    }

    public function doLegacyGlobalSearch($queries, $andor, $max_hit, $start, $uid)
    {
    }

    public function hasAdminIndex()
    {
        return false;
    }

    public function getAdminIndex()
    {
        return null;
    }

    public function getAdminMenu()
    {
    }
}

class Legacy_ModuleAdapter extends Legacy_AbstractModule
{
    public $_mAdminMenuLoadedFlag = false;

    public $mAdminMenu = null;
 
    public function __construct($module, $loadConfig=true)
    {
        parent::__construct($module, $loadConfig);
    }

    public function doActionSearch(&$searchArgs)
    {
        if (!is_object($searchArgs)) {
            return;
        }
 
        $this->mXoopsModule->loadAdminMenu();
 
        /*
        * Polyfill if not PHP >= 7.3.0 // XCL 2.3.0 Bug fix #163 @gigamaster
        */
        if (!function_exists('is_countable')) {
 
            function is_countable($searchArgs) {
 
                if (0 == (is_countable($this->mXoopsModule->adminmenu) ? count($this->mXoopsModule->adminmenu) : 0) && !isset($this->mXoopsModule->modinfo['config'])) {
 
                    return (is_countable($searchArgs));
                }
            }
        }
 
 
        //
        // Search preference
        //
        if (isset($this->mXoopsModule->modinfo['config']) && (is_countable($this->mXoopsModule->modinfo['config']) ? count($this->mXoopsModule->modinfo['config']) : 0)>0) {
            $findFlag = false;
            foreach ($searchArgs->getKeywords() as $word) {
                if (stripos(_PREFERENCES, (string) $word) !== false) {
                    $root =& XCube_Root::getSingleton();
                    $searchArgs->addRecord($this->mXoopsModule->getVar('name'), $root->mController->getPreferenceEditUrl($this->mXoopsModule), _PREFERENCES);
                    $findFlag = true;
                    break;
                }
            }
            // Since XCL 2.3.x PHP8 Check if constant is defined
            if (!$findFlag) {
                $configInfos= [];
                foreach ($this->mXoopsModule->modinfo['config'] as $config) {
                    if (isset($config['title'])) {
                        if (defined($config['title'])) {
                            $configInfos[]= @constant($config['title']);
                        }
                    }
                    if (isset($config['description'])) {
                        if (defined($config['description'])) {
                            $configInfos[]= @constant($config['description']);
                        }
                    }
                    if (isset($config['options']) && (is_countable($config['options']) ? count($config['options']) : 0) > 0 ) {
                        foreach ($config['options'] as $key=>$val) {
                            if (defined($key)) {
                                $configInfos[]= ( constant($key) ?? $key ?? '' );
                            }
                        }
                    }
                }
 
                $findFlag=true;
                foreach ($searchArgs->getKeywords() as $word) {
                    $findFlag&=(stripos(implode(' ', $configInfos), (string) $word) !== false);
                }
 
                if ($findFlag) {
                    $searchArgs->addRecord($this->mXoopsModule->getVar('name'),
                                      XOOPS_URL.'/modules/legacy/admin/index.php?action=PreferenceEdit&amp;confmod_id='.$this->mXoopsModule->getVar('mid'),
                                      _PREFERENCES);
                }
            }
        }
 
        /*
        *  Search AdminMenu
        *  Polyfill if not PHP 7.3.0 // XCLBug #163 @Gigamaster
        */
        if (!function_exists('is_countable')) {
 
            function is_countable($searchArgs) {
 
                if ((is_countable($this->mXoopsModule->adminmenu) ? count($this->mXoopsModule->adminmenu) : 0) > 0 ) {
                    foreach ($this->mXoopsModule->adminmenu as $menu) {
                        $findFlag = true;
                        foreach ($searchArgs->getKeywords() as $word) {
                            $tmpFlag=false;
                            $tmpFlag|=(stripos($menu['title'], (string) $word) !== false);
 
                            // Search keyword
                            if (isset($menu['keywords'])) {
                                $keyword=is_array($menu['keywords']) ? implode(' ', $menu['keywords']) : $menu['keywords'];
                                $tmpFlag|=(stripos($keyword, (string) $word) !== false);
                            }
 
                            $findFlag&=$tmpFlag;
                        }
 
                        if ($findFlag) {
                            //
                            // Create url string with absolute information.
                            //
                            $url= '';
                            if (isset($menu['absolute'])&&$menu['absolute']) {
                                $url=$menu['link'];
                            } else {
                                $url= XOOPS_URL . '/modules/' . $this->mXoopsModule->getVar('dirname') . '/' . $menu['link'];
                            }
 
                            //
                            // Add record
                            //
                            $searchArgs->addRecord($this->mXoopsModule->getVar('name'), $url, $menu['title']);
                        }
                    }
                }
 
            return (is_countable($searchArgs));
 
            }
 
        }
 
        //
        // Search help
        //
        if ($this->mXoopsModule->hasHelp()) {
            $findFlag = false;
 
            foreach ($searchArgs->getKeywords() as $word) {
                if (stripos(_HELP, (string) $word) !== false) {
                    $root =& XCube_Root::getSingleton();
                    $searchArgs->addRecord($this->mXoopsModule->getVar('name'), $root->mController->getHelpViewUrl($this->mXoopsModule), _HELP);
                    $findFlag = true;
                    break;
                }
            }
 
            if (!$findFlag) {
                $root =& XCube_Root::getSingleton();
                $language = $root->mContext->getXoopsConfig('language');
                $helpfile = $this->mXoopsModule->getHelp();
                $dir = XOOPS_MODULE_PATH . '/' . $this->mXoopsModule->getVar('dirname') . '/language/' . $language . '/help';
 
/*                 if (!file_exists($dir . '/' . $helpfile)) {
                    $dir = XOOPS_MODULE_PATH . '/' . $this->mXoopsModule->getVar('dirname') . '/language/english/help';
                    if (!file_exists($dir . '/' . $helpfile)) {
                        return;
                    }
                } */
                if (!file_exists($dir . '/' . $helpfile)) {
                    $dir = XOOPS_MODULE_PATH . '/' . $this->mXoopsModule->getVar('dirname') . '/language/english/help';
                    if (!file_exists($dir . '/' . $helpfile)) {
                        // Try XOOPS_TRUST_PATH for D3 modules
                        $trustDir = XOOPS_TRUST_PATH . '/modules/' . $this->mXoopsModule->getVar('dirname') . '/language/' . $language . '/help';
                        if (!file_exists($trustDir . '/' . $helpfile)) {
                            $trustDir = XOOPS_TRUST_PATH . '/modules/' . $this->mXoopsModule->getVar('dirname') . '/language/english/help';
                            if (!file_exists($trustDir . '/' . $helpfile)) {
                                return;
                            }
                        }
                        $dir = $trustDir;
                    }
                }
                
                $lines = file($dir . '/' . $helpfile);
                foreach ($lines as $line) {
                    foreach ($searchArgs->getKeywords() as $word) {
                        if (stripos($line, (string) $word) !== false) {
                            $url = XOOPS_MODULE_URL . '/legacy/admin/index.php?action=Help&amp;dirname=' . $this->mXoopsModule->getVar('dirname');
                            $searchArgs->addRecord($this->mXoopsModule->getVar('name'), $url, _HELP);
                            return;
                        }
                    }
                }
            }
        }
    }
 
    public function doLegacyGlobalSearch($queries, $andor, $max_hit, $start, $uid)
    {
        $ret = [];
        $results = $this->mXoopsModule->search($queries, $andor, $max_hit, $start, $uid);
 
        if (is_array($results) && count($results) > 0) {
            foreach ($results as $result) {
                $item = [];
                if (isset($result['image']) && $result['image'] !== '') {
                    if (file_exists(XOOPS_ROOT_PATH . '/uploads/' . $result['image'])) {
                        $item['image'] = XOOPS_URL . '/uploads/' . $result['image'];
                    } else {
                        // TODO @gigamaster change module dirname to images/icons
                        // $item['image'] = XOOPS_URL . '/modules/' . $this->mXoopsModule->get('dirname') . '/' . $result['image'];
                        $item['image'] = XOOPS_URL . '/images/icons/' . $result['image'];
                    }
                } else {
                    $item['image'] = XOOPS_URL . '/images/icons/file.svg';
                }
 
                $item['link'] = XOOPS_URL . '/modules/' . $this->mXoopsModule->get('dirname') . '/' . $result['link'];
                $item['title'] = $result['title'];
                $item['uid'] = $result['uid'];
 
                //
                // TODO If this service will come to web service, we should
                // change format from unixtime to string by timeoffset.
                //
                $item['time'] = $result['time'] ?? 0;
 
                $ret[] = $item;
            }
        }
 
        return $ret;
    }

    public function hasAdminIndex()
    {
        $dmy =& $this->mXoopsModule->getInfo();
        return isset($this->mXoopsModule->modinfo['adminindex']) && null !== $this->mXoopsModule->modinfo['adminindex'];
    }

    public function getAdminIndex()
    {
        $dmy =& $this->mXoopsModule->getInfo();
        return XOOPS_MODULE_URL . '/' . $this->mXoopsModule->get('dirname') . '/' . $this->mXoopsModule->modinfo['adminindex'];
    }
 
    public function getAdminMenu()
    {
        if ($this->_mAdminMenuLoadedFlag) {
            return $this->mAdminMenu;
        }
 
        $info =& $this->mXoopsModule->getInfo();
        $root =& XCube_Root::getSingleton();
 
        //
        // Load admin menu, and add preference menu by own judge.
        //
        $this->mXoopsModule->loadAdminMenu();
        if ($this->mXoopsModule->get('hasnotification')
            || (isset($info['config']) && is_array($info['config']))
            || (isset($info['comments']) && is_array($info['comments']))) {
            $this->mXoopsModule->adminmenu[] = [
                    'link' => $root->mController->getPreferenceEditUrl($this->mXoopsModule),
                    'title' => _PREFERENCES,
                    'absolute' => true
            ];
        }
 
        if ($this->mXoopsModule->hasHelp()) {
            $this->mXoopsModule->adminmenu[] = [
                'link'     =>  $root->mController->getHelpViewUrl($this->mXoopsModule),
                'title'    => _HELP,
                'absolute' => true
            ];
        }
 
        $this->_mAdminMenuLoadedFlag = true;
 
        if ($this->mXoopsModule->adminmenu) {
            $dirname = $this->mXoopsModule->get('dirname');
            foreach ($this->mXoopsModule->adminmenu as $menu) {
                if (!isset($menu['absolute']) || (isset($menu['absolute']) && true !== $menu['absolute'])) {
                    $menu['link'] = XOOPS_MODULE_URL . '/' . $dirname . '/' . $menu['link'];
                }
                $this->mAdminMenu[] = $menu;
            }
        }
 
        return $this->mAdminMenu;
    }
}