Codes::setForPrinting() - Code Metrics - Inspection of "[wip] Refactor the menu" - elkarte/Elkarte - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — development (#3050)

by John
created 2018-01-19 00:42 UTC
Codes::setForPrinting() A

↳ Parent: Codes
Complexity

Conditions	2
Paths	2
Size

Total Lines	22
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes
Metric	Value
cc	2
eloc	10
nc	2
nop	0
dl	0
loc	22
ccs	0
cts	10
cp	0
crap	6
rs	9.2
c	0
b	0
f	0
<?php

/**
 *
 * @name      ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * This file contains code covered by:
 * copyright:	2011 Simple Machines (http://www.simplemachines.org)
 * license:		BSD, See included LICENSE.TXT for terms and conditions.
 *
 * @version 2.0 dev
 *
 */

namespace BBC;

// @todo add attribute for TEST_PARAM_STRING and TEST_CONTENT so people can test the content
// @todo change ATTR_TEST to be able to test the entire message with the current offset

/**
 * Class Codes
 *
 * @package BBC
 */
class Codes
{
	/** the tag's name - must be lowercase */
	const ATTR_TAG = 1;

	/** One of self::TYPE_* */
	const ATTR_TYPE = 2;

	/**
	 * An optional array of parameters, for the form
	 * [tag abc=123]content[/tag].  The array is an associative array
	 * where the keys are the parameter names, and the values are an
	 * array which *may* contain any of self::PARAM_ATTR_*
	 */
	const ATTR_PARAM = 3;

	/**
	 * A regular expression to test immediately after the tag's
	 * '=', ' ' or ']'.  Typically, should have a \] at the end.
	 * Optional.
	 */
	const ATTR_TEST = 4;

	/**
	 * Only available for unparsed_content, closed, unparsed_commas_content, and unparsed_equals_content.
	 * $1 is replaced with the content of the tag.
	 * Parameters are replaced in the form {param}.
	 * For unparsed_commas_content, $2, $3, ..., $n are replaced.
	 */
	const ATTR_CONTENT = 5;

	/**
	 * Only when content is not used, to go before any content.
	 * For unparsed_equals, $1 is replaced with the value.
	 * For unparsed_commas, $1, $2, ..., $n are replaced.
	 */
	const ATTR_BEFORE = 6;

	/**
	 * Similar to before in every way, except that it is used when the tag is closed.
	 */
	const ATTR_AFTER = 7;

	/**
	 * Used in place of content when the tag is disabled.
	 * For closed, default is '', otherwise it is '$1' if block_level is false, '<div>$1</div>' elsewise.
	 */
	const ATTR_DISABLED_CONTENT = 8;

	/**
	 * Used in place of before when disabled.
	 * Defaults to '<div>' if block_level, '' if not.
	 */
	const ATTR_DISABLED_BEFORE = 9;

	/**
	 * Used in place of after when disabled.
	 * Defaults to '</div>' if block_level, '' if not.
	 */
	const ATTR_DISABLED_AFTER = 10;

	/**
	 * Set to true the tag is a "block level" tag, similar to HTML.
	 * Block level tags cannot be nested inside tags that are not block level, and will not be implicitly closed as easily.
	 * One break following a block level tag may also be removed.
	 */
	const ATTR_BLOCK_LEVEL = 11;

	/**
	 * Trim the whitespace after the opening tag or the closing tag or both.
	 * One of self::TRIM_*
	 * Optional
	 */
	const ATTR_TRIM = 12;

	/**
	 * Except when type is missing or 'closed', a callback to validate the data as $data.
	 * Depending on the tag's type, $data may be a string or an array of strings (corresponding to the replacement.)
	 */
	const ATTR_VALIDATE = 13;

	/**
	 * When type is unparsed_equals or parsed_equals only, may be not set,
	 * 'optional', or 'required' corresponding to if the content may be quoted.
	 * This allows the parser to read [tag="abc]def[esdf]"] properly.
	 */
	const ATTR_QUOTED = 14;

	/**
	 * An array of tag names, or not set.
	 * If set, the enclosing tag *must* be one of the listed tags, or parsing won't	occur.
	 */
	const ATTR_REQUIRE_PARENTS = 15;

	/**
	 * similar to require_parents, if set children won't be parsed if they are not in the list.
	 */
	const ATTR_REQUIRE_CHILDREN = 16;

	/**
	 * Similar to, but very different from, require_parents.
	 * If it is set the listed tags will not be parsed inside the tag.
	 */
	const ATTR_DISALLOW_PARENTS = 17;

	/**
	 * Similar to, but very different from, require_children.
	 * If it is set the listed tags will not be parsed inside the tag.
	 */
	const ATTR_DISALLOW_CHILDREN = 18;

	/**
	 * When ATTR_DISALLOW_PARENTS is used, this gets put before the tag.
	 */
	const ATTR_DISALLOW_BEFORE = 19;

	/**
	 * * When ATTR_DISALLOW_PARENTS is used, this gets put after the tag.
	 */
	const ATTR_DISALLOW_AFTER = 20;

	/**
	 * an array restricting what BBC can be in the parsed_equals parameter, if desired.
	 */
	const ATTR_PARSED_TAGS_ALLOWED = 21;

	/**
	 * (bool) Turn uris like http://www.google.com in to links
	 */
	const ATTR_AUTOLINK = 22;

	/**
	 * The length of the tag
	 */
	const ATTR_LENGTH = 23;

	/**
	 * Whether the tag is disabled
	 */
	const ATTR_DISABLED = 24;

	/**
	 * If the message contains a code with this, the message should not be cached
	 */
	const ATTR_NO_CACHE = 25;

	/** [tag]parsed content[/tag] */
	const TYPE_PARSED_CONTENT = 0;

	/** [tag=xyz]parsed content[/tag] */
	const TYPE_UNPARSED_EQUALS = 1;

	/** [tag=parsed data]parsed content[/tag] */
	const TYPE_PARSED_EQUALS = 2;

	/** [tag]unparsed content[/tag] */
	const TYPE_UNPARSED_CONTENT = 3;

	/** [tag], [tag/], [tag /] */
	const TYPE_CLOSED = 4;

	/** [tag=1,2,3]parsed content[/tag] */
	const TYPE_UNPARSED_COMMAS = 5;

	/** [tag=1,2,3]unparsed content[/tag] */
	const TYPE_UNPARSED_COMMAS_CONTENT = 6;

	/** [tag=...]unparsed content[/tag] */
	const TYPE_UNPARSED_EQUALS_CONTENT = 7;

	/** [*] */
	const TYPE_ITEMCODE = 8;

	/** a regular expression to validate and match the value. */
	const PARAM_ATTR_MATCH = 0;
	/** true if the value should be quoted. */
	const PARAM_ATTR_QUOTED = 1;
	/** callback to evaluate on the data, which is $data. */
	const PARAM_ATTR_VALIDATE = 2;
	/** a string in which to replace $1 with the data. Either it or validate may be used, not both. */
	const PARAM_ATTR_VALUE = 3;
	/** true if the parameter is optional. */
	const PARAM_ATTR_OPTIONAL = 4;

	/**  */
	const TRIM_NONE = 0;
	/**  */
	const TRIM_INSIDE = 1;
	/**  */
	const TRIM_OUTSIDE = 2;
	/**  */
	const TRIM_BOTH = 3;

	// These are mainly for *ATTR_QUOTED since there are 3 options
	const OPTIONAL = -1;
	const NONE = 0;
	const REQUIRED = 1;

	/**
	 * An array of self::ATTR_*
	 * ATTR_TAG and ATTR_TYPE are required for every tag.
	 * The rest of the attributes depend on the type and other options.
	 */
	protected $bbc = array();
	protected $itemcodes = array();
	protected $additional_bbc = array();
	protected $disabled = array();
	protected $parsing_codes = array();

	/**
	 * Codes constructor.
	 *
	 * @param array $tags
	 * @param array $disabled
	 */
	public function __construct(array $tags = array(), array $disabled = array())
	{
		$this->additional_bbc = $tags;

		foreach ($disabled as $tag)
		{
			$this->disable($tag);
		}

		foreach ($tags as $tag)
		{
			$this->add($tag);
		}

		$this->bbc = $this->getDefault();
	}

	/**
	 * Add a code
	 *
	 * @param array $code
	 */
	public function add(array $code)
	{

// 		$first_char = $code[self::ATTR_TAG][0];

// 		if (!isset($this->bbc[$first_char]))
// 		{
// 			$this->bbc[$first_char] = array();
// 		}

		$this->bbc[] = $code;
	}

	/**
	 * Remove a BBC code from the render stack
	 *
	 * @param $tag
	 */
	public function remove($tag)
	{
		foreach ($this->bbc as $k => $v)
		{
			if ($tag === $v[self::ATTR_TAG])
			{
				unset($this->bbc[$k]);
			}
		}
	}

	/**
	 * Load all of the default BBC codes
	 *
	 * @return mixed
	 */
	public function getDefault()
	{
		global $modSettings, $txt, $scripturl;

		// This array can be arranged in any order.
		return array_merge($this->bbc, array(
			array(
				self::ATTR_TAG => 'abbr',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_TEST => '([A-Za-z][A-Za-z0-9_\-\s&;]*)',
				self::ATTR_BEFORE => '<abbr title="$1">',
				self::ATTR_AFTER => '</abbr>',
				self::ATTR_QUOTED => self::OPTIONAL,
				self::ATTR_DISABLED_AFTER => ' ($1)',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'anchor',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_TEST => '[#]?([A-Za-z][A-Za-z0-9_\-]*)',
				self::ATTR_BEFORE => '<span id="post_$1">',
				self::ATTR_AFTER => '</span>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 6,
			),
			array(
				self::ATTR_TAG => 'b',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<strong class="bbc_strong">',
				self::ATTR_AFTER => '</strong>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 1,
			),
			array(
				self::ATTR_TAG => 'br',
				self::ATTR_TYPE => self::TYPE_CLOSED,
				self::ATTR_CONTENT => '<br />',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 2,
			),
			array(
				self::ATTR_TAG => 'center',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<div class="centertext">',
				self::ATTR_AFTER => '</div>',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 6,
			),
			array(
				self::ATTR_TAG => 'code',
				self::ATTR_TYPE => self::TYPE_UNPARSED_CONTENT,
				self::ATTR_CONTENT => '<div class="codeheader">' . $txt['code'] . ': <a href="#" onclick="return elkSelectText(this);" class="codeoperation">' . $txt['code_select'] . '</a></div><pre class="bbc_code prettyprint">$1</pre>',
				self::ATTR_VALIDATE => $this->isDisabled('code') ? null : function (&$tag, &$data) {
					$data = tabToHtmlTab(strtr($data, array('[' => '&#91;', ']' => '&#93;')));
				},
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'code',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS_CONTENT,
				self::ATTR_CONTENT => '<div class="codeheader">' . $txt['code'] . ': ($2) <a href="#" onclick="return elkSelectText(this);" class="codeoperation">' . $txt['code_select'] . '</a></div><pre class="bbc_code prettyprint">$1</pre>',
				self::ATTR_VALIDATE => $this->isDisabled('code') ? null : function (&$tag, &$data) {
					$data[0] = tabToHtmlTab(strtr($data[0], array('[' => '&#91;', ']' => '&#93;')));
				},
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'color',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_TEST => '(#[\da-fA-F]{3}|#[\da-fA-F]{6}|[A-Za-z]{1,20}|rgb\((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\s?,\s?){2}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\))',
				self::ATTR_BEFORE => '<span style="color: $1;" class="bbc_color">',
				self::ATTR_AFTER => '</span>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'email',
				self::ATTR_TYPE => self::TYPE_UNPARSED_CONTENT,
				self::ATTR_CONTENT => '<a href="mailto:$1" class="bbc_email">$1</a>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'email',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_BEFORE => '<a href="mailto:$1" class="bbc_email">',
				self::ATTR_AFTER => '</a>',
				self::ATTR_DISALLOW_CHILDREN => array(
					'email' => 1,
					'url' => 1,
					'iurl' => 1,
				),
				self::ATTR_DISABLED_AFTER => ' ($1)',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'footnote',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<sup class="bbc_footnotes">%fn%',
				self::ATTR_AFTER => '%fn%</sup>',
				self::ATTR_TRIM => self::TRIM_NONE,
				self::ATTR_DISALLOW_PARENTS => array(
					'footnote' => 1,
					'code' => 1,
					'anchor' => 1,
					'url' => 1,
					'iurl' => 1,
				),
				self::ATTR_DISALLOW_BEFORE => '',
				self::ATTR_DISALLOW_AFTER => '',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 8,
			),
			array(
				self::ATTR_TAG => 'font',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_TEST => '[A-Za-z0-9_,\-\s]+?',
				self::ATTR_BEFORE => '<span style="font-family: $1;" class="bbc_font">',
				self::ATTR_AFTER => '</span>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'hr',
				self::ATTR_TYPE => self::TYPE_CLOSED,
				self::ATTR_CONTENT => '<hr />',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 2,
			),
			array(
				self::ATTR_TAG => 'i',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<em>',
				self::ATTR_AFTER => '</em>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 1,
			),
			array(
				self::ATTR_TAG => 'img',
				self::ATTR_TYPE => self::TYPE_UNPARSED_CONTENT,
				self::ATTR_PARAM => array(
					'width' => array(
						self::PARAM_ATTR_VALUE => 'width:100%;max-width:$1px;',
						self::PARAM_ATTR_MATCH => '(\d+)',
						self::PARAM_ATTR_OPTIONAL => true,
					),
					'height' => array(
						self::PARAM_ATTR_VALUE => 'max-height:$1px;',
						self::PARAM_ATTR_MATCH => '(\d+)',
						self::PARAM_ATTR_OPTIONAL => true,
					),
					'title' => array(
						self::PARAM_ATTR_MATCH => '(.+?)',
						self::PARAM_ATTR_OPTIONAL => true,
					),
					'alt' => array(
						self::PARAM_ATTR_MATCH => '(.+?)',
						self::PARAM_ATTR_OPTIONAL => true,
					),
				),
				self::ATTR_CONTENT => '<img src="$1" title="{title}" alt="{alt}" style="{width}{height}" class="bbc_img resized" />',
				self::ATTR_VALIDATE => function (&$tag, &$data) {
					$data = addProtocol($data);
				},
				self::ATTR_DISABLED_CONTENT => '($1)',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 3,
			),
			array(
				self::ATTR_TAG => 'img',
				self::ATTR_TYPE => self::TYPE_UNPARSED_CONTENT,
				self::ATTR_CONTENT => '<img src="$1" alt="" class="bbc_img" />',
				self::ATTR_VALIDATE => function (&$tag, &$data) {
					$data = addProtocol($data);
				},
				self::ATTR_DISABLED_CONTENT => '($1)',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 3,
			),
			array(
				self::ATTR_TAG => 'iurl',
				self::ATTR_TYPE => self::TYPE_UNPARSED_CONTENT,
				self::ATTR_CONTENT => '<a href="$1" class="bbc_link">$1</a>',
				self::ATTR_VALIDATE => function (&$tag, &$data) {
					//$data = removeBr($data);
					$data = addProtocol($data);
				},
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'iurl',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_BEFORE => '<a href="$1" class="bbc_link">',
				self::ATTR_AFTER => '</a>',
				self::ATTR_VALIDATE => function (&$tag, &$data) {
					if ($data[0] === '#')
					{
						$data = '#post_' . substr($data, 1);
					}
					else
					{
						$data = addProtocol($data);
					}
				},
				self::ATTR_DISALLOW_CHILDREN => array(
					'email' => 1,
					'url' => 1,
					'iurl' => 1,
				),
				self::ATTR_DISABLED_AFTER => ' ($1)',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'left',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<div style="text-align: left;">',
				self::ATTR_AFTER => '</div>',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'li',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<li>',
				self::ATTR_AFTER => '</li>',
				self::ATTR_TRIM => self::TRIM_OUTSIDE,
				self::ATTR_REQUIRE_PARENTS => array(
					'list' => 1,
				),
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_DISABLED_BEFORE => '',
				self::ATTR_DISABLED_AFTER => '<br />',
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 2,
			),
			array(
				self::ATTR_TAG => 'list',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<ul class="bbc_list">',
				self::ATTR_AFTER => '</ul>',
				self::ATTR_TRIM => self::TRIM_INSIDE,
				self::ATTR_REQUIRE_CHILDREN => array(
					'li' => 1,
					'list' => 1,
				),
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'list',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_PARAM => array(
					'type' => array(
						self::PARAM_ATTR_MATCH => '(none|disc|circle|square|decimal|decimal-leading-zero|lower-roman|upper-roman|lower-alpha|upper-alpha|lower-greek|lower-latin|upper-latin|hebrew|armenian|georgian|cjk-ideographic|hiragana|katakana|hiragana-iroha|katakana-iroha)',
					),
				),
				self::ATTR_BEFORE => '<ul class="bbc_list" style="list-style-type: {type};">',
				self::ATTR_AFTER => '</ul>',
				self::ATTR_TRIM => self::TRIM_INSIDE,
				self::ATTR_REQUIRE_CHILDREN => array(
					'li' => 1,
				),
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'me',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_BEFORE => '<div class="meaction">&nbsp;$1 ',
				self::ATTR_AFTER => '</div>',
				self::ATTR_QUOTED => self::OPTIONAL,
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_DISABLED_BEFORE => '/me ',
				self::ATTR_DISABLED_AFTER => '<br />',
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 2,
			),
			array(
				self::ATTR_TAG => 'member',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_TEST => '\d*',
				self::ATTR_BEFORE => '<span class="bbc_mention"><a href="' . $scripturl . '?action=profile;u=$1">@',
				self::ATTR_AFTER => '</a></span>',
				self::ATTR_DISABLED_BEFORE => '@',
				self::ATTR_DISABLED_AFTER => '',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 6,
			),
			array(
				self::ATTR_TAG => 'nobbc',
				self::ATTR_TYPE => self::TYPE_UNPARSED_CONTENT,
				self::ATTR_CONTENT => '$1',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'pre',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<pre class="bbc_pre">',
				self::ATTR_AFTER => '</pre>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 3,
			),
			array(
				self::ATTR_TAG => 'quote',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<div class="quoteheader">' . $txt['quote'] . '</div><blockquote>',
				self::ATTR_AFTER => '</blockquote>',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'quote',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_PARAM => array(
					'author' => array(
						self::PARAM_ATTR_MATCH => '([^<>&"\'=\\\\]{1,192}?)',
						self::PARAM_ATTR_QUOTED => self::OPTIONAL,
					),
				),
				self::ATTR_BEFORE => '<div class="quoteheader">' . $txt['quote_from'] . ': {author}</div><blockquote>',
				self::ATTR_AFTER => '</blockquote>',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'quote',
				self::ATTR_TYPE => self::TYPE_PARSED_EQUALS,
				self::ATTR_BEFORE => '<div class="quoteheader">' . $txt['quote_from'] . ': $1</div><blockquote>',
				self::ATTR_AFTER => '</blockquote>',
				self::ATTR_QUOTED => self::OPTIONAL,
				self::ATTR_PARSED_TAGS_ALLOWED => array(
					'url',
					'iurl',
				),
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'quote',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_PARAM => array(
					'author' => array(
						self::PARAM_ATTR_MATCH => '([^<>&"\'=\\\\]{1,192}?)'
					),
					'link' => array(
						self::PARAM_ATTR_MATCH => '(?:board=\d+;)?((?:topic|threadid)=[\dmsg#\./]{1,40}(?:;start=[\dmsg#\./]{1,40})?|msg=\d{1,40}|action=profile;u=\d+)',
					),
					'date' => array(
						self::PARAM_ATTR_MATCH => '(\d+)',
						self::PARAM_ATTR_VALIDATE => 'htmlTime',
					),
				),
				self::ATTR_BEFORE => '<div class="quoteheader"><a href="' . $scripturl . '?{link}">' . $txt['quote_from'] . ': {author} ' . ($modSettings['todayMod'] == 3 ? ' - ' : $txt['search_on']) . ' {date}</a></div><blockquote>',
				self::ATTR_AFTER => '</blockquote>',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'quote',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_PARAM => array(
					'author' => array(
						self::PARAM_ATTR_MATCH => '([^<>&"\'=\\\\]{1,192}?)'
					),
				),
				self::ATTR_BEFORE => '<div class="quoteheader">' . $txt['quote_from'] . ': {author}</div><blockquote>',
				self::ATTR_AFTER => '</blockquote>',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'right',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<div style="text-align: right;">',
				self::ATTR_AFTER => '</div>',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 's',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<del>',
				self::ATTR_AFTER => '</del>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 1,
			),
			array(
				self::ATTR_TAG => 'size',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_TEST => '[1-7]{1}',
				self::ATTR_BEFORE => '<span style="font-size: $1;" class="bbc_size">',
				self::ATTR_AFTER => '</span>',
				self::ATTR_VALIDATE => function (&$tag, &$data) {
					$sizes = array(1 => 0.7, 2 => 1.0, 3 => 1.35, 4 => 1.45, 5 => 2.0, 6 => 2.65, 7 => 3.95);
					$data = $sizes[(int) $data] . 'em';
				},
				self::ATTR_DISALLOW_PARENTS => array(
					'size' => 1,
				),
				self::ATTR_DISALLOW_BEFORE => '<span>',
				self::ATTR_DISALLOW_AFTER => '</span>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'size',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_TEST => '([1-9][\d]?p[xt]|small(?:er)?|large[r]?|x[x]?-(?:small|large)|medium|(0\.[1-9]|[1-9](\.[\d][\d]?)?)?em)',
				self::ATTR_BEFORE => '<span style="font-size: $1;" class="bbc_size">',
				self::ATTR_AFTER => '</span>',
				self::ATTR_DISALLOW_PARENTS => array('size' => 1),
				self::ATTR_DISALLOW_BEFORE => '<span>',
				self::ATTR_DISALLOW_AFTER => '</span>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 4,
			),
			array(
				self::ATTR_TAG => 'spoiler',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<span class="spoilerheader">' . $txt['spoiler'] . '</span><div class="spoiler"><div class="bbc_spoiler" style="display: none;">',
				self::ATTR_AFTER => '</div></div>',
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 7,
			),
			array(
				self::ATTR_TAG => 'sub',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<sub>',
				self::ATTR_AFTER => '</sub>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 3,
			),
			array(
				self::ATTR_TAG => 'sup',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<sup>',
				self::ATTR_AFTER => '</sup>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 3,
			),
			array(
				self::ATTR_TAG => 'table',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<div class="bbc_table_container"><table class="bbc_table">',
				self::ATTR_AFTER => '</table></div>',
				self::ATTR_TRIM => self::TRIM_INSIDE,
				self::ATTR_REQUIRE_CHILDREN => array(
					'tr' => 1,
				),
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 5,
			),
			array(
				self::ATTR_TAG => 'td',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<td>',
				self::ATTR_AFTER => '</td>',
				self::ATTR_REQUIRE_PARENTS => array(
					'tr' => 1,
				),
				self::ATTR_TRIM => self::TRIM_OUTSIDE,
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_DISABLED_BEFORE => '',
				self::ATTR_DISABLED_AFTER => '',
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 2,
			),
			array(
				self::ATTR_TAG => 'th',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<th>',
				self::ATTR_AFTER => '</th>',
				self::ATTR_REQUIRE_PARENTS => array(
					'tr' => 1,
				),
				self::ATTR_TRIM => self::TRIM_OUTSIDE,
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_DISABLED_BEFORE => '',
				self::ATTR_DISABLED_AFTER => '',
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 2,
			),
			array(
				self::ATTR_TAG => 'tr',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<tr>',
				self::ATTR_AFTER => '</tr>',
				self::ATTR_REQUIRE_PARENTS => array(
					'table' => 1,
				),
				self::ATTR_REQUIRE_CHILDREN => array(
					'td' => 1,
					'th' => 1,
				),
				self::ATTR_TRIM => self::TRIM_BOTH,
				self::ATTR_BLOCK_LEVEL => true,
				self::ATTR_DISABLED_BEFORE => '',
				self::ATTR_DISABLED_AFTER => '',
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 2,
			),
			array(
				self::ATTR_TAG => 'tt',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<span class="bbc_tt">',
				self::ATTR_AFTER => '</span>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 2,
			),
			array(
				self::ATTR_TAG => 'u',
				self::ATTR_TYPE => self::TYPE_PARSED_CONTENT,
				self::ATTR_BEFORE => '<span class="bbc_u">',
				self::ATTR_AFTER => '</span>',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => true,
				self::ATTR_LENGTH => 1,
			),
			array(
				self::ATTR_TAG => 'url',
				self::ATTR_TYPE => self::TYPE_UNPARSED_CONTENT,
				self::ATTR_CONTENT => '<a href="$1" class="bbc_link" target="_blank">$1</a>',
				self::ATTR_VALIDATE => function (&$tag, &$data) {
					$data = addProtocol($data);
				},
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 3,
			),
			array(
				self::ATTR_TAG => 'url',
				self::ATTR_TYPE => self::TYPE_UNPARSED_EQUALS,
				self::ATTR_BEFORE => '<a href="$1" class="bbc_link" target="_blank">',
				self::ATTR_AFTER => '</a>',
				self::ATTR_VALIDATE => function (&$tag, &$data) {
					$data = addProtocol($data);
				},
				self::ATTR_DISALLOW_CHILDREN => array(
					'email' => 1,
					'url' => 1,
					'iurl' => 1,
				),
				self::ATTR_DISABLED_AFTER => ' ($1)',
				self::ATTR_BLOCK_LEVEL => false,
				self::ATTR_AUTOLINK => false,
				self::ATTR_LENGTH => 3,
			),
		));
	}

	/**
	 * Returns the item codes array, used for simple lists, e.g. [*]
	 *
	 * @return array
	 */
	public function getItemCodes()
	{
		$item_codes = array(
			'*' => 'disc',
			'@' => 'disc',
			'+' => 'square',
			'x' => 'square',
			'#' => 'decimal',
			'0' => 'decimal',
			'o' => 'circle',
			'O' => 'circle',
		);

		// Want to add some more ?
		call_integration_hook('integrate_item_codes', array(&$item_codes));

		return $item_codes;
	}

	/**
	 * Return the current Default BBC codes and those added by modifications
	 *
	 * @return array|mixed
	 */
	public function getCodes()
	{
		return $this->bbc;
	}

	/**
	 * Returns an array of installed bbc codes grouped by attr type e.g. quote[0], quote[1]
	 *
	 * @return array
	 */
	public function getCodesGroupedByTag()
	{
		$bbc = array();
		foreach ($this->bbc as $code)
		{
			if (!isset($bbc[$code[self::ATTR_TAG]]))
			{
				$bbc[$code[self::ATTR_TAG]] = array();
			}

			$bbc[$code[self::ATTR_TAG]][] = $code;
		}

		return $bbc;
	}

	/**
	 * Return the list of BBC tags, like b, i, spoiler
	 *
	 * @return array
	 */
	public function getTags()
	{
		$tags = array();
		foreach ($this->bbc as $tag)
		{
			$tags[$tag[self::ATTR_TAG]] = $tag[self::ATTR_TAG];
		}

		return $tags;
	}

	/**
	 * @todo besides the itemcodes (just add a arg $with_itemcodes), this way should be standard and saved like that.
	 * Even, just remove the itemcodes when needed
	 *
	 * @return array
	 */
	public function getForParsing()
	{
		$bbc = $this->bbc;
		$item_codes = $this->getItemCodes();
		call_integration_hook('bbc_codes_parsing', array(&$bbc, &$item_codes));

		if (!$this->isDisabled('li') && !$this->isDisabled('list'))
		{
			foreach ($item_codes as $c => $dummy)
			{
				// Skip anything "bad"
				if (!is_string($c) || (is_string($c) && trim($c) === ''))
				{
					continue;
				}

				$bbc[$c] = $this->getItemCodeTag($c);
			}
		}

		$return = array();

		// Find the first letter of the tag faster
		foreach ($bbc as &$code)
		{
			$return[$code[self::ATTR_TAG][0]][] = $code;
		}

		return $return;
	}

	/**
	 * Returns the first letter of all valid bbc codes for the parser
	 *
	 * @todo not used
	 *
	 * @return $this
	 */
	public function setParsingCodes()
	{
		$this->parsing_codes = $this->getForParsing();

		return $this;
	}

	/**
	 * Return if the found code [X is possibly a valid one by checking
	 * if we have a code that begins with X
	 *
	 * @todo not used
	 *
	 * @param $char
	 *
	 * @return bool
	 */
	public function hasChar($char)
	{
		return isset($this->parsing_codes[$char]);
	}

	/**
	 * Get BCC codes by character start
	 *
	 * @todo not used
	 *
	 * @param $char
	 *
	 * @return mixed
	 */
	public function getCodesByChar($char)
	{
		return $this->parsing_codes[$char];
	}

	/**
	 * Generates item code tags
	 *
	 * @param $code
	 *
	 * @return array
	 */
	protected function getItemCodeTag($code)
	{
		return array(
			self::ATTR_TAG => $code,
			self::ATTR_TYPE => self::TYPE_ITEMCODE,
			self::ATTR_BLOCK_LEVEL => true,
			self::ATTR_LENGTH => 1,
		);
	}

	/**
	 * Disables certain tags when we are going to print
	 *
	 * @return $this
	 */
	public function setForPrinting()
	{
		// Colors can't well be displayed... supposed to be black and white.
		$this->disable('color');
		$this->disable('me');

		// Links are useless on paper... just show the link.
		$this->disable('url');
		$this->disable('iurl');
		$this->disable('email');

		// @todo Change maybe?
		if (!isset($_GET['images']))
		{
			$this->disable('img');
		}

		// @todo Interface/setting to add more?
		call_integration_hook('integrate_bbc_set_printing', array($this));

		return $this;
	}

	/**
	 * Return if a tag is enable
	 *
	 * @param string $tag
	 *
	 * @return bool
	 */
	public function isDisabled($tag)
	{
		return isset($this->disabled[$tag]);
	}

	/**
	 * If BBC Parsing is enabled
	 *
	 * @return array
	 */
	public function getDisabled()
	{
		return $this->disabled;
	}

	/**
	 * Disable a tag from parsing
	 *
	 * @param $tag
	 *
	 * @return bool
	 */
	public function disable($tag)
	{
		$this->disabled[$tag] = $tag;

		return isset($this->disabled[$tag]);
	}

	/**
	 * Restore a disabled tag
	 *
	 * @param $tag
	 *
	 * @return bool
	 */
	public function restore($tag)
	{
		if (isset($this->disabled[$tag]))
		{
			unset($this->disabled[$tag]);
		}

		return !isset($this->disabled[$tag]);
	}

	/**
	 * Set the tags that will be parsed
	 *
	 * @param $parse_tags
	 */
	public function setParsedTags($parse_tags)
	{
		foreach ($this->bbc as $k => $code)
		{
			if (!in_array($code[self::ATTR_TAG], $parse_tags))
			{
				//$this->remove($code);
				unset($this->bbc[$k]);

				$this->disabled[$code[self::ATTR_TAG]] = $code[self::ATTR_TAG];
			}
		}
	}
}

elkarte / Elkarte

Pull Request — development (#3050)

Codes::setForPrinting() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
