plugins/DirectionDetector/DirectionDetectorPlugin.php

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