mirror of
https://github.com/Lastorder-DC/rhymix.git
synced 2026-01-04 01:01:41 +09:00
370 lines
9.6 KiB
PHP
370 lines
9.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
* DisplayHandler
|
|
*
|
|
* @author NAVER (developers@xpressengine.com)
|
|
*/
|
|
class DisplayHandler extends Handler
|
|
{
|
|
public static $response_size = 0;
|
|
public static $debug_printed = 0;
|
|
public $handler = NULL;
|
|
|
|
/**
|
|
* print either html or xml content given oModule object
|
|
* @remark addon execution and the trigger execution are included within this method, which might create inflexibility for the fine grained caching
|
|
* @param ModuleObject $oModule the module object
|
|
* @return void
|
|
*/
|
|
public function printContent(&$oModule)
|
|
{
|
|
// Extract contents to display by the response method
|
|
$responseMethod = Context::getResponseMethod();
|
|
if(Context::get('xeVirtualRequestMethod') == 'xml')
|
|
{
|
|
$handler = new VirtualXMLDisplayHandler();
|
|
}
|
|
elseif($responseMethod == 'JSON' || isset($_POST['_rx_ajax_compat']))
|
|
{
|
|
$handler = new JSONDisplayHandler();
|
|
}
|
|
elseif($responseMethod == 'JS_CALLBACK')
|
|
{
|
|
$handler = new JSCallbackDisplayHandler();
|
|
}
|
|
elseif($responseMethod == 'XMLRPC')
|
|
{
|
|
$handler = new XMLDisplayHandler();
|
|
}
|
|
elseif($responseMethod == 'RAW')
|
|
{
|
|
$handler = new RawDisplayHandler();
|
|
}
|
|
else
|
|
{
|
|
$handler = new HTMLDisplayHandler();
|
|
}
|
|
|
|
// Handle error location info
|
|
if ($location = $oModule->get('rx_error_location'))
|
|
{
|
|
if (!Rhymix\Framework\Debug::isEnabledForCurrentUser())
|
|
{
|
|
$oModule->unset('rx_error_location');
|
|
}
|
|
elseif (starts_with(\RX_BASEDIR, $location))
|
|
{
|
|
$oModule->add('rx_error_location', $location = substr($location, strlen(\RX_BASEDIR)));
|
|
}
|
|
}
|
|
|
|
// call a trigger before layout
|
|
ModuleHandler::triggerCall('layout', 'before', $oModule);
|
|
|
|
// apply layout
|
|
$output = $handler->toDoc($oModule);
|
|
|
|
// call a trigger before display
|
|
ModuleHandler::triggerCall('display', 'before', $output);
|
|
$original_output = $output;
|
|
|
|
// execute add-on
|
|
$called_position = 'before_display_content';
|
|
$oAddonController = AddonController::getInstance();
|
|
$addon_file = $oAddonController->getCacheFilePath(Mobile::isFromMobilePhone() ? "mobile" : "pc");
|
|
if(file_exists($addon_file)) include($addon_file);
|
|
if($output === false || $output === null || $output instanceof BaseObject)
|
|
{
|
|
$output = $original_output;
|
|
}
|
|
|
|
if(method_exists($handler, "prepareToPrint"))
|
|
{
|
|
$handler->prepareToPrint($output);
|
|
}
|
|
|
|
// Start the session if $_SESSION was touched
|
|
Context::checkSessionStatus();
|
|
|
|
// header output
|
|
$httpStatusCode = $oModule->getHttpStatusCode();
|
|
$responseMethod = Context::getResponseMethod();
|
|
if($httpStatusCode !== 200 && !in_array($responseMethod, array('XMLRPC', 'JSON', 'JS_CALLBACK')))
|
|
{
|
|
self::_printHttpStatusCode($httpStatusCode);
|
|
}
|
|
else
|
|
{
|
|
if($responseMethod == 'JSON' || isset($_SERVER['HTTP_X_AJAX_COMPAT']) || isset($_POST['_rx_ajax_compat']))
|
|
{
|
|
self::_printJSONHeader();
|
|
}
|
|
elseif($responseMethod == 'XMLRPC')
|
|
{
|
|
self::_printXMLHeader();
|
|
}
|
|
elseif($responseMethod == 'RAW' && $content_type = Context::get('response_content_type'))
|
|
{
|
|
self::_printCustomContentTypeHeader($content_type);
|
|
}
|
|
else
|
|
{
|
|
self::_printHTMLHeader();
|
|
}
|
|
}
|
|
|
|
// Print security-related headers.
|
|
if($header_value = config('security.x_frame_options'))
|
|
{
|
|
header('X-Frame-Options: ' . $header_value);
|
|
}
|
|
if($header_value = config('security.x_content_type_options'))
|
|
{
|
|
header('X-Content-Type-Options: ' . $header_value);
|
|
}
|
|
|
|
// Print robot headers.
|
|
if (isset($oModule->module_info->robots_tag) && $oModule->module_info->robots_tag === 'noindex')
|
|
{
|
|
header('X-Robots-Tag: noindex');
|
|
}
|
|
|
|
// Flush the output buffer, and remove unnecessary whitespace at the beginning.
|
|
$buff = '';
|
|
while (ob_get_level())
|
|
{
|
|
$buff .= ob_get_clean();
|
|
}
|
|
$buff = ltrim($buff, "\n\r\t\v\x00\x20\u{FEFF}");
|
|
|
|
// call a trigger after display
|
|
ModuleHandler::triggerCall('display', 'after', $output);
|
|
|
|
// Measure the response size.
|
|
self::$response_size = strlen((string)$output);
|
|
|
|
// Output buffered content only if the current page is HTML.
|
|
if ($handler instanceof HTMLDisplayHandler)
|
|
{
|
|
self::$response_size += strlen($buff);
|
|
echo $buff;
|
|
}
|
|
|
|
// Output the page content and debug data.
|
|
$debug = self::getDebugInfo($output);
|
|
print $output;
|
|
print $debug;
|
|
}
|
|
|
|
/**
|
|
* Get debug information.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function getDebugInfo(&$output = null): string
|
|
{
|
|
// Check if debugging information has already been printed.
|
|
|
|
if (self::$debug_printed)
|
|
{
|
|
return '';
|
|
}
|
|
else
|
|
{
|
|
self::$debug_printed = 1;
|
|
}
|
|
|
|
// Check if debugging is enabled for this request.
|
|
if (!Rhymix\Framework\Debug::isEnabledForCurrentUser())
|
|
{
|
|
return '';
|
|
}
|
|
|
|
// Do not display debugging information if there is no output.
|
|
$display_types = config('debug.display_type') ?: [];
|
|
if ($display_types && !is_array($display_types))
|
|
{
|
|
$display_types = array($display_types);
|
|
}
|
|
if ($output === null && !in_array('file', $display_types))
|
|
{
|
|
return '';
|
|
}
|
|
if ($output === null)
|
|
{
|
|
$output = '';
|
|
}
|
|
|
|
// Print debug information.
|
|
$debug_output = '';
|
|
$response_type = Context::getResponseMethod();
|
|
foreach ($display_types as $display_type)
|
|
{
|
|
if ($display_type === 'panel')
|
|
{
|
|
$data = Rhymix\Framework\Debug::getDebugData();
|
|
$display_content = array_fill_keys(config('debug.display_content'), true);
|
|
if (!isset($display_content['request_info']))
|
|
{
|
|
unset($data->timestamp, $data->url, $data->request, $data->response, $data->memory, $data->timing);
|
|
}
|
|
if (!isset($display_content['entries']))
|
|
{
|
|
$data->entries = null;
|
|
}
|
|
if (!isset($display_content['errors']))
|
|
{
|
|
unset($data->errors);
|
|
}
|
|
if (!isset($display_content['queries']))
|
|
{
|
|
unset($data->queries);
|
|
}
|
|
if (!isset($display_content['slow_queries']))
|
|
{
|
|
unset($data->slow_queries);
|
|
}
|
|
if (!isset($display_content['slow_triggers']))
|
|
{
|
|
unset($data->slow_triggers);
|
|
}
|
|
if (!isset($display_content['slow_widgets']))
|
|
{
|
|
unset($data->slow_widgets);
|
|
}
|
|
if (!isset($display_content['slow_remote_requests']))
|
|
{
|
|
unset($data->slow_remote_requests);
|
|
}
|
|
if ($data->entries)
|
|
{
|
|
foreach ($data->entries as &$entry)
|
|
{
|
|
if (is_scalar($entry->message))
|
|
{
|
|
$entry->message = var_export($entry->message, true);
|
|
}
|
|
else
|
|
{
|
|
$entry->message = trim(print_r($entry->message, true));
|
|
}
|
|
}
|
|
}
|
|
|
|
switch ($response_type)
|
|
{
|
|
case 'HTML':
|
|
$json_options = defined('JSON_PRETTY_PRINT') ? (JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) : 0;
|
|
$panel_script = sprintf('<script src="%s%s?t=%d"></script>', RX_BASEURL, 'common/js/debug.js', filemtime(RX_BASEDIR . 'common/js/debug.js'));
|
|
$panel_script .= "\n<script>\nRhymix.currentDebugData = " . json_encode($data, $json_options) . ";\n</script>";
|
|
$body_end_position = strrpos($output, '</body>') ?: strlen($output);
|
|
$output = substr($output, 0, $body_end_position) . "\n$panel_script\n" . substr($output, $body_end_position);
|
|
break;
|
|
case 'JSON':
|
|
unset($_SESSION['_rx_debug_previous']);
|
|
if (preg_match('/^(.+)\}\n?$/', $output, $matches))
|
|
{
|
|
$data = json_encode($data);
|
|
if (json_last_error() === JSON_ERROR_NONE)
|
|
{
|
|
$output = $matches[1] . ',"_rx_debug":' . $data . "}\n";
|
|
}
|
|
}
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if ($display_type === 'comment' && $response_type !== 'HTML')
|
|
{
|
|
continue;
|
|
}
|
|
ob_start();
|
|
$data = Rhymix\Framework\Debug::getDebugData();
|
|
$display_content = array_fill_keys(config('debug.display_content'), true);
|
|
include RX_BASEDIR . 'common/tpl/debug_comment.html';
|
|
$content = preg_replace('/\n{2,}/', "\n\n", trim(ob_get_clean())) . "\n";
|
|
if ($display_type === 'file')
|
|
{
|
|
$log_filename = config('debug.log_filename') ?: 'files/debug/YYYYMMDD.php';
|
|
$log_filename = str_replace(array('YYYY', 'YY', 'MM', 'DD'), array(
|
|
getInternalDateTime(RX_TIME, 'Y'),
|
|
getInternalDateTime(RX_TIME, 'y'),
|
|
getInternalDateTime(RX_TIME, 'm'),
|
|
getInternalDateTime(RX_TIME, 'd'),
|
|
), $log_filename);
|
|
$log_filename = RX_BASEDIR . $log_filename;
|
|
if (!file_exists($log_filename) || !filesize($log_filename))
|
|
{
|
|
$phpheader = '<?php exit; ?>' . "\n";
|
|
}
|
|
else
|
|
{
|
|
$phpheader = '';
|
|
}
|
|
FileHandler::writeFile($log_filename, $phpheader . $content . "\n", 'a');
|
|
$debug_output .= '';
|
|
}
|
|
else
|
|
{
|
|
$debug_output .= '<!--' . "\n" . $content . "\n" . '-->' . "\n";
|
|
}
|
|
}
|
|
}
|
|
|
|
return $debug_output;
|
|
}
|
|
|
|
/**
|
|
* print a HTTP HEADER for XML, which is encoded in UTF-8
|
|
* @return void
|
|
*/
|
|
public static function _printXMLHeader()
|
|
{
|
|
header("Content-Type: text/xml; charset=UTF-8");
|
|
}
|
|
|
|
/**
|
|
* print a HTTP HEADER for HTML, which is encoded in UTF-8
|
|
* @return void
|
|
*/
|
|
public static function _printHTMLHeader()
|
|
{
|
|
header("Content-Type: text/html; charset=UTF-8");
|
|
}
|
|
|
|
/**
|
|
* print a HTTP HEADER for JSON, which is encoded in UTF-8
|
|
* @return void
|
|
*/
|
|
public static function _printJSONHeader()
|
|
{
|
|
header("Content-Type: application/json; charset=UTF-8");
|
|
}
|
|
|
|
/**
|
|
* print a custom Content-Type header.
|
|
*
|
|
* @param string $content_type
|
|
* @return void
|
|
*/
|
|
public static function _printCustomContentTypeHeader($content_type)
|
|
{
|
|
$charset = (strpos($content_type, 'text/') === 0) ? '; charset=UTF-8' : '';
|
|
header('Content-Type: ' . $content_type . $charset);
|
|
}
|
|
|
|
/**
|
|
* print a HTTP HEADER for HTML, which is encoded in UTF-8
|
|
* @return void
|
|
*/
|
|
public static function _printHttpStatusCode($code)
|
|
{
|
|
$statusMessage = Context::get('http_status_message');
|
|
header("HTTP/1.0 $code $statusMessage");
|
|
}
|
|
|
|
}
|