AdminController::validatePolicy() - Code Metrics - Inspection of "Add Env Policy Logic" - LaravelRUS/SleepingOwlAdmin - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — new (#872)

unknown
created 2018-06-12 10:11 UTC
AdminController::validatePolicy() B

↳ Parent: AdminController
Complexity

Conditions	6
Paths	6
Size

Total Lines	5
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
eloc	3
nc	6
nop	2
dl	0
loc	5
rs	8.8571
c	0
b	0
f	0
<?php

namespace SleepingOwl\Admin\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Routing\Controller;
use SleepingOwl\Admin\Form\FormElements;
use DaveJamesMiller\Breadcrumbs\Generator;
use SleepingOwl\Admin\Form\Columns\Column;
use SleepingOwl\Admin\Display\DisplayTable;
use Illuminate\Contracts\Support\Renderable;
use SleepingOwl\Admin\Display\DisplayTabbed;
use Illuminate\Validation\ValidationException;
use SleepingOwl\Admin\Contracts\AdminInterface;
use SleepingOwl\Admin\Model\ModelConfiguration;
use Illuminate\Contracts\Foundation\Application;
use SleepingOwl\Admin\Contracts\Form\FormInterface;
use SleepingOwl\Admin\Contracts\ModelConfigurationInterface;
use SleepingOwl\Admin\Contracts\Display\ColumnEditableInterface;

class AdminController extends Controller
{
    /**
     * @var \DaveJamesMiller\Breadcrumbs\Manager
     */
    protected $breadcrumbs;

    /**
     * @var
     */
    protected $breadCrumbsData;

    /**
     * @var AdminInterface
     */
    protected $admin;

    /**
     * @var
     */
    private $parentBreadcrumb = 'home';

    /**
     * @var Application
     */
    public $app;

    /**
     * @var
     */
    protected $envPolicy;

    /**
     * AdminController constructor.
     *
     * @param Request $request
     * @param AdminInterface $admin
     * @param Application $application
     */
    public function __construct(Request $request, AdminInterface $admin, Application $application)
    {
        $this->app = $application;
        $this->admin = $admin;
        $this->breadcrumbs = $admin->template()->breadcrumbs();

        if ($this->envPolicy = config('sleeping_owl.env_editor_policy')) {
            $this->envPolicy = new $this->envPolicy;
        }

        $admin->navigation()->setCurrentUrl($request->getUri());
        $admin->navigation()->/** @scrutinizer ignore-call */ setCurrentUrl($request->getUri());

        if (! $this->breadcrumbs->exists('home')) {
            $this->breadcrumbs->register('home', function (Generator $breadcrumbs) {
                $breadcrumbs->push(trans('sleeping_owl::lang.dashboard'), route('admin.dashboard'));
            });
        }

        $this->breadCrumbsData = [];

        if ($currentPage = $admin->navigation()->getCurrentPage()) {
            foreach ($currentPage->getPathArray() as $page) {
                $this->breadCrumbsData[] = [
                    'id'     => $page['id'],
                    'title'  => $page['title'],
                    'url'    => $page['url'],
                    'parent' => $this->parentBreadcrumb,
                ];

                $this->parentBreadcrumb = $page['id'];
            }
        }
    }

    /**
     * @return string
     */
    public function getParentBreadcrumb()
    {
        return $this->parentBreadcrumb;
    }

    /**
     * @param string $parentBreadcrumb
     */
    public function setParentBreadcrumb($parentBreadcrumb)
    {
        $this->parentBreadcrumb = $parentBreadcrumb;
    }

    /**
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function getDashboard()
    {
        return $this->renderContent(
            $this->admin->template()->view('dashboard'),
            /** @scrutinizer ignore-type */ $this->admin->template()->view('dashboard'),
            trans('sleeping_owl::lang.dashboard')
            /** @scrutinizer ignore-type */ trans('sleeping_owl::lang.dashboard')
        );
    }

    /**
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function getEnvEditor()
    {
        $envFile = app()->environmentFilePath();
        $envFile = app()->/** @scrutinizer ignore-call */ environmentFilePath();
        $envContent = collect(parse_ini_file($envFile, false, INI_SCANNER_RAW));

        /**
         * Use filter masks.
         * @param $key
         * @return bool
         */
        $envContent = $envContent->filter(function ($value, $key) {
            return ! in_array($key, config('sleeping_owl.env_editor_excluded_keys')) && ! $this->filterKey($key);
        });

        $envContent = $envContent->filter(function ($value, $key) {
            return $this->validatePolicy('display', $key);
        });

        $envContent = $envContent->map(function ($value, $key) {
            return (object)[
                'value'     => $value,
                'editable'  => $this->validatePolicy('edit', $key),
                'deletable' => $this->validatePolicy('delete', $key),
            ];
        });

        return $this->renderContent(
            $this->admin->template()->view('env_editor', ['data' => $envContent]),
            /** @scrutinizer ignore-type */ $this->admin->template()->view('env_editor', ['data' => $envContent]),
            trans('sleeping_owl::lang.env_editor.title')
            /** @scrutinizer ignore-type */ trans('sleeping_owl::lang.env_editor.title')
        );
    }

    /**
     * @param $permission
     * @param $key
     * @return bool
     */
    protected function validatePolicy($permission, $key)
    {
        return ($this->envPolicy && ((method_exists($this->envPolicy, $permission)
                    && $this->envPolicy->$permission(\Auth::user(), $key) !== false)))
            || ! method_exists($this->envPolicy, $permission) || ! $this->envPolicy || $this->validateBeforePolicy($key);
    }

    /**
     * @param $key
     * @return bool
     */
    protected function validateBeforePolicy($key)
    {
        return ($this->envPolicy && (method_exists($this->envPolicy, 'before'))
                && $this->envPolicy->before(\Auth::user(),$key) == true)
            || ! method_exists($this->envPolicy,'before') || ! $this->envPolicy;
    }

    /**
     * @param Request $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postEnvEditor(Request $request)
    {
        $envFile = app()->environmentFilePath();
        $envContent = collect(parse_ini_file($envFile, false, INI_SCANNER_RAW));

        $requestContent = collect($request->input('variables'));
        $removeContent = collect();

        foreach ($envContent as $key => $value) {
            if (! in_array($key, config('sleeping_owl.env_editor_excluded_keys')) && ! $this->filterKey($key)) {
                if ($requestContent->has($key)) {
                    if ($this->validatePolicy('edit', $key)) {
                        $envContent[$key] = $requestContent[$key]['value'];
                    }
                    $requestContent->forget($key);
                } else {
                    $envContent->forget($key);
                    $removeContent->put($key, null);
                }
            }
        }

        foreach ($requestContent as $key => $value) {
            if (! in_array($key, config('sleeping_owl.env_editor_excluded_keys')) && ! $this->filterKey($key)
                && $this->validatePolicy('create', $key)) {
                $this->writeEnvData($key, $value['value'], 1);
            }
            $requestContent->forget($key);
        }

        foreach ($removeContent as $key => $value) {
            if ($this->validatePolicy('delete', $key)) {
                $this->writeEnvData($key);
            }
        }

        foreach ($envContent as $key => $value) {
            $this->writeEnvData($key, $value);
        }

        return redirect()->back()->with('success_message', 'Env Updated');
    }

    /**
     * @param $key
     * @return bool
     */
    public function filterKey($key)
    {
        foreach (config('sleeping_owl.env_editor_excluded_keys') as $val) {
            if (strpos($val, '*') !== false) {
                $val = str_replace('*', '', $val);
                if (strpos($key, $val) !== false) {
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * @param $key
     * @param null $data

     * @param bool $new
     * @return bool
     */
    public function writeEnvData($key, $data = null, $new = null)
    {
        $envFile = app()->environmentFilePath();
        $str = file_get_contents($envFile);

        if (is_null($data)) {
            $str = preg_replace("/$key=.*/m", '', $str);
            file_put_contents($envFile, $str);

            return false;
        }

        if (is_null($new)) {
            $str = preg_replace("/$key=.*/m", "$key=$data", $str);
            file_put_contents($envFile, $str);

            return false;
        }

        $str = $str."\r\n$key=$data";
        file_put_contents($envFile, $str);

        return true;
    }

    /**
     * @param ModelConfigurationInterface $model
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     * @throws \DaveJamesMiller\Breadcrumbs\Exception
     */
    public function getDisplay(ModelConfigurationInterface $model)
    {
        if (! $model->isDisplayable()) {
            abort(404);
        }

        $display = $model->fireDisplay();

        $this->registerBreadcrumbs($model);

        return $this->render($model, $display);
    }

    /**
     * @param ModelConfigurationInterface $model
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     * @throws \DaveJamesMiller\Breadcrumbs\Exception
     */
    public function getCreate(ModelConfigurationInterface $model)
    {
        if (! $model->isCreatable()) {
            abort(404);
        }

        $create = $model->fireCreate();

        $this->registerBreadcrumb($model->getCreateTitle(), $this->parentBreadcrumb);
        $this->registerBreadcrumbs($model);

        return $this->render($model, $create, $model->getCreateTitle());
        return $this->render($model, $create, /** @scrutinizer ignore-type */ $model->getCreateTitle());
    }

    /**
     * @param ModelConfigurationInterface $model
     * @param Request $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postStore(ModelConfigurationInterface $model, Request $request)
    {
        if (! $model->isCreatable()) {
            abort(404);
        }

        $createForm = $model->fireCreate();
        $nextAction = $request->input('next_action');

        $backUrl = $this->getBackUrl($request);

        if ($createForm instanceof FormInterface) {
            try {
                $createForm->validateForm($request, $model);

                if ($createForm->saveForm($request, $model) === false) {
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
                    return redirect()->back()->with([
                        '_redirectBack'       => $backUrl,
                        'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
                    ]);
                }
            } catch (ValidationException $exception) {
                return redirect()->back()
                    ->withErrors($exception->validator)
                    ->withInput()
                    ->with([
                        '_redirectBack'       => $backUrl,
                        'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
                    ]);
            }
        }

        if ($nextAction == 'save_and_continue') {
            $newModel = $createForm->getModel();
            $primaryKey = $newModel->getKeyName();

            $redirectUrl = $model->getEditUrl($newModel->{$primaryKey});
            $redirectPolicy = $model->getRedirect();

            /* Make redirect when use in model config && Fix editable redirect */
            if ($redirectPolicy->get('create') == 'display' || ! $model->isEditable($newModel)) {
                $redirectUrl = $model->getDisplayUrl();
            }

            $response = redirect()->to(
                $redirectUrl
            )->with([
                '_redirectBack'       => $backUrl,
                'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
            ]);
        } elseif ($nextAction == 'save_and_create') {
            $response = redirect()->to($model->getCreateUrl($request->except([
                '_redirectBack',
                '_token',
                'url',
                'next_action',
            ])))->with([
                '_redirectBack'       => $backUrl,
                'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
            ]);
        } else {
            $response = redirect()->to($request->input('_redirectBack', $model->getDisplayUrl()));
        }

        return $response->with('success_message', $model->getMessageOnCreate());
    }

    /**
     * @param ModelConfigurationInterface $model
     * @param $id
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     * @throws \DaveJamesMiller\Breadcrumbs\Exception
     */
    public function getEdit(ModelConfigurationInterface $model, $id)
    {
        $item = $model->getRepository()->find($id);

        if (is_null($item) || ! $model->isEditable($item)) {
            abort(404);
        }

        $this->registerBreadcrumb($model->getEditTitle($item), $this->parentBreadcrumb);

        $edit = $model->fireEdit($id);

        $this->registerBreadcrumbs($model);

        return $this->render($model, $edit, $model->getEditTitle($item));
        return $this->render($model, $edit, /** @scrutinizer ignore-type */ $model->getEditTitle($item));
    }

    /**
     * @param ModelConfigurationInterface $model
     * @param Request $request
     * @param int $id
     *
     * @return \Illuminate\Http\RedirectResponse
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public function postUpdate(ModelConfigurationInterface $model, Request $request, $id)
    {
        /** @var FormInterface $editForm */
        $editForm = $model->fireEdit($id);
        $item = $editForm->getModel();

        if (is_null($item) || ! $model->isEditable($item)) {
            abort(404);
        }

        $nextAction = $request->input('next_action');

        $backUrl = $this->getBackUrl($request);

        if ($editForm instanceof FormInterface) {

            try {
                $editForm->validateForm($request, $model);

                if ($editForm->saveForm($request, $model) === false) {
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
                    return redirect()->back()->with([
                        '_redirectBack'       => $backUrl,
                        'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
                    ]);
                }
            } catch (ValidationException $exception) {
                return redirect()->back()
                    ->withErrors($exception->validator)
                    ->withInput()
                    ->with([
                        '_redirectBack'       => $backUrl,
                        'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
                    ]);
            }
        }

        $redirectPolicy = $model->getRedirect();

        if ($nextAction == 'save_and_continue') {
            $response = redirect()->back()->with([
                '_redirectBack'       => $backUrl,
                'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
            ]);

            if ($redirectPolicy->get('edit') == 'display') {
                $response = redirect()->to(
                    $model->getDisplayUrl()
                )->with([
                    '_redirectBack'       => $backUrl,
                    'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
                ]);
            }
        } elseif ($nextAction == 'save_and_create') {
            $response = redirect()->to($model->getCreateUrl($request->except([
                '_redirectBack',
                '_token',
                'url',
                'next_action',
            ])))->with([
                '_redirectBack'       => $backUrl,
                'sleeping_owl_tab_id' => $request->get('sleeping_owl_tab_id') ?: null,
            ]);
        } else {
            $response = redirect()->to($request->input('_redirectBack', $model->getDisplayUrl()));
        }

        return $response->with('success_message', $model->getMessageOnUpdate());
    }

    /**
     * @param ModelConfigurationInterface $model
     * @param Request $request
     *
     * @return bool
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public function inlineEdit(ModelConfigurationInterface $model, Request $request)
    {
        $field = $request->input('name');
        $id = $request->input('pk');
        $display = $model->fireDisplay();
        $column = null;

        /* @var ColumnEditableInterface|null $column */
        if (is_callable([$display, 'getColumns'])) {
            $column = $display->getColumns()->all()->filter(function ($column) use ($field) {
            $column = $display->/** @scrutinizer ignore-call */ getColumns()->all()->filter(function ($column) use ($field) {
                return ($column instanceof ColumnEditableInterface) && $field == $column->getName();
                return ($column instanceof ColumnEditableInterface) && $field == $column->/** @scrutinizer ignore-call */ getName();
            })->first();
        } else {
            if ($display instanceof DisplayTabbed) {
                foreach ($display->getTabs() as $tab) {
                    $content = $tab->getContent();

                    if ($content instanceof DisplayTable) {
                        $column = $content->getColumns()->all()->filter(function ($column) use ($field) {
                            return ($column instanceof ColumnEditableInterface) && $field == $column->getName();
                        })->first();
                    }
                    if ($content instanceof FormElements) {
                        foreach ($content->getElements() as $element) {

                            //Return data-table if inside FormElements
                            if ($element instanceof DisplayTable) {
                                $column = $element->getColumns()->all()->filter(function ($column) use ($field) {
                                    return ($column instanceof ColumnEditableInterface) && $field == $column->getName();
                                })->first();
                            }

                            //Try to find inline Editable in columns
                            if ($element instanceof Column) {
                                foreach ($element->getElements() as $columnElement) {
                                    if ($columnElement instanceof DisplayTable) {
                                        $column = $columnElement->getColumns()->all()->filter(function ($column) use (
                                            $field
                                        ) {
                                            return ($column instanceof ColumnEditableInterface) && $field == $column->getName();
                                        })->first();
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }

        if (is_null($column)) {
            abort(404);
        }

        $repository = $model->getRepository();
        $item = $repository->find($id);

        if (is_null($item) || ! $model->isEditable($item)) {
            abort(404);
        }

        $column->setModel($item);

        if ($model->fireEvent('updating', true, $item, $request) === false) {
        if ($model->/** @scrutinizer ignore-call */ fireEvent('updating', true, $item, $request) === false) {
            return;
        }

        $column->save($request, $model);

        $model->fireEvent('updated', false, $item, $request);
    }

    /**
     * @param ModelConfigurationInterface $model
     * @param Request $request
     * @param int $id
     * @return \Illuminate\Http\RedirectResponse
     */
    public function deleteDelete(ModelConfigurationInterface $model, Request $request, $id)
    {
        $item = $model->getRepository()->find($id);

        if (is_null($item) || ! $model->isDeletable($item)) {
            abort(404);
        }

        $model->fireDelete($id);

        if ($model->fireEvent('deleting', true, $item, $request) === false) {
            return redirect()->back();
        }

        $model->getRepository()->delete($id);

        $model->fireEvent('deleted', false, $item, $request);

        return redirect($request->input('_redirectBack', back()->getTargetUrl()))

            ->with('success_message', $model->getMessageOnDelete());
    }

    /**
     * @param ModelConfigurationInterface $model
     * @param Request $request
     * @param int $id
     *
     * @return \Illuminate\Http\RedirectResponse
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public function deleteDestroy(ModelConfigurationInterface $model, Request $request, $id)
    {
        if (! $model->isRestorableModel()) {
            abort(404);
        }

        $item = $model->getRepository()->findOnlyTrashed($id);

        if (is_null($item) || ! $model->isRestorable($item)) {
            abort(404);
        }

        $model->fireDestroy($id);

        if ($model->fireEvent('destroying', true, $item, $request) === false) {
            return redirect()->back();
        }

        $model->getRepository()->forceDelete($id);

        $model->fireEvent('destroyed', false, $item, $request);

        return redirect($request->input('_redirectBack', back()->getTargetUrl()))

            ->with('success_message', $model->getMessageOnDestroy());
    }

    /**
     * @param ModelConfigurationInterface|ModelConfiguration $model
     * @param Request $request
     * @param int $id
     *
     * @return \Illuminate\Http\RedirectResponse
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public function postRestore(ModelConfigurationInterface $model, Request $request, $id)
    {
        if (! $model->isRestorableModel()) {
            abort(404);
        }

        $item = $model->getRepository()->findOnlyTrashed($id);

        if (is_null($item) || ! $model->isRestorable($item)) {
            abort(404);
        }

        $model->fireRestore($id);

        if ($model->fireEvent('restoring', true, $item, $request) === false) {
            return redirect()->back();
        }

        $model->getRepository()->restore($id);

        $model->fireEvent('restored', false, $item, $request);

        return redirect($request->input('_redirectBack', back()->getTargetUrl()))

            ->with('success_message', $model->getMessageOnRestore());
    }

    /**
     * @param ModelConfigurationInterface $model
     * @param Renderable|string $content
     * @param string|null $title
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function render(ModelConfigurationInterface $model, $content, $title = null)
    {
        if ($content instanceof Renderable) {
            $content = $content->render();
        }

        if (is_null($title)) {
            $title = $model->getTitle();
        }

        return $this->admin->template()->view('_layout.inner')

            ->with('title', $title)
            ->/** @scrutinizer ignore-call */ with('title', $title)
            ->with('content', $content)
            ->with('breadcrumbKey', $this->parentBreadcrumb);
    }

    /**
     * @param Renderable|string $content
     * @param string|null $title
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function renderContent($content, $title = null)
    {
        if ($content instanceof Renderable) {
            $content = $content->render();
        }

        return $this->admin->template()->view('_layout.inner')

            ->with('title', $title)
            ->with('content', $content)
            ->with('breadcrumbKey', $this->parentBreadcrumb);
    }

    /**
     * @param Request $request
     *
     * @return null|string
     */
    protected function getBackUrl(Request $request)
    {
        if (($backUrl = $request->input('_redirectBack')) == \URL::previous()) {
            $backUrl = null;
            $request->merge(['_redirectBack' => $backUrl]);
        }

        return $backUrl;
    }

    public function getWildcard()
    {
        abort(404);
    }

    /**
     * @param $title
     * @param $parent
     * @throws \DaveJamesMiller\Breadcrumbs\Exception
     */
    protected function registerBreadcrumb($title, $parent)
    {
        $this->breadcrumbs->register('render', function (Generator $breadcrumbs) use ($title, $parent) {
            $breadcrumbs->parent($parent);
            $breadcrumbs->push($title);
        });

        $this->parentBreadcrumb = 'render';
    }

    /**
     * @param ModelConfigurationInterface $model
     * @throws \DaveJamesMiller\Breadcrumbs\Exception
     */
    protected function registerBreadcrumbs(ModelConfigurationInterface $model)
    {
        $this->breadCrumbsData = $this->breadCrumbsData + (array) $model->getBreadCrumbs();

        foreach ($this->breadCrumbsData as $breadcrumb) {
            if (! $this->breadcrumbs->exists($breadcrumb['id'])) {
                $this->breadcrumbs->register($breadcrumb['id'], function (Generator $breadcrumbs) use ($breadcrumb) {
                    $breadcrumbs->parent($breadcrumb['parent']);
                    $breadcrumbs->push($breadcrumb['title'], $breadcrumb['url']);
                });
            }
        }
    }
}

LaravelRUS / SleepingOwlAdmin

GitHub Access Token became invalid

Pull Request — new (#872)

AdminController::validatePolicy() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
