Release 4.0.0-BETA14

This reverts commit cbe0f44c4f.

This achieves the same result as the reverted commit wrt. process in the
same manner (writing a keepalive into the socket and checking if it
failed to send). However, it does _not_ allow the process to die on
reaching pipe EOF, since this can cause many spams of subprocesses when
stdin is actually not a tty (e.g. in a Docker container).

.gitattributes

@@ -4,6 +4,7 @@
 *.sh text eol=lf
 *.txt text eol=lf
 *.properties text eol=lf
+*.neon text eol=lf
 *.bat text eol=crlf
 *.cmd text eol=crlf
 *.ps1 text eol=crlf

.github/workflows/draft-release.yml

@@ -35,17 +35,18 @@ jobs:
       - name: Install Composer dependencies
         run: composer install --no-dev --prefer-dist --no-interaction --ignore-platform-reqs
 
-      - name: Patch VersionInfo
+      - name: Calculate build number
+        id: build-number
         run: |
-          BUILD_NUMBER=2000+$GITHUB_RUN_NUMBER #to stay above jenkins
+          BUILD_NUMBER=$((2000+$GITHUB_RUN_NUMBER)) #to stay above jenkins
           echo "Build number: $BUILD_NUMBER"
-          sed -i "s/const BUILD_NUMBER = 0/const BUILD_NUMBER = ${BUILD_NUMBER}/" src/VersionInfo.php
+          echo ::set-output name=BUILD_NUMBER::$BUILD_NUMBER
 
       - name: Minify BedrockData JSON files
         run: php vendor/pocketmine/bedrock-data/.minify_json.php
 
       - name: Build PocketMine-MP.phar
-        run: php -dphar.readonly=0 build/server-phar.php --git ${{ github.sha }}
+        run: php -dphar.readonly=0 build/server-phar.php --git ${{ github.sha }} --build ${{ steps.build-number.outputs.BUILD_NUMBER }}
 
       - name: Get PocketMine-MP release version
         id: get-pm-version
@@ -56,7 +57,7 @@ jobs:
           echo ::set-output name=PM_VERSION_MD::$(php -r 'require "vendor/autoload.php"; echo str_replace(".", "", \pocketmine\VersionInfo::BASE_VERSION);')
 
       - name: Generate build info
-        run: php build/generate-build-info-json.php ${{ github.sha }} ${{ steps.get-pm-version.outputs.PM_VERSION }} ${{ github.repository }} > build_info.json
+        run: php build/generate-build-info-json.php ${{ github.sha }} ${{ steps.get-pm-version.outputs.PM_VERSION }} ${{ github.repository }} ${{ steps.build-number.outputs.BUILD_NUMBER }} > build_info.json
 
       - name: Upload release artifacts
         uses: actions/upload-artifact@v2

build/generate-build-info-json.php

@@ -23,15 +23,15 @@ declare(strict_types=1);
 
 require dirname(__DIR__) . '/vendor/autoload.php';
 
