Phase\TakeATicketBundle\Controller\AjaxController

Complexity

Total Complexity

45

Size/Duplication

Total Lines	271
Duplicated Lines	12.18 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	4
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	nextSongsAction()	0	20	4
A	reloadPerformersAction()	0	5	1
A	songSearchAction()	0	22	3
A	useTicketAction()	17	17	2
A	remotesRedirectAction()	0	4	1
F	saveTicketAction()	0	132	26
A	deleteTicketAction()	14	14	2
A	lastUpdateHashAction()	0	4	1
B	newTicketOrderAction()	0	22	5

<?php
/**
 * Created by PhpStorm.
 * User: wechsler
 * Date: 28/01/2017
 * Time: 16:08
 */

namespace Phase\TakeATicketBundle\Controller;

use Phase\TakeATicket\Model\Instrument;
use Phase\TakeATicket\Model\Platform;
use Phase\TakeATicketBundle\Entity\User;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

class AjaxController extends BaseController
{
    const MANAGER_REQUIRED_ROLE = 'ROLE_ADMIN';
    const BAND_IDENTIFIER_BAND_NAME = 1;
    const BAND_IDENTIFIER_PERFORMERS = 2;

    /**
     * @var int Whether to identify band by its name or a list of performers
     */
    protected $bandIdentifier = self::BAND_IDENTIFIER_PERFORMERS;

    /**
     * @return JsonResponse
     *
     * FIXME does not honour config.displayOptions.songInPreview - always shows track!
     */
    public function nextSongsAction()
    {
        //        $this->setJsonErrorHandler();

72% of this comment could be valid code. Did you maybe forget this after debugging?

        //        $includePrivate = $this->app['security']->isGranted(self::MANAGER_REQUIRED_ROLE);

64% of this comment could be valid code. Did you maybe forget this after debugging?

        $includePrivate = false;
        $next = $this->getDataStore()->fetchUpcomingTickets($includePrivate);
        if ($includePrivate) {
            $show = $next;
        } else {
            $show = [];
            foreach ($next as $k => $ticket) {
                $show[$k] = $ticket;
                if ($ticket['blocking']) {
                    break;
                }
            }
        }

        return new JsonResponse($show);
    }

    public function reloadPerformersAction()
    {
        $performers = $this->getDataStore()->generatePerformerStats();
        return new JsonResponse($performers);
    }

    public function songSearchAction(Request $request)
    {
        $searchString = $request->get('searchString');
        $searchCount = 10;
        if ($request->get('searchCount')) {
            $searchCount = $request->get('searchCount');
        }
        $dataStore = $this->getDataStore();
        $songs = $dataStore->findSongsBySearchString($searchString, $searchCount);
        // Need to add sources, instruments
        $hydrated = [];

        foreach ($songs as $song) {
            $song = $dataStore->expandSongData($song);

            $hydrated[] = $song;
        }

        $jsonResponse = new JsonResponse(['ok' => 'ok', 'searchString' => $searchString, 'songs' => $hydrated]);

        return $jsonResponse;
    }

    public function useTicketAction(Request $request)

This method seems to be duplicated in your project.

    {
        //        $this->setJsonErrorHandler();

72% of this comment could be valid code. Did you maybe forget this after debugging?

        $this->denyAccessUnlessGranted(self::MANAGER_REQUIRED_ROLE);

        $id = $request->get('ticketId');
        $res = $this->getDataStore()->markTicketUsedById($id);
        //FIXME fetch ticket with extra data
        if ($res) {
            $jsonResponse = new JsonResponse(['ok' => 'ok']);
        } else {
            $jsonResponse = new JsonResponse(['ok' => 'fail'], 500);
        }

        return $jsonResponse;
    }

    public function remotesRedirectAction()
    {
        return new JsonResponse($this->getDataStore()->fetchSetting('remotesUrl'));
    }

