VisualCaptchaをNetCommonsプラグインに組み込みました

Controller/Component/NetCommonsVisualCaptchaComponent.php

@@ -0,0 +1,164 @@
+<?php
+/**
+ * NetCommonsBlock Component
+ *
+ * @author Noriko Arai <arai@nii.ac.jp>
+ * @author Shohei Nakajima <nakajimashouhei@gmail.com>
+ * @link http://www.netcommons.org NetCommons Project
+ * @license http://www.netcommons.org/license.txt NetCommons License
+ * @copyright Copyright 2014, NetCommons Project
+ */
+
+use visualCaptcha\Captcha;
+use visualCaptcha\Session;
+
+App::uses('Component', 'Controller');
+
+App::import('Vendor', 'Captcha', array(
+	'file' => 'visualcaptcha' . DS . 'src' . DS . 'visualCaptcha' . DS . 'Captcha.php'
+));
+App::import('Vendor', 'Session', array(
+	'file' => 'visualcaptcha' . DS . 'src' . DS . 'visualCaptcha' . DS . 'Session.php'
+));
+
+/**
+ * NetCommonsVisualCaptcha Component
+ *
+ * @author Shohei Nakajima <nakajimashouhei@gmail.com>
+ * @package NetCommons\NetCommons\Controller\Component
+ */
+class NetCommonsVisualCaptchaComponent extends Component {
+
+/**
+ * call controller w/ associations
+ *
+ * @var object
+ */
+	public $controller = null;
+
+/**
+ * assetPath /r associations
+ *
+ * @var string
+ */
+	public $assetPath = null;
+
+/**
+ * imageField Answer /r associations
+ *
+ * @var string
+ */
+	public $imageField = null;
+
+/**
+ * audioField Answer /r associations
+ *
+ * @var string
+ */
+	public $audioField = null;
+
+/**
+ * Called before the Controller::beforeFilter().
+ *
+ * @param Controller $controller Instantiating controller
+ * @return void
+ */
+	public function initialize(Controller $controller) {
+		$this->controller = $controller;
+		// if Security component is used
+		if (array_key_exists('Security', $this->controller->components)) {
+			$this->imageField = $this->controller->Session->read('visualcaptcha.frontendData.imageFieldName');
+			$this->audioField = $this->controller->Session->read('visualcaptcha.frontendData.audioFieldName');
+
+			if ($this->imageField && $this->audioField) {
+				$this->controller->Security->unlockedFields = array(
+					$this->imageField,
+					$this->audioField
+				);
+			}
+		}
+	}
+
+/**
+ * Called after the Controller::beforeFilter() and before the controller action
+ *
+ * @param Controller $controller Controller with components to startup
+ * @return void
+ * @throws ForbiddenException
+ */
+	public function startup(Controller $controller) {
+		//$assetsPath = VENDORS . 'emotionloop' . DS . 'visualcaptcha' . DS . 'src' . DS . 'visualCaptcha' . DS . 'assets';
+		$this->assetPath = App::pluginPath('NetCommons') . 'Vendor' . DS . 'visual_captcha';
+	}
+
+/**
+ * generate visual captcha data and return it
+ *
+ * @param int $count display image count
+ * @return string
+ */
+	public function generate($count = 5) {
+		$session = new Session();
+		$lang = Configure::read('Config.language');
+		$imageJsonPath = $this->assetPath . DS . $lang . DS . 'images.json';
+		$audioJsonPath = $this->assetPath . DS . $lang . DS . 'audios.json';
+		$captcha = new Captcha($session, $this->assetPath, $this->__utilReadJSON($imageJsonPath), $this->__utilReadJSON($audioJsonPath));
+		$captcha->generate($count);
+		return json_encode($captcha->getFrontEndData());
+	}
+
+/**
+ * generate visual captcha image data and return it
+ *
+ * @param int $index display image index
+ * @return string
+ */
+	public function image($index) {
+		$session = new Session();
+		$captcha = new Captcha($session, $this->assetPath);
+		return $captcha->streamImage(array(), $index, 0);
+	}
+
+/**
+ * generate audio captcha data and return it
+ *
+ * @return streaming data
+ */
+	public function audio() {
+		$session = new Session();
+		$captcha = new Captcha($session, $this->assetPath);
+		return $captcha->streamAudio(array(), 'mp3');
+	}
+
+/**
+ * check input response
+ *
+ * @return bool
+ */
+	public function check() {
+		$reqData = $this->controller->request->data;
+		$session = new Session();
+		$captcha = new Captcha($session, $this->assetPath);
+
+		if (isset($reqData[$this->imageField])) {
+			return $captcha->validateImage($reqData[$this->imageField]);
+		} elseif (isset($reqData[$this->audioField])) {
+			return $captcha->validateAudio($reqData[$this->audioField]);
+		}
+
+		return false;
+	}
+
+/**
+ * Read input file as JSON
+ *
+ * @param string $filePath json file path
+ * @return object
+ */
+	private function __utilReadJSON($filePath) {
+		if (!file_exists($filePath)) {
+			return null;
+		}
+		return json_decode(file_get_contents($filePath), true);
+	}
+}

