diff --git a/htdocs/diagnosis/diagnosis.css b/htdocs/diagnosis/diagnosis.css new file mode 100644 index 0000000..cd354b9 --- /dev/null +++ b/htdocs/diagnosis/diagnosis.css @@ -0,0 +1,12 @@ +#diagnosisResult .info { + background: #C0FFC0; +} +#diagnosisResult .warning { + background: #FFF0FF; +} +#diagnosisResult .error { + background: #FFA0A0; +} +#main #diagnosisResult td { + vertical-align: top; +} diff --git a/htdocs/diagnosis/diagnosis.tpl.php b/htdocs/diagnosis/diagnosis.tpl.php index 479bc8e..3ddf2a7 100644 --- a/htdocs/diagnosis/diagnosis.tpl.php +++ b/htdocs/diagnosis/diagnosis.tpl.php @@ -1,24 +1,28 @@ - +
+ - - - - + + + + +
+ + - + - +
diff --git a/htdocs/diagnosis/index.php b/htdocs/diagnosis/index.php index 0db6a28..51b4037 100644 --- a/htdocs/diagnosis/index.php +++ b/htdocs/diagnosis/index.php @@ -1,18 +1,28 @@ $item); +} +// }}} +function result($type, $result, $suggestion = "") // {{{ +{ + global $notes, $activeNote; $notes[] = array( 'type' => $type - , 'reason' => $reason + , 'result' => ($type != 'skipped' && !$suggestion ? "OK. " : "") . $result , 'suggestion' => $suggestion - ); + ) + $activeNote; } // }}} function getCacheInfos() // {{{ @@ -35,125 +45,356 @@ function getCacheInfos() // {{{ return $cacheInfos; } // }}} - -if (!extension_loaded('XCache')) { +function getIniFileInfo() // {{{ +{ ob_start(); phpinfo(INFO_GENERAL); $info = ob_get_clean(); ob_start(); if (preg_match_all("![^<]*]*>[^<]*(?:Configuration|ini|Server API)[^<]*[^<]*]*>[^<]*[^<]*!s", $info, $m)) { - echo '
'; - echo 'PHP Info'; - echo ''; - echo implode('', $m[0]); - echo '
'; - echo '
'; + $iniInfo = '' + . implode('', $m[0]) + . '
'; + } + else { + $iniInfo = ''; } + $loadedIni = ''; + $iniDirectory = ''; if (preg_match('!(.*?\\.ini)!', $info, $m)) { - echo "Please check $m[1]"; + $loadedIni = $m[1]; } else if (preg_match('!Configuration File \\(php.ini\\) Path *([^<]+)!', $info, $m)) { - echo "Please put a php.ini in $m[1] and load XCache extension"; + $iniDirectory = $m[1]; } - else { - echo "You don't even have a php.ini yet?"; - } - echo "(See above)"; - note("error", _T('XCache is not loaded'), ob_get_clean()); + return array($loadedIni, $iniDirectory, $iniInfo); } -else { - note("info", _T('XCache loaded')); - - $cacheInfos = getCacheInfos(); - - if (!ini_get("xcache.size") || !ini_get("xcache.cacher")) { - note( - "error" - , _T("XCache is not enabled. Website is not accelerated by XCache") - , _T("Set xcache.size to non-zero, set xcache.cacher = On") - ); - } - else { - note("info", _T('XCache Enabled')); - } +// }}} - $ooms = false; - foreach ($cacheInfos as $cacheInfo) { - if ($cacheInfo['ooms']) { - $ooms = true; - break; - } +$xcacheLoaded = extension_loaded('XCache'); +checking(_T("XCache extension")); // {{{ +if (!$xcacheLoaded) { + list($loadedIni, $iniDirectory, $iniInfo) = getIniFileInfo(); + if ($loadedIni) { + echo sprintf(_T("Add extension=xcache.so (or xcache.dll) in %s"), $loadedIni); } - if ($ooms) { - note( - "warning" - , _T("Out of memory happened when trying to write to cache") - , "Increase xcache.size and/or xcache.var_size" - ); + else if (preg_match('!Configuration File \\(php.ini\\) Path *([^<]+)!', $info, $m)) { + echo sprintf(_T("Please put a php.ini in %s and add extension=xcache.so (or xcache.dll) in it"), $iniDirectory); } else { - note("info", _T('XCache Memory Size')); + echo _T("Cannot detect ini location"); } + echo _T(" (See above)"); + result("error", _T('Not loaded'), ob_get_clean()); +} +else { + result("info", _T('Loaded')); +} +// }}} +if ($xcacheLoaded) { // {{{ load XCache summary + $cacheInfos = getCacheInfos(); - $errors = false; + $ooms = 0; + $errors = 0; + $disabled = 0; + $compiling = 0; + $readonlyProtection = false; + $phpCacheCount = xcache_count(XC_TYPE_PHP); + $phpCached = 0; + $varCached = 0; foreach ($cacheInfos as $cacheInfo) { - if ($cacheInfo['errors']) { - $errors = true; - break; + $ooms += $cacheInfo['ooms']; + $errors += $cacheInfo['errors']; + $disabled += $cacheInfo['disabled'] ? 1 : 0; + if ($cacheInfo['type'] == XC_TYPE_PHP) { + $compiling += $cacheInfo['compiling'] ? 1 : 0; + $phpCached += $cacheInfo['cached']; + } + if ($cacheInfo['type'] == XC_TYPE_VAR && $cacheInfo['cached']) { + $varCached += $cacheInfo['cached']; + } + if ($cacheInfo['can_readonly']) { + $readonlyProtection = true; } } - if ($errors) { - note( +} +// }}} +checking(_T("Enabling PHP Cacher")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else if (!ini_get("xcache.size")) { + result( + "error" + , _T("Not enabled: Website is not accelerated by XCache") + , _T("Set xcache.size to non-zero, set xcache.cacher = On") + ); +} +else if (!$phpCached) { + result( + "error" + , _T("No php script cached: Website is not accelerated by XCache") + , _T("Set xcache.cacher = On") + ); +} +else { + result("info", _T('Enabled')); +} +// }}} +checking(_T("PHP Compile Time Error")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else if (!$phpCacheCount) { + result("skipped", "XCache PHP cacher not enabled"); +} +else if ($errors) { + result( + "warning" + , _T("Error happened when compiling at least one of your PHP code") + , _T("This usually means there is syntax error in your PHP code. Enable PHP error_log to see what parser error is it, fix your code") + ); +} +else { + result("info", _T('No error happened')); +} +// }}} +checking(_T("Busy Compiling")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else if (!$phpCacheCount) { + result("skipped", "XCache PHP cacher not enabled"); +} +else if ($compiling) { + result( + "warning" + , _T("Cache marked as busy for compiling") + , _T("It's ok if this status don't stay for long. Otherwise, it could be a sign of PHP crash/coredump, report to XCache devs") + ); +} +else { + result("info", _T('Idle')); +} +// }}} +checking(_T("Enabling VAR Cacher")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else if (!ini_get("xcache.var_size")) { + result( + "error" + , _T("Not enabled: code that use xcache var cacher fall back to other backend") + , _T("Set xcache.var_size to non-zero") + ); +} +else { + result("info", _T('Enabled')); + + checking(_T("Using VAR Cacher")); // {{{ + if ($varCached) { + result( "warning" - , _T("Error happened when compiling at least one of your PHP code") - , _T("This usually means there is syntax error in your PHP code. Enable PHP error_log to see what parser error is it, fix your code") + , _T("No variable data cached") + , _T("Var Cacher won't work simply by enabling it." + . " PHP code must call XCache APIs like xcache_set() to use it as cache backend. 3rd party web apps may come with XCache support, config it to use XCache as cachign backend") ); } else { - note("info", _T('All PHP scripts seem fine')); + result("info", _T('Cache in use')); } - - /* - if ($ini['xcache.count'] < cpucount() * 2) { + // }}} +} +// }}} +checking(_T("Cache Size")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else if ($ooms) { + result( + "warning" + , _T("Out of memory happened when trying to write to cache") + , _T("Increase xcache.size and/or xcache.var_size") + ); +} +else { + result("info", _T('Enough')); +} +// }}} +checking(_T("Slots")); // {{{ +$slotsTooBig = null; +$slotsTooSmall = null; +foreach ($cacheInfos as $cacheInfo) { + if ($cacheInfo['size'] < '1024000' && $cacheInfo['slots'] >= '8192') { + $slotsTooBig = $cacheInfo['type']; + break; } - - if ($ini['xcache.size'] is small $ini['xcache.slots'] is big) { + if ($cacheInfo['slots'] < $cacheInfo['cached'] / 2) { + $slotsTooSmall = $cacheInfo['type']; + break; } +} +if (isset($slotsTooBig)) { + $prefix = $slotsTooBig == XC_TYPE_PHP ? '' : 'var_'; + result( + "warning" + , _T("Slots value too big") + , sprintf(_T("A very small value is set to %s value and leave %s value is too big.\n" + . "Decrease %s if small cache is really what you want"), "xcache.{$prefix}size", "xcache.{$prefix}slots", "xcache.{$prefix}slots") + ); +} +else if (isset($slotsTooSmall)) { + $prefix = $slotsTooSmall == XC_TYPE_PHP ? '' : 'var_'; + result( + "warning" + , _T("Slots value too small") + , sprintf(_T("So many item are cached. Increase %s to a more proper value"), "xcache.{$prefix}slots") + ); +} +else { + result("info", _T('Looks good')); +} +// }}} +checking(_T("Cache Status")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else if ($disabled) { + result( + "warning" + , _T("At least one of the caches is disabled. ") + . (ini_get("xcache.crash_on_coredump") ? _T("It was disabled by PHP crash/coredump handler or You disabled it manually") : _T('You disabled it manually')) + , _T("Enable the cache.") + . (ini_get("xcache.crash_on_coredump") ? " " . _T("If it was caused by PHP crash/coredump, report to XCache devs") : "") + ); +} +else { + result("info", _T('Idle')); +} +// }}} - if ($ini['xcache.readonly_protection']) { +checking(_T("Coredump Directory")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else if (!ini_get("xcache.coredump_directory")) { + result("info" + , _T("Not enabled") + , _T("Enable coredump to know your PHP crash. It can also be enabled in fpm other than in XCache") + ); +} +else if (ini_get("xcache.coredump_directory")) { + $coreDir = ini_get("xcache.coredump_directory"); + if (substr($coreDir, -1) != DIRECTORY_SEPARATOR) { + $coreDir .= DIRECTORY_SEPARATOR; } - - if ($cache['compiling']) { + $coreFiles = glob($coreDir . "core*"); + if ($coreFiles) { + result("error" + , _T("Core files found:\n") . implode("\n", $coreFiles) + , _T("Disable XCache PHP Cacher (xcache.size=0), remove the core file(s). If core file appears again, report call stack backtrace in the core to XCache devs") + ); } - - if ($cache['compiling']) { + else { + result("info" + , _T("Enabled") + , sprintf(_T("You can see core files if PHP crash in %s if PHP crash"), ini_get("xcache.coredump_directory")) + ); } - - if ($cache['disabled']) { +} +// }}} +checking(_T("Readonly Protection")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else if (ini_get("xcache.readonly_protection") && !$readonly_protection) { + result( + "error" + , _T("Set to enabled but not available") + , _T("Use xcache.mmap_path other than /dev/zero") + ); +} +else { + result( + "info" + , $readonlyProtection ? _T("Enabled") : _T("Disabled") + , _T("Enable readonly_protection == --performance & ++stability. " + . "Disable readonly_protection == ++performance & --stability") + ); +} +// }}} +checking(_T("XCache modules")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); +} +else { + $xcacheModules = explode(" ", XCACHE_MODULES); + $unexpectedModules = array_intersect($xcacheModules, array("coverager", "disassembler")); + if ($unexpectedModules) { + result( + "warning" + , implode("\n", $unexpectedModules) + , _T("Acceptable. Module(s) listed above are built into XCache but not for production server\n" + . "Leave it as is if you're feeling good.\n" + . "Re-configure XCache with the above module(s) disabled if you're strict with server security.") + ); + } + else { + result("info", _T('Idle')); } - */ } - -/* - -if (($coredumpFiles = globCoreDumpFiles()) { +// }}} +checking(_T("XCache test setting")); // {{{ +if (!$xcacheLoaded) { + result("skipped", "XCache not loaded"); } - -if (module not for server) { +else if ((int) ini_get('xcache.test') == 1) { + result( + "warning" + , _T("Enabled") + , _T("xcache.test is for testing only, not for server. set it to off") + ); +} +else { + result("info", _T('Disabled')); } +// }}} +checking(_T("PHP Version")); // {{{ +$phpVersion = phpversion(); +$unstablePhpVersionReason = null; +foreach ($knownUnstablePhpVersions as $knownUnstablePhpVersion) { + list($compareOp, $unstablePhpVersion, $reason) = $knownUnstablePhpVersion; + if ($compareOp) { + $isUnstable = version_compare($phpVersion, $unstablePhpVersion, $compareOp); + } + else { + $isUnstable = substr($phpVersion, 0, strlen($unstablePhpVersion)) == $unstablePhpVersion; + } -$phpVersion = php_version(); -foreach ($knownUnstablePhpVersion as $unstablePhpVersion => $reason) { - if (substr($phpVersion, 0, strlen($unstablePhpVersion)) == $unstablePhpVersion) { - // .. + if ($isUnstable) { + $unstablePhpVersionReason = $reason; + break; } } - -if (Zend Optimizer is loaded, zend optimize level > 0) { - warn("disabled"); +if ($unstablePhpVersionReason) { + result("error" + , _T("The version of PHP you're using is known to be unstable: ") . $unstablePhpVersionReason + , _T("Upgrade to new version of PHP")); } - -*/ +else { + result("info", _T("Looks good")); +} +// }}} +checking(_T("Extension Compatibility")); // {{{ +$loadedZendExtensions = get_loaded_extensions(true); +if (array_search("Zend Optimizer", $loadedZendExtensions) !== false) { + result( + "warning" + , _T("Zend Optimizer loaded") + , _T("Optimizer feature of 'Zend Optimizer' is disabled by XCache due to compatibility reason; the Loader of it is still available, encoded files are still supported") + ); +} +// }}} include "./diagnosis.tpl.php";