mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-30 21:40:43 +02:00
Code Issues Releases Wiki Activity

Merge pull request #3579 from s9e/ticket/13803

Browse Source 
[ticket/13803] Implement a generic and scalable way to reparse rich text
This commit is contained in:
Tristan Darricau
2015-06-24 16:58:41 +02:00
parent 6bcf12a558 2a7d26d3de
commit 8747c7a2c1
33 changed files with 2000 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

211
phpBB/phpbb/textreparser/base.php Normal file
View File

@@ -0,0 +1,211 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser;
abstract class base implements reparser_interface
{
/**
* {@inheritdoc}
*/
abstract public function get_max_id();
/**
* Return all records in given range
*
* @param integer $min_id Lower bound
* @param integer $max_id Upper bound
* @return array Array of records
*/
abstract protected function get_records_by_range($min_id, $max_id);
/**
* {@inheritdoc}
*/
abstract protected function save_record(array $record);
/**
* Add fields to given record, if applicable
*
* The enable_* fields are not always saved to the database. Sometimes we need to guess their
* original value based on the text content or possibly other fields
*
* @param array $record Original record
* @return array Complete record
*/
protected function add_missing_fields(array $record)
{
if (!isset($record['enable_bbcode'], $record['enable_smilies'], $record['enable_magic_url']))
{
$record += array(
'enable_bbcode' => $this->guess_bbcodes($record),
'enable_smilies' => $this->guess_smilies($record),
'enable_magic_url' => $this->guess_magic_url($record),
);
}
// Those BBCodes are disabled based on context and user permissions and that value is never
// stored in the database. Here we test whether they were used in the original text.
$bbcodes = array('flash', 'img', 'quote', 'url');
foreach ($bbcodes as $bbcode)
{
$field_name = 'enable_' . $bbcode . '_bbcode';
$record[$field_name] = $this->guess_bbcode($record, $bbcode);
}
// Magic URLs are tied to the URL BBCode, that's why if magic URLs are enabled we make sure
// that the URL BBCode is also enabled
if ($record['enable_magic_url'])
{
$record['enable_url_bbcode'] = true;
}
return $record;
}
/**
* Guess whether given BBCode is in use in given record
*
* @param array $record
* @param string $bbcode
* @return bool
*/
protected function guess_bbcode(array $record, $bbcode)
{
if (!empty($record['bbcode_uid']))
{
// Look for the closing tag, e.g. [/url]
$match = '[/' . $bbcode . ':' . $record['bbcode_uid'];
if (strpos($record['text'], $match) !== false)
{
return true;
}
}
if (substr($record['text'], 0, 2) == '<r')
{
// Look for the closing tag inside of a e element, in an element of the same name, e.g.
// <e>[/url]</e></URL>
$match = '<e>[/' . $bbcode . ']</e></' . strtoupper($bbcode) . '>';
if (strpos($record['text'], $match) !== false)
{
return true;
}
}
return false;
}
/**
* Guess whether any BBCode is in use in given record
*
* @param array $record
* @return bool
*/
protected function guess_bbcodes(array $record)
{
if (!empty($record['bbcode_uid']))
{
// Test whether the bbcode_uid is in use
$match = ':' . $record['bbcode_uid'];
if (strpos($record['text'], $match) !== false)
{
return true;
}
}
if (substr($record['text'], 0, 2) == '<r')
{
// Look for a closing tag inside of an e element
return (bool) preg_match('(<e>\\[/\\w+\\]</e>)', $match);
}
return false;
}
/**
* Guess whether magic URLs are in use in given record
*
* @param array $record
* @return bool
*/
protected function guess_magic_url(array $record)
{
// Look for <!-- m --> or for a URL tag that's not immediately followed by <s>
return (strpos($record['text'], '<!-- m -->') !== false || preg_match('(<URL [^>]++>(?!<s>))', $record['text']));
}
/**
* Guess whether smilies are in use in given record
*
* @param array $record
* @return bool
*/
protected function guess_smilies(array $record)
{
return (strpos($record['text'], '<!-- s') !== false || strpos($record['text'], '<E>') !== false);
}
/**
* {@inheritdoc}
*/
public function reparse_range($min_id, $max_id)
{
foreach ($this->get_records_by_range($min_id, $max_id) as $record)
{
$this->reparse_record($record);
}
}
/**
* Reparse given record
*
* @param array $record Associative array containing the record's data
*/
protected function reparse_record(array $record)
{
$record = $this->add_missing_fields($record);
$flags = ($record['enable_bbcode']) ? OPTION_FLAG_BBCODE : 0;
$flags |= ($record['enable_smilies']) ? OPTION_FLAG_SMILIES : 0;
$flags |= ($record['enable_magic_url']) ? OPTION_FLAG_LINKS : 0;
$unparsed = array_merge(
$record,
generate_text_for_edit($record['text'], $record['bbcode_uid'], $flags)
);
// generate_text_for_edit() and decode_message() actually return the text as HTML. It has to
// be decoded to plain text before it can be reparsed
$text = html_entity_decode($unparsed['text'], ENT_QUOTES, 'UTF-8');
$bitfield = $flags = null;
generate_text_for_storage(
$text,
$unparsed['bbcode_uid'],
$bitfield,
$flags,
$unparsed['enable_bbcode'],
$unparsed['enable_magic_url'],
$unparsed['enable_smilies'],
$unparsed['enable_img_bbcode'],
$unparsed['enable_flash_bbcode'],
$unparsed['enable_quote_bbcode'],
$unparsed['enable_url_bbcode']
);
// Save the new text if it has changed
if ($text !== $record['text'])
{
$record['text'] = $text;
$this->save_record($record);
}
}
}

