Merge pull request #3616 from s9e/ticket/13847

[ticket/13847] Move quote generation to text_formatter.utils
author: Tristan Darricau <tristan.darricau@sensiolabs.com> 2015-05-29 15:42:14 +0200
committer: Tristan Darricau <tristan.darricau@sensiolabs.com> 2015-05-29 15:42:14 +0200
commit: f5dbc3b6f269cb3841c20ad0096fcedb3dac7492 (patch)
tree: 5ca32d171af32f236d82cbf11cedfe3735c5fa3d
parent: 3c3b099f88471e05358fe3c01bb74caac69e89e7 (diff)
parent: 64e1824abdb2a9c860e049f10ecc81c051160ff5 (diff)
download: forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.tar
forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.tar.gz
forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.tar.bz2
forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.tar.xz
forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.zip
7 files changed, 172 insertions, 3 deletions
diff --git a/phpBB/includes/ucp/ucp_pm_compose.php b/phpBB/includes/ucp/ucp_pm_compose.php
index 59952182df..53be1b3b29 100644
--- a/phpBB/includes/ucp/ucp_pm_compose.php
+++ b/phpBB/includes/ucp/ucp_pm_compose.php
@@ -947,7 +947,11 @@ function compose_pm($id, $mode, $action, $user_folders = array())
 		{
 			$message_link = '';
 		}
-		$message_parser->message = $message_link . '[quote=&quot;' . $quote_username . '&quot;]' . censor_text(trim($message_parser->message)) . "[/quote]\n";
+		$quote_text = $phpbb_container->get('text_formatter.utils')->generate_quote(
+			censor_text(trim($message_parser->message)),
+			array('author' => $quote_username)
+		);
+		$message_parser->message = $message_link . $quote_text . "\n";
 	}
 
 	if (($action == 'reply' || $action == 'quote' || $action == 'quotepost') && !$preview && !$refresh)
@@ -975,7 +979,11 @@ function compose_pm($id, $mode, $action, $user_folders = array())
 		$forward_text[] = sprintf($user->lang['FWD_FROM'], $quote_username_text);
 		$forward_text[] = sprintf($user->lang['FWD_TO'], implode($user->lang['COMMA_SEPARATOR'], $fwd_to_field['to']));
 
-		$message_parser->message = implode("\n", $forward_text) . "\n\n[quote=&quot;{$quote_username}&quot;]\n" . censor_text(trim($message_parser->message)) . "\n[/quote]";
+		$quote_text = $phpbb_container->get('text_formatter.utils')->generate_quote(
+			censor_text(trim($message_parser->message)),
+			array('author' => $quote_username)
+		);
+		$message_parser->message = implode("\n", $forward_text) . "\n\n" . $quote_text;
 		$message_subject = ((!preg_match('/^Fwd:/', $message_subject)) ? 'Fwd: ' : '') . censor_text($message_subject);
 	}
 
