Server::canControlPower() - Code Metrics - Inspection of "Hid server power control panel from the clients." - hiqdev/hipanel-module-server - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 96a2a3...a63f8b )

by Andrii
created 2019-05-24 10:14 UTC
Server::canControlPower() A

↳ Parent: Server
Complexity

Conditions	4
Paths	6
Size

Total Lines	9
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	20
Importance

Changes
Metric	Value
eloc	5
dl	0
loc	9
ccs	0
cts	6
cp	0
rs	10
c	0
b	0
f	0
cc	4
nc	6
nop	0
crap	20
<?php
/**
 * Server module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-server
 * @package   hipanel-module-server
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\server\models;

use hipanel\base\Model;
use hipanel\base\ModelTrait;
use hipanel\models\Ref;
use hipanel\modules\finance\models\Sale;
use hipanel\modules\hosting\models\Ip;
filter:
    dependency_paths: ["lib/*"]
use hipanel\modules\server\helpers\ServerHelper;
use hipanel\modules\server\models\query\ServerQuery;
use hipanel\modules\server\models\traits\AssignSwitchTrait;
use hipanel\validators\EidValidator;
use hipanel\validators\RefValidator;
use Yii;
use yii\base\NotSupportedException;

/**
 * Class Server.
 *
 * @property int $id
 * @property string $name
 *
 * @property-read HardwareSale[] $hardwareSales
 */
class Server extends Model implements AssignSwitchInterface
{
    use ModelTrait, AssignSwitchTrait;


    const STATE_OK = 'ok';
    const STATE_DISABLED = 'disabled';
    const STATE_BLOCKED = 'blocked';
    const STATE_DELETED = 'deleted';

    const VIRTUAL_DEVICES = ['avds', 'svds', 'ovds'];

    const SVDS_TYPES = ['avds', 'svds'];

    const DEFAULT_PANEL = 'rcp';

    public function rules()
    {
        return [
            [['id', 'tariff_id', 'client_id', 'seller_id', 'mails_num'], 'integer'],
            [['osimage'], EidValidator::class],
            [['panel'], RefValidator::class],
            [
                [
                    'name', 'dc',
                    'client', 'seller',
                    'os', 'panel', 'rcp',
                    'parent_tariff', 'tariff', 'tariff_note', 'discounts',
                    'request_state', 'request_state_label',
                    'autorenewal',
                    'type', 'type_label', 'state', 'state_label', 'statuses',
                    'block_reason_label',
                    'running_task',
                    'ip', 'ips_num', 'mac',
                    'acs_num', 'del_acs_num', 'wizzarded',
                    'vnc',
                    'note', 'label', 'hwsummary', 'order_no',
                ],
                'safe',
            ],
            [['show_del', 'show_nic', 'show_vds', 'show_jail'], 'boolean'],
            [['switches', 'rack', 'net', 'kvm', 'pdu', 'ipmi'], 'safe'],
            [['last_expires', 'expires', 'status_time'], 'date'],
            [['time'], 'date', 'format' => 'php:Y-m-d H:i:s'],
            [
                ['state'],
                'isOperable',
                'on' => [
                    'reinstall',
                    'reboot',
                    'reset',
                    'shutdown',
                    'power-off',
                    'power-on',
                    'boot-live',
                    'regen-root-password',
                    'reset-password',
                ],
            ],
            [
                ['id'],
                'required',
                'on' => [
                    'refuse', 'delete', 'enable-autorenewal',
                    'enable-vnc', 'set-note', 'set-label',
                    'enable-block', 'disable-block', 'clear-resources',
                    'flush-switch-graphs',
                ],
            ],
            [
                ['id'],
                'integer',
                'on' => [
                    'refuse', 'delete', 'enable-autorenewal',
                    'enable-vnc', 'set-note', 'set-label',
                    'enable-block', 'disable-block',
                ],
            ],
            [['id', 'osimage'], 'required', 'on' => ['reinstall']],
            [['id', 'osimage'], 'required', 'on' => ['boot-live']],
            [['type', 'comment'], 'required', 'on' => ['enable-block', 'disable-block']],

            [['tariff_id', 'sale_time'], 'required', 'on' => ['sale']],
            [['move_accounts'], 'safe', 'on' => ['sale']],
            [['id', 'type'], 'required', 'on' => ['set-type']],
        ];
    }