69
phpBB/phpbb/textreparser/plugins/contact_admin_info.php Normal file
View File

@@ -0,0 +1,69 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class contact_admin_info extends \phpbb\textreparser\base
{
/**
* @var \phpbb\config\db_text
*/
protected $config_text;
/**
* Constructor
*
* @param \phpbb\config\db_text $config_text
*/
public function __construct(\phpbb\config\db_text $config_text)
{
$this->config_text = $config_text;
}
/**
* {@inheritdoc}
*/
public function get_max_id()
{
return 1;
}
/**
* {@inheritdoc}
*/
protected function get_records_by_range($min_id, $max_id)
{
$values = $this->config_text->get_array(array(
'contact_admin_info',
'contact_admin_info_uid',
'contact_admin_info_flags',
));
return array(array(
'id' => 1,
'text' => $values['contact_admin_info'],
'bbcode_uid' => $values['contact_admin_info_uid'],
'enable_bbcode' => $values['contact_admin_info_flags'] & OPTION_FLAG_BBCODE,
'enable_magic_url' => $values['contact_admin_info_flags'] & OPTION_FLAG_LINKS,
'enable_smilies' => $values['contact_admin_info_flags'] & OPTION_FLAG_SMILIES,
));
}
/**
* {@inheritdoc}
*/
protected function save_record(array $record)
{
$this->config_text->set('contact_admin_info', $record['text']);
}
}

37
phpBB/phpbb/textreparser/plugins/forum_description.php Normal file
View File

@@ -0,0 +1,37 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class forum_description extends \phpbb\textreparser\row_based_plugin
{
/**
* {@inheritdoc}
*/
public function get_columns()
{
return array(
'id' => 'forum_id',
'text' => 'forum_desc',
'bbcode_uid' => 'forum_desc_uid',
);
}
/**
* {@inheritdoc}
*/
public function get_table_name()
{
return FORUMS_TABLE;
}
}

37
phpBB/phpbb/textreparser/plugins/forum_rules.php Normal file
View File

@@ -0,0 +1,37 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class forum_rules extends \phpbb\textreparser\row_based_plugin
{
/**
* {@inheritdoc}
*/
public function get_columns()
{
return array(
'id' => 'forum_id',
'text' => 'forum_rules',
'bbcode_uid' => 'forum_rules_uid',
);
}
/**
* {@inheritdoc}
*/
public function get_table_name()
{
return FORUMS_TABLE;
}
}

37
phpBB/phpbb/textreparser/plugins/group_description.php Normal file
View File

@@ -0,0 +1,37 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class group_description extends \phpbb\textreparser\row_based_plugin
{
/**
* {@inheritdoc}
*/
public function get_columns()
{
return array(
'id' => 'group_id',
'text' => 'group_desc',
'bbcode_uid' => 'group_desc_uid',
);
}
/**
* {@inheritdoc}
*/
public function get_table_name()
{
return GROUPS_TABLE;
}
}

