mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-16 16:34:05 +00:00
Code Issues Projects Releases Wiki Activity

Separate crashdump rendering from crashdump data collection

Browse Source 
this allows this code to be reused for reproducing crashdumps based on the original data.
This commit is contained in:
Dylan K. Taylor 2021-11-18 00:58:20 +00:00
parent c48aa274e7
commit 4599913034
No known key found for this signature in database
GPG Key ID: 8927471A91CAFD3D
2 changed files with 124 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
src/crash/CrashDump.php
View File

@ -42,9 +42,7 @@ use function file;
use function file_exists; use function file_exists;
use function file_get_contents; use function file_get_contents;
use function fopen; use function fopen;
use function fwrite;
use function get_loaded_extensions; use function get_loaded_extensions;
use function implode;
use function is_dir; use function is_dir;
use function is_resource; use function is_resource;
use function json_encode; use function json_encode;
@ -69,7 +67,6 @@ use function zend_version;
use function zlib_encode; use function zlib_encode;
use const FILE_IGNORE_NEW_LINES; use const FILE_IGNORE_NEW_LINES;
use const JSON_UNESCAPED_SLASHES; use const JSON_UNESCAPED_SLASHES;
use const PHP_EOL;
use const PHP_OS; use const PHP_OS;
use const PHP_VERSION; use const PHP_VERSION;
use const SORT_STRING; use const SORT_STRING;
@ -84,14 +81,12 @@ class CrashDump{
*/ */
private const FORMAT_VERSION = 4; private const FORMAT_VERSION = 4;
private const PLUGIN_INVOLVEMENT_NONE = "none"; public const PLUGIN_INVOLVEMENT_NONE = "none";
private const PLUGIN_INVOLVEMENT_DIRECT = "direct"; public const PLUGIN_INVOLVEMENT_DIRECT = "direct";
private const PLUGIN_INVOLVEMENT_INDIRECT = "indirect"; public const PLUGIN_INVOLVEMENT_INDIRECT = "indirect";
/** @var Server */ /** @var Server */
private $server; private $server;
/** @var resource */
private $fp;
/** @var float */ /** @var float */
private $time; private $time;
private CrashDumpData $data; private CrashDumpData $data;
@ -112,26 +107,27 @@ class CrashDump{
mkdir($crashPath); mkdir($crashPath);
} }
$this->path = Path::join($crashPath, date("D_M_j-H.i.s-T_Y", (int) $this->time) . ".log"); $this->path = Path::join($crashPath, date("D_M_j-H.i.s-T_Y", (int) $this->time) . ".log");
$fp = @fopen($this->path, "wb");
if(!is_resource($fp)){
throw new \RuntimeException("Could not create Crash Dump");
}
$this->fp = $fp;
$this->data = new CrashDumpData(); $this->data = new CrashDumpData();
$this->data->format_version = self::FORMAT_VERSION; $this->data->format_version = self::FORMAT_VERSION;
$this->data->time = $this->time; $this->data->time = $this->time;
$this->data->uptime = $this->time - $this->server->getStartTime(); $this->data->uptime = $this->time - $this->server->getStartTime();
$this->addLine($this->server->getName() . " Crash Dump " . date("D M j H:i:s T Y", (int) $this->time));
$this->addLine();
$this->baseCrash(); $this->baseCrash();
$this->generalData(); $this->generalData();
$this->pluginsData(); $this->pluginsData();
$this->extraData(); $this->extraData();
$this->encodeData(); $fp = @fopen($this->path, "wb");
if(!is_resource($fp)){
throw new \RuntimeException("Could not create Crash Dump");
}
$writer = new CrashDumpRenderer($fp, $this->data);
$writer->renderHumanReadable();
$this->encodeData($writer);
fclose($this->fp); fclose($fp);
} }
public function getPath() : string{ public function getPath() : string{
@ -146,11 +142,11 @@ class CrashDump{
return $this->data; return $this->data;
} }
private function encodeData() : void{ private function encodeData(CrashDumpRenderer $renderer) : void{
$this->addLine(); $renderer->addLine();
$this->addLine("----------------------REPORT THE DATA BELOW THIS LINE-----------------------"); $renderer->addLine("----------------------REPORT THE DATA BELOW THIS LINE-----------------------");
$this->addLine(); $renderer->addLine();
$this->addLine("===BEGIN CRASH DUMP==="); $renderer->addLine("===BEGIN CRASH DUMP===");
$json = json_encode($this->data, JSON_UNESCAPED_SLASHES); $json = json_encode($this->data, JSON_UNESCAPED_SLASHES);
if($json === false){ if($json === false){
throw new \RuntimeException("Failed to encode crashdump JSON: " . json_last_error_msg()); throw new \RuntimeException("Failed to encode crashdump JSON: " . json_last_error_msg());
@ -159,16 +155,14 @@ class CrashDump{
if($zlibEncoded === false) throw new AssumptionFailedError("ZLIB compression failed"); if($zlibEncoded === false) throw new AssumptionFailedError("ZLIB compression failed");
$this->encodedData = $zlibEncoded; $this->encodedData = $zlibEncoded;
foreach(str_split(base64_encode($this->encodedData), 76) as $line){ foreach(str_split(base64_encode($this->encodedData), 76) as $line){
$this->addLine($line); $renderer->addLine($line);
} }
$this->addLine("===END CRASH DUMP==="); $renderer->addLine("===END CRASH DUMP===");
} }
private function pluginsData() : void{ private function pluginsData() : void{
if($this->pluginManager !== null){ if($this->pluginManager !== null){
$plugins = $this->pluginManager->getPlugins(); $plugins = $this->pluginManager->getPlugins();
$this->addLine();
$this->addLine("Loaded plugins:");
ksort($plugins, SORT_STRING); ksort($plugins, SORT_STRING);
foreach($plugins as $p){ foreach($plugins as $p){
$d = $p->getDescription(); $d = $p->getDescription();
@ -184,7 +178,6 @@ class CrashDump{
load: mb_strtoupper($d->getOrder()->name()), load: mb_strtoupper($d->getOrder()->name()),
website: $d->getWebsite() website: $d->getWebsite()
); );
$this->addLine($d->getName() . " " . $d->getVersion() . " by " . implode(", ", $d->getAuthors()) . " for API(s) " . implode(", ", $d->getCompatibleApis()));
} }
} }
} }
@ -250,10 +243,6 @@ class CrashDump{
$this->data->error = $error; $this->data->error = $error;
unset($this->data->error["fullFile"]); unset($this->data->error["fullFile"]);
unset($this->data->error["trace"]); unset($this->data->error["trace"]);
$this->addLine("Error: " . $error["message"]);
$this->addLine("File: " . $error["file"]);
$this->addLine("Line: " . $error["line"]);
$this->addLine("Type: " . $error["type"]);
$this->data->plugin_involvement = self::PLUGIN_INVOLVEMENT_NONE; $this->data->plugin_involvement = self::PLUGIN_INVOLVEMENT_NONE;
if(!$this->determinePluginFromFile($error["fullFile"], true)){ //fatal errors won't leave any stack trace if(!$this->determinePluginFromFile($error["fullFile"], true)){ //fatal errors won't leave any stack trace
@ -267,36 +256,24 @@ class CrashDump{
} }
} }
$this->addLine();
$this->addLine("Code:");
if($this->server->getConfigGroup()->getPropertyBool("auto-report.send-code", true) and file_exists($error["fullFile"])){ if($this->server->getConfigGroup()->getPropertyBool("auto-report.send-code", true) and file_exists($error["fullFile"])){
$file = @file($error["fullFile"], FILE_IGNORE_NEW_LINES); $file = @file($error["fullFile"], FILE_IGNORE_NEW_LINES);
if($file !== false){ if($file !== false){
for($l = max(0, $error["line"] - 10); $l < $error["line"] + 10 and isset($file[$l]); ++$l){ for($l = max(0, $error["line"] - 10); $l < $error["line"] + 10 and isset($file[$l]); ++$l){
$this->addLine("[" . ($l + 1) . "] " . $file[$l]);
$this->data->code[$l + 1] = $file[$l]; $this->data->code[$l + 1] = $file[$l];
} }
} }
} }
$this->addLine(); $this->data->trace = Utils::printableTrace($error["trace"]);
$this->addLine("Backtrace:");
foreach(($this->data->trace = Utils::printableTrace($error["trace"])) as $line){
$this->addLine($line);
}
$this->addLine();
} }
private function determinePluginFromFile(string $filePath, bool $crashFrame) : bool{ private function determinePluginFromFile(string $filePath, bool $crashFrame) : bool{
$frameCleanPath = Filesystem::cleanPath($filePath); $frameCleanPath = Filesystem::cleanPath($filePath);
if(strpos($frameCleanPath, Filesystem::CLEAN_PATH_SRC_PREFIX) !== 0){ if(strpos($frameCleanPath, Filesystem::CLEAN_PATH_SRC_PREFIX) !== 0){
$this->addLine();
if($crashFrame){ if($crashFrame){
$this->addLine("THIS CRASH WAS CAUSED BY A PLUGIN");
$this->data->plugin_involvement = self::PLUGIN_INVOLVEMENT_DIRECT; $this->data->plugin_involvement = self::PLUGIN_INVOLVEMENT_DIRECT;
}else{ }else{
$this->addLine("A PLUGIN WAS INVOLVED IN THIS CRASH");
$this->data->plugin_involvement = self::PLUGIN_INVOLVEMENT_INDIRECT; $this->data->plugin_involvement = self::PLUGIN_INVOLVEMENT_INDIRECT;
} }
@ -308,7 +285,6 @@ class CrashDump{
$filePath = Filesystem::cleanPath($file->getValue($plugin)); $filePath = Filesystem::cleanPath($file->getValue($plugin));
if(strpos($frameCleanPath, $filePath) === 0){ if(strpos($frameCleanPath, $filePath) === 0){
$this->data->plugin = $plugin->getName(); $this->data->plugin = $plugin->getName();
$this->addLine("BAD PLUGIN: " . $plugin->getDescription()->getFullName());
break; break;
} }
} }
@ -319,7 +295,6 @@ class CrashDump{
} }
private function generalData() : void{ private function generalData() : void{
$version = VersionInfo::VERSION();
$composerLibraries = []; $composerLibraries = [];
foreach(InstalledVersions::getInstalledPackages() as $package){ foreach(InstalledVersions::getInstalledPackages() as $package){
$composerLibraries[$package] = sprintf( $composerLibraries[$package] = sprintf(
@ -343,29 +318,5 @@ class CrashDump{
os: Utils::getOS(), os: Utils::getOS(),
composer_libraries: $composerLibraries, composer_libraries: $composerLibraries,
); );
$this->addLine($this->server->getName() . " version: " . $version->getFullVersion(true) . " [Protocol " . ProtocolInfo::CURRENT_PROTOCOL . "]");
$this->addLine("Git commit: " . VersionInfo::GIT_HASH());
$this->addLine("uname -a: " . php_uname("a"));
$this->addLine("PHP Version: " . phpversion());
$this->addLine("Zend version: " . zend_version());
$this->addLine("OS: " . PHP_OS . ", " . Utils::getOS());
$this->addLine("Composer libraries: ");
foreach(Utils::stringifyKeys($composerLibraries) as $library => $libraryVersion){
$this->addLine("- $library $libraryVersion");
}
}
/**
* @param string $line
*/
public function addLine($line = "") : void{
fwrite($this->fp, $line . PHP_EOL);
}
/**
* @param string $str
*/
public function add($str) : void{
fwrite($this->fp, $str);
} }
} }

103
src/crash/CrashDumpRenderer.php Normal file
View File

@ -0,0 +1,103 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\crash;
use pocketmine\utils\Utils;
use pocketmine\utils\VersionString;
use function count;
use function date;
use function fwrite;
use function implode;
use const PHP_EOL;
final class CrashDumpRenderer{
/**
* @param resource $fp
*/
public function __construct(private $fp, private CrashDumpData $data){
}
public function renderHumanReadable() : void{
$this->addLine($this->data->general->name . " Crash Dump " . date("D M j H:i:s T Y", (int) $this->data->time));
$this->addLine();
$this->addLine("Error: " . $this->data->error["message"]);
$this->addLine("File: " . $this->data->error["file"]);
$this->addLine("Line: " . $this->data->error["line"]);
$this->addLine("Type: " . $this->data->error["type"]);
if($this->data->plugin_involvement !== CrashDump::PLUGIN_INVOLVEMENT_NONE){
$this->addLine();
$this->addLine(match($this->data->plugin_involvement){
CrashDump::PLUGIN_INVOLVEMENT_DIRECT => "THIS CRASH WAS CAUSED BY A PLUGIN",
CrashDump::PLUGIN_INVOLVEMENT_INDIRECT => "A PLUGIN WAS INVOLVED IN THIS CRASH",
default => "Unknown plugin involvement!"
});
}
if($this->data->plugin !== ""){
$this->addLine("BAD PLUGIN: " . $this->data->plugin);
}
$this->addLine();
$this->addLine("Code:");
foreach($this->data->code as $lineNumber => $line){
$this->addLine("[$lineNumber] $line");
}
$this->addLine();
$this->addLine("Backtrace:");
foreach($this->data->trace as $line){
$this->addLine($line);
}
$this->addLine();
$version = new VersionString($this->data->general->base_version, $this->data->general->is_dev, $this->data->general->build);
$this->addLine($this->data->general->name . " version: " . $version->getFullVersion(true) . " [Protocol " . $this->data->general->protocol . "]");
$this->addLine("Git commit: " . $this->data->general->git);
$this->addLine("uname -a: " . $this->data->general->uname);
$this->addLine("PHP Version: " . $this->data->general->php);
$this->addLine("Zend version: " . $this->data->general->zend);
$this->addLine("OS: " . $this->data->general->php_os . ", " . $this->data->general->os);
$this->addLine("Composer libraries: ");
foreach(Utils::stringifyKeys($this->data->general->composer_libraries) as $library => $libraryVersion){
$this->addLine("- $library $libraryVersion");
}
if(count($this->data->plugins) > 0){
$this->addLine();
$this->addLine("Loaded plugins:");
foreach($this->data->plugins as $p){
$this->addLine($p->name . " " . $p->version . " by " . implode(", ", $p->authors) . " for API(s) " . implode(", ", $p->api));
}
}
}
public function addLine(string $line = "") : void{
fwrite($this->fp, $line . PHP_EOL);
}
}