Add ushahidi/kohana-validation package and use that

This replaces the dependencies on Kohana Core.

- Update Validators to refer to namespaced Valid and Validation class
- Fix DI for ValidationEngineTrait
- Set up translations
- Move error messages to laravel language files

application/classes/Ushahidi/Core.php

@@ -50,8 +50,6 @@ public static function init()
 			return Kohana::$config->load('site.intercomAppToken');
 		});
 
-		$di->set('tool.validation', $di->lazyNew('Ushahidi_ValidationEngine'));
-
 		$di->set('tool.mailer', $di->lazyNew('Ushahidi_Mailer', [
 			'siteConfig' => $di->lazyGet('site.config'),
 			'clientUrl' => $di->lazyGet('clienturl')

composer.json

@@ -8,6 +8,10 @@
         {
             "type": "vcs",
             "url": "https://github.com/ushahidi/ohanzee-db"
+        },
+        {
+            "type": "vcs",
+            "url": "https://github.com/ushahidi/kohana-validation"
         }
     ],
     "require": {
@@ -48,7 +52,8 @@
         "ramsey/uuid": "^3.4.1",
         "sentry/sentry": "~1.5",
         "dusterio/lumen-passport": "^0.1.9",
-        "barryvdh/laravel-cors": "^0.9.2"
+        "barryvdh/laravel-cors": "^0.9.2",
+        "ushahidi/kohana-validation": "dev-master"
     },
     "require-dev": {
         "fzaninotto/faker": "~1.4",

application/messages/config.php → resources/lang/en/config.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
     'providerNotAvailable' => 'One or more of the enabled providers is not available :param1',

application/messages/csv.php → resources/lang/en/csv.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
     'range' => 'The file size should be less than :param3 KB',

application/messages/form.php → resources/lang/en/form.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
     'invalidFormStageId' => 'form_stage_id :value does not exist',

application/messages/form_attribute.php → resources/lang/en/form_attribute.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
     'not_empty' => ':field must not be empty',

application/messages/form_role.php → resources/lang/en/form_role.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
 	'roles' => [

application/messages/layers.php → resources/lang/en/layers.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return array(
 	'dataUrlOrMediaRequired' => 'One of data_url or media_id is required',

application/messages/media.php → resources/lang/en/media.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
     'size_error' => 'The file size should be less than :param1 MB',

application/messages/message.php → resources/lang/en/message.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
 	'contact' => [

application/messages/notifications.php → resources/lang/en/notifications.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
 	'email' => [

application/messages/post.php → resources/lang/en/post.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return [
   'publishedPostsLimitReached' => 'limit::posts',

application/messages/tag.php → resources/lang/en/tag.php

@@ -1,8 +1,7 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return array(
 	'isSlugAvailable' => ':field :value is already in use',
   'description.regex' => 'The description must contain only letters, numbers, spaces and punctuation',
   'tag.regex' => 'The category name must contain only letters, numbers, spaces and punctuation',
 );
-

application/messages/user.php → resources/lang/en/user.php

@@ -1,4 +1,4 @@
-<?php defined('SYSPATH') OR die('No direct script access.');
+<?php
 
 return array(
 	'isUniqueEmail'    => ':field is already in use',

resources/lang/en/validation.php

@@ -0,0 +1,29 @@
+<?php defined('SYSPATH') or die('No direct script access.');
+
+return array(
+
+	'alpha'         => ':field must contain only letters',
+	'alpha_dash'    => ':field must contain only numbers, letters and dashes',
+	'alpha_numeric' => ':field must contain only letters and numbers',
+	'color'         => ':field must be a color',
+	'credit_card'   => ':field must be a credit card number',
+	'date'          => ':field must be a date',
+	'decimal'       => ':field must be a decimal with :param2 places',
+	'digit'         => ':field must be a digit',
+	'email'         => ':field must be an email address',
+	'email_domain'  => ':field must contain a valid email domain',
+	'equals'        => ':field must equal :param2',
+	'exact_length'  => ':field must be exactly :param2 characters long',
+	'in_array'      => ':field must be one of the available options',
+	'ip'            => ':field must be an ip address',
+	'matches'       => ':field must be the same as :param3',
+	'min_length'    => ':field must be at least :param2 characters long',
+	'max_length'    => ':field must not exceed :param2 characters long',
+	'not_empty'     => ':field must not be empty',
+	'numeric'       => ':field must be numeric',
+	'phone'         => ':field must be a phone number',
+	'range'         => ':field must be within the range of :param2 to :param3',
+	'regex'         => ':field does not match the required format',
+	'url'           => ':field must be a url',
+
+);

src/App/Init.php

@@ -51,6 +51,14 @@
 	})
 ];
 
+// ValidationEngine
+$di->set('tool.validation', $di->lazyNew(Ushahidi\App\Validator\KohanaValidationEngine::class, [
+	// Inject laravel translator
+	'translator' => $di->lazy(function () {
+		return app('translator');
+	})
+]));
+
 // Defined memcached
 $di->set('memcached', $di->lazy(function () use ($di) {
 	$config = $di->get('ratelimiter.config');
@@ -205,10 +213,6 @@
 	'update' => $di->lazyNew(Ushahidi\App\Validator\Permission\Update::class),
 ];
 
-// Validation Trait
-$di->setter['Ushahidi\Core\Tool\ValidationEngineTrait']['setValidation'] = $di->newFactory('Ushahidi_ValidationEngine');
-$di->params['Ushahidi_ValidationEngine']['array'] = [];
-
 // Formatter mapping
 $di->params['Ushahidi\Factory\FormatterFactory']['map'] = [
 	'config'               => $di->lazyNew(Ushahidi\App\Formatter\Config::class),

src/App/Validator/Contact/Receive.php

@@ -20,7 +20,7 @@ public function validContact($contact, $data, $validation)
 		// Valid Email?
 		if (isset($data['type']) and
 			$data['type'] == Contact::EMAIL and
-			 ! \Valid::email($contact) ) {
+			 ! \Kohana\Validation\Valid::email($contact) ) {
 			return $validation->error('contact', 'invalid_email', [$contact]);
 		} elseif (isset($data['type']) and
 			$data['type'] == Contact::PHONE ) {

src/App/Validator/Contact/Update.php

@@ -63,7 +63,7 @@ public function validContact($contact, $data, $validation)
 		// Valid Email?
 		if (isset($data['type']) and
 			$data['type'] == Contact::EMAIL and
-			 ! \Valid::email($contact) ) {
+			 ! \Kohana\Validation\Valid::email($contact) ) {
 			return $validation->error('contact', 'invalid_email', [$contact]);
 		} // Valid Phone?
 		// @todo Look at using libphonenumber to validate international numbers

src/App/Validator/Form/Update.php

@@ -52,7 +52,7 @@ protected function getRules()
 		];
 	}
 
-    public function checkPostTypeLimit(\Validation $validation)
+    public function checkPostTypeLimit(\Kohana\Validation\Validation $validation)
     {
 		if ($this->limits['forms'] !== true) {
 			$total_forms = $this->repo->getTotalCount();

src/App/Validator/KohanaValidationEngine.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Ushahidi\App\Validator;
+
+/**
+ * Ushahidi Core Validation Tool
+ *
+ * @author     Ushahidi Team <team@ushahidi.com>
+ * @package    Ushahidi\Core
+ * @copyright  2014 Ushahidi
+ * @license    https://www.gnu.org/licenses/agpl-3.0.html
+ *             GNU Affero General Public License Version 3 (AGPL3)
+ */
+
+use Kohana\Validation\Validation as KohanaValidation;
+use Ushahidi\Core\Tool\ValidationEngine;
+use Illuminate\Contracts\Translation\Translator;
+
+class KohanaValidationEngine extends KohanaValidation implements ValidationEngine
+{
+    /**
+     * @var TranslatorContract
+     */
+    private $translator;
+
+    public function __construct(Translator $translator)
+    {
+        $this->translator = $translator;
+
+        parent::__construct([], $this->getTranslationCallback());
+    }
+
+    public function getTranslationCallback()
+    {
+        return function ($file, $field, $error = null) {
+            if ($error) {
+                return $this->translator->has("$file.$field.$error") ?
+                    $this->translator->trans("$file.$field.$error") : false;
+            } else {
+                return $this->translator->has("$file.$field") ?
+                    $this->translator->trans("$file.$field") : false;
+            }
+        };
+    }
+
+    public function setData(array $data)
+    {
+        $this->_data = $data;
+    }
+
+    public function getData($key = null)
+    {
+        if ($key === null) {
+            return $this->_data;
+        }
+
+        if (array_key_exists($key, $this->_data)) {
+            return $this->_data[$key];
+        }
+
+        return null;
+    }
+
+    public function setFullData(array $fullData)
+    {
+        $this->bind(':fulldata', $fullData);
+    }
+
+    public function getFullData($key = null)
+    {
+        if ($key === null) {
+            return $this->_bound[':fulldata'];
+        }
+
+        if (array_key_exists($key, $this->_bound[':fulldata'])) {
+            return $this->_bound[':fulldata'][$key];
+        }
+
+        return null;
+    }
+}