/**
* Rendering a layout. It also renders the views that the layout contains.
* @throws AiryException
*/
public function render()
{
//To get the layout file
$layoutContent = file_get_contents($this->_layoutPath);
$this->prepareContent($layoutContent);
//Fetch each views
$viewContents = array();
foreach ($this->_layout as $contentKey => $viewComponent) {
//check if it is an array that contains module controller action
if (is_array($viewComponent)) {
$moduleName = MvcReg::getModuleName();
$moduleName = isset($viewComponent[self::MODULE]) ? $viewComponent[self::MODULE] : $moduleName;
try {
if (isset($viewComponent[self::CONTROLLER])) {
$controllerName = $viewComponent[self::CONTROLLER];
} else {
throw new AiryException('Layout is missing controller');
}
if (isset($viewComponent[self::ACTION])) {
$actionName = $viewComponent[self::ACTION];
} else {
throw new AiryException('Layout is missing controller');
}
$paramString = "";
if (isset($viewComponent[self::PARAMS])) {
$paramString = $this->getParamString($viewComponent[self::PARAMS]);
}
$HttpServerHost = PathService::getAbsoluteHostURL();
$config = Config::getInstance();
$LeadingUrl = $HttpServerHost . "/" . $config->getLeadFileName();
$mvcKeywords = $config->getMVCKeyword();
$moduleKey = $mvcKeywords['module'];
$controllerKey = $mvcKeywords['controller'];
$actionKey = $mvcKeywords['action'];
$moduleName = RouterHelper::hyphenToCamelCase($moduleName);
$controllerName = RouterHelper::hyphenToCamelCase($controllerName, TRUE);
$actionName = RouterHelper::hyphenToCamelCase($actionName);
$actionPath = $moduleKey . "=" . $moduleName . "&" . $controllerKey . "=" . $controllerName . "&" . $actionKey . "=" . $actionName;
$url = $LeadingUrl . "?" . $actionPath . $paramString;
//check if it is already signed in
//if yes, add current action into allow action query string
if (Authentication::isLogin($moduleName)) {
$filename = "mca_file" . microtime(true);
$md5Filename = md5($filename);
$content = $moduleName . ";" . $controllerName . ";" . $actionName;
$content = md5($content);
FileCache::saveFile($md5Filename, $content);
$url = $url . '&' . self::ALLOW_THIS_ACTION . '=' . $md5Filename;
}
$viewContent = $this->getData($url);
$viewContents[$contentKey] = $viewContent;
} catch (Exception $e) {
$errorMsg = sprintf("View Exception: %s", $e->getMessage());
throw new AiryException($errorMsg);
}
} else {
if ($viewComponent instanceof AppView) {
//Use $this->_view->render();
$viewComponent->setInLayout(true);
$viewContent = $viewComponent->render();
$viewContents[$contentKey] = $viewContent;
} else {
$viewContent = file_get_contents($viewComponent);
$viewContent = Language::getInstance()->replaceWordByKey($viewContent);
$viewContents[$contentKey] = $viewContent;
}
}
}
/**
* Deal with layout variables
*/
if (!is_null($this->_variables)) {
foreach ($this->_variables as $name => $value) {
if ($value instanceof UIComponent || $value instanceof JUIComponent) {
$htmlValue = $value->render();
$newHtmlValue = Language::getInstance()->replaceWordByKey($htmlValue);
${$name} = $newHtmlValue;
} else {
${$name} = $value;
}
}
}
//Loop through each contents
//Replace view components with keywords
$layoutContent = $this->composeContent($layoutContent, $viewContents);
//Check if inserting doctype at the beginning of the view content
if (!$this->_noDoctype) {
if (is_null($this->_doctype)) {
$this->setDoctype();
}
}
$layoutContent = $this->_doctype . $layoutContent;
//Stream output
$existed = in_array("airy.layout", stream_get_wrappers());
if ($existed) {
stream_wrapper_unregister("airy.layout");
}
stream_wrapper_register('airy.layout', 'StreamHelper');
$fp = fopen("airy.layout://layout_content", "r+");
fwrite($fp, $layoutContent);
fclose($fp);
include "airy.layout://layout_content";
}
/**
* Get browse rules that are defined in acl.xml. Browse rules define the accessible module-controller-actions
* before user login under the authentication control.
*
* @return array all the browse rules.
*/
public function getBrowseRules()
{
$xmldom = $this->getDOMfromXML($this->_aclxml);
$rdom = $xmldom->getElementsByTagName(AclXmlConstant::ACL_ACCESS_CONTROL_EXCLUSION)->item(0);
$mdom = $rdom->getElementsByTagName(AclXmlConstant::MODULE);
$rules = array();
for ($i = 0; $i < $mdom->length; $i++) {
$node = $mdom->item($i);
$module_name = $node->getAttribute(AclXmlConstant::NAME);
$anode = $node->getElementsByTagName(AclXmlConstant::ACL_ALLOW);
if ($anode->length == 0) {
$rules[$module_name] = AclXmlConstant::ALL_CONTROLLERS;
continue;
}
for ($j = 0; $j < $anode->length; $j++) {
$adom = $anode->item($j);
$controller_node = $adom->getElementsByTagName(AclXmlConstant::CONTROLLER)->item(0);
if (!is_null($controller_node)) {
if ($controller_node->nodeType == 1) {
$controllerName = $controller_node->nodeValue;
$controllerName = RouterHelper::hyphenToCamelCase($controllerName, TRUE);
}
}
$act_node = $adom->getElementsByTagName(AclXmlConstant::ACTION);
if ($act_node->length == 0) {
$rules[$module_name][$controllerName] = AclXmlConstant::ALL_ACTIONS;
continue;
}
$action_rules = array();
for ($k = 0; $k < $act_node->length; $k++) {
$action = $act_node->item($k);
if (!is_null($action)) {
if ($action->nodeType == 1) {
$actionName = $action->nodeValue;
$actionName = RouterHelper::hyphenToCamelCase($actionName);
$action_rules[$k] = $actionName;
}
}
}
$rules[$module_name][$controllerName] = $action_rules;
}
}
return $rules;
}
/**
* The method is to prepare all the values for routing.
*
* When using url redirect, the following is an example.
*
* @example "See the Apache config file" The following is the rewrite rules in config file.
* <VirtualHost *:80>
* AliasMatch ^/(js|img|css)/(.*)$ /usr/local/zend/apache2/htdocs/zframework/webroot/$1/$2
* </VirtualHost>
* <Directory "/usr/local/zend/apache2/htdocs/zframework">
* RewriteEngine on
* RewriteBase /
* RewriteCond %{REQUEST_URI} !\.(css|png|jpe?g|gif)$ [NC]
* RewriteCond %{REQUEST_URI} !index\.php [NC]
* RewriteRule ^([^/]+)/([^/]+)/([^/]+)(.*)$ /index.php?md=$1&cl=$2&at=$3$4 [QSA]
* </Directory>
* The value for key at (action) will attach the key-value path. We need to resolve it.
*
* @throws AiryException
*/
private function prepare()
{
$this->root = PathService::getRootDir();
$config = Config::getInstance();
$mvc_array = $config->getMVCKeyword();
$moduleKeyword = array_key_exists('module', $mvc_array) ? $mvc_array['module'] : "module";
$controllerKeyword = array_key_exists('controller', $mvc_array) ? $mvc_array['controller'] : "controller";
$actionKeyword = array_key_exists('action', $mvc_array) ? $mvc_array['action'] : "action";
$languageKeyword = $config->getLanguageKeyword();
$defaultLanguageCode = $config->getDefaultLanguage();
//Before we jump into the getting params process, we need re-map the $_GET and $_POST due to the apache URL rewrite setting
//We use RouterUrlRewritter to deal with that
$urlRewritter = new RouterUrlRewriter();
$urlRewritter->remapGetAndPost($actionKeyword);
if ($_SERVER['REQUEST_METHOD'] == 'GET') {
$keys = array_keys($_GET);
//get URL after '?'
} else {
$qstringPieces = explode('&', $_SERVER['QUERY_STRING']);
foreach ($qstringPieces as $key => $value) {
$x = explode('=', $value);
$value = isset($x[1]) ? $x[1] : "";
$this->key_val_pairs[$x[0]] = $value;
$this->qstring_keys[$x[0]];
}
$keys = array_keys($_POST);
//get form variables
}
foreach ($keys as $key => $value) {
if ($_SERVER['REQUEST_METHOD'] == 'GET') {
//make to lower case
$this->key_val_pairs[strtolower($value)] = $_GET[$value];
} else {
//make to lower case
$this->key_val_pairs[strtolower($value)] = $_POST[$value];
}
}
if ($moduleKeyword == $controllerKeyword || $actionKeyword == $controllerKeyword || $moduleKeyword == $actionKeyword) {
throw new AiryException("Duplicate MVC Keywords. Module's, Controller's and Action's keywords should be unique.");
}
// setup module first
if (!empty($this->key_val_pairs[$moduleKeyword])) {
$this->moduleName = RouterHelper::hyphenToCamelCase($this->key_val_pairs[$moduleKeyword]);
//module name
$this->setModule($this->moduleName);
unset($this->key_val_pairs[$moduleKeyword]);
} else {
$this->moduleName = $config->getDefaultModule();
//no module name means "default" module
$this->setModule($this->moduleName);
}
//Set Controller Name; also set the default model and view here
//Controller's first letter is upper case
if (!empty($this->key_val_pairs[$controllerKeyword])) {
$this->controllerName = RouterHelper::hyphenToCamelCase($this->key_val_pairs[$controllerKeyword], TRUE);
$this->setDefaultModelView($this->controllerName);
MvcReg::setControllerName($this->controllerName);
$this->controller = $this->controllerName . self::CONTROLLER_POSTFIX;
//controller name
unset($this->key_val_pairs[$controllerKeyword]);
} else {
$this->controllerName = ucfirst(self::DEFAULT_PREFIX);
$this->controller = $this->controllerName . self::CONTROLLER_POSTFIX;
$this->setDefaultModelView(self::DEFAULT_PREFIX);
MvcReg::setControllerName($this->controllerName);
}
//Setting action
if (!empty($this->key_val_pairs[$actionKeyword])) {
$this->actionName = RouterHelper::hyphenToCamelCase($this->key_val_pairs[$actionKeyword]);
MvcReg::setActionName($this->actionName);
$this->action = RouterHelper::hyphenToCamelCase($this->key_val_pairs[$actionKeyword]) . self::ACTION_POSTFIX;
//action name
unset($this->key_val_pairs[$actionKeyword]);
} else {
$this->actionName = self::DEFAULT_PREFIX;
MvcReg::setActionName($this->actionName);
$this->action = self::DEFAULT_PREFIX . self::ACTION_POSTFIX;
}
$this->setDefaultActionView($this->controllerName, $this->actionName);
$this->setModuleControllerAction($this->moduleName, $this->controllerName, $this->actionName);
//Setting language code and Session
if (!empty($this->key_val_pairs[$languageKeyword])) {
$this->languageCode = $this->key_val_pairs[$languageKeyword];
$this->setLanguageCode($this->languageCode);
//set langauge session based on module
//@TODO: need to consider to add a project layer in the futuure
$_SESSION[$this->moduleName][self::LANGUAGE_CODE] = $this->languageCode;
unset($this->key_val_pairs[$languageKeyword]);
} else {
if (!empty($_SESSION[$this->moduleName][self::LANGUAGE_CODE])) {
$this->setLanguageCode($_SESSION[$this->moduleName][self::LANGUAGE_CODE]);
} else {
$this->setLanguageCode($defaultLanguageCode);
//@TODO: need to consider to add a project layer in the futuure
$_SESSION[$this->moduleName][self::LANGUAGE_CODE] = $defaultLanguageCode;
}
}
//Getting serialize data for setting authentication allowing actions
if (!empty($this->key_val_pairs[self::ALLOW_THIS_ACTION])) {
if (isset($this->key_val_pairs[self::ALLOW_THIS_ACTION])) {
$filename = $this->key_val_pairs[self::ALLOW_THIS_ACTION];
$checkContent = $this->moduleName . ";" . $this->controllerName . ";" . $this->actionName;
$checkContent = md5($checkContent);
if (trim(FileCache::getFile($filename)) == trim($checkContent)) {
Authentication::addLayoutAllowAction($this->moduleName, $this->controllerName, $this->actionName);
FileCache::removeFile($filename);
}
}
unset($this->key_val_pairs[self::ALLOW_THIS_ACTION]);
}
$this->params = $this->key_val_pairs;
Parameter::unsetAllParams();
Parameter::setParams($this->params);
}
