1 # This file originates from composer2nix
3 { stdenv, lib, writeTextFile, fetchurl, php, unzip, composer ? php.packages.composer }:
6 buildZipPackage = { name, src }:
9 buildInputs = [ unzip ];
12 baseDir=$(find . -type d -mindepth 1 -maxdepth 1)
25 , symlinkDependencies ? false
27 , removeComposerArtifacts ? false
31 , unpackPhase ? "true"
33 , doRemoveVendor ? true
37 reconstructInstalled = writeTextFile {
38 name = "reconstructinstalled.php";
43 if(file_exists($argv[1]))
45 $composerLockStr = file_get_contents($argv[1]);
47 if($composerLockStr === false)
49 fwrite(STDERR, "Cannot open composer.lock contents\n");
54 $config = json_decode($composerLockStr, true);
56 if(array_key_exists("packages", $config))
57 $allPackages = $config["packages"];
59 $allPackages = array();
61 ${lib.optionalString (!noDev) ''
62 if(array_key_exists("packages-dev", $config))
63 $allPackages = array_merge($allPackages, $config["packages-dev"]);
66 $packagesStr = json_encode($allPackages, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
76 constructBin = writeTextFile {
77 name = "constructbin.php";
82 $composerJSONStr = file_get_contents($argv[1]);
84 if($composerJSONStr === false)
86 fwrite(STDERR, "Cannot open composer.json contents\n");
91 $config = json_decode($composerJSONStr, true);
93 if(array_key_exists("bin-dir", $config))
94 $binDir = $config["bin-dir"];
98 if(array_key_exists("bin", $config))
100 if(!file_exists("vendor/".$binDir))
101 mkdir("vendor/".$binDir);
103 foreach($config["bin"] as $bin)
104 symlink("../../".$bin, "vendor/".$binDir."/".basename($bin));
111 bundleDependencies = dependencies:
112 lib.concatMapStrings (dependencyName:
114 dependency = dependencies.${dependencyName};
117 ${if dependency.targetDir == "" then ''
118 vendorDir="$(dirname ${dependencyName})"
119 mkdir -p "$vendorDir"
120 ${if symlinkDependencies then
121 ''ln -s "${dependency.src}" "$vendorDir/$(basename "${dependencyName}")"''
123 ''cp -a "${dependency.src}" "$vendorDir/$(basename "${dependencyName}")"''
124 }${if dependency.needsModifyRights or false then "\n" + ''
125 chmod -R u+rwx "$vendorDir/$(basename "${dependencyName}")"
128 namespaceDir="${dependencyName}/$(dirname "${dependency.targetDir}")"
129 mkdir -p "$namespaceDir"
130 ${if symlinkDependencies then
131 ''ln -s "${dependency.src}" "$namespaceDir/$(basename "${dependency.targetDir}")"''
133 ''cp -a "${dependency.src}" "$namespaceDir/$(basename "${dependency.targetDir}")"''
134 }${if dependency.needsModifyRights or false then "\n" + ''
135 chmod -R u+rwx "$namespaceDir/$(basename "${dependency.targetDir}")"
138 '') (builtins.attrNames dependencies);
140 extraArgs = removeAttrs args [ "name" "packages" "devPackages" "buildInputs" ];
142 stdenv.mkDerivation ({
143 name = "composer-${name}";
144 buildInputs = [ php composer ] ++ buildInputs;
146 inherit unpackPhase buildPhase;
149 ${if executable then ''
150 mkdir -p $out/share/php
151 cp -a $src $out/share/php/$name
152 chmod -R u+w $out/share/php/$name
153 cd $out/share/php/$name
160 # Execute pre install hook
163 # Remove unwanted files
168 ${if doRemoveVendor then ''
169 # Remove the provided vendor folder if it exists
172 # If there is no composer.lock file, compose a dummy file.
173 # Otherwise, composer attempts to download the package.json file from
174 # the registry which we do not want.
175 if [ ! -f composer.lock ]
177 cat > composer.lock <<EOF
184 # Reconstruct the installed.json file from the lock file
185 mkdir -p vendor/composer
186 ${reconstructInstalled} composer.lock > vendor/composer/installed.json
188 # Copy or symlink the provided dependencies
190 ${bundleDependencies packages}
191 ${lib.optionalString (!noDev) (bundleDependencies devPackages)}
194 # Reconstruct autoload scripts
195 # We use the optimize feature because Nix packages cannot change after they have been built
196 # Using the dynamic loader for a Nix package is useless since there is nothing to dynamically reload.
197 composer dump-autoload --optimize ${lib.optionalString noDev "--no-dev"}
199 # Run the install step as a validation to confirm that everything works out as expected
200 composer install --optimize-autoloader ${lib.optionalString noDev "--no-dev"}
202 ${lib.optionalString executable ''
203 # Reconstruct the bin/ folder if we deploy an executable project
204 ${constructBin} composer.json
205 ln -s $(pwd)/vendor/bin $out/bin
208 ${lib.optionalString (!symlinkDependencies) ''
209 # Patch the shebangs if possible
210 if [ -d $(pwd)/vendor/bin ]
212 # Look for all executables in bin/
213 for i in $(pwd)/vendor/bin/*
215 # Look for their location
216 realFile=$(readlink -f "$i")
218 # Restore write permissions
219 chmod u+wx "$(dirname "$realFile")"
220 chmod u+w "$realFile"
223 sed -e "s|#!/usr/bin/php|#!${php}/bin/php|" \
224 -e "s|#!/usr/bin/env php|#!${php}/bin/php|" \
227 chmod u+x "$realFile"
232 if [ "$removeComposerArtifacts" = "1" ]
234 # Remove composer stuff
235 rm -f composer.json composer.lock
238 # Execute post install hook
243 { inherit composer buildZipPackage buildPackage; }