Merge remote-tracking branch 'EXreaction/ticket/11420' into develop

* EXreaction/ticket/11420: [ticket/11420] Fix tests [ticket/11420] Fix tests [ticket/11420] Fix tests [ticket/11420] Use !==, === when comparing strings [ticket/11420] Fix comments, license link [ticket/11420] Rename migrations file to something more helpful [ticket/11420] Forgot to include mock sql_insert_buffer [ticket/11420] Fix notification options conversion
author: Joas Schilling <nickvergessen@gmx.de> 2013-07-13 11:15:53 -0400
committer: Joas Schilling <nickvergessen@gmx.de> 2013-07-13 11:15:53 -0400
commit: 1584fdd26dd73610d76e1bacf25c442d5d59f0f9 (patch)
tree: db1dd56590f4ab83f4b9e188822b30ca8fa90649
parent: 7b0a6ef06c0f84634ba6f2ba3c2c9d304e61a19a (diff)
parent: fa8f62a604d5d885f6126619ca1dc3db7b0731a7 (diff)
download: forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.tar
forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.tar.gz
forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.tar.bz2
forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.tar.xz
forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.zip
5 files changed, 329 insertions, 64 deletions
diff --git a/phpBB/includes/db/migration/data/310/notification_options_reconvert.php b/phpBB/includes/db/migration/data/310/notification_options_reconvert.php
new file mode 100644
index 0000000000..d994d7ec5f
--- /dev/null
+++ b/phpBB/includes/db/migration/data/310/notification_options_reconvert.php
@@ -0,0 +1,118 @@
+<?php
+/**
+*
+* @package migration
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+class phpbb_db_migration_data_310_notification_options_reconvert extends phpbb_db_migration
+{
+	static public function depends_on()
+	{
+		return array('phpbb_db_migration_data_310_notifications_schema_fix');
+	}
+
+	public function update_data()
+	{
+		return array(
+			array('custom', array(array($this, 'convert_notifications'))),
+		);
+	}
+
+	public function convert_notifications()
+	{
+		$insert_table = $this->table_prefix . 'user_notifications';
+		$insert_buffer = new phpbb_db_sql_insert_buffer($this->db, $insert_table);
+
+		$this->perform_conversion($insert_buffer, $insert_table);
+	}
+
+	/**
+	* Perform the conversion (separate for testability)
+	*
+	* @param phpbb_db_sql_insert_buffer $insert_buffer
+	* @param string $insert_table
+	*/
+	public function perform_conversion(phpbb_db_sql_insert_buffer $insert_buffer, $insert_table)
+	{
+		$sql = 'DELETE FROM ' . $insert_table;
+		$this->db->sql_query($sql);
+
+		$sql = 'SELECT user_id, user_notify_type, user_notify_pm
+			FROM ' . USERS_TABLE;
+		$result = $this->db->sql_query($sql);
+
+		while ($row = $this->db->sql_fetchrow($result))
+		{
+			$notification_methods = array();
+
+			// In-board notification
+			$notification_methods[] = '';
+
+			if ($row['user_notify_type'] == NOTIFY_EMAIL || $row['user_notify_type'] == NOTIFY_BOTH)
+			{
+				$notification_methods[] = 'email';
+			}
+
+			if ($row['user_notify_type'] == NOTIFY_IM || $row['user_notify_type'] == NOTIFY_BOTH)
+			{
+				$notification_methods[] = 'jabber';
+			}
+
+			// Notifications for posts
+			foreach (array('post', 'topic') as $item_type)
+			{
+				$this->add_method_rows(
+					$insert_buffer,
+					$item_type,
+					0,
+					$row['user_id'],
+					$notification_methods
+				);
+			}
+
+			if ($row['user_notify_pm'])
+			{
+				// Notifications for private messages
+				// User either gets all methods or no method
+				$this->add_method_rows(
+					$insert_buffer,
+					'pm',
+					0,
+					$row['user_id'],
+					$notification_methods
+				);
+			}
+		}
+		$this->db->sql_freeresult($result);
+
+		$insert_buffer->flush();
+	}
+
+	/**
+	* Insert method rows to DB
+	*
+	* @param phpbb_db_sql_insert_buffer $insert_buffer
+	* @param string $item_type
+	* @param int $item_id
+	* @param int $user_id
+	* @param string $methods
+	*/
+	protected function add_method_rows(phpbb_db_sql_insert_buffer $insert_buffer, $item_type, $item_id, $user_id, array $methods)
+	{
+		$row_base = array(
+			'item_type'		=> $item_type,
+			'item_id'		=> (int) $item_id,
+			'user_id'		=> (int) $user_id,
+			'notify'		=> 1
+		);
+
+		foreach ($methods as $method)
+		{
+			$row_base['method'] = $method;
+			$insert_buffer->insert($row_base);
+		}
+	}
+}
diff --git a/phpBB/includes/db/migration/data/310/notifications.php b/phpBB/includes/db/migration/data/310/notifications.php
index 82bfd4cb2d..17c939d95a 100644
--- a/phpBB/includes/db/migration/data/310/notifications.php
+++ b/phpBB/includes/db/migration/data/310/notifications.php
@@ -91,70 +91,6 @@ class phpbb_db_migration_data_310_notifications extends phpbb_db_migration
 				),
 			)),
 			array('config.add', array('load_notifications', 1)),
