cs\Builder

Complexity

Total Complexity

32

Size/Duplication

Total Lines	379
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

96.07%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
B	get_htaccess()	0	33	1
A	module()	0	6	2
A	theme()	0	6	2
C	generic_package_creation()	0	63	11
C	core()	0	131	7
B	get_core_files()	0	33	4
A	filter_and_add_components()	0	10	1
B	get_component_files()	0	28	3

<?php
/**
 * @package    CleverStyle Framework
 * @subpackage Builder
 * @author     Nazar Mokrynskyi <nazar@mokrynskyi.com>
 * @copyright  Copyright (c) 2011-2017, Nazar Mokrynskyi
 * @license    MIT License, see license.txt
 */
namespace cs;
use
	Phar;

class Builder {
	/**
	 * @var string
	 */
	protected $root;
	/**
	 * @var string
	 */
	protected $target;
	/**
	 * @param string $root
	 * @param string $target
	 */
	public function __construct ($root, $target) {
		$this->root   = $root;
		$this->target = $target;
		/** @noinspection MkdirRaceConditionInspection */
		@mkdir($target);
	}
	/**
	 * @param string[]    $modules
	 * @param string[]    $themes
	 * @param null|string $suffix
	 *
	 * @return string
	 *
	 * @throws \UnexpectedValueException
	 * @throws \BadMethodCallException
	 */
	public function core ($modules = [], $themes = [], $suffix = null) {
		$suffix      = $suffix ? "_$suffix" : '';
		$version     = file_get_json("$this->root/modules/System/meta.json")['version'];
		$target_file = "$this->target/CleverStyle_Framework_$version$suffix.phar.php";
		if (file_exists($target_file)) {
			unlink($target_file);
		}
		$phar = new Phar($target_file);
		unset($target_file);
		$phar->startBuffering();
		$length = strlen("$this->root/");
		/** @noinspection ForeachSourceInspection */
		foreach (get_files_list("$this->root/install", false, 'f', '', true) as $file) {
			$phar->addFile("$this->root/install/$file", $file);
		}
		unset($file);
		$phar->addFile("$this->root/assets/img/logo.svg", 'logo.svg');
		/**
		 * Core files to be included into installation package
		 */
		$core_files = $this->get_core_files();
		/**
		 * Add modules that should be built-in into package
		 */
		$components_files = [];
		$modules          = $this->filter_and_add_components("$this->root/modules", $modules, $components_files);
		$phar->addFromString('modules.json', _json_encode($modules));
		/**
		 * Add themes that should be built-in into package
		 */
		$themes = $this->filter_and_add_components("$this->root/themes", $themes, $components_files);
		$phar->addFromString('themes.json', _json_encode($themes));
		/**
		 * Joining system and components files
		 */
		$core_files = array_merge($core_files, $components_files);
		/**
		 * Addition of files into package
		 */
		foreach ($core_files as $index => &$file) {
			$phar->addFile($file, "fs/$index");
			$file = substr($file, $length);
		}
		unset($index, $file);
		/**
		 * Add license under the file `license-cleverstyle-framework.txt` rather than `license.txt`, so that license is not enforced on projects using it and is
		 * not overridden on framework update
		 */
		$phar->addFile("$this->root/license.txt", 'fs/'.count($core_files));
		$core_files[] = 'license-cleverstyle-framework.txt';
		/**
		 * Addition of separate files into package
		 */
		$phar->addFromString(
			'languages.json',
			_json_encode(
				array_merge(
					_substr(get_files_list("$this->root/core/languages", '/^.*?\.php$/i', 'f'), 0, -4) ?: [],
					_substr(get_files_list("$this->root/core/languages", '/^.*?\.json$/i', 'f'), 0, -5) ?: []
				)
			)
		);
		$phar->addFromString(
			'db_drivers.json',
			_json_encode(
				_substr(get_files_list("$this->root/core/drivers/DB", '/^[^_].*?\.php$/i', 'f'), 0, -4)
			)
		);
		/**
		 * Fixation of system files list (without components files), it is needed for future system updating
		 */
		$phar->addFromString(
			'fs.json',
			_json_encode(
				array_flip(
					array_diff(
						$core_files,
						_substr($components_files, $length)
					)
				)
			)
		);
		unset($components_files, $length);
		/**
		 * Addition of files, that are needed only for installation
		 */
		$phar->addFromString('fs/'.count($core_files), $this->get_htaccess());
		$core_files[] = '.htaccess';
		$phar->addFile("$this->root/config/main.php", 'fs/'.count($core_files));
		$core_files[] = 'config/main.php';
		$phar->addFile("$this->root/favicon.ico", 'fs/'.count($core_files));
		$core_files[] = 'favicon.ico';
		$phar->addFile("$this->root/.gitignore", 'fs/'.count($core_files));
		$core_files[] = '.gitignore';
		/**
		 * Flip array to have direct access to files by name during extracting and installation, and fixing of files list for installation
		 */
		$phar->addFromString(
			'fs_installer.json',
			_json_encode(
				array_flip($core_files)
			)
		);
		unset($core_files);
		/**
		 * Addition of supplementary files, that are needed directly for installation process: installer with GUI interface, readme, license, some additional
		 * information about available languages, themes, current version of system
		 */
		$phar->addFile("$this->root/license.txt", 'license.txt');
		$phar->addFile("$this->root/modules/System/meta.json", 'meta.json');
		$phar->setStub(
		/** @lang PHP */
			<<<STUB
<?php
if (version_compare(PHP_VERSION, '7.0', '<')) {
	echo 'CleverStyle Framework requires PHP 7.0 or higher';
	return;
}

if (php_sapi_name() == 'cli') {
	Phar::mapPhar('cleverstyle_framework.phar');
	include 'phar://cleverstyle_framework.phar/cli.php';
} else {
	Phar::webPhar(null, 'web.php');
}
__HALT_COMPILER();
STUB
		);
		$phar->stopBuffering();
		return "Done! CleverStyle Framework $version";
	}
	/**
	 * Get array of files
	 *
	 * @return string[]
	 */
	protected function get_core_files () {
		$files_to_include = [
			"$this->root/assets",
			"$this->root/blocks/.gitkept",
			"$this->root/core",
			"$this->root/custom",
			"$this->root/modules/System",
			"$this->root/storage/.htaccess",
			"$this->root/storage/public_cache/.htaccess",
			"$this->root/storage/public/.htaccess",
			"$this->root/storage/temp/.htaccess",
			"$this->root/themes/CleverStyle",
			"$this->root/bower.json",
			"$this->root/cli",
			"$this->root/composer.json",
			"$this->root/composer.lock",
			"$this->root/index.php",
			"$this->root/package.json"
		];
		$files            = [];
		foreach ($files_to_include as $s) {
			if (is_file($s)) {
				$files[] = $s;
			} elseif (is_dir($s)) {
				/** @noinspection SlowArrayOperationsInLoopInspection */
				$files = array_merge(
					$files,
					get_files_list($s, false, 'f', true, true, false, false, true)
				);
			}
		}
		return $files;
	}
	/**
	 * @param string   $dir
	 * @param string[] $components
	 * @param string[] $components_files
	 *
	 * @return string[]
	 */
	protected function filter_and_add_components ($dir, $components, &$components_files) {
		$components = array_filter(
			$components,
			function ($component) use ($dir, &$components_files) {
				return $this->get_component_files("$dir/$component", $components_files);
			}
		);
		sort($components);
		return $components;
	}
	/**
	 * @param string   $component_root
	 * @param string[] $files Array, where new files will be appended
	 *
	 * @return bool
	 */
	protected function get_component_files ($component_root, &$files) {
		/**
		 * Do not allow building System module and CleverStyle theme
		 */
		if (in_array(basename($component_root), ['System', 'CleverStyle'])) {
			return false;
		}
		/**
		 * Components without meta.json also not allowed
		 */
		if (!file_exists("$component_root/meta.json")) {
			return false;
		}
		@unlink("$component_root/fs.json");
		$local_files = get_files_list($component_root, false, 'f', true, true, false, false, true);
		$files       = array_merge($files, $local_files);
		file_put_json(
			"$component_root/fs.json",
			array_values(
				_substr(
					$local_files,
					strlen("$component_root/")
				)
			)
		);
		$files[] = "$component_root/fs.json";
		return true;
	}
	/**
	 * @return string
	 */
	protected function get_htaccess () {
		/** @lang ApacheConfig */
		return <<<HTACCESS
AddDefaultCharset utf-8
Options -Indexes -Multiviews +FollowSymLinks
IndexIgnore *.php *.pl *.cgi *.htaccess *.htpasswd
FileETag None

RewriteEngine On
RewriteBase /

<FilesMatch ".*/.*">
	Options -FollowSymLinks
</FilesMatch>
<FilesMatch "\.(css|js|gif|jpg|jpeg|png|ico|svg|svgz|ttc|ttf|otf|woff|woff2|eot)$">
	RewriteEngine Off
</FilesMatch>
<FilesMatch "\.(css|js|gif|jpg|jpeg|png|ico|svg|svgz|ttc|ttf|otf|woff|woff2|eot|html)$">
	<ifModule mod_expires.c>
		ExpiresActive On
		ExpiresDefault "access plus 1 month"
	</ifModule>
	<ifModule mod_headers.c>
		Header set Cache-Control "max-age=2592000, immutable"
	</ifModule>
</FilesMatch>
<Files license.txt>
	RewriteEngine Off
</Files>

RewriteRule .* index.php
HTACCESS;
	}
	/**
	 * @param string      $module
	 * @param null|string $suffix
	 *
	 * @return string
	 */
	public function module ($module, $suffix = null) {
		if ($module == 'System') {
			return "Can't build module, System module is a part of core, it is not necessary to build it as separate module";
		}
		return $this->generic_package_creation("$this->root/modules/$module", $suffix);
	}
	/**
	 * @param string      $theme
	 * @param null|string $suffix
	 *
	 * @return string
	 */
	public function theme ($theme, $suffix = null) {
		if ($theme == 'CleverStyle') {
			return "Can't build theme, CleverStyle theme is a part of core, it is not necessary to build it as separate theme";
		}
		return $this->generic_package_creation("$this->root/themes/$theme", $suffix);
	}
	/**
	 * @param string      $source_dir
	 * @param null|string $suffix
	 *
	 * @return string
	 */
	protected function generic_package_creation ($source_dir, $suffix = null) {
		if (!file_exists("$source_dir/meta.json")) {
			$component = basename($source_dir);
			return "Can't build $component, meta information (meta.json) not found";
		}
		$meta = file_get_json("$source_dir/meta.json");
		$type = '';
		$Type = '';
		switch ($meta['category']) {
			case 'modules':
				$type = 'module_';
				$Type = 'Module';
				break;
			case 'themes':
				$type = 'theme_';
				$Type = 'Theme';
				break;
		}
		$suffix      = $suffix ? "_$suffix" : '';
		$target_file = "$this->target/$type$meta[package]_$meta[version]$suffix.phar.php";
		if (file_exists($target_file)) {
			unlink($target_file);
		}
		$phar = new Phar($target_file);
		unset($target_file);
		$phar->startBuffering();
		@unlink("$source_dir/fs.json");
		$files  = get_files_list($source_dir, false, 'f', true, true, false, false, true);
		$length = strlen("$source_dir/");
		/** @noinspection ForeachSourceInspection */
		foreach ($files as $index => &$file) {
			$phar->addFile($file, "fs/$index");
			$file = substr($file, $length);
		}
		unset($index, $file, $length);
		/**
		 * Flip array to have direct access to files by name during extraction
		 */
		$phar->addFromString(
			'fs.json',
			_json_encode(
				array_flip($files)
			)
		);
		unset($files);
		$phar->addFile("$source_dir/meta.json", 'meta.json');
		$readme = false;
		if (file_exists("$source_dir/readme.html")) {
			$phar->addFile("$source_dir/readme.html", 'readme.html');
			$readme = 'readme.html';
		} elseif (file_exists("$source_dir/readme.txt")) {
			$phar->addFile("$source_dir/readme.txt", 'readme.txt');
			$readme = 'readme.txt';
		}
		if ($readme) {
			$phar->setStub("<?php Phar::webPhar(null, '$readme'); __HALT_COMPILER();");
		} else {
			$phar->addFromString('index.html', isset($meta['description']) ? $meta['description'] : $meta['package']);
			$phar->setStub("<?php Phar::webPhar(null, 'index.html'); __HALT_COMPILER();");
		}
		$phar->stopBuffering();
		return "Done! $Type $meta[package] $meta[version]";
	}
}