]> git.mxchange.org Git - friendica.git/blobdiff - src/Content/Smilies.php
Move Config::get() to DI::config()->get()
[friendica.git] / src / Content / Smilies.php
index ce785d66f44f48687160a8ed334a6fe01d3550ed..5e87fd86cc1b45395a297283d86bfd36318c7d3f 100644 (file)
@@ -2,7 +2,7 @@
 
 /**
  * @file src/Content/Smilies.php
- * @brief This file contains the Smilies class which contains functions to handle smiles
+ * This file contains the Smilies class which contains functions to handle smiles
  *
  * @todo Use the shortcodes from here:
  * https://github.com/iamcal/emoji-data/blob/master/emoji_pretty.json?raw=true
  */
 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,7 +26,7 @@ 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
         *
@@ -49,19 +49,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()
        {
-               $texts =  array(
+               $texts =  [
                        '<3',
                        '</3',
                        '<\\3',
@@ -98,54 +99,77 @@ class Smilies
                        'red#',
                        'red#matrix'
 
-               );
-
-               $icons = array(
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-heart.gif" alt="&lt;3" title="&lt;3" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-brokenheart.gif" alt="&lt;/3" title="&lt;/3" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-brokenheart.gif" alt="&lt;\\3" title="&lt;\\3" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-smile.gif" alt=":-)" title=":-)" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-wink.gif" alt=";-)" title=";-)" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-frown.gif" alt=":-(" title=":-(" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-tongue-out.gif" alt=":-P" title=":-P" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-tongue-out.gif" alt=":-p" title=":-P" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-kiss.gif" alt=":-x" title=":-x" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-kiss.gif" alt=":-X" title=":-X" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-laughing.gif" alt=":-D" title=":-D"  />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-surprised.gif" alt="8-|" title="8-|" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-surprised.gif" alt="8-O" title="8-O" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-surprised.gif" alt=":-O" title="8-O" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-thumbsup.gif" alt="\\o/" title="\\o/" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-Oo.gif" alt="o.O" title="o.O" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-Oo.gif" alt="O.o" title="O.o" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-Oo.gif" alt="o_O" title="o_O" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-Oo.gif" alt="O_o" title="O_o" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-cry.gif" alt=":\'(" title=":\'("/>',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-foot-in-mouth.gif" alt=":-!" title=":-!" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-undecided.gif" alt=":-/" title=":-/" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-embarassed.gif" alt=":-[" title=":-[" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-cool.gif" alt="8-)" title="8-)" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/beer_mug.gif" alt=":beer" title=":beer" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/beer_mug.gif" alt=":homebrew" title=":homebrew" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/coffee.gif" alt=":coffee" title=":coffee" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-facepalm.gif" alt=":facepalm" title=":facepalm" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/like.gif" alt=":like" title=":like" />',
-               '<img class="smiley" src="' . System::baseUrl() . '/images/dislike.gif" alt=":dislike" title=":dislike" />',
-               '<a href="https://friendi.ca">~friendica <img class="smiley" src="' . System::baseUrl() . '/images/friendica-16.png" alt="~friendica" title="~friendica" /></a>',
-               '<a href="http://redmatrix.me/">red<img class="smiley" src="' . System::baseUrl() . '/images/rm-16.png" alt="red#" title="red#" />matrix</a>',
-               '<a href="http://redmatrix.me/">red<img class="smiley" src="' . System::baseUrl() . '/images/rm-16.png" alt="red#matrix" title="red#matrix" />matrix</a>'
-               );
-
-               $params = array('texts' => $texts, 'icons' => $icons);
-               call_hooks('smilie', $params);
+               ];
+
+               $baseUrl = DI::baseUrl();
+
+               $icons = [
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-heart.gif" alt="&lt;3" title="&lt;3" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-brokenheart.gif" alt="&lt;/3" title="&lt;/3" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-brokenheart.gif" alt="&lt;\\3" title="&lt;\\3" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-smile.gif" alt=":-)" title=":-)" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-wink.gif" alt=";-)" title=";-)" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-frown.gif" alt=":-(" title=":-(" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-tongue-out.gif" alt=":-P" title=":-P" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-tongue-out.gif" alt=":-p" title=":-P" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-x" title=":-x" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-X" title=":-X" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-laughing.gif" alt=":-D" title=":-D"  />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt="8-|" title="8-|" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt="8-O" title="8-O" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt=":-O" title="8-O" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-thumbsup.gif" alt="\\o/" title="\\o/" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="o.O" title="o.O" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="O.o" title="O.o" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="o_O" title="o_O" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="O_o" title="O_o" />',
+               '<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-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" />',
+               '<img class="smiley" src="' . $baseUrl . '/images/coffee.gif" alt=":coffee" title=":coffee" />',
+               '<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="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>'
+               ];
+
+               $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($search, $replace, $subject)
+       {
+               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,52 +180,61 @@ 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, $no_images = false)
+       {
+               $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 <pre> and <code> 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($text, array $smilies, $no_images = false)
        {
-               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'))
+                       || (local_user() && intval(DI::pConfig()->get(local_user(), 'system', 'no_smilies')))
                ) {
-                       return $s;
+                       return $text;
                }
 
-               $s = preg_replace_callback('/<pre>(.*?)<\/pre>/ism', 'self::encode', $s);
-               $s = preg_replace_callback('/<code>(.*?)<\/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, '<img ')) {
-                                       $cleaned['texts'][] = $params['texts'][$key];
-                                       $cleaned['icons'][] = $params['icons'][$key];
+                                       $cleaned['texts'][] = $smilies['texts'][$key];
+                                       $cleaned['icons'][] = $smilies['icons'][$key];
                                }
                        }
