Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dev/joomla#26 - Fix path derivation when CMS is rooted in a subdir #16887

Merged
merged 2 commits into from
Mar 24, 2020
Merged

dev/joomla#26 - Fix path derivation when CMS is rooted in a subdir #16887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0cda11
dev/joomla#26 - Fix path derivation when CMS is rooted in a subdir
totten Mar 24, 2020
961b200
(NFC) Update comments in PathsTest.php
totten Mar 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Civi/Core/Paths.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,19 @@ public function __construct() {
->register('civicrm.packages', function () {
return [
'path' => \Civi::paths()->getPath('[civicrm.root]/packages/'),
'url' => \Civi::paths()->getUrl('[civicrm.root]/packages/'),
'url' => \Civi::paths()->getUrl('[civicrm.root]/packages/', 'absolute'),
];
})
->register('civicrm.vendor', function () {
return [
'path' => \Civi::paths()->getPath('[civicrm.root]/vendor/'),
'url' => \Civi::paths()->getUrl('[civicrm.root]/vendor/'),
'url' => \Civi::paths()->getUrl('[civicrm.root]/vendor/', 'absolute'),
];
})
->register('civicrm.bower', function () {
return [
'path' => \Civi::paths()->getPath('[civicrm.root]/bower_components/'),
'url' => \Civi::paths()->getUrl('[civicrm.root]/bower_components/'),
'url' => \Civi::paths()->getUrl('[civicrm.root]/bower_components/', 'absolute'),
];
})
->register('civicrm.files', function () {
Expand Down
51 changes: 51 additions & 0 deletions tests/phpunit/Civi/Core/PathsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,55 @@ public function testGetUrl_ImplicitBase() {
$this->assertEquals("$cmsRoot/foo", $p->getUrl('foo'));
}

/**
* This test demonstrates how to (and how not to) compute a derivative path variable.
*/
public function testAbsoluteRelativeConversions() {
$gstack = \CRM_Utils_GlobalStack::singleton();
$gstack->push(['_SERVER' => ['HTTP_HOST' => 'example.com']]);
$cleanup = \CRM_Utils_AutoClean::with([$gstack, 'pop']);

$paths = new Paths();
$paths->register('test.base', function () {
return [
'path' => '/var/foo/',
'url' => 'http://example.com/foo/',
];
});
$paths->register('test.goodsub', function () use ($paths) {
// This is a stand-in for how [civicrm.bower], [civicrm.packages], [civicrm.vendor] currently work.
return [
'path' => $paths->getPath('[test.base]/good/'),
'url' => $paths->getUrl('[test.base]/good/', 'absolute'),
];
});
$paths->register('test.badsub', function () use ($paths) {
// This is a stand-in for how [civicrm.bower], [civicrm.packages], [civicrm.vendor] used to work (incorrectly).
return [
'path' => $paths->getPath('[test.base]/bad/'),
// The following *looks* OK, but it's not. Note that `getUrl()` by default uses `$preferFormat==relative`.
// Both registered URLs (`register()`, `$civicrm_paths`) and outputted URLs (`getUrl()`)
// can be in relative form. However, they are relative to different bases: registrations are
// relative to CMS root, and outputted URLs are relative to HTTP root. They are often the same, but...
// on deployments where they differ, this example will misbehave.
'url' => $paths->getUrl('[test.base]/bad/'),
];
});

// The test.base works as explicitly defined...
$this->assertEquals('/var/foo', $paths->getPath('[test.base]/.'));
$this->assertEquals('http://example.com/foo', $paths->getUrl('[test.base]/.', 'absolute'));
$this->assertEquals('/foo', $paths->getUrl('[test.base]/.', 'relative'));

// The test.goodsub works as expected...
$this->assertEquals('/var/foo/good', $paths->getPath('[test.goodsub]/.'));
$this->assertEquals('http://example.com/foo/good', $paths->getUrl('[test.goodsub]/.', 'absolute'));
$this->assertEquals('/foo/good', $paths->getUrl('[test.goodsub]/.', 'relative'));

// The test.badsub doesn't work as expected.
$this->assertEquals('/var/foo/bad', $paths->getPath('[test.badsub]/.'));
$this->assertNotEquals('http://example.com/foo/bad', $paths->getUrl('[test.badsub]/.', 'absolute'));
$this->assertNotEquals('/foo/bad', $paths->getUrl('[test.badsub]/.', 'relative'));
}

}