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

Completed
Push — master ( 00aab8...5fa9a0 )

by Dmitry
created 2017-03-27 15:06 UTC
ServerController::actions() D

↳ Parent: ServerController
Complexity

Conditions	13
Paths	1
Size

Total Lines	327
Code Lines	232
Duplication

Lines	30
Ratio	9.17 %
Code Coverage

Tests	56
CRAP Score	13
Importance

Changes	3
Bugs	0	Features	1
Metric	Value
c	3
b	0
f	1
dl	30
loc	327
ccs	56
cts	56
cp	1
rs	4.9922
cc	13
eloc	232
nc	1
nop	0
crap	13
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-2017, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\server\controllers;

use hipanel\actions\Action;
use hipanel\actions\ComboSearchAction;
use hipanel\actions\IndexAction;
use hipanel\actions\OrientationAction;
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\modules\finance\models\Tariff;
use hipanel\modules\server\cart\ServerRenewProduct;
use hipanel\modules\server\helpers\ServerHelper;
use hipanel\modules\server\models\Osimage;
use hipanel\modules\server\models\Server;
use hipanel\modules\server\models\ServerUseSearch;
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'],
                ],
            ],
        ]);
    }

    public function actions()
    {
        return [
            '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');

                    $dataProvider->query
                        ->andWhere(['with_ips' => 1])
                        ->andWhere(['with_tariffs' => 1])
                        ->andWhere(['with_switches' => 1])
                        ->andWhere(['with_requests' => 1])
                        ->andWhere(['with_discounts' => 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,
            ],
            'view' => [
                'class' => ViewAction::class,
                'on beforePerform' => function (Event $event) {

                    /** @var \hipanel\actions\SearchAction $action */
                    $action = $event->sender;
                    $dataProvider = $action->getDataProvider();
                    $dataProvider->query->joinWith('uses');
                    $dataProvider->query->joinWith('ips');

                    // 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])
                        ->select(['*']);
                },
                'data' => function ($action) {
                    /**
                     * @var Action $action
                     * @var self $controller
                     * @var Server $model
                     */
                    $controller = $action->controller;
                    $model = $action->getModel();
                    $model->vnc = $controller->getVNCInfo($model);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

                    $panels = $controller->getPanelTypes();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

                    $cacheKeys = [__METHOD__, 'view', 'tariff', $model->tariff_id, Yii::$app->user->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);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                    $groupedOsimages = ServerHelper::groupOsimages($osimages, $ispSupported);

                    if ($model->isLiveCDSupported()) {
                        $osimageslivecd = $controller->getOsimagesLiveCd();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                    }

                    $blockReasons = $controller->getBlockReasons();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

                    return compact([
                        'model',
                        'osimages',
                        'osimageslivecd',
                        'groupedOsimages',
                        'panels',
                        'blockReasons',
                    ]);
                },
            ],
            'requests-state' => [
                'class' => RequestStateAction::class,
                'model' => Server::class,
            ],
            'set-note' => [
                'class' => SmartUpdateAction::class,
                'success' => Yii::t('hipanel:server', 'Note changed'),
                'error' => Yii::t('hipanel:server', 'Failed to change note'),
            ],
            'set-label' => [
                'class' => SmartUpdateAction::class,
                '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;
                        },
                    ],
                ],
            ],
            'sale' => [
                'class' => SmartUpdateAction::class,
                'view' => '_saleModal',
                'POST' => [
                    'save' => true,
                    'success' => [
                        'class' => RenderJsonAction::class,
                        'return' => function ($action) {
                            return ['success' => !$action->collection->hasErrors()];
                        },
                    ],
                ],
            ],
            'enable-vnc' => [
                'class' => ViewAction::class,
                'view' => '_vnc',
                'data' => function ($action) {
                    $model = $action->getModel();
                    if ($model->canEnableVNC()) {
                        $model->vnc = $this->getVNCInfo($model, true);
                    }

                    return [];
                },
            ],
            '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'),
            ],
            'disable-block' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel:server', 'Server was unblocked successfully'),
                'error' => Yii::t('hipanel:server', 'Error during the server unblocking'),
            ],
            '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['orgUrl'],
            ],
            '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,
                'scenario' => 'delete',
                'view' => '_bulkDelete',
            ],
            'bulk-enable-block' => [
                'class' => SmartUpdateAction::class,
                'scenario' => 'enable-block',
                'success' => Yii::t('hipanel:server', 'Servers were blocked successfully'),
                'error' => Yii::t('hipanel:server', 'Error during the servers 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,
                'scenario' => 'enable-block',
                'view' => '_bulkEnableBlock',
                'data' => function ($action, $data) {
                    return array_merge($data, [
                        'blockReasons' => $this->getBlockReasons(),
                    ]);
                },
            ],
            'bulk-disable-block' => [
                'class' => SmartUpdateAction::class,
                'scenario' => 'disable-block',
                'success' => Yii::t('hipanel:server', 'Servers were unblocked successfully'),
                'error' => Yii::t('hipanel:server', 'Error during the servers unblocking'),
                'POST html' => [
                    'save'    => true,
                    'success' => [
                        'class' => RedirectAction::class,
                    ],
                ],
                'on beforeSave' => function (Event $event) {
                    /** @var \hipanel\actions\Action $action */
                    $action = $event->sender;
                    $comment = Yii::$app->request->post('comment');
                    if (!empty($type)) {

                        foreach ($action->collection->models as $model) {
                            $model->setAttribute('comment', $comment);
                        }
                    }
                },
            ],
            'bulk-disable-block-modal' => [
                'class' => PrepareBulkAction::class,
                'scenario' => 'disable-block',
                'view' => '_bulkDisableBlock',
            ],
            'set-orientation' => [
                'class' => OrientationAction::class,
                'allowedRoutes' => [
                    '@server/index',
                ],
            ],
        ];
    }

    /**
     * Gets info of VNC on the server.
     *
     * @param Server $model
     * @param bool $enable
     * @throws ResponseErrorException
     * @return array
     */
    public function getVNCInfo($model, $enable = false)
    {
        $vnc = ['endTime' => strtotime('+8 hours', strtotime($model->statuses['serverEnableVNC']))];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if ($model->canEnableVnc() && $vnc['endTime'] > time() || $enable) {
            try {
                $vnc = ArrayHelper::merge($vnc, Server::perform('enable-VNC', ['id' => $model->id]));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                $vnc['enabled'] = true;
            } catch (ResponseErrorException $e) {
                if ($e->getMessage() !== 'vds_has_tasks') { // expected error, that could be skipped
                    throw $e;
                }
                $vnc['enabled'] = false;
            }
        }

        return $vnc;
    }

    public function actionDrawChart()
    {
        $post = Yii::$app->request->post();
        if (!in_array($post['type'], ['traffic', 'bandwidth'], true)) {
            throw new NotFoundHttpException();
        }

        $searchModel = new ServerUseSearch();
        $dataProvider = $searchModel->search([]);
        $dataProvider->pagination = false;
        $dataProvider->query->action('get-uses');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $dataProvider->query->andWhere($post);
        $models = $dataProvider->getModels();

        list($labels, $data) = ServerHelper::groupUsesForChart($models);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

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

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

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        } 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;
    }
}

hiqdev / hipanel-module-server

Push — master ( 00aab8...5fa9a0 )

ServerController::actions() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like
