IdsLogController::export() - Code Metrics - Inspection of "remove action suffix from controller methods" - zikula/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#4481)

by Axel
created 2020-09-18 15:36 UTC
IdsLogController::export() F

↳ Parent: IdsLogController
Complexity

Conditions	18
Paths	483
Size

Total Lines	94
Code Lines	66
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	18
eloc	66
c	0
b	0
f	0
nc	483
nop	2
dl	0
loc	94
rs	1.418
How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula - https://ziku.la/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\SecurityCenterModule\Controller;

use InvalidArgumentException;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
use Zikula\Bundle\CoreBundle\Controller\AbstractController;
use Zikula\Bundle\CoreBundle\Response\PlainResponse;
use Zikula\Bundle\FormExtensionBundle\Form\Type\DeletionType;
use Zikula\Component\SortableColumns\Column;
use Zikula\Component\SortableColumns\SortableColumns;
use Zikula\PermissionsModule\Annotation\PermissionCheck;
use Zikula\SecurityCenterModule\Entity\Repository\IntrusionRepository;
use Zikula\SecurityCenterModule\Form\Type\IdsLogExportType;
use Zikula\SecurityCenterModule\Form\Type\IdsLogFilterType;
use Zikula\ThemeModule\Engine\Annotation\Theme;

/**
 * Class IdsLogController
 *
 * @Route("/idslog")
 */
class IdsLogController extends AbstractController
{
    /**
     * @Route("/view/{page}", methods = {"GET"}, requirements={"page" = "\d+"})
     * @PermissionCheck("edit")
     * @Theme("admin")
     * @Template("@ZikulaSecurityCenterModule/IdsLog/view.html.twig")
     *
     * Function to view ids log events.
     */
    public function viewLog(
        Request $request,
        IntrusionRepository $repository,
        RouterInterface $router,
        int $page = 1
    ): array {
        // sorting
        $sort = $request->query->get('sort', 'date DESC');
        $sort_exp = explode(' ', $sort);
        $sortField = $sort_exp[0];
        $sortDirection = $sort_exp[1] ?? 'ASC';
        $sorting = [$sortField => $sortDirection];

        // filtering
        $defaultFilter = [
            'uid' => 0,
            'name' => null,
            'tag' => null,
            'value' => null,
            'page' => null,
            'ip' => null,
            'impact' => null
        ];
        $filterForm = $this->createForm(IdsLogFilterType::class, $defaultFilter, [
            'repository' => $repository
        ]);
        $filters = $where = [];
        $filterForm->handleRequest($request);
        if ($filterForm->isSubmitted() && $filterForm->isValid()) {
            $filters = $filterForm->getData();
            foreach ($filters as $flt_key => $flt_value) {
                if (isset($flt_value) && !empty($flt_value)) {
                    $where[$flt_key] = $flt_value;
                }
            }
        }
        $hasFilters = 0 < count($where);

        // number of items to show
        $pageSize = (int)$this->getVar('pagesize', 25);

        // get data
        $paginator = $repository->getIntrusions($where, $sorting, $page, $pageSize);
        $paginator->setRoute('zikulasecuritycentermodule_idslog_view');
        $paginator->setRouteParameters(['sort' => $sort, 'filter' => $filters]);

        $sortableColumns = new SortableColumns($router, 'zikulasecuritycentermodule_idslog_view', 'sort', 'sortdir');
        $sortableColumns->addColumns([
            new Column('name'),
            new Column('tag'),
            new Column('value'),
            new Column('page'),
            new Column('username'),
            new Column('ip'),
            new Column('impact'),
            new Column('date')
        ]);
        $sortableColumns->setOrderBy($sortableColumns->getColumn($sortField), mb_strtoupper($sortDirection));

        $templateParameters = [
            'filterForm' => $filterForm->createView(),
            'hasFilters' => $hasFilters,
            'sort' => $sortableColumns,
            'paginator' => $paginator
        ];

        return $templateParameters;
    }

