]> git.mxchange.org Git - friendica.git/blob - src/Content/Smilies.php
Merge pull request #6127 from annando/notice
[friendica.git] / src / Content / Smilies.php
1 <?php
2
3 /**
4  * @file src/Content/Smilies.php
5  * @brief This file contains the Smilies class which contains functions to handle smiles
6  *
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
11  *
12  * Have also a look here:
13  * https://www.webpagefx.com/tools/emoji-cheat-sheet/
14  */
15 namespace Friendica\Content;
16
17 use Friendica\App;
18 use Friendica\Core\Addon;
19 use Friendica\Core\Config;
20 use Friendica\Core\PConfig;
21 use Friendica\Core\System;
22 use Friendica\Util\Strings;
23
24 /**
25  * This class contains functions to handle smiles
26  */
27
28 class Smilies
29 {
30         /**
31          * @brief Replaces/adds the emoticon list
32          *
33          * This function should be used whenever emoticons are added
34          *
35          * @param array  $b              Array of emoticons
36          * @param string $smiley         The text smilie
37          * @param string $representation The replacement
38          *
39          * @return void
40          */
41         public static function add(&$b, $smiley, $representation)
42         {
43                 $found = array_search($smiley, $b['texts']);
44
45                 if (!is_int($found)) {
46                         $b['texts'][] = $smiley;
47                         $b['icons'][] = $representation;
48                 } else {
49                         $b['icons'][$found] = $representation;
50                 }
51         }
52
53         /**
54          * @brief Function to list all smilies
55          *
56          * Get an array of all smilies, both internal and from addons.
57          *
58          * @return array
59          *      'texts' => smilie shortcut
60          *      'icons' => icon in html
61          *
62          * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array)
63          */
64         public static function getList()
65         {
66                 $texts =  [
67                         '&lt;3',
68                         '&lt;/3',
69                         '&lt;\\3',
70                         ':-)',
71                         ';-)',
72                         ':-(',
73                         ':-P',
74                         ':-p',
75                         ':-"',
76                         ':-&quot;',
77                         ':-x',
78                         ':-X',
79                         ':-D',
80                         '8-|',
81                         '8-O',
82                         ':-O',
83                         '\\o/',
84                         'o.O',
85                         'O.o',
86                         'o_O',
87                         'O_o',
88                         ":'(",
89                         ":-!",
90                         ":-/",
91                         ":-[",
92                         "8-)",
93                         ':beer',
94                         ':homebrew',
95                         ':coffee',
96                         ':facepalm',
97                         ':like',
98                         ':dislike',
99                         '~friendica',
100                         'red#',
101                         'red#matrix'
102
103                 ];
104
105                 $icons = [
106                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-heart.gif" alt="&lt;3" title="&lt;3" />',
107                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-brokenheart.gif" alt="&lt;/3" title="&lt;/3" />',
108                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-brokenheart.gif" alt="&lt;\\3" title="&lt;\\3" />',
109                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-smile.gif" alt=":-)" title=":-)" />',
110                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-wink.gif" alt=";-)" title=";-)" />',
111                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-frown.gif" alt=":-(" title=":-(" />',
112                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-tongue-out.gif" alt=":-P" title=":-P" />',
113                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-tongue-out.gif" alt=":-p" title=":-P" />',
114                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
115                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
116                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-kiss.gif" alt=":-x" title=":-x" />',
117                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-kiss.gif" alt=":-X" title=":-X" />',
118                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-laughing.gif" alt=":-D" title=":-D"  />',
119                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-surprised.gif" alt="8-|" title="8-|" />',
120                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-surprised.gif" alt="8-O" title="8-O" />',
121                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-surprised.gif" alt=":-O" title="8-O" />',
122                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-thumbsup.gif" alt="\\o/" title="\\o/" />',
123                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-Oo.gif" alt="o.O" title="o.O" />',
124                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-Oo.gif" alt="O.o" title="O.o" />',
125                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-Oo.gif" alt="o_O" title="o_O" />',
126                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-Oo.gif" alt="O_o" title="O_o" />',
127                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-cry.gif" alt=":\'(" title=":\'("/>',
128                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-foot-in-mouth.gif" alt=":-!" title=":-!" />',
129                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-undecided.gif" alt=":-/" title=":-/" />',
130                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-embarassed.gif" alt=":-[" title=":-[" />',
131                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-cool.gif" alt="8-)" title="8-)" />',
132                 '<img class="smiley" src="' . System::baseUrl() . '/images/beer_mug.gif" alt=":beer" title=":beer" />',
133                 '<img class="smiley" src="' . System::baseUrl() . '/images/beer_mug.gif" alt=":homebrew" title=":homebrew" />',
134                 '<img class="smiley" src="' . System::baseUrl() . '/images/coffee.gif" alt=":coffee" title=":coffee" />',
135                 '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-facepalm.gif" alt=":facepalm" title=":facepalm" />',
136                 '<img class="smiley" src="' . System::baseUrl() . '/images/like.gif" alt=":like" title=":like" />',
137                 '<img class="smiley" src="' . System::baseUrl() . '/images/dislike.gif" alt=":dislike" title=":dislike" />',
138                 '<a href="https://friendi.ca">~friendica <img class="smiley" src="' . System::baseUrl() . '/images/friendica-16.png" alt="~friendica" title="~friendica" /></a>',
139                 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . System::baseUrl() . '/images/rm-16.png" alt="red#" title="red#" />matrix</a>',
140                 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . System::baseUrl() . '/images/rm-16.png" alt="red#matrix" title="red#matrix" />matrix</a>'
141                 ];
142
143                 $params = ['texts' => $texts, 'icons' => $icons];
144                 Addon::callHooks('smilie', $params);
145
146                 return $params;
147         }
148
149
150         /**
151          * Copied from http://php.net/manual/en/function.str-replace.php#88569
152          * Modified for camel caps: renamed stro_replace -> strOrigReplace
153          *
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.
158          *
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
162          *
163          * @return string $subject with all substrings in the $search array replaced by the values in the $replace array
164          */
165         private static function strOrigReplace($search, $replace, $subject)
166         {
167                 return strtr($subject, array_combine($search, $replace));
168         }
169
170         /**
171          * Replaces text emoticons with graphical images
172          *
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
175          * processed.
176          *
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
180          *
181          * @brief Replaces text emoticons with graphical images
182          * @param string  $s         Text that should be replaced
183          * @param boolean $no_images Only replace emoticons without images
184          *
185          * @return string HTML Output of the Smilie
186          */
187         public static function replace($s, $no_images = false)
188         {
189                 $smilies = self::getList();
190
191                 $s = self::replaceFromArray($s, $smilies, $no_images);
192
193                 return $s;
194         }
195
196         /**
197          * Replaces emoji shortcodes in a string from a structured array of searches and replaces.
198          *
199          * Depends on system.no_smilies config value, skips <pre> and <code> tags.
200          *
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)
204          * @return string
205          */
206         public static function replaceFromArray($text, array $smilies, $no_images = false)
207         {
208                 if (intval(Config::get('system', 'no_smilies'))
209                         || (local_user() && intval(PConfig::get(local_user(), 'system', 'no_smilies')))
210                 ) {
211                         return $text;
212                 }
213
214                 $text = preg_replace_callback('/<pre>(.*?)<\/pre>/ism'  , 'self::encode', $text);
215                 $text = preg_replace_callback('/<code>(.*?)<\/code>/ism', 'self::encode', $text);
216
217                 if ($no_images) {
218                         $cleaned = ['texts' => [], 'icons' => []];
219                         $icons = $smilies['icons'];
220                         foreach ($icons as $key => $icon) {
221                                 if (!strstr($icon, '<img ')) {
222                                         $cleaned['texts'][] = $smilies['texts'][$key];
223                                         $cleaned['icons'][] = $smilies['icons'][$key];
224                                 }
225                         }
226                         $smilies = $cleaned;
227                 }
228
229                 $text = preg_replace_callback('/&lt;(3+)/', 'self::pregHeart', $text);
230                 $text = self::strOrigReplace($smilies['texts'], $smilies['icons'], $text);
231
232                 $text = preg_replace_callback('/<pre>(.*?)<\/pre>/ism', 'self::decode', $text);
233                 $text = preg_replace_callback('/<code>(.*?)<\/code>/ism', 'self::decode', $text);
234
235                 return $text;
236         }
237
238         /**
239          * @param string $m string
240          *
241          * @return string base64 encoded string
242          */
243         private static function encode($m)
244         {
245                 return(str_replace($m[1], Strings::base64UrlEncode($m[1]), $m[0]));
246         }
247
248         /**
249          * @param string $m string
250          *
251          * @return string base64 decoded string
252          */
253         private static function decode($m)
254         {
255                 return(str_replace($m[1], Strings::base64UrlDecode($m[1]), $m[0]));
256         }
257
258
259         /**
260          * @brief expand <3333 to the correct number of hearts
261          *
262          * @param string $x string
263          *
264          * @return string HTML Output
265          *
266          * @todo: Rework because it doesn't work correctly
267          */
268         private static function pregHeart($x)
269         {
270                 if (strlen($x[1]) == 1) {
271                         return $x[0];
272                 }
273                 $t = '';
274                 for ($cnt = 0; $cnt < strlen($x[1]); $cnt ++) {
275                         $t .= '<img class="smiley" src="' . System::baseUrl() . '/images/smiley-heart.gif" alt="&lt;3" />';
276                 }
277                 $r =  str_replace($x[0], $t, $x[0]);
278                 return $r;
279         }
280 }