diff --git a/phpBB/phpbb/textformatter/s9e/utils.php b/phpBB/phpbb/textformatter/s9e/utils.php
index e21dedecc4..04df589930 100644
--- a/phpBB/phpbb/textformatter/s9e/utils.php
+++ b/phpBB/phpbb/textformatter/s9e/utils.php
@@ -35,6 +35,44 @@ class utils implements \phpbb\textformatter\utils_interface
 	}
 
 	/**
+	* Return given string between quotes
+	*
+	* Will use either single- or double- quotes depending on whichever requires less escaping.
+	* Quotes and backslashes are escaped with backslashes where necessary
+	*
+	* @param  string $str Original string
+	* @return string      Escaped string within quotes
+	*/
+	protected function enquote($str)
+	{
+		$singleQuoted = "'" . addcslashes($str, "\\'") . "'";
+		$doubleQuoted = '"' . addcslashes($str, '\\"') . '"';
+
+		return (strlen($singleQuoted) < strlen($doubleQuoted)) ? $singleQuoted : $doubleQuoted;
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function generate_quote($text, array $attributes = array())
+	{
+		$quote = '[quote';
+		if (isset($attributes['author']))
+		{
+			// Add the author as the BBCode's default attribute
+			$quote .= '=' . $this->enquote($attributes['author']);
+			unset($attributes['author']);
+		}
+		foreach ($attributes as $name => $value)
+		{
+			$quote .= ' ' . $name . '=' . $this->enquote($value);
+		}
+		$quote .= ']' . $text . '[/quote]';
+
+		return $quote;
+	}
+
+	/**
 	* Get a list of quote authors, limited to the outermost quotes
 	*
 	* @param  string   $xml Parsed text
diff --git a/phpBB/phpbb/textformatter/utils_interface.php b/phpBB/phpbb/textformatter/utils_interface.php
index 6d3fd13021..41a6ba2345 100644
--- a/phpBB/phpbb/textformatter/utils_interface.php
+++ b/phpBB/phpbb/textformatter/utils_interface.php
@@ -29,6 +29,18 @@ interface utils_interface
 	public function clean_formatting($text);
 
 	/**
+	* Create a quote block for given text
+	*
+	* Possible attributes:
+	*   - author
+	*
+	* @param  string $text       Quote's text
+	* @param  array  $attributes Quote's attributes
+	* @return string             Quote block to be used in a new post/text
+	*/
+	public function generate_quote($text, array $attributes = array());
+
+	/**
 	* Get a list of quote authors, limited to the outermost quotes
 	*
 	* @param  string   $text Parsed text
diff --git a/phpBB/posting.php b/phpBB/posting.php
index a4fb4d7a8d..4d52da2567 100644
--- a/phpBB/posting.php
+++ b/phpBB/posting.php
@@ -1597,7 +1597,11 @@ if ($generate_quote)
 {
 	if ($config['allow_bbcode'])
 	{
-		$message_parser->message = '[quote=&quot;' . $post_data['quote_username'] . '&quot;]' . censor_text(trim($message_parser->message)) . "[/quote]\n";
+		$message_parser->message = $phpbb_container->get('text_formatter.utils')->generate_quote(
+			censor_text(trim($message_parser->message)),
+			array('author' => $post_data['quote_username'])
+		);
+		$message_parser->message .= "\n";
 	}
 	else
 	{
diff --git a/tests/functional/posting_test.php b/tests/functional/posting_test.php
index 5c083aef37..8677237772 100644
--- a/tests/functional/posting_test.php
+++ b/tests/functional/posting_test.php
@@ -72,6 +72,20 @@ class phpbb_functional_posting_test extends phpbb_functional_test_case
 		$this->assertContains('&#128512;', $crawler->text());
 	}
 
+	public function test_quote()
+	{
+		$text     = 'Test post </textarea>"\' &&amp;amp;';
+		$expected = '[quote="admin"]' . $text . '[/quote]';
+
+		$this->login();
+		$topic = $this->create_topic(2, 'Test Topic 1', 'Test topic');
+		$post  = $this->create_post(2, $topic['topic_id'], 'Re: Test Topic 1', $text);
+
+		$crawler = self::request('GET', "posting.php?mode=quote&f=2&t={$post['topic_id']}&p={$post['post_id']}&sid={$this->sid}");
+
+		$this->assertContains($expected, $crawler->filter('textarea#message')->text());
+	}
+
 	/**
 	* @testdox max_quote_depth is applied to the text populating the posting form
 	*/
diff --git a/tests/functional/private_messages_test.php b/tests/functional/private_messages_test.php
index 1f6dc3a979..3f602d62fb 100644
--- a/tests/functional/private_messages_test.php
+++ b/tests/functional/private_messages_test.php
@@ -66,4 +66,31 @@ class phpbb_functional_private_messages_test extends phpbb_functional_test_case
 		$crawler = self::submit($form);
 		$this->assertContains($this->lang('CONFIG_UPDATED'), $crawler->filter('.successbox')->text());
 	}
