3 * PHP port of CSSJanus.
5 * Copyright 2008 Google Inc.
6 * Copyright 2010 Roan Kattouw
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
24 * This is a PHP port of CSSJanus, a utility that transforms CSS style sheets
25 * written for LTR to RTL.
27 * Original code: http://code.google.com/p/cssjanus/source/browse/trunk/cssjanus.py
29 * @author Lindsey Simon <elsigh@google.com>
30 * @author Roan Kattouw
33 // Patterns defined as null are built dynamically by buildPatterns()
34 private static $patterns = array(
35 'tmpToken' => '`TMP`',
36 'nonAscii' => '[\200-\377]',
37 'unicode' => '(?:(?:\\[0-9a-f]{1,6})(?:\r\n|\s)?)',
38 'num' => '(?:[0-9]*\.[0-9]+|[0-9]+)',
39 'unit' => '(?:em|ex|px|cm|mm|in|pt|pc|deg|rad|grad|ms|s|hz|khz|%)',
40 'body_selector' => 'body\s*{\s*',
41 'direction' => 'direction\s*:\s*',
47 'possibly_negative_quantity' => null,
49 'url_special_chars' => '[!#$%&*-~]',
50 'valid_after_uri_chars' => '[\'\"]?\s*',
52 'lookahead_not_open_brace' => null,
53 'lookahead_not_closing_paren' => null,
54 'lookahead_for_closing_paren' => null,
55 'lookahead_not_letter' => '(?![a-zA-Z])',
56 'lookbehind_not_letter' => '(?<![a-zA-Z])',
57 'chars_within_selector' => '[^\}]*?',
58 'noflip_annotation' => '\/\*\s*@noflip\s*\*\/',
59 'noflip_single' => null,
60 'noflip_class' => null,
61 'comment' => '/\/\*[^*]*\*+([^\/*][^*]*\*+)*\//',
62 'direction_ltr' => null,
63 'direction_rtl' => null,
66 'left_in_url' => null,
67 'right_in_url' => null,
70 'cursor_east' => null,
71 'cursor_west' => null,
72 'four_notation_quantity' => null,
73 'four_notation_color' => null,
74 'border_radius' => null,
76 'text_shadow1' => null,
77 'text_shadow2' => null,
78 'bg_horizontal_percentage' => null,
79 'bg_horizontal_percentage_x' => null,
83 * Build patterns we can't define above because they depend on other patterns.
85 private static function buildPatterns() {
86 if ( !is_null( self
::$patterns['escape'] ) ) {
87 // Patterns have already been built
91 // @codingStandardsIgnoreStart Generic.Files.LineLength.TooLong
92 $patterns =& self
::$patterns;
93 $patterns['escape'] = "(?:{$patterns['unicode']}|\\[^\r\n\f0-9a-f])";
94 $patterns['nmstart'] = "(?:[_a-z]|{$patterns['nonAscii']}|{$patterns['escape']})";
95 $patterns['nmchar'] = "(?:[_a-z0-9-]|{$patterns['nonAscii']}|{$patterns['escape']})";
96 $patterns['ident'] = "-?{$patterns['nmstart']}{$patterns['nmchar']}*";
97 $patterns['quantity'] = "{$patterns['num']}(?:\s*{$patterns['unit']}|{$patterns['ident']})?";
98 $patterns['possibly_negative_quantity'] = "((?:-?{$patterns['quantity']})|(?:inherit|auto))";
99 $patterns['color'] = "(#?{$patterns['nmchar']}+|(?:rgba?|hsla?)\([ \d.,%-]+\))";
100 $patterns['url_chars'] = "(?:{$patterns['url_special_chars']}|{$patterns['nonAscii']}|{$patterns['escape']})*";
101 $patterns['lookahead_not_open_brace'] = "(?!({$patterns['nmchar']}|\r?\n|\s|#|\:|\.|\,|\+|>|\(|\)|\[|\]|=|\*=|~=|\^=|'[^']*'])*?{)";
102 $patterns['lookahead_not_closing_paren'] = "(?!{$patterns['url_chars']}?{$patterns['valid_after_uri_chars']}\))";
103 $patterns['lookahead_for_closing_paren'] = "(?={$patterns['url_chars']}?{$patterns['valid_after_uri_chars']}\))";
104 $patterns['noflip_single'] = "/({$patterns['noflip_annotation']}{$patterns['lookahead_not_open_brace']}[^;}]+;?)/i";
105 $patterns['noflip_class'] = "/({$patterns['noflip_annotation']}{$patterns['chars_within_selector']}})/i";
106 $patterns['direction_ltr'] = "/({$patterns['direction']})ltr/i";
107 $patterns['direction_rtl'] = "/({$patterns['direction']})rtl/i";
108 $patterns['left'] = "/{$patterns['lookbehind_not_letter']}(left){$patterns['lookahead_not_letter']}{$patterns['lookahead_not_closing_paren']}{$patterns['lookahead_not_open_brace']}/i";
109 $patterns['right'] = "/{$patterns['lookbehind_not_letter']}(right){$patterns['lookahead_not_letter']}{$patterns['lookahead_not_closing_paren']}{$patterns['lookahead_not_open_brace']}/i";
110 $patterns['left_in_url'] = "/{$patterns['lookbehind_not_letter']}(left){$patterns['lookahead_for_closing_paren']}/i";
111 $patterns['right_in_url'] = "/{$patterns['lookbehind_not_letter']}(right){$patterns['lookahead_for_closing_paren']}/i";
112 $patterns['ltr_in_url'] = "/{$patterns['lookbehind_not_letter']}(ltr){$patterns['lookahead_for_closing_paren']}/i";
113 $patterns['rtl_in_url'] = "/{$patterns['lookbehind_not_letter']}(rtl){$patterns['lookahead_for_closing_paren']}/i";
114 $patterns['cursor_east'] = "/{$patterns['lookbehind_not_letter']}([ns]?)e-resize/";
115 $patterns['cursor_west'] = "/{$patterns['lookbehind_not_letter']}([ns]?)w-resize/";
116 $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";
117 $patterns['four_notation_color'] = "/(-color\s*:\s*){$patterns['color']}(\s+){$patterns['color']}(\s+){$patterns['color']}(\s+){$patterns['color']}(\s*[;}])/i";
118 $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";
119 $patterns['box_shadow'] = "/(box-shadow\s*:\s*(?:inset\s*)?){$patterns['possibly_negative_quantity']}/i";
120 $patterns['text_shadow1'] = "/(text-shadow\s*:\s*){$patterns['color']}(\s*){$patterns['possibly_negative_quantity']}/i";
121 $patterns['text_shadow2'] = "/(text-shadow\s*:\s*){$patterns['possibly_negative_quantity']}/i";
122 // The two regexes below are parenthesized differently then in the original implementation to make the
123 // callback's job more straightforward
124 $patterns['bg_horizontal_percentage'] = "/(background(?:-position)?\s*:\s*[^%]*?)(-?{$patterns['num']})(%\s*(?:{$patterns['quantity']}|{$patterns['ident']}))/";
125 $patterns['bg_horizontal_percentage_x'] = "/(background-position-x\s*:\s*)(-?{$patterns['num']})(%)/";
126 // @codingStandardsIgnoreEnd
130 * Transform an LTR stylesheet to RTL
131 * @param string $css stylesheet to transform
132 * @param $swapLtrRtlInURL Boolean: If true, swap 'ltr' and 'rtl' in URLs
133 * @param $swapLeftRightInURL Boolean: If true, swap 'left' and 'right' in URLs
134 * @return string Transformed stylesheet
136 public static function transform( $css, $swapLtrRtlInURL = false, $swapLeftRightInURL = false ) {
137 // We wrap tokens in ` , not ~ like the original implementation does.
138 // This was done because ` is not a legal character in CSS and can only
139 // occur in URLs, where we escape it to %60 before inserting our tokens.
140 $css = str_replace( '`', '%60', $css );
142 self
::buildPatterns();
144 // Tokenize single line rules with /* @noflip */
145 $noFlipSingle = new CSSJanusTokenizer( self
::$patterns['noflip_single'], '`NOFLIP_SINGLE`' );
146 $css = $noFlipSingle->tokenize( $css );
148 // Tokenize class rules with /* @noflip */
149 $noFlipClass = new CSSJanusTokenizer( self
::$patterns['noflip_class'], '`NOFLIP_CLASS`' );
150 $css = $noFlipClass->tokenize( $css );
153 $comments = new CSSJanusTokenizer( self
::$patterns['comment'], '`C`' );
154 $css = $comments->tokenize( $css );
156 // LTR->RTL fixes start here
157 $css = self
::fixDirection( $css );
158 if ( $swapLtrRtlInURL ) {
159 $css = self
::fixLtrRtlInURL( $css );
162 if ( $swapLeftRightInURL ) {
163 $css = self
::fixLeftRightInURL( $css );
165 $css = self
::fixLeftAndRight( $css );
166 $css = self
::fixCursorProperties( $css );
167 $css = self
::fixFourPartNotation( $css );
168 $css = self
::fixBorderRadius( $css );
169 $css = self
::fixBackgroundPosition( $css );
170 $css = self
::fixShadows( $css );
172 // Detokenize stuff we tokenized before
173 $css = $comments->detokenize( $css );
174 $css = $noFlipClass->detokenize( $css );
175 $css = $noFlipSingle->detokenize( $css );
177 // Remove remaining /* @noflip */ annotations, they won't be needed anymore
178 // and can interfere with other code (bug 69698).
179 $css = self
::nullTransform( $css );
185 * Remove @noflip annotations, but don't do any other transforms.
186 * @param string $css stylesheet to transform
187 * @return string Transformed stylesheet
189 public static function nullTransform( $css ) {
190 $patt = self
::$patterns['noflip_annotation'];
191 $css = preg_replace( "/($patt)\\s*/i", '', $css );
197 * Replace direction: ltr; with direction: rtl; and vice versa.
199 * The original implementation only does this inside body selectors
200 * and misses "body\n{\ndirection:ltr;\n}". This function does not have
203 * See http://code.google.com/p/cssjanus/issues/detail?id=15 and
208 private static function fixDirection( $css ) {
209 $css = preg_replace( self
::$patterns['direction_ltr'],
210 '$1' . self
::$patterns['tmpToken'], $css );
211 $css = preg_replace( self
::$patterns['direction_rtl'], '$1ltr', $css );
212 $css = str_replace( self
::$patterns['tmpToken'], 'rtl', $css );
218 * Replace 'ltr' with 'rtl' and vice versa in background URLs
222 private static function fixLtrRtlInURL( $css ) {
223 $css = preg_replace( self
::$patterns['ltr_in_url'], self
::$patterns['tmpToken'], $css );
224 $css = preg_replace( self
::$patterns['rtl_in_url'], 'ltr', $css );
225 $css = str_replace( self
::$patterns['tmpToken'], 'rtl', $css );
231 * Replace 'left' with 'right' and vice versa in background URLs
235 private static function fixLeftRightInURL( $css ) {
236 $css = preg_replace( self
::$patterns['left_in_url'], self
::$patterns['tmpToken'], $css );
237 $css = preg_replace( self
::$patterns['right_in_url'], 'left', $css );
238 $css = str_replace( self
::$patterns['tmpToken'], 'right', $css );
244 * Flip rules like left: , padding-right: , etc.
248 private static function fixLeftAndRight( $css ) {
249 $css = preg_replace( self
::$patterns['left'], self
::$patterns['tmpToken'], $css );
250 $css = preg_replace( self
::$patterns['right'], 'left', $css );
251 $css = str_replace( self
::$patterns['tmpToken'], 'right', $css );
257 * Flip East and West in rules like cursor: nw-resize;
261 private static function fixCursorProperties( $css ) {
262 $css = preg_replace( self
::$patterns['cursor_east'],
263 '$1' . self
::$patterns['tmpToken'], $css );
264 $css = preg_replace( self
::$patterns['cursor_west'], '$1e-resize', $css );
265 $css = str_replace( self
::$patterns['tmpToken'], 'w-resize', $css );
271 * Swap the second and fourth parts in four-part notation rules like
272 * padding: 1px 2px 3px 4px;
274 * Unlike the original implementation, this function doesn't suffer from
275 * the bug where whitespace is not preserved when flipping four-part rules
276 * and four-part color rules with multiple whitespace characters between
277 * colors are not recognized.
278 * See http://code.google.com/p/cssjanus/issues/detail?id=16
282 private static function fixFourPartNotation( $css ) {
283 $css = preg_replace( self
::$patterns['four_notation_quantity'], '$1$2$3$8$5$6$7$4$9', $css );
284 $css = preg_replace( self
::$patterns['four_notation_color'], '$1$2$3$8$5$6$7$4$9', $css );
289 * Swaps appropriate corners in four-part border-radius rules.
290 * Needs to undo the effect of fixFourPartNotation() on those rules, too.
295 private static function fixBorderRadius( $css ) {
296 // Undo four_notation_quantity
297 $css = preg_replace( self
::$patterns['border_radius'], '$1$2$3$8$5$6$7$4$9', $css );
299 $css = preg_replace( self
::$patterns['border_radius'], '$1$4$3$2$5$8$7$6$9', $css );
305 * Negates horizontal offset in box-shadow and text-shadow rules.
310 private static function fixShadows( $css ) {
311 // Flips the sign of a CSS value, possibly with a unit.
312 // (We can't just negate the value with unary minus due to the units.)
313 $flipSign = function ( $cssValue ) {
314 // Don't mangle zeroes
315 if ( floatval( $cssValue ) === 0.0 ) {
317 } elseif ( $cssValue[0] === '-' ) {
318 return substr( $cssValue, 1 );
320 return "-" . $cssValue;
324 $css = preg_replace_callback(
325 self
::$patterns['box_shadow'], function ( $matches ) use ( $flipSign ) {
326 return $matches[1] . $flipSign( $matches[2] );
331 $css = preg_replace_callback(
332 self
::$patterns['text_shadow1'],
333 function ( $matches ) use ( $flipSign ) {
334 return $matches[1] . $matches[2] . $matches[3] . $flipSign( $matches[4] );
339 $css = preg_replace_callback(
340 self
::$patterns['text_shadow2'],
341 function ( $matches ) use ( $flipSign ) {
342 return $matches[1] . $flipSign( $matches[2] );
351 * Flip horizontal background percentages.
355 private static function fixBackgroundPosition( $css ) {
356 $replaced = preg_replace_callback( self
::$patterns['bg_horizontal_percentage'],
357 array( 'self', 'calculateNewBackgroundPosition' ), $css );
358 if ( $replaced !== null ) {
359 // Check for null; sometimes preg_replace_callback() returns null here for some weird reason
362 $replaced = preg_replace_callback( self
::$patterns['bg_horizontal_percentage_x'],
363 array( 'self', 'calculateNewBackgroundPosition' ), $css );
364 if ( $replaced !== null ) {
372 * Callback for calculateNewBackgroundPosition()
373 * @param $matches array
376 private static function calculateNewBackgroundPosition( $matches ) {
377 return $matches[1] . ( 100 - $matches[2] ) . $matches[3];
382 * Utility class used by CSSJanus that tokenizes and untokenizes things we want
383 * to protect from being janused.
384 * @author Roan Kattouw
386 class CSSJanusTokenizer
{
387 private $regex, $token;
392 * @param string $regex Regular expression whose matches to replace by a token.
393 * @param string $token Token
395 public function __construct( $regex, $token ) {
396 $this->regex
= $regex;
397 $this->token
= $token;
398 $this->originals
= array();
402 * Replace all occurrences of $regex in $str with a token and remember
403 * the original strings.
404 * @param string $str to tokenize
405 * @return string Tokenized string
407 public function tokenize( $str ) {
408 return preg_replace_callback( $this->regex
, array( $this, 'tokenizeCallback' ), $str );
412 * @param $matches array
415 private function tokenizeCallback( $matches ) {
416 $this->originals
[] = $matches[0];
421 * Replace tokens with their originals. If multiple strings were tokenized, it's important they be
422 * detokenized in exactly the SAME ORDER.
423 * @param string $str previously run through tokenize()
424 * @return string Original string
426 public function detokenize( $str ) {
427 // PHP has no function to replace only the first occurrence or to
428 // replace occurrences of the same string with different values,
429 // so we use preg_replace_callback() even though we don't really need a regex
430 return preg_replace_callback( '/' . preg_quote( $this->token
, '/' ) . '/',
431 array( $this, 'detokenizeCallback' ), $str );
438 private function detokenizeCallback( $matches ) {
439 $retval = current( $this->originals
);
440 next( $this->originals
);