%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
namespace CirrusSearch\Maintenance\Validators;
use CirrusSearch\Maintenance\Maintenance;
abstract class Validator {
/**
* @var Maintenance
*/
protected $maint;
/**
* @var bool
*/
protected $printDebugCheckConfig = false;
/**
* @param Maintenance $maint Maintenance object, to relay output to.
*/
public function __construct( Maintenance $maint ) {
$this->maint = $maint;
}
/**
* @return \Status
*/
abstract public function validate();
/**
* @param bool $print
*/
public function printDebugCheckConfig( $print = true ) {
$this->printDebugCheckConfig = (bool) $print;
}
/**
* @param mixed $actual
* @param array $required
* @param string|null $indent
* @return bool
*/
protected function checkConfig( $actual, array $required, $indent = null ) {
foreach( $required as $key => $value ) {
$this->debugCheckConfig( "\n$indent$key: " );
if ( !array_key_exists( $key, $actual ) ) {
$this->debugCheckConfig( "not found..." );
if ( $key === '_all' ) {
// The _all field never comes back so we just have to assume it
// is set correctly.
$this->debugCheckConfig( "was the all field so skipping..." );
continue;
}
return false;
}
if ( is_array( $value ) ) {
$this->debugCheckConfig( "descend..." );
if ( !is_array( $actual[ $key ] ) ) {
$this->debugCheckConfig( "other not array..." );
return false;
}
if ( !$this->checkConfig( $actual[ $key ], $value, $indent . "\t" ) ) {
return false;
}
continue;
}
$actual[ $key ] = $this->normalizeConfigValue( $actual[ $key ] );
$value = $this->normalizeConfigValue( $value );
$this->debugCheckConfig( $actual[ $key ] . " ?? $value..." );
// Note that I really mean !=, not !==. Coercion is cool here.
// print $actual[ $key ] . " $value\n";
if ( $actual[ $key ] != $value ) {
$this->debugCheckConfig( 'different...' );
return false;
}
}
return true;
}
/**
* Normalize a config value for comparison. Elasticsearch will accept all kinds
* of config values but it tends to through back 'true' for true and 'false' for
* false so we normalize everything. Sometimes, oddly, it'll through back false
* for false....
*
* @param mixed $value config value
* @return mixed value normalized
*/
private function normalizeConfigValue( $value ) {
if ( $value === true ) {
return 'true';
} else if ( $value === false ) {
return 'false';
}
return $value;
}
/**
* @param string $string
*/
private function debugCheckConfig( $string ) {
if ( $this->printDebugCheckConfig ) {
$this->output( $string );
}
}
/**
* @param string $message
* @param mixed $channel
*/
protected function output( $message, $channel = null ) {
if ( $this->maint ) {
$this->maint->output( $message, $channel );
}
}
/**
* @param string $message
*/
protected function outputIndented( $message ) {
if ( $this->maint ) {
$this->maint->outputIndented( $message );
}
}
}
Zerion Mini Shell 1.0