ServerController::actions() - Code Metrics - Inspection of "csfixed" - hiqdev/hipanel-module-server - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 35e1dc...d5db3a )

by Andrii
created 2018-07-03 07:12 UTC
ServerController::actions() F

↳ Parent: ServerController
Complexity

Conditions	18
Paths	1
Size

Total Lines
456
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	106
CRAP Score	61.9468
Importance

Changes
Metric	Value
dl	0
loc	456
c	0
b	0
f	0
ccs	106
cts	218
cp	0.4862
rs	3.8933
cc	18
nc	1
nop	0
crap	61.9468
How to fix Long Method Complexity

<?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-2018, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\server\controllers;

use hipanel\actions\Action;
use hipanel\actions\ComboSearchAction;
use hipanel\actions\IndexAction;
use hipanel\actions\PrepareBulkAction;
use hipanel\actions\ProxyAction;
use hipanel\actions\RedirectAction;
use hipanel\actions\RenderAction;
use hipanel\actions\RenderJsonAction;
use hipanel\actions\RequestStateAction;
use hipanel\actions\SmartDeleteAction;
use hipanel\actions\SmartPerformAction;
use hipanel\actions\SmartUpdateAction;
use hipanel\actions\ValidateFormAction;
use hipanel\actions\ViewAction;
use hipanel\base\CrudController;
use hipanel\filters\EasyAccessControl;
use hipanel\models\Ref;
use hipanel\modules\finance\models\Tariff;
use hipanel\modules\server\cart\ServerRenewProduct;
use hipanel\modules\server\helpers\ServerHelper;
use hipanel\modules\server\models\HardwareSettings;
use hipanel\modules\server\models\MonitoringSettings;
use hipanel\modules\server\models\Osimage;
use hipanel\modules\server\models\Server;
use hipanel\modules\server\models\ServerUseSearch;
use hipanel\modules\server\models\SoftwareSettings;
use hipanel\modules\server\widgets\ResourceConsumption;
use hiqdev\hiart\ResponseErrorException;
use hiqdev\yii2\cart\actions\AddToCartAction;
use Yii;
use yii\base\Event;
use yii\filters\VerbFilter;
use yii\helpers\ArrayHelper;
use yii\web\NotFoundHttpException;
use yii\web\Response;

class ServerController extends CrudController
{
    public function behaviors()
    {
        return array_merge(parent::behaviors(), [
            'server-actions-verb' => [
                'class' => VerbFilter::class,
                'actions' => [
                    'reboot' => ['post'],
                    'reset' => ['post'],
                    'shutdown' => ['post'],
                    'power-off' => ['post'],
                    'power-on' => ['post'],
                    'reset-password' => ['post'],
                    'enable-block' => ['post'],
                    'disable-block' => ['post'],
                    'refuse' => ['post'],
                    'flush-switch-graphs' => ['post'],
                ],
            ],
            [
                'class' => EasyAccessControl::class,
                'actions' => [
                    'monitoring-settings' => 'support',
                    'software-settings' => 'support',
                    'hardware-settings' => 'support',
                    'delete' => 'server.delete',
                    '*' => 'server.read',
                ],
            ],
        ]);
    }

