includes/libs/CSSJanus.php

   1 <?php
   2 /**
   3  * PHP port of CSSJanus.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * This is a PHP port of CSSJanus, a utility that transforms CSS style sheets
  25  * written for LTR to RTL.
  26  *
  27  * The original Python version of CSSJanus is Copyright 2008 by Google Inc. and
  28  * is distributed under the Apache license. This PHP port is Copyright 2010 by
  29  * Roan Kattouw and is dual-licensed under the GPL (as in the comment above) and
  30  * the Apache (as in the original code) licenses.
  31  *
  32  * Original code: http://code.google.com/p/cssjanus/source/browse/trunk/cssjanus.py
  33  * License of original code: http://code.google.com/p/cssjanus/source/browse/trunk/LICENSE
  34  * @author Roan Kattouw
  35  *
  36  */
  37 class CSSJanus {
  38         // Patterns defined as null are built dynamically by buildPatterns()
  39         private static $patterns = array(
  40                 'tmpToken' => '`TMP`',
  41                 'nonAscii' => '[\200-\377]',
  42                 'unicode' => '(?:(?:\\[0-9a-f]{1,6})(?:\r\n|\s)?)',
  43                 'num' => '(?:[0-9]*\.[0-9]+|[0-9]+)',
  44                 'unit' => '(?:em|ex|px|cm|mm|in|pt|pc|deg|rad|grad|ms|s|hz|khz|%)',
  45                 'body_selector' => 'body\s*{\s*',
  46                 'direction' => 'direction\s*:\s*',
  47                 'escape' => null,
  48                 'nmstart' => null,
  49                 'nmchar' => null,
  50                 'ident' => null,
  51                 'quantity' => null,
  52                 'possibly_negative_quantity' => null,
  53                 'color' => null,
  54                 'url_special_chars' => '[!#$%&*-~]',
  55                 'valid_after_uri_chars' => '[\'\"]?\s*',
  56                 'url_chars' => null,
  57                 'lookahead_not_open_brace' => null,
  58                 'lookahead_not_closing_paren' => null,
  59                 'lookahead_for_closing_paren' => null,
  60                 'lookahead_not_letter' => '(?![a-zA-Z])',
  61                 'lookbehind_not_letter' => '(?<![a-zA-Z])',
  62                 'chars_within_selector' => '[^\}]*?',
  63                 'noflip_annotation' => '\/\*\s*@noflip\s*\*\/',
  64                 'noflip_single' => null,
  65                 'noflip_class' => null,
  66                 'comment' => '/\/\*[^*]*\*+([^\/*][^*]*\*+)*\//',
  67                 'direction_ltr' => null,
  68                 'direction_rtl' => null,
  69                 'left' => null,
  70                 'right' => null,
  71                 'left_in_url' => null,
  72                 'right_in_url' => null,
  73                 'ltr_in_url' => null,
  74                 'rtl_in_url' => null,
  75                 'cursor_east' => null,
  76                 'cursor_west' => null,
  77                 'four_notation_quantity' => null,
  78                 'four_notation_color' => null,
  79                 'border_radius' => null,
  80                 'box_shadow' => null,
  81                 'text_shadow1' => null,
  82                 'text_shadow2' => null,
  83                 'bg_horizontal_percentage' => null,
  84                 'bg_horizontal_percentage_x' => null,
  85         );
  86
  87         /**
  88          * Build patterns we can't define above because they depend on other patterns.
  89          */
  90         private static function buildPatterns() {
  91                 if ( !is_null( self::$patterns['escape'] ) ) {
  92                         // Patterns have already been built
  93                         return;
  94                 }
  95
  96                 // @codingStandardsIgnoreStart Generic.Files.LineLength.TooLong
  97                 $patterns =& self::$patterns;
  98                 $patterns['escape'] = "(?:{$patterns['unicode']}|\\[^\r\n\f0-9a-f])";
  99                 $patterns['nmstart'] = "(?:[_a-z]|{$patterns['nonAscii']}|{$patterns['escape']})";
 100                 $patterns['nmchar'] = "(?:[_a-z0-9-]|{$patterns['nonAscii']}|{$patterns['escape']})";
 101                 $patterns['ident'] = "-?{$patterns['nmstart']}{$patterns['nmchar']}*";
 102                 $patterns['quantity'] = "{$patterns['num']}(?:\s*{$patterns['unit']}|{$patterns['ident']})?";
 103                 $patterns['possibly_negative_quantity'] = "((?:-?{$patterns['quantity']})|(?:inherit|auto))";
 104                 $patterns['color'] = "(#?{$patterns['nmchar']}+|(?:rgba?|hsla?)\([ \d.,%-]+\))";
 105                 $patterns['url_chars'] = "(?:{$patterns['url_special_chars']}|{$patterns['nonAscii']}|{$patterns['escape']})*";
 106                 $patterns['lookahead_not_open_brace'] = "(?!({$patterns['nmchar']}|\r?\n|\s|#|\:|\.|\,|\+|>|\(|\)|\[|\]|=|\*=|~=|\^=|'[^']*'])*?{)";
 107                 $patterns['lookahead_not_closing_paren'] = "(?!{$patterns['url_chars']}?{$patterns['valid_after_uri_chars']}\))";
 108                 $patterns['lookahead_for_closing_paren'] = "(?={$patterns['url_chars']}?{$patterns['valid_after_uri_chars']}\))";
 109                 $patterns['noflip_single'] = "/({$patterns['noflip_annotation']}{$patterns['lookahead_not_open_brace']}[^;}]+;?)/i";
 110                 $patterns['noflip_class'] = "/({$patterns['noflip_annotation']}{$patterns['chars_within_selector']}})/i";
 111                 $patterns['direction_ltr'] = "/({$patterns['direction']})ltr/i";
 112                 $patterns['direction_rtl'] = "/({$patterns['direction']})rtl/i";
 113                 $patterns['left'] = "/{$patterns['lookbehind_not_letter']}(left){$patterns['lookahead_not_letter']}{$patterns['lookahead_not_closing_paren']}{$patterns['lookahead_not_open_brace']}/i";
 114                 $patterns['right'] = "/{$patterns['lookbehind_not_letter']}(right){$patterns['lookahead_not_letter']}{$patterns['lookahead_not_closing_paren']}{$patterns['lookahead_not_open_brace']}/i";
 115                 $patterns['left_in_url'] = "/{$patterns['lookbehind_not_letter']}(left){$patterns['lookahead_for_closing_paren']}/i";
 116                 $patterns['right_in_url'] = "/{$patterns['lookbehind_not_letter']}(right){$patterns['lookahead_for_closing_paren']}/i";
 117                 $patterns['ltr_in_url'] = "/{$patterns['lookbehind_not_letter']}(ltr){$patterns['lookahead_for_closing_paren']}/i";
 118                 $patterns['rtl_in_url'] = "/{$patterns['lookbehind_not_letter']}(rtl){$patterns['lookahead_for_closing_paren']}/i";
 119                 $patterns['cursor_east'] = "/{$patterns['lookbehind_not_letter']}([ns]?)e-resize/";
 120                 $patterns['cursor_west'] = "/{$patterns['lookbehind_not_letter']}([ns]?)w-resize/";
 121                 $patterns['four_notation_quantity'] = "/(:\s*){$patterns['possibly_negative_quantity']}(\s+){$patterns['possibly_negative_quantity']}(\s+){$patterns['possibly_negative_quantity']}(\s+){$patterns['possibly_negative_quantity']}(\s*[;}])/i";
 122                 $patterns['four_notation_color'] = "/(-color\s*:\s*){$patterns['color']}(\s+){$patterns['color']}(\s+){$patterns['color']}(\s+){$patterns['color']}(\s*[;}])/i";
 123                 $patterns['border_radius'] = "/(border-radius\s*:\s*){$patterns['possibly_negative_quantity']}(\s+){$patterns['possibly_negative_quantity']}(\s+){$patterns['possibly_negative_quantity']}(\s+){$patterns['possibly_negative_quantity']}(\s*[;}])/i";
 124                 $patterns['box_shadow'] = "/(box-shadow\s*:\s*(?:inset\s*)?){$patterns['possibly_negative_quantity']}/i";
 125                 $patterns['text_shadow1'] = "/(text-shadow\s*:\s*){$patterns['color']}(\s*){$patterns['possibly_negative_quantity']}/i";
 126                 $patterns['text_shadow2'] = "/(text-shadow\s*:\s*){$patterns['possibly_negative_quantity']}/i";
 127                 // The two regexes below are parenthesized differently then in the original implementation to make the
 128                 // callback's job more straightforward
 129                 $patterns['bg_horizontal_percentage'] = "/(background(?:-position)?\s*:\s*[^%]*?)(-?{$patterns['num']})(%\s*(?:{$patterns['quantity']}|{$patterns['ident']}))/";
 130                 $patterns['bg_horizontal_percentage_x'] = "/(background-position-x\s*:\s*)(-?{$patterns['num']})(%)/";
 131                 // @codingStandardsIgnoreEnd
 132         }
 133
 134         /**
 135          * Transform an LTR stylesheet to RTL
 136          * @param string $css stylesheet to transform
 137          * @param $swapLtrRtlInURL Boolean: If true, swap 'ltr' and 'rtl' in URLs
 138          * @param $swapLeftRightInURL Boolean: If true, swap 'left' and 'right' in URLs
 139          * @return string Transformed stylesheet
 140          */
 141         public static function transform( $css, $swapLtrRtlInURL = false, $swapLeftRightInURL = false ) {
 142                 // We wrap tokens in ` , not ~ like the original implementation does.
 143                 // This was done because ` is not a legal character in CSS and can only
 144                 // occur in URLs, where we escape it to %60 before inserting our tokens.
 145                 $css = str_replace( '`', '%60', $css );
 146
 147                 self::buildPatterns();
 148
 149                 // Tokenize single line rules with /* @noflip */
 150                 $noFlipSingle = new CSSJanusTokenizer( self::$patterns['noflip_single'], '`NOFLIP_SINGLE`' );
 151                 $css = $noFlipSingle->tokenize( $css );
 152
 153                 // Tokenize class rules with /* @noflip */
 154                 $noFlipClass = new CSSJanusTokenizer( self::$patterns['noflip_class'], '`NOFLIP_CLASS`' );
 155                 $css = $noFlipClass->tokenize( $css );
 156
 157                 // Tokenize comments
 158                 $comments = new CSSJanusTokenizer( self::$patterns['comment'], '`C`' );
 159                 $css = $comments->tokenize( $css );
 160
 161                 // LTR->RTL fixes start here
 162                 $css = self::fixDirection( $css );
 163                 if ( $swapLtrRtlInURL ) {
 164                         $css = self::fixLtrRtlInURL( $css );
 165                 }
 166
 167                 if ( $swapLeftRightInURL ) {
 168                         $css = self::fixLeftRightInURL( $css );
 169                 }
 170                 $css = self::fixLeftAndRight( $css );
 171                 $css = self::fixCursorProperties( $css );
 172                 $css = self::fixFourPartNotation( $css );
 173                 $css = self::fixBorderRadius( $css );
 174                 $css = self::fixBackgroundPosition( $css );
 175                 $css = self::fixShadows( $css );
 176
 177                 // Detokenize stuff we tokenized before
 178                 $css = $comments->detokenize( $css );
 179                 $css = $noFlipClass->detokenize( $css );
 180                 $css = $noFlipSingle->detokenize( $css );
 181
 182                 return $css;
 183         }
 184
 185         /**
 186          * Replace direction: ltr; with direction: rtl; and vice versa.
 187          *
 188          * The original implementation only does this inside body selectors
 189          * and misses "body\n{\ndirection:ltr;\n}". This function does not have
 190          * these problems.
 191          *
 192          * See http://code.google.com/p/cssjanus/issues/detail?id=15 and
 193          * TODO: URL
 194          * @param $css string
 195          * @return string
 196          */
 197         private static function fixDirection( $css ) {
 198                 $css = preg_replace( self::$patterns['direction_ltr'],
 199                         '$1' . self::$patterns['tmpToken'], $css );
 200                 $css = preg_replace( self::$patterns['direction_rtl'], '$1ltr', $css );
 201                 $css = str_replace( self::$patterns['tmpToken'], 'rtl', $css );
 202
 203                 return $css;
 204         }
 205
 206         /**
 207          * Replace 'ltr' with 'rtl' and vice versa in background URLs
 208          * @param $css string
 209          * @return string
 210          */
 211         private static function fixLtrRtlInURL( $css ) {
 212                 $css = preg_replace( self::$patterns['ltr_in_url'], self::$patterns['tmpToken'], $css );
 213                 $css = preg_replace( self::$patterns['rtl_in_url'], 'ltr', $css );
 214                 $css = str_replace( self::$patterns['tmpToken'], 'rtl', $css );
 215
 216                 return $css;
 217         }
 218
 219         /**
 220          * Replace 'left' with 'right' and vice versa in background URLs
 221          * @param $css string
 222          * @return string
 223          */
 224         private static function fixLeftRightInURL( $css ) {
 225                 $css = preg_replace( self::$patterns['left_in_url'], self::$patterns['tmpToken'], $css );
 226                 $css = preg_replace( self::$patterns['right_in_url'], 'left', $css );
 227                 $css = str_replace( self::$patterns['tmpToken'], 'right', $css );
 228
 229                 return $css;
 230         }
 231
 232         /**
 233          * Flip rules like left: , padding-right: , etc.
 234          * @param $css string
 235          * @return string
 236          */
 237         private static function fixLeftAndRight( $css ) {
 238                 $css = preg_replace( self::$patterns['left'], self::$patterns['tmpToken'], $css );
 239                 $css = preg_replace( self::$patterns['right'], 'left', $css );
 240                 $css = str_replace( self::$patterns['tmpToken'], 'right', $css );
 241
 242                 return $css;
 243         }
 244
 245         /**
 246          * Flip East and West in rules like cursor: nw-resize;
 247          * @param $css string
 248          * @return string
 249          */
 250         private static function fixCursorProperties( $css ) {
 251                 $css = preg_replace( self::$patterns['cursor_east'],
 252                         '$1' . self::$patterns['tmpToken'], $css );
 253                 $css = preg_replace( self::$patterns['cursor_west'], '$1e-resize', $css );
 254                 $css = str_replace( self::$patterns['tmpToken'], 'w-resize', $css );
 255
 256                 return $css;
 257         }
 258
 259         /**
 260          * Swap the second and fourth parts in four-part notation rules like
 261          * padding: 1px 2px 3px 4px;
 262          *
 263          * Unlike the original implementation, this function doesn't suffer from
 264          * the bug where whitespace is not preserved when flipping four-part rules
 265          * and four-part color rules with multiple whitespace characters between
 266          * colors are not recognized.
 267          * See http://code.google.com/p/cssjanus/issues/detail?id=16
 268          * @param $css string
 269          * @return string
 270          */
 271         private static function fixFourPartNotation( $css ) {
 272                 $css = preg_replace( self::$patterns['four_notation_quantity'], '$1$2$3$8$5$6$7$4$9', $css );
 273                 $css = preg_replace( self::$patterns['four_notation_color'], '$1$2$3$8$5$6$7$4$9', $css );
 274                 return $css;
 275         }
 276
 277         /**
 278          * Swaps appropriate corners in four-part border-radius rules.
 279          * Needs to undo the effect of fixFourPartNotation() on those rules, too.
 280          *
 281          * @param $css string
 282          * @return string
 283          */
 284         private static function fixBorderRadius( $css ) {
 285                 // Undo four_notation_quantity
 286                 $css = preg_replace( self::$patterns['border_radius'], '$1$2$3$8$5$6$7$4$9', $css );
 287                 // Do the real thing
 288                 $css = preg_replace( self::$patterns['border_radius'], '$1$4$3$2$5$8$7$6$9', $css );
 289
 290                 return $css;
 291         }
 292
 293         /**
 294          * Negates horizontal offset in box-shadow and text-shadow rules.
 295          *
 296          * @param $css string
 297          * @return string
 298          */
 299         private static function fixShadows( $css ) {
 300                 // Flips the sign of a CSS value, possibly with a unit.
 301                 // (We can't just negate the value with unary minus due to the units.)
 302                 $flipSign = function ( $cssValue ) {
 303                         // Don't mangle zeroes
 304                         if ( intval( $cssValue ) === 0 ) {
 305                                 return $cssValue;
 306                         } elseif ( $cssValue[0] === '-' ) {
 307                                 return substr( $cssValue, 1 );
 308                         } else {
 309                                 return "-" . $cssValue;
 310                         }
 311                 };
 312
 313                 $css = preg_replace_callback(
 314                         self::$patterns['box_shadow'], function ( $matches ) use ( $flipSign ) {
 315                                 return $matches[1] . $flipSign( $matches[2] );
 316                         },
 317                         $css
 318                 );
 319
 320                 $css = preg_replace_callback(
 321                         self::$patterns['text_shadow1'],
 322                         function ( $matches ) use ( $flipSign ) {
 323                                 return $matches[1] . $matches[2] . $matches[3] . $flipSign( $matches[4] );
 324                         },
 325                         $css
 326                 );
 327
 328                 $css = preg_replace_callback(
 329                         self::$patterns['text_shadow2'],
 330                         function ( $matches ) use ( $flipSign ) {
 331                                 return $matches[1] . $flipSign( $matches[2] );
 332                         },
 333                         $css
 334                 );
 335
 336                 return $css;
 337         }
 338
 339         /**
 340          * Flip horizontal background percentages.
 341          * @param $css string
 342          * @return string
 343          */
 344         private static function fixBackgroundPosition( $css ) {
 345                 $replaced = preg_replace_callback( self::$patterns['bg_horizontal_percentage'],
 346                         array( 'self', 'calculateNewBackgroundPosition' ), $css );
 347                 if ( $replaced !== null ) {
 348                         // Check for null; sometimes preg_replace_callback() returns null here for some weird reason
 349                         $css = $replaced;
 350                 }
 351                 $replaced = preg_replace_callback( self::$patterns['bg_horizontal_percentage_x'],
 352                         array( 'self', 'calculateNewBackgroundPosition' ), $css );
 353                 if ( $replaced !== null ) {
 354                         $css = $replaced;
 355                 }
 356
 357                 return $css;
 358         }
 359
 360         /**
 361          * Callback for calculateNewBackgroundPosition()
 362          * @param $matches array
 363          * @return string
 364          */
 365         private static function calculateNewBackgroundPosition( $matches ) {
 366                 return $matches[1] . ( 100 - $matches[2] ) . $matches[3];
 367         }
 368 }
 369
 370 /**
 371  * Utility class used by CSSJanus that tokenizes and untokenizes things we want
 372  * to protect from being janused.
 373  * @author Roan Kattouw
 374  */
 375 class CSSJanusTokenizer {
 376         private $regex, $token;
 377         private $originals;
 378
 379         /**
 380          * Constructor
 381          * @param string $regex Regular expression whose matches to replace by a token.
 382          * @param string $token Token
 383          */
 384         public function __construct( $regex, $token ) {
 385                 $this->regex = $regex;
 386                 $this->token = $token;
 387                 $this->originals = array();
 388         }
 389
 390         /**
 391          * Replace all occurrences of $regex in $str with a token and remember
 392          * the original strings.
 393          * @param string $str to tokenize
 394          * @return string Tokenized string
 395          */
 396         public function tokenize( $str ) {
 397                 return preg_replace_callback( $this->regex, array( $this, 'tokenizeCallback' ), $str );
 398         }
 399
 400         /**
 401          * @param $matches array
 402          * @return string
 403          */
 404         private function tokenizeCallback( $matches ) {
 405                 $this->originals[] = $matches[0];
 406                 return $this->token;
 407         }
 408
 409         /**
 410          * Replace tokens with their originals. If multiple strings were tokenized, it's important they be
 411          * detokenized in exactly the SAME ORDER.
 412          * @param string $str previously run through tokenize()
 413          * @return string Original string
 414          */
 415         public function detokenize( $str ) {
 416                 // PHP has no function to replace only the first occurrence or to
 417                 // replace occurrences of the same string with different values,
 418                 // so we use preg_replace_callback() even though we don't really need a regex
 419                 return preg_replace_callback( '/' . preg_quote( $this->token, '/' ) . '/',
 420                         array( $this, 'detokenizeCallback' ), $str );
 421         }
 422
 423         /**
 424          * @param $matches
 425          * @return mixed
 426          */
 427         private function detokenizeCallback( $matches ) {
 428                 $retval = current( $this->originals );
 429                 next( $this->originals );
 430
 431                 return $retval;
 432         }
 433 }