Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/captainhook/captainhook/src/ |
<?php
/**
* This file is part of CaptainHook
*
* (c) Sebastian Feldmann <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace CaptainHook\App;
use CaptainHook\App\Config\Run;
use InvalidArgumentException;
use SebastianFeldmann\Camino\Check;
/**
* Class Config
*
* @package CaptainHook
* @author Sebastian Feldmann <[email protected]>
* @link https://github.com/captainhookphp/captainhook
* @since Class available since Release 0.9.0
* @internal
*/
class Config
{
public const SETTING_ALLOW_FAILURE = 'allow-failure';
public const SETTING_BOOTSTRAP = 'bootstrap';
public const SETTING_COLORS = 'ansi-colors';
public const SETTING_CUSTOM = 'custom';
public const SETTING_GIT_DIR = 'git-directory';
public const SETTING_INCLUDES = 'includes';
public const SETTING_INCLUDES_LEVEL = 'includes-level';
public const SETTING_LABEL = 'label';
public const SETTING_RUN_EXEC = 'run-exec';
public const SETTING_RUN_MODE = 'run-mode';
public const SETTING_RUN_PATH = 'run-path';
public const SETTING_RUN_GIT = 'run-git';
public const SETTING_PHP_PATH = 'php-path';
public const SETTING_VERBOSITY = 'verbosity';
public const SETTING_FAIL_ON_FIRST_ERROR = 'fail-on-first-error';
/**
* Path to the config file
*
* @var string
*/
private string $path;
/**
* Does the config file exist
*
* @var bool
*/
private bool $fileExists;
/**
* CaptainHook settings
*
* @var array<string, string>
*/
private array $settings;
/**
* All options related to running CaptainHook
*
* @var \CaptainHook\App\Config\Run
*/
private Run $runConfig;
/**
* List of users custom settings
*
* @var array<string, mixed>
*/
private array $custom = [];
/**
* List of plugins
*
* @var array<string, \CaptainHook\App\Config\Plugin>
*/
private array $plugins = [];
/**
* List of hook configs
*
* @var array<string, \CaptainHook\App\Config\Hook>
*/
private array $hooks = [];
/**
* Config constructor
*
* @param string $path
* @param bool $fileExists
* @param array<string, mixed> $settings
*/
public function __construct(string $path, bool $fileExists = false, array $settings = [])
{
$settings = $this->setupPlugins($settings);
$settings = $this->setupCustom($settings);
$settings = $this->setupRunConfig($settings);
$this->path = $path;
$this->fileExists = $fileExists;
$this->settings = $settings;
foreach (Hooks::getValidHooks() as $hook => $value) {
$this->hooks[$hook] = new Config\Hook($hook);
}
}
/**
* Extract custom settings from Captain Hook ones
*
* @param array<string, mixed> $settings
* @return array<string, mixed>
*/
private function setupCustom(array $settings): array
{
/* @var array<string, mixed> $custom */
$this->custom = $settings['custom'] ?? [];
unset($settings['custom']);
return $settings;
}
/**
* Setup all configured plugins
*
* @param array<string, mixed> $settings
* @return array<string, mixed>
*/
private function setupPlugins(array $settings): array
{
/* @var array<int, array<string, mixed>> $pluginSettings */
$pluginSettings = $settings['plugins'] ?? [];
unset($settings['plugins']);
foreach ($pluginSettings as $plugin) {
$name = (string) $plugin['plugin'];
$options = isset($plugin['options']) && is_array($plugin['options'])
? $plugin['options']
: [];
$this->plugins[$name] = new Config\Plugin($name, $options);
}
return $settings;
}
/**
* Extract all running related settings into a run configuration
*
* @param array<string, mixed> $settings
* @return array<string, mixed>
*/
private function setupRunConfig(array $settings): array
{
// extract the legacy settings
$settingsToMove = [
self::SETTING_RUN_MODE,
self::SETTING_RUN_EXEC,
self::SETTING_RUN_PATH,
self::SETTING_RUN_GIT
];
$config = [];
foreach ($settingsToMove as $setting) {
if (!empty($settings[$setting])) {
$config[substr($setting, 4)] = $settings[$setting];
}
unset($settings[$setting]);
}
// make sure the new run configuration supersedes the legacy settings
if (isset($settings['run']) && is_array($settings['run'])) {
$config = array_merge($config, $settings['run']);
unset($settings['run']);
}
$this->runConfig = new Run($config);
return $settings;
}
/**
* Is configuration loaded from file
*
* @return bool
*/
public function isLoadedFromFile(): bool
{
return $this->fileExists;
}
/**
* Are actions allowed to fail without stopping the git operation
*
* @return bool
*/
public function isFailureAllowed(): bool
{
return (bool) ($this->settings[self::SETTING_ALLOW_FAILURE] ?? false);
}
/**
* @param string $hook
* @param bool $withVirtual if true, also check if hook is enabled through any enabled virtual hook
* @return bool
*/
public function isHookEnabled(string $hook, bool $withVirtual = true): bool
{
// either this hook is explicitly enabled
$hookConfig = $this->getHookConfig($hook);
if ($hookConfig->isEnabled()) {
return true;
}
// or any virtual hook that triggers it is enabled
if ($withVirtual && Hooks::triggersVirtualHook($hookConfig->getName())) {
$virtualHookConfig = $this->getHookConfig(Hooks::getVirtualHook($hookConfig->getName()));
if ($virtualHookConfig->isEnabled()) {
return true;
}
}
return false;
}
/**
* Path getter
*
* @return string
*/
public function getPath(): string
{
return $this->path;
}
/**
* Return git directory path if configured, CWD/.git if not
*
* @return string
*/
public function getGitDirectory(): string
{
if (empty($this->settings[self::SETTING_GIT_DIR])) {
return getcwd() . '/.git';
}
// if repo path is absolute use it otherwise create an absolute path relative to the configuration file
return Check::isAbsolutePath($this->settings[self::SETTING_GIT_DIR])
? $this->settings[self::SETTING_GIT_DIR]
: dirname($this->path) . '/' . $this->settings[self::SETTING_GIT_DIR];
}
/**
* Return bootstrap file if configured, CWD/vendor/autoload.php by default
*
* @return string
*/
public function getBootstrap(): string
{
return !empty($this->settings[self::SETTING_BOOTSTRAP])
? $this->settings[self::SETTING_BOOTSTRAP]
: 'vendor/autoload.php';
}
/**
* Return the configured verbosity
*
* @return string
*/
public function getVerbosity(): string
{
return !empty($this->settings[self::SETTING_VERBOSITY])
? $this->settings[self::SETTING_VERBOSITY]
: 'normal';
}
/**
* Should the output use ansi colors
*
* @return bool
*/
public function useAnsiColors(): bool
{
return (bool) ($this->settings[self::SETTING_COLORS] ?? true);
}
/**
* Get configured php-path
*
* @return string
*/
public function getPhpPath(): string
{
return (string) ($this->settings[self::SETTING_PHP_PATH] ?? '');
}
/**
* Get run configuration
*
* @return \CaptainHook\App\Config\Run
*/
public function getRunConfig(): Run
{
return $this->runConfig;
}
/**
* Returns the users custom config values
*
* @return array<mixed>
*/
public function getCustomSettings(): array
{
return $this->custom;
}
/**
* Whether to abort the hook as soon as a any action has errored. Default is true.
* Otherwise, all actions get executed (even if some of them have failed) and
* finally, a non-zero exit code is returned if any action has errored.
*
* @return bool
*/
public function failOnFirstError(): bool
{
return (bool) ($this->settings[self::SETTING_FAIL_ON_FIRST_ERROR] ?? true);
}
/**
* Return config for given hook
*
* @param string $hook
* @return \CaptainHook\App\Config\Hook
* @throws \InvalidArgumentException
*/
public function getHookConfig(string $hook): Config\Hook
{
if (!Hook\Util::isValid($hook)) {
throw new InvalidArgumentException('Invalid hook name: ' . $hook);
}
return $this->hooks[$hook];
}
/**
* Returns a hook config containing all the actions to execute
*
* Returns all actions from the triggered hook but also any actions of virtual hooks that might be triggered.
* E.g. 'post-rewrite' or 'post-checkout' trigger the virtual/artificial 'post-change' hook.
* Virtual hooks are special hooks to simplify configuration.
*
* @param string $hook
* @return \CaptainHook\App\Config\Hook
*/
public function getHookConfigToExecute(string $hook): Config\Hook
{
$config = new Config\Hook($hook, true);
$hookConfig = $this->getHookConfig($hook);
$config->addAction(...$hookConfig->getActions());
if (Hooks::triggersVirtualHook($hookConfig->getName())) {
$vHookConfig = $this->getHookConfig(Hooks::getVirtualHook($hookConfig->getName()));
if ($vHookConfig->isEnabled()) {
$config->addAction(...$vHookConfig->getActions());
}
}
return $config;
}
/**
* Return plugins
*
* @return Config\Plugin[]
*/
public function getPlugins(): array
{
return $this->plugins;
}
/**
* Return config array to write to disc
*
* @return array<string, mixed>
*/
public function getJsonData(): array
{
$data = [];
if (!empty($this->settings)) {
$data['config'] = $this->settings;
}
$runConfigData = $this->runConfig->getJsonData();
if (!empty($runConfigData)) {
$data['config']['run'] = $runConfigData;
}
if (!empty($this->plugins)) {
$data['config']['plugins'] = $this->getPluginsJsonData();
}
foreach (Hooks::getValidHooks() as $hook => $value) {
$data[$hook] = $this->hooks[$hook]->getJsonData();
}
return $data;
}
/**
* Collect and return plugin json data for all plugins
*
* @return array<int, mixed>
*/
private function getPluginsJsonData(): array
{
$plugins = [];
foreach ($this->plugins as $plugin) {
$plugins[] = $plugin->getJsonData();
}
return $plugins;
}
}