silverstripe / silverstripe-spellcheck

code/data/SpellProvider.php

Indentation +16 added lines, -16 removed lines

@@ -2,21 +2,21 @@
 
 interface SpellProvider
 {
-    /**
-     * Spellchecks an array of words.
-     *
-     * @param string $locale Locale code to check
-     * @param array $words List of words to spellcheck.
-     * @return array List of misspelled words.
-     */
-    public function checkWords($locale, $words);
+	/**
+	 * Spellchecks an array of words.
+	 *
+	 * @param string $locale Locale code to check
+	 * @param array $words List of words to spellcheck.
+	 * @return array List of misspelled words.
+	 */
+	public function checkWords($locale, $words);
 
-    /**
-     * Returns suggestions of for a specific word.
-     *
-     * @param string $locale Locale code to check
-     * @param string $word Specific word to get suggestions for.
-     * @return array List of suggestions for the specified word.
-     */
-    public function getSuggestions($locale, $word);
+	/**
+	 * Returns suggestions of for a specific word.
+	 *
+	 * @param string $locale Locale code to check
+	 * @param string $word Specific word to get suggestions for.
+	 * @return array List of suggestions for the specified word.
+	 */
+	public function getSuggestions($locale, $word);
 }

code/handling/SpellController.php

Indentation +223 added lines, -223 removed lines

