From aeaa7a2c6239e5c71a405a5a81d3592dfd0e23ed Mon Sep 17 00:00:00 2001
From: coderkun <coderkun@users.noreply.github.com>
Date: Sat, 12 Apr 2014 03:25:18 +0200
Subject: [PATCH] implement Questtype ?crossword?

---
 .../crossword/CrosswordQuesttypeAgent.inc     |  24 ++
 .../CrosswordQuesttypeController.inc          | 355 ++++++++++++++++++
 .../crossword/CrosswordQuesttypeModel.inc     |  93 +++++
 questtypes/crossword/html/quest.tpl           |  26 ++
 questtypes/crossword/html/submission.tpl      |  23 ++
 5 files changed, 521 insertions(+)
 create mode 100644 questtypes/crossword/CrosswordQuesttypeAgent.inc
 create mode 100644 questtypes/crossword/CrosswordQuesttypeController.inc
 create mode 100644 questtypes/crossword/CrosswordQuesttypeModel.inc
 create mode 100644 questtypes/crossword/html/quest.tpl
 create mode 100644 questtypes/crossword/html/submission.tpl

diff --git a/questtypes/crossword/CrosswordQuesttypeAgent.inc b/questtypes/crossword/CrosswordQuesttypeAgent.inc
new file mode 100644
index 00000000..9b137fe9
--- /dev/null
+++ b/questtypes/crossword/CrosswordQuesttypeAgent.inc
@@ -0,0 +1,24 @@
+<?php
+	
+	/**
+	 * The Legend of Z
+	 *
+	 * @author	Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
+	 * @copyright	2014 Heinrich-Heine-Universität Düsseldorf
+	 * @license	http://www.gnu.org/licenses/gpl.html
+	 * @link	https://bitbucket.org/coderkun/the-legend-of-z
+	 */
+	
+	namespace hhu\z\questtypes;
+	
+	
+	/**
+	 * QuesttypeAgent for solving a crossword.
+	 * 
+	 * @author	Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
+	 */
+	class CrosswordQuesttypeAgent extends \hhu\z\QuesttypeAgent
+	{
+	}
+
+?>
diff --git a/questtypes/crossword/CrosswordQuesttypeController.inc b/questtypes/crossword/CrosswordQuesttypeController.inc
new file mode 100644
index 00000000..e08e1c29
--- /dev/null
+++ b/questtypes/crossword/CrosswordQuesttypeController.inc
@@ -0,0 +1,355 @@
+<?php
+	
+	/**
+	 * The Legend of Z
+	 *
+	 * @author	Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
+	 * @copyright	2014 Heinrich-Heine-Universität Düsseldorf
+	 * @license	http://www.gnu.org/licenses/gpl.html
+	 * @link	https://bitbucket.org/coderkun/the-legend-of-z
+	 */
+	
+	namespace hhu\z\questtypes;
+	
+	
+	/**
+	 * Controller of the CrosswordQuesttypeAgent for solving a crossword.
+	 * 
+	 * @author	Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
+	 */
+	class CrosswordQuesttypeController extends \hhu\z\QuesttypeController
+	{
+		
+		
+		
+		
+		/**
+		 * Save the answers of a Character for a Quest.
+		 * 
+		 * @param	array	$seminary	Current Seminary data
+		 * @param	array	$questgroup	Current Questgroup data
+		 * @param	array	$quest		Current Quest data
+		 * @param	array	$character	Current Character data
+		 * @param	array	$answers	Character answers for the Quest
+		 */
+		public function saveAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers)
+		{
+			// Get words
+			$words = $this->Crossword->getWordsForQuest($quest['id']);
+			
+			// Iterate words
+			foreach($words as &$word)
+			{
+				// Assemble answer for word
+				$answer = '';
+				if($word['vertical'])
+				{
+					$x = $word['pos_x'];
+					$startY = $word['pos_y'];
+					$endY = $startY + mb_strlen($word['word'], 'UTF-8') - 1;
+					
+					foreach(range($startY, $endY) as $y)
+					{
+						if(array_key_exists($x, $answers) && array_key_exists($y, $answers[$x]) && !empty($answers[$x][$y])) {
+							$answer .= $answers[$x][$y];
+						}
+						else {
+							$answer .= ' ';
+						}
+					}
+				}
+				else
+				{
+					$startX = $word['pos_x'];
+					$endX = $startX + mb_strlen($word['word'], 'UTF-8') - 1;
+					$y = $word['pos_y'];
+					
+					foreach(range($startX, $endX) as $x)
+					{
+						if(array_key_exists($x, $answers) && array_key_exists($y, $answers[$x]) && !empty($answers[$x][$y])) {
+							$answer .= $answers[$x][$y];
+						}
+						else {
+							$answer .= ' ';
+						}
+					}
+				}
+				
+				// Save answer
+				$this->Crossword->setCharacterSubmission($word['id'], $character['id'], $answer);
+			}
+		}
+		
+		
+		/**
+		 * Check if answers of a Character for a Quest match the correct ones.
+		 * 
+		 * @param	array	$seminary	Current Seminary data
+		 * @param	array	$questgroup	Current Questgroup data
+		 * @param	array	$quest		Current Quest data
+		 * @param	array	$character	Current Character data
+		 * @return	boolean			True/false for a right/wrong answer or null for moderator evaluation
+		 */
+		public function matchAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers)
+		{
+			// Get words
+			$words = $this->Crossword->getWordsForQuest($quest['id']);
+			
+			// Iterate words
+			foreach($words as &$word)
+			{
+				// Assemble answer for word
+				$answer = '';
+				if($word['vertical'])
+				{
+					$x = $word['pos_x'];
+					$startY = $word['pos_y'];
+					$endY = $startY + mb_strlen($word['word'], 'UTF-8') - 1;
+					
+					foreach(range($startY, $endY) as $y)
+					{
+						if(array_key_exists($x, $answers) && array_key_exists($y, $answers[$x]) && !empty($answers[$x][$y])) {
+							$answer .= $answers[$x][$y];
+						}
+						else {
+							$answer .= ' ';
+						}
+					}
+				}
+				else
+				{
+					$startX = $word['pos_x'];
+					$endX = $startX + mb_strlen($word['word'], 'UTF-8') - 1;
+					$y = $word['pos_y'];
+					
+					foreach(range($startX, $endX) as $x)
+					{
+						if(array_key_exists($x, $answers) && array_key_exists($y, $answers[$x]) && !empty($answers[$x][$y])) {
+							$answer .= $answers[$x][$y];
+						}
+						else {
+							$answer .= ' ';
+						}
+					}
+				}
+				
+				// Check answer
+				if(mb_strtolower($word['word'], 'UTF-8') != mb_strtolower($answer, 'UTF-8')) {
+					return false;
+				}
+			}
+			
+			
+			// All answer right
+			return true;
+		}
+		
+		
+		/**
+		 * Action: quest.
+		 * 
+		 * Display a text with lists with predefined values.
+		 * 
+		 * @param	array		$seminary	Current Seminary data
+		 * @param	array		$questgroup	Current Questgroup data
+		 * @param	array		$quest		Current Quest data
+		 * @param	array		$character	Current Character data
+		 * @param	Exception	$exception	Character submission exception
+		 */
+		public function quest($seminary, $questgroup, $quest, $character, $exception)
+		{
+			// Get words
+			$words = $this->Crossword->getWordsForQuest($quest['id']);
+			
+			// Create 2D-matrix
+			$matrix = array();
+			$maxX = 0;
+			$maxY = 0;
+			foreach($words as $index => &$word)
+			{
+				if($this->request->getGetParam('show-answer') == 'true') {
+					$word['answer'] = $this->Crossword->getCharacterSubmission($word['id'], $character['id']);
+				}
+				// Insert word
+				if($word['vertical'])
+				{
+					$x = $word['pos_x'];
+					$startY = $word['pos_y'];
+					$endY = $startY + mb_strlen($word['word'], 'UTF-8') - 1;
+					
+					$matrix = array_pad($matrix, $x+1, array());
+					$matrix[$x] = array_pad($matrix[$x], $endY+1, null);
+					$maxX = max($maxX, $x);
+					$maxY = max($maxY, $endY);
+					
+					foreach(range($startY, $endY) as $y)
+					{
+						$oldValue = (array_key_exists($x, $matrix) && array_key_exists($y, $matrix[$x]) && !is_null($matrix[$x][$y])) ? $matrix[$x][$y] : null;
+						$matrix[$x][$y] = array(
+							'char'		=> mb_substr($word['word'], $y-$startY, 1, 'UTF-8'),
+							'indices'	=> array($index),
+							'answer' 	=> null
+						);
+						if(!is_null($oldValue)) {
+							$matrix[$x][$y]['indices'] = array_merge($matrix[$x][$y]['indices'], $oldValue['indices']);
+						}
+						if(array_key_exists('answer', $word))
+						{
+							$answer = mb_substr($word['answer'], $y-$startY, 1, 'UTF-8');
+							if($answer != ' ') {
+								$matrix[$x][$y]['answer'] = $answer;
+							}
+						}
+					}
+				}
+				else
+				{
+					$startX = $word['pos_x'];
+					$endX = $startX + mb_strlen($word['word'], 'UTF-8') - 1;
+					$y = $word['pos_y'];
+					
+					$matrix = array_pad($matrix, $endX+1, array());
+					$maxX = max($maxX, $endX);
+					$maxY = max($maxY, $y);
+					
+					foreach(range($startX, $endX) as $x)
+					{
+						$matrix[$x] = array_pad($matrix[$x], $y+1, null);
+						
+						$oldValue = (array_key_exists($x, $matrix) && array_key_exists($y, $matrix[$x]) && !is_null($matrix[$x][$y])) ? $matrix[$x][$y] : null;
+						$matrix[$x][$y] = array(
+							'char'		=> mb_substr($word['word'], $x-$startX, 1, 'UTF-8'),
+							'indices'	=> array($index),
+							'answer'	=> null
+						);
+						if(!is_null($oldValue)) {
+							$matrix[$x][$y]['indices'] = array_merge($matrix[$x][$y]['indices'], $oldValue['indices']);
+						}
+						if(array_key_exists('answer', $word))
+						{
+							$answer = mb_substr($word['answer'], $x-$startX, 1, 'UTF-8');
+							if($answer != ' ') {
+								$matrix[$x][$y]['answer'] = $answer;
+							}
+						}
+					}
+				}
+			}
+			
+			
+			// Pass data to view
+			$this->set('words', $words);
+			$this->set('maxX', $maxX);
+			$this->set('maxY', $maxY);
+			$this->set('matrix', $matrix);
+		}
+		
+		
+		/**
+		 * Action: submission.
+		 * 
+		 * Show the submission of a Character for a Quest.
+		 * 
+		 * @param	array	$seminary	Current Seminary data
+		 * @param	array	$questgroup	Current Questgroup data
+		 * @param	array	$quest		Current Quest data
+		 * @param	array	$character	Current Character data
+		 */
+		public function submission($seminary, $questgroup, $quest, $character)
+		{
+			// Get words
+			$words = $this->Crossword->getWordsForQuest($quest['id']);
+			
+			// Create 2D-matrix
+			$matrix = array();
+			$maxX = 0;
+			$maxY = 0;
+			foreach($words as $index => &$word)
+			{
+				// Character answer
+				$word['answer'] = $this->Crossword->getCharacterSubmission($word['id'], $character['id']);
+				
+				// Insert word
+				if($word['vertical'])
+				{
+					$x = $word['pos_x'];
+					$startY = $word['pos_y'];
+					$endY = $startY + mb_strlen($word['word'], 'UTF-8') - 1;
+					
+					$matrix = array_pad($matrix, $x+1, array());
+					$matrix[$x] = array_pad($matrix[$x], $endY+1, null);
+					$maxX = max($maxX, $x);
+					$maxY = max($maxY, $endY);
+					
+					foreach(range($startY, $endY) as $y)
+					{
+						$oldValue = (array_key_exists($x, $matrix) && array_key_exists($y, $matrix[$x]) && !is_null($matrix[$x][$y])) ? $matrix[$x][$y] : null;
+						$matrix[$x][$y] = array(
+							'char'		=> mb_substr($word['word'], $y-$startY, 1, 'UTF-8'),
+							'indices'	=> array($index),
+							'answer'	=> null,
+							'right'		=> false
+						);
+						if(!is_null($oldValue)) {
+							$matrix[$x][$y]['indices'] = array_merge($matrix[$x][$y]['indices'], $oldValue['indices']);
+						}
+						
+						if(!is_null($word['answer']))
+						{
+							$answer = mb_substr($word['answer'], $y-$startY, 1, 'UTF-8');
+							if($answer != ' ')
+							{
+								$matrix[$x][$y]['answer'] = $answer;
+								$matrix[$x][$y]['right'] = (mb_strtolower($matrix[$x][$y]['char'], 'UTF-8') == mb_strtolower($answer, 'UTF-8'));
+							}
+						}
+					}
+				}
+				else
+				{
+					$startX = $word['pos_x'];
+					$endX = $startX + mb_strlen($word['word'], 'UTF-8') - 1;
+					$y = $word['pos_y'];
+					
+					$matrix = array_pad($matrix, $endX+1, array());
+					$maxX = max($maxX, $endX);
+					$maxY = max($maxY, $y);
+					
+					foreach(range($startX, $endX) as $x)
+					{
+						$matrix[$x] = array_pad($matrix[$x], $y+1, null);
+						
+						$oldValue = (array_key_exists($x, $matrix) && array_key_exists($y, $matrix[$x]) && !is_null($matrix[$x][$y])) ? $matrix[$x][$y] : null;
+						$matrix[$x][$y] = array(
+							'char'		=> mb_substr($word['word'], $x-$startX, 1, 'UTF-8'),
+							'indices'	=> array($index),
+							'answer'	=> null,
+							'right'		=> false
+						);
+						if(!is_null($oldValue)) {
+							$matrix[$x][$y]['indices'] = array_merge($matrix[$x][$y]['indices'], $oldValue['indices']);
+						}
+						if(!is_null($word['answer']))
+						{
+							$answer = mb_substr($word['answer'], $x-$startX, 1, 'UTF-8');
+							if($answer != ' ')
+							{
+								$matrix[$x][$y]['answer'] = $answer;
+								$matrix[$x][$y]['right'] = (mb_strtolower($matrix[$x][$y]['char'], 'UTF-8') == mb_strtolower($answer, 'UTF-8'));
+							}
+						}
+					}
+				}
+			}
+			
+			
+			// Pass data to view
+			$this->set('words', $words);
+			$this->set('maxX', $maxX);
+			$this->set('maxY', $maxY);
+			$this->set('matrix', $matrix);
+		}
+		
+	}
+
+?>
diff --git a/questtypes/crossword/CrosswordQuesttypeModel.inc b/questtypes/crossword/CrosswordQuesttypeModel.inc
new file mode 100644
index 00000000..78a42821
--- /dev/null
+++ b/questtypes/crossword/CrosswordQuesttypeModel.inc
@@ -0,0 +1,93 @@
+<?php
+	
+	/**
+	 * The Legend of Z
+	 *
+	 * @author	Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
+	 * @copyright	2014 Heinrich-Heine-Universität Düsseldorf
+	 * @license	http://www.gnu.org/licenses/gpl.html
+	 * @link	https://bitbucket.org/coderkun/the-legend-of-z
+	 */
+	
+	namespace hhu\z\questtypes;
+	
+	
+	/**
+	 * Model of the CrosswordQuesttypeAgent for solving a crossword.
+	 * 
+	 * @author	Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
+	 */
+	class CrosswordQuesttypeModel extends \hhu\z\QuesttypeModel
+	{
+		
+		
+		
+		
+		/**
+		 * Get all words for a crossword-Quest.
+		 * 
+		 * @param	int	$questId	ID of Quest
+		 * @return	array			Words
+		 */
+		public function getWordsForQuest($questId)
+		{
+			return $this->db->query(
+				'SELECT id, question, word, vertical, pos_x, pos_y '.
+				'FROM questtypes_crossword_words '.
+				'WHERE quest_id = ? ',
+				'i',
+				$questId
+			);
+		}
+		
+		
+		/**
+		 * Save Character’s submitted answer for one crossword-word.
+		 * 
+		 * @param	int	$regexId	ID of word
+		 * @param	int	$characterId	ID of Character
+		 * @param	string	$answer		Submitted answer for this word
+		 */
+		public function setCharacterSubmission($wordId, $characterId, $answer)
+		{
+			$this->db->query(
+				'INSERT INTO questtypes_crossword_words_characters '.
+				'(questtypes_crossword_word_id, character_id, answer) '.
+				'VALUES '.
+				'(?, ?, ?) '.
+				'ON DUPLICATE KEY UPDATE '.
+				'answer = ?',
+				'iiss',
+				$wordId, $characterId, $answer,
+				$answer
+			);
+		}
+		
+		
+		/**
+		 * Get answer of one crossword-word submitted by Character.
+		 * 
+		 * @param	int	$regexId	ID of lisword
+		 * @param	int	$characterId	ID of Character
+		 * @return	int			Submitted answer for this word or null
+		 */
+		public function getCharacterSubmission($wordId, $characterId)
+		{
+			$data = $this->db->query(
+				'SELECT answer '.
+				'FROM questtypes_crossword_words_characters '.
+				'WHERE questtypes_crossword_word_id = ? AND character_id = ? ',
+				'ii',
+				$wordId, $characterId
+			);
+			if(!empty($data)) {
+				return $data[0]['answer'];
+			}
+			
+			
+			return null;
+		}
+		
+	}
+
+?>
diff --git a/questtypes/crossword/html/quest.tpl b/questtypes/crossword/html/quest.tpl
new file mode 100644
index 00000000..3965b69c
--- /dev/null
+++ b/questtypes/crossword/html/quest.tpl
@@ -0,0 +1,26 @@
+<form method="post">
+	<table>
+		<tbody>
+			<?php foreach(range(0, $maxY) as $y) : ?>
+			<tr>
+				<?php foreach(range(0, $maxX) as $x) : ?>
+				<td>
+					<?php if(array_key_exists($x, $matrix) && array_key_exists($y, $matrix[$x]) && !is_null($matrix[$x][$y])) : ?>
+					<input type="text" name="answers[<?=$x?>][<?=$y?>]" maxlength="1" size="1" placeholder="<?=implode('/',$matrix[$x][$y]['indices'])?>" value="<?=(!is_null($matrix[$x][$y]['answer'])) ? $matrix[$x][$y]['answer'] : ''?>" />	
+					<?php endif ?>
+				</td>
+				<?php endforeach ?>
+			</tr>
+			<?php endforeach ?>
+		</tbody>
+	</table>
+	
+	<ul>
+		<?php foreach($words as &$word) : ?>
+		<li><?=$word['question']?></li>
+		<?php endforeach ?>
+	</ul>
+	
+	<br /><br />
+	<input type="submit" name="submit" value="<?=_('solve')?>" />
+</form>
diff --git a/questtypes/crossword/html/submission.tpl b/questtypes/crossword/html/submission.tpl
new file mode 100644
index 00000000..60f239c3
--- /dev/null
+++ b/questtypes/crossword/html/submission.tpl
@@ -0,0 +1,23 @@
+<form method="post">
+	<table>
+		<tbody>
+			<?php foreach(range(0, $maxY) as $y) : ?>
+			<tr>
+				<?php foreach(range(0, $maxX) as $x) : ?>
+				<td>
+					<?php if(array_key_exists($x, $matrix) && array_key_exists($y, $matrix[$x]) && !is_null($matrix[$x][$y])) : ?>
+					<input type="text" name="answers[<?=$x?>][<?=$y?>]" maxlength="1" size="1" disabled="disabled" style="background-color:<?=($matrix[$x][$y]['right']) ? 'green' : 'red'?>" placeholder="<?=implode('/',$matrix[$x][$y]['indices'])?>" value="<?=(!is_null($matrix[$x][$y]['answer'])) ? $matrix[$x][$y]['answer'] : ''?>" />	
+					<?php endif ?>
+				</td>
+				<?php endforeach ?>
+			</tr>
+			<?php endforeach ?>
+		</tbody>
+	</table>
+	
+	<ul>
+		<?php foreach($words as &$word) : ?>
+		<li><?=$word['question']?></li>
+		<?php endforeach ?>
+	</ul>
+</form>