-			array('custom', array(array($this, 'convert_notifications'))),
 		);
 	}
-
-	public function convert_notifications()
-	{
-		$convert_notifications = array(
-			array(
-				'check'			=> ($this->config['allow_topic_notify']),
-				'item_type'		=> 'post',
-			),
-			array(
-				'check'			=> ($this->config['allow_forum_notify']),
-				'item_type'		=> 'topic',
-			),
-			array(
-				'check'			=> ($this->config['allow_bookmarks']),
-				'item_type'		=> 'bookmark',
-			),
-			array(
-				'check'			=> ($this->config['allow_privmsg']),
-				'item_type'		=> 'pm',
-			),
-		);
-
-		foreach ($convert_notifications as $convert_data)
-		{
-			if ($convert_data['check'])
-			{
-				$sql = 'SELECT user_id, user_notify_type
-					FROM ' . USERS_TABLE . '
-						WHERE user_notify = 1';
-				$result = $this->db->sql_query($sql);
-				while ($row = $this->db->sql_fetchrow($result))
-				{
-					$this->sql_query('INSERT INTO ' . $this->table_prefix . 'user_notifications ' . $this->db->sql_build_array('INSERT', array(
-						'item_type'		=> $convert_data['item_type'],
-						'item_id'		=> 0,
-						'user_id'		=> $row['user_id'],
-						'method'		=> '',
-					)));
-
-					if ($row['user_notify_type'] == NOTIFY_EMAIL || $row['user_notify_type'] == NOTIFY_BOTH)
-					{
-						$this->sql_query('INSERT INTO ' . $this->table_prefix . 'user_notifications ' . $this->db->sql_build_array('INSERT', array(
-							'item_type'		=> $convert_data['item_type'],
-							'item_id'		=> 0,
-							'user_id'		=> $row['user_id'],
-							'method'		=> 'email',
-						)));
-					}
-
-					if ($row['user_notify_type'] == NOTIFY_IM || $row['user_notify_type'] == NOTIFY_BOTH)
-					{
-						$this->sql_query('INSERT INTO ' . $this->table_prefix . 'user_notifications ' . $this->db->sql_build_array('INSERT', array(
-							'item_type'		=> $convert_data['item_type'],
-							'item_id'		=> 0,
-							'user_id'		=> $row['user_id'],
-							'method'		=> 'jabber',
-						)));
-					}
-				}
-				$this->db->sql_freeresult($result);
-			}
-		}
-	}
 }
