X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FContent%2FSmilies.php;h=02abee6cf61d9605fcd7e0a52276a66b35b3c155;hb=9fbdcb5459e4acb158961427837612999253e046;hp=ce785d66f44f48687160a8ed334a6fe01d3550ed;hpb=a21f6135fcd8f0bfdb49de38a5ab4954d1784503;p=friendica.git diff --git a/src/Content/Smilies.php b/src/Content/Smilies.php index ce785d66f4..02abee6cf6 100644 --- a/src/Content/Smilies.php +++ b/src/Content/Smilies.php @@ -1,23 +1,29 @@ . * - * Have also a look here: - * https://www.webpagefx.com/tools/emoji-cheat-sheet/ */ + namespace Friendica\Content; -use Friendica\App; -use Friendica\Core\Config; -use Friendica\Core\PConfig; -use Friendica\Core\System; +use Friendica\Core\Hook; +use Friendica\DI; +use Friendica\Util\Strings; /** * This class contains functions to handle smiles @@ -26,17 +32,16 @@ use Friendica\Core\System; class Smilies { /** - * @brief Replaces/adds the emoticon list + * Replaces/adds the emoticon list * * This function should be used whenever emoticons are added * * @param array $b Array of emoticons * @param string $smiley The text smilie * @param string $representation The replacement - * * @return void */ - public static function add(&$b, $smiley, $representation) + public static function add(array &$b, string $smiley, string $representation) { $found = array_search($smiley, $b['texts']); @@ -49,19 +54,20 @@ class Smilies } /** - * @brief Function to list all smilies + * Function to list all smilies * * Get an array of all smilies, both internal and from addons. * * @return array - * 'texts' => smilie shortcut - * 'icons' => icon in html + * 'texts' => smilie shortcut + * 'icons' => icon in html * - * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array) + * @throws \Friendica\Network\HTTPException\InternalServerErrorException + * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array) */ - public static function getList() + public static function getList(): array { - $texts = array( + $texts = [ '<3', '</3', '<\\3', @@ -98,54 +104,77 @@ class Smilies 'red#', 'red#matrix' - ); - - $icons = array( - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '~friendica ', - 'redmatrix', - 'redmatrix' - ); - - $params = array('texts' => $texts, 'icons' => $icons); - call_hooks('smilie', $params); + ]; + + $baseUrl = DI::baseUrl(); + + $icons = [ + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '', + '~friendica ', + 'redmatrix', + 'redmatrix' + ]; + + $params = ['texts' => $texts, 'icons' => $icons]; + Hook::callAll('smilie', $params); return $params; } + /** - * @brief Replaces text emoticons with graphical images + * Copied from http://php.net/manual/en/function.str-replace.php#88569 + * Modified for camel caps: renamed stro_replace -> strOrigReplace + * + * When using str_replace(...), values that did not exist in the original string (but were put there by previous + * replacements) will be replaced continuously. This string replacement function is designed to replace the values + * in $search with those in $replace while not factoring in prior replacements. Note that this function will + * always look for the longest possible match first and then work its way down to individual characters. + * + * @param array $search list of strings or characters that need to be replaced + * @param array $replace list of strings or characters that will replace the corresponding values in $search + * @param string $subject the string on which this operation is being performed + * + * @return string $subject with all substrings in the $search array replaced by the values in the $replace array + */ + private static function strOrigReplace(array $search, array $replace, string $subject): string + { + return strtr($subject, array_combine($search, $replace)); + } + + /** + * Replaces text emoticons with graphical images * * It is expected that this function will be called using HTML text. * We will escape text between HTML pre and code blocks from being @@ -156,94 +185,104 @@ class Smilies * bbcode source for HTML display * * @param string $s Text that should be replaced - * @param boolean $sample optional, default false * @param boolean $no_images Only replace emoticons without images * - * @return string HML Output of the Smilie + * @return string HTML Output of the Smilie + * @throws \Friendica\Network\HTTPException\InternalServerErrorException + */ + public static function replace(string $s, bool $no_images = false): string + { + $smilies = self::getList(); + + $s = self::replaceFromArray($s, $smilies, $no_images); + + return $s; + } + + /** + * Replaces emoji shortcodes in a string from a structured array of searches and replaces. + * + * Depends on system.no_smilies config value, skips
and tags.
+ *
+ * @param string $text An HTML string
+ * @param array $smilies An string replacement array with the following structure: ['texts' => [], 'icons' => []]
+ * @param bool $no_images Only replace shortcodes without image replacement (e.g. Unicode characters)
+ * @return string
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function replace($s, $sample = false, $no_images = false)
+ public static function replaceFromArray(string $text, array $smilies, bool $no_images = false): string
{
- if (intval(Config::get('system', 'no_smilies'))
- || (local_user() && intval(PConfig::get(local_user(), 'system', 'no_smilies')))
+ if (intval(DI::config()->get('system', 'no_smilies'))
+ || (DI::userSession()->getLocalUserId() && intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'no_smilies')))
) {
- return $s;
+ return $text;
}
- $s = preg_replace_callback('/(.*?)<\/pre>/ism', 'self::encode', $s);
- $s = preg_replace_callback('/(.*?)<\/code>/ism', 'self::encode', $s);
-
- $params = self::getList();
+ $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', 'self::encode', $text);
+ $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', 'self::encode', $text);
if ($no_images) {
- $cleaned = array('texts' => array(), 'icons' => array());
- $icons = $params['icons'];
+ $cleaned = ['texts' => [], 'icons' => []];
+ $icons = $smilies['icons'];
foreach ($icons as $key => $icon) {
if (!strstr($icon, '';
- for ($x = 0; $x < count($params['texts']); $x ++) {
- $s .= '- ' . $params['texts'][$x] . '
- ' . $params['icons'][$x] . '
';
- }
- } else {
- $params['string'] = preg_replace_callback('/<(3+)/', 'self::pregHeart', $params['string']);
- $s = str_replace($params['texts'], $params['icons'], $params['string']);
- }
+ $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', 'self::decode', $text);
+ $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', 'self::decode', $text);
- $s = preg_replace_callback('/(.*?)<\/pre>/ism', 'self::decode', $s);
- $s = preg_replace_callback('/(.*?)<\/code>/ism', 'self::decode', $s);
-
- return $s;
+ return $text;
}
/**
- * @param string $m string
+ * Encodes smiley match array to BASE64 string
*
+ * @param array $m Match array
* @return string base64 encoded string
*/
- private static function encode($m)
+ private static function encode(array $m): string
{
- return(str_replace($m[1], base64url_encode($m[1]), $m[0]));
+ return '<' . $m[1] . '>' . Strings::base64UrlEncode($m[2]) . '' . $m[1] . '>';
}
/**
- * @param string $m string
+ * Decodes a previously BASE64-encoded match array to a string
*
+ * @param array $m Matches array
* @return string base64 decoded string
+ * @throws \Exception
*/
- private static function decode($m)
+ private static function decode(array $m): string
{
- return(str_replace($m[1], base64url_decode($m[1]), $m[0]));
+ return '<' . $m[1] . '>' . Strings::base64UrlDecode($m[2]) . '' . $m[1] . '>';
}
/**
- * @brief expand <3333 to the correct number of hearts
- *
- * @param string $x string
+ * expand <3333 to the correct number of hearts
*
+ * @param array $matches
* @return string HTML Output
- *
- * @todo: Rework because it doesn't work correctly
*/
- private static function pregHeart($x)
+ private static function heartReplaceCallback(array $matches): string
{
- if (strlen($x[1]) == 1) {
- return $x[0];
+ if (strlen($matches[1]) == 1) {
+ return $matches[0];
}
+
$t = '';
- for ($cnt = 0; $cnt < strlen($x[1]); $cnt ++) {
- $t .= '';
+ for ($cnt = 0; $cnt < strlen($matches[1]); $cnt ++) {
+ $t .= 'â¤';
}
- $r = str_replace($x[0], $t, $x[0]);
- return $r;
+
+ return str_replace($matches[0], $t, $matches[0]);
}
}