]> git.mxchange.org Git - friendica.git/blobdiff - src/Content/Smilies.php
spelling: trimmed
[friendica.git] / src / Content / Smilies.php
index cafc6f3147033046831636c04a3764245c04d62c..ff9d63882ea5b6ef62bf65a03fdbffcbbaf7e380 100644 (file)
@@ -1,20 +1,26 @@
 <?php
-
 /**
- * @file src/Content/Smilies.php
- * @brief This file contains the Smilies class which contains functions to handle smiles
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
  *
- * @todo Use the shortcodes from here:
- * https://github.com/iamcal/emoji-data/blob/master/emoji_pretty.json?raw=true
- * https://raw.githubusercontent.com/emojione/emojione/master/extras/alpha-codes/eac.json?raw=true
- * https://github.com/johannhof/emoji-helper/blob/master/data/emoji.json?raw=true
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  *
- * Have also a look here:
- * https://www.webpagefx.com/tools/emoji-cheat-sheet/
  */
+
 namespace Friendica\Content;
 
-use Friendica\Core\Config;
 use Friendica\Core\Hook;
 use Friendica\DI;
 use Friendica\Util\Strings;
@@ -26,17 +32,16 @@ use Friendica\Util\Strings;
 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,7 +54,7 @@ class Smilies
        }
 
        /**
-        * @brief Function to list all smilies
+        * Function to list all smilies
         *
         * Get an array of all smilies, both internal and from addons.
         *
@@ -60,7 +65,7 @@ class Smilies
         * @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 =  [
                        '&lt;3',
@@ -128,7 +133,7 @@ class Smilies
                '<img class="smiley" src="' . $baseUrl . '/images/smiley-cry.gif" alt=":\'(" title=":\'("/>',
                '<img class="smiley" src="' . $baseUrl . '/images/smiley-foot-in-mouth.gif" alt=":-!" title=":-!" />',
                '<img class="smiley" src="' . $baseUrl . '/images/smiley-undecided.gif" alt=":-/" title=":-/" />',
-               '<img class="smiley" src="' . $baseUrl . '/images/smiley-embarassed.gif" alt=":-[" title=":-[" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-embarrassed.gif" alt=":-[" title=":-[" />',
                '<img class="smiley" src="' . $baseUrl . '/images/smiley-cool.gif" alt="8-)" title="8-)" />',
                '<img class="smiley" src="' . $baseUrl . '/images/beer_mug.gif" alt=":beer" title=":beer" />',
                '<img class="smiley" src="' . $baseUrl . '/images/beer_mug.gif" alt=":homebrew" title=":homebrew" />',
@@ -136,7 +141,7 @@ class Smilies
                '<img class="smiley" src="' . $baseUrl . '/images/smiley-facepalm.gif" alt=":facepalm" title=":facepalm" />',
                '<img class="smiley" src="' . $baseUrl . '/images/like.gif" alt=":like" title=":like" />',
                '<img class="smiley" src="' . $baseUrl . '/images/dislike.gif" alt=":dislike" title=":dislike" />',
-               '<a href="https://friendi.ca">~friendica <img class="smiley" src="' . $baseUrl . '/images/friendica-16.png" alt="~friendica" title="~friendica" /></a>',
+               '<a href="https://friendi.ca">~friendica <img class="smiley" width="16" height="16" src="' . $baseUrl . '/images/friendica.svg" alt="~friendica" title="~friendica" /></a>',
                '<a href="http://redmatrix.me/">red<img class="smiley" src="' . $baseUrl . '/images/rm-16.png" alt="red#" title="red#" />matrix</a>',
                '<a href="http://redmatrix.me/">red<img class="smiley" src="' . $baseUrl . '/images/rm-16.png" alt="red#matrix" title="red#matrix" />matrix</a>'
                ];
@@ -163,7 +168,7 @@ 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));
        }
@@ -179,14 +184,13 @@ class Smilies
         * function from being executed by the prepare_text() routine when preparing
         * bbcode source for HTML display
         *
-        * @brief Replaces text emoticons with graphical images
         * @param string  $s         Text that should be replaced
         * @param boolean $no_images Only replace emoticons without images
         *
         * @return string HTML Output of the Smilie
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function replace($s, $no_images = false)
+       public static function replace(string $s, bool $no_images = false): string
        {
                $smilies = self::getList();
 
@@ -206,16 +210,16 @@ class Smilies
         * @return string
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function replaceFromArray($text, array $smilies, $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(DI::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 $text;
                }
 
-               $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', 'self::encode', $text);
-               $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', 'self::encode', $text);
+               $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', [self::class, 'encode'], $text);
+               $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', [self::class, 'encode'], $text);
 
                if ($no_images) {
                        $cleaned = ['texts' => [], 'icons' => []];
@@ -229,58 +233,56 @@ class Smilies
                        $smilies = $cleaned;
                }
 
-               $text = preg_replace_callback('/&lt;(3+)/', 'self::pregHeart', $text);
+               $text = preg_replace_callback('/&lt;(3+)/', [self::class, 'heartReplaceCallback'], $text);
                $text = self::strOrigReplace($smilies['texts'], $smilies['icons'], $text);
 
-               $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', 'self::decode', $text);
-               $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', 'self::decode', $text);
+               $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', [self::class, 'decode'], $text);
+               $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', [self::class, 'decode'], $text);
 
                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 '<' . $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 '<' . $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
-        *
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       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 ++) {
+               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]);
        }
 }