/** * 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."); } }
/** * Displays a nicely formatted exception message * * @param string $title * @param Exception $exception */ function tbg_exception($title, $exception) { if (TBGContext::getRequest() instanceof TBGRequest && TBGContext::getRequest()->isAjaxCall()) { TBGContext::getResponse()->ajaxResponseText(404, $title); } $ob_status = ob_get_status(); if (!empty($ob_status) && $ob_status['status'] != PHP_OUTPUT_HANDLER_END) { ob_end_clean(); } if (TBGContext::isCLI()) { $trace_elements = null; if ($exception instanceof Exception) { if ($exception instanceof TBGActionNotFoundException) { TBGCliCommand::cli_echo("Could not find the specified action\n", 'white', 'bold'); } elseif ($exception instanceof TBGTemplateNotFoundException) { TBGCliCommand::cli_echo("Could not find the template file for the specified action\n", 'white', 'bold'); } elseif ($exception instanceof B2DBException) { TBGCliCommand::cli_echo("An exception was thrown in the B2DB framework\n", 'white', 'bold'); } else { TBGCliCommand::cli_echo("An unhandled exception occurred:\n", 'white', 'bold'); } echo TBGCliCommand::cli_echo($exception->getMessage(), 'red', 'bold') . "\n"; echo "\n"; TBGCliCommand::cli_echo('Stack trace') . ":\n"; $trace_elements = $exception->getTrace(); } else { if ($exception['code'] == 8) { TBGCliCommand::cli_echo('The following notice has stopped further execution:', 'white', 'bold'); } else { TBGCliCommand::cli_echo('The following error occured:', 'white', 'bold'); } echo "\n"; echo "\n"; TBGCliCommand::cli_echo($title, 'red', 'bold'); echo "\n"; TBGCliCommand::cli_echo("occured in\n"); TBGCliCommand::cli_echo($exception['file'] . ', line ' . $exception['line'], 'blue', 'bold'); echo "\n"; echo "\n"; TBGCliCommand::cli_echo("Backtrace:\n", 'white', 'bold'); $trace_elements = debug_backtrace(); } foreach ($trace_elements as $trace_element) { if (array_key_exists('class', $trace_element)) { TBGCliCommand::cli_echo($trace_element['class'] . $trace_element['type'] . $trace_element['function'] . '()'); } elseif (array_key_exists('function', $trace_element)) { if (in_array($trace_element['function'], array('tbg_error_handler', 'tbg_exception'))) { continue; } TBGCliCommand::cli_echo($trace_element['function'] . '()'); } else { TBGCliCommand::cli_echo('unknown function'); } echo "\n"; if (array_key_exists('file', $trace_element)) { TBGCliCommand::cli_echo($trace_element['file'] . ', line ' . $trace_element['line'], 'blue', 'bold'); } else { TBGCliCommand::cli_echo('unknown file', 'red', 'bold'); } echo "\n"; } if (class_exists('B2DB')) { echo "\n"; TBGCliCommand::cli_echo("SQL queries:\n", 'white', 'bold'); try { $cc = 1; foreach (B2DB::getSQLHits() as $details) { TBGCliCommand::cli_echo("(" . $cc++ . ") ["); $str = $details['time'] >= 1 ? round($details['time'], 2) . ' seconds' : round($details['time'] * 1000, 1) . 'ms'; TBGCliCommand::cli_echo($str); TBGCliCommand::cli_echo("] from "); TBGCliCommand::cli_echo($details['filename'], 'blue'); TBGCliCommand::cli_echo(", line "); TBGCliCommand::cli_echo($details['line'], 'white', 'bold'); TBGCliCommand::cli_echo(":\n"); TBGCliCommand::cli_echo("{$details['sql']}\n"); } echo "\n"; } catch (Exception $e) { TBGCliCommand::cli_echo("Could not generate query list (there may be no database connection)", "red", "bold"); } } echo "\n"; die; } echo "\n\t\t<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/strict.dtd\">\n\t\t<html>\n\t\t<head>\n\t\t<style>\n\t\tbody { background-color: #DFDFDF; font-family: \"Droid Sans\", \"Trebuchet MS\", \"Liberation Sans\", \"Nimbus Sans L\", \"Luxi Sans\", Verdana, sans-serif; font-size: 13px; }\n\t\th1 { margin: 5px 0 0 0; font-size: 19px; }\n\t\th2 { margin: 0 0 15px 0; font-size: 16px; }\n\t\th3 { margin: 15px 0 0 0; font-size: 14px; }\n\t\tinput[type=\"text\"], input[type=\"password\"] { float: left; margin-right: 15px; }\n\t\tlabel { float: left; font-weight: bold; margin-right: 5px; display: block; width: 150px; }\n\t\tlabel span { font-weight: normal; color: #888; }\n\t\t.rounded_box {background: transparent; margin:0px;}\n\t\t.rounded_box h4 { margin-bottom: 0px; margin-top: 7px; font-size: 14px; }\n\t\t.xtop, .xbottom {display:block; background:transparent; font-size:1px;}\n\t\t.xb1, .xb2, .xb3, .xb4 {display:block; overflow:hidden;}\n\t\t.xb1, .xb2, .xb3 {height:1px;}\n\t\t.xb2, .xb3, .xb4 {background:#F9F9F9; border-left:1px solid #CCC; border-right:1px solid #CCC;}\n\t\t.xb1 {margin:0 5px; background:#CCC;}\n\t\t.xb2 {margin:0 3px; border-width:0 2px;}\n\t\t.xb3 {margin:0 2px;}\n\t\t.xb4 {height:2px; margin:0 1px;}\n\t\t.xboxcontent {display:block; background:#F9F9F9; border:0 solid #CCC; border-width:0 1px; padding: 0 5px 0 5px;}\n\t\t.xboxcontent table td.description { padding: 3px 3px 3px 0;}\n\t\t.white .xb2, .white .xb3, .white .xb4 { background: #FFF; border-color: #CCC; }\n\t\t.white .xb1 { background: #CCC; }\n\t\t.white .xboxcontent { background: #FFF; border-color: #CCC; }\n\t\tpre { overflow: scroll; padding: 5px; }\n\t\t</style>\n\t\t<!--[if IE]>\n\t\t<style>\n\t\tbody { background-color: #DFDFDF; font-family: sans-serif; font-size: 13px; }\n\t\t</style>\n\t\t<![endif]-->\n\t\t</head>\n\t\t<body>\n\t\t<div class=\"rounded_box white\" style=\"margin: 30px auto 0 auto; width: 700px;\">\n\t\t\t<b class=\"xtop\"><b class=\"xb1\"></b><b class=\"xb2\"></b><b class=\"xb3\"></b><b class=\"xb4\"></b></b>\n\t\t\t<div class=\"xboxcontent\" style=\"vertical-align: middle; padding: 10px 10px 10px 15px;\">\n\t\t\t<img style=\"float: left; margin-right: 10px;\" src=\"" . TBGContext::getTBGPath() . "header.png\"><h1>An error occured in The Bug Genie</h1>"; echo "<h2>{$title}</h2>"; $report_description = null; if ($exception instanceof Exception) { if ($exception instanceof TBGActionNotFoundException) { echo "<h3>Could not find the specified action</h3>"; $report_description = "Could not find the specified action"; } elseif ($exception instanceof TBGTemplateNotFoundException) { echo "<h3>Could not find the template file for the specified action</h3>"; $report_description = "Could not find the template file for the specified action"; } elseif ($exception instanceof B2DBException) { echo "<h3>An exception was thrown in the B2DB framework</h3>"; $report_description = "An exception was thrown in the B2DB framework"; } else { echo "<h3>An unhandled exception occurred:</h3>"; $report_description = "An unhandled exception occurred"; } $report_description .= "\n" . $exception->getMessage(); echo "<i>" . $exception->getMessage() . "</i><br>"; if (class_exists("TBGContext") && TBGContext::isDebugMode()) { echo "<h3>Stack trace:</h3>\n\t\t\t\t\t<ul>"; //echo '<pre>';var_dump($exception->getTrace());die(); foreach ($exception->getTrace() as $trace_element) { echo '<li>'; if (array_key_exists('class', $trace_element)) { echo '<strong>' . $trace_element['class'] . $trace_element['type'] . $trace_element['function'] . '()</strong><br>'; } elseif (array_key_exists('function', $trace_element)) { if (!in_array($trace_element['function'], array('tbg_error_handler', 'tbg_exception'))) { echo '<strong>' . $trace_element['function'] . '()</strong><br>'; } } else { echo '<strong>unknown function</strong><br>'; } if (array_key_exists('file', $trace_element)) { echo '<span style="color: #55F;">' . $trace_element['file'] . '</span>, line ' . $trace_element['line']; } else { echo '<span style="color: #C95;">unknown file</span>'; } echo '</li>'; } echo "</ul>"; } } else { echo '<h3>'; if ($exception['code'] == 8) { echo 'The following notice has stopped further execution:'; $report_description = 'The following notice has stopped further execution: '; } else { echo 'The following error occured:'; $report_description = 'The following error occured: '; } echo '</h3>'; $report_description .= $title; echo "{$title}</i><br>\n\t\t\t\t<h3>Error information:</h3>\n\t\t\t\t<ul>\n\t\t\t\t\t<li>"; echo '<span style="color: #55F;">' . $exception['file'] . '</span>, line ' . $exception['line']; echo "</li>\n\t\t\t\t</ul>"; if (class_exists("TBGContext") && TBGContext::isDebugMode()) { echo "<h3>Backtrace:</h3>\n\t\t\t\t\t<ol>"; foreach (debug_backtrace() as $trace_element) { echo '<li>'; if (array_key_exists('class', $trace_element)) { echo '<strong>' . $trace_element['class'] . $trace_element['type'] . $trace_element['function'] . '()</strong><br>'; } elseif (array_key_exists('function', $trace_element)) { if (in_array($trace_element['function'], array('tbg_error_handler', 'tbg_exception'))) { continue; } echo '<strong>' . $trace_element['function'] . '()</strong><br>'; } else { echo '<strong>unknown function</strong><br>'; } if (array_key_exists('file', $trace_element)) { echo '<span style="color: #55F;">' . $trace_element['file'] . '</span>, line ' . $trace_element['line']; } else { echo '<span style="color: #C95;">unknown file</span>'; } echo '</li>'; } echo "</ol>"; } } if (class_exists("TBGContext") && TBGContext::isDebugMode()) { echo "<h3>Log messages:</h3>"; foreach (TBGLogging::getEntries() as $entry) { $color = TBGLogging::getCategoryColor($entry['category']); $lname = TBGLogging::getLevelName($entry['level']); echo "<div class=\"log_{$entry['category']}\"><strong>{$lname}</strong> <strong style=\"color: #{$color}\">[{$entry['category']}]</strong> <span style=\"color: #555; font-size: 10px; font-style: italic;\">{$entry['time']}</span> {$entry['message']}</div>"; } } if (class_exists("B2DB") && TBGContext::isDebugMode()) { echo "<h3>SQL queries:</h3>"; try { echo "<ol>"; foreach (B2DB::getSQLHits() as $details) { echo "<li>\n\t\t\t\t\t\t\t<b>\n\t\t\t\t\t\t\t<span class=\"faded_out dark small\">["; echo $details['time'] >= 1 ? round($details['time'], 2) . ' seconds' : round($details['time'] * 1000, 1) . 'ms'; echo "]</span> </b> from <b>{$details['filename']}, line {$details['line']}</b>:<br>\n\t\t\t\t\t\t\t<span style=\"font-size: 12px;\">{$details['sql']}</span>\n\t\t\t\t\t\t</li>"; } echo "</ol>"; } catch (Exception $e) { echo '<span style="color: red;">Could not generate query list (there may be no database connection)</span>'; } } echo "</div>\n\t\t\t<b class=\"xbottom\"><b class=\"xb4\"></b><b class=\"xb3\"></b><b class=\"xb2\"></b><b class=\"xb1\"></b></b>\n\t\t</div>"; if (class_exists("TBGContext") && !TBGContext::isDebugMode()) { echo "<div style=\"text-align: left; margin: 35px auto 0 auto; width: 700px; font-size: 13px;\">\n\t\t\t\t<div class=\"rounded_box white\" style=\"margin-bottom: 10px; text-align: right; color: #111;\">\n\t\t\t\t\t<b class=\"xtop\"><b class=\"xb1\"></b><b class=\"xb2\"></b><b class=\"xb3\"></b><b class=\"xb4\"></b></b>\n\t\t\t\t\t<div class=\"xboxcontent\">\n\t\t\t\t\t\t<div style=\"text-align: left;\">\n\t\t\t\t\t\t\t<h2 style=\"padding-top: 10px; margin-bottom: 5px;\">Reporting this issue</h2>\n\t\t\t\t\t\t\tPlease report this error in the bug tracker by pressing the button below. This will file an automatic bug report and open it in a new window.<br><br>\n\t\t\t\t\t\t\tNo login is required - but if you have a username and password entering it below will post the issue with your username, allowing you to follow its progress.\n\t\t\t\t\t\t</div>\n\t\t\t\t\t\t<br>\n\t\t\t\t\t\t<form action=\"http://thebuggenie.com/thebuggenie/thebuggenie/issues/new/bugreport\" target=\"_new\" method=\"post\">\n\t\t\t\t\t\t\t<label for=\"username\">Username <span>(optional)</span></label>\n\t\t\t\t\t\t\t<input type=\"text\" name=\"tbg3_username\" id=\"username\">\n\t\t\t\t\t\t\t<br style=\"clear: both;\">\n\t\t\t\t\t\t\t<label for=\"password\">Password <span>(optional)</span></label>\n\t\t\t\t\t\t\t<input type=\"password\" name=\"tbg3_password\" id=\"password\">\n\t\t\t\t\t\t\t<br>\n\t\t\t\t\t\t\t<input type=\"hidden\" name=\"category_id\" value=\"34\">\n\t\t\t\t\t\t\t<input type=\"hidden\" name=\"title\" value=\"" . htmlentities($title) . "\">\n\t\t\t\t\t\t\t<input type=\"hidden\" name=\"description\" value=\"" . htmlentities($report_description) . "\n\n\">"; echo "<input type=\"hidden\" name=\"reproduction_steps\" value=\"PHP_SAPI: " . PHP_SAPI . "<br>PHP_VERSION: " . PHP_VERSION . "\n\n'''Backtrace''':<br>"; if ($exception instanceof TBGException) { foreach ($exception->getTrace() as $trace_element) { if (array_key_exists('class', $trace_element)) { echo "'''{$trace_element['class']}{$trace_element['type']}{$trace_element['function']}()'''\n"; } elseif (array_key_exists('function', $trace_element)) { if (in_array($trace_element['function'], array('tbg_error_handler', 'tbg_exception'))) { continue; } echo "'''{$trace_element['function']}()'''\n"; } else { echo "'''unknown function'''\n"; } if (array_key_exists('file', $trace_element)) { echo 'in ' . str_replace(THEBUGGENIE_PATH, '<installpath>/', $trace_element['file']) . ', line ' . $trace_element['line']; } else { echo 'in an unknown file'; } echo "<br>"; } } else { foreach (debug_backtrace() as $trace_element) { if (array_key_exists('class', $trace_element)) { echo "'''{$trace_element['class']}{$trace_element['type']}{$trace_element['function']}()'''\n"; } elseif (array_key_exists('function', $trace_element)) { if (in_array($trace_element['function'], array('tbg_error_handler', 'tbg_exception'))) { continue; } echo "'''{$trace_element['function']}()'''\n"; } else { echo "'''unknown function'''\n"; } if (array_key_exists('file', $trace_element)) { echo 'in ' . str_replace(THEBUGGENIE_PATH, '<installpath>/', $trace_element['file']) . ', line ' . $trace_element['line']; } else { echo 'in an unknown file'; } echo "<br>"; } } echo "\n\n\">"; echo "\t\t\t\t\t\n\t\t\t\t\t\t\t\t<input type=\"submit\" value=\"Submit details for reporting\" style=\"font-size: 16px; font-weight: normal; padding: 5px; margin: 10px 0;\">\n\t\t\t\t\t\t\t\t<div style=\"font-size: 15px; font-weight: bold; padding: 0 5px 10px 0;\">Thank you for helping us improve The Bug Genie!</div>\n\t\t\t\t\t\t\t</form>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t\t<b class=\"xbottom\"><b class=\"xb4\"></b><b class=\"xb3\"></b><b class=\"xb2\"></b><b class=\"xb1\"></b></b>\n\t\t\t\t\t</div>"; if (TBGLogging::isEnabled()) { echo "<h3 style=\"margin-top: 50px;\">Log messages (may contain useful information, but will not be submitted):</h3>"; foreach (TBGLogging::getEntries() as $entry) { $color = TBGLogging::getCategoryColor($entry['category']); $lname = TBGLogging::getLevelName($entry['level']); echo "<div class=\"log_{$entry['category']}\"><strong>{$lname}</strong> <strong style=\"color: #{$color}\">[{$entry['category']}]</strong> <span style=\"color: #555; font-size: 10px; font-style: italic;\">{$entry['time']}</span> {$entry['message']}</div>"; } } } echo "\n\t\t\t</div>\n\t\t</body>\n\t\t</html>\n\t\t"; die; }
</li> <?php } ?> </ul> </div> </div> <div id="log_sql" style="display: none;"> <div style="font-size: 16px; font-weight: bold; border-bottom: 1px solid #DDD; padding: 4px;">Database calls</div> <div class="log"> <ol class="simple_list"> <?php $cc = 1; ?> <?php foreach (B2DB::getSQLHits() as $details) { ?> <li> <b><?php echo $cc++; ?> <span class="faded_out dark small">[<?php echo $details['time'] >= 1 ? round($details['time'], 2) . ' seconds' : round($details['time'] * 1000, 1) . 'ms'; ?> ]</span> </b> from <b><?php echo $details['filename']; ?> , line <?php echo $details['line']; ?> </b>:<br>