From 08e3b8ffdc179607ea7e86d22cf72072dd630ee6 Mon Sep 17 00:00:00 2001
From: "Dylan K. Taylor" <odigiman@gmail.com>
Date: Sat, 4 Jan 2020 14:56:53 +0000
Subject: [PATCH] build: added specialized script to create a server phar this
 is much easier to use than devtools, and allows us to make additional
 specializations for PM build that would otherwise just be a colossal pain in
 the ass.

---
 build/server-phar.php | 147 ++++++++++++++++++++++++++++++++++++++++++
 phpstan.neon.dist     |   2 +
 2 files changed, 149 insertions(+)
 create mode 100644 build/server-phar.php

diff --git a/build/server-phar.php b/build/server-phar.php
new file mode 100644
index 000000000..de0abee97
--- /dev/null
+++ b/build/server-phar.php
@@ -0,0 +1,147 @@
+<?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\build\server_phar;
+
+use pocketmine\utils\Git;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+/**
+ * @param string[]    $strings
+ * @param string|null $delim
+ *
+ * @return string[]
+ */
+function preg_quote_array(array $strings, string $delim = null) : array{
+	return array_map(function(string $str) use ($delim) : string{ return preg_quote($str, $delim); }, $strings);
+}
+
+/**
+ * @param string   $pharPath
+ * @param string   $basePath
+ * @param string[] $includedPaths
+ * @param array    $metadata
+ * @param string   $stub
+ * @param int      $signatureAlgo
+ * @param int|null $compression
+ *
+ * @return \Generator|string[]
+ */
+function buildPhar(string $pharPath, string $basePath, array $includedPaths, array $metadata, string $stub, int $signatureAlgo = \Phar::SHA1, ?int $compression = null){
+	$basePath = rtrim(str_replace("/", DIRECTORY_SEPARATOR, $basePath), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+	$includedPaths = array_map(function($path){
+		return rtrim(str_replace("/", DIRECTORY_SEPARATOR, $path), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+	}, $includedPaths);
+	yield "Creating output file $pharPath";
+	if(file_exists($pharPath)){
+		yield "Phar file already exists, overwriting...";
+		try{
+			\Phar::unlinkArchive($pharPath);
+		}catch(\PharException $e){
+			//unlinkArchive() doesn't like dodgy phars
+			unlink($pharPath);
+		}
+	}
+
+	yield "Adding files...";
+
+	$start = microtime(true);
+	$phar = new \Phar($pharPath);
+	$phar->setMetadata($metadata);
+	$phar->setStub($stub);
+	$phar->setSignatureAlgorithm($signatureAlgo);
+	$phar->startBuffering();
+
+	//If paths contain any of these, they will be excluded
+	$excludedSubstrings = preg_quote_array([
+		realpath($pharPath), //don't add the phar to itself
+	], '/');
+
+	$folderPatterns = preg_quote_array([
+		DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR,
+		DIRECTORY_SEPARATOR . '.' //"Hidden" files, git dirs etc
+	], '/');
+
+	//Only exclude these within the basedir, otherwise the project won't get built if it itself is in a directory that matches these patterns
+	$basePattern = preg_quote(rtrim($basePath, DIRECTORY_SEPARATOR), '/');
+	foreach($folderPatterns as $p){
+		$excludedSubstrings[] = $basePattern . '.*' . $p;
+	}
+
+	$regex = sprintf('/^(?!.*(%s))^%s(%s).*/i',
+		 implode('|', $excludedSubstrings), //String may not contain any of these substrings
+		 preg_quote($basePath, '/'), //String must start with this path...
+		 implode('|', preg_quote_array($includedPaths, '/')) //... and must be followed by one of these relative paths, if any were specified. If none, this will produce a null capturing group which will allow anything.
+	);
+
+	$directory = new \RecursiveDirectoryIterator($basePath, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS | \FilesystemIterator::CURRENT_AS_PATHNAME); //can't use fileinfo because of symlinks
+	$iterator = new \RecursiveIteratorIterator($directory);
+	$regexIterator = new \RegexIterator($iterator, $regex);
+
+	$count = count($phar->buildFromIterator($regexIterator, $basePath));
+	yield "Added $count files";
+
+	if($compression !== null){
+		yield "Checking for compressible files...";
+		foreach($phar as $file => $finfo){
+			/** @var \PharFileInfo $finfo */
+			if($finfo->getSize() > (1024 * 512)){
+				yield "Compressing " . $finfo->getFilename();
+				$finfo->compress($compression);
+			}
+		}
+	}
+	$phar->stopBuffering();
+
+	yield "Done in " . round(microtime(true) - $start, 3) . "s";
+}
+
+function main() : void{
+	if(ini_get("phar.readonly") == 1){
+		echo "Set phar.readonly to 0 with -dphar.readonly=0" . PHP_EOL;
+		exit(1);
+	}
+
+	$opts = getopt("", ["out:"]);
+	$gitHash = Git::getRepositoryStatePretty(dirname(__DIR__));
+	echo "Git hash detected as $gitHash" . PHP_EOL;
+	foreach(buildPhar(
+		$opts["out"] ?? getcwd() . DIRECTORY_SEPARATOR . "PocketMine-MP.phar",
+		dirname(__DIR__) . DIRECTORY_SEPARATOR,
+		[
+			'src',
+			'vendor'
+		],
+		[
+			'git' => $gitHash
+		],
+		'<?php require("phar://" . __FILE__ . "/src/pocketmine/PocketMine.php"); __HALT_COMPILER();'
+	) as $line){
+		echo $line . PHP_EOL;
+	}
+}
+
+if(!defined('pocketmine\_PHPSTAN_ANALYSIS')){
+	main();
+}
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
index 3588a1117..f46f022b7 100644
--- a/phpstan.neon.dist
+++ b/phpstan.neon.dist
@@ -11,8 +11,10 @@ parameters:
 	autoload_files:
 		- tests/phpstan/bootstrap.php
 		- src/pocketmine/PocketMine.php
+		- build/server-phar.php
 	paths:
 		- src
+		- build/server-phar.php
 	dynamicConstantNames:
 		- pocketmine\IS_DEVELOPMENT_BUILD
 		- pocketmine\DEBUG