silverstripe / silverstripe-akismet

code/AkismetField.php

Indentation +180 added lines, -180 removed lines

@@ -8,206 +8,206 @@
  */
 class AkismetField extends FormField
 {
-    /**
-     * @var array
-     */
-    private $fieldMapping = array();
+	/**
+	 * @var array
+	 */
+	private $fieldMapping = array();
 
-    /**
-     *
-     * @var boolean
-     */
-    protected $isSpam = null;
+	/**
+	 *
+	 * @var boolean
+	 */
+	protected $isSpam = null;
     
-    /**
-     * Get the nested confirmation checkbox field
-     * 
-     * @return CheckboxField
-     */
-    protected function confirmationField()
-    {
-        // Check if confirmation is required
-        $requireConfirmation = Config::inst()->get('AkismetSpamProtector', 'require_confirmation');
-        if (empty($requireConfirmation)) {
-            return null;
-        }
+	/**
+	 * Get the nested confirmation checkbox field
+	 * 
+	 * @return CheckboxField
+	 */
+	protected function confirmationField()
+	{
+		// Check if confirmation is required
+		$requireConfirmation = Config::inst()->get('AkismetSpamProtector', 'require_confirmation');
+		if (empty($requireConfirmation)) {
+			return null;
+		}
         
-        // If confirmation is required then return a checkbox
-        return CheckboxField::create(
-            $this->getName(),
-            _t('AkismetField.NOTIFICATION', 'I understand that, and give consent to, having this content submitted to '
-                . 'a third party for automated spam detection')
-        )
-            ->setError($this->Message(), $this->MessageType())
-            ->setForm($this->getForm());
-    }
+		// If confirmation is required then return a checkbox
+		return CheckboxField::create(
+			$this->getName(),
+			_t('AkismetField.NOTIFICATION', 'I understand that, and give consent to, having this content submitted to '
+				. 'a third party for automated spam detection')
+		)
+			->setError($this->Message(), $this->MessageType())
+			->setForm($this->getForm());
+	}
     
-    public function Field($properties = array())
-    {
-        $checkbox = $this->confirmationField();
-        if ($checkbox) {
-            return $checkbox->Field($properties);
-        }
-    }
+	public function Field($properties = array())
+	{
+		$checkbox = $this->confirmationField();
+		if ($checkbox) {
+			return $checkbox->Field($properties);
+		}
+	}
     
-    public function FieldHolder($properties = array())
-    {
-        $checkbox = $this->confirmationField();
-        if ($checkbox) {
-            return $checkbox->FieldHolder($properties);
-        }
-    }
+	public function FieldHolder($properties = array())
+	{
+		$checkbox = $this->confirmationField();
+		if ($checkbox) {
+			return $checkbox->FieldHolder($properties);
+		}
+	}
     
-    /**
-     * @return array
-     */
-    public function getSpamMappedData()
-    {
-        if (empty($this->fieldMapping)) {
-            return null;
-        }
+	/**
+	 * @return array
+	 */
+	public function getSpamMappedData()
+	{
+		if (empty($this->fieldMapping)) {
+			return null;
+		}
         
-        $result = array();
-        $data = $this->form->getData();
+		$result = array();
+		$data = $this->form->getData();
 
-        foreach ($this->fieldMapping as $fieldName => $mappedName) {
-            $result[$mappedName] = (isset($data[$fieldName])) ? $data[$fieldName] : null;
-        }
+		foreach ($this->fieldMapping as $fieldName => $mappedName) {
+			$result[$mappedName] = (isset($data[$fieldName])) ? $data[$fieldName] : null;
+		}
 
-        return $result;
-    }
+		return $result;
+	}
     
-    /**
-     * This function first gets values from mapped fields and then check these values against
-     * Mollom web service and then notify callback object with the spam checking result.
-     * @param Validator $validator
-     * @return 	boolean		- true when Mollom confirms that the submission is ham (not spam)
-     *						- false when Mollom confirms that the submission is spam 
-     * 						- false when Mollom say 'unsure'. 
-     *						  In this case, 'mollom_captcha_requested' session is set to true 
-     *       				  so that Field() knows it's time to display captcha 			
-     */
-    public function validate($validator)
-    {
+	/**
+	 * This function first gets values from mapped fields and then check these values against
+	 * Mollom web service and then notify callback object with the spam checking result.
+	 * @param Validator $validator
+	 * @return 	boolean		- true when Mollom confirms that the submission is ham (not spam)
+	 *						- false when Mollom confirms that the submission is spam 
+	 * 						- false when Mollom say 'unsure'. 
+	 *						  In this case, 'mollom_captcha_requested' session is set to true 
+	 *       				  so that Field() knows it's time to display captcha 			
+	 */
+	public function validate($validator)
+	{
         
-        // Check that, if necessary, the user has given permission to check for spam
-        $requireConfirmation = Config::inst()->get('AkismetSpamProtector', 'require_confirmation');
-        if ($requireConfirmation && !$this->Value()) {
-            $validator->validationError(
-                $this->name,
-                _t(
-                    'AkismetField.NOTIFICATIONREQUIRED',
-                    'You must give consent to submit this content to spam detection'
-                ),
-                "error"
-            );
-            return false;
-        }
+		// Check that, if necessary, the user has given permission to check for spam
+		$requireConfirmation = Config::inst()->get('AkismetSpamProtector', 'require_confirmation');
+		if ($requireConfirmation && !$this->Value()) {
+			$validator->validationError(
+				$this->name,
+				_t(
+					'AkismetField.NOTIFICATIONREQUIRED',
+					'You must give consent to submit this content to spam detection'
+				),
+				"error"
+			);
+			return false;
+		}
         
-        // Check result
-        $isSpam = $this->getIsSpam();
-        if (!$isSpam) {
-            return true;
-        }
+		// Check result
+		$isSpam = $this->getIsSpam();
+		if (!$isSpam) {
+			return true;
+		}
 
-        // Save error message
-        $errorMessage = _t(
-            'AkismetField.SPAM',
-            "Your submission has been rejected because it was treated as spam."
-        );
+		// Save error message
+		$errorMessage = _t(
+			'AkismetField.SPAM',
+			"Your submission has been rejected because it was treated as spam."
+		);
 
-        // If spam should be allowed, let it pass and save it for later
-        if (Config::inst()->get('AkismetSpamProtector', 'save_spam')) {
-            // In order to save spam but still display the spam message, we must mock a form message
-            // without failing the validation
-            $errors = array(array(
-                'fieldName' => $this->name,
-                'message' => $errorMessage,
-                'messageType' => 'error',
-            ));
-            $formName = $this->getForm()->FormName();
-            Session::set("FormInfo.{$formName}.errors", $errors);
-            return true;
-        } else {
-            // Mark as spam
-            $validator->validationError($this->name, $errorMessage, "error");
-            return false;
-        }
-    }
+		// If spam should be allowed, let it pass and save it for later
+		if (Config::inst()->get('AkismetSpamProtector', 'save_spam')) {
+			// In order to save spam but still display the spam message, we must mock a form message
+			// without failing the validation
+			$errors = array(array(
+				'fieldName' => $this->name,
+				'message' => $errorMessage,
+				'messageType' => 'error',
+			));
+			$formName = $this->getForm()->FormName();
+			Session::set("FormInfo.{$formName}.errors", $errors);
+			return true;
+		} else {
+			// Mark as spam
+			$validator->validationError($this->name, $errorMessage, "error");
+			return false;
+		}
+	}
 
-    /**
-     * Determine if this field is spam or not
-     *
-     * @return boolean
-     */
-    public function getIsSpam()
-    {
-        // Prevent multiple API calls
-        if ($this->isSpam !== null) {
-            return $this->isSpam;
-        }
+	/**
+	 * Determine if this field is spam or not
+	 *
+	 * @return boolean
+	 */
+	public function getIsSpam()
+	{
+		// Prevent multiple API calls
+		if ($this->isSpam !== null) {
+			return $this->isSpam;
+		}
 
-        // Check bypass permission
-        $permission = Config::inst()->get('AkismetSpamProtector', 'bypass_permission');
-        if ($permission && Permission::check($permission)) {
-            return false;
-        }
+		// Check bypass permission
+		$permission = Config::inst()->get('AkismetSpamProtector', 'bypass_permission');
+		if ($permission && Permission::check($permission)) {
+			return false;
+		}
 
-        // if the user has logged and there's no force check on member
-        $bypassMember = Config::inst()->get('AkismetSpamProtector', 'bypass_members');
-        if ($bypassMember && Member::currentUser()) {
-            return false;
-        }
+		// if the user has logged and there's no force check on member
+		$bypassMember = Config::inst()->get('AkismetSpamProtector', 'bypass_members');
+		if ($bypassMember && Member::currentUser()) {
+			return false;
+		}
 
-        // Map input fields to spam fields
-        $mappedData = $this->getSpamMappedData();
-        $content = isset($mappedData['body']) ? $mappedData['body'] : null;
-        $author = isset($mappedData['authorName']) ? $mappedData['authorName'] : null;
-        $email = isset($mappedData['authorMail']) ? $mappedData['authorMail'] : null;
-        $url = isset($mappedData['authorUrl']) ? $mappedData['authorUrl'] : null;
+		// Map input fields to spam fields
+		$mappedData = $this->getSpamMappedData();
+		$content = isset($mappedData['body']) ? $mappedData['body'] : null;
+		$author = isset($mappedData['authorName']) ? $mappedData['authorName'] : null;
+		$email = isset($mappedData['authorMail']) ? $mappedData['authorMail'] : null;
+		$url = isset($mappedData['authorUrl']) ? $mappedData['authorUrl'] : null;
 
-        // Check result
-        $api = AkismetSpamProtector::api();
-        $this->isSpam = $api && $api->isSpam($content, $author, $email, $url);
-        return $this->isSpam;
-    }
+		// Check result
+		$api = AkismetSpamProtector::api();
+		$this->isSpam = $api && $api->isSpam($content, $author, $email, $url);
+		return $this->isSpam;
+	}
     
-    /**
-     * Get the fields to map spam protection too
-     *
-     * @return array Associative array of Field Names, where the indexes of the array are
-     * the field names of the form and the values are the standard spamprotection
-     * fields used by the protector
-     */
-    public function getFieldMapping()
-    {
-        return $this->fieldMapping;
-    }
+	/**
+	 * Get the fields to map spam protection too
+	 *
+	 * @return array Associative array of Field Names, where the indexes of the array are
+	 * the field names of the form and the values are the standard spamprotection
+	 * fields used by the protector
+	 */
+	public function getFieldMapping()
+	{
+		return $this->fieldMapping;
+	}
 
-    /**
-     * Set the fields to map spam protection too
-     *
-     * @param array $fieldMapping array of Field Names, where the indexes of the array are
-     * the field names of the form and the values are the standard spamprotection
-     * fields used by the protector
-     * @return self
-     */
-    public function setFieldMapping($fieldMapping)
-    {
-        $this->fieldMapping = $fieldMapping;
-        return $this;
-    }
+	/**
+	 * Set the fields to map spam protection too
+	 *
+	 * @param array $fieldMapping array of Field Names, where the indexes of the array are
+	 * the field names of the form and the values are the standard spamprotection
+	 * fields used by the protector
+	 * @return self
+	 */
+	public function setFieldMapping($fieldMapping)
+	{
+		$this->fieldMapping = $fieldMapping;
+		return $this;
+	}
 
-    /**
-     * Allow spam flag to be saved to the underlying data record
-     *
-     * @param \DataObjectInterface $record
-     */
-    public function saveInto(\DataObjectInterface $record)
-    {
-        if (Config::inst()->get('AkismetSpamProtector', 'save_spam')) {
-            $dataValue = $this->getIsSpam() ? 1 : 0;
-            $record->setCastedField($this->name, $dataValue);
-        }
-    }
+	/**
+	 * Allow spam flag to be saved to the underlying data record
+	 *
+	 * @param \DataObjectInterface $record
+	 */
+	public function saveInto(\DataObjectInterface $record)
+	{
+		if (Config::inst()->get('AkismetSpamProtector', 'save_spam')) {
+			$dataValue = $this->getIsSpam() ? 1 : 0;
+			$record->setCastedField($this->name, $dataValue);
+		}
+	}
 }

