ShortList

Complexity

Total Complexity

8

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	5
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
B	onBeforeWrite()	0	35	6
A	Link()	0	4	1
A	isBrowser()	0	9	1

<?php

/**
 * @file
 * This is the model for the short list URLs.
 */

/**
 * A model to store the short list of items and a unique URL.
 */
class ShortList extends DataObject

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * Fields.
     */
    private static $db = array(
        'SessionID'     => 'varchar(32)',
        'URL'           => 'Varchar(100)',
        'UserAgent'     => 'Varchar(512)'
    );

    /**
     * Attaches to many items.
     */
    private static $has_many = array(
        'ShortListItems' => 'ShortListItem'
    );

    /**
     * Where the URL is unique.
     */
    private static $indexes = array(
        'UniqueURL'     => array(
            'type'      => 'unique',
            'value'     => 'URL'
        )
    );

    /**
     * Ensure we populate these fields before a save.
     */
    public function onBeforeWrite()
    {

        // Run other beforewrites first.
        parent::onBeforeWrite();

        if (!$this->isBrowser()) {
            return false;
        }

        // If this is the first save...
        if (!$this->ID) {
            // Ensure the session exists before querying it.
            if (!Session::request_contains_session_id()) {
                Session::start();
            }

            // Store the sesion and has information in the database.
            $this->SessionID = session_id();

            if (is_null($this->SessionID)) {
                return false;
            }

            $gen = new RandomGenerator();
            $uniqueurl = substr($gen->randomToken(), 0, 32);

            while (ShortList::get()->filter('URL', $uniqueurl)->count() > 0) {
                $uniqueurl = substr($gen->randomToken(), 0, 32);
            }

            $this->URL = $uniqueurl;
            $this->UserAgent = Controller::curr()->getRequest()->getHeader('User-Agent');
        }
    }

    /**
     * All URLs are prefixed with URLSegment from config.
     */
    public function Link($action = null)
    {
        return Config::inst()->get('ShortList', 'URLSegment') . $this->URL;
    }

    /**
     * A basic browser detection.
     * * if a browser is not here - assume it's a crawler or a bot. In which case, it shouldn't create a shortlist.
     *
     * @see http://stackoverflow.com/a/1537636
     * */
    public static function isBrowser()
    {
        // Regular expression to match common browsers
        $browserlist = '/(opera|aol|msie|firefox|chrome|konqueror|safari|netscape|navigator|mosaic|lynx|amaya|omniweb|avant|camino|flock|seamonkey|mozilla|gecko)+/i';

        $userAgent = strtolower(Controller::curr()->getRequest()->getHeader('User-Agent'));

        return preg_match($browserlist, $userAgent) === 1;
    }
}