include/Smilies.php

   1 <?php
   2
   3 /**
   4  * @file include/Smilies.php
   5  * @brief This file contains the Smilies class which contains functions to handle smiles
   6  */
   7
   8 use Friendica\App;
   9
  10 /**
  11  * This class contains functions to handle smiles
  12  */
  13
  14 class Smilies {
  15
  16         /**
  17          * @brief Function to list all smilies
  18          *
  19          * Get an array of all smilies, both internal and from addons.
  20          *
  21          * @return array
  22          *      'texts' => smilie shortcut
  23          *      'icons' => icon in html
  24          *
  25          * @hook smilie ('texts' => smilies texts array, 'icons' => smilies html array)
  26          */
  27         public static function get_list() {
  28
  29                 $texts =  array(
  30                         '&lt;3',
  31                         '&lt;/3',
  32                         '&lt;\\3',
  33                         ':-)',
  34                         ';-)',
  35                         ':-(',
  36                         ':-P',
  37                         ':-p',
  38                         ':-"',
  39                         ':-&quot;',
  40                         ':-x',
  41                         ':-X',
  42                         ':-D',
  43                         '8-|',
  44                         '8-O',
  45                         ':-O',
  46                         '\\o/',
  47                         'o.O',
  48                         'O.o',
  49                         'o_O',
  50                         'O_o',
  51                         ":'(",
  52                         ":-!",
  53                         ":-/",
  54                         ":-[",
  55                         "8-)",
  56                         ':beer',
  57                         ':homebrew',
  58                         ':coffee',
  59                         ':facepalm',
  60                         ':like',
  61                         ':dislike',
  62                         '~friendica',
  63                         'red#',
  64                         'red#matrix'
  65
  66                 );
  67
  68                 $icons = array(
  69                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-heart.gif" alt="&lt;3" title="&lt;3" />',
  70                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-brokenheart.gif" alt="&lt;/3" title="&lt;/3" />',
  71                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-brokenheart.gif" alt="&lt;\\3" title="&lt;\\3" />',
  72                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-smile.gif" alt=":-)" title=":-)" />',
  73                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-wink.gif" alt=";-)" title=";-)" />',
  74                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-frown.gif" alt=":-(" title=":-(" />',
  75                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-tongue-out.gif" alt=":-P" title=":-P" />',
  76                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-tongue-out.gif" alt=":-p" title=":-P" />',
  77                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
  78                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-kiss.gif" alt=":-\" title=":-\" />',
  79                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-kiss.gif" alt=":-x" title=":-x" />',
  80                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-kiss.gif" alt=":-X" title=":-X" />',
  81                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-laughing.gif" alt=":-D" title=":-D"  />',
  82                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-surprised.gif" alt="8-|" title="8-|" />',
  83                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-surprised.gif" alt="8-O" title="8-O" />',
  84                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-surprised.gif" alt=":-O" title="8-O" />',
  85                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-thumbsup.gif" alt="\\o/" title="\\o/" />',
  86                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-Oo.gif" alt="o.O" title="o.O" />',
  87                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-Oo.gif" alt="O.o" title="O.o" />',
  88                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-Oo.gif" alt="o_O" title="o_O" />',
  89                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-Oo.gif" alt="O_o" title="O_o" />',
  90                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-cry.gif" alt=":\'(" title=":\'("/>',
  91                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-foot-in-mouth.gif" alt=":-!" title=":-!" />',
  92                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-undecided.gif" alt=":-/" title=":-/" />',
  93                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-embarassed.gif" alt=":-[" title=":-[" />',
  94                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-cool.gif" alt="8-)" title="8-)" />',
  95                 '<img class="smiley" src="' . App::get_baseurl() . '/images/beer_mug.gif" alt=":beer" title=":beer" />',
  96                 '<img class="smiley" src="' . App::get_baseurl() . '/images/beer_mug.gif" alt=":homebrew" title=":homebrew" />',
  97                 '<img class="smiley" src="' . App::get_baseurl() . '/images/coffee.gif" alt=":coffee" title=":coffee" />',
  98                 '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-facepalm.gif" alt=":facepalm" title=":facepalm" />',
  99                 '<img class="smiley" src="' . App::get_baseurl() . '/images/like.gif" alt=":like" title=":like" />',
 100                 '<img class="smiley" src="' . App::get_baseurl() . '/images/dislike.gif" alt=":dislike" title=":dislike" />',
 101                 '<a href="http://friendica.com">~friendica <img class="smiley" src="' . App::get_baseurl() . '/images/friendica-16.png" alt="~friendica" title="~friendica" /></a>',
 102                 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . App::get_baseurl() . '/images/rm-16.png" alt="red#" title="red#" />matrix</a>',
 103                 '<a href="http://redmatrix.me/">red<img class="smiley" src="' . App::get_baseurl() . '/images/rm-16.png" alt="red#matrix" title="red#matrix" />matrix</a>'
 104                 );
 105
 106                 $params = array('texts' => $texts, 'icons' => $icons);
 107                 call_hooks('smilie', $params);
 108
 109                 return $params;
 110
 111         }
 112
 113         /**
 114          * @brief Replaces text emoticons with graphical images
 115          *
 116          * It is expected that this function will be called using HTML text.
 117          * We will escape text between HTML pre and code blocks from being
 118          * processed.
 119          *
 120          * At a higher level, the bbcode [nosmile] tag can be used to prevent this
 121          * function from being executed by the prepare_text() routine when preparing
 122          * bbcode source for HTML display
 123          *
 124          * @param string $s
 125          * @param boolean $sample
 126          *
 127          * @return string HML Output of the Smilie
 128          */
 129         public static function replace($s, $sample = false) {
 130                 if(intval(get_config('system','no_smilies'))
 131                         || (local_user() && intval(get_pconfig(local_user(),'system','no_smilies'))))
 132                         return $s;
 133
 134                 $s = preg_replace_callback('/<pre>(.*?)<\/pre>/ism','self::encode',$s);
 135                 $s = preg_replace_callback('/<code>(.*?)<\/code>/ism','self::encode',$s);
 136
 137                 $params = self::get_list();
 138                 $params['string'] = $s;
 139
 140                 if($sample) {
 141                         $s = '<div class="smiley-sample">';
 142                         for($x = 0; $x < count($params['texts']); $x ++) {
 143                                 $s .= '<dl><dt>' . $params['texts'][$x] . '</dt><dd>' . $params['icons'][$x] . '</dd></dl>';
 144                         }
 145                 }
 146                 else {
 147                         $params['string'] = preg_replace_callback('/&lt;(3+)/','self::preg_heart',$params['string']);
 148                         $s = str_replace($params['texts'],$params['icons'],$params['string']);
 149                 }
 150
 151                 $s = preg_replace_callback('/<pre>(.*?)<\/pre>/ism','self::decode',$s);
 152                 $s = preg_replace_callback('/<code>(.*?)<\/code>/ism','self::decode',$s);
 153
 154                 return $s;
 155         }
 156
 157         private function encode($m) {
 158                 return(str_replace($m[1],base64url_encode($m[1]),$m[0]));
 159         }
 160
 161         private function decode($m) {
 162                 return(str_replace($m[1],base64url_decode($m[1]),$m[0]));
 163         }
 164
 165
 166         /**
 167          * @brief expand <3333 to the correct number of hearts
 168          *
 169          * @param string $x
 170          * @return string HTML Output
 171          *
 172          * @todo: Rework because it doesn't work correctly
 173          */
 174         private function preg_heart($x) {
 175                 if(strlen($x[1]) == 1)
 176                         return $x[0];
 177                 $t = '';
 178                 for($cnt = 0; $cnt < strlen($x[1]); $cnt ++)
 179                         $t .= '<img class="smiley" src="' . App::get_baseurl() . '/images/smiley-heart.gif" alt="&lt;3" />';
 180                 $r =  str_replace($x[0],$t,$x[0]);
 181                 return $r;
 182         }
 183
 184 }