plugins/DirectionDetector/DirectionDetectorPlugin.php

   1 <?php
   2 /**
   3  * DirectionDetector plugin, detects notices with RTL content & sets RTL
   4  * style for them.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  * @category     Plugin
  20  * @package      StatusNet
  21  * @author               Behrooz shabani (everplays) - <behrooz@rock.com>
  22  * @copyright    2009-2010 Behrooz shabani
  23  * @license      http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  24  *
  25  */
  26
  27 if (!defined('STATUSNET')) {
  28     exit(1);
  29 }
  30
  31 define('DIRECTIONDETECTORPLUGIN_VERSION', '0.2.0');
  32
  33 class DirectionDetectorPlugin extends Plugin {
  34     /**
  35      * SN plugin API, here we will make changes on rendered column
  36      *
  37      * @param object $notice notice is going to be saved
  38      */
  39     public function onStartNoticeSave($notice){
  40         if(!preg_match('/<span class="rtl">/', $notice->rendered) && self::isRTL($notice->content))
  41             $notice->rendered = '<span class="rtl">'.$notice->rendered.'</span>';
  42         return true;
  43     }
  44
  45     /**
  46      * SN plugin API, here we will add css needed for modifiyed rendered
  47      *
  48      * @param Action $xml
  49      */
  50     public function onEndShowStatusNetStyles($xml){
  51         $xml->element('style', array('type' => 'text/css'), 'span.rtl {display:block;direction:rtl;text-align:right;float:right;} .notice .author {float:left}');
  52     }
  53
  54     /**
  55      * is passed string a rtl content or not
  56      *
  57      * @param string $content
  58      * @return boolean
  59      */
  60     public static function isRTL($content){
  61         $content = self::getClearText($content);
  62         $words = explode(' ', $content);
  63         $rtl = 0;
  64         foreach($words as $str)
  65             if(self::startsWithRTLCharacter($str))
  66                 $rtl++;
  67             else
  68                 $rtl--;
  69         if($rtl>0)// if number of rtl words is more than ltr words so it's a rtl content
  70             return true;
  71         elseif($rtl==0)
  72             // check first word again
  73             return self::startsWithRTLCharacter($words[0]);
  74         return false;
  75     }
  76
  77     /**
  78      * checks that passed string starts with a RTL language or not
  79      *
  80      * @param string $str
  81      * @return boolean
  82      */
  83     public static function startsWithRTLCharacter($str){
  84         if( is_array($cc = self::utf8ToUnicode(mb_substr($str, 0, 1, 'utf-8'))) )
  85             $cc = $cc[0];
  86         else
  87             return false;
  88         if($cc>=1536 && $cc<=1791) // arabic, persian, urdu, kurdish, ...
  89             return true;
  90         if($cc>=65136 && $cc<=65279) // arabic peresent 2
  91             return true;
  92         if($cc>=64336 && $cc<=65023) // arabic peresent 1
  93             return true;
  94         if($cc>=1424 && $cc<=1535) // hebrew
  95             return true;
  96         if($cc>=64256 && $cc<=64335) // hebrew peresent
  97             return true;
  98         if($cc>=1792 && $cc<=1871) // Syriac
  99             return true;
 100         if($cc>=1920 && $cc<=1983) // Thaana
 101             return true;
 102         if($cc>=1984 && $cc<=2047) // NKo
 103             return true;
 104         if($cc>=11568 && $cc<=11647) // Tifinagh
 105             return true;
 106         return false;
 107     }
 108
 109     /**
 110      * clears text from replys, tags, groups, reteets & whitespaces
 111      *
 112      * @param string $str
 113      * @return string
 114      */
 115     private static function getClearText($str){
 116         $str = preg_replace('/@[^ ]+|![^ ]+|#[^ ]+/u', '', $str); // reply, tag, group
 117         $str = preg_replace('/^RT[: ]{1}| RT | RT: |^RD[: ]{1}| RD | RD: |[♺♻:]/u', '', $str); // redent, retweet
 118         $str = preg_replace("/[ \r\t\n]+/", ' ', trim($str)); // remove spaces
 119         return $str;
 120     }
 121
 122     /**
 123      * adds javascript to do same thing on input textarea
 124      *
 125      * @param Action $action
 126      */
 127     function onEndShowScripts($action){
 128         if (common_logged_in()) {
 129             $action->script('plugins/DirectionDetector/jquery.DirectionDetector.js');
 130         }
 131     }
 132
 133     /**
 134      * Takes an UTF-8 string and returns an array of ints representing the
 135      * Unicode characters. Astral planes are supported ie. the ints in the
 136      * output can be > 0xFFFF. O$ccurrances of the BOM are ignored. Surrogates
 137      * are not allowed.
 138      *
 139      * @param string $str
 140      * @return mixed array of ints, or false on invalid input
 141      */
 142     private static function utf8ToUnicode($str){
 143         $mState = 0;       // cached expected number of octets after the current octet
 144                    // until the beginning of the next UTF8 character sequence
 145         $mUcs4  = 0;     // cached Unicode character
 146         $mBytes = 1;       // cached expected number of octets in the current sequence
 147         $out = array();
 148         $len = strlen($str);
 149
 150         for($i = 0; $i < $len; $i++) {
 151             $in = ord($str{$i});
 152             if (0 == $mState) {
 153                 // When mState is zero we expect either a US-ASCII character or a
 154                 // multi-octet sequence.
 155                 if (0 == (0x80 & ($in))) {
 156                     // US-ASCII, pass straight through.
 157                     $out[] = $in;
 158                     $mBytes = 1;
 159                 } elseif (0xC0 == (0xE0 & ($in))) {
 160                     // First octet of 2 octet sequence
 161                     $mUcs4 = ($in);
 162                     $mUcs4 = ($mUcs4 & 0x1F) << 6;
 163                     $mState = 1;
 164                     $mBytes = 2;
 165                 } elseif (0xE0 == (0xF0 & ($in))) {
 166                     // First octet of 3 octet sequence
 167                     $mUcs4 = ($in);
 168                     $mUcs4 = ($mUcs4 & 0x0F) << 12;
 169                     $mState = 2;
 170                     $mBytes = 3;
 171                 } elseif (0xF0 == (0xF8 & ($in))) {
 172                     // First octet of 4 octet sequence
 173                     $mUcs4 = ($in);
 174                     $mUcs4 = ($mUcs4 & 0x07) << 18;
 175                     $mState = 3;
 176                     $mBytes = 4;
 177                 } elseif (0xF8 == (0xFC & ($in))) {
 178                     /* First octet of 5 octet sequence.
 179                      *
 180                      * This is illegal because the encoded codepoint must be either
 181                      * (a) not the shortest form or
 182                      * (b) outside the Unicode range of 0-0x10FFFF.
 183                      * Rather than trying to resynchronize, we will carry on until the end
 184                      * of the sequence and let the later error handling code catch it.
 185                      */
 186                     $mUcs4 = ($in);
 187                     $mUcs4 = ($mUcs4 & 0x03) << 24;
 188                     $mState = 4;
 189                     $mBytes = 5;
 190                 } elseif (0xFC == (0xFE & ($in))) {
 191                     // First octet of 6 octet sequence, see comments for 5 octet sequence.
 192                     $mUcs4 = ($in);
 193                     $mUcs4 = ($mUcs4 & 1) << 30;
 194                     $mState = 5;
 195                     $mBytes = 6;
 196                 } else {
 197                     /* Current octet is neither in the US-ASCII range nor a legal first
 198                      * octet of a multi-octet sequence.
 199                      */
 200                     return false;
 201                 }
 202             } else {
 203                 // When mState is non-zero, we expect a continuation of the multi-octet
 204                 // sequence
 205                 if (0x80 == (0xC0 & ($in))) {
 206                     // Legal continuation.
 207                     $shift = ($mState - 1) * 6;
 208                     $tmp = $in;
 209                     $tmp = ($tmp & 0x0000003F) << $shift;
 210                     $mUcs4 |= $tmp;
 211                     if (0 == --$mState) {
 212                         /* End of the multi-octet sequence. mUcs4 now contains the final
 213                          * Unicode codepoint to be output
 214                          *
 215                          * Check for illegal sequences and codepoints.
 216                          */
 217                         // From Unicode 3.1, non-shortest form is illegal
 218                         if      (
 219                                 ((2 == $mBytes) && ($mUcs4 < 0x0080)) ||
 220                                 ((3 == $mBytes) && ($mUcs4 < 0x0800)) ||
 221                                 ((4 == $mBytes) && ($mUcs4 < 0x10000)) ||
 222                                 (4 < $mBytes) ||
 223                                 // From Unicode 3.2, surrogate characters are illegal
 224                                 (($mUcs4 & 0xFFFFF800) == 0xD800) ||
 225                                 // Codepoints outside the Unicode range are illegal
 226                                 ($mUcs4 > 0x10FFFF)
 227                             ){
 228                             return false;
 229                         }
 230                         if (0xFEFF != $mUcs4) {
 231                             $out[] = $mUcs4;
 232                         }
 233                         //initialize UTF8 cache
 234                         $mState = 0;
 235                         $mUcs4  = 0;
 236                         $mBytes = 1;
 237                     }
 238                 } else {
 239                     /* ((0xC0 & (*in) != 0x80) && (mState != 0))
 240                      *
 241                      * Incomplete multi-octet sequence.
 242                      */
 243                     return false;
 244                 }
 245             }
 246         }
 247         return $out;
 248     }
 249
 250     /**
 251      * plugin details
 252      */
 253     function onPluginVersion(&$versions){
 254         $url = 'http://status.net/wiki/Plugin:DirectionDetector';
 255
 256         $versions[] = array(
 257             'name' => 'Direction detector',
 258             'version' => DIRECTIONDETECTORPLUGIN_VERSION,
 259             'author' => 'Behrooz Shabani',
 260             'homepage' => $url,
 261             'rawdescription' => _m('Shows notices with right-to-left content in correct direction.')
 262         );
 263         return true;
 264     }
 265 }
 266
 267 /*
 268 // Example:
 269 var_dump(DirectionDetectorPlugin::isRTL('RT @everplays ♺: دادگاه به دليل عدم حضور وکلای متهمان بنا بر اصل ١٣٥ قانون اساسی غير قانونی است')); // true
 270 */