ShortListController

Complexity

Total Complexity

40

Size/Duplication

Total Lines	214
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	10	2
B	index()	0	23	5
A	Link()	0	11	2
B	renderList()	0	22	4
B	performAction()	0	32	5
A	shortListCount()	0	14	4
A	getShortListSession()	0	4	1
A	getSecurityToken()	0	4	1
A	getSessionShortList()	0	7	1
A	renderAjax()	0	13	3
A	dontRender()	0	4	4
A	isSessionValid()	0	3	3
B	dontPerformAction()	0	5	5

<?php
use Jaybizzle\CrawlerDetect\CrawlerDetect;

class ShortListController extends Page_Controller
{
    private static $allowed_actions = array(
        'renderList',
        'performAction'
    );

    private static $url_handlers = array(
        'add'       => 'performAction',
        'remove'    => 'performAction',
        '$URL!'     => 'renderList',
    );

    private static $extensions = array(
        'ShortListPaginationExtension'
    );

    public function init()
    {
        parent::init();

        Session::start();

        if ($this->request->getVar('page')) {
            $this->currentPage = $this->request->getVar('page');
        }
    }

    /**
     * When landing on the homepage, if there is a shortlist for the current
     * user, redirect to the correct URL. Otherwise, 404.
     * */
    public function index($request)
    {
        if (($shortlist = $this->getSessionShortList())) {
            return $this->redirect(Config::inst()->get('ShortList', 'URLSegment').$shortlist->URL);
        } else {
            $CrawlerDetect = new CrawlerDetect;

            // Check the user agent of the current 'visitor'
            if ($CrawlerDetect->isCrawler()) {
                return $this->httpError(403);
            }

            $shortlist = $this->getSessionShortList();

            if (!$shortlist || !$shortlist->exists()) {
                $shortlist = new ShortList();
                $shortlist->write();
            }
        }

        // render with empty template.
        return $this->renderWith(array('Page', 'ShortList_empty'));
    }

    /**
     * Get the absolute URL of this controller.
     * */
    public function Link($action = null)
    {
        $shortlist = $this->getSessionShortList();
        $url = Config::inst()->get('ShortList', 'URLSegment');

        if ($shortlist) {
            $url .= $shortlist->URL;
        }

        return $url;
    }

    public function renderList($request)
    {
        $shortlist = DataObject::get_one('ShortList', $filter = array('URL' => $request->param('URL')));
        $link = false;
        $count = 0;

        if ($this->dontRender($shortlist, $request)) {
            return $this->httpError(404);
        }

        if ($shortlist && $shortlist->exists()) {
            $link = $shortlist->Link();
            $count = $shortlist->ShortListItems()->Count();
        }

        return $this->customise(array(
            'ShortlistURL' => $link,
            'ShortlistCount' => $count
        ))->renderWith(
            array('ShortList', 'Page')
        );
    }

    public function performAction($request)
    {
        if ($this->dontPerformAction($request)) {
            return $this->httpError(404);
        }

        $action = new AddToshortlistAction();
        $matches = array();

        preg_match('/remove|add/', $request->getURL(), $matches);

        if ($matches[0] == 'remove') {
            $action = new RemoveFromshortlistAction();
        }

        $status = $action->performAction(
            $shortlist = $this->getSessionShortList(),

$shortlist = $this->getSessionShortList() is of type object<DataObject>, but the function expects a null|object<ShortList>.

            $ID = $request->getVar('id'),
            $type = $request->getVar('type'),
            $session = $request->getVar('s')
        );

        if ($request->isAjax()) {
            return $this->renderAjax($session);
        }

        if (array_key_exists('output', $request->getVars())) {
            return $status;
        }

        return $this->redirectBack();
    }


    /**
     * Get the number of items in the current short list.
     *
     * @param session The session to check & find a shortlist for.
     * @return mixed false if no session exists - else the number of items in the shortlist.
     * */
    public function shortListCount($session = false)
    {
        if ($this->isSessionValid($session)) {
            return false;
        }

        $shortlist = $this->getSessionShortList();

        if (!$shortlist || !$shortlist->exists()) {
            return 0;
        }

        return $shortlist->Items()->count();
    }

    public static function getShortListSession()
    {
        return DataObject::get_one('ShortList', $filter = array('SessionID' => self::getSecurityToken()));
    }

    /**
     * Get the token to use to add/remove from shortlist.
     * */
    public static function getSecurityToken()
    {
        return Utilities::getSecurityToken();
    }

    /**
     * Return a valid shortlist - or null.
     * */
    private function getSessionShortList()
    {
        return DataObject::get_one('ShortList',
            $filter = array('SessionID' => self::getSecurityToken()),
            $cache = false
        );
    }

    /**
     * Return the json encoded count & url for the current session
     * */
    private function renderAjax($session) {
        $shortlist = $this->getSessionShortList();
        $url = false;

        if ($shortlist && $shortlist->exists()) {
            $url = $shortlist->Link();
        }

        return json_encode(array(
            'count' => $this->shortListCount($session),
            'url' => $url
        ));
    }

    /**
     * Don't render the template!
     * */
    private function dontRender($shortlist, $request)
    {
        return is_null(self::getSecurityToken()) || !$request->param('URL') || !$shortlist || !$shortlist->exists();
    }

    /**
     * Is this session valid?
     * */
    private function isSessionValid($session) {
        return is_null(self::getSecurityToken()) || !$session || $session != self::getSecurityToken();
    }

    /**
     * Don't perform an action.
     * */
    private function dontPerformAction($request)
    {
        return is_null(self::getSecurityToken()) || !$request->getVar('id') || !$request->getVar('type') ||
            !$request->getVar('s') || $request->getVar('s') != self::getSecurityToken();
    }
}