@@ -5,227 +5,227 @@
  */
 class SpellController extends Controller
 {
-    /**
-     * Locales to spellcheck
-     *
-     * @var array
-     * @config
-     */
-    private static $locales = array();
-
-    /**
-     * Necessary permission required to spellcheck. Set to empty or null to disable restrictions.
-     *
-     * @var string
-     * @config
-     */
-    private static $required_permission = 'CMS_ACCESS_CMSMain';
-
-    /**
-     * Enable security token for spellchecking
-     *
-     * @var bool
-     * @config
-     */
-    private static $enable_security_token = true;
-
-    /**
-     * Dependencies required by this controller
-     *
-     * @var array
-     * @config
-     */
-    private static $dependencies = array(
-        'Provider' => '%$SpellProvider'
-    );
-
-    /**
-     * Spellcheck provider
-     *
-     * @var SpellProvider
-     */
-    protected $provider = null;
-
-    /**
-     * Parsed request data
-     *
-     * @var array|null Null if not set or an array if parsed
-     */
-    protected $data = null;
-
-    /**
-     * Get the current provider
-     *
-     * @return SpellProvider
-     */
-    public function getProvider()
-    {
-        return $this->provider;
-    }
-
-    /**
-     * Gets locales to spellcheck for
-     *
-     * @return array
-     */
-    public static function get_locales()
-    {
-        // Default to current locale if none configured
-        return self::config()->locales ?: array(i18n::get_locale());
-    }
-
-    /**
-     * Set the provider to use
-     *
-     * @param SpellProvider $provider
-     * @return $this
-     */
-    public function setProvider(SpellProvider $provider)
-    {
-        $this->provider = $provider;
-        return $this;
-    }
-
-    /**
-     * Parse the output response
-     *
-     * @param string $id Request ID
-     * @param array|null $result Result data
-     * @param array|null $error Error data
-     * @param int $code HTTP Response code
-     */
-    protected function result($id, $result, $error = null, $code = 200)
-    {
-        $this->response->setStatusCode($code);
-        $this->response->setBody(json_encode(array(
-            'id' => $id ? preg_replace('/\W/', '', $id) : null, // Cleanup id
-            'result' => $result,
-            'error' => $error
-        )));
-        return $this->response;
-    }
-
-    protected function success($result)
-    {
-        $data = $this->getRequestData();
-        return $this->result($data['id'], $result);
-    }
-
-    /**
-     * Set the error
-     *
-     * @param string $message
-     * @param int $code HTTP error code
-     */
-    protected function error($message, $code)
-    {
-        $error = array(
-            'errstr' => $message,
-            'errfile' => '',
-            'errline' => null,
-            'errcontext' => '',
-            'level' => 'FATAL'
-        );
-        return $this->result(null, null, $error, $code);
-    }
-
-    public function index()
-    {
-        $this->setHeaders();
-
-        // Check security token
-        if (self::config()->enable_security_token && !SecurityToken::inst()->checkRequest($this->request)) {
-            return $this->error(
-                _t(
-                    'SpellController.SecurityMissing',
-                    'Your session has expired. Please refresh your browser to continue.'
-                ),
-                400
-            );
-        }
-
-        // Check permission
-        $permission = self::config()->required_permission;
-        if ($permission && !Permission::check($permission)) {
-            return $this->error(_t('SpellController.SecurityDenied', 'Permission Denied'), 403);
-        }
-
-        // Check data
-        $data = $this->getRequestData();
-        if (empty($data)) {
-            return $this->error(_t('SpellController.MissingData', "Could not get raw post data"), 400);
-        }
-
-        // Check params and request type
-        if (!Director::is_ajax() || empty($data['method']) || empty($data['params']) || count($data['params']) < 2) {
-            return $this->error(_t('SpellController.InvalidRequest', 'Invalid request'), 400);
-        }
-
-        // Check locale
-        $params = $data['params'];
-        $locale = $params[0];
-        if (!in_array($locale, self::get_locales())) {
-            return $this->error(_t('SpellController.InvalidLocale', 'Not supported locale'), 400);
-        }
-
-        // Check provider
-        $provider = $this->getProvider();
-        if (empty($provider)) {
-            return $this->error(_t('SpellController.MissingProviders', "No spellcheck module installed"), 500);
-        }
-
-        // Perform action
-        try {
-            $method = $data['method'];
-            $words = $params[1];
-            switch ($method) {
-                case 'checkWords':
-                    return $this->success($provider->checkWords($locale, $words));
-                case 'getSuggestions':
-                    return $this->success($provider->getSuggestions($locale, $words));
-                default:
-                    return $this->error(
-                        _t(
-                            'SpellController.UnsupportedMethod',
-                            "Unsupported method '{method}'",
-                            array('method' => $method)
-                        ),
-                        400
-                    );
-            }
-        } catch (SpellException $ex) {
-            return $this->error($ex->getMessage(), $ex->getCode());
-        }
-    }
-
-    /**
-     * Ensures the response has the correct headers
-     */
-    protected function setHeaders()
-    {
-        // Set headers
-        HTTP::set_cache_age(0);
-        HTTP::add_cache_headers($this->response);
-        $this->response
-            ->addHeader('Content-Type', 'application/json')
-            ->addHeader('Content-Encoding', 'UTF-8')
-            ->addHeader('X-Content-Type-Options', 'nosniff');
-    }
-
-    /**
-     * Get request data
-     *
-     * @return array Parsed data with an id, method, and params key
-     */
-    protected function getRequestData()
-    {
-        // Check if data needs to be parsed
-        if ($this->data === null) {
-            // Parse data from input
-            $result = $this->request->requestVar('json_data')
-                ?: file_get_contents("php://input");
-            $this->data = $result ? json_decode($result, true) : array();
-        }
-        return $this->data;
-    }
+	/**
+	 * Locales to spellcheck
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $locales = array();
+
+	/**
+	 * Necessary permission required to spellcheck. Set to empty or null to disable restrictions.
+	 *
+	 * @var string
+	 * @config
+	 */
+	private static $required_permission = 'CMS_ACCESS_CMSMain';
+
+	/**
+	 * Enable security token for spellchecking
+	 *
+	 * @var bool
+	 * @config
+	 */
+	private static $enable_security_token = true;
+
+	/**
+	 * Dependencies required by this controller
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $dependencies = array(
+		'Provider' => '%$SpellProvider'
+	);
+
+	/**
+	 * Spellcheck provider
+	 *
+	 * @var SpellProvider
+	 */
+	protected $provider = null;
+
+	/**
+	 * Parsed request data
+	 *
+	 * @var array|null Null if not set or an array if parsed
+	 */
+	protected $data = null;
+
+	/**
+	 * Get the current provider
+	 *
+	 * @return SpellProvider
+	 */
+	public function getProvider()
+	{
+		return $this->provider;
+	}
+
+	/**
+	 * Gets locales to spellcheck for
+	 *
+	 * @return array
+	 */
+	public static function get_locales()
+	{
+		// Default to current locale if none configured
+		return self::config()->locales ?: array(i18n::get_locale());
+	}
+
+	/**
+	 * Set the provider to use
+	 *
+	 * @param SpellProvider $provider
+	 * @return $this
+	 */
+	public function setProvider(SpellProvider $provider)
+	{
+		$this->provider = $provider;
+		return $this;
+	}
+
+	/**
+	 * Parse the output response
+	 *
+	 * @param string $id Request ID
+	 * @param array|null $result Result data
+	 * @param array|null $error Error data
+	 * @param int $code HTTP Response code
+	 */
+	protected function result($id, $result, $error = null, $code = 200)
+	{
+		$this->response->setStatusCode($code);
+		$this->response->setBody(json_encode(array(
+			'id' => $id ? preg_replace('/\W/', '', $id) : null, // Cleanup id
+			'result' => $result,
+			'error' => $error
+		)));
+		return $this->response;
+	}
+
+	protected function success($result)
+	{
+		$data = $this->getRequestData();
+		return $this->result($data['id'], $result);
+	}
+
+	/**
+	 * Set the error
+	 *
+	 * @param string $message
+	 * @param int $code HTTP error code
+	 */
+	protected function error($message, $code)
+	{
+		$error = array(
+			'errstr' => $message,
+			'errfile' => '',
+			'errline' => null,
+			'errcontext' => '',
+			'level' => 'FATAL'
+		);
+		return $this->result(null, null, $error, $code);
+	}
+
+	public function index()
+	{
+		$this->setHeaders();
+
+		// Check security token
+		if (self::config()->enable_security_token && !SecurityToken::inst()->checkRequest($this->request)) {
+			return $this->error(
+				_t(
+					'SpellController.SecurityMissing',
+					'Your session has expired. Please refresh your browser to continue.'
+				),
+				400
+			);
+		}
+
+		// Check permission
+		$permission = self::config()->required_permission;
+		if ($permission && !Permission::check($permission)) {
+			return $this->error(_t('SpellController.SecurityDenied', 'Permission Denied'), 403);
+		}
+
+		// Check data
+		$data = $this->getRequestData();
+		if (empty($data)) {
+			return $this->error(_t('SpellController.MissingData', "Could not get raw post data"), 400);
+		}
+
+		// Check params and request type
+		if (!Director::is_ajax() || empty($data['method']) || empty($data['params']) || count($data['params']) < 2) {
+			return $this->error(_t('SpellController.InvalidRequest', 'Invalid request'), 400);
+		}
+
+		// Check locale
+		$params = $data['params'];
+		$locale = $params[0];
+		if (!in_array($locale, self::get_locales())) {
+			return $this->error(_t('SpellController.InvalidLocale', 'Not supported locale'), 400);
+		}
+
+		// Check provider
+		$provider = $this->getProvider();
+		if (empty($provider)) {
+			return $this->error(_t('SpellController.MissingProviders', "No spellcheck module installed"), 500);
+		}
+
+		// Perform action
+		try {
+			$method = $data['method'];
+			$words = $params[1];
+			switch ($method) {
+				case 'checkWords':
+					return $this->success($provider->checkWords($locale, $words));
+				case 'getSuggestions':
+					return $this->success($provider->getSuggestions($locale, $words));
+				default:
+					return $this->error(
+						_t(
+							'SpellController.UnsupportedMethod',
+							"Unsupported method '{method}'",
+							array('method' => $method)
+						),
+						400
+					);
+			}
+		} catch (SpellException $ex) {
+			return $this->error($ex->getMessage(), $ex->getCode());
+		}
+	}
+
+	/**
+	 * Ensures the response has the correct headers
+	 */
+	protected function setHeaders()
+	{
+		// Set headers
+		HTTP::set_cache_age(0);
+		HTTP::add_cache_headers($this->response);
+		$this->response
+			->addHeader('Content-Type', 'application/json')
+			->addHeader('Content-Encoding', 'UTF-8')
+			->addHeader('X-Content-Type-Options', 'nosniff');
+	}
+
+	/**
+	 * Get request data
+	 *
+	 * @return array Parsed data with an id, method, and params key
+	 */
+	protected function getRequestData()
+	{
+		// Check if data needs to be parsed
+		if ($this->data === null) {
+			// Parse data from input
+			$result = $this->request->requestVar('json_data')
+				?: file_get_contents("php://input");
+			$this->data = $result ? json_decode($result, true) : array();
+		}
+		return $this->data;
+	}
 }