-                       $params = $cleaned;
+                       $smilies = $cleaned;
                }
 
-               $params['string'] = $s;
+               $text = preg_replace_callback('/&lt;(3+)/', 'self::pregHeart', $text);
+               $text = self::strOrigReplace($smilies['texts'], $smilies['icons'], $text);
 
-               if ($sample) {
-                       $s = '<div class="smiley-sample">';
-                       for ($x = 0; $x < count($params['texts']); $x ++) {
-                               $s .= '<dl><dt>' . $params['texts'][$x] . '</dt><dd>' . $params['icons'][$x] . '</dd></dl>';
-                       }
-               } else {
-                       $params['string'] = preg_replace_callback('/&lt;(3+)/', 'self::pregHeart', $params['string']);
-                       $s = str_replace($params['texts'], $params['icons'], $params['string']);
-               }
-
-               $s = preg_replace_callback('/<pre>(.*?)<\/pre>/ism', 'self::decode', $s);
-               $s = preg_replace_callback('/<code>(.*?)<\/code>/ism', 'self::decode', $s);
+               $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', 'self::decode', $text);
+               $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', 'self::decode', $text);
 
-               return $s;
+               return $text;
        }
 
        /**
@@ -211,38 +244,41 @@ class Smilies
         */
        private static function encode($m)
        {
-               return(str_replace($m[1], base64url_encode($m[1]), $m[0]));
+               return '<' . $m[1] . '>' . Strings::base64UrlEncode($m[2]) . '</' . $m[1] . '>';
        }
 
        /**
         * @param string $m string
         *
         * @return string base64 decoded string
+        * @throws \Exception
         */
        private static function decode($m)
        {
-               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
+        * expand <3333 to the correct number of hearts
         *
         * @param string $x string
         *
         * @return string HTML Output
         *
-        * @todo: Rework because it doesn't work correctly
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private static function pregHeart($x)
        {
                if (strlen($x[1]) == 1) {
                        return $x[0];
                }
+
                $t = '';
                for ($cnt = 0; $cnt < strlen($x[1]); $cnt ++) {
-                       $t .= '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-heart.gif" alt="&lt;3" />';
+                       $t .= '';
                }
+
                $r =  str_replace($x[0], $t, $x[0]);
                return $r;
        }