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.

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

Patch Phing to fix relative symlinks #179

Merged
merged 6 commits into from
Jan 7, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
10 changes: 9 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
"bin/the-build-installer"
],
"require": {
"palantirnet/phing-drush-task": "^1.1",
"cweagans/composer-patches": "^1.7",
"drupal/coder": "^8.3.6",
"drush/drush": "^9 || ^10",
"palantirnet/phing-drush-task": "^1.1",
"pear/http_request2": "^2.3",
"pear/versioncontrol_git": "@dev",
"phing/phing": "^2.14",
Expand All @@ -27,5 +28,12 @@
},
"config": {
"sort-packages": true
},
"extra": {
"patches": {
"phing/phing": {
"Support relative symliks in Phing": "https://raw.githubusercontent.com/palantirnet/the-build/7cdc28b6019fb88a0604261366f9ea35f1e21d96/patches/phing-relative-symlinks.patch"
}
}
}
}
2 changes: 1 addition & 1 deletion defaults/install/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

<!-- Include styleguide resources in the theme. This approach will symlink
resources in development environments, and copy them for artifact builds. -->
<!-- <includeresource source="styleguide/source/assets/css" dest="${drupal.root}/themes/custom/example_theme/css" /> -->
<!-- <includeresource relative="true" source="${build.dir}/styleguide/source/assets/css" dest="${build.dir}/${drupal.root}/themes/custom/example_theme/css" /> -->
</target>


Expand Down
76 changes: 76 additions & 0 deletions patches/phing-relative-symlinks.patch
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
diff --git a/classes/phing/tasks/ext/SymlinkTask.php b/classes/phing/tasks/ext/SymlinkTask.php
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a README to the patches directory that explains where this patch comes from?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went ahead and added a README.

index f132b4f747..87844a0d09 100644
--- a/classes/phing/tasks/ext/SymlinkTask.php
+++ b/classes/phing/tasks/ext/SymlinkTask.php
@@ -206,6 +206,46 @@ public function isRelative()
return $this->relative;
}

+ /**
+ * Given an existing path, convert it to a path relative to a given starting path.
+ *
+ * @param string $endPath Absolute path of target
+ * @param string $startPath Absolute path where traversal begins
+ *
+ * @return string Path of target relative to starting path
+ */
+ public function makePathRelative($endPath, $startPath)
+ {
+ // Normalize separators on Windows
+ if ('\\' === DIRECTORY_SEPARATOR) {
+ $endPath = str_replace('\\', '/', $endPath);
+ $startPath = str_replace('\\', '/', $startPath);
+ }
+
+ // Split the paths into arrays
+ $startPathArr = explode('/', trim($startPath, '/'));
+ $endPathArr = explode('/', trim($endPath, '/'));
+
+ // Find for which directory the common path stops
+ $index = 0;
+ while (isset($startPathArr[$index]) && isset($endPathArr[$index]) && $startPathArr[$index] === $endPathArr[$index]) {
+ ++$index;
+ }
+
+ // Determine how deep the start path is relative to the common path (ie, "web/bundles" = 2 levels)
+ $depth = count($startPathArr) - $index;
+
+ // Repeated "../" for each level need to reach the common path
+ $traverser = str_repeat('../', $depth);
+
+ $endPathRemainder = implode('/', array_slice($endPathArr, $index));
+
+ // Construct $endPath from traversing to the common path, then to the remaining $endPath
+ $relativePath = $traverser.('' !== $endPathRemainder ? $endPathRemainder.'/' : '');
+
+ return '' === $relativePath ? './' : $relativePath;
+ }
+
/**
* Generates an array of directories / files to be linked
* If _filesets is empty, returns getTarget()
@@ -235,11 +275,7 @@ protected function getMap()
throw new BuildException('Link must be an existing directory when using fileset');
}

- if ($this->isRelative()) {
- $fromDir = $fs->getDir($this->getProject())->getPath();
- } else {
- $fromDir = $fs->getDir($this->getProject())->getAbsolutePath();
- }
+ $fromDir = $fs->getDir($this->getProject())->getAbsolutePath();

if (!is_dir($fromDir)) {
$this->log('Directory doesn\'t exist: ' . $fromDir, Project::MSG_WARN);
@@ -300,6 +336,11 @@ protected function symlink($target, $link)
{
$fs = FileSystem::getFileSystem();

+ if ($this->isRelative()) {
+ $link =(new PhingFile($link))->getAbsolutePath();
+ $target = rtrim($this->makePathRelative($target, dirname($link)), '/');
+ }
+
if (is_link($link) && @readlink($link) == $target) {
$this->log('Link exists: ' . $link, Project::MSG_INFO);

24 changes: 23 additions & 1 deletion src/TheBuild/IncludeResourceTask.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ class IncludeResourceTask extends \Task {
*/
protected $dest = NULL;

/**
* Whether to create relative symlinks
*
* @var boolean
*/
private $relative = true;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be protected instead of private I think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went ahead and made this change.


/**
* Init tasks.
Expand All @@ -44,6 +50,10 @@ public function init() {
if (!is_null($mode)) {
$this->setMode($mode);
}
$relative = $this->getProject()->getProperty('includeresource.relative');
if (!is_null($relative)) {
$this->setRelative($relative);
}
}


Expand All @@ -70,7 +80,11 @@ public function main() {
}
else {
$this->log(sprintf("Linking '%s' to '%s'", $this->source->getPath(), $this->dest->getPath()));
FileSystem::getFileSystem()->symlink($this->source->getPath(), $this->dest->getPath());
$symlink_task = $this->project->createTask("symlink");
$symlink_task->setTarget($this->source->getPath());
$symlink_task->setLink($this->dest->getPath());
$symlink_task->setRelative($this->relative);
$symlink_task->main();
}
}

Expand Down Expand Up @@ -122,4 +136,12 @@ public function setDest(PhingFile $dest) {
$this->dest = $dest;
}

/**
* @param boolean $relative
*/
public function setRelative($relative)
{
$this->relative = $relative;
}

}
2 changes: 1 addition & 1 deletion targets/drupal.xml
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ Or, you can specify the export file directly:
<target name="drupal-first-install" depends="set-site" hidden="true">
<fail unless="drupal.site.admin_user" />

<symlink link="${build.dir}/${drupal.root}/modules/contrib/the_build_utility" target="${build.thebuild.dir}/defaults/standard/modules/the_build_utility" />
<symlink link="${build.dir}/${drupal.root}/modules/contrib/the_build_utility" target="${build.thebuild.dir}/defaults/standard/modules/the_build_utility" relative="true" />

<composer command="require" composer="${composer.composer}">
<arg value="drupal/admin_toolbar" />
Expand Down