X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FContent%2FSmilies.php;h=02abee6cf61d9605fcd7e0a52276a66b35b3c155;hb=9fbdcb5459e4acb158961427837612999253e046;hp=2fedb894270116befdbac68613c29e495bb1ef59;hpb=6191fab4d7c99295dec88b1c01d7c52d23ac74d4;p=friendica.git diff --git a/src/Content/Smilies.php b/src/Content/Smilies.php index 2fedb89427..02abee6cf6 100644 --- a/src/Content/Smilies.php +++ b/src/Content/Smilies.php @@ -1,24 +1,29 @@ . * - * Have also a look here: - * https://www.webpagefx.com/tools/emoji-cheat-sheet/ */ + namespace Friendica\Content; -use Friendica\App; -use Friendica\Core\Addon; -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 @@ -27,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']); @@ -50,17 +54,18 @@ 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 = [ '<3', @@ -101,46 +106,48 @@ class Smilies ]; + $baseUrl = DI::baseUrl(); + $icons = [ - '<3', - '</3', - '<\\3', - ':-)', - ';-)', - ':-(', - ':-P', - ':-p', - ':-\', - ':-\', - ':-x', - ':-X', - ':-D', - '8-|', - '8-O', - ':-O', - '\\o/', - 'o.O', - 'O.o', - 'o_O', - 'O_o', - ':\'(', - ':-!', - ':-/', - ':-[', - '8-)', - ':beer', - ':homebrew', - ':coffee', - ':facepalm', - ':like', - ':dislike', - '~friendica ~friendica', - 'redred#matrix', - 'redred#matrixmatrix' + '<3', + '</3', + '<\\3', + ':-)', + ';-)', + ':-(', + ':-P', + ':-p', + ':-\', + ':-\', + ':-x', + ':-X', + ':-D', + '8-|', + '8-O', + ':-O', + '\\o/', + 'o.O', + 'O.o', + 'o_O', + 'O_o', + ':\'(', + ':-!', + ':-/', + ':-[', + '8-)', + ':beer', + ':homebrew', + ':coffee', + ':facepalm', + ':like', + ':dislike', + '~friendica ~friendica', + 'redred#matrix', + 'redred#matrixmatrix' ]; $params = ['texts' => $texts, 'icons' => $icons]; - Addon::callHooks('smilie', $params); + Hook::callAll('smilie', $params); return $params; } @@ -161,13 +168,13 @@ class Smilies * * @return string $subject with all substrings in the $search array replaced by the values in the $replace array */ - private static function strOrigReplace($search, $replace, $subject) + private static function strOrigReplace(array $search, array $replace, string $subject): string { return strtr($subject, array_combine($search, $replace)); } /** - * @brief Replaces text emoticons with graphical images + * 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 @@ -178,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($s, $sample = false, $no_images = false) + public static function replace(string $s, bool $no_images = false): string { - if (intval(Config::get('system', 'no_smilies')) - || (local_user() && intval(PConfig::get(local_user(), 'system', 'no_smilies'))) + $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 replaceFromArray(string $text, array $smilies, bool $no_images = false): string
+	{
+		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 = ['texts' => [], 'icons' => []];
-			$icons = $params['icons'];
+			$icons = $smilies['icons'];
 			foreach ($icons as $key => $icon) {
 				if (!strstr($icon, '
' . $params['icons'][$x] . '
';
-			}
-		} else {
-			$params['string'] = preg_replace_callback('/<(3+)/', 'self::pregHeart', $params['string']);
-			$s = self::strOrigReplace($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]) . '';
 	}
 
 	/**
-	 * @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]) . '';
 	}
 
 
 	/**
-	 * @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 .= '<3';
+		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]);
 	}
 }