Release 3.17.2

inspired by #3592, which has gone stale

build/make-release.php

@@ -24,7 +24,6 @@ declare(strict_types=1);
 namespace pocketmine\build\make_release;
 
 use pocketmine\utils\VersionString;
-use function defined;
 use function dirname;
 use function fgets;
 use function file_get_contents;
@@ -86,6 +85,4 @@ function main(array $argv) : void{
 	system('git push origin HEAD ' . $currentVer->getBaseVersion());
 }
 
-if(!defined('pocketmine\_PHPSTAN_ANALYSIS')){
-	main($argv);
-}
+main($argv);

build/server-phar.php

@@ -26,7 +26,6 @@ namespace pocketmine\build\server_phar;
 use pocketmine\utils\Git;
 use function array_map;
 use function count;
-use function defined;
 use function dirname;
 use function file_exists;
 use function getcwd;
@@ -174,6 +173,4 @@ STUB
 	}
 }
 
-if(!defined('pocketmine\_PHPSTAN_ANALYSIS')){
-	main();
-}
+main();

changelogs/3.17.md

@@ -21,3 +21,8 @@ Plugin developers should **only** update their required API to this version if y
 - Server uptime is now included in crash reports.
 - Hoes now take damage when used to break sponges.
 - Using lava as fuel in a furnace now leaves behind an empty bucket.
+
+# 3.17.2
+- Fixed region header corruption when chunks with larger-than-expected lengths are found. These chunks are now treated as corrupted, instead of automatically attempting to salvage them (which usually fails anyway).
+- `RegionLoader->removeChunk()` now allows the space used by the removed chunk to be reused by future region saves.
+- Extracted `Living->applyConsumptionResults()` from `Living->consumeObject()` (preparation for a future bug fix).

src/pocketmine/PocketMine.php

@@ -299,7 +299,5 @@ namespace pocketmine {
 		exit($exitCode);
 	}
 
-	if(!defined('pocketmine\_PHPSTAN_ANALYSIS')){
-		\pocketmine\server();
-	}
+	\pocketmine\server();
 }

src/pocketmine/VersionInfo.php

