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                 // Remove remaining /* @noflip */ annotations, they won't be needed anymore
 183                 // and can interfere with other code (bug 69698).
 184                 $css = self::nullTransform( $css );
 185
 186                 return $css;
 187         }
 188
 189         /**
 190          * Remove @noflip annotations, but don't do any other transforms.
 191          * @param string $css stylesheet to transform
 192          * @return string Transformed stylesheet
 193          */
 194         public static function nullTransform( $css ) {
 195                 $patt = self::$patterns['noflip_annotation'];
 196                 $css = preg_replace( "/($patt)\\s*/i", '', $css );
 197
 198                 return $css;
 199         }
 200
 201         /**
 202          * Replace direction: ltr; with direction: rtl; and vice versa.
 203          *
 204          * The original implementation only does this inside body selectors
 205          * and misses "body\n{\ndirection:ltr;\n}". This function does not have
 206          * these problems.
 207          *
 208          * See http://code.google.com/p/cssjanus/issues/detail?id=15 and
 209          * TODO: URL
 210          * @param $css string
 211          * @return string
 212          */
 213         private static function fixDirection( $css ) {
 214                 $css = preg_replace( self::$patterns['direction_ltr'],
 215                         '$1' . self::$patterns['tmpToken'], $css );
 216                 $css = preg_replace( self::$patterns['direction_rtl'], '$1ltr', $css );
 217                 $css = str_replace( self::$patterns['tmpToken'], 'rtl', $css );
 218
 219                 return $css;
 220         }
 221
 222         /**
 223          * Replace 'ltr' with 'rtl' and vice versa in background URLs
 224          * @param $css string
 225          * @return string
 226          */
 227         private static function fixLtrRtlInURL( $css ) {
 228                 $css = preg_replace( self::$patterns['ltr_in_url'], self::$patterns['tmpToken'], $css );
 229                 $css = preg_replace( self::$patterns['rtl_in_url'], 'ltr', $css );
 230                 $css = str_replace( self::$patterns['tmpToken'], 'rtl', $css );
 231
 232                 return $css;
 233         }
 234
 235         /**
 236          * Replace 'left' with 'right' and vice versa in background URLs
 237          * @param $css string
 238          * @return string
 239          */
 240         private static function fixLeftRightInURL( $css ) {
 241                 $css = preg_replace( self::$patterns['left_in_url'], self::$patterns['tmpToken'], $css );
 242                 $css = preg_replace( self::$patterns['right_in_url'], 'left', $css );
 243                 $css = str_replace( self::$patterns['tmpToken'], 'right', $css );
 244
 245                 return $css;
 246         }
 247
 248         /**
 249          * Flip rules like left: , padding-right: , etc.
 250          * @param $css string
 251          * @return string
 252          */
 253         private static function fixLeftAndRight( $css ) {
 254                 $css = preg_replace( self::$patterns['left'], self::$patterns['tmpToken'], $css );
 255                 $css = preg_replace( self::$patterns['right'], 'left', $css );
 256                 $css = str_replace( self::$patterns['tmpToken'], 'right', $css );
 257
 258                 return $css;
 259         }
 260
 261         /**
 262          * Flip East and West in rules like cursor: nw-resize;
 263          * @param $css string
 264          * @return string
 265          */
 266         private static function fixCursorProperties( $css ) {
 267                 $css = preg_replace( self::$patterns['cursor_east'],
 268                         '$1' . self::$patterns['tmpToken'], $css );
 269                 $css = preg_replace( self::$patterns['cursor_west'], '$1e-resize', $css );
 270                 $css = str_replace( self::$patterns['tmpToken'], 'w-resize', $css );
 271
 272                 return $css;
 273         }
 274
 275         /**
 276          * Swap the second and fourth parts in four-part notation rules like
 277          * padding: 1px 2px 3px 4px;
 278          *
 279          * Unlike the original implementation, this function doesn't suffer from
 280          * the bug where whitespace is not preserved when flipping four-part rules
 281          * and four-part color rules with multiple whitespace characters between
 282          * colors are not recognized.
 283          * See http://code.google.com/p/cssjanus/issues/detail?id=16
 284          * @param $css string
 285          * @return string
 286          */
 287         private static function fixFourPartNotation( $css ) {
 288                 $css = preg_replace( self::$patterns['four_notation_quantity'], '$1$2$3$8$5$6$7$4$9', $css );
 289                 $css = preg_replace( self::$patterns['four_notation_color'], '$1$2$3$8$5$6$7$4$9', $css );
 290                 return $css;
 291         }
 292
 293         /**
 294          * Swaps appropriate corners in four-part border-radius rules.
 295          * Needs to undo the effect of fixFourPartNotation() on those rules, too.
 296          *
 297          * @param $css string
 298          * @return string
 299          */
 300         private static function fixBorderRadius( $css ) {
 301                 // Undo four_notation_quantity
 302                 $css = preg_replace( self::$patterns['border_radius'], '$1$2$3$8$5$6$7$4$9', $css );
 303                 // Do the real thing
 304                 $css = preg_replace( self::$patterns['border_radius'], '$1$4$3$2$5$8$7$6$9', $css );
 305
 306                 return $css;
 307         }
 308
 309         /**
 310          * Negates horizontal offset in box-shadow and text-shadow rules.
 311          *
 312          * @param $css string
 313          * @return string
 314          */
 315         private static function fixShadows( $css ) {
 316                 // Flips the sign of a CSS value, possibly with a unit.
 317                 // (We can't just negate the value with unary minus due to the units.)
 318                 $flipSign = function ( $cssValue ) {
 319                         // Don't mangle zeroes
 320                         if ( floatval( $cssValue ) === 0.0 ) {
 321                                 return $cssValue;
 322                         } elseif ( $cssValue[0] === '-' ) {
 323                                 return substr( $cssValue, 1 );
 324                         } else {
 325                                 return "-" . $cssValue;
 326                         }
 327                 };
 328
 329                 $css = preg_replace_callback(
 330                         self::$patterns['box_shadow'], function ( $matches ) use ( $flipSign ) {
 331                                 return $matches[1] . $flipSign( $matches[2] );
 332                         },
 333                         $css
 334                 );
 335
 336                 $css = preg_replace_callback(
 337                         self::$patterns['text_shadow1'],
 338                         function ( $matches ) use ( $flipSign ) {
 339                                 return $matches[1] . $matches[2] . $matches[3] . $flipSign( $matches[4] );
 340                         },
 341                         $css
 342                 );
 343
 344                 $css = preg_replace_callback(
 345                         self::$patterns['text_shadow2'],
 346                         function ( $matches ) use ( $flipSign ) {
 347                                 return $matches[1] . $flipSign( $matches[2] );
 348                         },
 349                         $css
 350                 );
 351
 352                 return $css;
 353         }
 354
 355         /**
 356          * Flip horizontal background percentages.
 357          * @param $css string
 358          * @return string
 359          */
 360         private static function fixBackgroundPosition( $css ) {
 361                 $replaced = preg_replace_callback( self::$patterns['bg_horizontal_percentage'],
 362                         array( 'self', 'calculateNewBackgroundPosition' ), $css );
 363                 if ( $replaced !== null ) {
 364                         // Check for null; sometimes preg_replace_callback() returns null here for some weird reason
 365                         $css = $replaced;
 366                 }
 367                 $replaced = preg_replace_callback( self::$patterns['bg_horizontal_percentage_x'],
 368                         array( 'self', 'calculateNewBackgroundPosition' ), $css );
 369                 if ( $replaced !== null ) {
 370                         $css = $replaced;
 371                 }
 372
 373                 return $css;
 374         }
 375
 376         /**
 377          * Callback for calculateNewBackgroundPosition()
 378          * @param $matches array
 379          * @return string
 380          */
 381         private static function calculateNewBackgroundPosition( $matches ) {
 382                 return $matches[1] . ( 100 - $matches[2] ) . $matches[3];
 383         }
 384 }
 385
 386 /**
 387  * Utility class used by CSSJanus that tokenizes and untokenizes things we want
 388  * to protect from being janused.
 389  * @author Roan Kattouw
 390  */
 391 class CSSJanusTokenizer {
 392         private $regex, $token;
 393         private $originals;
 394
 395         /**
 396          * Constructor
 397          * @param string $regex Regular expression whose matches to replace by a token.
 398          * @param string $token Token
 399          */
 400         public function __construct( $regex, $token ) {
 401                 $this->regex = $regex;
 402                 $this->token = $token;
 403                 $this->originals = array();
 404         }
 405
 406         /**
 407          * Replace all occurrences of $regex in $str with a token and remember
 408          * the original strings.
 409          * @param string $str to tokenize
 410          * @return string Tokenized string
 411          */
 412         public function tokenize( $str ) {
 413                 return preg_replace_callback( $this->regex, array( $this, 'tokenizeCallback' ), $str );
 414         }
 415
 416         /**
 417          * @param $matches array
 418          * @return string
 419          */
 420         private function tokenizeCallback( $matches ) {
 421                 $this->originals[] = $matches[0];
 422                 return $this->token;
 423         }
 424
 425         /**
 426          * Replace tokens with their originals. If multiple strings were tokenized, it's important they be
 427          * detokenized in exactly the SAME ORDER.
 428          * @param string $str previously run through tokenize()
 429          * @return string Original string
 430          */
 431         public function detokenize( $str ) {
 432                 // PHP has no function to replace only the first occurrence or to
 433                 // replace occurrences of the same string with different values,
 434                 // so we use preg_replace_callback() even though we don't really need a regex
 435                 return preg_replace_callback( '/' . preg_quote( $this->token, '/' ) . '/',
 436                         array( $this, 'detokenizeCallback' ), $str );
 437         }
 438
 439         /**
 440          * @param $matches
 441          * @return mixed
 442          */
 443         private function detokenizeCallback( $matches ) {
 444                 $retval = current( $this->originals );
 445                 next( $this->originals );
 446
 447                 return $retval;
 448         }
 449 }