Page MenuHomePhorge
Files F117749917

rcube_string_replacer.php
No OneTemporary
Actions

Authored By
Unknown
Size
11 KB
Referenced Files
None
Subscribers
None

rcube_string_replacer.php
View Options

<?php
/**
+-----------------------------------------------------------------------+
| This file is part of the Roundcube Webmail client |
| |
| Copyright (C) The Roundcube Dev Team |
| |
| Licensed under the GNU General Public License version 3 or |
| any later version with exceptions for skins & plugins. |
| See the README file for a full license statement. |
| |
| PURPOSE: |
| Handle string replacements based on preg_replace_callback |
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
*/
/**
* Helper class for string replacements based on preg_replace_callback
*
* @package Framework
* @subpackage Utils
*/
class rcube_string_replacer
{
public $pattern;
public $mailto_pattern;
public $link_pattern;
public $linkref_index;
public $linkref_pattern;
protected $values = [];
protected $options = [];
protected $linkrefs = [];
protected $urls = [];
protected $noword = '[^\w@.#-]';
/**
* Object constructor
*
* @param array $options Configuration options
*/
function __construct($options = [])
{
// Create hard-to-guess replacement string
$uniq_ident = sprintf('%010d%010d', mt_rand(), mt_rand());
$this->pattern = '/##' . $uniq_ident . '##(\d+)##/';
// Simplified domain expression for UTF8 characters handling
// Support unicode/punycode in top-level domain part
$utf_domain = '[^?&@"\'\\/()<>\s\r\t\n]+\\.?([^\\x00-\\x2f\\x3b-\\x40\\x5b-\\x60\\x7b-\\x7f]{2,}|xn--[a-zA-Z0-9]{2,})';
$url1 = '.:;,';
$url2 = 'a-zA-Z0-9%=#$@+?|!&\\/_~\\[\\]\\(\\){}\*\x80-\xFE-';
// Supported link prefixes
$link_prefix = "([\w]+:\/\/|{$this->noword}[Ww][Ww][Ww]\.|^[Ww][Ww][Ww]\.)";
$this->options = $options;
$this->linkref_index = '/\[([^<>\]#]+)\](:?\s*' . substr($this->pattern, 1, -1) . ')/';
$this->linkref_pattern = '/\[([^<>\]#]+)\]/';
$this->link_pattern = "/$link_prefix($utf_domain([$url1]*[$url2]+)*)/";
$this->mailto_pattern = "/("
. "[-\w!\#\$%&*+~\/^`|{}=]+(?:\.[-\w!\#\$%&*+~\/^`|{}=]+)*" // local-part
. "@$utf_domain" // domain-part
. "(\?[$url1$url2]+)?" // e.g. ?subject=test...
. ")/";
}
/**
* Add a string to the internal list
*
* @param string $str String value
*
* @return int Index of value for retrieval
*/
public function add($str)
{
$i = count($this->values);
$this->values[$i] = $str;
return $i;
}
/**
* Build replacement string
*
* @param string|int $i Replacement index
*
* @return string Replacement string
*/
public function get_replacement($i)
{
return str_replace('(\d+)', $i, substr($this->pattern, 1, -1));
}
/**
* Callback function used to build HTML links around URL strings
*
* @param array $matches Matches result from preg_replace_callback
*
* @return string Return valid link for recognized schemes, otherwise
* return the unmodified URL.
*/
protected function link_callback($matches)
{
$i = -1;
$scheme = strtolower($matches[1]);
$url_prefix = '';
$prefix = '';
if (preg_match('!^(http|ftp|file)s?://!i', $scheme)) {
$url = $matches[1] . $matches[2];
}
else if (preg_match("/^({$this->noword}*)(www\.)$/i", $matches[1], $m)) {
$url = $m[2] . $matches[2];
$url_prefix = 'http://';
$prefix = $m[1];
}
if (!empty($url)) {
$suffix = $this->parse_url_brackets($url);
$attrib = isset($this->options['link_attribs']) ? (array) $this->options['link_attribs'] : [];
$attrib['href'] = $url_prefix . $url;
$i = $this->add(html::a($attrib, rcube::Q($url)) . $suffix);
$this->urls[$i] = $attrib['href'];
}
return $i >= 0 ? $prefix . $this->get_replacement($i) : $matches[0];
}
/**
* Callback to add an entry to the link index
*
* @param array $matches Matches result from preg_replace_callback with PREG_OFFSET_CAPTURE
*
* @return string Replacement string
*/
protected function linkref_addindex($matches)
{
$key = $matches[1][0];
if (!isset($this->linkrefs[$key])) {
$this->linkrefs[$key] = [];
}
// Store the reference and its occurrence position
$this->linkrefs[$key][] = [
$this->urls[$matches[3][0]] ?? null,
$matches[0][1]
];
return $this->get_replacement($this->add('[' . $key . ']')) . $matches[2][0];
}
/**
* Callback to replace link references with real links
*
* @param array $matches Matches result from preg_replace_callback with PREG_OFFSET_CAPTURE
*
* @return string Replacement string
*/
protected function linkref_callback($matches)
{
$i = 0;
$key = $matches[1][0];
if (!empty($this->linkrefs[$key])) {
$attrib = isset($this->options['link_attribs']) ? (array) $this->options['link_attribs'] : [];
foreach ($this->linkrefs[$key] as $linkref) {
$attrib['href'] = $linkref[0];
if ($linkref[1] >= $matches[1][1]) {
break;
}
}
$i = $this->add(html::a($attrib, rcube::Q($matches[1][0])));
}
return $i > 0 ? '[' . $this->get_replacement($i) . ']' : $matches[0][0];
}
/**
* Callback function used to build mailto: links around e-mail strings
*
* @param array $matches Matches result from preg_replace_callback
*
* @return string Replacement string
*/
protected function mailto_callback($matches)
{
$href = $matches[1];
$suffix = $this->parse_url_brackets($href);
$i = $this->add(html::a('mailto:' . $href, rcube::Q($href)) . $suffix);
return $i >= 0 ? $this->get_replacement($i) : '';
}
/**
* Look up the index from the preg_replace matches array
* and return the substitution value.
*
* @param array $matches Matches result from preg_replace_callback
*
* @return string Value at index $matches[1]
*/
protected function replace_callback($matches)
{
return $this->values[$matches[1]] ?? null;
}
/**
* Replace all defined (link|mailto) patterns with replacement string
*
* @param string $str Text
*
* @return string Text
*/
public function replace($str)
{
if (!is_string($str)) {
return '';
}
// search for patterns like links and e-mail addresses
$str = preg_replace_callback($this->link_pattern, [$this, 'link_callback'], $str);
$str = preg_replace_callback($this->mailto_pattern, [$this, 'mailto_callback'], $str);
// resolve link references
/*
This code requires PHP 7.4 and could be used instead of the two if() statements below,
when we get there.
$str = preg_replace_callback($this->linkref_index,
[$this, 'linkref_addindex'], $str, -1, $count, PREG_OFFSET_CAPTURE
);
$str = preg_replace_callback($this->linkref_pattern,
[$this, 'linkref_callback'], $str, -1, $count, PREG_OFFSET_CAPTURE
);
*/
if (preg_match_all($this->linkref_index, $str, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER)) {
$diff = 0;
foreach ($matches as $m) {
$replace = $this->linkref_addindex($m);
$str = substr_replace($str, $replace, $m[0][1] + $diff, strlen($m[0][0]));
$diff += strlen($replace) - strlen($m[0][0]);
}
}
if (preg_match_all($this->linkref_pattern, $str, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER)) {
$diff = 0;
foreach ($matches as $m) {
$replace = $this->linkref_callback($m);
$str = substr_replace($str, $replace, $m[0][1] + $diff, strlen($m[0][0]));
$diff += strlen($replace) - strlen($m[0][0]);
}
}
return $str;
}
/**
* Replace substituted strings with original values
*
* @param string $str Text
*
* @return string Text
*/
public function resolve($str)
{
return preg_replace_callback($this->pattern, [$this, 'replace_callback'], $str);
}
/**
* Fixes bracket characters in URL handling
*
* @param string &$url URL
*
* @return string Suffix (the rest of the URL input)
*/
protected static function parse_url_brackets(&$url)
{
// #1487672: special handling of square brackets,
// URL regexp allows [] characters in URL, for example:
// "http://example.com/?a[b]=c". However we need to handle
// properly situation when a bracket is placed at the end
// of the link e.g. "[http://example.com]"
// Yes, this is not perfect handles correctly only paired characters
// but it should work for common cases
$suffix = '';
if (preg_match('/(\\[|\\])/', $url)) {
$in = false;
for ($i=0, $len=strlen($url); $i<$len; $i++) {
if ($url[$i] == '[') {
if ($in) {
break;
}
$in = true;
}
else if ($url[$i] == ']') {
if (!$in) {
break;
}
$in = false;
}
}
if ($i < $len) {
$suffix = substr($url, $i);
$url = substr($url, 0, $i);
}
}
// Do the same for parentheses
if (preg_match('/(\\(|\\))/', $url)) {
$in = false;
for ($i=0, $len=strlen($url); $i<$len; $i++) {
if ($url[$i] == '(') {
if ($in) {
break;
}
$in = true;
}
else if ($url[$i] == ')') {
if (!$in) {
break;
}
$in = false;
}
}
if ($i < $len) {
$suffix = substr($url, $i);
$url = substr($url, 0, $i);
}
}
return $suffix;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Apr 4, 1:53 AM (1 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
73/b8/1710da1be386d5b115d1e6bca6d2
Default Alt Text
rcube_string_replacer.php (11 KB)

Event Timeline