Completed
Push — master ( cd1511...46820b )
by Matthias
02:07
created

CSS::importFiles()   C

Complexity

Conditions 7
Paths 2

Size

Total Lines 34
Code Lines 17

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 34
rs 6.7272
c 0
b 0
f 0
cc 7
eloc 17
nc 2
nop 2
1
<?php
2
3
namespace MatthiasMullie\Minify;
4
5
use MatthiasMullie\Minify\Exceptions\FileImportException;
6
use MatthiasMullie\PathConverter\Converter;
7
8
/**
9
 * CSS minifier.
10
 *
11
 * Please report bugs on https://github.com/matthiasmullie/minify/issues
12
 *
13
 * @author Matthias Mullie <[email protected]>
14
 * @author Tijs Verkoyen <[email protected]>
15
 * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved
16
 * @license MIT License
17
 */
18
class CSS extends Minify
19
{
20
    /**
21
     * @var int
22
     */
23
    protected $maxImportSize = 5;
24
25
    /**
26
     * @var string[]
27
     */
28
    protected $importExtensions = array(
29
        'gif' => 'data:image/gif',
30
        'png' => 'data:image/png',
31
        'jpe' => 'data:image/jpeg',
32
        'jpg' => 'data:image/jpeg',
33
        'jpeg' => 'data:image/jpeg',
34
        'svg' => 'data:image/svg+xml',
35
        'woff' => 'data:application/x-font-woff',
36
        'tif' => 'image/tiff',
37
        'tiff' => 'image/tiff',
38
        'xbm' => 'image/x-xbitmap',
39
    );
40
41
    /**
42
     * Set the maximum size if files to be imported.
43
     *
44
     * Files larger than this size (in kB) will not be imported into the CSS.
45
     * Importing files into the CSS as data-uri will save you some connections,
46
     * but we should only import relatively small decorative images so that our
47
     * CSS file doesn't get too bulky.
48
     *
49
     * @param int $size Size in kB
50
     */
51
    public function setMaxImportSize($size)
52
    {
53
        $this->maxImportSize = $size;
54
    }
55
56
    /**
57
     * Set the type of extensions to be imported into the CSS (to save network
58
     * connections).
59
     * Keys of the array should be the file extensions & respective values
60
     * should be the data type.
61
     *
62
     * @param string[] $extensions Array of file extensions
63
     */
64
    public function setImportExtensions(array $extensions)
65
    {
66
        $this->importExtensions = $extensions;
67
    }
68
69
    /**
70
     * Move any import statements to the top.
71
     *
72
     * @param string $content Nearly finished CSS content
73
     *
74
     * @return string
75
     */
76
    protected function moveImportsToTop($content)
77
    {
78
        if (preg_match_all('/@import[^;]+;/', $content, $matches)) {
79
            // remove from content
80
            foreach ($matches[0] as $import) {
81
                $content = str_replace($import, '', $content);
82
            }
83
84
            // add to top
85
            $content = implode('', $matches[0]).$content;
86
        }
87
88
        return $content;
89
    }
90
91
    /**
92
     * Combine CSS from import statements.
93
     *
94
     * @import's will be loaded and their content merged into the original file,
95
     * to save HTTP requests.
96
     *
97
     * @param string   $source  The file to combine imports for
98
     * @param string   $content The CSS content to combine imports for
99
     * @param string[] $parents Parent paths, for circular reference checks
100
     *
101
     * @return string
102
     *
103
     * @throws FileImportException
104
     */
105
    protected function combineImports($source, $content, $parents)
106
    {
107
        $importRegexes = array(
108
            // @import url(xxx)
109
            '/
110
            # import statement
111
            @import
112
113
            # whitespace
114
            \s+
115
116
                # open url()
117
                url\(
118
119
                    # (optional) open path enclosure
120
                    (?P<quotes>["\']?)
121
122
                        # fetch path
123
                        (?P<path>
124
125
                            # do not fetch data uris, external sources or absolute paths
126
                            (?!(
127
                                ["\']?
128
                                (data:|https?:\\/\\/|\\/)
129
                            ))
130
131
                            .+?
132
                        )
133
134
                    # (optional) close path enclosure
135
                    (?P=quotes)
136
137
                # close url()
138
                \)
139
140
                # (optional) trailing whitespace
141
                \s*
142
143
                # (optional) media statement(s)
144
                (?P<media>[^;]*)
145
146
                # (optional) trailing whitespace
147
                \s*
148
149
            # (optional) closing semi-colon
150
            ;?
151
152
            /ix',
153
154
            // @import 'xxx'
155
            '/
156
157
            # import statement
158
            @import
159
160
            # whitespace
161
            \s+
162
163
                # open path enclosure
164
                (?P<quotes>["\'])
165
166
                    # fetch path
167
                    (?P<path>
168
169
                        # do not fetch data uris, external sources or absolute paths
170
                        (?!(
171
                            ["\']?
172
                            (data:|https?:\\/\\/|\\/)
173
                        ))
174
175
                        .+?
176
                    )
177
178
                # close path enclosure
179
                (?P=quotes)
180
181
                # (optional) trailing whitespace
182
                \s*
183
184
                # (optional) media statement(s)
185
                (?P<media>[^;]*)
186
187
                # (optional) trailing whitespace
188
                \s*
189
190
            # (optional) closing semi-colon
191
            ;?
192
193
            /ix',
194
        );
195
196
        // find all relative imports in css
197
        $matches = array();
198
        foreach ($importRegexes as $importRegex) {
199
            if (preg_match_all($importRegex, $content, $regexMatches, PREG_SET_ORDER)) {
200
                $matches = array_merge($matches, $regexMatches);
201
            }
202
        }
203
204
        $search = array();
205
        $replace = array();
206
207
        // loop the matches
208
        foreach ($matches as $match) {
209
            // get the path for the file that will be imported
210
            $importPath = dirname($source).'/'.$match['path'];
211
212
            // only replace the import with the content if we can grab the
213
            // content of the file
214
            if (!$this->canImportByPath($match['path']) || !$this->canImportFile($importPath)) {
215
                continue;
216
            }
217
218
            // check if current file was not imported previously in the same
219
            // import chain.
220
            if (in_array($importPath, $parents)) {
221
                throw new FileImportException('Failed to import file "'.$importPath.'": circular reference detected.');
222
            }
223
224
            // grab referenced file & minify it (which may include importing
225
            // yet other @import statements recursively)
226
            $minifier = new static($importPath);
227
            $importContent = $minifier->execute($source, $parents);
228
229
            // check if this is only valid for certain media
230
            if (!empty($match['media'])) {
231
                $importContent = '@media '.$match['media'].'{'.$importContent.'}';
232
            }
233
234
            // add to replacement array
235
            $search[] = $match[0];
236
            $replace[] = $importContent;
237
        }
238
239
        // replace the import statements
240
        return str_replace($search, $replace, $content);
241
    }
242
243
    /**
244
     * Import files into the CSS, base64-ized.
245
     *
246
     * @url(image.jpg) images will be loaded and their content merged into the
247
     * original file, to save HTTP requests.
248
     *
249
     * @param string $source  The file to import files for
250
     * @param string $content The CSS content to import files for
251
     *
252
     * @return string
253
     */
254
    protected function importFiles($source, $content)
255
    {
256
        $extensions = array_keys($this->importExtensions);
257
        $regex = '/url\((["\']?)(.*?\.('.implode('|', $extensions).'))\\1\)/i';
258
        if ($extensions && preg_match_all($regex, $content, $matches, PREG_SET_ORDER)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $extensions of type integer[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
259
            $search = array();
260
            $replace = array();
261
262
            // loop the matches
263
            foreach ($matches as $match) {
264
                // get the path for the file that will be imported
265
                $path = $match[2];
266
                $path = dirname($source).'/'.$path;
267
                $extension = $match[3];
268
269
                // only replace the import with the content if we're able to get
270
                // the content of the file, and it's relatively small
271
                if ($this->canImportByPath($match[2]) && $this->canImportFile($path) && $this->canImportBySize($path)) {
272
                    // grab content && base64-ize
273
                    $importContent = $this->load($path);
274
                    $importContent = base64_encode($importContent);
275
276
                    // build replacement
277
                    $search[] = $match[0];
278
                    $replace[] = 'url('.$this->importExtensions[$extension].';base64,'.$importContent.')';
279
                }
280
            }
281
282
            // replace the import statements
283
            $content = str_replace($search, $replace, $content);
284
        }
285
286
        return $content;
287
    }
288
289
    /**
290
     * Minify the data.
291
     * Perform CSS optimizations.
292
     *
293
     * @param string[optional] $path    Path to write the data to
294
     * @param string[]         $parents Parent paths, for circular reference checks
295
     *
296
     * @return string The minified data
297
     */
298
    public function execute($path = null, $parents = array())
299
    {
300
        $content = '';
301
302
        // loop css data (raw data and files)
303
        foreach ($this->data as $source => $css) {
304
            /*
305
             * Let's first take out strings & comments, since we can't just remove
306
             * whitespace anywhere. If whitespace occurs inside a string, we should
307
             * leave it alone. E.g.:
308
             * p { content: "a   test" }
309
             */
310
            $this->extractStrings();
311
            $this->stripComments();
312
            $css = $this->replace($css);
313
314
            $css = $this->stripWhitespace($css);
315
            $css = $this->shortenHex($css);
316
            $css = $this->shortenZeroes($css);
317
            $css = $this->shortenFontWeights($css);
318
            $css = $this->stripEmptyTags($css);
319
320
            // restore the string we've extracted earlier
321
            $css = $this->restoreExtractedData($css);
322
323
            $source = is_int($source) ? '' : $source;
324
            $parents = $source ? array_merge($parents, array($source)) : $parents;
325
            $css = $this->combineImports($source, $css, $parents);
326
            $css = $this->importFiles($source, $css);
327
328
            /*
329
             * If we'll save to a new path, we'll have to fix the relative paths
330
             * to be relative no longer to the source file, but to the new path.
331
             * If we don't write to a file, fall back to same path so no
332
             * conversion happens (because we still want it to go through most
333
             * of the move code...)
334
             */
335
            $converter = new Converter($source, $path ?: $source);
336
            $css = $this->move($converter, $css);
337
338
            // combine css
339
            $content .= $css;
340
        }
341
342
        $content = $this->moveImportsToTop($content);
343
344
        return $content;
345
    }
346
347
    /**
348
     * Moving a css file should update all relative urls.
349
     * Relative references (e.g. ../images/image.gif) in a certain css file,
350
     * will have to be updated when a file is being saved at another location
351
     * (e.g. ../../images/image.gif, if the new CSS file is 1 folder deeper).
352
     *
353
     * @param Converter $converter Relative path converter
354
     * @param string    $content   The CSS content to update relative urls for
355
     *
356
     * @return string
357
     */
358
    protected function move(Converter $converter, $content)
359
    {
360
        /*
361
         * Relative path references will usually be enclosed by url(). @import
362
         * is an exception, where url() is not necessary around the path (but is
363
         * allowed).
364
         * This *could* be 1 regular expression, where both regular expressions
365
         * in this array are on different sides of a |. But we're using named
366
         * patterns in both regexes, the same name on both regexes. This is only
367
         * possible with a (?J) modifier, but that only works after a fairly
368
         * recent PCRE version. That's why I'm doing 2 separate regular
369
         * expressions & combining the matches after executing of both.
370
         */
371
        $relativeRegexes = array(
372
            // url(xxx)
373
            '/
374
            # open url()
375
            url\(
376
377
                \s*
378
379
                # open path enclosure
380
                (?P<quotes>["\'])?
381
382
                    # fetch path
383
                    (?P<path>.+?)
384
385
                # close path enclosure
386
                (?(quotes)(?P=quotes))
387
388
                \s*
389
390
            # close url()
391
            \)
392
393
            /ix',
394
395
            // @import "xxx"
396
            '/
397
            # import statement
398
            @import
399
400
            # whitespace
401
            \s+
402
403
                # we don\'t have to check for @import url(), because the
404
                # condition above will already catch these
405
406
                # open path enclosure
407
                (?P<quotes>["\'])
408
409
                    # fetch path
410
                    (?P<path>.+?)
411
412
                # close path enclosure
413
                (?P=quotes)
414
415
            /ix',
416
        );
417
418
        // find all relative urls in css
419
        $matches = array();
420
        foreach ($relativeRegexes as $relativeRegex) {
421
            if (preg_match_all($relativeRegex, $content, $regexMatches, PREG_SET_ORDER)) {
422
                $matches = array_merge($matches, $regexMatches);
423
            }
424
        }
425
426
        $search = array();
427
        $replace = array();
428
429
        // loop all urls
430
        foreach ($matches as $match) {
431
            // determine if it's a url() or an @import match
432
            $type = (strpos($match[0], '@import') === 0 ? 'import' : 'url');
433
434
            $url = $match['path'];
435
            if ($this->canImportByPath($url)) {
436
                // attempting to interpret GET-params makes no sense, so let's discard them for awhile
437
                $params = strrchr($url, '?');
438
                $url = $params ? substr($url, 0, -strlen($params)) : $url;
439
440
                // fix relative url
441
                $url = $converter->convert($url);
442
443
                // now that the path has been converted, re-apply GET-params
444
                $url .= $params;
445
            }
446
447
            // build replacement
448
            $search[] = $match[0];
449
            if ($type === 'url') {
450
                $replace[] = 'url('.$url.')';
451
            } elseif ($type === 'import') {
452
                $replace[] = '@import "'.$url.'"';
453
            }
454
        }
455
456
        // replace urls
457
        return str_replace($search, $replace, $content);
458
    }
459
460
    /**
461
     * Shorthand hex color codes.
462
     * #FF0000 -> #F00.
463
     *
464
     * @param string $content The CSS content to shorten the hex color codes for
465
     *
466
     * @return string
467
     */
468
    protected function shortenHex($content)
469
    {
470
        $content = preg_replace('/(?<=[: ])#([0-9a-z])\\1([0-9a-z])\\2([0-9a-z])\\3(?=[; }])/i', '#$1$2$3', $content);
471
472
        // we can shorten some even more by replacing them with their color name
473
        $colors = array(
474
            '#F0FFFF' => 'azure',
475
            '#F5F5DC' => 'beige',
476
            '#A52A2A' => 'brown',
477
            '#FF7F50' => 'coral',
478
            '#FFD700' => 'gold',
479
            '#808080' => 'gray',
480
            '#008000' => 'green',
481
            '#4B0082' => 'indigo',
482
            '#FFFFF0' => 'ivory',
483
            '#F0E68C' => 'khaki',
484
            '#FAF0E6' => 'linen',
485
            '#800000' => 'maroon',
486
            '#000080' => 'navy',
487
            '#808000' => 'olive',
488
            '#CD853F' => 'peru',
489
            '#FFC0CB' => 'pink',
490
            '#DDA0DD' => 'plum',
491
            '#800080' => 'purple',
492
            '#F00' => 'red',
493
            '#FA8072' => 'salmon',
494
            '#A0522D' => 'sienna',
495
            '#C0C0C0' => 'silver',
496
            '#FFFAFA' => 'snow',
497
            '#D2B48C' => 'tan',
498
            '#FF6347' => 'tomato',
499
            '#EE82EE' => 'violet',
500
            '#F5DEB3' => 'wheat',
501
        );
502
503
        return preg_replace_callback(
504
            '/(?<=[: ])('.implode(array_keys($colors), '|').')(?=[; }])/i',
505
            function ($match) use ($colors) {
506
                return $colors[strtoupper($match[0])];
507
            },
508
            $content
509
        );
510
    }
511
512
    /**
513
     * Shorten CSS font weights.
514
     *
515
     * @param string $content The CSS content to shorten the font weights for
516
     *
517
     * @return string
518
     */
519
    protected function shortenFontWeights($content)
520
    {
521
        $weights = array(
522
            'normal' => 400,
523
            'bold' => 700,
524
        );
525
526
        $callback = function ($match) use ($weights) {
527
            return $match[1].$weights[$match[2]];
528
        };
529
530
        return preg_replace_callback('/(font-weight\s*:\s*)('.implode('|', array_keys($weights)).')(?=[;}])/', $callback, $content);
531
    }
532
533
    /**
534
     * Shorthand 0 values to plain 0, instead of e.g. -0em.
535
     *
536
     * @param string $content The CSS content to shorten the zero values for
537
     *
538
     * @return string
539
     */
540
    protected function shortenZeroes($content)
541
    {
542
        // reusable bits of code throughout these regexes:
543
        // before & after are used to make sure we don't match lose unintended
544
        // 0-like values (e.g. in #000, or in http://url/1.0)
545
        // units can be stripped from 0 values, or used to recognize non 0
546
        // values (where wa may be able to strip a .0 suffix)
547
        $before = '(?<=[:(, ])';
548
        $after = '(?=[ ,);}])';
549
        $units = '(em|ex|%|px|cm|mm|in|pt|pc|ch|rem|vh|vw|vmin|vmax|vm)';
550
551
        // strip units after zeroes (0px -> 0)
552
        // NOTE: it should be safe to remove all units for a 0 value, but in
553
        // practice, Webkit (especially Safari) seems to stumble over at least
554
        // 0%, potentially other units as well. Only stripping 'px' for now.
555
        // @see https://github.com/matthiasmullie/minify/issues/60
556
        $content = preg_replace('/'.$before.'(-?0*(\.0+)?)(?<=0)px'.$after.'/', '\\1', $content);
557
558
        // strip 0-digits (.0 -> 0)
559
        $content = preg_replace('/'.$before.'\.0+'.$units.'?'.$after.'/', '0\\1', $content);
560
        // strip trailing 0: 50.10 -> 50.1, 50.10px -> 50.1px
561
        $content = preg_replace('/'.$before.'(-?[0-9]+\.[0-9]+)0+'.$units.'?'.$after.'/', '\\1\\2', $content);
562
        // strip trailing 0: 50.00 -> 50, 50.00px -> 50px
563
        $content = preg_replace('/'.$before.'(-?[0-9]+)\.0+'.$units.'?'.$after.'/', '\\1\\2', $content);
564
        // strip leading 0: 0.1 -> .1, 01.1 -> 1.1
565
        $content = preg_replace('/'.$before.'(-?)0+([0-9]*\.[0-9]+)'.$units.'?'.$after.'/', '\\1\\2\\3', $content);
566
567
        // strip negative zeroes (-0 -> 0) & truncate zeroes (00 -> 0)
568
        $content = preg_replace('/'.$before.'-?0+'.$units.'?'.$after.'/', '0\\1', $content);
569
570
        // remove zeroes where they make no sense in calc: e.g. calc(100px - 0)
571
        // the 0 doesn't have any effect, and this isn't even valid without unit
572
        // strip all `+ 0` or `- 0` occurrences: calc(10% + 0) -> calc(10%)
573
        // looped because there may be multiple 0s inside 1 group of parentheses
574
        do {
575
            $previous = $content;
576
            $content = preg_replace('/\(([^\(\)]+)\s+[\+\-]\s+0(\s+[^\(\)]+)?\)/', '(\\1\\2)', $content);
577
        } while ($content !== $previous);
578
        // strip all `0 +` occurrences: calc(0 + 10%) -> calc(10%)
579
        $content = preg_replace('/\(\s*0\s+\+\s+([^\(\)]+)\)/', '(\\1)', $content);
580
        // strip all `0 -` occurrences: calc(0 - 10%) -> calc(-10%)
581
        $content = preg_replace('/\(\s*0\s+\-\s+([^\(\)]+)\)/', '(-\\1)', $content);
582
        // I'm not going to attempt to optimize away `x * 0` instances:
583
        // it's dumb enough code already that it likely won't occur, and it's
584
        // too complex to do right (order of operations would have to be
585
        // respected etc)
586
        // what I cared about most here was fixing incorrectly truncated units
587
588
        return $content;
589
    }
590
591
    /**
592
     * Strip comments from source code.
593
     *
594
     * @param string $content
595
     *
596
     * @return string
597
     */
598
    protected function stripEmptyTags($content)
599
    {
600
        return preg_replace('/(^|\}|;)[^\{\};]+\{\s*\}/', '\\1', $content);
601
    }
602
603
    /**
604
     * Strip comments from source code.
605
     */
606
    protected function stripComments()
607
    {
608
        $this->registerPattern('/\/\*.*?\*\//s', '');
609
    }
610
611
    /**
612
     * Strip whitespace.
613
     *
614
     * @param string $content The CSS content to strip the whitespace for
615
     *
616
     * @return string
617
     */
618
    protected function stripWhitespace($content)
619
    {
620
        // remove leading & trailing whitespace
621
        $content = preg_replace('/^\s*/m', '', $content);
622
        $content = preg_replace('/\s*$/m', '', $content);
623
624
        // replace newlines with a single space
625
        $content = preg_replace('/\s+/', ' ', $content);
626
627
        // remove whitespace around meta characters
628
        // inspired by stackoverflow.com/questions/15195750/minify-compress-css-with-regex
629
        $content = preg_replace('/\s*([\*$~^|]?+=|[{};,>~]|!important\b)\s*/', '$1', $content);
630
        $content = preg_replace('/([\[(:])\s+/', '$1', $content);
631
        $content = preg_replace('/\s+([\]\)])/', '$1', $content);
632
        $content = preg_replace('/\s+(:)(?![^\}]*\{)/', '$1', $content);
633
634
        // whitespace around + and - can only be stripped in selectors, like
635
        // :nth-child(3+2n), not in things like calc(3px + 2px) or shorthands
636
        // like 3px -2px
637
        $content = preg_replace('/\s*([+-])\s*(?=[^}]*{)/', '$1', $content);
638
639
        // remove semicolon/whitespace followed by closing bracket
640
        $content = str_replace(';}', '}', $content);
641
642
        return trim($content);
643
    }
644
645
    /**
646
     * Check if file is small enough to be imported.
647
     *
648
     * @param string $path The path to the file
649
     *
650
     * @return bool
651
     */
652
    protected function canImportBySize($path)
653
    {
654
        return ($size = @filesize($path)) && $size <= $this->maxImportSize * 1024;
655
    }
656
657
    /**
658
     * Check if file a file can be imported, going by the path.
659
     *
660
     * @param string $path
661
     *
662
     * @return bool
663
     */
664
    protected function canImportByPath($path)
665
    {
666
        return preg_match('/^(data:|https?:|\\/)/', $path) === 0;
667
    }
668
}
669