    /**
     * Determine good server states.
     *
     * @return array
     */
    public function goodStates()
    {
        return [static::STATE_OK, static::STATE_DISABLED];
    }

    /**
     * @return bool
     */
    public function isOperable()
    {
        if ($this->running_task || !$this->isStateGood()) {

            return false;
        }

        return true;
    }

    public function canEnableVNC()
    {
        return $this->isVNCSupported() && $this->isStateGood();
    }

    public function isStateGood()
    {
        return in_array($this->state, $this->goodStates(), true);

    }

    /**
     * Checks whether server supports VNC.
     *
     * @return bool
     */
    public function isVNCSupported()
    {
        return in_array($this->type, static::SVDS_TYPES, true);

    }

    /**
     * Checks whether server supports root password change.
     *
     * @return bool
     */
    public function isPwChangeSupported()
    {
        return $this->type === 'ovds';

    }

    /**
     * Checks whether server supports LiveCD.
     *
     * @return bool
     */
    public function isLiveCDSupported()
    {
        return in_array($this->type, static::SVDS_TYPES, true);

    }

    /**
     * Check whether server is virtual.
     *
     * @return bool
     */
    public function isVirtualDevice()
    {
        return in_array($this->type, static::VIRTUAL_DEVICES, true);

    }

    /**
     * Check whether server is dedicated.
     *
     * @return bool
     */
    public function isDedicatedDevice()
    {
        return $this->type === 'dedicated';

    }

    public function getIsBlocked()
    {
        return $this->state === static::STATE_BLOCKED;

    }

