src/Content/Smilies.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Content;
  23
  24 use Friendica\Content\Text\BBCode;
  25 use Friendica\Core\Hook;
  26 use Friendica\DI;
  27 use Friendica\Util\Strings;
  28
  29 /**
  30  * This class contains functions to handle smiles
  31  */
  32
  33 class Smilies
  34 {
  35         /**
  36          * Replaces/adds the emoticon list
  37          *
  38          * This function should be used whenever emoticons are added
  39          *
  40          * @param array  $b              Array of emoticons
  41          * @param string $smiley         The text smilie
  42          * @param string $representation The replacement
  43          * @return void
  44          */
  45         public static function add(array &$b, string $smiley, string $representation)
  46         {
  47                 $found = array_search($smiley, $b['texts']);
  48
  49                 if (!is_int($found)) {
  50                         $b['texts'][] = $smiley;
  51                         $b['icons'][] = $representation;
  52                 } else {
  53                         $b['icons'][$found] = $representation;
  54                 }
  55         }
  56
  57         /**
  58          * Function to list all smilies
  59          *
  60          * Get an array of all smilies, both internal and from addons.
  61          *
  62          * @return array
  63          *    'texts' => smilie shortcut
  64          *    'icons' => icon in html
  65          *
  66          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  67          * @hook  smilie ('texts' => smilies texts array, 'icons' => smilies html array)
  68          */
  69         public static function getList(): array
  70         {
  71                 $texts = [
  72                         '&lt;3',
  73                         '&lt;/3',
  74                         '&lt;\\3',
  75                         ':-)',
  76                         ';-)',
  77                         ':-(',
  78                         ':-P',
  79                         ':-p',
  80                         ':-"',
  81                         ':-&quot;',
  82                         ':-x',
  83                         ':-X',
  84                         ':-D',
  85                         '8-|',
  86                         '8-O',
  87                         ':-O',
  88                         '\\o/',
  89                         'o.O',
  90                         'O.o',
  91                         'o_O',
  92                         'O_o',
  93                         ":'(",
  94                         ":-!",
  95                         ":-/",
  96                         ":-[",
  97                         "8-)",
  98                         ':beer',
  99                         ':homebrew',
 100                         ':coffee',
 101                         ':facepalm',
 102                         ':like',
 103                         ':dislike',
 104                         '~friendica',
 105                         'red#',
 106                         'red#matrix'
 107
 108                 ];
 109
 110                 $baseUrl = (string)DI::baseUrl();
 111
 112                 $icons = [
 113                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-heart.gif" alt="&lt;3" title="&lt;3" />',
 114                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-brokenheart.gif" alt="&lt;/3" title="&lt;/3" />',
 115                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-brokenheart.gif" alt="&lt;\\3" title="&lt;\\3" />',
 116                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-smile.gif" alt=":-)" title=":-)" />',
 117                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-wink.gif" alt=";-)" title=";-)" />',
 118                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-frown.gif" alt=":-(" title=":-(" />',
 119                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-tongue-out.gif" alt=":-P" title=":-P" />',
 120                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-tongue-out.gif" alt=":-p" title=":-P" />',
 121                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
 122                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
 123                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-x" title=":-x" />',
 124                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-X" title=":-X" />',
 125                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-laughing.gif" alt=":-D" title=":-D"  />',
 126                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt="8-|" title="8-|" />',
 127                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt="8-O" title="8-O" />',
 128                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt=":-O" title="8-O" />',
 129                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-thumbsup.gif" alt="\\o/" title="\\o/" />',
 130                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="o.O" title="o.O" />',
 131                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="O.o" title="O.o" />',
 132                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="o_O" title="o_O" />',
 133                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="O_o" title="O_o" />',
 134                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-cry.gif" alt=":\'(" title=":\'("/>',
 135                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-foot-in-mouth.gif" alt=":-!" title=":-!" />',
 136                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-undecided.gif" alt=":-/" title=":-/" />',
 137                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-embarrassed.gif" alt=":-[" title=":-[" />',
 138                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-cool.gif" alt="8-)" title="8-)" />',
 139                 '<img class="smiley" src="' . $baseUrl . '/images/beer_mug.gif" alt=":beer" title=":beer" />',
 140                 '<img class="smiley" src="' . $baseUrl . '/images/beer_mug.gif" alt=":homebrew" title=":homebrew" />',
 141                 '<img class="smiley" src="' . $baseUrl . '/images/coffee.gif" alt=":coffee" title=":coffee" />',
 142                 '<img class="smiley" src="' . $baseUrl . '/images/smiley-facepalm.gif" alt=":facepalm" title=":facepalm" />',
 143                 '<img class="smiley" src="' . $baseUrl . '/images/like.gif" alt=":like" title=":like" />',
 144                 '<img class="smiley" src="' . $baseUrl . '/images/dislike.gif" alt=":dislike" title=":dislike" />',
 145                 '<a href="https://friendi.ca">~friendica <img class="smiley" width="16" height="16" src="' . $baseUrl . '/images/friendica.svg" alt="~friendica" title="~friendica" /></a>',
 146                 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . $baseUrl . '/images/rm-16.png" alt="red#" title="red#" />matrix</a>',
 147                 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . $baseUrl . '/images/rm-16.png" alt="red#matrix" title="red#matrix" />matrix</a>'
 148                 ];
 149
 150                 $params = ['texts' => $texts, 'icons' => $icons];
 151                 Hook::callAll('smilie', $params);
 152
 153                 return $params;
 154         }
 155
 156         /**
 157          * Finds all used smilies (denoted by quoting colons like :heart:) in the provided text and normalizes their usages.
 158          *
 159          * @param string $text that might contain smiley usages
 160          * @return array with smilie codes (colon included) as the keys, their image urls as values;
 161          *               the normalized string is put under the '' (empty string) key
 162          */
 163         public static function extractUsedSmilies(string $text, string &$normalized = null): array
 164         {
 165                 $emojis = [];
 166
 167                 $normalized = BBCode::performWithEscapedTags($text, ['code'], function ($text) use (&$emojis) {
 168                         return BBCode::performWithEscapedTags($text, ['noparse', 'nobb', 'pre'], function ($text) use (&$emojis) {
 169                                 if (strpos($text, '[nosmile]') !== false || self::noSmilies()) {
 170                                         return $text;
 171                                 }
 172                                 $smilies = self::getList();
 173                                 $normalized = [];
 174                                 return self::performForEachWordMatch(
 175                                         array_combine($smilies['texts'], $smilies['icons']),
 176                                         $text,
 177                                         function (string $name, string $image) use($normalized, &$emojis) {
 178                                                 if (array_key_exists($name, $normalized)) {
 179                                                         return $normalized[$name];
 180                                                 }
 181                                                 if (preg_match('/src="(.+?)"/', $image, $match)) {
 182                                                         $url = $match[1];
 183                                                         // Image smilies, which should be normalized instead of being embedded for some protocols like ActivityPub.
 184                                                         // Normalize name
 185                                                         $norm = preg_replace('/[\s\-:#~]/', '', $name);
 186                                                         if (!ctype_alnum($norm)) {
 187                                                                 if (preg_match('#/smiley-(\w+)\.gif#', $url, $match)) {
 188                                                                         $norm = $match[1];
 189                                                                 } else {
 190                                                                         $norm = 'smiley' . count($normalized);
 191                                                                 }
 192                                                         }
 193                                                         $shortcode = ':' . $norm . ':';
 194                                                         $normalized[$name] = $shortcode;
 195                                                         $emojis[$norm] = $url;
 196                                                         return $shortcode;
 197                                                 } else {
 198                                                         $normalized[$name] = $image;
 199                                                         // Probably text-substitution smilies (e.g., Unicode ones).
 200                                                         return $image;
 201                                                 }
 202                                         },
 203                                 );
 204                         });
 205                 });
 206
 207                 return $emojis;
 208         }
 209
 210         /**
 211          * Similar to strtr but matches only whole words and replaces texts with $callback.
 212          *
 213          * @param array $words
 214          * @param string $subject
 215          * @param callable $callback ($offset, $value)
 216          * @return string
 217          */
 218         private static function performForEachWordMatch(array $words, string $subject, callable $callback): string
 219         {
 220                 $ord1_bitset = 0;
 221                 $ord2_bitset = 0;
 222                 $prefixes = [];
 223                 foreach ($words as $word => $_) {
 224                         if (strlen($word) < 2) {
 225                                 continue;
 226                         }
 227                         $ord1 = ord($word[0]);
 228                         $ord2 = ord($word[1]);
 229                         // A smiley shortcode must not begin or end with whitespaces.
 230                         if (ctype_space($word[0]) || ctype_space($word[strlen($word) - 1])) {
 231                                 continue;
 232                         }
 233                         $ord1_bitset |= 1 << ($ord1 & 31);
 234                         $ord2_bitset |= 1 << ($ord2 & 31);
 235                         if (!array_key_exists($word[0], $prefixes)) {
 236                                 $prefixes[$word[0]] = [];
 237                         }
 238                         $prefixes[$word[0]][] = $word;
 239                 }
 240
 241                 $slength = strlen($subject);
 242                 $result = '';
 243                 // $processed is used to delay string concatenation since appending a char every loop is inefficient.
 244                 $processed = 0;
 245                 // Find possible starting points for smilies.
 246                 // For built-in smilies, the two bitsets should make attempts quite efficient.
 247                 // However, presuming custom smilies follow the format of ":shortcode" or ":shortcode:",
 248                 // if the user adds more smilies (with addons), the second bitset may eventually become useless.
 249                 for ($i = 0; $i < $slength - 1; $i++) {
 250                         $c = $subject[$i];
 251                         $d = $subject[$i + 1];
 252                         if (($ord1_bitset & (1 << (ord($c) & 31))) && ($ord2_bitset & (1 << (ord($d) & 31))) && array_key_exists($c, $prefixes)) {
 253                                 foreach ($prefixes[$c] as $word) {
 254                                         $wlength = strlen($word);
 255                                         if (substr($subject, $i, $wlength) === $word) {
 256                                                 // Check for boundaries
 257                                                 if (($i === 0 || ctype_space($subject[$i - 1]) || ctype_punct($subject[$i - 1]))
 258                                                         && ($i + $wlength >= $slength || ctype_space($subject[$i + $wlength]) || ctype_punct($subject[$i + $wlength]))) {
 259                                                         $result .= substr($subject, $processed, $i - $processed);
 260                                                         $result .= call_user_func($callback, $word, $words[$word]);
 261                                                         $i += $wlength;
 262                                                         $processed = $i;
 263                                                         $i--;
 264                                                         break;
 265                                                 }
 266                                         }
 267                                 }
 268                         }
 269                 }
 270                 if ($processed < $slength) {
 271                         $result .= substr($subject, $processed);
 272                 }
 273                 return $result;
 274         }
 275
 276         /**
 277          * Copied from http://php.net/manual/en/function.str-replace.php#88569
 278          * Modified for camel caps: renamed stro_replace -> strOrigReplace
 279          *
 280          * When using str_replace(...), values that did not exist in the original string (but were put there by previous
 281          * replacements) will be replaced continuously.  This string replacement function is designed to replace the values
 282          * in $search with those in $replace while not factoring in prior replacements.  Note that this function will
 283          * always look for the longest possible match first and then work its way down to individual characters.
 284          *
 285          * @param array $search list of strings or characters that need to be replaced
 286          * @param array $replace list of strings or characters that will replace the corresponding values in $search
 287          * @param string $subject the string on which this operation is being performed
 288          *
 289          * @return string $subject with all substrings in the $search array replaced by the values in the $replace array
 290          */
 291         private static function strOrigReplace(array $search, array $replace, string $subject): string
 292         {
 293                 return self::performForEachWordMatch(
 294                         array_combine($search, $replace),
 295                         $subject,
 296                         function (string $_, string $value) {
 297                                 return $value;
 298                         }
 299                 );
 300         }
 301
 302         /**
 303          * Replaces text emoticons with graphical images
 304          *
 305          * It is expected that this function will be called using HTML text.
 306          * We will escape text between HTML pre and code blocks from being
 307          * processed.
 308          *
 309          * At a higher level, the bbcode [nosmile] tag can be used to prevent this
 310          * function from being executed by the prepare_text() routine when preparing
 311          * bbcode source for HTML display
 312          *
 313          * @param string  $s         Text that should be replaced
 314          * @param boolean $no_images Only replace emoticons without images
 315          *
 316          * @return string HTML Output of the Smilie
 317          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 318          */
 319         public static function replace(string $s, bool $no_images = false): string
 320         {
 321                 $smilies = self::getList();
 322
 323                 $s = self::replaceFromArray($s, $smilies, $no_images);
 324
 325                 return $s;
 326         }
 327
 328         private static function noSmilies(): bool {
 329                 return (intval(DI::config()->get('system', 'no_smilies')) ||
 330                                 (DI::userSession()->getLocalUserId() &&
 331                                  intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'no_smilies'))));
 332         }
 333
 334         /**
 335          * Replaces emoji shortcodes in a string from a structured array of searches and replaces.
 336          *
 337          * Depends on system.no_smilies config value, skips <pre> and <code> tags.
 338          *
 339          * @param string $text      An HTML string
 340          * @param array  $smilies   An string replacement array with the following structure: ['texts' => [], 'icons' => []]
 341          * @param bool   $no_images Only replace shortcodes without image replacement (e.g. Unicode characters)
 342          * @return string
 343          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 344          */
 345         public static function replaceFromArray(string $text, array $smilies, bool $no_images = false): string
 346         {
 347                 if (self::noSmilies()) {
 348                         return $text;
 349                 }
 350
 351                 $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', [self::class, 'encode'], $text);
 352                 $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', [self::class, 'encode'], $text);
 353
 354                 if ($no_images) {
 355                         $cleaned = ['texts' => [], 'icons' => []];
 356                         $icons = $smilies['icons'];
 357                         foreach ($icons as $key => $icon) {
 358                                 if (!strstr($icon, '<img ')) {
 359                                         $cleaned['texts'][] = $smilies['texts'][$key];
 360                                         $cleaned['icons'][] = $smilies['icons'][$key];
 361                                 }
 362                         }
 363                         $smilies = $cleaned;
 364                 }
 365
 366                 $text = preg_replace_callback('/\B&lt;3+?\b/', [self::class, 'heartReplaceCallback'], $text);
 367                 $text = self::strOrigReplace($smilies['texts'], $smilies['icons'], $text);
 368
 369                 $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', [self::class, 'decode'], $text);
 370                 $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', [self::class, 'decode'], $text);
 371
 372                 return $text;
 373         }
 374
 375         /**
 376          * Encodes smiley match array to BASE64 string
 377          *
 378          * @param array $m Match array
 379          * @return string base64 encoded string
 380          */
 381         private static function encode(array $m): string
 382         {
 383                 return '<' . $m[1] . '>' . Strings::base64UrlEncode($m[2]) . '</' . $m[1] . '>';
 384         }
 385
 386         /**
 387          * Decodes a previously BASE64-encoded match array to a string
 388          *
 389          * @param array $m Matches array
 390          * @return string base64 decoded string
 391          * @throws \Exception
 392          */
 393         private static function decode(array $m): string
 394         {
 395                 return '<' . $m[1] . '>' . Strings::base64UrlDecode($m[2]) . '</' . $m[1] . '>';
 396         }
 397
 398
 399         /**
 400          * expand <3333 to the correct number of hearts
 401          *
 402          * @param array $matches
 403          * @return string HTML Output
 404          */
 405         private static function heartReplaceCallback(array $matches): string
 406         {
 407                 return str_repeat('❤', strlen($matches[0]) - 4);
 408         }
 409
 410         /**
 411          * Checks if the body doesn't contain any alphanumeric characters
 412          *
 413          * @param string $body Possibly-HTML post body
 414          * @return boolean
 415          */
 416         public static function isEmojiPost(string $body): bool
 417         {
 418                 // Strips all whitespace
 419                 $conv = preg_replace('#\s#u', '', html_entity_decode($body));
 420                 if (empty($conv)) {
 421                         return false;
 422                 }
 423
 424                 if (!class_exists('IntlChar')) {
 425                         // Most Emojis are 4 byte Unicode characters, so this is a good workaround, when IntlChar does not exist on the system
 426                         return strlen($conv) / mb_strlen($conv) == 4;
 427                 }
 428
 429                 for ($i = 0; $i < mb_strlen($conv); $i++) {
 430                         $character = mb_substr($conv, $i, 1);
 431
 432                         if (\IntlChar::isalnum($character) || \IntlChar::ispunct($character) || \IntlChar::isgraph($character) && (strlen($character) <= 2)) {
 433                                 return false;
 434                         }
 435                 }
 436                 return true;
 437         }
 438 }