code/AkismetSpamProtector.php

Indentation +104 added lines, -104 removed lines

@@ -8,122 +8,122 @@
  */
 class AkismetSpamProtector implements SpamProtector
 {
-    /**
-     * Set this to your API key
-     * 
-     * @var string
-     * @config
-     */
-    private static $api_key = null;
+	/**
+	 * Set this to your API key
+	 * 
+	 * @var string
+	 * @config
+	 */
+	private static $api_key = null;
 
-    /**
-     * Permission required to bypass check
-     *
-     * @var string
-     * @config
-     */
-    private static $bypass_permission = 'ADMIN';
+	/**
+	 * Permission required to bypass check
+	 *
+	 * @var string
+	 * @config
+	 */
+	private static $bypass_permission = 'ADMIN';
 
-    /**
-     * Set to try to bypass check for all logged in users
-     *
-     * @var boolean
-     * @config
-     */
-    private static $bypass_members = false;
+	/**
+	 * Set to try to bypass check for all logged in users
+	 *
+	 * @var boolean
+	 * @config
+	 */
+	private static $bypass_members = false;
 
-    /**
-     * IMPORTANT: If you are operating in a country (such as Germany) that has content transmission disclosure
-     * requirements, set this to true in order to require a user prompt prior to submission of user data
-     * to the Akismet servers
-     *
-     * @var boolean
-     * @config
-     */
-    private static $require_confirmation = false;
+	/**
+	 * IMPORTANT: If you are operating in a country (such as Germany) that has content transmission disclosure
+	 * requirements, set this to true in order to require a user prompt prior to submission of user data
+	 * to the Akismet servers
+	 *
+	 * @var boolean
+	 * @config
+	 */
+	private static $require_confirmation = false;
 
-    /**
-     * Set to true to disable spam errors, instead saving this field to the dataobject with the spam
-     * detection as a flag. This will disable validation errors when spam is encountered.
-     * The flag will be saved to the same field specified by the 'name' option in enableSpamProtection()
-     *
-     * @var boolean
-     * @config
-     */
-    private static $save_spam = false;
+	/**
+	 * Set to true to disable spam errors, instead saving this field to the dataobject with the spam
+	 * detection as a flag. This will disable validation errors when spam is encountered.
+	 * The flag will be saved to the same field specified by the 'name' option in enableSpamProtection()
+	 *
+	 * @var boolean
+	 * @config
+	 */
+	private static $save_spam = false;
     
-    /**
-     * @var array
-     */
-    private $fieldMapping = array();
+	/**
+	 * @var array
+	 */
+	private $fieldMapping = array();
     
-    /**
-     * Overridden API key
-     *
-     * @var string
-     */
-    protected static $_api_key = null;
+	/**
+	 * Overridden API key
+	 *
+	 * @var string
+	 */
+	protected static $_api_key = null;
     
-    /**
-     * Set the API key
-     * 
-     * @param string $key
-     */
-    public static function set_api_key($key)
-    {
-        self::$_api_key = $key;
-    }
+	/**
+	 * Set the API key
+	 * 
+	 * @param string $key
+	 */
+	public static function set_api_key($key)
+	{
+		self::$_api_key = $key;
+	}
     
-    /**
-     * Get the API key
-     * 
-     * @return string
-     */
-    protected static function get_api_key()
-    {
-        if (self::$_api_key) {
-            return self::$_api_key;
-        }
+	/**
+	 * Get the API key
+	 * 
+	 * @return string
+	 */
+	protected static function get_api_key()
+	{
+		if (self::$_api_key) {
+			return self::$_api_key;
+		}
         
-        // Check config
-        $key = Config::inst()->get('AkismetSpamProtector', 'api_key');
-        if (!empty($key)) {
-            return $key;
-        }
+		// Check config
+		$key = Config::inst()->get('AkismetSpamProtector', 'api_key');
+		if (!empty($key)) {
+			return $key;
+		}
         
-        // Check environment
-        if (defined('SS_AKISMET_API_KEY')) {
-            return SS_AKISMET_API_KEY;
-        }
-    }
+		// Check environment
+		if (defined('SS_AKISMET_API_KEY')) {
+			return SS_AKISMET_API_KEY;
+		}
+	}
     
-    /**
-     * Retrieves Akismet API object singleton, or null if not configured
-     * 
-     * @return AkismetService
-     */
-    public static function api()
-    {
-        // Get API key and URL
-        $key = self::get_api_key();
-        if (empty($key)) {
-            user_error("AkismetSpamProtector is incorrectly configured. Please specify an API key.", E_USER_WARNING);
-            return null;
-        }
-        $url = Director::protocolAndHost();
+	/**
+	 * Retrieves Akismet API object singleton, or null if not configured
+	 * 
+	 * @return AkismetService
+	 */
+	public static function api()
+	{
+		// Get API key and URL
+		$key = self::get_api_key();
+		if (empty($key)) {
+			user_error("AkismetSpamProtector is incorrectly configured. Please specify an API key.", E_USER_WARNING);
+			return null;
+		}
+		$url = Director::protocolAndHost();
         
-        // Generate API object
-        return Injector::inst()->get('AkismetService', true, array($key, $url));
-    }
+		// Generate API object
+		return Injector::inst()->get('AkismetService', true, array($key, $url));
+	}
     
-    public function getFormField($name = null, $title = null, $value = null, $form = null, $rightTitle = null)
-    {
-        return AkismetField::create($name, $title, $value, $form, $rightTitle)
-            ->setFieldMapping($this->fieldMapping);
-    }
+	public function getFormField($name = null, $title = null, $value = null, $form = null, $rightTitle = null)
+	{
+		return AkismetField::create($name, $title, $value, $form, $rightTitle)
+			->setFieldMapping($this->fieldMapping);
+	}
 
-    public function setFieldMapping($fieldMapping)
-    {
-        $this->fieldMapping = $fieldMapping;
-    }
+	public function setFieldMapping($fieldMapping)
+	{
+		$this->fieldMapping = $fieldMapping;
+	}
 }

