mirror of
https://github.com/friendica/friendica
synced 2024-11-14 11:42:55 +00:00
ffc8b2a79a
- Add new replaceFromArray function to enable smilies replacement with an arbitrary array - Moved $sample logic from class to module
279 lines
10 KiB
PHP
279 lines
10 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file src/Content/Smilies.php
|
|
* @brief 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
|
|
* 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
|
|
*
|
|
* 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;
|
|
|
|
/**
|
|
* This class contains functions to handle smiles
|
|
*/
|
|
|
|
class Smilies
|
|
{
|
|
/**
|
|
* @brief 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)
|
|
{
|
|
$found = array_search($smiley, $b['texts']);
|
|
|
|
if (!is_int($found)) {
|
|
$b['texts'][] = $smiley;
|
|
$b['icons'][] = $representation;
|
|
} else {
|
|
$b['icons'][$found] = $representation;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief 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
|
|
*
|
|
* @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array)
|
|
*/
|
|
public static function getList()
|
|
{
|
|
$texts = [
|
|
'<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',
|
|
'red#',
|
|
'red#matrix'
|
|
|
|
];
|
|
|
|
$icons = [
|
|
'<img class="smiley" src="' . System::baseUrl() . '/images/smiley-heart.gif" alt="<3" title="<3" />',
|
|
'<img class="smiley" src="' . System::baseUrl() . '/images/smiley-brokenheart.gif" alt="</3" title="</3" />',
|
|
'<img class="smiley" src="' . System::baseUrl() . '/images/smiley-brokenheart.gif" alt="<\\3" title="<\\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 = ['texts' => $texts, 'icons' => $icons];
|
|
Addon::callHooks('smilie', $params);
|
|
|
|
return $params;
|
|
}
|
|
|
|
|
|
/**
|
|
* 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
|
|
* processed.
|
|
*
|
|
* At a higher level, the bbcode [nosmile] tag can be used to prevent this
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
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')))
|
|
) {
|
|
return $text;
|
|
}
|
|
|
|
$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 = $smilies['icons'];
|
|
foreach ($icons as $key => $icon) {
|
|
if (!strstr($icon, '<img ')) {
|
|
$cleaned['texts'][] = $smilies['texts'][$key];
|
|
$cleaned['icons'][] = $smilies['icons'][$key];
|
|
}
|
|
}
|
|
$smilies = $cleaned;
|
|
}
|
|
|
|
$text = preg_replace_callback('/<(3+)/', 'self::pregHeart', $text);
|
|
$text = self::strOrigReplace($smilies['texts'], $smilies['icons'], $text);
|
|
|
|
$text = preg_replace_callback('/<pre>(.*?)<\/pre>/ism', 'self::decode', $text);
|
|
$text = preg_replace_callback('/<code>(.*?)<\/code>/ism', 'self::decode', $text);
|
|
|
|
return $text;
|
|
}
|
|
|
|
/**
|
|
* @param string $m string
|
|
*
|
|
* @return string base64 encoded string
|
|
*/
|
|
private static function encode($m)
|
|
{
|
|
return(str_replace($m[1], base64url_encode($m[1]), $m[0]));
|
|
}
|
|
|
|
/**
|
|
* @param string $m string
|
|
*
|
|
* @return string base64 decoded string
|
|
*/
|
|
private static function decode($m)
|
|
{
|
|
return(str_replace($m[1], base64url_decode($m[1]), $m[0]));
|
|
}
|
|
|
|
|
|
/**
|
|
* @brief expand <3333 to the correct number of hearts
|
|
*
|
|
* @param string $x string
|
|
*
|
|
* @return string HTML Output
|
|
*
|
|
* @todo: Rework because it doesn't work correctly
|
|
*/
|
|
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="<3" />';
|
|
}
|
|
$r = str_replace($x[0], $t, $x[0]);
|
|
return $r;
|
|
}
|
|
}
|