    /**
     * Checks whether server can be operated not.
     *
     * @throws NotSupportedException
     * @return bool
     * @see isOperable()
     */
    public function checkOperable()
    {
        if (!$this->isOperable()) {
            throw new NotSupportedException(Yii::t('hipanel:server', 'Server already has a running task. Can not start new.'));
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function scenarioActions()
    {
        return [
            'reinstall' => 'resetup',
            'reset-password' => 'regen-root-password',
        ];
    }

    /**
     * During 5 days after the last expiration client is able to refuse server with full refund.
     * Method checks, whether 5 days passed.
     * @return bool
     */
    public function canFullRefuse()
    {
        if (!is_numeric($this->last_expires)) {

            return null; // In case server is not sold
        }

        return (time() - Yii::$app->formatter->asTimestamp($this->last_expires)) / 3600 / 24 < 5;
    }

    /**
     * @return bool
     */
    public function canRrd(): bool
    {
        return isset($this->ip) && isset($this->wizzarded);

    }

    public function groupUsesForCharts()
    {
        return ServerHelper::groupUsesForChart($this->uses);

    }

    public function getUses()
    {
        return $this->hasMany(ServerUse::class, ['object_id' => 'id']);
    }

    public function getIps()
    {
        if (Yii::getAlias('@ip', false)) {
            return $this->hasMany(Ip::class, ['device_id' => 'id'])->joinWith('links');
        }

        return [];
    }

    public function getSwitches()
    {
        return $this->hasMany(Server::class, ['obj_id' => 'id']);
    }

    public function getConsumptions()
    {
        return $this->hasMany(Consumption::class, ['object_id' => 'id'])->indexBy('type');
    }

    public function getBindings()
    {
        return $this->hasMany(Binding::class, ['device_id' => 'id'])->indexBy(function ($binding) {
            return $binding->typeWithNo;
        });
    }

    public function getSales()
    {
        return $this->hasMany(Sale::class, ['id' => 'object_id']);
    }

    public function getMonitoringSettings()
    {
        return $this->hasOne(MonitoringSettings::class, ['id' => 'id']);
    }

    public function getHardwareSettings()
    {
        return $this->hasOne(HardwareSettings::class, ['id' => 'id']);
    }

    public function getHardwareSales()
    {
        return $this->hasMany(HardwareSale::class, ['id' => 'id']);
    }

    public function getSoftwareSettings()
    {
        return $this->hasOne(SoftwareSettings::class, ['id' => 'id']);
    }

    public function getMailSettings()
    {
        return $this->hasOne(MailSettings::class, ['id' => 'id']);
    }

    public function getBinding($type)
    {
        if (!isset($this->bindings[$type])) {

            return null;
        }

        return $this->bindings[$type];
    }

    public function getPanel()
    {
        if ($this->state === self::STATE_DISABLED) {

            return null;
        }

        if ($this->panel || $this->isVirtualDevice()) {

            return $this->panel;
        }

        return self::DEFAULT_PANEL;
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return $this->mergeAttributeLabels([
            'remoteid' => Yii::t('hipanel:server', 'Remote ID'),
            'name' => Yii::t('hipanel:server', 'Name'),
            'dc' => Yii::t('hipanel:server', 'DC'),
            'net' => Yii::t('hipanel:server', 'Switch'),
            'kvm' => Yii::t('hipanel:server', 'KVM'),
            'pdu' => Yii::t('hipanel:server', 'APC'),
            'rack' => Yii::t('hipanel:server', 'Rack'),
            'ipmi' => Yii::t('hipanel:server', 'IPMI'),
            'status_time' => Yii::t('hipanel:server', 'Status update time'),
            'block_reason_label' => Yii::t('hipanel:server', 'Block reason label'),
            'request_state_label' => Yii::t('hipanel:server', 'Request state label'),
            'mac' => Yii::t('hipanel:server', 'MAC'),
            'ips' => Yii::t('hipanel:server', 'IPs'),
            'label' => Yii::t('hipanel:server', 'Internal note'),
            'os' => Yii::t('hipanel:server', 'OS'),
            'comment' => Yii::t('hipanel:server', 'Comment'),
            'hwsummary' => Yii::t('hipanel:server', 'Summary'),
            'sale_time' => Yii::t('hipanel:server', 'Sale time'),
            'expires' => Yii::t('hipanel:server', 'Expires'),
            'tariff_id' => Yii::t('hipanel:server', 'Tariff'),
            'order_no' => Yii::t('hipanel:server', 'Order'),
            'move_accounts' => Yii::t('hipanel:server', 'Move accounts to new client'),
            'server' => Yii::t('hipanel:server', 'Server name'),
            'mails_num' => Yii::t('hipanel:server', 'Number of mailboxes'),
        ]);
    }

    public function getTypeOptions(): array
    {
        return Ref::getList('type,device,server', 'hipanel:server');
    }

    public function getStateOptions(): array
    {
        return [
            self::STATE_DISABLED    => Yii::t('hipanel:server', 'Ok, panel OFF'),
            self::STATE_OK          => Yii::t('hipanel:server', 'Ok'),
            self::STATE_BLOCKED     => Yii::t('hipanel:server', 'Blocked'),
        ];
    }

    /**
     * {@inheritdoc}
     * @return ServerQuery
     */
    public static function find($options = [])
    {
        return new ServerQuery(get_called_class(), [
            'options' => $options,
        ]);
    }

    /**
     * @return bool
     */
    public function canControlPower(): bool
    {
        $powerManagementAllowed = Yii::$app->params['module.server.power.management.allowed'];

        $userCanControlPower = Yii::$app->user->can('support') &&
        $userCanControlPower = Yii::$app->user->/** @scrutinizer ignore-call */ can('support') &&
            (Yii::$app->user->can('server.control-system') ||
            Yii::$app->user->can('server.control-power'));

        return $powerManagementAllowed || $userCanControlPower;
    }
}

hiqdev / hipanel-module-server

Push — master ( 96a2a3...a63f8b )

Server::canControlPower() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
