StudioBonito\SilverStripe\SpamProtection\Honeypot\FormField\HoneypotField

Complexity

Total Complexity

11

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	21	4
A	Title()	0	4	1
A	Type()	0	4	1
A	Field()	0	6	1
A	createHoneypotField()	0	13	1
A	createTimestampField()	0	13	1
A	getFieldStyle()	0	10	2

<?php namespace StudioBonito\SilverStripe\SpamProtection\Honeypot\FormField;

use SilverStripe\Core\Config\Config;
use SilverStripe\Forms\TextField;
use SilverStripe\View\HTML;
use SilverStripe\ORM\FieldType\DBHTMLText;

class HoneypotField extends TextField
{
    /**
     * The number of seconds before you can submit a valid request.
     *
     * @var int
     * @config
     */
    private static $time_limit = 5;

The property $time_limit is not used and could be removed.

    /**
     * Reject the field if the honeypot has been filled or if the form has been submitted to quickly.
     *
     * @param $validator
     *
     * @return bool
     */
    public function validate($validator)
    {
        $timeLimit = $this->config()->time_limit;

        $timestamp = $this->getForm()->getController()->getRequest()->postVar($this->getName() . '_Timestamp');

        if (!empty($this->value) || ($timeLimit > 0 && ($timestamp + $timeLimit) > time())) {
            $validator->validationError(
                $this->name,
                _t(
                    'HoneypotField.SPAM',
                    'Your submission has been rejected because it was treated as spam.'
                ),
                'error'
            );

            return false;
        }

        return true;
    }

    /**
     * Since this isn't a hidden field, the title will continue to show in the form.
     * This prevents that from happening, since a hidden field will not show the validation message.
     *
     * @codeCoverageIgnore
     *
     * @return string
     */
    public function Title()
    {
        return '';
    }

    /**
     * Override the Type to remove the class namespace.
     *
     * @codeCoverageIgnore
     *
     * @return string
     */
    public function Type()
    {
        return 'honeypotspamprotector';
    }

    /**
     * Override the Field to add the Captcha and Timestamp fields.
     *
     * @codeCoverageIgnore
     *
     * @param array $properties
     *
     * @return string
     */
    public function Field($properties = array())
    {
        $field = DBHTMLText::create($this->getName());
        $field->setValue($this->createHoneypotField() . $this->createTimestampField());
        return $field;
    }

    /**
     * Create the Captcha Field.
     *
     * @codeCoverageIgnore
     *
     * @return string
     */
    protected function createHoneypotField()
    {
        return HTML::createTag(
            'input',
            array(
                'type'  => 'text',
                'id'    => $this->ID(),
                'name'  => $this->getName(),
                'value' => $this->Value(),
                'style' => $this->getFieldStyle(),
            )
        );
    }

    /**
     * Create the Timestamp Field.
     *
     * @codeCoverageIgnore
     *
     * @return string
     */
    protected function createTimestampField()
    {
        return HTML::createTag(
            'input',
            array(
                'type'  => 'text',
                'id'    => $this->ID() . '_Timestamp',
                'name'  => $this->getName() . '_Timestamp',
                'value' => time(),
                'style' => $this->getFieldStyle(),
            )
        );
    }
    
    /**
     * Return a configured style rule for the fields, if none is configured use a default display:none rule
     *
     * @codeCoverageIgnore
     *
     * @return string
     */
    public function getFieldStyle()
    {
        $default_css_rule = 'display:none!important';
        $css_rule = Config::inst()->get(__CLASS__, 'field_style_rule');
        if (!$css_rule) {
            return $default_css_rule;
        } else {
            return $css_rule;
        }
    }
}