Adding upstream version 2.5.0.upstream/2.5.0upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 570 insertions, 0 deletions

diff --git a/library/Businessprocess/Node.php b/library/Businessprocess/Node.php
new file mode 100644
index 0000000..a0c07d2
--- /dev/null
+++ b/library/Businessprocess/Node.php
@@ -0,0 +1,570 @@
+<?php
+
+namespace Icinga\Module\Businessprocess;
+
+use Icinga\Exception\ProgrammingError;
+use ipl\Html\Html;
+use ipl\Web\Widget\Icon;
+
+abstract class Node
+{
+    const FLAG_DOWNTIME = 1;
+    const FLAG_ACK      = 2;
+    const FLAG_MISSING  = 4;
+    const FLAG_NONE     = 8;
+    const SHIFT_FLAGS   = 4;
+
+    const ICINGA_OK          = 0;
+    const ICINGA_WARNING     = 1;
+    const ICINGA_CRITICAL    = 2;
+    const ICINGA_UNKNOWN     = 3;
+    const ICINGA_UP          = 0;
+    const ICINGA_DOWN        = 1;
+    const ICINGA_UNREACHABLE = 2;
+    const ICINGA_PENDING     = 99;
+    const NODE_EMPTY         = 128;
+
+    /** @var bool Whether to treat acknowledged hosts/services always as UP/OK */
+    protected static $ackIsOk = false;
+
+    /** @var bool Whether to treat hosts/services in downtime always as UP/OK */
+    protected static $downtimeIsOk = false;
+
+    protected $sortStateToStateMap = array(
+        4 => self::ICINGA_CRITICAL,
+        3 => self::ICINGA_UNKNOWN,
+        2 => self::ICINGA_WARNING,
+        1 => self::ICINGA_PENDING,
+        0 => self::ICINGA_OK
+    );
+
+    protected $stateToSortStateMap = array(
+        self::ICINGA_PENDING  => 1,
+        self::ICINGA_UNKNOWN  => 3,
+        self::ICINGA_CRITICAL => 4,
+        self::ICINGA_WARNING  => 2,
+        self::ICINGA_OK       => 0,
+        self::NODE_EMPTY      => 0
+    );
+
+    /** @var ?string Alias of the node */
+    protected $alias;
+
+    /**
+     * Main business process object
+     *
+     * @var BpConfig
+     */
+    protected $bp;
+
+    /**
+     * Parent nodes
+     *
+     * @var array
+     */
+    protected $parents = array();
+
+    /**
+     * Node identifier
+     *
+     * @var string
+     */
+    protected $name;
+
+    /**
+     * Node state
+     *
+     * @var ?int
+     */
+    protected $state;
+
+    /**
+     * Whether this nodes state has been acknowledged
+     *
+     * @var bool
+     */
+    protected $ack;
+
+    /**
+     * Whether this node is in a scheduled downtime
+     *
+     * @var bool
+     */
+    protected $downtime;
+
+    // obsolete
+    protected $duration;
+
+    /**
+     * This node's icon
+     *
+     * @var ?string
+     */
+    protected $icon;
+
+    /**
+     * Last state change, unix timestamp
+     *
+     * @var int
+     */
+    protected $lastStateChange;
+
+    protected $missing = false;
+
+    protected $empty = false;
+
+    protected $className = 'unknown';
+
+    protected $stateNames = array(
+        'OK',
+        'WARNING',
+        'CRITICAL',
+        'UNKNOWN',
+        99 => 'PENDING',
+        128 => 'EMPTY'
+    );
+
+    /**
+     * Set whether to treat acknowledged hosts/services always as UP/OK
+     *
+     * @param bool $ackIsOk
+     */
+    public static function setAckIsOk($ackIsOk = true)
+    {
+        self::$ackIsOk = $ackIsOk;
+    }
+
+    /**
+     * Set whether to treat hosts/services in downtime always as UP/OK
+     *
+     * @param bool $downtimeIsOk
+     */
+    public static function setDowntimeIsOk($downtimeIsOk = true)
+    {
+        self::$downtimeIsOk = $downtimeIsOk;
+    }
+
+    public function setBpConfig(BpConfig $bp)
+    {
+        $this->bp = $bp;
+        return $this;
+    }
+
+    public function getBpConfig()
+    {
+        return $this->bp;
+    }
+
+    public function setMissing($missing = true)
+    {
+        $this->missing = $missing;
+        return $this;
+    }
+
+    public function isProblem()
+    {
+        return $this->getState() > 0;
+    }
+
+    public function hasBeenChanged()
+    {
+        return false;
+    }
+
+    public function isMissing()
+    {
+        return $this->missing;
+    }
+
+    public function hasMissingChildren()
+    {
+        return count($this->getMissingChildren()) > 0;
+    }
+
+    public function getMissingChildren()
+    {
+        return array();
+    }
+
+    public function hasInfoUrl()
+    {
+        return false;
+    }
+
+    public function setState($state)
+    {
+        $this->state = (int) $state;
+        $this->missing = false;
+        return $this;
+    }
+
+    /**
+     * Forget my state
+     *
+     * @return $this
+     */
+    public function clearState()
+    {
+        $this->state = null;
+        return $this;
+    }
+
+    public function setAck($ack = true)
+    {
+        $this->ack = $ack;
+        return $this;
+    }
+
+    public function setDowntime($downtime = true)
+    {
+        $this->downtime = $downtime;
+        return $this;
+    }
+
+    public function getStateName($state = null)
+    {
+        $states = $this->enumStateNames();
+        if ($state === null) {
+            return $states[ $this->getState() ];
+        } else {
+            return $states[ $state ];
+        }
+    }
+
+    public function enumStateNames()
+    {
+        return $this->stateNames;
+    }
+
+    public function getState()
+    {
+        if ($this->state === null) {
+            throw new ProgrammingError(
+                sprintf(
+                    'Node %s is unable to retrieve it\'s state',
+                    $this->name
+                )
+            );
+        }
+
+        return $this->state;
+    }
+
+    public function getSortingState($state = null)
+    {
+        if ($state === null) {
+            $state = $this->getState();
+        }
+
+        if (self::$ackIsOk && $this->isAcknowledged()) {
+            $state = self::ICINGA_OK;
+        }
+
+        if (self::$downtimeIsOk && $this->isInDowntime()) {
+            $state = self::ICINGA_OK;
+        }
+
+        $sort = $this->stateToSortState($state);
+        $sort = ($sort << self::SHIFT_FLAGS)
+               + ($this->isInDowntime() ? self::FLAG_DOWNTIME : 0)
+               + ($this->isAcknowledged() ? self::FLAG_ACK : 0);
+        if (! ($sort & (self::FLAG_DOWNTIME | self::FLAG_ACK))) {
+            $sort |= self::FLAG_NONE;
+        }
+
+        return $sort;
+    }
+
+    public function getLastStateChange()
+    {
+        return $this->lastStateChange;
+    }
+
+    public function setLastStateChange($timestamp)
+    {
+        $this->lastStateChange = $timestamp;
+        return $this;
+    }
+
+    public function addParent(Node $parent)
+    {
+        $this->parents[] = $parent;
+        return $this;
+    }
+
+    public function getDuration()
+    {
+        return $this->duration;
+    }
+
+    public function isHandled()
+    {
+        return $this->isInDowntime() || $this->isAcknowledged();
+    }
+
+    public function isInDowntime()
+    {
+        if ($this->downtime === null) {
+            $this->getState();
+        }
+        return $this->downtime;
+    }
+
+    public function isAcknowledged()
+    {
+        if ($this->ack === null) {
+            $this->getState();
+        }
+        return $this->ack;
+    }
+
+    public function getChildren($filter = null)
+    {
+        return array();
+    }
+
+    public function countChildren($filter = null)
+    {
+        return count($this->getChildren($filter));
+    }
+
+    public function hasChildren($filter = null)
+    {
+        return $this->countChildren($filter) > 0;
+    }
+
+    public function isEmpty()
+    {
+        return $this->countChildren() === 0;
+    }
+
+    public function hasAlias()
+    {
+        return $this->alias !== null;
+    }
+
+    /**
+     * Get the alias of the node
+     *
+     * @return ?string
+     */
+    public function getAlias()
+    {
+        return $this->alias;
+    }
+
+    /**
+     * Set the alias of the node
+     *
+     * @param string $alias
+     *
+     * @return $this
+     */
+    public function setAlias($alias)
+    {
+        $this->alias = $alias;
+
+        return $this;
+    }
+
+    public function hasParents()
+    {
+        return count($this->parents) > 0;
+    }
+
+    public function hasParentName($name)
+    {
+        foreach ($this->getParents() as $parent) {
+            if ($parent->getName() === $name) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public function removeParent($name)
+    {
+        $this->parents = array_filter(
+            $this->parents,
+            function (BpNode $parent) use ($name) {
+                return $parent->getName() !== $name;
+            }
+        );
+
+        return $this;
+    }
+
+    /**
+     * @return BpNode[]
+     */
+    public function getParents()
+    {
+        return $this->parents;
+    }
+
+    /**
+     * @param BpConfig $rootConfig
+     *
+     * @return array
+     */
+    public function getPaths($rootConfig = null)
+    {
+        $differentConfig = false;
+        if ($rootConfig === null) {
+            $rootConfig = $this->getBpConfig();
+        } else {
+            $differentConfig = $this->getBpConfig()->getName() !== $rootConfig->getName();
+        }
+
+        $paths = [];
+        foreach ($this->parents as $parent) {
+            foreach ($parent->getPaths($rootConfig) as $path) {
+                $path[] = $differentConfig ? $this->getIdentifier() : $this->getName();
+                $paths[] = $path;
+            }
+        }
+
+        if (! $this instanceof ImportedNode && $this->getBpConfig()->hasRootNode($this->getName())) {
+            $paths[] = [$differentConfig ? $this->getIdentifier() : $this->getName()];
+        } elseif (! $this->hasParents()) {
+            $paths[] = ['__unbound__', $differentConfig ? $this->getIdentifier() : $this->getName()];
+        }
+
+        return $paths;
+    }
+
+    protected function stateToSortState($state)
+    {
+        if (array_key_exists($state, $this->stateToSortStateMap)) {
+            return $this->stateToSortStateMap[$state];
+        }
+
+        throw new ProgrammingError(
+            'Got invalid state for node %s: %s',
+            $this->getName(),
+            var_export($state, true) . var_export($this->stateToSortStateMap, true)
+        );
+    }
+
+    protected function sortStateTostate($sortState)
+    {
+        $sortState = $sortState >> self::SHIFT_FLAGS;
+        if (array_key_exists($sortState, $this->sortStateToStateMap)) {
+            return $this->sortStateToStateMap[$sortState];
+        }
+
+        throw new ProgrammingError('Got invalid sorting state %s', $sortState);
+    }
+
+    public function getObjectClassName()
+    {
+        return $this->className;
+    }
+
+    public function getLink()
+    {
+        return Html::tag('a', ['href' => '#', 'class' => 'toggle'], new Icon('caret-down'));
+    }
+
+    public function getIcon(): Icon
+    {
+        return new Icon($this->icon ?? 'circle-exclamation');
+    }
+
+    public function operatorHtml()
+    {
+        return '&nbsp;';
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * Get the Node operators
+     *
+     * @return array
+     */
+    public static function getOperators(): array
+    {
+        return [
+            '&' => t('AND'),
+            '|' => t('OR'),
+            '^' => t('XOR'),
+            '!' => t('NOT'),
+            '%' => t('DEGRADED'),
+            '1' => t('MIN 1'),
+            '2' => t('MIN 2'),
+            '3' => t('MIN 3'),
+            '4' => t('MIN 4'),
+            '5' => t('MIN 5'),
+            '6' => t('MIN 6'),
+            '7' => t('MIN 7'),
+            '8' => t('MIN 8'),
+            '9' => t('MIN 9'),
+        ];
+    }
+
+    public function getIdentifier()
+    {
+        return '@' . $this->getBpConfig()->getName() . ':' . $this->getName();
+    }
+
+    public function __toString()
+    {
+        return $this->getName();
+    }
+
+    public function __destruct()
+    {
+        unset($this->parents);
+    }
+
+    /**
+     * Export the node to array
+     *
+     * @param   array   $parent The node's parent. Used to construct the path to the node
+     * @param   bool    $flat   If false, children will be added to the array key children, else the array will be flat
+     *
+     * @return  array
+     */
+    public function toArray(array $parent = null, $flat = false)
+    {
+        $data = [
+            'name'  => $this->getAlias(),
+            'state' => $this->getStateName(),
+            'since' => $this->getLastStateChange(),
+            'in_downtime' => $this->isInDowntime() ? true : false
+        ];
+
+        if ($parent !== null) {
+            $data['path'] = $parent['path'] . '!' . $this->getAlias();
+        } else {
+            $data['path'] = $this->getAlias();
+        }
+
+        $children = [];
+
+        foreach ($this->getChildren() as $node) {
+            if ($flat) {
+                $children = array_merge($children, $node->toArray($data, $flat));
+            } else {
+                $children[] = $node->toArray($data, $flat);
+            }
+        }
+
+        if ($flat) {
+            $data = [$data];
+
+            if (! empty($children)) {
+                $data = array_merge($data, $children);
+            }
+        } else {
+            $data['children'] = $children;
+        }
+
+        return $data;
+    }
+}