    /**
     * @Route("/export")
     * @PermissionCheck("edit")
     * @Theme("admin")
     * @Template("@ZikulaSecurityCenterModule/IdsLog/export.html.twig")
     *
     * Export ids log.
     *
     * @return array|Response
     */
    public function export(Request $request, IntrusionRepository $repository)
    {
        $form = $this->createForm(IdsLogExportType::class, []);
        $form->handleRequest($request);
        if ($form->isSubmitted() && $form->isValid()) {
            if ($form->get('export')->isClicked()) {
            if ($form->get('export')->/** @scrutinizer ignore-call */ isClicked()) {
                $formData = $form->getData();

                // export the titles ?
                $exportTitles = isset($formData['titles']) && 1 === $formData['titles'];

                // name of the exported file
                $exportFile = $formData['file'] ?? null;
                if (null === $exportFile || '' === $exportFile) {
                    $exportFile = 'idslog.csv';
                }
                if (!mb_strrpos($exportFile, '.csv')) {
                    $exportFile .= '.csv';
                }

                // delimeter
                $delimiter = $formData['delimiter'] ?? null;
                if (null === $delimiter || '' === $delimiter) {
                    $delimiter = 1;
                }
                switch ($delimiter) {
                    case 1:
                        $delimiter = ',';
                        break;
                    case 2:
                        $delimiter = ';';
                        break;
                    case 3:
                        $delimiter = ':';
                        break;
                    case 4:
                        $delimiter = chr(9);
                }

                $titles = [
                    $this->trans('Name'),
                    $this->trans('Tag'),
                    $this->trans('Value'),
                    $this->trans('Page'),
                    $this->trans('User Name'),
                    $this->trans('IP'),
                    $this->trans('Impact'),
                    $this->trans('PHPIDS filters used'),
                    $this->trans('Date')
                ];

                // get data
                $items = $repository->getIntrusions([], ['date' => 'DESC']);

                $string = $exportTitles ? implode($delimiter, $titles) . PHP_EOL : '';
                foreach ($items->getResults() as $item) {
                    $dta = $item->toArray();
                    $dta['filters'] = unserialize($dta['filters']);
                    $filtersUsed = '';
                    foreach ($dta['filters'] as $filter) {
                        $filtersUsed .= $filter['id'] . ' ';
                    }
                    $string .=
                        $dta['name'] . $delimiter .
                        $dta['tag'] . $delimiter .
                        htmlspecialchars(str_replace(["\r\n", "\n"], ['', ''], $dta['value']), ENT_COMPAT, 'UTF-8', false) . $delimiter .
                        htmlspecialchars($dta['page'], ENT_COMPAT, 'UTF-8', false) . $delimiter .
                        $dta['user']['uname'] . $delimiter .
                        $dta['ip'] . $delimiter .
                        $dta['impact'] . $delimiter .
                        $filtersUsed . $delimiter .
                        $dta['date']->format('Y-m-d H:i:s') . PHP_EOL;
                }

                // create and export the csv file
                $response = new PlainResponse($string);
                $disposition = $response->headers->makeDisposition(
                    ResponseHeaderBag::DISPOSITION_ATTACHMENT,
                    $exportFile
                );
                $response->headers->set('Content-Disposition', $disposition);
                $response->headers->set('Content-Type', 'text/csv');

                return $response;
            }
            if ($form->get('cancel')->isClicked()) {
                $this->addFlash('status', 'Operation cancelled.');

                return $this->redirectToRoute('zikulasecuritycentermodule_idslog_view');
            }
        }

        return [
            'form' => $form->createView()
        ];
    }

    /**
     * @Route("/purge")
     * @PermissionCheck("delete")
     * @Theme("admin")
     * @Template("@ZikulaSecurityCenterModule/IdsLog/purge.html.twig")
     *
     * Purge ids log.
     *
     * @return array|RedirectResponse
     */
    public function purge(Request $request, IntrusionRepository $repository)
    {
        $form = $this->createForm(DeletionType::class);
        $form->handleRequest($request);
        if ($form->isSubmitted() && $form->isValid()) {
            if ($form->get('delete')->isClicked()) {
                // delete all entries
                $repository->truncateTable();

                $this->addFlash('status', 'Done! Purged IDS log.');
            } elseif ($form->get('cancel')->isClicked()) {
                $this->addFlash('status', 'Operation cancelled.');
            }

            return $this->redirectToRoute('zikulasecuritycentermodule_idslog_view');
        }

        return [
            'form' => $form->createView()
        ];
    }

    /**
     * @Route("/deleteentry")
     * @PermissionCheck("delete")
     *
     * Delete an ids log entry.
     *
     * @throws AccessDeniedException Thrown if the CSRF token is invalid
     * @throws InvalidArgumentException Thrown if the object id is not numeric or if
     */
    public function deleteEntry(Request $request, IntrusionRepository $repository): RedirectResponse
    {
        if (!$this->isCsrfTokenValid('delete-idsentry', $request->query->get('token'))) {
            throw new AccessDeniedException();
        }

        $id = $request->query->getInt('id', 0);
        $intrusion = $repository->find($id);
        if (!$intrusion) {
            $this->addFlash('error', $this->trans('Error! Invalid %identifier% received.', ['%identifier%' => "object ID [${id}]"]));
        } else {
            // delete object
            $this->getDoctrine()->getManager()->remove($intrusion);
            $this->getDoctrine()->getManager()->flush();
        }

        return $this->redirectToRoute('zikulasecuritycentermodule_idslog_view');
    }
}

zikula / core

Pull Request — master (#4481)

IdsLogController::export() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
