Completed
Push — master ( 51c3c7...cad5d7 )
by Matthias
04:27
created

CSS::importFiles()   B

Complexity

Conditions 6
Paths 2

Size

Total Lines 34
Code Lines 17

Duplication

Lines 0
Ratio 0 %

Importance

Changes 8
Bugs 2 Features 1
Metric Value
c 8
b 2
f 1
dl 0
loc 34
rs 8.439
cc 6
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 $content string Nearly finished CSS content
73
     *
74
     * @return string
75
     */
76
    protected function moveImportsToTop($content)
77
    {
78
        if (preg_match_all('/@import[^;]+;/', $content, $matches)) {
79
80
            // remove from content
81
            foreach ($matches[0] as $import) {
82
                $content = str_replace($import, '', $content);
83
            }
84
85
            // add to top
86
            $content = implode('', $matches[0]).$content;
87
        };
88
89
        return $content;
90
    }
91
92
    /**
93
     * Combine CSS from import statements.
94
     *
95
     * @import's will be loaded and their content merged into the original file,
96
     * to save HTTP requests.
97
     *
98
     * @param string $source  The file to combine imports for.
99
     * @param string $content The CSS content to combine imports for.
100
     * @param array  $parents Parent paths, for circular reference checks.
101
     *
102
     * @return string
103
     *
104
     * @throws FileImportException
105
     */
106
    protected function combineImports($source, $content, $parents)
