4 * @file src/Content/Smilies.php
5 * This file contains the Smilies class which contains functions to handle smiles
7 * @todo Use the shortcodes from here:
8 * https://github.com/iamcal/emoji-data/blob/master/emoji_pretty.json?raw=true
9 * https://raw.githubusercontent.com/emojione/emojione/master/extras/alpha-codes/eac.json?raw=true
10 * https://github.com/johannhof/emoji-helper/blob/master/data/emoji.json?raw=true
12 * Have also a look here:
13 * https://www.webpagefx.com/tools/emoji-cheat-sheet/
15 namespace Friendica\Content;
17 use Friendica\Core\Hook;
19 use Friendica\Util\Strings;
22 * This class contains functions to handle smiles
28 * Replaces/adds the emoticon list
30 * This function should be used whenever emoticons are added
32 * @param array $b Array of emoticons
33 * @param string $smiley The text smilie
34 * @param string $representation The replacement
38 public static function add(&$b, $smiley, $representation)
40 $found = array_search($smiley, $b['texts']);
42 if (!is_int($found)) {
43 $b['texts'][] = $smiley;
44 $b['icons'][] = $representation;
46 $b['icons'][$found] = $representation;
51 * Function to list all smilies
53 * Get an array of all smilies, both internal and from addons.
56 * 'texts' => smilie shortcut
57 * 'icons' => icon in html
59 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
60 * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array)
62 public static function getList()
103 $baseUrl = DI::baseUrl();
106 '<img class="smiley" src="' . $baseUrl . '/images/smiley-heart.gif" alt="<3" title="<3" />',
107 '<img class="smiley" src="' . $baseUrl . '/images/smiley-brokenheart.gif" alt="</3" title="</3" />',
108 '<img class="smiley" src="' . $baseUrl . '/images/smiley-brokenheart.gif" alt="<\\3" title="<\\3" />',
109 '<img class="smiley" src="' . $baseUrl . '/images/smiley-smile.gif" alt=":-)" title=":-)" />',
110 '<img class="smiley" src="' . $baseUrl . '/images/smiley-wink.gif" alt=";-)" title=";-)" />',
111 '<img class="smiley" src="' . $baseUrl . '/images/smiley-frown.gif" alt=":-(" title=":-(" />',
112 '<img class="smiley" src="' . $baseUrl . '/images/smiley-tongue-out.gif" alt=":-P" title=":-P" />',
113 '<img class="smiley" src="' . $baseUrl . '/images/smiley-tongue-out.gif" alt=":-p" title=":-P" />',
114 '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
115 '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
116 '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-x" title=":-x" />',
117 '<img class="smiley" src="' . $baseUrl . '/images/smiley-kiss.gif" alt=":-X" title=":-X" />',
118 '<img class="smiley" src="' . $baseUrl . '/images/smiley-laughing.gif" alt=":-D" title=":-D" />',
119 '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt="8-|" title="8-|" />',
120 '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt="8-O" title="8-O" />',
121 '<img class="smiley" src="' . $baseUrl . '/images/smiley-surprised.gif" alt=":-O" title="8-O" />',
122 '<img class="smiley" src="' . $baseUrl . '/images/smiley-thumbsup.gif" alt="\\o/" title="\\o/" />',
123 '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="o.O" title="o.O" />',
124 '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="O.o" title="O.o" />',
125 '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="o_O" title="o_O" />',
126 '<img class="smiley" src="' . $baseUrl . '/images/smiley-Oo.gif" alt="O_o" title="O_o" />',
127 '<img class="smiley" src="' . $baseUrl . '/images/smiley-cry.gif" alt=":\'(" title=":\'("/>',
128 '<img class="smiley" src="' . $baseUrl . '/images/smiley-foot-in-mouth.gif" alt=":-!" title=":-!" />',
129 '<img class="smiley" src="' . $baseUrl . '/images/smiley-undecided.gif" alt=":-/" title=":-/" />',
130 '<img class="smiley" src="' . $baseUrl . '/images/smiley-embarassed.gif" alt=":-[" title=":-[" />',
131 '<img class="smiley" src="' . $baseUrl . '/images/smiley-cool.gif" alt="8-)" title="8-)" />',
132 '<img class="smiley" src="' . $baseUrl . '/images/beer_mug.gif" alt=":beer" title=":beer" />',
133 '<img class="smiley" src="' . $baseUrl . '/images/beer_mug.gif" alt=":homebrew" title=":homebrew" />',
134 '<img class="smiley" src="' . $baseUrl . '/images/coffee.gif" alt=":coffee" title=":coffee" />',
135 '<img class="smiley" src="' . $baseUrl . '/images/smiley-facepalm.gif" alt=":facepalm" title=":facepalm" />',
136 '<img class="smiley" src="' . $baseUrl . '/images/like.gif" alt=":like" title=":like" />',
137 '<img class="smiley" src="' . $baseUrl . '/images/dislike.gif" alt=":dislike" title=":dislike" />',
138 '<a href="https://friendi.ca">~friendica <img class="smiley" src="' . $baseUrl . '/images/friendica-16.png" alt="~friendica" title="~friendica" /></a>',
139 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . $baseUrl . '/images/rm-16.png" alt="red#" title="red#" />matrix</a>',
140 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . $baseUrl . '/images/rm-16.png" alt="red#matrix" title="red#matrix" />matrix</a>'
143 $params = ['texts' => $texts, 'icons' => $icons];
144 Hook::callAll('smilie', $params);
151 * Copied from http://php.net/manual/en/function.str-replace.php#88569
152 * Modified for camel caps: renamed stro_replace -> strOrigReplace
154 * When using str_replace(...), values that did not exist in the original string (but were put there by previous
155 * replacements) will be replaced continuously. This string replacement function is designed to replace the values
156 * in $search with those in $replace while not factoring in prior replacements. Note that this function will
157 * always look for the longest possible match first and then work its way down to individual characters.
159 * @param array $search list of strings or characters that need to be replaced
160 * @param array $replace list of strings or characters that will replace the corresponding values in $search
161 * @param string $subject the string on which this operation is being performed
163 * @return string $subject with all substrings in the $search array replaced by the values in the $replace array
165 private static function strOrigReplace($search, $replace, $subject)
167 return strtr($subject, array_combine($search, $replace));
171 * Replaces text emoticons with graphical images
173 * It is expected that this function will be called using HTML text.
174 * We will escape text between HTML pre and code blocks from being
177 * At a higher level, the bbcode [nosmile] tag can be used to prevent this
178 * function from being executed by the prepare_text() routine when preparing
179 * bbcode source for HTML display
181 * @param string $s Text that should be replaced
182 * @param boolean $no_images Only replace emoticons without images
184 * @return string HTML Output of the Smilie
185 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
187 public static function replace($s, $no_images = false)
189 $smilies = self::getList();
191 $s = self::replaceFromArray($s, $smilies, $no_images);
197 * Replaces emoji shortcodes in a string from a structured array of searches and replaces.
199 * Depends on system.no_smilies config value, skips <pre> and <code> tags.
201 * @param string $text An HTML string
202 * @param array $smilies An string replacement array with the following structure: ['texts' => [], 'icons' => []]
203 * @param bool $no_images Only replace shortcodes without image replacement (e.g. Unicode characters)
205 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
207 public static function replaceFromArray($text, array $smilies, $no_images = false)
209 if (intval(DI::config()->get('system', 'no_smilies'))
210 || (local_user() && intval(DI::pConfig()->get(local_user(), 'system', 'no_smilies')))
215 $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', 'self::encode', $text);
216 $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', 'self::encode', $text);
219 $cleaned = ['texts' => [], 'icons' => []];
220 $icons = $smilies['icons'];
221 foreach ($icons as $key => $icon) {
222 if (!strstr($icon, '<img ')) {
223 $cleaned['texts'][] = $smilies['texts'][$key];
224 $cleaned['icons'][] = $smilies['icons'][$key];
230 $text = preg_replace_callback('/<(3+)/', 'self::pregHeart', $text);
231 $text = self::strOrigReplace($smilies['texts'], $smilies['icons'], $text);
233 $text = preg_replace_callback('/<(code)>(.*?)<\/code>/ism', 'self::decode', $text);
234 $text = preg_replace_callback('/<(pre)>(.*?)<\/pre>/ism', 'self::decode', $text);
240 * @param string $m string
242 * @return string base64 encoded string
244 private static function encode($m)
246 return '<' . $m[1] . '>' . Strings::base64UrlEncode($m[2]) . '</' . $m[1] . '>';
250 * @param string $m string
252 * @return string base64 decoded string
255 private static function decode($m)
257 return '<' . $m[1] . '>' . Strings::base64UrlDecode($m[2]) . '</' . $m[1] . '>';
262 * expand <3333 to the correct number of hearts
264 * @param string $x string
266 * @return string HTML Output
268 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
270 private static function pregHeart($x)
272 if (strlen($x[1]) == 1) {
277 for ($cnt = 0; $cnt < strlen($x[1]); $cnt ++) {
281 $r = str_replace($x[0], $t, $x[0]);