silverstripe-mathspamprotection/src/MathSpamProtectorField.php

<?php

namespace SilverStripe\MathSpamProtection;

use SilverStripe\Control\Controller;
use SilverStripe\Core\Config\Config;
use SilverStripe\Control\Session;
use SilverStripe\Forms\TextField;

/**
 * {@link FormField} for adding an optional maths protection question to a form.
 *
 * @package mathspamprotection
 */

class MathSpamProtectorField extends TextField
{
    /**
     * @config
     *
     * @var bool $enabled
     */
    private static $enabled = true;

    /**
     * @config
     *
     * @var string
     */
    private static $question_prefix;

    /**
     * @config
     *
     * @var bool $allow_numeric_answer
     */
    private static $allow_numeric_answer = true;

    public function Field($properties = array())
    {
        if ($this->config()->get('enabled')) {
            return parent::Field($properties);
        }

        return null;
    }

    public function FieldHolder($properties = array())
    {
        if ($this->config()->get('enabled')) {
            return parent::FieldHolder($properties);
        }

        return null;
    }

    /**
     * Returns the spam question
     *
     * @return string
     */
    public function Title()
    {
        $prefix = $this->config()->get('question_prefix');

        if (!$prefix) {
            $prefix = _t('MathSpamProtectionField.SPAMQUESTION', "Spam protection question: %s");
        }

        return sprintf(
            $prefix,
            $this->getMathsQuestion()
        );
    }

    /**
     * Validates the value submitted by the user with the one saved into the
     * {@link Session} and then notify callback object with the spam checking
     * result.
     *
     * @return bool
     */
    public function validate($validator)
    {
        if (!$this->config()->get( 'enabled')) {
            return true;
        }

        $value = Controller::curr()->getRequest()->postVar($this->getName());

        if (!$value) {
            $value = $this->Value();
        }

        if (!$this->isCorrectAnswer($value)) {
            $validator->validationError(
                $this->name,
                _t(
                    'MathSpamProtectionField.INCORRECTSOLUTION',
                    "Incorrect solution to the spam protection question, please try again."
                ),
                "error"
            );

            return false;
        }

        return true;
    }


    /**
     * Creates the question from random variables, which are also saved to the session.
     *
     * @return string
     */
    public function getMathsQuestion()
    {
        /** @var Session $session */
        $session = Controller::curr()->getRequest()->getSession();

        if (!$session->get("mathQuestionV1") && !$session->get("mathQuestionV2")) {
            $v1 = rand(1, 9);
            $v2 = rand(1, 9);

            $session->set("mathQuestionV1", $v1);
            $session->set("mathQuestionV2", $v2);
        } else {
            $v1 = $session->get("mathQuestionV1");
            $v2 = $session->get("mathQuestionV2");
        }

        return sprintf(
            _t('MathSpamProtection.WHATIS', "What is %s plus %s?"),
            MathSpamProtectorField::digit_to_word($v1),
            MathSpamProtectorField::digit_to_word($v2)
        );
    }

    /**
     * Checks the given answer if it matches the addition of the saved session
     * variables.
     *
     * Users can answer using words or digits.
     *
     * @return bool
     */
    public function isCorrectAnswer($answer)
    {
        $session = Controller::curr()->getRequest()->getSession();

        $v1 = $session->get("mathQuestionV1");
        $v2 = $session->get("mathQuestionV2");

        $session->clear('mathQuestionV1');
        $session->clear('mathQuestionV2');

        $word = MathSpamProtectorField::digit_to_word($v1 + $v2);

        return ($word == strtolower($answer) || ($this->config()->get('allow_numeric_answer') && (($v1 + $v2) === intval($answer))));
    }

    /**
     * Helper method for converting digits to their equivalent english words
     *
     * @return string
     */
    public static function digit_to_word($num)
    {
        $numbers = array(_t('MathSpamProtection.ZERO', 'zero'),
            _t('MathSpamProtection.ONE', 'one'),
            _t('MathSpamProtection.TWO', 'two'),
            _t('MathSpamProtection.THREE', 'three'),
            _t('MathSpamProtection.FOUR', 'four'),
            _t('MathSpamProtection.FIVE', 'five'),
            _t('MathSpamProtection.SIX', 'six'),
            _t('MathSpamProtection.SEVEN', 'seven'),
            _t('MathSpamProtection.EIGHT', 'eight'),
            _t('MathSpamProtection.NINE', 'nine'),
            _t('MathSpamProtection.TEN', 'ten'),
            _t('MathSpamProtection.ELEVEN', 'eleven'),
            _t('MathSpamProtection.TWELVE', 'twelve'),
            _t('MathSpamProtection.THIRTEEN', 'thirteen'),
            _t('MathSpamProtection.FOURTEEN', 'fourteen'),
            _t('MathSpamProtection.FIFTEEN', 'fifteen'),
            _t('MathSpamProtection.SIXTEEN', 'sixteen'),
            _t('MathSpamProtection.SEVENTEEN', 'seventeen'),
            _t('MathSpamProtection.EIGHTEEN', 'eighteen'));

        if ($num < 0) {
            return "minus ".($numbers[-1*$num]);
        }

        return $numbers[$num];
    }

    public function Type()
    {
        return 'mathspamprotector text';
    }
}