mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
Merge pull request #10134 from gurucomkz/resolve-combined-css-refs
ENH Resolve relative paths in CSS files when combining
This commit is contained in:
Guy Sartorelli
GitHub
commit
7b0957709d
@ -40,6 +40,7 @@
|
||||
"swiftmailer/swiftmailer": "^6.2",
|
||||
"symfony/cache": "^3.4 || ^4.0",
|
||||
"symfony/config": "^3.4 || ^4.0",
|
||||
"symfony/filesystem": "^5.4 || ^6.0",
|
||||
"symfony/translation": "^3.4 || ^4.0",
|
||||
"symfony/yaml": "^3.4 || ^4.0",
|
||||
"php": "^7.4 || ^8.0",
|
||||
|
||||
@ -19,6 +19,7 @@ use SilverStripe\Dev\Debug;
|
||||
use SilverStripe\Dev\Deprecation;
|
||||
use SilverStripe\i18n\i18n;
|
||||
use SilverStripe\ORM\FieldType\DBField;
|
||||
use Symfony\Component\Filesystem\Path as FilesystemPath;
|
||||
|
||||
class Requirements_Backend
|
||||
{
|
||||
@ -52,6 +53,20 @@ class Requirements_Backend
|
||||
*/
|
||||
private static $combine_in_dev = false;
|
||||
|
||||
/**
|
||||
* Determine if relative urls in the combined files should be converted to absolute.
|
||||
*
|
||||
* By default combined files will be parsed for relative URLs to image/font assets and those
|
||||
* URLs will be changed to absolute to accomodate the fact that the combined css is placed
|
||||
* in a totally different folder than the source css files.
|
||||
*
|
||||
* Turn this off if you see some unexpected results.
|
||||
*
|
||||
* @config
|
||||
* @var bool
|
||||
*/
|
||||
private static $resolve_relative_css_refs = false;
|
||||
|
||||
/**
|
||||
* Paths to all required JavaScript files relative to docroot
|
||||
*
|
||||
@ -1395,6 +1410,10 @@ MESSAGE
|
||||
throw new InvalidArgumentException("Combined file {$file} does not exist");
|
||||
}
|
||||
$fileContent = file_get_contents($filePath ?? '');
|
||||
if ($type == 'css') {
|
||||
// resolve relative paths for css files
|
||||
$fileContent = $this->resolveCSSReferences($fileContent, $file);
|
||||
}
|
||||
// Use configured minifier
|
||||
if ($minify) {
|
||||
$fileContent = $this->minifier->minify($fileContent, $type, $file);
|
||||
@ -1421,6 +1440,32 @@ MESSAGE
|
||||
return $combinedURL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves relative paths in CSS files which are lost when combining them
|
||||
*
|
||||
* @param string $content
|
||||
* @param string $filePath
|
||||
* @return string New content with paths resolved
|
||||
*/
|
||||
protected function resolveCSSReferences($content, $filePath)
|
||||
{
|
||||
$doResolving = Config::inst()->get(__CLASS__, 'resolve_relative_css_refs');
|
||||
if (!$doResolving) {
|
||||
return $content;
|
||||
}
|
||||
$fileUrl = Injector::inst()->get(ResourceURLGenerator::class)->urlForResource($filePath);
|
||||
$fileUrlDir = dirname($fileUrl);
|
||||
$content = preg_replace_callback('#(url\([\n\r\s\'"]*)([^\s\)\?\'"]+)#i', function ($match) use ($fileUrlDir) {
|
||||
[ $fullMatch, $prefix, $relativePath ] = $match;
|
||||
if ($relativePath[0] === '/' || false !== strpos($relativePath, '://')) {
|
||||
return $fullMatch;
|
||||
}
|
||||
$substitute = FilesystemPath::canonicalize(FilesystemPath::join($fileUrlDir, $relativePath));
|
||||
return $prefix . $substitute;
|
||||
}, $content);
|
||||
return $content;
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a filename and list of files, generate a new filename unique to these files
|
||||
*
|
||||
|
||||
@ -13,6 +13,7 @@ use Silverstripe\Assets\Dev\TestAssetStore;
|
||||
use SilverStripe\View\Requirements_Backend;
|
||||
use SilverStripe\Core\Manifest\ResourceURLGenerator;
|
||||
use SilverStripe\Control\SimpleResourceURLGenerator;
|
||||
use SilverStripe\Core\Config\Config;
|
||||
use SilverStripe\View\SSViewer;
|
||||
use SilverStripe\View\ThemeResourceLoader;
|
||||
|
||||
@ -77,6 +78,219 @@ class RequirementsTest extends SapphireTest
|
||||
$this->assertStringContainsString('http://www.mydomain.com:3000/test.css', $html, 'Load external with port');
|
||||
}
|
||||
|
||||
public function testResolveCSSReferencesDisabled()
|
||||
{
|
||||
/** @var Requirements_Backend $backend */
|
||||
$backend = Injector::inst()->create(Requirements_Backend::class);
|
||||
$this->setupRequirements($backend);
|
||||
Config::forClass(get_class($backend))->set('resolve_relative_css_refs', false);
|
||||
|
||||
$backend->combineFiles(
|
||||
'RequirementsTest_pc.css',
|
||||
[
|
||||
'css/RequirementsTest_d.css',
|
||||
'css/deep/deeper/RequirementsTest_p.css'
|
||||
]
|
||||
);
|
||||
|
||||
$backend->includeInHTML(self::$html_template);
|
||||
|
||||
// we get the file path here
|
||||
$allCSS = $backend->getCSS();
|
||||
$this->assertCount(
|
||||
1,
|
||||
$allCSS,
|
||||
'only one combined file'
|
||||
);
|
||||
|
||||
$files = array_keys($allCSS);
|
||||
$combinedFileName = $files[0];
|
||||
$combinedFileName = str_replace('/' . ASSETS_DIR . '/', '/', $combinedFileName);
|
||||
|
||||
$combinedFilePath = TestAssetStore::base_path() . $combinedFileName;
|
||||
|
||||
$content = file_get_contents($combinedFilePath);
|
||||
|
||||
/* DISABLED COMBINED CSS URL RESOLVER IGNORED ONE DOT */
|
||||
$this->assertStringContainsString(
|
||||
".p0 { background: url(./zero.gif); }",
|
||||
$content,
|
||||
'disabled combined css url resolver ignored one dot'
|
||||
);
|
||||
|
||||
/* DISABLED COMBINED CSS URL RESOLVER IGNORED DOUBLE-DOT */
|
||||
$this->assertStringContainsString(
|
||||
".p1 { background: url(../one.gif); }",
|
||||
$content,
|
||||
'disabled combined css url resolver ignored double-dot'
|
||||
);
|
||||
}
|
||||
|
||||
public function testResolveCSSReferences()
|
||||
{
|
||||
/** @var Requirements_Backend $backend */
|
||||
$backend = Injector::inst()->create(Requirements_Backend::class);
|
||||
$this->setupRequirements($backend);
|
||||
Config::forClass(get_class($backend))->set('resolve_relative_css_refs', true);
|
||||
|
||||
$backend->combineFiles(
|
||||
'RequirementsTest_pc.css',
|
||||
[
|
||||
'css/RequirementsTest_d.css',
|
||||
'css/deep/deeper/RequirementsTest_p.css'
|
||||
]
|
||||
);
|
||||
|
||||
$backend->includeInHTML(self::$html_template);
|
||||
|
||||
// we get the file path here
|
||||
$allCSS = $backend->getCSS();
|
||||
$this->assertCount(
|
||||
1,
|
||||
$allCSS,
|
||||
'only one combined file'
|
||||
);
|
||||
$files = array_keys($allCSS);
|
||||
$combinedFileName = $files[0];
|
||||
$combinedFileName = str_replace('/' . ASSETS_DIR . '/', '/', $combinedFileName);
|
||||
|
||||
$combinedFilePath = TestAssetStore::base_path() . $combinedFileName;
|
||||
|
||||
/* COMBINED JAVASCRIPT FILE EXISTS */
|
||||
$this->assertTrue(
|
||||
file_exists($combinedFilePath),
|
||||
'combined css file exists'
|
||||
);
|
||||
|
||||
$content = file_get_contents($combinedFilePath);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER IGNORE FULL URLS */
|
||||
$this->assertStringContainsString(
|
||||
".url { background: url(http://example.com/zero.gif); }",
|
||||
$content,
|
||||
'combined css url resolver ignore full urls'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED ONE DOT */
|
||||
$this->assertStringContainsString(
|
||||
".p0 { background: url(/css/deep/deeper/zero.gif); }",
|
||||
$content,
|
||||
'combined css url resolver decoded one dot'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED NO DOTS */
|
||||
$this->assertStringContainsString(
|
||||
".p0-plain { background: url(/css/deep/deeper/zero.gif); }",
|
||||
$content,
|
||||
'combined css url resolver decoded no dots'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DAMAGED A QUERYSTRING */
|
||||
$this->assertStringContainsString(
|
||||
".p0-qs { background: url(/css/deep/deeper/zero.gif?some=param); }",
|
||||
$content,
|
||||
'combined css url resolver damaged a querystring'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH SINGLE QUOTES */
|
||||
$this->assertStringContainsString(
|
||||
".p0sq { background: url('/css/deep/deeper/zero-sq.gif'); }",
|
||||
$content,
|
||||
'combined css url resolver decoded one dot with single quotes'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH DOUBLE QUOTES */
|
||||
$this->assertStringContainsString(
|
||||
".p0dq { background: url(\"/css/deep/deeper/zero-dq.gif\"); }",
|
||||
$content,
|
||||
'combined css url resolver decoded one dot with double quotes'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH DOUBLE QUOTES AND SPACES NEW LINE */
|
||||
$this->assertStringContainsString(
|
||||
"\n \"/css/deep/deeper/zero-dq-nls.gif\"\n",
|
||||
$content,
|
||||
'combined css url resolver decoded one dot with double quotes and spaces new line'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH DOUBLE QUOTES NEW LINE */
|
||||
$this->assertStringContainsString(
|
||||
"\"/css/deep/deeper/zero-dq-nl.gif\"",
|
||||
$content,
|
||||
'combined css url resolver decoded one dot with double quotes new line'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED ONE DOT WITH DOUBLE QUOTES NEW LINE WITH SPACES */
|
||||
$this->assertStringContainsString(
|
||||
"\"/css/deep/deeper/zero-dq-nls.gif\"",
|
||||
$content,
|
||||
'combined css url resolver decoded one dot with double quotes new line with spaces'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED 1 DOUBLE-DOT */
|
||||
$this->assertStringContainsString(
|
||||
".p1 { background: url(/css/deep/one.gif); }",
|
||||
$content,
|
||||
'combined css url resolver decoded 1 double-dot'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED 2 DOUBLE-DOT */
|
||||
$this->assertStringContainsString(
|
||||
".p2 { background: url(/css/two.gif); }",
|
||||
$content,
|
||||
'combined css url resolver decoded 2 double-dot'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED 2 DOUBLE-DOT SINGLE QUOTES */
|
||||
$this->assertStringContainsString(
|
||||
".p2sq { background: url('/css/two-sq.gif'); }",
|
||||
$content,
|
||||
'combined css url resolver decoded 2 double-dot single quotes'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED 2 DOUBLE-DOT DOUBLE QUOTES */
|
||||
$this->assertStringContainsString(
|
||||
".p2dq { background: url(\"/css/two-dq.gif\"); }",
|
||||
$content,
|
||||
'combined css url resolver decoded 2 double-dot double quotes'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER SHOULD NOT TOUCH ABSOLUTE PATH */
|
||||
$this->assertStringContainsString(
|
||||
".p2abs { background: url(/foo/bar/../../two-abs.gif); }",
|
||||
$content,
|
||||
'combined css url resolver should not touch absolute path'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER SHOULD NOT TOUCH ABSOLUTE PATH ON NEW LINE */
|
||||
$this->assertStringContainsString(
|
||||
"\n /foo/bar/../../two-abs-ln.gif\n",
|
||||
$content,
|
||||
'combined css url resolver should not touch absolute path on new line'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED 3 DOUBLE-DOT */
|
||||
$this->assertStringContainsString(
|
||||
".p3 { background: url(/three.gif); }",
|
||||
$content,
|
||||
'combined css url resolver decoded 3 double-dot'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER DECODED 4 DOUBLE-DOT WHEN ONLY 3 LEVELS AVAILABLE*/
|
||||
$this->assertStringContainsString(
|
||||
".p4 { background: url(/four.gif); }",
|
||||
$content,
|
||||
'combined css url resolver decoded 4 double-dot when only 3 levels available'
|
||||
);
|
||||
|
||||
/* COMBINED CSS URL RESOLVER MODIFIED AN ARBITRARY VALUE */
|
||||
$this->assertStringContainsString(
|
||||
".weird { content: \"./keepme.gif\"; }",
|
||||
$content,
|
||||
'combined css url resolver modified an arbitrary value'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Setup new backend
|
||||
*
|
||||
|
||||
@ -0,0 +1,26 @@
|
||||
.url { background: url(http://example.com/zero.gif); } /* don't touch this */
|
||||
.p0 { background: url(./zero.gif); }
|
||||
.p0-plain { background: url(zero.gif); }
|
||||
.p0-qs { background: url(./zero.gif?some=param); } /* keep the query string */
|
||||
.p0-nl { background: url(
|
||||
./zero-nl.gif );
|
||||
}
|
||||
.p0sq { background: url('./zero-sq.gif'); }
|
||||
.p0dq { background: url("./zero-dq.gif"); }
|
||||
.p0dq-nl { background: url(
|
||||
"./zero-dq-nl.gif"
|
||||
); }
|
||||
.p0dq-nls { background: url(
|
||||
"./zero-dq-nls.gif"
|
||||
); }
|
||||
.p1 { background: url(../one.gif); }
|
||||
.p2 { background: url(../../two.gif); }
|
||||
.p2abs { background: url(/foo/bar/../../two-abs.gif); } /* don't touch this */
|
||||
.p2abs-ln { background: url(
|
||||
/foo/bar/../../two-abs-ln.gif
|
||||
); } /* don't touch this */
|
||||
.p2sq { background: url('../../two-sq.gif'); }
|
||||
.p2dq { background: url("../../two-dq.gif"); }
|
||||
.p3 { background: url(../../../three.gif); }
|
||||
.p4 { background: url(../../../../four.gif); }
|
||||
.weird { content: "./keepme.gif"; }
|
||||
Loading…
Reference in New Issue
Block a user