code/config/AkismetConfig.php

Indentation +7 added lines, -7 removed lines

@@ -5,12 +5,12 @@
  */
 class AkismetConfig extends DataExtension
 {
-    private static $db = array(
-        'AkismetKey' => 'Varchar'
-    );
+	private static $db = array(
+		'AkismetKey' => 'Varchar'
+	);
 
-    public function updateCMSFields(FieldList $fields)
-    {
-        $fields->addFieldToTab('Root.Akismet', new PasswordField('AkismetKey', 'Akismet Key'));
-    }
+	public function updateCMSFields(FieldList $fields)
+	{
+		$fields->addFieldToTab('Root.Akismet', new PasswordField('AkismetKey', 'Akismet Key'));
+	}
 }

code/config/AkismetProcessor.php

Indentation +50 added lines, -50 removed lines

@@ -5,54 +5,54 @@
  */
 class AkismetProcessor implements RequestFilter
 {
-    public function postRequest(SS_HTTPRequest $request, SS_HTTPResponse $response, DataModel $model)
-    {
-    }
-
-    public function preRequest(SS_HTTPRequest $request, Session $session, DataModel $model)
-    {
-        // Skip if database isn't ready
-        if (!$this->isDBReady()) {
-            return;
-        }
-
-        // Skip if SiteConfig doesn't have this extension
-        if (!SiteConfig::has_extension('AkismetConfig')) {
-            return;
-        }
-
-        // Check if key exists
-        $akismetKey = SiteConfig::current_site_config()->AkismetKey;
-        if ($akismetKey) {
-            AkismetSpamProtector::set_api_key($akismetKey);
-        }
-    }
-
-    /**
-     * Make sure the DB is ready before accessing siteconfig db field
-     *
-     * @return bool
-     */
-    protected function isDBReady()
-    {
-        if (!DB::isActive()) {
-            return false;
-        }
-
-        // Require table
-        if (!DB::getConn()->hasTable('SiteConfig')) {
-            return false;
-        }
-
-        // Ensure siteconfig has all fields necessary
-        $dbFields = DB::fieldList('SiteConfig');
-        if (empty($dbFields)) {
-            return false;
-        }
-
-        // Ensure that SiteConfig has all fields
-        $objFields = DataObject::database_fields('SiteConfig', false);
-        $missingFields = array_diff_key($objFields, $dbFields);
-        return empty($missingFields);
-    }
+	public function postRequest(SS_HTTPRequest $request, SS_HTTPResponse $response, DataModel $model)
+	{
+	}
+
+	public function preRequest(SS_HTTPRequest $request, Session $session, DataModel $model)
+	{
+		// Skip if database isn't ready
+		if (!$this->isDBReady()) {
+			return;
+		}
+
+		// Skip if SiteConfig doesn't have this extension
+		if (!SiteConfig::has_extension('AkismetConfig')) {
+			return;
+		}
+
+		// Check if key exists
+		$akismetKey = SiteConfig::current_site_config()->AkismetKey;
+		if ($akismetKey) {
+			AkismetSpamProtector::set_api_key($akismetKey);
+		}
+	}
+
+	/**
+	 * Make sure the DB is ready before accessing siteconfig db field
+	 *
+	 * @return bool
+	 */
+	protected function isDBReady()
+	{
+		if (!DB::isActive()) {
+			return false;
+		}
+
+		// Require table
+		if (!DB::getConn()->hasTable('SiteConfig')) {
+			return false;
+		}
+
+		// Ensure siteconfig has all fields necessary
+		$dbFields = DB::fieldList('SiteConfig');
+		if (empty($dbFields)) {
+			return false;
+		}
+
+		// Ensure that SiteConfig has all fields
+		$objFields = DataObject::database_fields('SiteConfig', false);
+		$missingFields = array_diff_key($objFields, $dbFields);
+		return empty($missingFields);
+	}
 }

