Cleanup BBCode class

Signed-off-by: Yuriy Pikhtarev <iglix@me.com>
This commit is contained in:
Yuriy Pikhtarev 2018-06-26 19:44:20 +03:00
commit 201720c22f
No known key found for this signature in database
GPG key ID: 3A9B5A757B48ECC6
3 changed files with 106 additions and 140 deletions

View file

@ -465,11 +465,10 @@ $bb_cfg['max_search_words_per_post'] = 200;
$bb_cfg['search_min_word_len'] = 3; $bb_cfg['search_min_word_len'] = 3;
$bb_cfg['search_max_word_len'] = 35; $bb_cfg['search_max_word_len'] = 35;
$bb_cfg['limit_max_search_results'] = false; $bb_cfg['limit_max_search_results'] = false;
$bb_cfg['spam_filter_file_path'] = ''; // BB_PATH .'/misc/spam_filter_words.txt';
// Posting // Posting
$bb_cfg['prevent_multiposting'] = true; // replace "reply" with "edit last msg" if user (not admin or mod) is last topic poster $bb_cfg['prevent_multiposting'] = true; // replace "reply" with "edit last msg" if user (not admin or mod) is last topic poster
$bb_cfg['max_smilies'] = 10; // Максимальное число смайлов в посте (0 - без ограничения) $bb_cfg['max_smilies'] = 25; // Максимальное число смайлов в посте (0 - без ограничения)
// PM // PM
$bb_cfg['privmsg_disable'] = false; // отключить систему личных сообщений на форуме $bb_cfg['privmsg_disable'] = false; // отключить систему личных сообщений на форуме

View file