diff --git a/tests/mock/sql_insert_buffer.php b/tests/mock/sql_insert_buffer.php
new file mode 100644
index 0000000000..ba09aa8d7f
--- /dev/null
+++ b/tests/mock/sql_insert_buffer.php
@@ -0,0 +1,21 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+class phpbb_mock_sql_insert_buffer extends phpbb_db_sql_insert_buffer
+{
+	public function flush()
+	{
+		return (sizeof($this->buffer)) ? true : false;
+	}
+
+	public function get_buffer()
+	{
+		return $this->buffer;
+	}
+}
diff --git a/tests/notification/convert_test.php b/tests/notification/convert_test.php
new file mode 100644
index 0000000000..4d00fa0a1e
--- /dev/null
+++ b/tests/notification/convert_test.php
@@ -0,0 +1,110 @@
+<?php
+/**
+*
+* @package testing
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+require_once dirname(__FILE__) . '/../../phpBB/includes/db/db_tools.php';
+require_once dirname(__FILE__) . '/../mock/sql_insert_buffer.php';
+
+class phpbb_notification_convert_test extends phpbb_database_test_case
+{
+	protected $notifications, $db, $container, $user, $config, $auth, $cache;
+
+	public function getDataSet()
+	{
+		return $this->createXMLDataSet(dirname(__FILE__) . '/fixtures/convert.xml');
+	}
+
+	protected function setUp()
+	{
+		parent::setUp();
+
+		global $phpbb_root_path, $phpEx;
+
+		$this->db = $this->new_dbal();
+
+		$this->migration = new phpbb_db_migration_data_310_notification_options_reconvert(
+			new phpbb_config(array()),
+			$this->db,
+			new phpbb_db_tools($this->db),
+			$phpbb_root_path,
+			$phpEx,
+			'phpbb_'
+		);
+	}
+
+	public function test_convert()
+	{
+		$buffer = new phpbb_mock_sql_insert_buffer($this->db, 'phpbb_user_notifications');
+		$this->migration->perform_conversion($buffer, 'phpbb_user_notifications');
+
+		$expected = array_merge(
+			$this->create_expected('post', 1, 'email'),
+			$this->create_expected('topic', 1, 'email'),
+
+			$this->create_expected('post', 2, 'email'),
+			$this->create_expected('topic', 2, 'email'),
+			$this->create_expected('pm', 2, 'email'),
+
+			$this->create_expected('post', 3, 'jabber'),
+			$this->create_expected('topic', 3, 'jabber'),
+
+			$this->create_expected('post', 4, 'jabber'),
+			$this->create_expected('topic', 4, 'jabber'),
+			$this->create_expected('pm', 4, 'jabber'),
+
+			$this->create_expected('post', 5, 'both'),
+			$this->create_expected('topic', 5, 'both'),
+
+			$this->create_expected('post', 6, 'both'),
+			$this->create_expected('topic', 6, 'both'),
+			$this->create_expected('pm', 6, 'both')
+		);
+
+		$this->assertEquals($expected, $buffer->get_buffer());
+	}
+
+	protected function create_expected($type, $user_id, $method = '')
+	{
+		$return = array();
+
+		if ($method !== '')
+		{
+			$return[] = array(
+				'item_type'		=> $type,
+				'item_id'		=> 0,
+				'user_id'		=> $user_id,
+				'method'		=> '',
+				'notify'		=> 1,
+			);
+		}
+
+		if ($method === 'email' || $method === 'both')
+		{
+			$return[] = array(
+				'item_type'		=> $type,
+				'item_id'		=> 0,
+				'user_id'		=> $user_id,
+				'method'		=> 'email',
+				'notify'		=> 1,
+			);
+		}
+
+		if ($method === 'jabber' || $method === 'both')
+		{
+			$return[] = array(
+				'item_type'		=> $type,
+				'item_id'		=> 0,
+				'user_id'		=> $user_id,
+				'method'		=> 'jabber',
+				'notify'		=> 1,
+			);
+		}
+
+		return $return;
+	}
+}
diff --git a/tests/notification/fixtures/convert.xml b/tests/notification/fixtures/convert.xml
new file mode 100644
index 0000000000..3f0a065cc4
--- /dev/null
+++ b/tests/notification/fixtures/convert.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<dataset>
+	<table name="phpbb_users">
+		<column>user_id</column>
+		<column>username</column>
+		<column>username_clean</column>
+		<column>user_notify_type</column>
+		<column>user_notify_pm</column>
+		<column>user_permissions</column>
+		<column>user_sig</column>
+		<column>user_occ</column>
+		<column>user_interests</column>
+		<row>
+			<value>1</value>
+			<value>1</value>
+			<value>1</value>
+			<value>0</value>
+			<value>0</value>
+			<value></value>
+			<value></value>
+			<value></value>
+			<value></value>
+		</row>
+		<row>
+			<value>2</value>
+			<value>2</value>
+			<value>2</value>
+			<value>0</value>
+			<value>1</value>
+			<value></value>
+			<value></value>
+			<value></value>
+			<value></value>
+		</row>
+		<row>
+			<value>3</value>
+			<value>3</value>
+			<value>3</value>
+			<value>1</value>
+			<value>0</value>
+			<value></value>
+			<value></value>
+			<value></value>
+			<value></value>
+		</row>
+		<row>
+			<value>4</value>
+			<value>4</value>
+			<value>4</value>
+			<value>1</value>
+			<value>1</value>
+			<value></value>
+			<value></value>
+			<value></value>
+			<value></value>
+		</row>
+		<row>
+			<value>5</value>
+			<value>5</value>
+			<value>5</value>
+			<value>2</value>
+			<value>0</value>
+			<value></value>
+			<value></value>
+			<value></value>
+			<value></value>
+		</row>
+		<row>
+			<value>6</value>
+			<value>6</value>
+			<value>6</value>
+			<value>2</value>
+			<value>1</value>
+			<value></value>
+			<value></value>
+			<value></value>
+			<value></value>
+		</row>
+	</table>
+</dataset>
author	Joas Schilling <nickvergessen@gmx.de>	2013-07-13 11:15:53 -0400
committer	Joas Schilling <nickvergessen@gmx.de>	2013-07-13 11:15:53 -0400
commit	1584fdd26dd73610d76e1bacf25c442d5d59f0f9 (patch)
tree	db1dd56590f4ab83f4b9e188822b30ca8fa90649
parent	7b0a6ef06c0f84634ba6f2ba3c2c9d304e61a19a (diff)
parent	fa8f62a604d5d885f6126619ca1dc3db7b0731a7 (diff)
download	forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.tar forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.tar.gz forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.tar.bz2 forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.tar.xz forums-1584fdd26dd73610d76e1bacf25c442d5d59f0f9.zip