code/handling/SpellException.php

Indentation +9 added lines, -9 removed lines

@@ -5,13 +5,13 @@
  */
 class SpellException extends Exception
 {
-    /**
-     * @param string $message
-     * @param int $code HTTP error code
-     * @param Exception $previous
-     */
-    public function __construct($message, $code, $previous = null)
-    {
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * @param string $message
+	 * @param int $code HTTP error code
+	 * @param Exception $previous
+	 */
+	public function __construct($message, $code, $previous = null)
+	{
+		parent::__construct($message, $code, $previous);
+	}
 }

code/handling/SpellRequestFilter.php

Indentation +28 added lines, -28 removed lines

@@ -2,36 +2,36 @@
 
 class SpellRequestFilter implements RequestFilter
 {
-    /**
-     * HtmlEditorConfig name to use
-     *
-     * @var string
-     * @config
-     */
-    private static $editor = 'cms';
+	/**
+	 * HtmlEditorConfig name to use
+	 *
+	 * @var string
+	 * @config
+	 */
+	private static $editor = 'cms';
 
-    public function preRequest(\SS_HTTPRequest $request, \Session $session, \DataModel $model)
-    {
-        // Check languages to set
-        $languages = array();
-        foreach (SpellController::get_locales() as $locale) {
-            $languages[] = i18n::get_locale_name($locale).'='.$locale;
-        }
+	public function preRequest(\SS_HTTPRequest $request, \Session $session, \DataModel $model)
+	{
+		// Check languages to set
+		$languages = array();
+		foreach (SpellController::get_locales() as $locale) {
+			$languages[] = i18n::get_locale_name($locale).'='.$locale;
+		}
 
 
-        // Set settings
-        $editor = Config::inst()->get(__CLASS__, 'editor');
-        HtmlEditorConfig::get($editor)->enablePlugins('spellchecker');
-        HtmlEditorConfig::get($editor)->addButtonsToLine(2, 'spellchecker');
-        $token = SecurityToken::inst();
-        HtmlEditorConfig::get($editor)->setOption('spellchecker_rpc_url', $token->addToUrl('spellcheck/'));
-        HtmlEditorConfig::get($editor)->setOption('browser_spellcheck', false);
-        HtmlEditorConfig::get($editor)->setOption('spellchecker_languages', '+'.implode(', ', $languages));
-        return true;
-    }
+		// Set settings
+		$editor = Config::inst()->get(__CLASS__, 'editor');
+		HtmlEditorConfig::get($editor)->enablePlugins('spellchecker');
+		HtmlEditorConfig::get($editor)->addButtonsToLine(2, 'spellchecker');
+		$token = SecurityToken::inst();
+		HtmlEditorConfig::get($editor)->setOption('spellchecker_rpc_url', $token->addToUrl('spellcheck/'));
+		HtmlEditorConfig::get($editor)->setOption('browser_spellcheck', false);
+		HtmlEditorConfig::get($editor)->setOption('spellchecker_languages', '+'.implode(', ', $languages));
+		return true;
+	}
 
-    public function postRequest(\SS_HTTPRequest $request, \SS_HTTPResponse $response, \DataModel $model)
-    {
-        return true;
-    }
+	public function postRequest(\SS_HTTPRequest $request, \SS_HTTPResponse $response, \DataModel $model)
+	{
+		return true;
+	}
 }

code/providers/HunSpellProvider.php

Indentation +84 added lines, -84 removed lines

@@ -5,97 +5,97 @@
  */
 class HunSpellProvider implements SpellProvider
 {
-    /**
-     * See https://gist.github.com/sebskuse/1244667
-     *
-     * @var string
-     * @config
-     */
-    private static $pattern = "/^(?P<type>&)\s(?P<original>\w+)\s(?P<count>\d+)\s(?P<offset>\d+):\s(?P<misses>.*+)$/u";
+	/**
+	 * See https://gist.github.com/sebskuse/1244667
+	 *
+	 * @var string
+	 * @config
+	 */
+	private static $pattern = "/^(?P<type>&)\s(?P<original>\w+)\s(?P<count>\d+)\s(?P<offset>\d+):\s(?P<misses>.*+)$/u";
 
 
-    /**
-     * Invoke hunspell library
-     *
-     * @param string $locale
-     * @param string $input Input text
-     * @param string $stdout output
-     * @param string $stderr error
-     * @return int Exit code
-     */
-    protected function invoke($locale, $input, &$stdout, &$stderr)
-    {
-        // Prepare arguments
-        $command = 'hunspell -d ' . escapeshellarg($locale);
-        $descriptorSpecs = array(
-            0 => array("pipe", "r"),
-            1 => array("pipe", "w"),
-            2 => array("pipe", "w")
-        );
-        $env = array(
-            'LANG' => $locale . '.utf-8'
-        );
-        // Invoke command
-        $proc = proc_open($command, $descriptorSpecs, $pipes, null, $env);
-        if (!is_resource($proc)) {
-            return 255;
-        }
+	/**
+	 * Invoke hunspell library
+	 *
+	 * @param string $locale
+	 * @param string $input Input text
+	 * @param string $stdout output
+	 * @param string $stderr error
+	 * @return int Exit code
+	 */
+	protected function invoke($locale, $input, &$stdout, &$stderr)
+	{
+		// Prepare arguments
+		$command = 'hunspell -d ' . escapeshellarg($locale);
+		$descriptorSpecs = array(
+			0 => array("pipe", "r"),
+			1 => array("pipe", "w"),
+			2 => array("pipe", "w")
+		);
+		$env = array(
+			'LANG' => $locale . '.utf-8'
+		);
+		// Invoke command
+		$proc = proc_open($command, $descriptorSpecs, $pipes, null, $env);
+		if (!is_resource($proc)) {
+			return 255;
+		}
 
-        // Send content as input
-        fwrite($pipes[0], $input);
-        fclose($pipes[0]);
+		// Send content as input
+		fwrite($pipes[0], $input);
+		fclose($pipes[0]);
 
-        // Get output
-        $stdout = stream_get_contents($pipes[1]);
-        fclose($pipes[1]);
-        $stderr = stream_get_contents($pipes[2]);
-        fclose($pipes[2]);
+		// Get output
+		$stdout = stream_get_contents($pipes[1]);
+		fclose($pipes[1]);
+		$stderr = stream_get_contents($pipes[2]);
+		fclose($pipes[2]);
 
-        // Get result
-        return proc_close($proc);
-    }
+		// Get result
+		return proc_close($proc);
+	}
 
-    /**
-     * Get results from hunspell
-     *
-     * @param string $locale
-     * @param array $words
-     * @return array List of incorrect words, each with their list of suggestions
-     * @throws SpellException
-     */
-    protected function getResults($locale, $words)
-    {
-        // Invoke HunSpell
-        $input = implode(' ', $words);
-        $return = $this->invoke($locale, $input, $stdout, $stderr);
-        if ($stderr) {
-            throw new SpellException($stderr, 500);
-        } elseif ($return) {
-            throw new SpellException("An unidentified error has occurred", 500);
-        }
+	/**
+	 * Get results from hunspell
+	 *
+	 * @param string $locale
+	 * @param array $words
+	 * @return array List of incorrect words, each with their list of suggestions
+	 * @throws SpellException
+	 */
+	protected function getResults($locale, $words)
+	{
+		// Invoke HunSpell
+		$input = implode(' ', $words);
+		$return = $this->invoke($locale, $input, $stdout, $stderr);
+		if ($stderr) {
+			throw new SpellException($stderr, 500);
+		} elseif ($return) {
+			throw new SpellException("An unidentified error has occurred", 500);
+		}
 
-        // Parse results
-        $pattern = Config::inst()->get(__CLASS__, 'pattern');
-        $results = array();
-        foreach (preg_split('/$\R?^/m', $stdout) as $line) {
-            if (preg_match($pattern, $line, $matches)) {
-                $results[$matches['original']] = explode(', ', $matches['misses']);
-            }
-        }
-        return $results;
-    }
+		// Parse results
+		$pattern = Config::inst()->get(__CLASS__, 'pattern');
+		$results = array();
+		foreach (preg_split('/$\R?^/m', $stdout) as $line) {
+			if (preg_match($pattern, $line, $matches)) {
+				$results[$matches['original']] = explode(', ', $matches['misses']);
+			}
+		}
+		return $results;
+	}
 
-    public function checkWords($locale, $words)
-    {
-        $results = $this->getResults($locale, $words);
-        return array_keys($results);
-    }
+	public function checkWords($locale, $words)
+	{
+		$results = $this->getResults($locale, $words);
+		return array_keys($results);
+	}
 
-    public function getSuggestions($locale, $word)
-    {
-        $results = $this->getResults($locale, array($word));
-        if (isset($results[$word])) {
-            return $results[$word];
-        }
-    }
+	public function getSuggestions($locale, $word)
+	{
+		$results = $this->getResults($locale, array($word));
+		if (isset($results[$word])) {
+			return $results[$word];
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -26,14 +26,14 @@
     protected function invoke($locale, $input, &$stdout, &$stderr)
     {
         // Prepare arguments
-        $command = 'hunspell -d ' . escapeshellarg($locale);
+        $command = 'hunspell -d '.escapeshellarg($locale);
         $descriptorSpecs = array(
             0 => array("pipe", "r"),
             1 => array("pipe", "w"),
             2 => array("pipe", "w")
         );
         $env = array(
-            'LANG' => $locale . '.utf-8'
+            'LANG' => $locale.'.utf-8'
         );
         // Invoke command
         $proc = proc_open($command, $descriptorSpecs, $pipes, null, $env);