40
phpBB/phpbb/textreparser/plugins/pm_text.php Normal file
View File

@@ -0,0 +1,40 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class pm_text extends \phpbb\textreparser\row_based_plugin
{
/**
* {@inheritdoc}
*/
public function get_columns()
{
return array(
'id' => 'msg_id',
'enable_bbcode' => 'enable_bbcode',
'enable_smilies' => 'enable_smilies',
'enable_magic_url' => 'enable_magic_url',
'text' => 'message_text',
'bbcode_uid' => 'bbcode_uid',
);
}
/**
* {@inheritdoc}
*/
public function get_table_name()
{
return PRIVMSGS_TABLE;
}
}

74
phpBB/phpbb/textreparser/plugins/poll_option.php Normal file
View File

@@ -0,0 +1,74 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class poll_option extends \phpbb\textreparser\base
{
/**
* @var \phpbb\db\driver\driver_interface
*/
protected $db;
/**
* Constructor
*
* @param \phpbb\db\driver\driver_interface $db Database connection
*/
public function __construct(\phpbb\db\driver\driver_interface $db)
{
$this->db = $db;
}
/**
* {@inheritdoc}
*/
public function get_max_id()
{
$sql = 'SELECT MAX(topic_id) AS max_id FROM ' . POLL_OPTIONS_TABLE;
$result = $this->db->sql_query($sql);
$max_id = (int) $this->db->sql_fetchfield('max_id');
$this->db->sql_freeresult($result);
return $max_id;
}
/**
* {@inheritdoc}
*/
protected function get_records_by_range($min_id, $max_id)
{
$sql = 'SELECT o.topic_id, o.poll_option_id, o.poll_option_text AS text, p.bbcode_uid
FROM ' . POLL_OPTIONS_TABLE . ' o, ' . TOPICS_TABLE . ' t, ' . POSTS_TABLE . ' p
WHERE o.topic_id BETWEEN ' . $min_id . ' AND ' . $max_id .'
AND t.topic_id = o.topic_id
AND p.post_id = t.topic_first_post_id';
$result = $this->db->sql_query($sql);
$records = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
return $records;
}
/**
* {@inheritdoc}
*/
protected function save_record(array $record)
{
$sql = 'UPDATE ' . POLL_OPTIONS_TABLE . "
SET poll_option_text = '" . $this->db->sql_escape($record['text']) . "'
WHERE topic_id = " . $record['topic_id'] . '
AND poll_option_id = ' . $record['poll_option_id'];
$this->db->sql_query($sql);
}
}

50
phpBB/phpbb/textreparser/plugins/poll_title.php Normal file
View File

@@ -0,0 +1,50 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class poll_title extends \phpbb\textreparser\row_based_plugin
{
/**
* {@inheritdoc}
*/
public function get_columns()
{
return array(
'id' => 'topic_id',
'text' => 'poll_title',
);
}
/**
* {@inheritdoc}
*/
protected function get_records_by_range_query($min_id, $max_id)
{
$sql = 'SELECT t.topic_id AS id, t.poll_title AS text, p.bbcode_uid
FROM ' . TOPICS_TABLE . ' t, ' . POSTS_TABLE . ' p
WHERE t.topic_id BETWEEN ' . $min_id . ' AND ' . $max_id .'
AND t.poll_max_options > 0
AND p.post_id = t.topic_first_post_id';
return $sql;
}
/**
* {@inheritdoc}
*/
public function get_table_name()
{
return TOPICS_TABLE;
}
}

40
phpBB/phpbb/textreparser/plugins/post_text.php Normal file
View File

@@ -0,0 +1,40 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class post_text extends \phpbb\textreparser\row_based_plugin
{
/**
* {@inheritdoc}
*/
public function get_columns()
{
return array(
'id' => 'post_id',
'enable_bbcode' => 'enable_bbcode',
'enable_smilies' => 'enable_smilies',
'enable_magic_url' => 'enable_magic_url',
'text' => 'post_text',
'bbcode_uid' => 'bbcode_uid',
);
}
/**
* {@inheritdoc}
*/
public function get_table_name()
{
return POSTS_TABLE;
}
}