@ -11,10 +11,10 @@ if (!defined('BB_ROOT')) {
die(basename(__FILE__)); die(basename(__FILE__));
} }
$datastore->enqueue(array( $datastore->enqueue([
'smile_replacements', 'smile_replacements',
'cat_forums', 'cat_forums',
)); ]);
$page_cfg['include_bbcode_js'] = true; $page_cfg['include_bbcode_js'] = true;
@ -23,7 +23,7 @@ $page_cfg['include_bbcode_js'] = true;
// //
function get_bbcode_tpl() function get_bbcode_tpl()
{ {
$bbcode_tpl = array(); $bbcode_tpl = [];
// Quote // Quote
$bbcode_tpl['quote_open'] = <<<HTML $bbcode_tpl['quote_open'] = <<<HTML
@ -120,7 +120,7 @@ function generate_smilies($mode)
if ($sql = $data['smile']) { if ($sql = $data['smile']) {
$num_smilies = 0; $num_smilies = 0;
$rowset = array(); $rowset = [];
foreach ($sql as $row) { foreach ($sql as $row) {
if (empty($rowset[$row['smile_url']])) { if (empty($rowset[$row['smile_url']])) {
$rowset[$row['smile_url']]['code'] = addslashes($row['code']); $rowset[$row['smile_url']]['code'] = addslashes($row['code']);
@ -130,7 +130,6 @@ function generate_smilies($mode)
} }
if ($num_smilies) { if ($num_smilies) {
$smilies_count = ($mode == 'inline') ? min(19, $num_smilies) : $num_smilies;
$smilies_split_row = ($mode == 'inline') ? $inline_columns - 1 : $window_columns - 1; $smilies_split_row = ($mode == 'inline') ? $inline_columns - 1 : $window_columns - 1;
$s_colspan = 0; $s_colspan = 0;
@ -139,14 +138,14 @@ function generate_smilies($mode)
foreach ($rowset as $smile_url => $data) { foreach ($rowset as $smile_url => $data) {
if (!$col) { if (!$col) {
$template->assign_block_vars('smilies_row', array()); $template->assign_block_vars('smilies_row', []);
} }
$template->assign_block_vars('smilies_row.smilies_col', array( $template->assign_block_vars('smilies_row.smilies_col', [
'SMILEY_CODE' => $data['code'], 'SMILEY_CODE' => $data['code'],
'SMILEY_IMG' => $bb_cfg['smilies_path'] . '/' . $smile_url, 'SMILEY_IMG' => $bb_cfg['smilies_path'] . '/' . $smile_url,
'SMILEY_DESC' => $data['emoticon'], 'SMILEY_DESC' => $data['emoticon'],
)); ]);
$s_colspan = max($s_colspan, $col + 1); $s_colspan = max($s_colspan, $col + 1);
@ -162,17 +161,17 @@ function generate_smilies($mode)
} }
if ($mode == 'inline' && $num_smilies > $inline_rows * $inline_columns) { if ($mode == 'inline' && $num_smilies > $inline_rows * $inline_columns) {
$template->assign_block_vars('switch_smilies_extra', array()); $template->assign_block_vars('switch_smilies_extra', []);
$template->assign_vars(array( $template->assign_vars([
'U_MORE_SMILIES' => POSTING_URL . "?mode=smilies", 'U_MORE_SMILIES' => POSTING_URL . "?mode=smilies",
)); ]);
} }
$template->assign_vars(array( $template->assign_vars([
'PAGE_TITLE' => $lang['EMOTICONS'], 'PAGE_TITLE' => $lang['EMOTICONS'],
'S_SMILIES_COLSPAN' => $s_colspan, 'S_SMILIES_COLSPAN' => $s_colspan,
)); ]);
} }
} }
@ -345,9 +344,6 @@ function extract_search_words($text)
// Filter out characters like ^, $, &, change "it's" to "its" // Filter out characters like ^, $, &, change "it's" to "its"
$text = preg_replace('#[.,:;]#u', ' ', $text); $text = preg_replace('#[.,:;]#u', ' ', $text);
// short & long words
// $text = preg_replace('#(?<=^|\s)(\S{1,'.$min_word_len.'}|\S{'.$max_word_len.',}|\W*)(?=$|\s)#u', ' ', $text);
// Trim 1+ spaces to one space and split this string into unique words // Trim 1+ spaces to one space and split this string into unique words
$text = array_unique(explode(' ', str_compact($text))); $text = array_unique(explode(' ', str_compact($text)));
@ -361,7 +357,6 @@ function extract_search_words($text)
$text = $text_out; $text = $text_out;
if (count($text) > $max_words_count) { if (count($text) > $max_words_count) {
# shuffle($text);
$text = array_splice($text, 0, $max_words_count); $text = array_splice($text, 0, $max_words_count);
} }
@ -387,7 +382,6 @@ function add_search_words($post_id, $post_message, $topic_title = '', $only_retu
} }
/** /**
* @deprecated bb_code
* Dirty class removed from here since 2.2.0 * Dirty class removed from here since 2.2.0
* To add new bbcodes see at src/Legacy/BBCode.php * To add new bbcodes see at src/Legacy/BBCode.php
*/ */

View file

@ -15,10 +15,13 @@ namespace TorrentPier\Legacy;
*/ */
class BBCode class BBCode
{ {
public $tpl = []; // шаблоны для замены тегов /** @var array $tpl Replacements for some code elements */
public $smilies; // смайлы public $tpl = [];
public $found_spam; // найденные спам "слова"
public $del_words = []; // см. get_words_rate() /** @var array $smilies Replacements for smilies */
public $smilies;
/** @var array $tidy_cfg Tidy preprocessor configuration */
public $tidy_cfg = [ public $tidy_cfg = [
'drop-empty-paras' => false, 'drop-empty-paras' => false,
'fix-uri' => false, 'fix-uri' => false,
@ -37,6 +40,8 @@ class BBCode
'show-warnings' => false, 'show-warnings' => false,
'wrap' => 0, 'wrap' => 0,
]; ];
/** @var array $block_tags Define some elements as block-processed */
public $block_tags = [ public $block_tags = [
'align', 'align',
'br', 'br',
@ -47,6 +52,7 @@ class BBCode
'quote', 'quote',
'spoiler', 'spoiler',
]; ];
public $preg = []; public $preg = [];
public $str = []; public $str = [];
public $preg_search = []; public $preg_search = [];
@ -65,9 +71,9 @@ class BBCode
} }
/** /**
* init_replacements * Initialize replacements for elements
*/ */
public function init_replacements() private function init_replacements(): void
{ {
$tpl = $this->tpl; $tpl = $this->tpl;
$img_exp = '(https?:)?//[^\s\?&;=\#\"<>]+?\.(jpg|jpeg|gif|png)([a-z0-9/?&%;][^\[\]]*)?'; $img_exp = '(https?:)?//[^\s\?&;=\#\"<>]+?\.(jpg|jpeg|gif|png)([a-z0-9/?&%;][^\[\]]*)?';
@ -126,48 +132,21 @@ class BBCode
} }
/** /**
* bbcode2html * Convert bbcodes to html. Text must be prepared with htmlCHR
*
* @param string $text
* *
* @param string $text должен быть уже обработан htmlCHR($text, false, ENT_NOQUOTES)
* @return string * @return string
*/ */
public function bbcode2html($text) public function bbcode2html($text): string
{ {
global $bb_cfg; global $bb_cfg;
$text = " $text "; $text = self::clean_up($text);
$text = static::clean_up($text); $text = $this->parse($text);
$text = $this->spam_filter($text);
// Tag parse
if (strpos($text, '[') !== false) {
// [code]
$text = preg_replace_callback('#(\s*)\[code\](.+?)\[/code\](\s*)#s', [&$this, 'code_callback'], $text);
// Escape tags inside tiltes in [quote="tilte"]
$text = preg_replace_callback('#(\[(quote|spoiler)=")(.+?)("\])#', [&$this, 'escape_tiltes_callback'], $text);
// [url]
$url_exp = '[\w\#!$%&~/.\-;:=,?@а-яА-Я()\[\]+]+?';
$text = preg_replace_callback("#\[url\]((?:https?://)?$url_exp)\[/url\]#isu", [&$this, 'url_callback'], $text);
$text = preg_replace_callback("#\[url\](www\.$url_exp)\[/url\]#isu", [&$this, 'url_callback'], $text);
$text = preg_replace_callback("#\[url=((?:https?://)?$url_exp)\]([^?\n\t].*?)\[/url\]#isu", [&$this, 'url_callback'], $text);
$text = preg_replace_callback("#\[url=(www\.$url_exp)\]([^?\n\t].*?)\[/url\]#isu", [&$this, 'url_callback'], $text);
// Normalize block level tags wrapped with new lines
$block_tags = implode('|', $this->block_tags);
$text = str_replace("\n\n[hr]\n\n", '[br][hr][br]', $text);
$text = preg_replace("#(\s*)(\[/?($block_tags)(.*?)\])(\s*)#", '$2', $text);
// Tag replacements
$text = preg_replace($this->preg_search, $this->preg_repl, $text);
$text = str_replace($this->str_search, $this->str_repl, $text);
}
$text = $this->make_clickable($text); $text = $this->make_clickable($text);
$text = $this->smilies_pass($text); $text = $this->smilies_pass($text);
$text = $this->new_line2html($text); $text = $this->new_line2html($text);
$text = trim($text);
if ($bb_cfg['tidy_post']) { if ($bb_cfg['tidy_post']) {
$text = $this->tidy($text); $text = $this->tidy($text);
@ -177,84 +156,68 @@ class BBCode
} }
/** /**
* Clean up * Parse elements in the text
* *
* @param string $text * @param string $text
*
* @return string * @return string
*/ */
public static function clean_up($text) private function parse($text): string
{
// Tag parse
if (strpos($text, '[') === false) {
return $text;
}
// [code]
$text = preg_replace_callback('#(\s*)\[code\](.+?)\[/code\](\s*)#s', [&$this, 'code_callback'], $text);
// Escape tags inside titles in [quote="tilte"]
$text = preg_replace_callback('#(\[(quote|spoiler)=")(.+?)("\])#', [&$this, 'escape_titles_callback'], $text);
// [url]
$url_exp = '[\w\#!$%&~/.\-;:=,?@а-яА-Я()\[\]+]+?';
$text = preg_replace_callback("#\[url\]((?:https?://)?$url_exp)\[/url\]#isu", [&$this, 'url_callback'], $text);
$text = preg_replace_callback("#\[url\](www\.$url_exp)\[/url\]#isu", [&$this, 'url_callback'], $text);
$text = preg_replace_callback("#\[url=((?:https?://)?$url_exp)\]([^?\n\t].*?)\[/url\]#isu", [&$this, 'url_callback'], $text);
$text = preg_replace_callback("#\[url=(www\.$url_exp)\]([^?\n\t].*?)\[/url\]#isu", [&$this, 'url_callback'], $text);
// Normalize block level tags wrapped with new lines
$block_tags = implode('|', $this->block_tags);
$text = str_replace("\n\n[hr]\n\n", '[br][hr][br]', $text);
$text = preg_replace("#(\s*)(\[/?($block_tags)(.*?)\])(\s*)#", '$2', $text);
// Tag replacements
$text = preg_replace($this->preg_search, $this->preg_repl, $text);
$text = str_replace($this->str_search, $this->str_repl, $text);
return $text;
}
/**
* Clean up test from trailing spaces and more
*
* @param string $text
*
* @return string
*/
public static function clean_up($text): string
{ {
$text = trim($text); $text = trim($text);
$text = str_replace("\r", '', $text); $text = str_replace("\r", '', $text);
$text = preg_replace('#[ \t]+$#m', '', $text); // trailing spaces $text = preg_replace('#[ \t]+$#m', '', $text);
$text = preg_replace('#\n{3,}#', "\n\n", $text); $text = preg_replace('#\n{3,}#', "\n\n", $text);
return $text; return $text;
} }
/** /**
* Spam filter * Callback to [code]
*
* @param string $text
* @return string
*/
private function spam_filter($text)
{
global $bb_cfg;
static $spam_words = null;
static $spam_replace = ' СПАМ';
if (isset($this)) {
$found_spam =& $this->found_spam;
}
// set $spam_words and $spam_replace
if (!$bb_cfg['spam_filter_file_path']) {
return $text;
}
if (null === $spam_words) {
$spam_words = file_get_contents($bb_cfg['spam_filter_file_path']);
$spam_words = strtolower($spam_words);
$spam_words = explode("\n", $spam_words);
}
$found_spam = [];
$msg_decoded = $text;
$msg_decoded = html_entity_decode($msg_decoded);
$msg_decoded = urldecode($msg_decoded);
$msg_decoded = str_replace('&', ' &', $msg_decoded);
$msg_search = strtolower($msg_decoded);
foreach ($spam_words as $spam_str) {
if (!$spam_str = trim($spam_str)) {
continue;
}
if (strpos($msg_search, $spam_str) !== false) {
$found_spam[] = $spam_str;
}
}
if ($found_spam) {
$spam_exp = [];
foreach ($found_spam as $keyword) {
$spam_exp[] = preg_quote($keyword, '/');
}
$spam_exp = implode('|', $spam_exp);
$text = preg_replace("/($spam_exp)(\S*)/i", $spam_replace, $msg_decoded);
$text = htmlCHR($text, false, ENT_NOQUOTES);
}
return $text;
}
/**
* [code] callback
* *
* @param string $m * @param string $m
*
* @return string * @return string
*/ */
public function code_callback($m) private function code_callback($m): string
{ {
$code = trim($m[2]); $code = trim($m[2]);
$code = str_replace(' ', '&nbsp; ', $code); $code = str_replace(' ', '&nbsp; ', $code);
@ -265,12 +228,13 @@ class BBCode
} }
/** /**
* [url] callback * Callback to [url]
* *
* @param string $m * @param string $m
*
* @return string * @return string
*/ */
public function url_callback($m) private function url_callback($m): string
{ {
global $bb_cfg; global $bb_cfg;
@ -291,12 +255,13 @@ class BBCode
} }
/** /**
* Escape tags inside titles in [quote="title"] * Callback to escape titles in block elements
* *
* @param string $m * @param string $m
*
* @return string * @return string
*/ */
public function escape_tiltes_callback($m) private function escape_titles_callback($m): string
{ {
$tilte = substr($m[3], 0, 250); $tilte = substr($m[3], 0, 250);
$tilte = str_replace(['[', ']', ':', ')', '"'], ['&#91;', '&#93;', '&#58;', '&#41;', '&#34;'], $tilte); $tilte = str_replace(['[', ']', ':', ')', '"'], ['&#91;', '&#93;', '&#58;', '&#41;', '&#34;'], $tilte);
@ -306,12 +271,13 @@ class BBCode
} }
/** /**
* Make clickable * Callback to make text clickable
*
* @param string $text
* *
* @param $text
* @return string * @return string
*/ */
public function make_clickable($text) private function make_clickable($text): string
{ {
$url_regexp = "# $url_regexp = "#
(?<![\"'=]) (?<![\"'=])
@ -335,16 +301,17 @@ class BBCode
// Remove our padding.. // Remove our padding..
$ret = substr(substr($ret, 0, -1), 1); $ret = substr(substr($ret, 0, -1), 1);
return ($ret); return $ret;
} }
/** /**
* Make url clickable * Callback to make URL clickable
* *
* @param string $m * @param string $m
*
* @return string * @return string
*/ */
public function make_url_clickable_callback($m) private function make_url_clickable_callback($m): string
{ {
global $bb_cfg; global $bb_cfg;
@ -362,33 +329,38 @@ class BBCode
} }
/** /**
* Add smilies * Replace smilies to images in text
* *
* @param string $text * @param string $text
*
* @return string * @return string
*/ */
public function smilies_pass($text) private function smilies_pass($text): string
{ {
global $datastore; global $bb_cfg, $datastore;
if (null === $this->smilies) { if (null === $this->smilies) {
$this->smilies = $datastore->get('smile_replacements'); $this->smilies = $datastore->get('smile_replacements');
} }
if ($this->smilies) { if ($this->smilies) {
$parsed_text = preg_replace($this->smilies['orig'], $this->smilies['repl'], $text, 101, $smilies_cnt); /** @noinspection NestedPositiveIfStatementsInspection */
$text = ($smilies_cnt <= 100) ? $parsed_text : $text; if ($parsed_text = preg_replace($this->smilies['orig'], $this->smilies['repl'], $text, 101, $smilies_cnt)) {
return (($smilies_cnt <= $bb_cfg['max_smilies']) && $bb_cfg['max_smilies'] > 0) ? $parsed_text : $text;
}
} }
return $text; return $text;
} }
/** /**
* Replace new line code to html * Replace text new line to html
* *
* @param string $text * @param string $text
*
* @return string * @return string
*/ */
public function new_line2html($text) private function new_line2html($text): string
{ {
$text = preg_replace('#\n{2,}#', '<span class="post-br"><br /></span>', $text); $text = preg_replace('#\n{2,}#', '<span class="post-br"><br /></span>', $text);
$text = str_replace("\n", '<br />', $text); $text = str_replace("\n", '<br />', $text);
@ -396,12 +368,13 @@ class BBCode
} }
/** /**
* Tidy * Prepare post text with tidy preprocessor
* *
* @param string $text * @param string $text
*
* @return string * @return string
*/ */
public function tidy($text) private function tidy($text): string
{ {
$text = tidy_repair_string($text, $this->tidy_cfg, 'utf8'); $text = tidy_repair_string($text, $this->tidy_cfg, 'utf8');
return $text; return $text;