ModuleHandler::procModule() - Code Metrics - Inspection of "ERROR 워링메세지도 debugMessage파일에 추가." - xpressengine/xe-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — develop (#1872)

unknown
created 2016-03-06 11:58 UTC
ModuleHandler::procModule() F

↳ Parent: ModuleHandler
Complexity

Conditions	89
Paths	> 20000
Size

Total Lines	459
Code Lines	264
Duplication

Lines	119
Ratio	25.93 %
Metric	Value
dl	119
loc	459
rs	2
cc	89
eloc	264
nc	927868444
nop	0
How to fix Long Method Complexity

<?php
/* Copyright (C) NAVER <http://www.navercorp.com> */

/**
 * @class ModuleHandler
 * @author NAVER ([email protected])
 * Handling modules
 *
 * @remarks This class is to excute actions of modules.
 *          Constructing an instance without any parameterconstructor, it finds the target module based on Context.
 *          If there is no act on the found module, excute an action referencing action_forward.
 * */
class ModuleHandler extends Handler
{

	var $module = NULL; ///< Module
	var $act = NULL; ///< action
	var $mid = NULL; ///< Module ID
	var $document_srl = NULL; ///< Document Number
	var $module_srl = NULL; ///< Module Number
	var $module_info = NULL; ///< Module Info. Object
	var $error = NULL; ///< an error code.
	var $httpStatusCode = NULL; ///< http status code.

	/**
	 * prepares variables to use in moduleHandler
	 * @param string $module name of module
	 * @param string $act name of action
	 * @param int $mid
	 * @param int $document_srl
	 * @param int $module_srl
	 * @return void
	 * */

	function ModuleHandler($module = '', $act = '', $mid = '', $document_srl = '', $module_srl = '')

	{
		// If XE has not installed yet, set module as install
		if(!Context::isInstalled())
		{
			$this->module = 'install';
			$this->act = Context::get('act');
			return;
		}

		$oContext = Context::getInstance();
		if($oContext->isSuccessInit == FALSE)

		{
			$logged_info = Context::get('logged_info');
			if($logged_info->is_admin != "Y")
			{
				$this->error = 'msg_invalid_request';
				return;
			}
		}

		// Set variables from request arguments
		$this->module = $module ? $module : Context::get('module');
		$this->act = $act ? $act : Context::get('act');
		$this->mid = $mid ? $mid : Context::get('mid');
		$this->document_srl = $document_srl ? (int) $document_srl : (int) Context::get('document_srl');
		$this->module_srl = $module_srl ? (int) $module_srl : (int) Context::get('module_srl');
        if($entry = Context::get('entry'))
        {
            $this->entry = Context::convertEncodingStr($entry);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

		// Validate variables to prevent XSS
		$isInvalid = NULL;
		if($this->module && !preg_match("/^([a-z0-9\_\-]+)$/i", $this->module))
		{
			$isInvalid = TRUE;
		}
		if($this->mid && !preg_match("/^([a-z0-9\_\-]+)$/i", $this->mid))
		{
			$isInvalid = TRUE;
		}
		if($this->act && !preg_match("/^([a-z0-9\_\-]+)$/i", $this->act))
		{
			$isInvalid = TRUE;
		}
		if($isInvalid)
		{
			htmlHeader();
			echo Context::getLang("msg_invalid_request");
			htmlFooter();
			Context::close();
			exit;
		}

		if(isset($this->act) && (strlen($this->act) >= 4 && substr_compare($this->act, 'disp', 0, 4) === 0))
		{
			if(Context::get('_use_ssl') == 'optional' && Context::isExistsSSLAction($this->act) && $_SERVER['HTTPS'] != 'on')
			{
				if(Context::get('_https_port')!=null) {
					header('location:https://' . $_SERVER['HTTP_HOST'] . ':' . Context::get('_https_port') . $_SERVER['REQUEST_URI']);
				} else {
					header('location:https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
				}
				return;
			}
		}

		// call a trigger before moduleHandler init
		ModuleHandler::triggerCall('moduleHandler.init', 'before', $this);
		if(__DEBUG__ == 1 && __DEBUG_OUTPUT__ == 0)
		{
			if(__DEBUG_PROTECT__ === 1 && __DEBUG_PROTECT_IP__ == $_SERVER['REMOTE_ADDR'])
			{
				set_error_handler(array($this, 'xeErrorLog'), E_WARNING);
			}
			else if(__DEBUG_PROTECT__ === 0)
			{
				set_error_handler(array($this, 'xeErrorLog'), E_WARNING);
			}
		}

		// execute addon (before module initialization)
		$called_position = 'before_module_init';
		$oAddonController = getController('addon');
		$addon_file = $oAddonController->getCacheFilePath(Mobile::isFromMobilePhone() ? 'mobile' : 'pc');
		if(file_exists($addon_file)) include($addon_file);
	}

	function xeErrorLog($errnumber, $errormassage, $errorfile, $errorline, $errorcontext)

	{
		if($errnumber != E_WARNING)
		{
			return false;
		}
		else
		{
			$errorname = 'Warrning!';
		}
		$buff = "\n".$errorname . " : ";
		$buff .= $errormassage . "\n";
		$buff .= "file : " . $errorfile . " line : ";
		$buff .= $errorline . "\n";
		debugPrint($buff);
		restore_error_handler();
		return true;
	}

	/**
	 * Initialization. It finds the target module based on module, mid, document_srl, and prepares to execute an action
	 * @return boolean true: OK, false: redirected
	 * */
	function init()
	{
		$oModuleModel = getModel('module');
		$site_module_info = Context::get('site_module_info');

		// if success_return_url and error_return_url is incorrect
		$urls = array(Context::get('success_return_url'), Context::get('error_return_url'));
		foreach($urls as $url)
		{
			if(empty($url))
			{
				continue;
			}
		
			$urlInfo = parse_url($url);
			$host = $urlInfo['host'];
		
			$dbInfo = Context::getDBInfo();
			$defaultUrlInfo = parse_url($dbInfo->default_url);
			$defaultHost = $defaultUrlInfo['host'];
		
			if($host && ($host != $defaultHost && $host != $site_module_info->domain))
			{
				throw new Exception('msg_default_url_is_null');
			}
		}
		
		if(!$this->document_srl && $this->mid && $this->entry)
		{
			$oDocumentModel = getModel('document');
			$this->document_srl = $oDocumentModel->getDocumentSrlByAlias($this->mid, $this->entry);
			if($this->document_srl)
			{
				Context::set('document_srl', $this->document_srl);
			}
		}

		// Get module's information based on document_srl, if it's specified
		if($this->document_srl)
		{
			
			$module_info = $oModuleModel->getModuleInfoByDocumentSrl($this->document_srl);
			// If the document does not exist, remove document_srl
			if(!$module_info)
			{
				unset($this->document_srl);
			}
			else
			{
				// If it exists, compare mid based on the module information
				// if mids are not matching, set it as the document's mid
				if(!$this->mid || ($this->mid != $module_info->mid))
				{
					
					if(Context::getRequestMethod() == 'GET')
					{
						$this->mid = $module_info->mid;
						header('location:' . getNotEncodedSiteUrl($site_module_info->domain, 'mid', $this->mid, 'document_srl', $this->document_srl));
						return FALSE;
					}
					else
					{
						$this->mid = $module_info->mid;
						Context::set('mid', $this->mid);
					}
					
				}
				// if requested module is different from one of the document, remove the module information retrieved based on the document number
				if($this->module && $module_info->module != $this->module)
				{
					unset($module_info);
				}
			}

		}

		// If module_info is not set yet, and there exists mid information, get module information based on the mid
		if(!$module_info && $this->mid)
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		{
			$module_info = $oModuleModel->getModuleInfoByMid($this->mid, $site_module_info->site_srl);
			//if($this->module && $module_info->module != $this->module) unset($module_info);
		}

		// redirect, if module_site_srl and site_srl are different
		if(!$this->module && !$module_info && $site_module_info->site_srl == 0 && $site_module_info->module_site_srl > 0)
		{
			$site_info = $oModuleModel->getSiteInfo($site_module_info->module_site_srl);
			header("location:" . getNotEncodedSiteUrl($site_info->domain, 'mid', $site_module_info->mid));
			return FALSE;
		}

		// If module_info is not set still, and $module does not exist, find the default module
		if(!$module_info && !$this->module && !$this->mid)
		{
			$module_info = $site_module_info;
		}

		if(!$module_info && !$this->module && $site_module_info->module_site_srl)
		{
			$module_info = $site_module_info;
		}

		// redirect, if site_srl of module_info is different from one of site's module_info
		if($module_info && $module_info->site_srl != $site_module_info->site_srl && !isCrawler())
		{
			// If the module is of virtual site
			if($module_info->site_srl)
			{
				$site_info = $oModuleModel->getSiteInfo($module_info->site_srl);
				$redirect_url = getNotEncodedSiteUrl($site_info->domain, 'mid', Context::get('mid'), 'document_srl', Context::get('document_srl'), 'module_srl', Context::get('module_srl'), 'entry', Context::get('entry'));
				// If it's called from a virtual site, though it's not a module of the virtual site
			}
			else
			{
				$db_info = Context::getDBInfo();
				if(!$db_info->default_url)
				{
					return Context::getLang('msg_default_url_is_not_defined');
				}
				else
				{
					$redirect_url = getNotEncodedSiteUrl($db_info->default_url, 'mid', Context::get('mid'), 'document_srl', Context::get('document_srl'), 'module_srl', Context::get('module_srl'), 'entry', Context::get('entry'));
				}
			}
			header("location:" . $redirect_url);
			return FALSE;
		}

		// If module info was set, retrieve variables from the module information
		if($module_info)
		{
			$this->module = $module_info->module;
			$this->mid = $module_info->mid;
			$this->module_info = $module_info;
			Context::setBrowserTitle($module_info->browser_title);

			$viewType = (Mobile::isFromMobilePhone()) ? 'M' : 'P';
			$targetSrl = (Mobile::isFromMobilePhone()) ? 'mlayout_srl' : 'layout_srl';

			// use the site default layout.
			if($module_info->{$targetSrl} == -1)
			{
				$oLayoutAdminModel = getAdminModel('layout');
				$layoutSrl = $oLayoutAdminModel->getSiteDefaultLayout($viewType, $module_info->site_srl);
			}
			else
			{
				$layoutSrl = $module_info->{$targetSrl};
			}

			// reset a layout_srl in module_info.
			$module_info->{$targetSrl} = $layoutSrl;

			$part_config = $oModuleModel->getModulePartConfig('layout', $layoutSrl);
			Context::addHtmlHeader($part_config->header_script);
		}

		// Set module and mid into module_info
		if(!isset($this->module_info))
		{
			$this->module_info = new stdClass();
		}
		$this->module_info->module = $this->module;
		$this->module_info->mid = $this->mid;

		// Set site_srl add 2011 08 09
		$this->module_info->site_srl = $site_module_info->site_srl;

		// Still no module? it's an error
		if(!$this->module)
		{
			$this->error = 'msg_module_is_not_exists';
			$this->httpStatusCode = '404';
		}

		// If mid exists, set mid into context
		if($this->mid)
		{
			Context::set('mid', $this->mid, TRUE);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		}
		
		// Call a trigger after moduleHandler init
		$output = ModuleHandler::triggerCall('moduleHandler.init', 'after', $this->module_info);
		if(!$output->toBool())
		{
			$this->error = $output->getMessage();
			return TRUE;
		}

		// Set current module info into context
		Context::set('current_module_info', $this->module_info);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		return TRUE;
	}

	/**
	 * get a module instance and execute an action
	 * @return ModuleObject executed module instance
	 * */
	function procModule()
	{
		$oModuleModel = getModel('module');
		$display_mode = Mobile::isFromMobilePhone() ? 'mobile' : 'view';

		// If error occurred while preparation, return a message instance
		if($this->error)
		{
			$this->_setInputErrorToContext();
			$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
			$oMessageObject->setError(-1);
			$oMessageObject->setMessage($this->error);
			$oMessageObject->dispMessage();
			if($this->httpStatusCode)
			{
				$oMessageObject->setHttpStatusCode($this->httpStatusCode);
			}
			return $oMessageObject;
		}

		// Get action information with conf/module.xml
		$xml_info = $oModuleModel->getModuleActionXml($this->module);

		// If not installed yet, modify act
		if($this->module == "install")
		{
			if(!$this->act || !$xml_info->action->{$this->act})
			{
				$this->act = $xml_info->default_index_act;
			}
		}

		// if act exists, find type of the action, if not use default index act
		if(!$this->act)
		{
			$this->act = $xml_info->default_index_act;
		}

		// still no act means error
		if(!$this->act)
		{
			$this->error = 'msg_module_is_not_exists';
			$this->httpStatusCode = '404';

			$this->_setInputErrorToContext();
			$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
			$oMessageObject->setError(-1);
			$oMessageObject->setMessage($this->error);
			$oMessageObject->dispMessage();
			if($this->httpStatusCode)
			{
				$oMessageObject->setHttpStatusCode($this->httpStatusCode);
			}
			return $oMessageObject;
		}

		// get type, kind
		$type = $xml_info->action->{$this->act}->type;
		$ruleset = $xml_info->action->{$this->act}->ruleset;
		$kind = stripos($this->act, 'admin') !== FALSE ? 'admin' : '';
		if(!$kind && $this->module == 'admin')
		{
			$kind = 'admin';
		}

		// check REQUEST_METHOD in controller
		if($type == 'controller')
		{
			$allowedMethod = $xml_info->action->{$this->act}->method;

			if(!$allowedMethod)
			{
				$allowedMethodList[0] = 'POST';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
			}
			else
			{
				$allowedMethodList = explode('|', strtoupper($allowedMethod));
			}

			if(!in_array(strtoupper($_SERVER['REQUEST_METHOD']), $allowedMethodList))
			{
				$this->error = "msg_invalid_request";
				$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
				$oMessageObject->setError(-1);
				$oMessageObject->setMessage($this->error);
				$oMessageObject->dispMessage();
				return $oMessageObject;
			}
		}

		if($this->module_info->use_mobile != "Y")
		{
			Mobile::setMobile(FALSE);
		}

		$logged_info = Context::get('logged_info');

		// check CSRF for POST actions
		if(Context::getRequestMethod() === 'POST' && Context::isInstalled() && $this->act !== 'procFileUpload' && !checkCSRF()) {
			$this->error = 'msg_invalid_request';
			$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
			$oMessageObject->setError(-1);
			$oMessageObject->setMessage($this->error);
			$oMessageObject->dispMessage();
			return $oMessageObject;
		}

		// Admin ip
		if($kind == 'admin' && $_SESSION['denied_admin'] == 'Y')
		{
			$this->_setInputErrorToContext();
			$this->error = "msg_not_permitted_act";
			$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
			$oMessageObject->setError(-1);
			$oMessageObject->setMessage($this->error);
			$oMessageObject->dispMessage();
			return $oMessageObject;
		}

		// if(type == view, and case for using mobilephone)
		if($type == "view" && Mobile::isFromMobilePhone() && Context::isInstalled())
		{
			$orig_type = "view";
			$type = "mobile";
			// create a module instance
			$oModule = $this->getModuleInstance($this->module, $type, $kind);
			if(!is_object($oModule) || !method_exists($oModule, $this->act))
			{
				$type = $orig_type;
				Mobile::setMobile(FALSE);
				$oModule = $this->getModuleInstance($this->module, $type, $kind);
			}
		}
		else
		{
			// create a module instance
			$oModule = $this->getModuleInstance($this->module, $type, $kind);
		}

		if(!is_object($oModule))
		{
			$this->_setInputErrorToContext();
			$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
			$oMessageObject->setError(-1);
			$oMessageObject->setMessage($this->error);
			$oMessageObject->dispMessage();
			if($this->httpStatusCode)
			{
				$oMessageObject->setHttpStatusCode($this->httpStatusCode);
			}
			return $oMessageObject;
		}

		// If there is no such action in the module object
		if(!isset($xml_info->action->{$this->act}) || !method_exists($oModule, $this->act))
		{

			if(!Context::isInstalled())
			{
				$this->_setInputErrorToContext();
				$this->error = 'msg_invalid_request';
				$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
				$oMessageObject->setError(-1);
				$oMessageObject->setMessage($this->error);
				$oMessageObject->dispMessage();
				if($this->httpStatusCode)
				{
					$oMessageObject->setHttpStatusCode($this->httpStatusCode);
				}
				return $oMessageObject;
			}

			$forward = NULL;
			// 1. Look for the module with action name
			if(preg_match('/^([a-z]+)([A-Z])([a-z0-9\_]+)(.*)$/', $this->act, $matches))
			{
				$module = strtolower($matches[2] . $matches[3]);
				$xml_info = $oModuleModel->getModuleActionXml($module);

				if($xml_info->action->{$this->act} && ((stripos($this->act, 'admin') !== FALSE) || $xml_info->action->{$this->act}->standalone != 'false'))
				{
					$forward = new stdClass();
					$forward->module = $module;
					$forward->type = $xml_info->action->{$this->act}->type;
					$forward->ruleset = $xml_info->action->{$this->act}->ruleset;
					$forward->act = $this->act;
				}
				else
				{
					$this->error = 'msg_invalid_request';
					$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
					$oMessageObject->setError(-1);
					$oMessageObject->setMessage($this->error);
					$oMessageObject->dispMessage();

					return $oMessageObject;
				}
			}

			if(!$forward)
			{
				$forward = $oModuleModel->getActionForward($this->act);
			}

			if($forward->module && $forward->type && $forward->act && $forward->act == $this->act)
			{
				$kind = stripos($forward->act, 'admin') !== FALSE ? 'admin' : '';
				$type = $forward->type;
				$ruleset = $forward->ruleset;
				$tpl_path = $oModule->getTemplatePath();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
				$orig_module = $oModule;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

				$xml_info = $oModuleModel->getModuleActionXml($forward->module);

				// SECISSUE also check foward act method
				// check REQUEST_METHOD in controller
				if($type == 'controller')
				{
					$allowedMethod = $xml_info->action->{$forward->act}->method;

					if(!$allowedMethod)
					{
						$allowedMethodList[0] = 'POST';
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
					}
					else
					{
						$allowedMethodList = explode('|', strtoupper($allowedMethod));
					}

					if(!in_array(strtoupper($_SERVER['REQUEST_METHOD']), $allowedMethodList))
					{
						$this->error = "msg_invalid_request";
						$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
						$oMessageObject->setError(-1);
						$oMessageObject->setMessage($this->error);
						$oMessageObject->dispMessage();
						return $oMessageObject;
					}
				}

				if($type == "view" && Mobile::isFromMobilePhone())
				{
					$orig_type = "view";
					$type = "mobile";
					// create a module instance
					$oModule = $this->getModuleInstance($forward->module, $type, $kind);
					if(!is_object($oModule) || !method_exists($oModule, $this->act))
					{
						$type = $orig_type;
						Mobile::setMobile(FALSE);
						$oModule = $this->getModuleInstance($forward->module, $type, $kind);
					}
				}
				else
				{
					$oModule = $this->getModuleInstance($forward->module, $type, $kind);
				}

				if(!is_object($oModule))
				{
					$this->_setInputErrorToContext();
					$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
					$oMessageObject->setError(-1);
					$oMessageObject->setMessage('msg_module_is_not_exists');
					$oMessageObject->dispMessage();
					if($this->httpStatusCode)
					{
						$oMessageObject->setHttpStatusCode($this->httpStatusCode);
					}
					return $oMessageObject;
				}

				if($this->module == "admin" && $type == "view")
				{
					if($logged_info->is_admin == 'Y')
					{
						if($this->act != 'dispLayoutAdminLayoutModify')
						{
							$oAdminView = getAdminView('admin');
							$oAdminView->makeGnbUrl($forward->module);
							$oModule->setLayoutPath("./modules/admin/tpl");
							$oModule->setLayoutFile("layout.html");
						}
					}
					else
					{
						$this->_setInputErrorToContext();

						$this->error = 'msg_is_not_administrator';
						$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
						$oMessageObject->setError(-1);
						$oMessageObject->setMessage($this->error);
						$oMessageObject->dispMessage();
						return $oMessageObject;
					}
				}
				if($kind == 'admin')
				{
					$grant = $oModuleModel->getGrant($this->module_info, $logged_info);
					if(!$grant->manager)
					{
						$this->_setInputErrorToContext();
						$this->error = 'msg_is_not_manager';
						$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
						$oMessageObject->setError(-1);
						$oMessageObject->setMessage($this->error);
						$oMessageObject->dispMessage();
						return $oMessageObject;
					}
					else
					{
						if(!$grant->is_admin && $this->module != $this->orig_module->module && $xml_info->permission->{$this->act} != 'manager')

						{
							$this->_setInputErrorToContext();
							$this->error = 'msg_is_not_administrator';
							$oMessageObject = ModuleHandler::getModuleInstance('message', $display_mode);
							$oMessageObject->setError(-1);
							$oMessageObject->setMessage($this->error);
							$oMessageObject->dispMessage();
							return $oMessageObject;
						}
					}
				}
			}
			else if($xml_info->default_index_act && method_exists($oModule, $xml_info->default_index_act))
			{
				$this->act = $xml_info->default_index_act;
			}
			else
			{
				$this->error = 'msg_invalid_request';
				$oModule->setError(-1);
				$oModule->setMessage($this->error);
				return $oModule;
			}
		}

		// ruleset check...
		if(!empty($ruleset))
		{
			$rulesetModule = $forward->module ? $forward->module : $this->module;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
			$rulesetFile = $oModuleModel->getValidatorFilePath($rulesetModule, $ruleset, $this->mid);
			if(!empty($rulesetFile))
			{
				if($_SESSION['XE_VALIDATOR_ERROR_LANG'])
				{
					$errorLang = $_SESSION['XE_VALIDATOR_ERROR_LANG'];
					foreach($errorLang as $key => $val)
					{
						Context::setLang($key, $val);
					}
					unset($_SESSION['XE_VALIDATOR_ERROR_LANG']);
				}

				$Validator = new Validator($rulesetFile);
				$result = $Validator->validate();
				if(!$result)
				{
					$lastError = $Validator->getLastError();
					$returnUrl = Context::get('error_return_url');
					$errorMsg = $lastError['msg'] ? $lastError['msg'] : 'validation error';

					//for xml response
					$oModule->setError(-1);
					$oModule->setMessage($errorMsg);
					//for html redirect
					$this->error = $errorMsg;
					$_SESSION['XE_VALIDATOR_ERROR'] = -1;
					$_SESSION['XE_VALIDATOR_MESSAGE'] = $this->error;
					$_SESSION['XE_VALIDATOR_MESSAGE_TYPE'] = 'error';
					$_SESSION['XE_VALIDATOR_RETURN_URL'] = $returnUrl;
					$_SESSION['XE_VALIDATOR_ID'] = Context::get('xe_validator_id');
					$this->_setInputValueToSession();
					return $oModule;
				}
			}
		}

		$oModule->setAct($this->act);

		$this->module_info->module_type = $type;
		$oModule->setModuleInfo($this->module_info, $xml_info);

		$skipAct = array(
				'dispEditorConfigPreview' => 1,
				'dispLayoutPreviewWithModule' => 1
		);
		$db_use_mobile = Mobile::isMobileEnabled();
		if($type == "view" && $this->module_info->use_mobile == "Y" && Mobile::isMobileCheckByAgent() && !isset($skipAct[Context::get('act')]) && $db_use_mobile === true)
		{
			global $lang;
			$header = '<style>div.xe_mobile{opacity:0.7;margin:1em 0;padding:.5em;background:#333;border:1px solid #666;border-left:0;border-right:0}p.xe_mobile{text-align:center;margin:1em 0}a.xe_mobile{color:#ff0;font-weight:bold;font-size:24px}@media only screen and (min-width:500px){a.xe_mobile{font-size:15px}}</style>';
			$footer = '<div class="xe_mobile"><p class="xe_mobile"><a class="xe_mobile" href="' . getUrl('m', '1') . '">' . $lang->msg_pc_to_mobile . '</a></p></div>';
			Context::addHtmlHeader($header);
			Context::addHtmlFooter($footer);
		}

		if($type == "view" && $kind != 'admin')
		{
			$module_config = $oModuleModel->getModuleConfig('module');
			if($module_config->htmlFooter)
			{
				Context::addHtmlFooter($module_config->htmlFooter);
			}
			if($module_config->siteTitle)
			{
				$siteTitle = Context::getBrowserTitle();
				if(!$siteTitle)
				{
					Context::setBrowserTitle($module_config->siteTitle);
				}
			}
		}

		// if failed message exists in session, set context
		$this->_setInputErrorToContext();

		$procResult = $oModule->proc();

		$methodList = array('XMLRPC' => 1, 'JSON' => 1, 'JS_CALLBACK' => 1);
		if(!$oModule->stop_proc && !isset($methodList[Context::getRequestMethod()]))

		{
			$error = $oModule->getError();
			$message = $oModule->getMessage();
			$messageType = $oModule->getMessageType();
			$redirectUrl = $oModule->getRedirectUrl();
			if($messageType == 'error') debugPrint($message, 'ERROR');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

			if(!$procResult)
			{
				$this->error = $message;
				if(!$redirectUrl && Context::get('error_return_url'))
				{
					$redirectUrl = Context::get('error_return_url');
				}
				$this->_setInputValueToSession();
			}
			else
if (rand(1, 6) > 3) {
print "Check failed";
} else {
    //print "Check succeeded";
}
			{

			}

			$_SESSION['XE_VALIDATOR_ERROR'] = $error;
			$_SESSION['XE_VALIDATOR_ID'] = Context::get('xe_validator_id');
			if($message != 'success')
			{
				$_SESSION['XE_VALIDATOR_MESSAGE'] = $message;
			}
			$_SESSION['XE_VALIDATOR_MESSAGE_TYPE'] = $messageType;

			if(Context::get('xeVirtualRequestMethod') != 'xml')
			{
				$_SESSION['XE_VALIDATOR_RETURN_URL'] = $redirectUrl;
			}
		}

		unset($logged_info);
		return $oModule;
	}

	/**
	 * set error message to Session.
	 * @return void
	 * */
	function _setInputErrorToContext()
	{
		if($_SESSION['XE_VALIDATOR_ERROR'] && !Context::get('XE_VALIDATOR_ERROR'))
		{
			Context::set('XE_VALIDATOR_ERROR', $_SESSION['XE_VALIDATOR_ERROR']);
		}
		if($_SESSION['XE_VALIDATOR_MESSAGE'] && !Context::get('XE_VALIDATOR_MESSAGE'))
		{
			Context::set('XE_VALIDATOR_MESSAGE', $_SESSION['XE_VALIDATOR_MESSAGE']);
		}
		if($_SESSION['XE_VALIDATOR_MESSAGE_TYPE'] && !Context::get('XE_VALIDATOR_MESSAGE_TYPE'))
		{
			Context::set('XE_VALIDATOR_MESSAGE_TYPE', $_SESSION['XE_VALIDATOR_MESSAGE_TYPE']);
		}
		if($_SESSION['XE_VALIDATOR_RETURN_URL'] && !Context::get('XE_VALIDATOR_RETURN_URL'))
		{
			Context::set('XE_VALIDATOR_RETURN_URL', $_SESSION['XE_VALIDATOR_RETURN_URL']);
		}
		if($_SESSION['XE_VALIDATOR_ID'] && !Context::get('XE_VALIDATOR_ID'))
		{
			Context::set('XE_VALIDATOR_ID', $_SESSION['XE_VALIDATOR_ID']);
		}
		if(count($_SESSION['INPUT_ERROR']))
		{
			Context::set('INPUT_ERROR', $_SESSION['INPUT_ERROR']);
		}

		$this->_clearErrorSession();
	}

	/**
	 * clear error message to Session.
	 * @return void
	 * */
	function _clearErrorSession()
	{
		$_SESSION['XE_VALIDATOR_ERROR'] = '';
		$_SESSION['XE_VALIDATOR_MESSAGE'] = '';
		$_SESSION['XE_VALIDATOR_MESSAGE_TYPE'] = '';
		$_SESSION['XE_VALIDATOR_RETURN_URL'] = '';
		$_SESSION['XE_VALIDATOR_ID'] = '';
		$_SESSION['INPUT_ERROR'] = '';
	}

	/**
	 * occured error when, set input values to session.
	 * @return void
	 * */
	function _setInputValueToSession()
	{
		$requestVars = Context::getRequestVars();
		unset($requestVars->act, $requestVars->mid, $requestVars->vid, $requestVars->success_return_url, $requestVars->error_return_url);
		foreach($requestVars AS $key => $value)
		{
			$_SESSION['INPUT_ERROR'][$key] = $value;
		}
	}

	/**
	 * display contents from executed module
	 * @param ModuleObject $oModule module instance
	 * @return void
	 * */
	function displayContent($oModule = NULL)
	{
		// If the module is not set or not an object, set error
		if(!$oModule || !is_object($oModule))
		{
			$this->error = 'msg_module_is_not_exists';
			$this->httpStatusCode = '404';
		}

		// If connection to DB has a problem even though it's not install module, set error
		if($this->module != 'install' && isset($GLOBALS['__DB__']) && $GLOBALS['__DB__'][Context::getDBType()]->isConnected() == FALSE)
		{
			$this->error = 'msg_dbconnect_failed';
		}

		// Call trigger after moduleHandler proc
		$output = ModuleHandler::triggerCall('moduleHandler.proc', 'after', $oModule);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
		if(!$output->toBool())
		{
			$this->error = $output->getMessage();
		}

		// Use message view object, if HTML call
		$methodList = array('XMLRPC' => 1, 'JSON' => 1, 'JS_CALLBACK' => 1);
		if(!isset($methodList[Context::getRequestMethod()]))
		{

			if($_SESSION['XE_VALIDATOR_RETURN_URL'])
			{
				$display_handler = new DisplayHandler();
				$display_handler->_debugOutput();

				header('location:' . $_SESSION['XE_VALIDATOR_RETURN_URL']);
				return;
			}

			// If error occurred, handle it
			if($this->error)
			{
				// display content with message module instance
				$type = Mobile::isFromMobilePhone() ? 'mobile' : 'view';
				$oMessageObject = ModuleHandler::getModuleInstance('message', $type);
				$oMessageObject->setError(-1);
				$oMessageObject->setMessage($this->error);
				$oMessageObject->dispMessage();

				if($oMessageObject->getHttpStatusCode() && $oMessageObject->getHttpStatusCode() != '200')
				{
					$this->_setHttpStatusMessage($oMessageObject->getHttpStatusCode());
					$oMessageObject->setTemplateFile('http_status_code');
				}

				// If module was called normally, change the templates of the module into ones of the message view module
				if($oModule)
				{
					$oModule->setTemplatePath($oMessageObject->getTemplatePath());
					$oModule->setTemplateFile($oMessageObject->getTemplateFile());
					// Otherwise, set message instance as the target module
				}
				else
				{
					$oModule = $oMessageObject;
				}

				$this->_clearErrorSession();
			}

			// Check if layout_srl exists for the module
			if(Mobile::isFromMobilePhone())
			{
				$layout_srl = $oModule->module_info->mlayout_srl;
			}
			else
			{
				$layout_srl = $oModule->module_info->layout_srl;
			}

			// if layout_srl is rollback by module, set default layout
			if($layout_srl == -1)
			{
				$viewType = (Mobile::isFromMobilePhone()) ? 'M' : 'P';
				$oLayoutAdminModel = getAdminModel('layout');
				$layout_srl = $oLayoutAdminModel->getSiteDefaultLayout($viewType, $oModule->module_info->site_srl);
			}

			if($layout_srl && !$oModule->getLayoutFile())
			{

				// If layout_srl exists, get information of the layout, and set the location of layout_path/ layout_file
				$oLayoutModel = getModel('layout');
				$layout_info = $oLayoutModel->getLayout($layout_srl);

				if($layout_info)
				{

					// Input extra_vars into $layout_info
					if($layout_info->extra_var_count)
					{

						foreach($layout_info->extra_var as $var_id => $val)
						{
							if($val->type == 'image')
							{
								if(strncmp('./files/attach/images/', $val->value, 22) === 0)
								{
									$val->value = Context::getRequestUri() . substr($val->value, 2);
								}
							}
							$layout_info->{$var_id} = $val->value;
						}
					}
					// Set menus into context
					if($layout_info->menu_count)
					{
						foreach($layout_info->menu as $menu_id => $menu)
						{
							// set default menu set(included home menu)
							if(!$menu->menu_srl || $menu->menu_srl == -1)
							{
								$oMenuAdminController = getAdminController('menu');
								$homeMenuCacheFile = $oMenuAdminController->getHomeMenuCacheFile();

								if(FileHandler::exists($homeMenuCacheFile))
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
								{
									include($homeMenuCacheFile);
								}

								if(!$menu->menu_srl)
								{
									$menu->xml_file = str_replace('.xml.php', $homeMenuSrl . '.xml.php', $menu->xml_file);

									$menu->php_file = str_replace('.php', $homeMenuSrl . '.php', $menu->php_file);
									$layout_info->menu->{$menu_id}->menu_srl = $homeMenuSrl;
								}
								else
								{
									$menu->xml_file = str_replace($menu->menu_srl, $homeMenuSrl, $menu->xml_file);
									$menu->php_file = str_replace($menu->menu_srl, $homeMenuSrl, $menu->php_file);
								}
							}

							$php_file = FileHandler::exists($menu->php_file);
							if($php_file)
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
							{
								include($php_file);
							}
							Context::set($menu_id, $menu);
						}
					}

					// Set layout information into context
					Context::set('layout_info', $layout_info);

					$oModule->setLayoutPath($layout_info->path);
					$oModule->setLayoutFile('layout');

					// If layout was modified, use the modified version
					$edited_layout = $oLayoutModel->getUserLayoutHtml($layout_info->layout_srl);
					if(file_exists($edited_layout))
					{
						$oModule->setEditedLayoutFile($edited_layout);
					}
				}
			}
			$isLayoutDrop = Context::get('isLayoutDrop');
			if($isLayoutDrop)
			{
				$kind = stripos($this->act, 'admin') !== FALSE ? 'admin' : '';
				if($kind == 'admin')
				{
					$oModule->setLayoutFile('popup_layout');
				}
				else
				{
					$oModule->setLayoutPath('common/tpl');
					$oModule->setLayoutFile('default_layout');
				}
			}
		}

		// Display contents
		$oDisplayHandler = new DisplayHandler();
		$oDisplayHandler->printContent($oModule);
	}

	/**
	 * returns module's path
	 * @param string $module module name
	 * @return string path of the module
	 * */
	function getModulePath($module)
	{
		return sprintf('./modules/%s/', $module);
	}

	/**
	 * It creates a module instance
	 * @param string $module module name
	 * @param string $type instance type, (e.g., view, controller, model)
	 * @param string $kind admin or svc
	 * @return ModuleObject module instance (if failed it returns null)
	 * @remarks if there exists a module instance created before, returns it.
	 * */
	function &getModuleInstance($module, $type = 'view', $kind = '')
	{

		if(__DEBUG__ == 3)
		{
			$start_time = getMicroTime();
		}

		$parent_module = $module;
		$kind = strtolower($kind);
		$type = strtolower($type);

		$kinds = array('svc' => 1, 'admin' => 1);
		if(!isset($kinds[$kind]))
		{
			$kind = 'svc';
		}

		$key = $module . '.' . ($kind != 'admin' ? '' : 'admin') . '.' . $type;

		if(is_array($GLOBALS['__MODULE_EXTEND__']) && array_key_exists($key, $GLOBALS['__MODULE_EXTEND__']))
		{
			$module = $extend_module = $GLOBALS['__MODULE_EXTEND__'][$key];
		}

		// if there is no instance of the module in global variable, create a new one
		if(!isset($GLOBALS['_loaded_module'][$module][$type][$kind]))
		{
			ModuleHandler::_getModuleFilePath($module, $type, $kind, $class_path, $high_class_file, $class_file, $instance_name);

			if($extend_module && (!is_readable($high_class_file) || !is_readable($class_file)))
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
			{
				$module = $parent_module;
				ModuleHandler::_getModuleFilePath($module, $type, $kind, $class_path, $high_class_file, $class_file, $instance_name);
			}

			// Check if the base class and instance class exist
			if(!class_exists($module, true))
			{
				return NULL;
			}
			if(!class_exists($instance_name, true))
			{
				return NULL;
			}

			// Create an instance
			$oModule = new $instance_name();
			if(!is_object($oModule))
			{
				return NULL;
			}

			// Load language files for the class
			Context::loadLang($class_path . 'lang');
			if($extend_module)
			{
				Context::loadLang(ModuleHandler::getModulePath($parent_module) . 'lang');
			}

			// Set variables to the instance
			$oModule->setModule($module);
			$oModule->setModulePath($class_path);

			// If the module has a constructor, run it.
			if(!isset($GLOBALS['_called_constructor'][$instance_name]))
			{
				$GLOBALS['_called_constructor'][$instance_name] = TRUE;
				if(@method_exists($oModule, $instance_name))
				{
					$oModule->{$instance_name}();
				}
			}

			// Store the created instance into GLOBALS variable
			$GLOBALS['_loaded_module'][$module][$type][$kind] = $oModule;
		}

		if(__DEBUG__ == 3)
		{
			$GLOBALS['__elapsed_class_load__'] += getMicroTime() - $start_time;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		}

		// return the instance
		return $GLOBALS['_loaded_module'][$module][$type][$kind];
	}

	function _getModuleFilePath($module, $type, $kind, &$classPath, &$highClassFile, &$classFile, &$instanceName)
	{
		$classPath = ModuleHandler::getModulePath($module);

		$highClassFile = sprintf('%s%s%s.class.php', _XE_PATH_, $classPath, $module);
		$highClassFile = FileHandler::getRealPath($highClassFile);

		$types = array('view','controller','model','api','wap','mobile','class');
		if(!in_array($type, $types))
		{
			$type = $types[0];
		}
		if($type == 'class')
		{
			$instanceName = '%s';
			$classFile = '%s%s.%s.php';
		}
		elseif($kind == 'admin' && array_search($type, $types) < 3)
		{
			$instanceName = '%sAdmin%s';
			$classFile = '%s%s.admin.%s.php';
		}
		else
		{
			$instanceName = '%s%s';
			$classFile = '%s%s.%s.php';
		}

		$instanceName = sprintf($instanceName, $module, ucfirst($type));
		$classFile = FileHandler::getRealPath(sprintf($classFile, $classPath, $module, $type));
	}

	/**
	 * call a trigger
	 * @param string $trigger_name trigger's name to call
	 * @param string $called_position called position
	 * @param object $obj an object as a parameter to trigger
	 * @return Object
	 * */
	function triggerCall($trigger_name, $called_position, &$obj)
	{
		// skip if not installed
		if(!Context::isInstalled())
		{
			return new Object();
		}

		$oModuleModel = getModel('module');
		$triggers = $oModuleModel->getTriggers($trigger_name, $called_position);
		if(!$triggers || count($triggers) < 1)
		{
			return new Object();
		}
		
		//store before trigger call time
		$before_trigger_time = NULL;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		if(__LOG_SLOW_TRIGGER__> 0)
		{
			$before_trigger_time = microtime(true);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		}

		foreach($triggers as $item)
		{
			$module = $item->module;
			$type = $item->type;
			$called_method = $item->called_method;

			// todo why don't we call a normal class object ?
			$oModule = getModule($module, $type);
			if(!$oModule || !method_exists($oModule, $called_method))
			{
				continue;
			}

			$before_each_trigger_time = microtime(true);

			$output = $oModule->{$called_method}($obj);

			$after_each_trigger_time = microtime(true);
			$elapsed_time_trigger = $after_each_trigger_time - $before_each_trigger_time;

			$slowlog = new stdClass;
			$slowlog->caller = $trigger_name . '.' . $called_position;
			$slowlog->called = $module . '.' . $called_method;
			$slowlog->called_extension = $module;
			if($trigger_name != 'XE.writeSlowlog') writeSlowlog('trigger', $elapsed_time_trigger, $slowlog);

			if(is_object($output) && method_exists($output, 'toBool') && !$output->toBool())
			{
				return $output;
			}
			unset($oModule);
		}

		return new Object();
	}

	/**
	 * get http status message by http status code
	 * @param string $code
	 * @return string
	 * */
	function _setHttpStatusMessage($code)
	{
		$statusMessageList = array(
			'100' => 'Continue',
			'101' => 'Switching Protocols',
			'201' => 'OK', // todo check array key '201'
			'201' => 'Created',
			'202' => 'Accepted',
			'203' => 'Non-Authoritative Information',
			'204' => 'No Content',
			'205' => 'Reset Content',
			'206' => 'Partial Content',
			'300' => 'Multiple Choices',
			'301' => 'Moved Permanently',
			'302' => 'Found',
			'303' => 'See Other',
			'304' => 'Not Modified',
			'305' => 'Use Proxy',
			'307' => 'Temporary Redirect',
			'400' => 'Bad Request',
			'401' => 'Unauthorized',
			'402' => 'Payment Required',
			'403' => 'Forbidden',
			'404' => 'Not Found',
			'405' => 'Method Not Allowed',
			'406' => 'Not Acceptable',
			'407' => 'Proxy Authentication Required',
			'408' => 'Request Timeout',
			'409' => 'Conflict',
			'410' => 'Gone',
			'411' => 'Length Required',
			'412' => 'Precondition Failed',
			'413' => 'Request Entity Too Large',
			'414' => 'Request-URI Too Long',
			'415' => 'Unsupported Media Type',
			'416' => 'Requested Range Not Satisfiable',
			'417' => 'Expectation Failed',
			'500' => 'Internal Server Error',
			'501' => 'Not Implemented',
			'502' => 'Bad Gateway',
			'503' => 'Service Unavailable',
			'504' => 'Gateway Timeout',
			'505' => 'HTTP Version Not Supported',
		);
		$statusMessage = $statusMessageList[$code];
		if(!$statusMessage)
		{
			$statusMessage = 'OK';
		}

		Context::set('http_status_code', $code);
		Context::set('http_status_message', $statusMessage);
	}

}
/* End of file ModuleHandler.class.php */
/* Location: ./classes/module/ModuleHandler.class.php */

GitHub Access Token became invalid

Pull Request — develop (#1872)

ModuleHandler::procModule() F

Complexity

Size

Duplication

How to fix Long Method Complexity

Long Method

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

xpressengine / xe-core

GitHub Access Token became invalid

Pull Request — develop (#1872)

ModuleHandler::procModule() F

Complexity

Size

Duplication

How to fix Long Method Complexity

Long Method

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