    public function actions()
    {
        return array_merge(parent::actions(), [
            'index' => [
                'class' => IndexAction::class,
                'findOptions' => ['with_requests' => true, 'with_discounts' => true],
                'on beforePerform' => function (Event $event) {
                    /** @var \hipanel\actions\SearchAction $action */
                    $action = $event->sender;
                    $dataProvider = $action->getDataProvider();
                    $dataProvider->query->joinWith(['ips', 'bindings']);

                    $dataProvider->query
                        ->andWhere(['with_ips' => 1])
                        ->andWhere(['with_requests' => 1])
                        ->andWhere(['with_discounts' => 1])
                        ->andWhere(['with_bindings' => 1])
                        ->select(['*']);
                },
                'filterStorageMap' => [
                    'name_like' => 'server.server.name',
                    'ips' => 'hosting.ip.ip_in',
                    'state' => 'server.server.state',
                    'client_id' => 'client.client.id',
                    'seller_id' => 'client.client.seller_id',
                ],
            ],
            'search' => [
                'class' => ComboSearchAction::class,
            ],
            'hardware-settings' => [
                'class' => SmartUpdateAction::class,
                'success' => Yii::t('hipanel:server', 'Hardware properties was changed'),
                'view' => 'hardwareSettings',
                'scenario' => 'default',
                'on beforeFetch' => function (Event $event) {
                    /** @var \hipanel\actions\SearchAction $action */
                    $action = $event->sender;
                    $dataProvider = $action->getDataProvider();
                    $dataProvider->query->joinWith(['hardwareSettings']);
                    $dataProvider->query->andWhere(['with_hardwareSettings' => 1])->select(['*']);
                },
                'on beforeLoad' => function (Event $event) {
                    /** @var Action $action */
                    $action = $event->sender;

                    $action->collection->setModel(HardwareSettings::class);
                    $action->collection->setModel(/** @scrutinizer ignore-type */ HardwareSettings::class);
                },
                'POST html' => [
                    'save' => true,
                    'success' => [
                        'class' => RedirectAction::class,
                        'url' => function () {
                            $server = Yii::$app->request->post('HardwareSettings');

                            return ['@server/view', 'id' => $server['id']];
                        },
                    ],
                ],
            ],
            'software-settings' => [
                'class' => SmartUpdateAction::class,
                'success' => Yii::t('hipanel:server', 'Software properties was changed'),
                'view' => 'softwareSettings',
                'scenario' => 'default',
                'on beforeFetch' => function (Event $event) {
                    /** @var \hipanel\actions\SearchAction $action */
                    $action = $event->sender;
                    $dataProvider = $action->getDataProvider();
                    $dataProvider->query->joinWith(['softwareSettings']);
                    $dataProvider->query->andWhere(['with_softwareSettings' => 1])->select(['*']);
                },
                'on beforeLoad' => function (Event $event) {
                    /** @var Action $action */
                    $action = $event->sender;

                    $action->collection->setModel(SoftwareSettings::class);
                    $action->collection->setModel(/** @scrutinizer ignore-type */ SoftwareSettings::class);
                },
                'POST html' => [
                    'save' => true,
                    'success' => [
                        'class' => RedirectAction::class,
                        'url' => function () {
                            $server = Yii::$app->request->post('SoftwareSettings');

                            return ['@server/view', 'id' => $server['id']];
                        },
                    ],
                ],
            ],
            'monitoring-settings' => [
                'class' => SmartUpdateAction::class,
                'success' => Yii::t('hipanel:server', 'Monitoring properties was changed'),
                'view' => 'monitoringSettings',
                'scenario' => 'default',
                'on beforeFetch' => function (Event $event) {
                    /** @var \hipanel\actions\SearchAction $action */
                    $action = $event->sender;
                    $dataProvider = $action->getDataProvider();
                    $dataProvider->query->joinWith(['monitoringSettings']);
                    $dataProvider->query
                        ->andWhere(['with_monitoringSettings' => 1])->select(['*']);
                },
                'on beforeLoad' => function (Event $event) {
                    /** @var Action $action */
                    $action = $event->sender;

                    $action->collection->setModel(MonitoringSettings::class);
                    $action->collection->setModel(/** @scrutinizer ignore-type */ MonitoringSettings::class);
                },
                'data' => function ($action) {
                    return [
                        'nicMediaOptions' => $action->controller->getFullFromRef('type,nic_media'),
                    ];
                },
                'POST html' => [
                    'save' => true,
                    'success' => [
                        'class' => RedirectAction::class,
                        'url' => function () {
                            $server = Yii::$app->request->post('MonitoringSettings');

                            return ['@server/view', 'id' => $server['id']];
                        },
                    ],
                ],
            ],
            'view' => [
                'class' => ViewAction::class,
                'on beforePerform' => function (Event $event) {
                    /** @var \hipanel\actions\SearchAction $action */
                    $action = $event->sender;
                    $dataProvider = $action->getDataProvider();
                    $dataProvider->query->joinWith(['uses', 'ips', 'switches', 'bindings', 'blocking']);

                    // TODO: ipModule is not wise yet. Redo
                    $dataProvider->query
                        ->andWhere(['with_requests' => 1])
                        ->andWhere(['show_deleted' => 1])
                        ->andWhere(['with_discounts' => 1])
                        ->andWhere(['with_uses' => 1])
                        ->andWhere(['with_ips' => 1])
                        ->andWhere(['with_bindings' => 1])
                        ->andWhere(['with_blocking' => 1])
                        ->select(['*']);
                },
                'data' => function ($action) {
                    /**
                     * @var Action
                     * @var self $controller
                     * @var Server $model
                     */
                    $controller = $action->controller;
                    $model = $action->getModel();
                    $model->vnc = $controller->getVNCInfo($model);

                    $panels = $controller->getPanelTypes();

                    $cacheKeys = [__METHOD__, 'view', 'tariff', $model->tariff_id, Yii::$app->user->getId()];
                    $cacheKeys = [__METHOD__, 'view', 'tariff', $model->tariff_id, Yii::$app->user->/** @scrutinizer ignore-call */ getId()];
                    $tariff = Yii::$app->cache->getOrSet($cacheKeys, function () use ($model) {
                        return Tariff::find()->where([
                            'id' => $model->tariff_id,
                            'show_final' => true,
                            'show_deleted' => true,
                            'with_resources' => true,
                        ])->joinWith('resources')->one();
                    });

                    $ispSupported = false;
                    if ($tariff !== null) {
                        foreach ($tariff->getResources() as $resource) {
                            if ($resource->type === 'isp' && $resource->quantity > 0) {
                                $ispSupported = true;
                            }
                        }
                    }

                    $osimages = $controller->getOsimages($model);
                    $groupedOsimages = ServerHelper::groupOsimages($osimages, $ispSupported);

                    if ($model->isLiveCDSupported()) {
                        $osimageslivecd = $controller->getOsimagesLiveCd();
                    }

                    $blockReasons = $controller->getBlockReasons();

                    return compact([
                        'model',
                        'osimages',
                        'osimageslivecd',
                        'groupedOsimages',
                        'panels',
                        'blockReasons',
                    ]);
                },
            ],
            'requests-state' => [
                'class' => RequestStateAction::class,
                'model' => Server::class,
            ],
            'set-note' => [
                'class' => SmartUpdateAction::class,
                'view' => '_bulkSetNote',
                'success' => Yii::t('hipanel:server', 'Note changed'),
                'error' => Yii::t('hipanel:server', 'Failed to change note'),
            ],
            'set-label' => [
                'class' => SmartUpdateAction::class,
                'view' => '_bulkSetLabel',
                'success' => Yii::t('hipanel:server', 'Internal note changed'),
                'error' => Yii::t('hipanel:server', 'Failed to change internal note'),
            ],
            'set-lock' => [
                'class' => RenderAction::class,
                'success' => Yii::t('hipanel:server', 'Record was changed'),
                'error' => Yii::t('hipanel:server', 'Error occurred'),
                'POST pjax' => [
                    'save' => true,
                    'success' => [
                        'class' => ProxyAction::class,
                        'action' => 'index',
                    ],
                ],
                'POST' => [
                    'save' => true,
                    'success' => [
                        'class' => RenderJsonAction::class,
                        'return' => function ($action) {
                            /** @var \hipanel\actions\Action $action */
                            return $action->collection->models;
                        },
                    ],
                ],
            ],
            'enable-vnc' => [
                'class' => ViewAction::class,
                'view' => '_vnc',
                'data' => function ($action) {
                    $model = $action->getModel();
                    if ($model->canEnableVNC()) {
                        $model->vnc = $this->getVNCInfo($model, true);
                    }

                    return [];
                },
            ],
            'bulk-sale' => [
                'class' => SmartUpdateAction::class,
                'scenario' => 'sale',
                'view' => '_bulkSale',
                'success' => Yii::t('hipanel:server', 'Servers were sold'),
                'POST pjax' => [
                    'save' => true,
                    'success' => [
                        'class' => ProxyAction::class,
                        'action' => 'index',
                    ],
                ],
                'on beforeSave' => function (Event $event) {
                    /** @var \hipanel\actions\Action $action */
                    $action = $event->sender;
                    $request = Yii::$app->request;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

                    if ($request->isPost) {
                        $values = [];
                        foreach (['client_id', 'tariff_id', 'sale_time', 'move_accounts'] as $attribute) {
                            $value = $request->post($attribute);
                            if (!empty($value)) {
                                $values[$attribute] = $value;
                            }
                        }
                        foreach ($action->collection->models as $model) {
                            foreach ($values as $attr => $value) {
                                $model->setAttribute($attr, $value);
                            }
                        }
                    }
                },
            ],
            'set-type' => [
                'class' => SmartUpdateAction::class,
                'view' => '_bulkSetType',
                'success' => Yii::t('hipanel:server', 'Type was changed'),
                'error' => Yii::t('hipanel:server', 'Failed to change type'),
            ],
            'reboot' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Reboot task has been successfully added to queue'),
                'error' => Yii::t('hipanel:server', 'Error during the rebooting'),
            ],
            'reset' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Reset task has been successfully added to queue'),
                'error' => Yii::t('hipanel:server', 'Error during the resetting'),
            ],
            'shutdown' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Shutdown task has been successfully added to queue'),
                'error' => Yii::t('hipanel:server', 'Error during the shutting down'),
            ],
            'power-off' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Power off task has been successfully added to queue'),
                'error' => Yii::t('hipanel:server', 'Error during the turning power off'),
            ],
            'power-on' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Power on task has been successfully added to queue'),
                'error' => Yii::t('hipanel:server', 'Error during the turning power on'),
            ],
            'reset-password' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Root password reset task has been successfully added to queue'),
                'error' => Yii::t('hipanel:server', 'Error during the resetting root password'),
            ],
            'enable-block' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Server was blocked successfully'),
                'error' => Yii::t('hipanel:server', 'Error during the server blocking'),
                'POST html' => [
                    'save' => true,
                    'success' => [
                        'class' => RedirectAction::class,
                    ],
                ],
                'on beforeSave' => function (Event $event) {
                    /** @var \hipanel\actions\Action $action */
                    $action = $event->sender;
                    $type = Yii::$app->request->post('type');
                    $comment = Yii::$app->request->post('comment');
                    if (!empty($type)) {
                        foreach ($action->collection->models as $model) {
                            $model->setAttributes([
                                'type' => $type,
                                'comment' => $comment,
                            ]);
                        }
                    }
                },
            ],
            'bulk-enable-block-modal' => [
                'class' => PrepareBulkAction::class,
                'view' => '_bulkEnableBlock',
                'data' => function ($action, $data) {
                    return array_merge($data, [
                        'blockReasons' => $this->getBlockReasons(),
                    ]);
                },
            ],
            'disable-block' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Server was unblocked successfully'),
                'error' => Yii::t('hipanel:server', 'Error during the server unblocking'),
                'POST html' => [
                    'save' => true,
                    'success' => [
                        'class' => RedirectAction::class,
                    ],
                ],
                'on beforeSave' => function (Event $event) {
                    /** @var \hipanel\actions\Action $action */
                    $action = $event->sender;
                    $type = Yii::$app->request->post('type');
                    $comment = Yii::$app->request->post('comment');
                    if (!empty($type)) {
                        foreach ($action->collection->models as $model) {
                            $model->setAttributes([
                                'comment' => $comment,
                                'type' => $type,
                            ]);
                        }
                    }
                },
            ],
            'bulk-disable-block-modal' => [
                'class' => PrepareBulkAction::class,
                'view' => '_bulkDisableBlock',
                'data' => function ($action, $data) {
                    return array_merge($data, [
                        'blockReasons' => $this->getBlockReasons(),
                    ]);
                },
            ],
            'refuse' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'You have refused the service'),
                'error' => Yii::t('hipanel:server', 'Error during the refusing the service'),
            ],
            'enable-autorenewal' => [
                'class' => SmartUpdateAction::class,
                'success' => Yii::t('hipanel:server', 'Server renewal enabled successfully'),
                'error' => Yii::t('hipanel:server', 'Error during the renewing the service'),
            ],
            'reinstall' => [
                'class' => SmartUpdateAction::class,
                'on beforeSave' => function (Event $event) {
                    /** @var Action $action */
                    $action = $event->sender;
                    foreach ($action->collection->models as $model) {
                        $model->osimage = Yii::$app->request->post('osimage');
                        $model->panel = Yii::$app->request->post('panel');
                    }
                },
                'success' => Yii::t('hipanel:server', 'Server reinstalling task has been successfully added to queue'),
                'error' => Yii::t('hipanel:server', 'Error during the server reinstalling'),
            ],
            'boot-live' => [
                'class' => SmartPerformAction::class,
                'on beforeSave' => function (Event $event) {
                    /** @var Action $action */
                    $action = $event->sender;
                    foreach ($action->collection->models as $model) {
                        $model->osimage = Yii::$app->request->post('osimage');
                    }
                },
                'success' => Yii::t('hipanel:server', 'Live CD booting task has been successfully added to queue'),
                'error' => Yii::t('hipanel:server', 'Error during the booting live CD'),
            ],
            'validate-form' => [
                'class' => ValidateFormAction::class,
            ],
            'buy' => [
                'class' => RedirectAction::class,
                'url' => Yii::$app->params['organization.url'],
            ],
            'add-to-cart-renewal' => [
                'class' => AddToCartAction::class,
                'productClass' => ServerRenewProduct::class,
            ],
            'delete' => [
                'class' => SmartDeleteAction::class,
                'success' => Yii::t('hipanel:server', 'Server was deleted successfully'),
                'error' => Yii::t('hipanel:server', 'Failed to delete server'),
            ],
            'bulk-delete-modal' => [
                'class' => PrepareBulkAction::class,
                'view' => '_bulkDelete',
            ],
            'clear-resources' => [
                'class' => SmartPerformAction::class,
                'view' => '_clearResources',
                'success' => Yii::t('hipanel:server', 'Servers resources were cleared successfully'),
                'error' => Yii::t('hipanel:server', 'Error occurred during server resources flushing'),
            ],
            'clear-resources-modal' => [
                'class' => PrepareBulkAction::class,
                'view' => '_clearResources',
            ],
            'flush-switch-graphs' => [
                'class' => SmartPerformAction::class,
                'view' => '_clearResources',
                'success' => Yii::t('hipanel:server', 'Switch graphs were flushed successfully'),
                'error' => Yii::t('hipanel:server', 'Error occurred during switch graphs flushing'),
            ],
            'flush-switch-graphs-modal' => [
                'class' => PrepareBulkAction::class,
                'view' => '_flushSwitchGraphs',
            ],
        ]);
    }

    /**
     * Gets info of VNC on the server.
     *
     * @param Server $model
     * @param bool $enable
     * @throws ResponseErrorException
     * @return array
     */
    public function getVNCInfo($model, $enable = false)
    {
        if ($enable) {
            try {
                $vnc = Server::perform('enable-VNC', ['id' => $model->id]);

                $vnc['endTime'] = time() + 28800;
                Yii::$app->cache->set([__METHOD__, $model->id, $model], $vnc, 28800);
                $vnc['enabled'] = true;
            } catch (ResponseErrorException $e) {
                if ($e->getMessage() !== 'vds_has_tasks') {
                    throw $e;
                }
            }
        } else {
            if ($model->statuses['serverEnableVNC'] !== null && strtotime('+8 hours', strtotime($model->statuses['serverEnableVNC'])) > time()) {

                $vnc = Yii::$app->cache->getOrSet([__METHOD__, $model->id, $model], function () use ($model) {
                    return ArrayHelper::merge([
                        'endTime' => strtotime($model->statuses['serverEnableVNC']) + 28800,

                    ], Server::perform('enable-VNC', ['id' => $model->id]));

                }, 28800);
            }
            $vnc['enabled'] = $model->statuses['serverEnableVNC'] === null ? false : strtotime('+8 hours', strtotime($model->statuses['serverEnableVNC'])) > time();
        }

        return $vnc;
    }

    public function actionDrawChart()
    {
        $post = Yii::$app->request->post();
        $types = array_merge(['server_traf', 'server_traf95'], array_keys(ResourceConsumption::types()));
        if (!in_array($post['type'], $types, true)) {
            throw new NotFoundHttpException();
        }

        $searchModel = new ServerUseSearch();
        $dataProvider = $searchModel->search([]);
        $dataProvider->pagination = false;
        $dataProvider->query->action('get-uses');
                              action('get-uses');
        $dataProvider->query->andWhere($post);
        $models = $dataProvider->getModels();

        list($labels, $data) = ServerHelper::groupUsesForChart($models);

        return $this->renderAjax('_consumption', [
            'labels' => $labels,
            'data' => $data,
            'consumptionBase' => $post['type'],
        ]);
    }

    /**
     * Gets OS images.
     *
     * @param Server $model
     * @throws NotFoundHttpException
     * @return array
     */
    protected function getOsimages(Server $model = null)
    {
        if ($model !== null) {
            $type = $model->type;

        } else {
            $type = null;
        }

        $models = ServerHelper::getOsimages($type);

        if ($models === null) {
            throw new NotFoundHttpException('The requested page does not exist.');
        }

        return $models;
    }

    protected function getOsimagesLiveCd()
    {
        $models = Yii::$app->cache->getOrSet([__METHOD__], function () {
            return Osimage::findAll(['livecd' => true]);
        }, 3600);

        if ($models !== null) {
            return $models;
        }

        throw new NotFoundHttpException('The requested page does not exist.');
    }

    protected function getPanelTypes()
    {
        return ServerHelper::getPanels();
    }

    public function actionIsOperable($id)
    {
        Yii::$app->response->format = Response::FORMAT_JSON;

        $result = ['id' => $id, 'result' => false];

        if ($server = Server::find()->where(['id' => $id])->one()) {
            $result['result'] = $server->isOperable();
        }

        return $result;
    }

    protected function getFullFromRef($gtype)
    {
        $callingMethod = debug_backtrace()[1]['function'];
        $result = Yii::$app->get('cache')->getOrSet([$callingMethod], function () use ($gtype) {
            $result = ArrayHelper::map(Ref::find()->where([
                'gtype' => $gtype,
                'select' => 'full',
            ])->all(), 'id', function ($model) {
                return Yii::t('hipanel:server:hub', $model->label);
            });

            return $result;
        }, 86400 * 24); // 24 days

        return $result;
    }

    public function actionResources($id)
    {
        $model = Server::find()->joinWith(['uses'])->andWhere(['id' => $id])->andWhere(['with_uses' => 1])->one();
        list($chartsLabels, $chartsData) = $model->groupUsesForCharts();

        return $this->render('resources', compact('model', 'chartsData', 'chartsLabels'));
    }
}

hiqdev / hipanel-module-server

Push — master ( 35e1dc...d5db3a )

ServerController::actions() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