-if(count($argv) !== 4){
-	fwrite(STDERR, "required args: <git hash> <tag name> <github repo (owner/name)>");
+if(count($argv) !== 5){
+	fwrite(STDERR, "required args: <git hash> <tag name> <github repo (owner/name)> <build number>");
 	exit(1);
 }
 
 echo json_encode([
 	"php_version" => sprintf("%d.%d", PHP_MAJOR_VERSION, PHP_MINOR_VERSION),
 	"base_version" => \pocketmine\VersionInfo::BASE_VERSION,
-	"build" => \pocketmine\VersionInfo::BUILD_NUMBER,
+	"build" => (int) $argv[4],
 	"is_dev" => \pocketmine\VersionInfo::IS_DEVELOPMENT_BUILD,
 	"channel" => \pocketmine\VersionInfo::BUILD_CHANNEL,
 	"git_commit" => $argv[1],

build/server-phar.php

@@ -134,13 +134,18 @@ function main() : void{
 		exit(1);
 	}
 
-	$opts = getopt("", ["out:", "git:"]);
+	$opts = getopt("", ["out:", "git:", "build:"]);
 	if(isset($opts["git"])){
 		$gitHash = $opts["git"];
 	}else{
 		$gitHash = Git::getRepositoryStatePretty(dirname(__DIR__));
 		echo "Git hash detected as $gitHash" . PHP_EOL;
 	}
+	if(isset($opts["build"])){
+		$build = (int) $opts["build"];
+	}else{
+		$build = 0;
+	}
 	foreach(buildPhar(
 		$opts["out"] ?? getcwd() . DIRECTORY_SEPARATOR . "PocketMine-MP.phar",
 		dirname(__DIR__) . DIRECTORY_SEPARATOR,
@@ -150,7 +155,8 @@ function main() : void{
 			'vendor'
 		],
 		[
-			'git' => $gitHash
+			'git' => $gitHash,
+			'build' => $build
 		],
 		<<<'STUB'
 <?php

changelogs/3.25.md

@@ -28,3 +28,11 @@ Plugin developers should **only** update their required API to this version if y
 
 # 3.25.4
 - Fixed a long-standing issue with `Player->removeWindow()` breaking inventory UIs on the client.
+
+# 3.25.5
+- Protocol: Fixed incorrect encoding in `StructureSettings`
+- Fixed reading tags from non-docblock comments in script plugins.
+- Build number is now defined in phar metadata instead of being patched into the source code directly.
+
+# 3.25.6
+- Fixed borked build number in release build of 3.25.5.

changelogs/4.0.md

@@ -1748,3 +1748,13 @@ Released 25th November 2021.
 
 ### Utils
 - `Utils::parseDocComment()` now allows `-` in tag names.
+
+# 4.0.0-BETA14
+Released 30th November 2021.
+
+## General
+- The server will now log an EMERGENCY-level message when `forceShutdown()` is used for any other reason than a graceful shutdown.
+- The server will now attempt to translate invalid blocks to valid equivalents when loading chunks. This fixes many issues with `update!` blocks appearing in worlds, particularly ghost structures (these would appear when world editors previously erased some blocks by setting their IDs but not metadata).
+
+## Fixes
+- Fixed `ConsoleReaderThread` spawning many zombie processes when running a server inside a Docker container.

composer.json

@@ -79,7 +79,7 @@
       "sort-packages": true
    },
    "scripts": {
-      "make-devtools": "@php -dphar.readonly=0 tests/plugins/DevTools/src/DevTools/ConsoleScript.php --make tests/plugins/DevTools --out plugins/DevTools.phar",
+      "make-devtools": "@php -dphar.readonly=0 tests/plugins/DevTools/src/ConsoleScript.php --make tests/plugins/DevTools --out plugins/DevTools.phar",
       "make-server": [
          "@composer install --no-dev --classmap-authoritative --ignore-platform-reqs",
          "@php -dphar.readonly=0 build/server-phar.php"

composer.lock

@@ -533,16 +533,16 @@
         },
         {
             "name": "pocketmine/locale-data",
-            "version": "2.0.17",
+            "version": "2.0.20",
             "source": {
                 "type": "git",
                 "url": "https://github.com/pmmp/Language.git",
-                "reference": "30e4a64d5674bac556c4e2b9842b19a981471ac4"
+                "reference": "a6e4eb22587e0014f6d658732cf633262723f8d3"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/pmmp/Language/zipball/30e4a64d5674bac556c4e2b9842b19a981471ac4",
-                "reference": "30e4a64d5674bac556c4e2b9842b19a981471ac4",
+                "url": "https://api.github.com/repos/pmmp/Language/zipball/a6e4eb22587e0014f6d658732cf633262723f8d3",
+                "reference": "a6e4eb22587e0014f6d658732cf633262723f8d3",
                 "shasum": ""
             },
             "type": "library",
@@ -550,9 +550,9 @@
             "description": "Language resources used by PocketMine-MP",
             "support": {
                 "issues": "https://github.com/pmmp/Language/issues",
-                "source": "https://github.com/pmmp/Language/tree/2.0.17"
+                "source": "https://github.com/pmmp/Language/tree/2.0.20"
             },
-            "time": "2021-11-12T00:59:39+00:00"
+            "time": "2021-11-25T20:56:12+00:00"
         },
         {
             "name": "pocketmine/log",

src/Server.php

@@ -1413,6 +1413,9 @@ class Server{
 			echo "\x1b]0;\x07";
 		}
 
+		if($this->isRunning){
+			$this->logger->emergency("Forcing server shutdown");
+		}
 		try{
 			if(!$this->isRunning()){
 				$this->sendUsage(SendUsageTask::TYPE_CLOSE);

src/VersionInfo.php

@@ -25,13 +25,14 @@ namespace pocketmine;
 
 use pocketmine\utils\Git;
 use pocketmine\utils\VersionString;
+use function is_array;
+use function is_int;
 use function str_repeat;
 
 final class VersionInfo{
 	public const NAME = "PocketMine-MP";
-	public const BASE_VERSION = "4.0.0-BETA13";
+	public const BASE_VERSION = "4.0.0-BETA14";
 	public const IS_DEVELOPMENT_BUILD = false;
-	public const BUILD_NUMBER = 0;
 	public const BUILD_CHANNEL = "beta";
 
 	private function __construct(){
@@ -61,12 +62,29 @@ final class VersionInfo{
 		return self::$gitHash;
 	}
 
+	private static ?int $buildNumber = null;
+
+	public static function BUILD_NUMBER() : int{
+		if(self::$buildNumber === null){
+			self::$buildNumber = 0;
+			if(\Phar::running(true) !== ""){
+				$phar = new \Phar(\Phar::running(false));
+				$meta = $phar->getMetadata();
+				if(is_array($meta) && isset($meta["build"]) && is_int($meta["build"])){
+					self::$buildNumber = $meta["build"];
+				}
+			}
+		}
+
+		return self::$buildNumber;
+	}
+
 	/** @var VersionString|null */
 	private static $fullVersion = null;
 
 	public static function VERSION() : VersionString{
 		if(self::$fullVersion === null){
-			self::$fullVersion = new VersionString(self::BASE_VERSION, self::IS_DEVELOPMENT_BUILD, self::BUILD_NUMBER);
+			self::$fullVersion = new VersionString(self::BASE_VERSION, self::IS_DEVELOPMENT_BUILD, self::BUILD_NUMBER());
 		}
 		return self::$fullVersion;
 	}

src/console/ConsoleReader.php

@@ -27,14 +27,24 @@ use pocketmine\utils\AssumptionFailedError;
 use function fclose;
 use function fgets;
 use function fopen;
+use function is_resource;
 use function stream_select;
 use function trim;
+use function usleep;
 
 final class ConsoleReader{
 	/** @var resource */
 	private $stdin;
 
 	public function __construct(){
+		$this->initStdin();
+	}
+
+	private function initStdin() : void{
+		if(is_resource($this->stdin)){
+			fclose($this->stdin);
+		}
+
 		$stdin = fopen("php://stdin", "r");
 		if($stdin === false) throw new AssumptionFailedError("Opening stdin should never fail");
 		$this->stdin = $stdin;
@@ -42,19 +52,23 @@ final class ConsoleReader{
 
 	/**
 	 * Reads a line from the console and adds it to the buffer. This method may block the thread.
-	 * @throws ConsoleReaderException
 	 */
 	public function readLine() : ?string{
+		if(!is_resource($this->stdin)){
+			$this->initStdin();
+		}
+
 		$r = [$this->stdin];
 		$w = $e = null;
 		if(($count = stream_select($r, $w, $e, 0, 200000)) === 0){ //nothing changed in 200000 microseconds
 			return null;
 		}elseif($count === false){ //stream error
-			throw new ConsoleReaderException("Unexpected EOF on select()");
+			return null;
 		}
 
 		if(($raw = fgets($this->stdin)) === false){ //broken pipe or EOF
-			throw new ConsoleReaderException("Unexpected EOF on fgets()");
+			usleep(200000); //prevent CPU waste if it's end of pipe
+			return null; //loop back round
 		}
 
 		$line = trim($raw);

src/console/ConsoleReaderChildProcess.php

@@ -45,14 +45,7 @@ if($socket === false){
 }
 $consoleReader = new ConsoleReader();
 while(!feof($socket)){
-	try{
-		$line = $consoleReader->readLine();
-	}catch(ConsoleReaderException $e){
-		//Encountered unexpected EOF. This might be because the user did something stupid, or because the parent process
-		//has died. In either case, commit suicide. If the parent process is still alive, it will start a new console
-		//reader.
-		break;
-	}
+	$line = $consoleReader->readLine();
 	if(@fwrite($socket, ($line ?? "") . "\n") === false){
 		//Always send even if there's no line, to check if the parent is alive
 		//If the parent process was terminated forcibly, it won't close the connection properly, so feof() will return

src/console/ConsoleReaderException.php

@@ -1,28 +0,0 @@
-<?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\console;
-
-final class ConsoleReaderException extends \RuntimeException{
-
-}

src/console/ConsoleReaderThread.php

@@ -31,6 +31,7 @@ use function base64_encode;
 use function fgets;
 use function fopen;
 use function preg_replace;
+use function proc_close;
 use function proc_open;
 use function proc_terminate;
 use function sprintf;
@@ -130,6 +131,7 @@ final class ConsoleReaderThread extends Thread{
 		//gets stuck in a blocking fgets() read because stream_select() is a hunk of junk (hence the separate process in
 		//the first place).
 		proc_terminate($sub);
+		proc_close($sub);
 		stream_socket_shutdown($client, STREAM_SHUT_RDWR);
 	}
 

src/crash/CrashDump.php

@@ -279,7 +279,7 @@ class CrashDump{
 		$this->data->general = new CrashDumpDataGeneral(
 			name: $this->server->getName(),
 			base_version: VersionInfo::BASE_VERSION,
-			build: VersionInfo::BUILD_NUMBER,
+			build: VersionInfo::BUILD_NUMBER(),
 			is_dev: VersionInfo::IS_DEVELOPMENT_BUILD,
 			protocol: ProtocolInfo::CURRENT_PROTOCOL,
 			git: VersionInfo::GIT_HASH(),

src/item/ItemFactory.php

@@ -252,6 +252,7 @@ class ItemFactory{
 		$this->register(new Steak(new ItemIdentifier(ItemIds::STEAK, 0), "Steak"));
 		$this->register(new Stick(new ItemIdentifier(ItemIds::STICK, 0), "Stick"));
 		$this->register(new StringItem(new ItemIdentifier(ItemIds::STRING, 0), "String"));
+		$this->register(new SweetBerries(new ItemIdentifier(ItemIds::SWEET_BERRIES, 0), "Sweet Berries"));
 		$this->register(new Totem(new ItemIdentifier(ItemIds::TOTEM, 0), "Totem of Undying"));
 		$this->register(new WheatSeeds(new ItemIdentifier(ItemIds::WHEAT_SEEDS, 0), "Wheat Seeds"));
 		$this->register(new WritableBook(new ItemIdentifier(ItemIds::WRITABLE_BOOK, 0), "Book & Quill"));
@@ -327,7 +328,6 @@ class ItemFactory{
 		//TODO: minecraft:shield
 		//TODO: minecraft:sparkler
 		//TODO: minecraft:spawn_egg
-		$this->register(new SweetBerries(new ItemIdentifier(ItemIds::SWEET_BERRIES, 0), "Sweet Berries"));
 		//TODO: minecraft:tnt_minecart
 		//TODO: minecraft:trident
 		//TODO: minecraft:turtle_helmet

src/world/World.php

@@ -2466,6 +2466,27 @@ class World implements ChunkManager{
 
 	private function initChunk(int $chunkX, int $chunkZ, ChunkData $chunkData) : void{
 		$logger = new \PrefixedLogger($this->logger, "Loading chunk $chunkX $chunkZ");
+
+		$this->timings->syncChunkLoadFixInvalidBlocks->startTiming();
+		$blockFactory = BlockFactory::getInstance();
+		$invalidBlocks = 0;
+		foreach($chunkData->getChunk()->getSubChunks() as $subChunk){
+			foreach($subChunk->getBlockLayers() as $blockLayer){
+				foreach($blockLayer->getPalette() as $blockStateId){
+					$mappedStateId = $blockFactory->getMappedStateId($blockStateId);
+					if($mappedStateId !== $blockStateId){
+						$blockLayer->replaceAll($blockStateId, $mappedStateId);
+						$invalidBlocks++;
+					}
+				}
+			}
+		}
+		if($invalidBlocks > 0){
+			$logger->debug("Fixed $invalidBlocks invalid blockstates");
+			$chunkData->getChunk()->setTerrainDirtyFlag(Chunk::DIRTY_FLAG_BLOCKS, true);
+		}
+		$this->timings->syncChunkLoadFixInvalidBlocks->stopTiming();
+
 		if(count($chunkData->getEntityNBT()) !== 0){
 			$this->timings->syncChunkLoadEntities->startTiming();
 			$entityFactory = EntityFactory::getInstance();

src/world/WorldTimings.php

@@ -45,6 +45,7 @@ class WorldTimings{
 
 	public TimingsHandler $syncChunkLoad;
 	public TimingsHandler $syncChunkLoadData;
+	public TimingsHandler $syncChunkLoadFixInvalidBlocks;
 	public TimingsHandler $syncChunkLoadEntities;
 	public TimingsHandler $syncChunkLoadTileEntities;
 	public TimingsHandler $syncChunkSave;
@@ -64,14 +65,15 @@ class WorldTimings{
 		$this->entityTick = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Tick Entities");
 
 		Timings::init(); //make sure the timers we want are available
-		$this->syncChunkSend = new TimingsHandler("** " . $name . "Player Send Chunks", Timings::$playerChunkSend);
-		$this->syncChunkSendPrepare = new TimingsHandler("** " . $name . "Player Send Chunk Prepare", Timings::$playerChunkSend);
+		$this->syncChunkSend = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Player Send Chunks", Timings::$playerChunkSend);
+		$this->syncChunkSendPrepare = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Player Send Chunk Prepare", Timings::$playerChunkSend);
 
-		$this->syncChunkLoad = new TimingsHandler("** " . $name . "Chunk Load", Timings::$worldLoad);
-		$this->syncChunkLoadData = new TimingsHandler("** " . $name . "Chunk Load - Data");
-		$this->syncChunkLoadEntities = new TimingsHandler("** " . $name . "Chunk Load - Entities");
-		$this->syncChunkLoadTileEntities = new TimingsHandler("** " . $name . "Chunk Load - TileEntities");
-		$this->syncChunkSave = new TimingsHandler("** " . $name . "Chunk Save", Timings::$worldSave);
+		$this->syncChunkLoad = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Chunk Load", Timings::$worldLoad);
+		$this->syncChunkLoadData = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Chunk Load - Data");
+		$this->syncChunkLoadFixInvalidBlocks = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Chunk Load - Fix Invalid Blocks");
+		$this->syncChunkLoadEntities = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Chunk Load - Entities");
+		$this->syncChunkLoadTileEntities = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Chunk Load - TileEntities");
+		$this->syncChunkSave = new TimingsHandler(Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX . $name . "Chunk Save", Timings::$worldSave);
 
 		$this->doTick = new TimingsHandler($name . "World Tick");
 	}

tests/phpstan/configs/actual-problems.neon

@@ -505,6 +505,11 @@ parameters:
 			count: 1
 			path: ../../../src/command/defaults/TimingsCommand.php
 
+		-
+			message: "#^Call to function is_resource\\(\\) with resource will always evaluate to true\\.$#"
+			count: 2
+			path: ../../../src/console/ConsoleReader.php
+
 		-
 			message: "#^Parameter \\#1 \\$json of function json_decode expects string, string\\|false given\\.$#"
 			count: 1

tests/phpunit/block/BlockTest.php

@@ -107,7 +107,6 @@ class BlockTest extends TestCase{
 	public function blockGetProvider() : array{
 		return [
 			[BlockLegacyIds::STONE, 5],
-			[BlockLegacyIds::STONE, 15],
 			[BlockLegacyIds::GOLD_BLOCK, 0],
 			[BlockLegacyIds::WOODEN_PLANKS, 5],
 			[BlockLegacyIds::SAND, 0],

tests/travis.sh

@@ -20,7 +20,7 @@ mkdir "$DATA_DIR"
 mkdir "$PLUGINS_DIR"
 
 cd tests/plugins/DevTools
-php -dphar.readonly=0 ./src/DevTools/ConsoleScript.php --make ./ --relative ./ --out "$PLUGINS_DIR/DevTools.phar"
+php -dphar.readonly=0 ./src/ConsoleScript.php --make ./ --relative ./ --out "$PLUGINS_DIR/DevTools.phar"
 cd ../../..
 composer make-server