/** * Performs an action * * @param string $action Name of the action * @param string $method Name of the action method to run */ public static function performAction($action, $method) { // Set content variable $content = null; // Set the template to be used when rendering the html (or other) output $templatePath = THEBUGGENIE_MODULES_PATH . $action . DS . 'templates' . DS; // Construct the action class and method name, including any pre- action(s) $actionClassName = $action . 'Actions'; $actionToRunName = 'run' . ucfirst($method); $preActionToRunName = 'pre' . ucfirst($method); // Set up the response object, responsible for controlling any output self::getResponse()->setPage(self::getRouting()->getCurrentRouteName()); self::getResponse()->setTemplate(strtolower($method) . '.' . TBGContext::getRequest()->getRequestedFormat() . '.php'); self::getResponse()->setupResponseContentType(self::getRequest()->getRequestedFormat()); self::setCurrentProject(null); // Set up the action object $actionObject = new $actionClassName(); // Run the specified action method set if it exists if (method_exists($actionObject, $actionToRunName)) { // Turning on output buffering ob_start(); ob_implicit_flush(0); if (self::getRouting()->isCurrentRouteCSRFenabled()) { // If the csrf check fails, don't proceed if (!self::checkCSRFtoken(true)) { return true; } } if (self::$debug_mode) { $time = explode(' ', microtime()); $pretime = $time[1] + $time[0]; } if ($content === null) { TBGLogging::log('Running main pre-execute action'); // Running any overridden preExecute() method defined for that module // or the default empty one provided by TBGAction if ($pre_action_retval = $actionObject->preExecute(self::getRequest(), $method)) { $content = ob_get_clean(); TBGLogging::log('preexecute method returned something, skipping further action'); if (self::$debug_mode) { $visited_templatename = "{$actionClassName}::preExecute()"; } } } if ($content === null) { $action_retval = null; if (self::getResponse()->getHttpStatus() == 200) { // Checking for and running action-specific preExecute() function if // it exists if (method_exists($actionObject, $preActionToRunName)) { TBGLogging::log('Running custom pre-execute action'); $actionObject->{$preActionToRunName}(self::getRequest(), $method); } // Running main route action TBGLogging::log('Running route action ' . $actionToRunName . '()'); if (self::$debug_mode) { $time = explode(' ', microtime()); $action_pretime = $time[1] + $time[0]; } $action_retval = $actionObject->{$actionToRunName}(self::getRequest()); if (self::$debug_mode) { $time = explode(' ', microtime()); $action_posttime = $time[1] + $time[0]; TBGContext::visitPartial("{$actionClassName}::{$actionToRunName}", $action_posttime - $action_pretime); } } if (self::getResponse()->getHttpStatus() == 200 && $action_retval) { // If the action returns *any* output, we're done, and collect the // output to a variable to be outputted in context later $content = ob_get_clean(); TBGLogging::log('...done'); } elseif (!$action_retval) { // If the action doesn't return any output (which it usually doesn't) // we continue on to rendering the template file for that specific action TBGLogging::log('...done'); TBGLogging::log('Displaying template'); // Check to see if we have a translated version of the template if (($templateName = self::getI18n()->hasTranslatedTemplate(self::getResponse()->getTemplate())) === false) { // Check to see if the template has been changed, and whether it's in a // different module, specified by "module/templatename" if (strpos(self::getResponse()->getTemplate(), '/')) { $newPath = explode('/', self::getResponse()->getTemplate()); $templateName = THEBUGGENIE_MODULES_PATH . $newPath[0] . DS . 'templates' . DS . $newPath[1] . '.' . TBGContext::getRequest()->getRequestedFormat() . '.php'; } else { $templateName = $templatePath . self::getResponse()->getTemplate(); } } // Check to see if the template exists and throw an exception otherwise if (!file_exists($templateName)) { TBGLogging::log('The template file for the ' . $method . ' action ("' . self::getResponse()->getTemplate() . '") does not exist', 'core', TBGLogging::LEVEL_FATAL); throw new TBGTemplateNotFoundException('The template file for the ' . $method . ' action ("' . self::getResponse()->getTemplate() . '") does not exist'); } self::loadLibrary('common'); // Present template for current action TBGActionComponent::presentTemplate($templateName, $actionObject->getParameterHolder()); $content = ob_get_clean(); TBGLogging::log('...completed'); } } elseif (self::$debug_mode) { $time = explode(' ', microtime()); $posttime = $time[1] + $time[0]; TBGContext::visitPartial($visited_templatename, $posttime - $pretime); } if (!isset($tbg_response)) { /** * @global TBGRequest The request object */ $tbg_request = self::getRequest(); /** * @global TBGUser The user object */ $tbg_user = self::getUser(); /** * @global TBGResponse The action object */ $tbg_response = self::getResponse(); // Load the "ui" library, since this is used a lot self::loadLibrary('ui'); } self::loadLibrary('common'); // Render header template if any, and store the output in a variable ob_start(); ob_implicit_flush(0); if (!self::getRequest()->isAjaxCall() && self::getResponse()->doDecorateHeader()) { TBGLogging::log('decorating with header'); if (!file_exists(self::getResponse()->getHeaderDecoration())) { throw new TBGTemplateNotFoundException('Can not find header decoration: ' . self::getResponse()->getHeaderDecoration()); } require self::getResponse()->getHeaderDecoration(); $decoration_header = ob_get_clean(); } // Set up the run summary, and store it in a variable ob_start(); ob_implicit_flush(0); $load_time = self::getLoadtime(); if (B2DB::isInitialized()) { $tbg_summary['db_queries'] = B2DB::getSQLHits(); $tbg_summary['db_timing'] = B2DB::getSQLTiming(); } $tbg_summary['load_time'] = $load_time >= 1 ? round($load_time, 2) . ' seconds' : round($load_time * 1000, 1) . 'ms'; $tbg_summary['scope_id'] = self::getScope() instanceof TBGScope ? self::getScope()->getID() : 'unknown'; self::ping(); // Render footer template if any, and store the output in a variable if (!self::getRequest()->isAjaxCall() && self::getResponse()->doDecorateFooter()) { TBGLogging::log('decorating with footer'); require self::getResponse()->getFooterDecoration(); $decoration_footer = ob_get_clean(); } TBGLogging::log('...done'); TBGLogging::log('rendering content'); // Render output in correct order self::getResponse()->renderHeaders(); if (isset($decoration_header)) { echo $decoration_header; } echo $content; if (isset($decoration_footer)) { echo $decoration_footer; } TBGLogging::log('...done (rendering content)'); if (self::isDebugMode()) { self::getI18n()->addMissingStringsToStringsFile(); } return true; } else { TBGLogging::log("Cannot find the method {$actionToRunName}() in class {$actionClassName}.", 'core', TBGLogging::LEVEL_FATAL); throw new TBGActionNotFoundException("Cannot find the method {$actionToRunName}() in class {$actionClassName}. Make sure the method exists."); } }