@@ -33,6 +33,6 @@ if(defined('pocketmine\_VERSION_INFO_INCLUDED')){
 const _VERSION_INFO_INCLUDED = true;
 
 const NAME = "PocketMine-MP";
-const BASE_VERSION = "3.17.1";
+const BASE_VERSION = "3.17.2";
 const IS_DEVELOPMENT_BUILD = false;
 const BUILD_NUMBER = 0;

src/pocketmine/entity/Human.php

@@ -300,17 +300,20 @@ class Human extends Creature implements ProjectileSource, InventoryHolder{
 		if($consumable instanceof MaybeConsumable and !$consumable->canBeConsumed()){
 			return false;
 		}
+		if($consumable instanceof FoodSource && $consumable->requiresHunger() and !$this->isHungry()){
+			return false;
+		}
 
+		return parent::consumeObject($consumable);
+	}
+
+	protected function applyConsumptionResults(Consumable $consumable) : void{
 		if($consumable instanceof FoodSource){
-			if($consumable->requiresHunger() and !$this->isHungry()){
-				return false;
-			}
-
 			$this->addFood($consumable->getFoodRestore());
 			$this->addSaturation($consumable->getSaturationRestore());
 		}
 
-		return parent::consumeObject($consumable);
+		parent::applyConsumptionResults($consumable);
 	}
 
 	/**

src/pocketmine/entity/Living.php

@@ -363,13 +363,20 @@ abstract class Living extends Entity implements Damageable{
 			return false;
 		}
 
+		$this->applyConsumptionResults($consumable);
+		return true;
+	}
+
+	/**
+	 * Applies effects from consuming the object. This shouldn't do any can-consume checks (those are expected to be
+	 * handled by the caller).
+	 */
+	protected function applyConsumptionResults(Consumable $consumable) : void{
 		foreach($consumable->getAdditionalEffects() as $effect){
 			$this->addEffect($effect);
 		}
 
 		$consumable->onConsume($this);
-
-		return true;
 	}
 
 	/**

src/pocketmine/level/format/io/region/RegionLoader.php

@@ -27,7 +27,6 @@ use pocketmine\level\format\ChunkException;
 use pocketmine\level\format\io\exception\CorruptedChunkException;
 use pocketmine\utils\AssumptionFailedError;
 use pocketmine\utils\Binary;
-use pocketmine\utils\MainLogger;
 use function assert;
 use function ceil;
 use function chr;
@@ -160,10 +159,7 @@ class RegionLoader{
 		}
 
 		if($length > ($this->locationTable[$index]->getSectorCount() << 12)){ //Invalid chunk, bigger than defined number of sectors
-			MainLogger::getLogger()->error("Chunk x=$x,z=$z length mismatch (expected " . ($this->locationTable[$index]->getSectorCount() << 12) . " sectors, got $length sectors)");
-			$old = $this->locationTable[$index];
-			$this->locationTable[$index] = new RegionLocationTableEntry($old->getFirstSector(), $length >> 12, time());
-			$this->writeLocationIndex($index);
+			throw new CorruptedChunkException("Chunk length mismatch (expected " . ($this->locationTable[$index]->getSectorCount() << 12) . " sectors, got $length sectors)");
 		}
 
 		$chunkData = fread($this->filePointer, $length);
@@ -186,6 +182,23 @@ class RegionLoader{
 		return $this->isChunkGenerated(self::getChunkOffset($x, $z));
 	}
 
+	private function disposeGarbageArea(RegionLocationTableEntry $oldLocation) : void{
+		/* release the area containing the old copy to the garbage pool */
+		$this->garbageTable->add($oldLocation);
+
+		$endGarbage = $this->garbageTable->end();
+		$nextSector = $this->nextSector;
+		for(; $endGarbage !== null and $endGarbage->getLastSector() + 1 === $nextSector; $endGarbage = $this->garbageTable->end()){
+			$nextSector = $endGarbage->getFirstSector();
+			$this->garbageTable->remove($endGarbage);
+		}
+
+		if($nextSector !== $this->nextSector){
+			$this->nextSector = $nextSector;
+			ftruncate($this->filePointer, $this->nextSector << 12);
+		}
+	}
+
 	/**
 	 * @return void
 	 * @throws ChunkException
@@ -230,20 +243,7 @@ class RegionLoader{
 		$this->writeLocationIndex($index);
 
 		if($oldLocation !== null){
-			/* release the area containing the old copy to the garbage pool */
-			$this->garbageTable->add($oldLocation);
-
-			$endGarbage = $this->garbageTable->end();
-			$nextSector = $this->nextSector;
-			for(; $endGarbage !== null and $endGarbage->getLastSector() + 1 === $nextSector; $endGarbage = $this->garbageTable->end()){
-				$nextSector = $endGarbage->getFirstSector();
-				$this->garbageTable->remove($endGarbage);
-			}
-
-			if($nextSector !== $this->nextSector){
-				$this->nextSector = $nextSector;
-				ftruncate($this->filePointer, $this->nextSector << 12);
-			}
+			$this->disposeGarbageArea($oldLocation);
 		}
 	}
 
@@ -253,8 +253,12 @@ class RegionLoader{
 	 */
 	public function removeChunk(int $x, int $z){
 		$index = self::getChunkOffset($x, $z);
+		$oldLocation = $this->locationTable[$index];
 		$this->locationTable[$index] = null;
 		$this->writeLocationIndex($index);
+		if($oldLocation !== null){
+			$this->disposeGarbageArea($oldLocation);
+		}
 	}
 
 	/**

tests/phpstan/bootstrap.php

@@ -21,8 +21,6 @@
 
 declare(strict_types=1);
 
-define('pocketmine\_PHPSTAN_ANALYSIS', true);
-
 if(!defined('LEVELDB_ZLIB_RAW_COMPRESSION')){
 	//leveldb might not be loaded
 	define('LEVELDB_ZLIB_RAW_COMPRESSION', 4);