code/service/AkismetService.php

Indentation +31 added lines, -31 removed lines

@@ -5,35 +5,35 @@
  */
 interface AkismetService
 {
-    /**
-     * Check if the comment is spam or not
-     * This is basically the core of everything. This call takes a number of
-     * arguments and characteristics about the submitted content and then
-     * returns a thumbs up or thumbs down.
-     * Almost everything is optional, but performance can drop dramatically if
-     * you exclude certain elements.
-     * REMARK: If you are having trouble triggering you can send
-     * "viagra-test-123" as the author and it will trigger a true response,
-     * always.
-     *
-     * @param string[optional] $content   The content that was submitted.
-     * @param string[optional] $author    The name.
-     * @param string[optional] $email     The email address.
-     * @param string[optional] $url       The URL.
-     * @param string[optional] $permalink The permanent location of the entry
-     *                                    the comment was submitted to.
-     * @param string[optional] $type The type, can be blank, comment,
-     *                                    trackback, pingback, or a made up
-     *                                    value like "registration".
-     * @return bool If the comment is spam true will be
-     *                                    returned, otherwise false.
-     */
-    public function isSpam(
-        $content,
-        $author = null,
-        $email = null,
-        $url = null,
-        $permalink = null,
-        $type = null
-    );
+	/**
+	 * Check if the comment is spam or not
+	 * This is basically the core of everything. This call takes a number of
+	 * arguments and characteristics about the submitted content and then
+	 * returns a thumbs up or thumbs down.
+	 * Almost everything is optional, but performance can drop dramatically if
+	 * you exclude certain elements.
+	 * REMARK: If you are having trouble triggering you can send
+	 * "viagra-test-123" as the author and it will trigger a true response,
+	 * always.
+	 *
+	 * @param string[optional] $content   The content that was submitted.
+	 * @param string[optional] $author    The name.
+	 * @param string[optional] $email     The email address.
+	 * @param string[optional] $url       The URL.
+	 * @param string[optional] $permalink The permanent location of the entry
+	 *                                    the comment was submitted to.
+	 * @param string[optional] $type The type, can be blank, comment,
+	 *                                    trackback, pingback, or a made up
+	 *                                    value like "registration".
+	 * @return bool If the comment is spam true will be
+	 *                                    returned, otherwise false.
+	 */
+	public function isSpam(
+		$content,
+		$author = null,
+		$email = null,
+		$url = null,
+		$permalink = null,
+		$type = null
+	);
 }