Locale/jpn/LC_MESSAGES/net_commons.po

@@ -335,3 +335,31 @@ msgstr "閉じる"
 #: Videos/View/VideoBlockSettings/index.ctp:43 Videos/View/Videos/index.ctp:55
 msgid "Add"
 msgstr "追加"
+
+#: View/Elements/visual_captcha.ctp:34
+msgid "Sound icon"
+msgstr "音声"
+
+#: View/Elements/visual_captcha.ctp:35
+msgid "Accessibility option: listen to a question and answer it!"
+msgstr "アクセシビリティ対応：音声を聞いて答える"
+
+#: View/Elements/visual_captcha.ctp:36
+msgid ""
+"Type below the <strong>answer</strong> to what you hear. Numbers or words:"
+msgstr ""
+"質問の音声を聞いて、下の回答欄に<strong>答え</strong>の数字・または言葉を入力"
+"してください。"
+
+#: View/Elements/visual_captcha.ctp:37
+msgid "Click or touch the <strong>ANSWER</strong>"
+msgstr ""
+"<strong>ANSWER</strong>のアイコンをクリックまたはタッチして、決定してください"
+
+#: View/Elements/visual_captcha.ctp:38
+msgid "Refresh/reload icon"
+msgstr "再読み込み"
+
+#: View/Elements/visual_captcha.ctp:39
+msgid "Refresh/reload: get new images and accessibility option!"
+msgstr "再読み込み：新しい絵や音声に変えます"

Locale/net_commons.pot

@@ -365,3 +365,26 @@ msgstr ""
 msgid "Add"
 msgstr ""
 
+#: View/Elements/visual_captcha.ctp:34
+msgid "Sound icon"
+msgstr ""
+
+#: View/Elements/visual_captcha.ctp:35
+msgid "Accessibility option: listen to a question and answer it!"
+msgstr ""
+
+#: View/Elements/visual_captcha.ctp:36
+msgid "Type below the <strong>answer</strong> to what you hear. Numbers or words:"
+msgstr ""
+
+#: View/Elements/visual_captcha.ctp:37
+msgid "Click or touch the <strong>ANSWER</strong>"
+msgstr ""
+
+#: View/Elements/visual_captcha.ctp:38
+msgid "Refresh/reload icon"
+msgstr ""
+
+#: View/Elements/visual_captcha.ctp:39
+msgid "Refresh/reload: get new images and accessibility option!"
+msgstr ""

Vendor/visual_captcha/eng/audios.json

@@ -0,0 +1,82 @@
+[
+    {
+        "path": "5times2.mp3",
+        "value": "10"
+    },
+    {
+        "path": "2times10.mp3",
+        "value": "20"
+    },
+    {
+        "path": "5plus1.mp3",
+        "value": "6"
+    },
+    {
+        "path": "4plus1.mp3",
+        "value": "5"
+    },
+    {
+        "path": "4plus3.mp3",
+        "value": "7"
+    },
+    {
+        "path": "6plus6.mp3",
+        "value": "12"
+    },
+    {
+        "path": "12times2.mp3",
+        "value": "24"
+    },
+    {
+        "path": "99plus1.mp3",
+        "value": "100"
+    },
+    {
+        "path": "add3to1.mp3",
+        "value": "4"
+    },
+    {
+        "path": "addblueandyellow.mp3",
+        "value": "green"
+    },
+    {
+        "path": "after2.mp3",
+        "value": "3"
+    },
+    {
+        "path": "divide4by2.mp3",
+        "value": "2"
+    },
+    {
+        "path": "milkcolor.mp3",
+        "value": "white"
+    },
+    {
+        "path": "skycolor.mp3",
+        "value": "blue"
+    },
+    {
+        "path": "sunastar.mp3",
+        "value": "yes"
+    },
+    {
+        "path": "yourobot.mp3",
+        "value": "no"
+    },
+    {
+        "path": "capitaloffrance.mp3",
+        "value": "paris"
+    },
+    {
+        "path": "skynight.mp3",
+        "value": "black"
+    },
+    {
+        "path": "thirdmonth.mp3",
+        "value": "march"
+    },
+    {
+        "path": "firstletteralphabet.mp3",
+        "value": "a"
+    }
+]