73
phpBB/phpbb/textreparser/plugins/user_signature.php Normal file
View File

@@ -0,0 +1,73 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser\plugins;
class user_signature extends \phpbb\textreparser\row_based_plugin
{
/**
* @var array Bit numbers used for user options
* @see \phpbb\user
*/
protected $keyoptions;
/**
* {@inheritdoc}
*/
protected function add_missing_fields(array $row)
{
if (!isset($this->keyoptions))
{
$this->save_keyoptions();
}
$options = $row['user_options'];
$row += array(
'enable_bbcode' => phpbb_optionget($this->keyoptions['sig_bbcode'], $options),
'enable_smilies' => phpbb_optionget($this->keyoptions['sig_smilies'], $options),
'enable_magic_url' => phpbb_optionget($this->keyoptions['sig_links'], $options),
);
return parent::add_missing_fields($row);
}
/**
* {@inheritdoc}
*/
public function get_columns()
{
return array(
'id' => 'user_id',
'text' => 'user_sig',
'bbcode_uid' => 'user_sig_bbcode_uid',
'user_options' => 'user_options',
);
}
/**
* {@inheritdoc}
*/
public function get_table_name()
{
return USERS_TABLE;
}
/**
* Save the keyoptions var from \phpbb\user
*/
protected function save_keyoptions()
{
$class_vars = get_class_vars('phpbb\\user');
$this->keyoptions = $class_vars['keyoptions'];
}
}

32
phpBB/phpbb/textreparser/reparser_interface.php Normal file
View File

@@ -0,0 +1,32 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser;
interface reparser_interface
{
/**
* Return the highest ID for all existing records
*
* @return integer
*/
public function get_max_id();
/**
* Reparse all records in given range
*
* @param integer $min_id Lower bound
* @param integer $max_id Upper bound
*/
public function reparse_range($min_id, $max_id);
}

117
phpBB/phpbb/textreparser/row_based_plugin.php Normal file
View File

@@ -0,0 +1,117 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\textreparser;
abstract class row_based_plugin extends base
{
/**
* @var \phpbb\db\driver\driver_interface
*/
protected $db;
/**
* Constructor
*
* @param \phpbb\db\driver\driver_interface $db Database connection
*/
public function __construct(\phpbb\db\driver\driver_interface $db)
{
$this->db = $db;
}
/**
* Return the name of the column that correspond to each field
*
* @return array
*/
abstract public function get_columns();
/**
* Return the name of the table used by this plugin
*
* @return string
*/
abstract public function get_table_name();
/**
* {@inheritdoc}
*/
public function get_max_id()
{
$columns = $this->get_columns();
$sql = 'SELECT MAX(' . $columns['id'] . ') AS max_id FROM ' . $this->get_table_name();
$result = $this->db->sql_query($sql);
$max_id = (int) $this->db->sql_fetchfield('max_id');
$this->db->sql_freeresult($result);
return $max_id;
}
/**
* {@inheritdoc}
*/
protected function get_records_by_range($min_id, $max_id)
{
$sql = $this->get_records_by_range_query($min_id, $max_id);
$result = $this->db->sql_query($sql);
$records = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
return $records;
}
/**
* Generate the query that retrieves all records for given range
*
* @param integer $min_id Lower bound
* @param integer $max_id Upper bound
* @return string SQL query
*/
protected function get_records_by_range_query($min_id, $max_id)
{
$columns = $this->get_columns();
$fields = array();
foreach ($columns as $field_name => $column_name)
{
if ($column_name === $field_name)
{
$fields[] = $column_name;
}
else
{
$fields[] = $column_name . ' AS ' . $field_name;
}
}
$sql = 'SELECT ' . implode(', ', $fields) . '
FROM ' . $this->get_table_name() . '
WHERE ' . $columns['id'] . ' BETWEEN ' . $min_id . ' AND ' . $max_id;
return $sql;
}
/**
* {@inheritdoc}
*/
protected function save_record(array $record)
{
$columns = $this->get_columns();
$sql = 'UPDATE ' . $this->get_table_name() . '
SET ' . $columns['text'] . " = '" . $this->db->sql_escape($record['text']) . "'
WHERE " . $columns['id'] . ' = ' . $record['id'];
$this->db->sql_query($sql);
}
}