+
+	public function test_quote_post()
+	{
+		$text     = 'Test post';
+		$expected = '[quote="admin"]' . $text . '[/quote]';
+
+		$this->login();
+		$topic = $this->create_topic(2, 'Test Topic 1', 'Test topic');
+		$post  = $this->create_post(2, $topic['topic_id'], 'Re: Test Topic 1', $text);
+
+		$crawler = self::request('GET', 'ucp.php?i=pm&mode=compose&action=quotepost&p=' . $post['post_id'] . '&sid=' . $this->sid);
+
+		$this->assertContains($expected, $crawler->filter('textarea#message')->text());
+	}
+
+	public function test_quote_forward()
+	{
+		$text     = 'This is a test private message sent by the testing framework.';
+		$expected = '[quote="admin"]' . $text . '[/quote]';
+
+		$this->login();
+		$message_id = $this->create_private_message('Test', $text, array(2));
+
+		$crawler = self::request('GET', 'ucp.php?i=pm&mode=compose&action=forward&f=0&p=' . $message_id . '&sid=' . $this->sid);
+
+		$this->assertContains($expected, $crawler->filter('textarea#message')->text());
+	}
 }
diff --git a/tests/text_formatter/s9e/utils_test.php b/tests/text_formatter/s9e/utils_test.php
index b1b937709c..555f29cb38 100644
--- a/tests/text_formatter/s9e/utils_test.php
+++ b/tests/text_formatter/s9e/utils_test.php
@@ -109,6 +109,72 @@ class phpbb_textformatter_s9e_utils_test extends phpbb_test_case
 	}
 
 	/**
+	* @dataProvider get_generate_quote_tests
+	*/
+	public function test_generate_quote($text, $params, $expected)
+	{
+		$container = $this->get_test_case_helpers()->set_s9e_services();
+		$utils     = $container->get('text_formatter.utils');
+
+		$this->assertSame($expected, $utils->generate_quote($text, $params));
+	}
+
+	public function get_generate_quote_tests()
+	{
+		return array(
+			array(
+				'...',
+				array(),
+				'[quote]...[/quote]',
+			),
+			array(
+				'...',
+				array('author' => 'Brian Kibler'),
+				'[quote="Brian Kibler"]...[/quote]',
+			),
+			array(
+				'...',
+				array('author' => 'Brian "Brian Kibler" Kibler of Brian Kibler Gaming'),
+				'[quote=\'Brian "Brian Kibler" Kibler of Brian Kibler Gaming\']...[/quote]',
+			),
+			array(
+				'...',
+				array('author' => "Brian Kibler Gaming's Brian Kibler"),
+				'[quote="Brian Kibler Gaming\'s Brian Kibler"]...[/quote]',
+			),
+			array(
+				'...',
+				array('author' => "\\\"'"),
+				'[quote="\\\\\\"\'"]...[/quote]',
+			),
+			array(
+				'...',
+				array('author' => 'Lots of doubles """ one single \' one backslash \\'),
+				'[quote=\'Lots of doubles """ one single \\\' one backslash \\\\\']...[/quote]',
+			),
+			array(
+				'...',
+				array('author' => "Lots of singles ''' one double \" one backslash \\"),
+				'[quote="Lots of singles \'\'\' one double \\" one backslash \\\\"]...[/quote]',
+			),
+			array(
+				'...',
+				array('author' => 'Defaults to doublequotes """\'\'\''),
+				'[quote="Defaults to doublequotes \\"\\"\\"\'\'\'"]...[/quote]',
+			),
+			array(
+				'...',
+				array(
+					'author'  => 'user',
+					'post_id' => 123,
+					'url'     => 'http://example.org'
+				),
+				'[quote="user" post_id="123" url="http://example.org"]...[/quote]',
+			),
+		);
+	}
+
+	/**
 	* @dataProvider get_remove_bbcode_tests
 	*/
 	public function test_remove_bbcode($original, $name, $depth, $expected)
author	Tristan Darricau <tristan.darricau@sensiolabs.com>	2015-05-29 15:42:14 +0200
committer	Tristan Darricau <tristan.darricau@sensiolabs.com>	2015-05-29 15:42:14 +0200
commit	f5dbc3b6f269cb3841c20ad0096fcedb3dac7492 (patch)
tree	5ca32d171af32f236d82cbf11cedfe3735c5fa3d
parent	3c3b099f88471e05358fe3c01bb74caac69e89e7 (diff)
parent	64e1824abdb2a9c860e049f10ecc81c051160ff5 (diff)
download	forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.tar forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.tar.gz forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.tar.bz2 forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.tar.xz forums-f5dbc3b6f269cb3841c20ad0096fcedb3dac7492.zip