    public function saveTicketAction(Request $request)
    {
        if (!$this->getDataStore()->fetchSetting('selfSubmission')) {
            $this->denyAccessUnlessGranted(self::MANAGER_REQUIRED_ROLE);
        }

        $title = $request->get('title');
        $songKey = $request->get('songId');
        $band = $request->get('band') ?: []; // band must be array even if null (as passed by AJAX if no performers)
        $private = $request->get('private') === 'true' ? 1 : 0;
        $blocking = $request->get('blocking') === 'true' ? 1 : 0;
        $existingTicketId = $request->get('existingTicketId');
        $submissionKey = trim($request->get('submissionKey'));
        $userId = null;

        if ($this->isGranted(self::MANAGER_REQUIRED_ROLE)) {
            $user = $this->getUser();
            /** @var User $user */
            $userId = $user->getId();
        } else {
            $blocking = 0;
            $private = 1;
            if ($existingTicketId) {
                throw new AccessDeniedException('Cannot modify existing tickets');
            }

            // Check song is unused, check no performers have more than 3 upcoming songs
            // Ensure that name format is valid

            $dataErrors = [];
            $fixableError = false;

            $ticketsForSong = $this->getDataStore()->getQueueEntriesForSongId($songKey);

            if (count($ticketsForSong)) {
                $dataErrors[] = 'The song is already taken';
            }

            $performerStats = $this->getDataStore()->generatePerformerStats();

            foreach ($band as $instrumentCandidates) {
                foreach ($instrumentCandidates as $candidate) {
                    $candidate = trim($candidate);
                    if ($candidate) {
                        if (preg_match('/\w+ \w+/', $candidate)) {
                            foreach ($performerStats as $performerStat) {
                                if (($performerStat['songsPending'] > 2) &&
                                    !strcasecmp($candidate, $performerStat['performerName'])
                                ) {
                                    $dataErrors[] = "$candidate has too many songs pending";
                                }
                            }
                        } else {
                            $dataErrors[] = "'$candidate' is not a valid name";
                        }
                    }
                }
            }

            if ($this->getDataStore()->fetchSetting('selfSubmissionKey') &&
                strcasecmp($submissionKey, $this->getDataStore()->fetchSetting('selfSubmissionKey'))
            ) {
                $dataErrors[] = 'Secret code wrong or missing';
                $fixableError = 'E_BAD_SECRET';
            }

            if ($dataErrors) {

The expression $dataErrors of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                $responseData = [
                    'status' => 'error',
                    'message' => implode(', ', $dataErrors)
                ];
                if ($fixableError) {

The expression $fixableError of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

                    $responseData['error'] = $fixableError; // more than one error = faily death.
                }
                return new JsonResponse($responseData, 200);
            }
        }

        $song = null;
        $songId = null;

        if (preg_match('/^[a-f0-9]{6}$/i', $songKey)) {
            $song = $this->getDataStore()->fetchSongByKey($songKey);
        } elseif (preg_match('/^\d+$/', $songKey)) {
            $song = $this->getDataStore()->fetchSongRowById($songKey);
        }

        if ($song) {
            $songId = $song['id'];
        }

        if (!$title) {
            $title = null;
        }

        if ($existingTicketId) {
            $ticketId = $existingTicketId;
        } else {
            $ticketId = $this->getDataStore()->storeNewTicket($title, $songId, $userId);
        }

        // update even new tickets so that we can add any new columns easily
        $updated = ['title' => $title, 'songId' => $songId, 'blocking' => $blocking, 'private' => $private];

        $this->getDataStore()->updateTicketById(
            $ticketId,
            $updated
        );

        // think this is legacy?
        if ($this->bandIdentifier === self::BAND_IDENTIFIER_PERFORMERS) {
            $this->getDataStore()->storeBandToTicket($ticketId, $band);
        }

        $ticket = $this->getDataStore()->fetchTicketById($ticketId);

        $ticket = $this->getDataStore()->expandTicketData($ticket);

        $responseData = [
            'ticket' => $ticket,
            'performers' => $this->getDataStore()->generatePerformerStats(),
            'status' => 'ok'
        ];

        if ($ticketId) {
            $jsonResponse = new JsonResponse($responseData);
        } else {
            $jsonResponse = new JsonResponse($responseData, 500);
        }

        return $jsonResponse;
    }

    public function deleteTicketAction(Request $request)

This method seems to be duplicated in your project.

    {
        $this->denyAccessUnlessGranted(self::MANAGER_REQUIRED_ROLE);

        $id = $request->get('ticketId');
        $res = $this->getDataStore()->deleteTicketById($id);
        if ($res) {
            $jsonResponse = new JsonResponse(['ok' => 'ok']);
        } else {
            $jsonResponse = new JsonResponse(['ok' => 'fail'], 500);
        }

        return $jsonResponse;
    }

    /**
     * Opaque hash that changes when new tickets are added (may cover further changes in future)
     *
     * @return JsonResponse
     * @throws \Doctrine\DBAL\DBALException
     */
    public function lastUpdateHashAction()
    {
        return new JsonResponse(['hash' => count($this->getDataStore()->fetchUndeletedTickets())]);
    }

    public function newTicketOrderAction(Request $request)
    {
        $this->denyAccessUnlessGranted(self::MANAGER_REQUIRED_ROLE);

        $idOrder = $request->get('idOrder');

        if (!is_array($idOrder)) {
            throw new \InvalidArgumentException('Order must be array!');
        }

        $res = true;
        foreach ($idOrder as $offset => $id) {
            $res = $res && $this->getDataStore()->updateTicketOffsetById($id, $offset);
        }
        if ($res) {
            $jsonResponse = new JsonResponse(['ok' => 'ok']);
        } else {
            $jsonResponse = new JsonResponse(['ok' => 'fail', 'message' => 'Failed to store new sort order'], 500);
        }

        return $jsonResponse;
    }
}