107
    {
108
        $importRegexes = array(
109
            // @import url(xxx)
110
            '/
111
            # import statement
112
            @import
113
114
            # whitespace
115
            \s+
116
117
                # open url()
118
                url\(
119
120
                    # (optional) open path enclosure
121
                    (?P<quotes>["\']?)
122
123
                        # fetch path
124
                        (?P<path>
125
126
                            # do not fetch data uris or external sources
127
                            (?!(
128
                                ["\']?
129
                                (data|https?):
130
                            ))
131
132
                            .+?
133
                        )
134
135
                    # (optional) close path enclosure
136
                    (?P=quotes)
137
138
                # close url()
139
                \)
140
141
                # (optional) trailing whitespace
142
                \s*
143
144
                # (optional) media statement(s)
145
                (?P<media>[^;]*)
146
147
                # (optional) trailing whitespace
148
                \s*
149
150
            # (optional) closing semi-colon
151
            ;?
152
153
            /ix',
154
155
            // @import 'xxx'
156
            '/
157
158
            # import statement
159
            @import
160
161
            # whitespace
162
            \s+
163
164
                # open path enclosure
165
                (?P<quotes>["\'])
166
167
                    # fetch path
168
                    (?P<path>
169
170
                        # do not fetch data uris or external sources
171
                        (?!(
172
                            ["\']?
173
                            (data|https?):
174
                        ))
175
176
                        .+?
177
                    )
178
179
                # close path enclosure
180
                (?P=quotes)
181
182
                # (optional) trailing whitespace
183
                \s*
184
185
                # (optional) media statement(s)
186
                (?P<media>[^;]*)
187
188
                # (optional) trailing whitespace
189
                \s*
190
191
            # (optional) closing semi-colon
192
            ;?
193
194
            /ix',
195
        );
196
197
        // find all relative imports in css
198
        $matches = array();
199
        foreach ($importRegexes as $importRegex) {
200
            if (preg_match_all($importRegex, $content, $regexMatches, PREG_SET_ORDER)) {
201
                $matches = array_merge($matches, $regexMatches);
202
            }
203
        }
204
205
        $search = array();
206
        $replace = array();
207
208
        // loop the matches
209
        foreach ($matches as $match) {
210
            // get the path for the file that will be imported
211
            $importPath = dirname($source).'/'.$match['path'];
212
213
            // only replace the import with the content if we can grab the
214
            // content of the file
215
            if ($this->canImportFile($importPath)) {
216
                // check if current file was not imported previously in the same
217
                // import chain.
218
                if (in_array($importPath, $parents)) {
219
                    throw new FileImportException('Failed to import file "'.$importPath.'": circular reference detected.');
220
                }
221
222
                // grab referenced file & minify it (which may include importing
223
                // yet other @import statements recursively)
224
                $minifier = new static($importPath);
225
                $importContent = $minifier->execute($source, $parents);
226
227
                // check if this is only valid for certain media
228
                if (!empty($match['media'])) {
229
                    $importContent = '@media '.$match['media'].'{'.$importContent.'}';
230
                }
231
232
                // add to replacement array
233
                $search[] = $match[0];
234
                $replace[] = $importContent;
235
            }
236
        }
237
238
        // replace the import statements
239
        $content = str_replace($search, $replace, $content);
240
241
        return $content;
242
    }
243
244
    /**
245
     * Import files into the CSS, base64-ized.
246
     *
247
     * @url(image.jpg) images will be loaded and their content merged into the
248
     * original file, to save HTTP requests.
249
     *
250
     * @param string $source  The file to import files for.
251
     * @param string $content The CSS content to import files for.
252
     *
253
     * @return string
254
     */
255
    protected function importFiles($source, $content)
256
    {
257
        $extensions = array_keys($this->importExtensions);
258
        $regex = '/url\((["\']?)((?!["\']?data:).*?\.('.implode('|', $extensions).'))\\1\)/i';
259
        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...
260
            $search = array();
261
            $replace = array();
262
263
            // loop the matches
264
            foreach ($matches as $match) {
265
                // get the path for the file that will be imported
266
                $path = $match[2];
267
                $path = dirname($source).'/'.$path;
268
                $extension = $match[3];
269
270
                // only replace the import with the content if we're able to get
271
                // the content of the file, and it's relatively small
272
                if ($this->canImportFile($path) && $this->canImportBySize($path)) {
273
                    // grab content && base64-ize
274
                    $importContent = $this->load($path);
275
                    $importContent = base64_encode($importContent);
276
277
                    // build replacement
278
                    $search[] = $match[0];
279
                    $replace[] = 'url('.$this->importExtensions[$extension].';base64,'.$importContent.')';
280
                }
281
            }
282
283
            // replace the import statements
284
            $content = str_replace($search, $replace, $content);
285
        }
286
287
        return $content;
288
    }
289
290
    /**
291
     * Minify the data.
292
     * Perform CSS optimizations.
293
     *
294
     * @param string[optional] $path    Path to write the data to.
295
     * @param string[]         $parents Parent paths, for circular reference checks.
296
     *
297
     * @return string The minified data.
298
     */
299
    public function execute($path = null, $parents = array())
300
    {
301
        $content = '';
302
303
        // loop css data (raw data and files)
304
        foreach ($this->data as $source => $css) {
305
            /*
306
             * Let's first take out strings & comments, since we can't just remove
307
             * whitespace anywhere. If whitespace occurs inside a string, we should
308
             * leave it alone. E.g.:
309
             * p { content: "a   test" }
310
             */
311
            $this->extractStrings();
312
            $this->stripComments();
313
            $css = $this->replace($css);
314
315
            $css = $this->stripWhitespace($css);
316
            $css = $this->shortenHex($css);
317
            $css = $this->shortenZeroes($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
                        # do not fetch data uris or external sources
386
                        (?!(
387
                            \s?
388
                            ["\']?
389
                            (data|https?):
390
                        ))
391
392
                        .+?
393
                    )
394
395
                # close path enclosure
396
                (?(quotes)(?P=quotes))
397
398
                \s*
399
400
            # close url()
401
            \)
402
403
            /ix',
404
405
            // @import "xxx"
406
            '/
407
            # import statement
408
            @import
409
410
            # whitespace
411
            \s+
412
413
                # we don\'t have to check for @import url(), because the
414
                # condition above will already catch these
415
416
                # open path enclosure
417
                (?P<quotes>["\'])
418
419
                    # fetch path
420
                    (?P<path>
421
422
                        # do not fetch data uris or external sources
423
                        (?!(
424
                            ["\']?
425
                            (data|https?):
426
                        ))
427
428
                        .+?
429
                    )
430
431
                # close path enclosure
432
                (?P=quotes)
433
434
            /ix',
435
        );
436
437
        // find all relative urls in css
438
        $matches = array();
439
        foreach ($relativeRegexes as $relativeRegex) {
440
            if (preg_match_all($relativeRegex, $content, $regexMatches, PREG_SET_ORDER)) {
441
                $matches = array_merge($matches, $regexMatches);
442
            }
443
        }
444
445
        $search = array();
446
        $replace = array();
447
448
        // loop all urls
449
        foreach ($matches as $match) {
450
            // determine if it's a url() or an @import match
451
            $type = (strpos($match[0], '@import') === 0 ? 'import' : 'url');
452
453
            // attempting to interpret GET-params makes no sense, so let's discard them for awhile
454
            $params = strrchr($match['path'], '?');
455
            $url = $params ? substr($match['path'], 0, -strlen($params)) : $match['path'];
456
457
            // fix relative url
458
            $url = $converter->convert($url);
459
460
            // now that the path has been converted, re-apply GET-params
461
            $url .= $params;
462
463
            // build replacement
464
            $search[] = $match[0];
465
            if ($type == 'url') {
466
                $replace[] = 'url('.$url.')';
467
            } elseif ($type == 'import') {
468
                $replace[] = '@import "'.$url.'"';
469
            }
470
        }
471
472
        // replace urls
473
        $content = str_replace($search, $replace, $content);
474
475
        return $content;
476
    }
477
478
    /**
479
     * Shorthand hex color codes.
480
     * #FF0000 -> #F00.
481
     *
482
     * @param string $content The CSS content to shorten the hex color codes for.
483
     *
484
     * @return string
485
     */
486
    protected function shortenHex($content)
487
    {
488
        $content = preg_replace('/(?<![\'"])#([0-9a-z])\\1([0-9a-z])\\2([0-9a-z])\\3(?![\'"])/i', '#$1$2$3', $content);
489
490
        return $content;
491
    }
492
493
    /**
494
     * Shorthand 0 values to plain 0, instead of e.g. -0em.
495
     *
496
     * @param string $content The CSS content to shorten the zero values for.
497
     *
498
     * @return string
499
     */
500
    protected function shortenZeroes($content)
501
    {
502
        // reusable bits of code throughout these regexes:
503
        // before & after are used to make sure we don't match lose unintended
504
        // 0-like values (e.g. in #000, or in http://url/1.0)
505
        // units can be stripped from 0 values, or used to recognize non 0
506
        // values (where wa may be able to strip a .0 suffix)
507
        $before = '(?<=[:(, ])';
508
        $after = '(?=[ ,);}])';
509
        $units = '(em|ex|%|px|cm|mm|in|pt|pc|ch|rem|vh|vw|vmin|vmax|vm)';
510
511
        // strip units after zeroes (0px -> 0)
512
        // NOTE: it should be safe to remove all units for a 0 value, but in
513
        // practice, Webkit (especially Safari) seems to stumble over at least
514
        // 0%, potentially other units as well. Only stripping 'px' for now.
515
        // @see https://github.com/matthiasmullie/minify/issues/60
516
        $content = preg_replace('/'.$before.'(-?0*(\.0+)?)(?<=0)px'.$after.'/', '\\1', $content);
517
518
        // strip 0-digits (.0 -> 0)
519
        $content = preg_replace('/'.$before.'\.0+'.$units.'?'.$after.'/', '0\\1', $content);
520
        // strip trailing 0: 50.10 -> 50.1, 50.10px -> 50.1px
521
        $content = preg_replace('/'.$before.'(-?[0-9]+\.[0-9]+)0+'.$units.'?'.$after.'/', '\\1\\2', $content);
522
        // strip trailing 0: 50.00 -> 50, 50.00px -> 50px
523
        $content = preg_replace('/'.$before.'(-?[0-9]+)\.0+'.$units.'?'.$after.'/', '\\1\\2', $content);
524
        // strip leading 0: 0.1 -> .1, 01.1 -> 1.1
525
        $content = preg_replace('/'.$before.'(-?)0+([0-9]*\.[0-9]+)'.$units.'?'.$after.'/', '\\1\\2\\3', $content);
526
527
        // strip negative zeroes (-0 -> 0) & truncate zeroes (00 -> 0)
528
        $content = preg_replace('/'.$before.'-?0+'.$units.'?'.$after.'/', '0\\1', $content);
529
530
        return $content;
531
    }
532
533
    /**
534
     * Strip comments from source code.
535
     *
536
     * @param string $content
537
     *
538
     * @return string
539
     */
540
    protected function stripEmptyTags($content)
541
    {
542
        return preg_replace('/(^|\})[^\{\}]+\{\s*\}/', '\\1', $content);
543
    }
544
545
    /**
546
     * Strip comments from source code.
547
     */
548
    protected function stripComments()
549
    {
550
        $this->registerPattern('/\/\*.*?\*\//s', '');
551
    }
552
553
    /**
554
     * Strip whitespace.
555
     *
556
     * @param string $content The CSS content to strip the whitespace for.
557
     *
558
     * @return string
559
     */
560
    protected function stripWhitespace($content)
561
    {
562
        // remove leading & trailing whitespace
563
        $content = preg_replace('/^\s*/m', '', $content);
564
        $content = preg_replace('/\s*$/m', '', $content);
565
566
        // replace newlines with a single space
567
        $content = preg_replace('/\s+/', ' ', $content);
568
569
        // remove whitespace around meta characters
570
        // inspired by stackoverflow.com/questions/15195750/minify-compress-css-with-regex
571
        $content = preg_replace('/\s*([\*$~^|]?+=|[{};,>~]|!important\b)\s*/', '$1', $content);
572
        $content = preg_replace('/([\[(:])\s+/', '$1', $content);
573
        $content = preg_replace('/\s+([\]\)])/', '$1', $content);
574
        $content = preg_replace('/\s+(:)(?![^\}]*\{)/', '$1', $content);
575
576
        // whitespace around + and - can only be stripped in selectors, like
577
        // :nth-child(3+2n), not in things like calc(3px + 2px) or shorthands
578
        // like 3px -2px
579
        $content = preg_replace('/\s*([+-])\s*(?=[^}]*{)/', '$1', $content);
580
581
        // remove semicolon/whitespace followed by closing bracket
582
        $content = str_replace(';}', '}', $content);
583
584
        return trim($content);
585
    }
586
587
    /**
588
     * Check if file is small enough to be imported.
589
     *
590
     * @param string $path The path to the file.
591
     *
592
     * @return bool
593
     */
594
    protected function canImportBySize($path)
595
    {
596
        return ($size = @filesize($path)) && $size <= $this->maxImportSize * 1024;
597
    }
598
}
599