rhymix/modules/module/module.model.php
Kijin Sung 84e5542d77 Remove unnecessary use of BaseObject
- 트리거 등 반환값이 필요하지 않은 곳에서 new BaseObject()를 반환하는 것 삭제
- 모듈 설치, 업데이트 후 무의미한 new BaseObject()를 반환하는 것 삭제
- 사용자에게 에러 메시지를 돌려주는 용도로 new BaseObject(-1, '에러메시지')를
  사용하는 경우는 대부분 $this->setError()로 변경함. 언어 변환과 sprintf()
  처리까지 한 번에 이루어지므로 이쪽이 더 편리함.
2017-12-01 00:54:51 +09:00

2471 lines
68 KiB
PHP

<?php
/* Copyright (C) NAVER <http://www.navercorp.com> */
/**
* @class moduleModel
* @author NAVER (developers@xpressengine.com)
* @brief Model class of module module
*/
class moduleModel extends module
{
/**
* @brief Initialization
*/
function init()
{
}
/**
* @brief Check if mid, vid are available
*/
function isIDExists($id, $site_srl = 0)
{
if (!preg_match('/^[a-z]{1}([a-z0-9_]+)$/i', $id))
{
return true;
}
if (Context::isReservedWord(strtolower($id)))
{
return true;
}
$dirs = array_map('strtolower', FileHandler::readDir(_XE_PATH_));
$dirs[] = 'rss';
$dirs[] = 'atom';
$dirs[] = 'api';
if (in_array(strtolower($id), $dirs))
{
return true;
}
// mid test
$args = new stdClass();
$args->mid = $id;
$args->site_srl = $site_srl;
$output = executeQuery('module.isExistsModuleName', $args);
if($output->data->count) return true;
// vid test (check mid != vid if site_srl=0, which means it is not a virtual site)
if(!$site_srl)
{
$site_args = new stdClass();
$site_args->domain = $id;
$output = executeQuery('module.isExistsSiteDomain', $site_args);
if($output->data->count) return true;
}
return false;
}
/**
* @brief Get all domains
*/
function getAllDomains($count = 20, $page = 1)
{
$args = new stdClass;
$args->list_count = $count;
$args->page = $page;
$output = executeQueryArray('module.getDomains', $args);
foreach ($output->data as &$domain)
{
$domain->settings = $domain->settings ? json_decode($domain->settings) : new stdClass;
}
return $output;
}
/**
* @brief Get default domain information
*/
function getDefaultDomainInfo()
{
$domain_info = Rhymix\Framework\Cache::get('site_and_module:domain_info:default');
if ($domain_info === null)
{
$args = new stdClass();
$args->is_default_domain = 'Y';
$output = executeQuery('module.getDomainInfo', $args);
if ($output->data)
{
$domain_info = $output->data;
$domain_info->site_srl = 0;
$domain_info->settings = $domain_info->settings ? json_decode($domain_info->settings) : new stdClass;
$domain_info->default_language = $domain_info->settings->language ?: config('locale.default_lang');
}
else
{
$domain_info = false;
}
Rhymix\Framework\Cache::set('site_and_module:domain_info:default', $domain_info, 0, true);
}
return $domain_info;
}
/**
* @brief Get site information by domain_srl
*/
function getSiteInfo($domain_srl)
{
$domain_srl = intval($domain_srl);
$domain_info = Rhymix\Framework\Cache::get('site_and_module:domain_info:srl:' . $domain_srl);
if ($domain_info === null)
{
$args = new stdClass();
$args->domain_srl = $domain_srl;
$output = executeQuery('module.getDomainInfo', $args);
if ($output->data)
{
$domain_info = $output->data;
$domain_info->site_srl = 0;
$domain_info->settings = $domain_info->settings ? json_decode($domain_info->settings) : new stdClass;
$domain_info->default_language = $domain_info->settings->language ?: config('locale.default_lang');
}
else
{
$domain_info = false;
}
Rhymix\Framework\Cache::set('site_and_module:domain_info:srl:' . $domain_srl, $domain_info, 0, true);
}
return $domain_info;
}
/**
* @brief Get site information by domain name
*/
function getSiteInfoByDomain($domain)
{
if (strpos($domain, '/') !== false)
{
$domain = Rhymix\Framework\URL::getDomainFromURL($domain);
}
if (strpos($domain, 'xn--') !== false)
{
$domain = Rhymix\Framework\URL::decodeIdna($domain);
}
if (strval($domain) === '')
{
return false;
}
$domain = strtolower($domain);
$domain_info = Rhymix\Framework\Cache::get('site_and_module:domain_info:domain:' . $domain);
if ($domain_info === null)
{
$args = new stdClass();
$args->domain = $domain;
$output = executeQuery('module.getDomainInfo', $args);
if ($output->data)
{
$domain_info = $output->data;
$domain_info->site_srl = 0;
$domain_info->settings = $domain_info->settings ? json_decode($domain_info->settings) : new stdClass;
$domain_info->default_language = $domain_info->settings->language ?: config('locale.default_lang');
}
else
{
$domain_info = false;
}
Rhymix\Framework\Cache::set('site_and_module:domain_info:domain:' . $domain, $domain_info, 0, true);
}
return $domain_info;
}
/**
* @brief Get module information with document_srl
* In this case, it is unable to use the cache file
*/
function getModuleInfoByDocumentSrl($document_srl)
{
$args = new stdClass();
$args->document_srl = $document_srl;
$output = executeQuery('module.getModuleInfoByDocument', $args);
$this->applyDefaultSkin($output->data);
return $this->addModuleExtraVars($output->data);
}
/**
* @brief Get the default mid according to the domain
*/
function getDefaultMid()
{
// Get current domain.
$domain = strtolower(preg_replace('/:\d+$/', '', $_SERVER['HTTP_HOST']));
// Find the domain information.
$domain_info = $this->getSiteInfoByDomain($domain);
if (!$domain_info)
{
$domain_info = $this->getDefaultDomainInfo();
if (!$domain_info)
{
$domain_info = $this->migrateDomains();
}
$domain_info->is_default_replaced = true;
}
// Fill in module extra vars and return.
if ($domain_info->module_srl)
{
return $this->addModuleExtraVars($domain_info);
}
else
{
return $domain_info;
}
}
/**
* @brief Get module information by mid
*/
function getModuleInfoByMid($mid, $site_srl = 0, $columnList = array())
{
if(!$mid || ($mid && !preg_match("/^[a-z][a-z0-9_]+$/i", $mid)))
{
return;
}
$args = new stdClass();
$args->mid = $mid;
$args->site_srl = (int)$site_srl;
$module_srl = Rhymix\Framework\Cache::get('site_and_module:module_srl:' . $mid . '_' . $site_srl);
if($module_srl)
{
$module_info = Rhymix\Framework\Cache::get('site_and_module:mid_info:' . $module_srl);
}
else
{
$module_info = null;
}
if($module_info === null)
{
$output = executeQuery('module.getMidInfo', $args);
$module_info = $output->data;
Rhymix\Framework\Cache::set('site_and_module:module_srl:' . $mid . '_' . $site_srl, $module_info->module_srl, 0, true);
Rhymix\Framework\Cache::set('site_and_module:mid_info:' . $module_info->module_srl, $module_info, 0, true);
}
$this->applyDefaultSkin($module_info);
if(!$module_info->module_srl && $module_info->data[0]) $module_info = $module_info->data[0];
return $this->addModuleExtraVars($module_info);
}
/**
* Get module info by menu_item_srl.
*
* @params int $menu_item_srl
*
* @return Object $moduleInfo
*/
public function getModuleInfoByMenuItemSrl($menu_item_srl = 0)
{
$menuItemSrl = Context::get('menu_item_srl');
$menuItemSrl = (!$menuItemSrl) ? $menu_item_srl : $menuItemSrl;
if(!$menuItemSrl)
{
$this->stop(-1, 'msg_invalid_request');
return;
}
$args = new stdClass();
$args->menu_item_srl = $menuItemSrl;
$output = executeQuery('module.getModuleInfoByMenuItemSrl', $args);
if(!$output->toBool())
{
return $output;
}
$moduleInfo = $output->data;
$mid = $moduleInfo->mid;
$site_srl = $moduleInfo->site_srl;
$moduleInfo->designSettings = new stdClass();
$moduleInfo->designSettings->layout = new stdClass();
$moduleInfo->designSettings->skin = new stdClass();
$oLayoutAdminModel = getAdminModel('layout');
$layoutSrlPc = ($moduleInfo->layout_srl == -1) ? $oLayoutAdminModel->getSiteDefaultLayout('P', $moduleInfo->site_srl) : $moduleInfo->layout_srl;
$layoutSrlMobile = ($moduleInfo->mlayout_srl == -1) ? $oLayoutAdminModel->getSiteDefaultLayout('M', $moduleInfo->site_srl) : $moduleInfo->mlayout_srl;
$skinNamePc = ($moduleInfo->is_skin_fix == 'N') ? $this->getModuleDefaultSkin($moduleInfo->module, 'P') : $moduleInfo->skin;
$skinNameMobile = ($moduleInfo->is_mskin_fix == 'N') ? $this->getModuleDefaultSkin($moduleInfo->module, $moduleInfo->mskin === '/USE_RESPONSIVE/' ? 'P' : 'M') : $moduleInfo->mskin;
$oLayoutModel = getModel('layout');
$layoutInfoPc = $layoutSrlPc ? $oLayoutModel->getLayoutRawData($layoutSrlPc, array('title')) : NULL;
$layoutInfoMobile = $layoutSrlMobile ? $oLayoutModel->getLayoutRawData($layoutSrlMobile, array('title')) : NULL;
$skinInfoPc = $this->loadSkinInfo(Modulehandler::getModulePath($moduleInfo->module), $skinNamePc);
$skinInfoMobile = $this->loadSkinInfo(Modulehandler::getModulePath($moduleInfo->module), $skinNameMobile, 'm.skins');
if(!$skinInfoPc)
{
$skinInfoPc = new stdClass();
$skinInfoPc->title = $skinNamePc;
}
if(!$skinInfoMobile)
{
$skinInfoMobile = new stdClass();
$skinInfoMobile->title = $skinNameMobile;
}
$moduleInfo->designSettings->layout->pcIsDefault = $moduleInfo->layout_srl == -1 ? 1 : 0;
$moduleInfo->designSettings->layout->pc = $layoutInfoPc->title;
$moduleInfo->designSettings->layout->mobileIsDefault = $moduleInfo->mlayout_srl == -1 ? 1 : 0;
$moduleInfo->designSettings->layout->mobile = $layoutInfoMobile->title;
$moduleInfo->designSettings->skin->pcIsDefault = $moduleInfo->is_skin_fix == 'N' ? 1 : 0;
$moduleInfo->designSettings->skin->pc = $skinInfoPc->title;
$moduleInfo->designSettings->skin->mobileIsDefault = ($moduleInfo->is_mskin_fix == 'N' && $moduleInfo->mskin !== '/USE_RESPONSIVE/') ? 1 : 0;
$moduleInfo->designSettings->skin->mobile = $skinInfoMobile->title;
$module_srl = Rhymix\Framework\Cache::get('site_and_module:module_srl:' . $mid . '_' . $site_srl);
if($module_srl)
{
$mid_info = Rhymix\Framework\Cache::get('site_and_module:mid_info:' . $module_srl);
}
else
{
$mid_info = null;
}
if($mid_info === null)
{
Rhymix\Framework\Cache::set('site_and_module:module_srl:' . $mid . '_' . $site_srl, $output->data->module_srl, 0, true);
Rhymix\Framework\Cache::set('site_and_module:mid_info:' . $output->data->module_srl, $moduleInfo, 0, true);
}
else
{
$mid_info->designSettings = $moduleInfo->designSettings;
$moduleInfo = $mid_info;
}
$moduleInfo = $this->addModuleExtraVars($moduleInfo);
if($moduleInfo->module == 'page' && $moduleInfo->page_type != 'ARTICLE')
{
unset($moduleInfo->skin);
unset($moduleInfo->mskin);
}
$this->add('module_info_by_menu_item_srl', $moduleInfo);
return $moduleInfo;
}
/**
* @brief Get module information corresponding to module_srl
*/
function getModuleInfoByModuleSrl($module_srl, $columnList = array())
{
if(intval($module_srl) == 0)
{
return false;
}
$mid_info = Rhymix\Framework\Cache::get("site_and_module:mid_info:$module_srl");
if($mid_info === null)
{
// Get data
$args = new stdClass();
$args->module_srl = $module_srl;
$output = executeQuery('module.getMidInfo', $args);
if(!$output->toBool()) return;
$mid_info = $output->data;
$this->applyDefaultSkin($mid_info);
Rhymix\Framework\Cache::set("site_and_module:mid_info:$module_srl", $mid_info, 0, true);
}
if($mid_info && count($columnList))
{
$module_info = new stdClass();
foreach($mid_info as $key => $item)
{
if(in_array($key, $columnList))
{
$module_info->$key = $item;
}
}
}
else $module_info = $mid_info;
$oModuleController = getController('module');
if(isset($module_info->browser_title)) $oModuleController->replaceDefinedLangCode($module_info->browser_title);
$this->applyDefaultSkin($module_info);
return $this->addModuleExtraVars($module_info);
}
/**
* Apply default skin info
*
* @param stdClass $moduleInfo Module information
*/
private function applyDefaultSkin(&$moduleInfo)
{
if($moduleInfo->is_skin_fix == 'N')
{
$moduleInfo->skin = '/USE_DEFAULT/';
}
if($moduleInfo->is_mskin_fix == 'N' && $moduleInfo->mskin !== '/USE_RESPONSIVE/')
{
$moduleInfo->mskin = '/USE_DEFAULT/';
}
}
/**
* @brief Get module information corresponding to layout_srl
*/
function getModulesInfoByLayout($layout_srl, $columnList = array())
{
// Imported data
$args = new stdClass;
$args->layout_srl = $layout_srl;
$output = executeQueryArray('module.getModulesByLayout', $args, $columnList);
$count = count($output->data);
$modules = array();
for($i=0;$i<$count;$i++)
{
$modules[] = $output->data[$i];
}
return $this->addModuleExtraVars($modules);
}
/**
* @brief Get module information corresponding to multiple module_srls
*/
function getModulesInfo($module_srls, $columnList = array())
{
if(is_array($module_srls)) $module_srls = implode(',',$module_srls);
$args = new stdClass();
$args->module_srls = $module_srls;
$output = executeQueryArray('module.getModulesInfo', $args, $columnList);
if(!$output->toBool()) return;
return $this->addModuleExtraVars($output->data);
}
/**
* @brief Add extra vars to the module basic information
*/
function addModuleExtraVars($module_info)
{
// Process although one or more module informaion is requested
if(!is_array($module_info)) $target_module_info = array($module_info);
else $target_module_info = $module_info;
// Get module_srl
$module_srls = array();
foreach($target_module_info as $key => $val)
{
$module_srl = $val->module_srl;
if(!$module_srl) continue;
$module_srls[] = $val->module_srl;
}
// Extract extra information of the module and skin
$extra_vars = $this->getModuleExtraVars($module_srls);
if(!count($module_srls) || !count($extra_vars)) return $module_info;
foreach($target_module_info as $key => $val)
{
if(!$extra_vars[$val->module_srl] || !count($extra_vars[$val->module_srl])) continue;
foreach($extra_vars[$val->module_srl] as $k => $v)
{
if($target_module_info[$key]->{$k}) continue;
$target_module_info[$key]->{$k} = $v;
}
}
if(is_array($module_info)) return $target_module_info;
return $target_module_info[0];
}
/**
* @brief Get a complete list of mid, which is created in the DB
*/
function getMidList($args = null, $columnList = array())
{
$list = Rhymix\Framework\Cache::get('site_and_module:module:mid_list_' . $args->site_srl);
if($list === null)
{
if(count($args) === 1 && isset($args->site_srl))
{
$columnList = array();
}
$output = executeQuery('module.getMidList', $args, $columnList);
if(!$output->toBool()) return $output;
$list = $output->data;
if(count($args) === 1 && isset($args->site_srl) && !$columnList)
{
Rhymix\Framework\Cache::set('site_and_module:module:mid_list_' . $args->site_srl, $list, 0, true);
}
}
if(!$list) return;
if(!is_array($list)) $list = array($list);
foreach($list as $val)
{
$mid_list[$val->mid] = $val;
}
return $mid_list;
}
/**
* @brief Get a complete list of module_srl, which is created in the DB
*/
function getModuleSrlList($args = null, $columnList = array())
{
$output = executeQueryArray('module.getMidList', $args, $columnList);
if(!$output->toBool()) return $output;
$list = $output->data;
if(!$list) return;
return $list;
}
/**
* @brief Return an array of module_srl corresponding to a mid list
*/
function getModuleSrlByMid($mid)
{
if($mid && !is_array($mid)) $mid = explode(',',$mid);
if(is_array($mid)) $mid = "'".implode("','",$mid)."'";
$site_module_info = Context::get('site_module_info');
$args = new stdClass;
$args->mid = $mid;
if($site_module_info) $args->site_srl = $site_module_info->site_srl;
$output = executeQuery('module.getModuleSrlByMid', $args);
if(!$output->toBool()) return $output;
$list = $output->data;
if(!$list) return;
if(!is_array($list)) $list = array($list);
foreach($list as $key => $val)
{
$module_srl_list[] = $val->module_srl;
}
return $module_srl_list;
}
/**
* @brief Get forward value by the value of act
*/
function getActionForward($act)
{
$action_forward = Rhymix\Framework\Cache::get('action_forward');
if($action_forward === null)
{
$args = new stdClass();
$output = executeQueryArray('module.getActionForward',$args);
if(!$output->toBool()) return new stdClass;
if(!$output->data) $output->data = array();
$action_forward = array();
foreach($output->data as $item)
{
$action_forward[$item->act] = $item;
}
Rhymix\Framework\Cache::set('action_forward', $action_forward, 0, true);
}
if($action_forward[$act])
{
return $action_forward[$act];
}
else
{
return new stdClass();
}
}
/**
* @brief Get trigger functions
*/
function getTriggerFunctions($trigger_name, $called_position)
{
if(isset($GLOBALS['__trigger_functions__'][$trigger_name][$called_position]))
{
return $GLOBALS['__trigger_functions__'][$trigger_name][$called_position];
}
else
{
return array();
}
}
/**
* @brief Get a list of all triggers on the trigger_name
*/
function getTriggers($trigger_name, $called_position)
{
if(is_null($GLOBALS['__triggers__']))
{
$triggers = Rhymix\Framework\Cache::get('triggers');
if($triggers === null)
{
$output = executeQueryArray('module.getTriggers');
$triggers = $output->data;
if($output->toBool())
{
Rhymix\Framework\Cache::set('triggers', $triggers, 0, true);
}
}
$triggers = $triggers ?: array();
foreach($triggers as $item)
{
$GLOBALS['__triggers__'][$item->trigger_name][$item->called_position][] = $item;
}
}
return $GLOBALS['__triggers__'][$trigger_name][$called_position];
}
/**
* @brief Get specific triggers from the trigger_name
*/
function getTrigger($trigger_name, $module, $type, $called_method, $called_position)
{
$triggers = $this->getTriggers($trigger_name, $called_position);
if($triggers && is_array($triggers))
{
foreach($triggers as $item)
{
if($item->module == $module && $item->type == $type && $item->called_method == $called_method)
{
return $item;
}
}
}
return NULL;
}
/**
* @brief Get module extend
*/
function getModuleExtend($parent_module, $type, $kind='')
{
$key = $parent_module.'.'.$kind.'.'.$type;
$module_extend_info = $this->loadModuleExtends();
if(array_key_exists($key, $module_extend_info))
{
return $module_extend_info[$key];
}
return false;
}
/**
* @brief Get all the module extend
*/
function loadModuleExtends()
{
$cache_file = './files/cache/common/module_extend.php';
$cache_file = FileHandler::getRealPath($cache_file);
if(!isset($GLOBALS['__MODULE_EXTEND__']))
{
// check pre install
if(file_exists(FileHandler::getRealPath('./files')) && !file_exists($cache_file))
{
$arr = array();
$output = executeQueryArray('module.getModuleExtend');
if($output->data)
{
foreach($output->data as $v)
{
$arr[] = sprintf("'%s.%s.%s' => '%s'", $v->parent_module, $v->kind, $v->type, $v->extend_module);
}
}
$str = '<?PHP return array(%s); ?>';
$str = sprintf($str, join(',',$arr));
FileHandler::writeFile($cache_file, $str);
}
if(file_exists($cache_file))
{
$GLOBALS['__MODULE_EXTEND__'] = include($cache_file);
}
else
{
$GLOBALS['__MODULE_EXTEND__'] = array();
}
}
return $GLOBALS['__MODULE_EXTEND__'];
}
/**
* @brief Get information from conf/info.xml
*/
function getModuleInfoXml($module)
{
// Get a path of the requested module. Return if not exists.
$module_path = ModuleHandler::getModulePath($module);
if(!$module_path) return;
// Read the xml file for module skin information
$xml_file = sprintf("%s/conf/info.xml", $module_path);
if(!file_exists($xml_file)) return;
$oXmlParser = new XmlParser();
$tmp_xml_obj = $oXmlParser->loadXmlFile($xml_file);
$xml_obj = $tmp_xml_obj->module;
if(!$xml_obj) return;
// Module Information
$module_info = new stdClass();
if($xml_obj->version && $xml_obj->attrs->version == '0.2')
{
// module format 0.2
$module_info->title = $xml_obj->title->body;
$module_info->description = $xml_obj->description->body;
$module_info->version = $xml_obj->version->body;
$module_info->homepage = $xml_obj->link->body;
$module_info->category = $xml_obj->category->body;
if(!$module_info->category) $module_info->category = 'service';
sscanf($xml_obj->date->body, '%d-%d-%d', $date_obj->y, $date_obj->m, $date_obj->d);
$module_info->date = sprintf('%04d%02d%02d', $date_obj->y, $date_obj->m, $date_obj->d);
$module_info->license = $xml_obj->license->body;
$module_info->license_link = $xml_obj->license->attrs->link;
if(!is_array($xml_obj->author)) $author_list[] = $xml_obj->author;
else $author_list = $xml_obj->author;
foreach($author_list as $author)
{
$author_obj = new stdClass();
$author_obj->name = $author->name->body;
$author_obj->email_address = $author->attrs->email_address;
$author_obj->homepage = $author->attrs->link;
$module_info->author[] = $author_obj;
}
}
else
{
// module format 0.1
$module_info->title = $xml_obj->title->body;
$module_info->description = $xml_obj->author->description->body;
$module_info->version = $xml_obj->attrs->version;
$module_info->category = $xml_obj->attrs->category;
if(!$module_info->category) $module_info->category = 'service';
sscanf($xml_obj->author->attrs->date, '%d. %d. %d', $date_obj->y, $date_obj->m, $date_obj->d);
$module_info->date = sprintf('%04d%02d%02d', $date_obj->y, $date_obj->m, $date_obj->d);
$author_obj = new stdClass();
$author_obj->name = $xml_obj->author->name->body;
$author_obj->email_address = $xml_obj->author->attrs->email_address;
$author_obj->homepage = $xml_obj->author->attrs->link;
$module_info->author[] = $author_obj;
}
// Add admin_index by using action information
$action_info = $this->getModuleActionXml($module);
$module_info->admin_index_act = $action_info->admin_index_act;
$module_info->default_index_act = $action_info->default_index_act;
$module_info->setup_index_act = $action_info->setup_index_act;
$module_info->simple_setup_index_act = $action_info->simple_setup_index_act;
return $module_info;
}
/**
* @brief Return permisson and action data by conf/module.xml in the module
* Cache it because it takes too long to parse module.xml file
* When caching, add codes so to include it directly
* This is apparently good for performance, but not sure about its side-effects
*/
function getModuleActionXml($module)
{
// Get a path of the requested module. Return if not exists.
$class_path = ModuleHandler::getModulePath($module);
if(!$class_path) return;
// Check if module.xml exists in the path. Return if not exist
$xml_file = sprintf("%sconf/module.xml", $class_path);
if(!file_exists($xml_file)) return;
// Check if cached file exists
$cache_file = sprintf(_XE_PATH_ . "files/cache/module_info/%s.%s.%s.php", $module, Context::getLangType(), __XE_VERSION__);
// Update if no cache file exists or it is older than xml file
if(!file_exists($cache_file) || filemtime($cache_file) < filemtime($xml_file) || $re_cache)
{
$info = new stdClass();
$buff = array(); // /< Set buff variable to use in the cache file
$buff[] = '<?php if(!defined("__XE__")) exit();';
$buff[] = '$info = new stdClass;';
$buff['default_index_act'] = '$info->default_index_act = \'%s\';';
$buff['setup_index_act'] = '$info->setup_index_act=\'%s\';';
$buff['simple_setup_index_act'] = '$info->simple_setup_index_act=\'%s\';';
$buff['admin_index_act'] = '$info->admin_index_act = \'%s\';';
$xml_obj = XmlParser::loadXmlFile($xml_file); // /< Read xml file and convert it to xml object
if(!count($xml_obj->module)) return; // /< Error occurs if module tag doesn't included in the xml
$grants = $xml_obj->module->grants->grant; // /< Permission information
$permissions = $xml_obj->module->permissions->permission; // /< Acting permission
$menus = $xml_obj->module->menus->menu;
$actions = $xml_obj->module->actions->action; // /< Action list (required)
$default_index = $admin_index = '';
// Arrange permission information
if($grants)
{
if(is_array($grants)) $grant_list = $grants;
else $grant_list[] = $grants;
$info->grant = new stdClass();
$buff[] = '$info->grant = new stdClass;';
foreach($grant_list as $grant)
{
$name = $grant->attrs->name;
$default = $grant->attrs->default?$grant->attrs->default:'guest';
$title = $grant->title->body;
$info->grant->{$name} = new stdClass();
$info->grant->{$name}->title = $title;
$info->grant->{$name}->default = $default;
$buff[] = sprintf('$info->grant->%s = new stdClass;', $name);
$buff[] = sprintf('$info->grant->%s->title=\'%s\';', $name, $title);
$buff[] = sprintf('$info->grant->%s->default=\'%s\';', $name, $default);
}
}
// Permissions to grant
if($permissions)
{
if(is_array($permissions)) $permission_list = $permissions;
else $permission_list[] = $permissions;
$buff[] = '$info->permission = new stdClass;';
$buff[] = '$info->permission_check = new stdClass;';
$info->permission = new stdClass;
$info->permission_check = new stdClass;
foreach($permission_list as $permission)
{
$action = $permission->attrs->action;
$target = $permission->attrs->target;
$info->permission->$action = $target;
$buff[] = sprintf('$info->permission->%s = \'%s\';', $action, $target);
$info->permission_check->$action = new stdClass;
$info->permission_check->$action->key = $permission->attrs->check_var ?: '';
$info->permission_check->$action->type = $permission->attrs->check_type ?: '';
$buff[] = sprintf('$info->permission_check->%s = new stdClass;', $action);
$buff[] = sprintf('$info->permission_check->%s->key = \'%s\';', $action, $info->permission_check->$action->key);
$buff[] = sprintf('$info->permission_check->%s->type = \'%s\';', $action, $info->permission_check->$action->type);
}
}
// for admin menus
if($menus)
{
if(is_array($menus)) $menu_list = $menus;
else $menu_list[] = $menus;
$buff[] = '$info->menu = new stdClass;';
$info->menu = new stdClass();
foreach($menu_list as $menu)
{
$menu_name = $menu->attrs->name;
$menu_title = is_array($menu->title) ? $menu->title[0]->body : $menu->title->body;
$menu_type = $menu->attrs->type;
$info->menu->{$menu_name} = new stdClass();
$info->menu->{$menu_name}->title = $menu_title;
$info->menu->{$menu_name}->acts = array();
$info->menu->{$menu_name}->type = $menu_type;
$buff[] = sprintf('$info->menu->%s = new stdClass;', $menu_name);
$buff[] = sprintf('$info->menu->%s->title=\'%s\';', $menu_name, $menu_title);
$buff[] = sprintf('$info->menu->%s->type=\'%s\';', $menu_name, $menu_type);
}
}
// actions
if($actions)
{
if(is_array($actions)) $action_list = $actions;
else $action_list[] = $actions;
if(!isset($info->permission))
{
$buff[] = '$info->permission = new stdClass;';
$buff[] = '$info->permission_check = new stdClass;';
$info->permission = new stdClass;
$info->permission_check = new stdClass;
}
$buff[] = '$info->action = new stdClass;';
$info->action = new stdClass();
foreach($action_list as $action)
{
$name = $action->attrs->name;
// <action permission="...">
if($action->attrs->permission)
{
$info->permission->$name = $action->attrs->permission;
$buff[] = sprintf('$info->permission->%s = \'%s\';', $name, $info->permission->$name);
$info->permission_check->$name = new stdClass;
$info->permission_check->$name->key = $action->attrs->check_var ?: '';
$info->permission_check->$name->type = $action->attrs->check_type ?: '';
$buff[] = sprintf('$info->permission_check->%s = new stdClass;', $name);
$buff[] = sprintf('$info->permission_check->%s->key = \'%s\';', $name, $info->permission_check->$name->key);
$buff[] = sprintf('$info->permission_check->%s->type = \'%s\';', $name, $info->permission_check->$name->type);
}
$type = $action->attrs->type;
$grant = $action->attrs->grant?$action->attrs->grant:'guest';
$standalone = $action->attrs->standalone=='false'?'false':'true';
$ruleset = $action->attrs->ruleset?$action->attrs->ruleset:'';
$method = $action->attrs->method?$action->attrs->method:'';
$check_csrf = $action->attrs->check_csrf=='false'?'false':'true';
$index = $action->attrs->index;
$admin_index = $action->attrs->admin_index;
$setup_index = $action->attrs->setup_index;
$simple_setup_index = $action->attrs->simple_setup_index;
$menu_index = $action->attrs->menu_index;
$info->action->{$name} = new stdClass();
$info->action->{$name}->type = $type;
$info->action->{$name}->grant = $grant;
$info->action->{$name}->standalone = $standalone;
$info->action->{$name}->ruleset = $ruleset;
$info->action->{$name}->method = $method;
$info->action->{$name}->check_csrf = $check_csrf;
if($action->attrs->menu_name)
{
$info->menu->{$action->attrs->menu_name} = new stdClass();
if($menu_index == 'true')
{
$info->menu->{$action->attrs->menu_name}->index = $name;
$buff[] = sprintf('$info->menu->%s->index=\'%s\';', $action->attrs->menu_name, $name);
}
if(is_array($info->menu->{$action->attrs->menu_name}->acts))
{
$info->menu->{$action->attrs->menu_name}->acts[] = $name;
}
$buff[] = sprintf('$info->menu->%s->acts[]=\'%s\';', $action->attrs->menu_name, $name);
$i++;
}
$buff[] = sprintf('$info->action->%s = new stdClass;', $name);
$buff[] = sprintf('$info->action->%s->type=\'%s\';', $name, $type);
$buff[] = sprintf('$info->action->%s->grant=\'%s\';', $name, $grant);
$buff[] = sprintf('$info->action->%s->standalone=\'%s\';', $name, $standalone);
$buff[] = sprintf('$info->action->%s->ruleset=\'%s\';', $name, $ruleset);
$buff[] = sprintf('$info->action->%s->method=\'%s\';', $name, $method);
$buff[] = sprintf('$info->action->%s->check_csrf=\'%s\';', $name, $check_csrf);
if($index=='true')
{
$default_index_act = $name;
$info->default_index_act = $name;
}
if($admin_index=='true')
{
$admin_index_act = $name;
$info->admin_index_act = $name;
}
if($setup_index=='true')
{
$setup_index_act = $name;
$info->setup_index_act = $name;
}
if($simple_setup_index=='true')
{
$simple_setup_index_act = $name;
$info->simple_setup_index_act = $name;
}
}
}
$buff['default_index_act'] = sprintf($buff['default_index_act'], $default_index_act);
$buff['setup_index_act'] = sprintf($buff['setup_index_act'], $setup_index_act);
$buff['simple_setup_index_act'] = sprintf($buff['simple_setup_index_act'], $simple_setup_index_act);
$buff['admin_index_act'] = sprintf($buff['admin_index_act'], $admin_index_act);
$buff[] = 'return $info;';
$buff = implode(PHP_EOL, $buff);
FileHandler::writeFile($cache_file, $buff);
return $info;
}
if(file_exists($cache_file)) return include($cache_file);
}
/**
* Get a skin list for js API.
* return void
*/
public function getModuleSkinInfoList()
{
$module = Context::get('module_type');
if($module == 'ARTICLE')
{
$module = 'page';
}
$skinType = Context::get('skin_type');
$path = ModuleHandler::getModulePath($module);
$dir = ($skinType == 'M') ? 'm.skins' : 'skins';
$skin_list = $this->getSkins($path, $dir);
$this->add('skin_info_list', $skin_list);
}
/**
* @brief Get a list of skins for the module
* Return file analysis of skin and skin.xml
*/
function getSkins($path, $dir = 'skins')
{
if(substr($path, -1) == '/')
{
$path = substr($path, 0, -1);
}
$skin_path = sprintf("%s/%s/", $path, $dir);
$list = FileHandler::readDir($skin_path);
if(!count($list)) return;
natcasesort($list);
foreach($list as $skin_name)
{
if(!is_dir($skin_path . $skin_name))
{
continue;
}
unset($skin_info);
$skin_info = $this->loadSkinInfo($path, $skin_name, $dir);
if(!$skin_info)
{
$skin_info = new stdClass();
$skin_info->title = $skin_name;
}
$skin_list[$skin_name] = $skin_info;
}
$tmpPath = strtr($path, array('/' => ' '));
$tmpPath = trim($tmpPath);
$module = array_pop(explode(' ', $tmpPath));
if($dir == 'skins')
{
$oAdminModel = getAdminModel('admin');
$themesInfo = $oAdminModel->getThemeList();
foreach($themesInfo as $themeName => $info)
{
$skinInfos = $info->skin_infos;
if(isset($skinInfos[$module]) && $skinInfos[$module]->is_theme)
{
$themeSkinInfo = $GLOBALS['__ThemeModuleSkin__'][$module]['skins'][$skinInfos[$module]->name];
$skin_list[$skinInfos[$module]->name] = $themeSkinInfo;
}
}
}
$siteInfo = Context::get('site_module_info');
$oMenuAdminModel = getAdminModel('menu');
$installedMenuTypes = $oMenuAdminModel->getModuleListInSitemap($siteInfo->site_srl);
$moduleName = $module;
if($moduleName === 'page')
{
$moduleName = 'ARTICLE';
}
if(array_key_exists($moduleName, $installedMenuTypes))
{
if($dir == 'skins')
{
$type = 'P';
}
else
{
$type = 'M';
}
$defaultSkinName = $this->getModuleDefaultSkin($module, $type);
if(isset($defaultSkinName))
{
$defaultSkinInfo = $this->loadSkinInfo($path, $defaultSkinName, $dir);
$useDefault = new stdClass();
$useDefault->title = lang('use_site_default_skin') . ' (' . $defaultSkinInfo->title . ')';
$useDefaultList['/USE_DEFAULT/'] = $useDefault;
if($type === 'M')
{
$useDefaultList['/USE_RESPONSIVE/'] = (object)array('title' => lang('use_responsive_pc_skin'));
}
$skin_list = array_merge($useDefaultList, $skin_list);
}
}
return $skin_list;
}
/**
* @brief Get skin information on a specific location
*/
function loadSkinInfo($path, $skin, $dir = 'skins')
{
// Read xml file having skin information
if(substr($path,-1)!='/') $path .= '/';
$skin_xml_file = sprintf("%s%s/%s/skin.xml", $path, $dir, $skin);
if(!file_exists($skin_xml_file)) return;
// Create XmlParser object
$oXmlParser = new XmlParser();
$_xml_obj = $oXmlParser->loadXmlFile($skin_xml_file);
// Return if no skin information is
if(!$_xml_obj->skin) return;
$xml_obj = $_xml_obj->skin;
// Skin Name
$skin_info = new stdClass();
$skin_info->title = $xml_obj->title->body;
$skin_info->author = array();
$skin_info->extra_vars = array();
$skin_info->colorset = array();
// Author information
if($xml_obj->version && $xml_obj->attrs->version == '0.2')
{
// skin format v0.2
$date_obj = (object)array('y' => 0, 'm' => 0, 'd' => 0);
sscanf($xml_obj->date->body, '%d-%d-%d', $date_obj->y, $date_obj->m, $date_obj->d);
$skin_info->version = $xml_obj->version->body;
$skin_info->date = sprintf('%04d%02d%02d', $date_obj->y, $date_obj->m, $date_obj->d);
$skin_info->homepage = $xml_obj->link->body;
$skin_info->license = $xml_obj->license->body;
$skin_info->license_link = $xml_obj->license->attrs->link;
$skin_info->description = $xml_obj->description->body;
if(!is_array($xml_obj->author)) $author_list = array($xml_obj->author);
else $author_list = $xml_obj->author;
foreach($author_list as $author)
{
$author_obj = new stdClass();
$author_obj->name = $author->name->body;
$author_obj->email_address = $author->attrs->email_address;
$author_obj->homepage = $author->attrs->link;
$skin_info->author[] = $author_obj;
}
// List extra vars
if($xml_obj->extra_vars)
{
$extra_var_groups = $xml_obj->extra_vars->group;
if(!$extra_var_groups) $extra_var_groups = $xml_obj->extra_vars;
if(!is_array($extra_var_groups)) $extra_var_groups = array($extra_var_groups);
foreach($extra_var_groups as $group)
{
$extra_vars = $group->var;
if(!$extra_vars)
{
continue;
}
if(!is_array($group->var))
{
$extra_vars = array($group->var);
}
foreach($extra_vars as $key => $val)
{
$obj = new stdClass;
$obj->group = $group->title->body;
$obj->name = $val->attrs->name;
$obj->title = $val->title->body;
$obj->type = $val->attrs->type ?: 'text';
$obj->description = $val->description->body;
$obj->value = $val->attrs->value;
$obj->default = $val->attrs->default;
if(preg_match('/,|\|@\|/', $obj->value, $delimiter) && $delimiter[0])
{
$obj->value = explode($delimiter[0], $obj->value);
}
if($obj->type == 'mid_list' && !is_array($obj->value))
{
$obj->value = array($obj->value);
}
// Get an option list from 'select'type
if(is_array($val->options))
{
$option_count = count($val->options);
for($i = 0; $i < $option_count; $i++)
{
$obj->options[$i] = new stdClass();
$obj->options[$i]->title = $val->options[$i]->title->body;
$obj->options[$i]->value = $val->options[$i]->attrs->value;
}
}
else
{
$obj->options[0] = new stdClass();
$obj->options[0]->title = $val->options->title->body;
$obj->options[0]->value = $val->options->attrs->value;
}
$skin_info->extra_vars[] = $obj;
}
}
}
}
else
{
// skin format v0.1
$date_obj = (object)array('y' => 0, 'm' => 0, 'd' => 0);
sscanf($xml_obj->maker->attrs->date, '%d-%d-%d', $date_obj->y, $date_obj->m, $date_obj->d);
$skin_info->version = $xml_obj->version->body;
$skin_info->date = sprintf('%04d%02d%02d', $date_obj->y, $date_obj->m, $date_obj->d);
$skin_info->homepage = $xml_obj->link->body;
$skin_info->license = $xml_obj->license->body;
$skin_info->license_link = $xml_obj->license->attrs->link;
$skin_info->description = $xml_obj->maker->description->body;
$skin_info->author[0] = new stdClass();
$skin_info->author[0]->name = $xml_obj->maker->name->body;
$skin_info->author[0]->email_address = $xml_obj->maker->attrs->email_address;
$skin_info->author[0]->homepage = $xml_obj->maker->attrs->link;
// Variables used in the skin
$extra_var_groups = $xml_obj->extra_vars->group;
if(!$extra_var_groups) $extra_var_groups = $xml_obj->extra_vars;
if(!is_array($extra_var_groups)) $extra_var_groups = array($extra_var_groups);
foreach($extra_var_groups as $group)
{
$extra_vars = $group->var;
if($extra_vars)
{
if(!is_array($extra_vars)) $extra_vars = array($extra_vars);
foreach($extra_vars as $var)
{
$options = array();
$group = $group->title->body;
$name = $var->attrs->name;
$type = $var->attrs->type;
$title = $var->title->body;
$description = $var->description->body;
// Get an option list from 'select'type.
if(is_array($var->default))
{
$option_count = count($var->default);
for($i = 0; $i < $option_count; $i++)
{
$options[$i] = new stdClass();
$options[$i]->title = $var->default[$i]->body;
$options[$i]->value = $var->default[$i]->body;
}
}
else
{
$options[0] = new stdClass();
$options[0]->title = $var->default->body;
$options[0]->value = $var->default->body;
}
$width = $var->attrs->width;
$height = $var->attrs->height;
$obj = new stdClass();
$obj->group = $group;
$obj->title = $title;
$obj->description = $description;
$obj->name = $name;
$obj->type = $type;
$obj->options = $options;
$obj->width = $width;
$obj->height = $height;
$obj->default = $options[0]->value;
$skin_info->extra_vars[] = $obj;
}
}
}
}
// colorset
$colorset = $xml_obj->colorset->color;
if($colorset)
{
if(!is_array($colorset)) $colorset = array($colorset);
foreach($colorset as $color)
{
$name = $color->attrs->name;
$title = $color->title->body;
$screenshot = $color->attrs->src;
if($screenshot)
{
$screenshot = sprintf("%s%s/%s/%s", $path, $dir, $skin, $screenshot);
if(!file_exists($screenshot)) $screenshot = "";
}
else $screenshot = "";
$obj = new stdClass();
$obj->name = $name;
$obj->title = $title;
$obj->screenshot = $screenshot;
$skin_info->colorset[] = $obj;
}
}
// Menu type (settings for layout)
if($xml_obj->menus->menu)
{
$menus = $xml_obj->menus->menu;
if(!is_array($menus)) $menus = array($menus);
$menu_count = count($menus);
$skin_info->menu_count = $menu_count;
for($i=0;$i<$menu_count;$i++)
{
unset($obj);
$obj->name = $menus[$i]->attrs->name;
if($menus[$i]->attrs->default == "true") $obj->default = true;
$obj->title = $menus[$i]->title->body;
$obj->maxdepth = $menus[$i]->maxdepth->body;
$skin_info->menu->{$obj->name} = $obj;
}
}
$thumbnail = sprintf("%s%s/%s/thumbnail.png", $path, $dir, $skin);
$skin_info->thumbnail = (file_exists($thumbnail))?$thumbnail:null;
return $skin_info;
}
/**
* @brief Return the number of modules which are registered on a virtual site
*/
function getModuleCount($site_srl, $module = null)
{
$args = new stdClass;
$args->site_srl = $site_srl;
if(!is_null($module)) $args->module = $module;
$output = executeQuery('module.getModuleCount', $args);
return $output->data->count;
}
/**
* @brief Return module configurations
* Global configuration is used to manage board, member and others
*/
function getModuleConfig($module, $site_srl = 0)
{
if(!isset($GLOBALS['__ModuleConfig__'][$site_srl][$module]))
{
$config = Rhymix\Framework\Cache::get('site_and_module:module_config:' . $module . '_' . $site_srl);
if($config === null)
{
$args = new stdClass;
$args->module = $module;
$args->site_srl = $site_srl;
// Only object type
if($config = executeQuery('module.getModuleConfig', $args)->data->config)
{
$config = unserialize($config);
}
else
{
$config = new stdClass;
}
// Set cache
Rhymix\Framework\Cache::set('site_and_module:module_config:' . $module . '_' . $site_srl, $config, 0, true);
}
$GLOBALS['__ModuleConfig__'][$site_srl][$module] = $config;
}
return $GLOBALS['__ModuleConfig__'][$site_srl][$module];
}
/**
* @brief Return the module configuration of mid
* Manage mid configurations which depend on module
*/
function getModulePartConfig($module, $module_srl)
{
if(!isset($GLOBALS['__ModulePartConfig__'][$module][$module_srl]))
{
$config = Rhymix\Framework\Cache::get('site_and_module:module_part_config:' . $module . '_' . $module_srl);
if($config === null)
{
$args = new stdClass;
$args->module = $module;
$args->module_srl = $module_srl;
// Object or Array(compatibility) type
if($config = executeQuery('module.getModulePartConfig', $args)->data->config)
{
$config = unserialize($config);
}
else
{
$config = new ArrayObject;
}
// For access to array as properties
if($config instanceof ArrayObject)
{
$config->setFlags(ArrayObject::ARRAY_AS_PROPS);
}
// Set cache
Rhymix\Framework\Cache::set('site_and_module:module_part_config:' . $module . '_' . $module_srl, $config, 0, true);
}
$GLOBALS['__ModulePartConfig__'][$module][$module_srl] = $config;
}
return $GLOBALS['__ModulePartConfig__'][$module][$module_srl];
}
/**
* @brief Get all of module configurations for each mid
*/
function getModulePartConfigs($module, $site_srl = 0)
{
$args = new stdClass();
$args->module = $module;
if($site_srl) $args->site_srl = $site_srl;
$output = executeQueryArray('module.getModulePartConfigs', $args);
if(!$output->toBool() || !$output->data)
{
return array();
}
$result = array();
foreach($output->data as $key => $val)
{
$result[$val->module_srl] = unserialize($val->config);
}
return $result;
}
/**
* @brief Get a list of module category
*/
function getModuleCategories($moduleCategorySrl = array())
{
$args = new stdClass();
$args->moduleCategorySrl = $moduleCategorySrl;
// Get data from the DB
$output = executeQuery('module.getModuleCategories', $args);
if(!$output->toBool()) return $output;
$list = $output->data;
if(!$list) return;
if(!is_array($list)) $list = array($list);
foreach($list as $val)
{
$category_list[$val->module_category_srl] = $val;
}
return $category_list;
}
/**
* @brief Get content from the module category
*/
function getModuleCategory($module_category_srl)
{
// Get data from the DB
$args = new stdClass;
$args->module_category_srl = $module_category_srl;
$output = executeQuery('module.getModuleCategory', $args);
if(!$output->toBool()) return $output;
return $output->data;
}
/**
* @brief Get xml information of the module
*/
function getModulesXmlInfo()
{
// Get a list of downloaded and installed modules
$searched_list = FileHandler::readDir('./modules');
$searched_count = count($searched_list);
if(!$searched_count) return;
sort($searched_list);
for($i=0;$i<$searched_count;$i++)
{
// Module name
$module_name = $searched_list[$i];
$path = ModuleHandler::getModulePath($module_name);
// Get information of the module
$info = $this->getModuleInfoXml($module_name);
unset($obj);
if(!isset($info)) continue;
$info->module = $module_name;
$info->created_table_count = $created_table_count;
$info->table_count = $table_count;
$info->path = $path;
$info->admin_index_act = $info->admin_index_act;
$list[] = $info;
}
return $list;
}
function checkNeedInstall($module_name)
{
$oDB = &DB::getInstance();
$info = null;
$moduledir = ModuleHandler::getModulePath($module_name);
if(file_exists(FileHandler::getRealPath($moduledir."schemas")))
{
$tmp_files = FileHandler::readDir($moduledir."schemas", '/(\.xml)$/');
$table_count = count($tmp_files);
// Check if the table is created
$created_table_count = 0;
for($j=0;$j<count($tmp_files);$j++)
{
list($table_name) = explode(".",$tmp_files[$j]);
if($oDB->isTableExists($table_name)) $created_table_count ++;
}
// Check if DB is installed
if($table_count > $created_table_count) return true;
else return false;
}
return false;
}
function checkNeedUpdate($module_name)
{
// Check if it is upgraded to module.class.php on each module
$oDummy = getModule($module_name, 'class');
if($oDummy && method_exists($oDummy, "checkUpdate"))
{
return $oDummy->checkUpdate();
}
return false;
}
/**
* @brief 업데이트 적용 여부 확인
* @param array|string $update_id
* @return Boolean
*/
public function needUpdate($update_id)
{
if(!is_array($update_id)) $update_id = array($update_id);
$args = new stdClass();
$args->update_id = implode(',', $update_id);
$output = executeQueryArray('module.getModuleUpdateLog', $args);
if(!!$output->error) return false;
if(!$output->data) $output->data = array();
if(count($update_id) === count($output->data)) return false;
return true;
}
/**
* @brief Get a type and information of the module
*/
function getModuleList()
{
// Create DB Object
$oDB = &DB::getInstance();
// Get a list of downloaded and installed modules
$searched_list = FileHandler::readDir('./modules', '/^([a-zA-Z0-9_-]+)$/');
sort($searched_list);
$searched_count = count($searched_list);
if(!$searched_count) return;
for($i=0;$i<$searched_count;$i++)
{
// module name
$module_name = $searched_list[$i];
$path = ModuleHandler::getModulePath($module_name);
if(!is_dir(FileHandler::getRealPath($path))) continue;
// Get the number of xml files to create a table in schemas
$tmp_files = FileHandler::readDir($path.'schemas', '/(\.xml)$/');
$table_count = count($tmp_files);
// Check if the table is created
$created_table_count = 0;
for($j=0;$j<$table_count;$j++)
{
list($table_name) = explode('.',$tmp_files[$j]);
if($oDB->isTableExists($table_name)) $created_table_count ++;
}
// Get information of the module
$info = NULL;
$info = $this->getModuleInfoXml($module_name);
if(!$info) continue;
$info->module = $module_name;
$info->category = $info->category;
$info->created_table_count = $created_table_count;
$info->table_count = $table_count;
$info->path = $path;
$info->admin_index_act = $info->admin_index_act;
if(!Context::isBlacklistedPlugin($module_name))
{
// Check if DB is installed
if($table_count > $created_table_count)
{
$info->need_install = true;
}
else
{
$info->need_install = false;
}
// Check if it is upgraded to module.class.php on each module
$oDummy = null;
$oDummy = getModule($module_name, 'class');
if($oDummy && method_exists($oDummy, "checkUpdate"))
{
$info->need_update = $oDummy->checkUpdate();
}
else
{
continue;
}
}
$list[] = $info;
}
return $list;
}
/**
* @brief Combine module_srls with domain of sites
* Because XE DBHandler doesn't support left outer join,
* it should be as same as $Output->data[]->module_srl.
*/
function syncModuleToSite(&$data)
{
if(!$data) return;
if(is_array($data))
{
foreach($data as $key => $val)
{
$module_srls[] = $val->module_srl;
}
if(!count($module_srls)) return;
}
else
{
$module_srls[] = $data->module_srl;
}
$args = new stdClass();
$args->module_srls = implode(',',$module_srls);
$output = executeQueryArray('module.getModuleSites', $args);
if(!$output->data) return array();
foreach($output->data as $key => $val)
{
$modules[$val->module_srl] = $val;
}
if(is_array($data))
{
foreach($data as $key => $val)
{
$data[$key]->domain = $modules[$val->module_srl]->domain;
}
}
else
{
$data->domain = $modules[$data->module_srl]->domain;
}
}
/**
* @brief Check if it is an administrator of site_module_info
*/
function isSiteAdmin($member_info, $site_srl = null)
{
if ($member_info && $member_info->is_admin == 'Y')
{
return true;
}
else
{
return false;
}
}
/**
* @brief Get admin information of the site
*/
function getSiteAdmin($site_srl)
{
return array();
}
/**
* @brief Check if a member is a module administrator
*/
function isModuleAdmin($member_info, $module_srl = null)
{
if (!$member_info || !$member_info->member_srl)
{
return false;
}
if ($member_info->is_admin == 'Y')
{
return true;
}
if ($module_srl === null)
{
$site_module_info = Context::get('site_module_info');
if(!$site_module_info) return false;
$module_srl = $site_module_info->module_srl;
}
$module_srl = $module_srl ?: 0;
$module_admins = Rhymix\Framework\Cache::get("site_and_module:module_admins:$module_srl");
if ($module_admins === null)
{
$args = new stdClass;
$args->module_srl = $module_srl;
$output = executeQueryArray('module.getModuleAdmin', $args);
$module_admins = array();
foreach ($output->data as $module_admin)
{
$module_admins[$module_admin->member_srl] = true;
}
Rhymix\Framework\Cache::set("site_and_module:module_admins:$module_srl", $module_admins, 0, true);
}
return isset($module_admins[$member_info->member_srl]);
}
/**
* @brief Get admin ID of the module
*/
function getAdminId($module_srl)
{
$obj = new stdClass();
$obj->module_srl = $module_srl;
$output = executeQueryArray('module.getAdminID', $obj);
if(!$output->toBool() || !$output->data) return;
return $output->data;
}
/**
* @brief Get extra vars of the module
* Extra information, not in the modules table
*/
function getModuleExtraVars($list_module_srl)
{
$extra_vars = array();
$get_module_srls = array();
if(!is_array($list_module_srl)) $list_module_srl = array($list_module_srl);
foreach($list_module_srl as $module_srl)
{
$vars = Rhymix\Framework\Cache::get("site_and_module:module_extra_vars:$module_srl");
if($vars !== null)
{
$extra_vars[$module_srl] = $vars;
}
else
{
$get_module_srls[] = $module_srl;
}
}
if(count($get_module_srls) > 0)
{
$args = new stdClass();
$args->module_srl = implode(',', $get_module_srls);
$output = executeQueryArray('module.getModuleExtraVars', $args);
if(!$output->toBool())
{
return;
}
if(!$output->data)
{
foreach($get_module_srls as $module_srl)
{
Rhymix\Framework\Cache::set("site_and_module:module_extra_vars:$module_srl", new stdClass, 0, true);
$extra_vars[$module_srl] = new stdClass;
}
}
foreach($output->data as $key => $val)
{
if(in_array($val->name, array('mid','module')) || $val->value == 'Array') continue;
if(!isset($extra_vars[$val->module_srl]))
{
$extra_vars[$val->module_srl] = new stdClass();
}
$extra_vars[$val->module_srl]->{$val->name} = $val->value;
Rhymix\Framework\Cache::set('site_and_module:module_extra_vars:' . $val->module_srl, $extra_vars[$val->module_srl], 0, true);
}
}
return $extra_vars;
}
/**
* @brief Get skin information of the module
*/
function getModuleSkinVars($module_srl)
{
$skin_vars = Rhymix\Framework\Cache::get("site_and_module:module_skin_vars:$module_srl");
if($skin_vars === null)
{
$args = new stdClass();
$args->module_srl = $module_srl;
$output = executeQueryArray('module.getModuleSkinVars',$args);
if(!$output->toBool()) return;
$skin_vars = array();
foreach($output->data as $vars)
{
$skin_vars[$vars->name] = $vars;
}
Rhymix\Framework\Cache::set("site_and_module:module_skin_vars:$module_srl", $skin_vars, 0, true);
}
return $skin_vars;
}
/**
* Get default skin name
*/
function getModuleDefaultSkin($module_name, $skin_type = 'P', $site_srl = 0, $updateCache = true)
{
$target = ($skin_type == 'M') ? 'mskin' : 'skin';
if(!$site_srl) $site_srl = 0;
$designInfoFile = sprintf(_XE_PATH_.'files/site_design/design_%s.php', $site_srl);
if(is_readable($designInfoFile))
{
include($designInfoFile);
$skinName = $designInfo->module->{$module_name}->{$target};
}
if(!$skinName)
{
$dir = ($skin_type == 'M') ? 'm.skins/' : 'skins/';
$moduleSkinPath = ModuleHandler::getModulePath($module_name).$dir;
if(is_dir($moduleSkinPath.'default'))
{
$skinName = 'default';
}
else if(is_dir($moduleSkinPath.'xe_default'))
{
$skinName = 'xe_default';
}
else
{
$skins = FileHandler::readDir($moduleSkinPath);
if(count($skins) > 0)
{
$skinName = $skins[0];
}
else
{
$skinName = NULL;
}
}
if($updateCache && $skinName)
{
if(!isset($designInfo->module->{$module_name})) $designInfo->module->{$module_name} = new stdClass();
$designInfo->module->{$module_name}->{$target} = $skinName;
$oAdminController = getAdminController('admin');
$oAdminController->makeDefaultDesignFile($designInfo, $site_srl);
}
}
return $skinName;
}
/**
* @brief Combine skin information with module information
*/
function syncSkinInfoToModuleInfo(&$module_info)
{
if(!$module_info->module_srl) return;
if(Mobile::isFromMobilePhone() && $module_info->mskin !== '/USE_RESPONSIVE/')
{
$skin_vars = $this->getModuleMobileSkinVars($module_info->module_srl);
}
else
{
$skin_vars = $this->getModuleSkinVars($module_info->module_srl);
}
if(!$skin_vars) return;
foreach($skin_vars as $name => $val)
{
if(isset($module_info->{$name})) continue;
$module_info->{$name} = $val->value;
}
}
/**
* Get mobile skin information of the module
* @param $module_srl Sequence of module
* @return array
*/
function getModuleMobileSkinVars($module_srl)
{
$skin_vars = Rhymix\Framework\Cache::get("site_and_module:module_mobile_skin_vars:$module_srl");
if($skin_vars === null)
{
$args = new stdClass();
$args->module_srl = $module_srl;
$output = executeQueryArray('module.getModuleMobileSkinVars',$args);
if(!$output->toBool() || !$output->data) return;
$skin_vars = array();
foreach($output->data as $vars)
{
$skin_vars[$vars->name] = $vars;
}
Rhymix\Framework\Cache::set("site_and_module:module_mobile_skin_vars:$module_srl", $skin_vars, 0, true);
}
return $skin_vars;
}
/**
* Combine skin information with module information
* @param $module_info Module information
*/
function syncMobileSkinInfoToModuleInfo(&$module_info)
{
if(!$module_info->module_srl) return;
$skin_vars = Rhymix\Framework\Cache::get('site_and_module:module_mobile_skin_vars:' . $module_info->module_srl);
if($skin_vars === null)
{
$args = new stdClass;
$args->module_srl = $module_info->module_srl;
$output = executeQueryArray('module.getModuleMobileSkinVars',$args);
if(!$output->toBool()) return;
$skin_vars = $output->data;
Rhymix\Framework\Cache::set('site_and_module:module_mobile_skin_vars:' . $module_info->module_srl, $skin_vars, 0, true);
}
if(!$skin_vars) return;
foreach($output->data as $val)
{
if(isset($module_info->{$val->name})) continue;
$module_info->{$val->name} = $val->value;
}
}
/**
* @brief Return privileges(granted) information by using module info, xml info and member info
*/
function getGrant($module_info, $member_info, $xml_info = '')
{
$__cache = &$GLOBALS['__MODULE_GRANT__'][$module_info->module][intval($module_info->module_srl)][intval($member_info->member_srl)];
if (!$xml_info && is_object($__cache))
{
return $__cache;
}
$grant = new stdClass;
// Get information of module.xml
if(!$xml_info)
{
$xml_info = $this->getModuleActionXml($module_info->module);
}
// Get group information of member
if(is_array($member_info->group_list))
{
$member_group = array_keys($member_info->group_list);
}
else
{
$member_group = array();
}
$is_module_admin = $module_info->module_srl ? $this->isModuleAdmin($member_info, $module_info->module_srl) : false;
// Get 'privilege name' list from module.xml
$privilege_list = array_keys((array) $xml_info->grant);
// Prepend default 'privilege name'
// manager, is_site_admin not distinguish because of compatibility.
array_unshift($privilege_list, 'access', 'is_admin', 'manager', 'is_site_admin', 'root');
// Unique
$privilege_list = array_unique($privilege_list, SORT_STRING);
// Grant first
foreach($privilege_list as $val)
{
// If an administrator, grant all
if($member_info->is_admin == 'Y')
{
$grant->{$val} = true;
}
// If a module manager, grant all (except 'root', 'is_admin')
else if($is_module_admin === true && $val !== 'root' && $val !== 'is_admin')
{
$grant->{$val} = true;
}
// If module_srl doesn't exist, grant access
else if(!$module_info->module_srl && $val === 'access')
{
$grant->{$val} = true;
}
// Default : not grant
else
{
$grant->{$val} = false;
}
}
// If access were not granted, check more
if(!$grant->access)
{
$checked = array();
// Grant privileges by information that get from the DB
foreach($this->getModuleGrants($module_info->module_srl)->data as $val)
{
$checked[$val->name] = true;
if($grant->{$val->name})
{
continue;
}
// All user
if($val->group_srl == 0)
{
$grant->{$val->name} = true;
continue;
}
// Log-in member only
if($member_info->member_srl)
{
if($val->group_srl == -1)
{
$grant->{$val->name} = true;
}
// Site-joined member only
else if($val->group_srl == -2)
{
// Grant if no information of the currently connected site exists
if(!Context::get('site_module_info')->site_srl)
{
$grant->{$val->name} = true;
}
else if(count($member_group))
{
$grant->{$val->name} = true;
}
}
// Manager only
else if($val->group_srl == -3)
{
if($grant->manager)
{
$grant->{$val->name} = true;
}
}
// If a target is a group
else if(count($member_group) && in_array($val->group_srl, $member_group))
{
$grant->{$val->name} = true;
}
}
}
// Grant access by default
if(!isset($checked['access']))
{
$grant->access = true;
}
// Grant privileges by default information of module
if(!empty($grant_list = (array) $xml_info->grant))
{
foreach($grant_list as $name => $item)
{
if(isset($checked[$name]) || $grant->{$name})
{
continue;
}
// All user
if($item->default == 'guest')
{
$grant->{$name} = true;
continue;
}
// Log-in member only
if($member_info->member_srl)
{
if($item->default == 'member')
{
$grant->{$name} = true;
}
else if($item->default == 'site')
{
// Grant if no information of the currently connected site exists
if(!Context::get('site_module_info')->site_srl)
{
$grant->{$name} = true;
}
else if(count($member_group))
{
$grant->{$name} = true;
}
}
}
}
}
}
return $__cache = $grant;
}
/**
* Get privileges(granted) information of the member for target module by target_srl
* @param string $target_srl as module_srl. It may be a reference serial number
* @param string $type module name. get module_srl from module
* @param object $member_info member information
* @return mixed success : object, fail : false
* */
function getPrivilegesBySrl($target_srl, $type = null, $member_info = null)
{
if(empty($target_srl = trim($target_srl)) || !preg_match('/^([0-9]+)$/', $target_srl) && $type != 'module')
{
return false;
}
if($type)
{
if($type == 'document')
{
$target_srl = getModel('document')->getDocument($target_srl, false, false)->get('module_srl');
}
else if($type == 'comment')
{
$target_srl = getModel('comment')->getComment($target_srl)->get('module_srl');
}
else if($type == 'file')
{
$target_srl = getModel('file')->getFile($target_srl)->module_srl;
}
else if($type == 'module')
{
$module_info = $this->getModuleInfoByMid($target_srl);
}
}
if(!isset($module_info))
{
$module_info = $this->getModuleInfoByModuleSrl($target_srl);
}
if(!$module_info->module_srl)
{
return false;
}
if(!$member_info)
{
$member_info = Context::get('logged_info');
}
return $this->getGrant($module_info, $member_info);
}
/**
* @brief Search all modules to find manager privilege of the member
* @param object $member_info member information
* @param string $module module name. if used, search scope is same module
* @return mixed success : object, fail : false
*/
function findManagerPrivilege($member_info, $module = null)
{
if(!$member_info->member_srl || empty($mid_list = $this->getMidList()))
{
return false;
}
foreach($mid_list as $module_info)
{
if($module && $module_info->module != $module)
{
continue;
}
if(($grant = $this->getGrant($module_info, $member_info)) && $grant->manager)
{
return $grant;
}
}
return false;
}
/**
* @brief Get module grants
*/
function getModuleGrants($module_srl)
{
$output = Rhymix\Framework\Cache::get("site_and_module:module_grants:$module_srl");
if ($output === null)
{
$args = new stdClass;
$args->module_srl = $module_srl;
$output = executeQueryArray('module.getModuleGrants', $args);
Rhymix\Framework\Cache::set("site_and_module:module_grants:$module_srl", $output, 0, true);
}
return $output;
}
function getModuleFileBox($module_filebox_srl)
{
$args = new stdClass();
$args->module_filebox_srl = $module_filebox_srl;
return executeQuery('module.getModuleFileBox', $args);
}
function getModuleFileBoxList()
{
$oModuleModel = getModel('module');
$args = new stdClass();
$args->page = Context::get('page');
$args->list_count = 5;
$args->page_count = 5;
$output = executeQuery('module.getModuleFileBoxList', $args);
$output = $oModuleModel->unserializeAttributes($output);
return $output;
}
function unserializeAttributes($module_filebox_list)
{
if(is_array($module_filebox_list->data))
{
foreach($module_filebox_list->data as &$item)
{
if(empty($item->comment))
{
continue;
}
$attributes = explode(';', $item->comment);
foreach($attributes as $attribute)
{
$values = explode(':', $attribute);
if((count($values) % 2) ==1)
{
for($i=2;$i<count($values);$i++)
{
$values[1].=":".$values[$i];
}
}
$atts[$values[0]]=$values[1];
}
$item->attributes = $atts;
unset($atts);
}
}
return $module_filebox_list;
}
function getFileBoxListHtml()
{
$logged_info = Context::get('logged_info');
if($logged_info->is_admin !='Y' && !$logged_info->is_site_admin) return $this->setError('msg_not_permitted');
$link = parse_url($_SERVER["HTTP_REFERER"]);
$link_params = explode('&',$link['query']);
foreach ($link_params as $param)
{
$param = explode("=",$param);
if($param[0] == 'selected_widget') $selected_widget = $param[1];
}
$oWidgetModel = getModel('widget');
if($selected_widget) $widget_info = $oWidgetModel->getWidgetInfo($selected_widget);
Context::set('allow_multiple', $widget_info->extra_var->images->allow_multiple);
$oModuleModel = getModel('module');
$output = $oModuleModel->getModuleFileBoxList();
Context::set('filebox_list', $output->data);
$page = Context::get('page');
if (!$page) $page = 1;
Context::set('page', $page);
Context::set('page_navigation', $output->page_navigation);
$security = new Security();
$security->encodeHTML('filebox_list..comment', 'filebox_list..attributes.');
$oTemplate = &TemplateHandler::getInstance();
$html = $oTemplate->compile(_XE_PATH_ . 'modules/module/tpl/', 'filebox_list_html');
$this->add('html', $html);
}
function getModuleFileBoxPath($module_filebox_srl)
{
return sprintf("./files/attach/filebox/%s",getNumberingPath($module_filebox_srl,3));
}
/**
* @brief Return ruleset cache file path
* @param module, act
*/
function getValidatorFilePath($module, $ruleset, $mid=null)
{
// load dynamic ruleset xml file
if(strpos($ruleset, '@') !== false)
{
$rulsetFile = str_replace('@', '', $ruleset);
$xml_file = sprintf('./files/ruleset/%s.xml', $rulsetFile);
return FileHandler::getRealPath($xml_file);
}
else if (strpos($ruleset, '#') !== false)
{
$rulsetFile = str_replace('#', '', $ruleset).'.'.$mid;
$xml_file = sprintf('./files/ruleset/%s.xml', $rulsetFile);
if(is_readable($xml_file))
return FileHandler::getRealPath($xml_file);
else{
$ruleset = str_replace('#', '', $ruleset);
}
}
// Get a path of the requested module. Return if not exists.
$class_path = ModuleHandler::getModulePath($module);
if(!$class_path) return;
// Check if module.xml exists in the path. Return if not exist
$xml_file = sprintf("%sruleset/%s.xml", $class_path, $ruleset);
if(!file_exists($xml_file)) return;
return $xml_file;
}
function getLangListByLangcodeForAutoComplete()
{
$keyword = Context::get('search_keyword');
$requestVars = Context::getRequestVars();
$args = new stdClass;
$args->site_srl = (int)$requestVars->site_srl;
$args->page = 1; // /< Page
$args->list_count = 100; // /< the number of posts to display on a single page
$args->page_count = 5; // /< the number of pages that appear in the page navigation
$args->sort_index = 'name';
$args->order_type = 'asc';
$args->search_keyword = Context::get('search_keyword'); // /< keyword to search*/
$output = executeQueryArray('module.getLangListByLangcode', $args);
$list = array();
if($output->toBool())
{
foreach((array)$output->data as $code_info)
{
unset($codeInfo);
$codeInfo = array('name'=>'$user_lang->'.$code_info->name, 'value'=>$code_info->value);
$list[] = $codeInfo;
}
}
$this->add('results', $list);
}
/**
* @brief already instance created module list
*/
function getModuleListByInstance($site_srl = 0, $columnList = array())
{
$args = new stdClass();
$args->site_srl = $site_srl;
$output = executeQueryArray('module.getModuleListByInstance', $args, $columnList);
return $output;
}
function getLangByLangcode()
{
$langCode = Context::get('langCode');
if (!$langCode) return;
$oModuleController = getController('module');
$oModuleController->replaceDefinedLangCode($langCode);
$this->add('lang', $langCode);
}
}
/* End of file module.model.php */
/* Location: ./modules/module/module.model.php */