copy.js 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. 'use strict'
  2. const fs = require('graceful-fs')
  3. const path = require('path')
  4. const mkdirs = require('../mkdirs').mkdirs
  5. const pathExists = require('../path-exists').pathExists
  6. const utimesMillis = require('../util/utimes').utimesMillis
  7. const stat = require('../util/stat')
  8. function copy (src, dest, opts, cb) {
  9. if (typeof opts === 'function' && !cb) {
  10. cb = opts
  11. opts = {}
  12. } else if (typeof opts === 'function') {
  13. opts = { filter: opts }
  14. }
  15. cb = cb || function () {}
  16. opts = opts || {}
  17. opts.clobber = 'clobber' in opts ? !!opts.clobber : true // default to true for now
  18. opts.overwrite = 'overwrite' in opts ? !!opts.overwrite : opts.clobber // overwrite falls back to clobber
  19. // Warn about using preserveTimestamps on 32-bit node
  20. if (opts.preserveTimestamps && process.arch === 'ia32') {
  21. process.emitWarning(
  22. 'Using the preserveTimestamps option in 32-bit node is not recommended;\n\n' +
  23. '\tsee https://github.com/jprichardson/node-fs-extra/issues/269',
  24. 'Warning', 'fs-extra-WARN0001'
  25. )
  26. }
  27. stat.checkPaths(src, dest, 'copy', opts, (err, stats) => {
  28. if (err) return cb(err)
  29. const { srcStat, destStat } = stats
  30. stat.checkParentPaths(src, srcStat, dest, 'copy', err => {
  31. if (err) return cb(err)
  32. runFilter(src, dest, opts, (err, include) => {
  33. if (err) return cb(err)
  34. if (!include) return cb()
  35. checkParentDir(destStat, src, dest, opts, cb)
  36. })
  37. })
  38. })
  39. }
  40. function checkParentDir (destStat, src, dest, opts, cb) {
  41. const destParent = path.dirname(dest)
  42. pathExists(destParent, (err, dirExists) => {
  43. if (err) return cb(err)
  44. if (dirExists) return getStats(destStat, src, dest, opts, cb)
  45. mkdirs(destParent, err => {
  46. if (err) return cb(err)
  47. return getStats(destStat, src, dest, opts, cb)
  48. })
  49. })
  50. }
  51. function runFilter (src, dest, opts, cb) {
  52. if (!opts.filter) return cb(null, true)
  53. Promise.resolve(opts.filter(src, dest))
  54. .then(include => cb(null, include), error => cb(error))
  55. }
  56. function getStats (destStat, src, dest, opts, cb) {
  57. const stat = opts.dereference ? fs.stat : fs.lstat
  58. stat(src, (err, srcStat) => {
  59. if (err) return cb(err)
  60. if (srcStat.isDirectory()) return onDir(srcStat, destStat, src, dest, opts, cb)
  61. else if (srcStat.isFile() ||
  62. srcStat.isCharacterDevice() ||
  63. srcStat.isBlockDevice()) return onFile(srcStat, destStat, src, dest, opts, cb)
  64. else if (srcStat.isSymbolicLink()) return onLink(destStat, src, dest, opts, cb)
  65. else if (srcStat.isSocket()) return cb(new Error(`Cannot copy a socket file: ${src}`))
  66. else if (srcStat.isFIFO()) return cb(new Error(`Cannot copy a FIFO pipe: ${src}`))
  67. return cb(new Error(`Unknown file: ${src}`))
  68. })
  69. }
  70. function onFile (srcStat, destStat, src, dest, opts, cb) {
  71. if (!destStat) return copyFile(srcStat, src, dest, opts, cb)
  72. return mayCopyFile(srcStat, src, dest, opts, cb)
  73. }
  74. function mayCopyFile (srcStat, src, dest, opts, cb) {
  75. if (opts.overwrite) {
  76. fs.unlink(dest, err => {
  77. if (err) return cb(err)
  78. return copyFile(srcStat, src, dest, opts, cb)
  79. })
  80. } else if (opts.errorOnExist) {
  81. return cb(new Error(`'${dest}' already exists`))
  82. } else return cb()
  83. }
  84. function copyFile (srcStat, src, dest, opts, cb) {
  85. fs.copyFile(src, dest, err => {
  86. if (err) return cb(err)
  87. if (opts.preserveTimestamps) return handleTimestampsAndMode(srcStat.mode, src, dest, cb)
  88. return setDestMode(dest, srcStat.mode, cb)
  89. })
  90. }
  91. function handleTimestampsAndMode (srcMode, src, dest, cb) {
  92. // Make sure the file is writable before setting the timestamp
  93. // otherwise open fails with EPERM when invoked with 'r+'
  94. // (through utimes call)
  95. if (fileIsNotWritable(srcMode)) {
  96. return makeFileWritable(dest, srcMode, err => {
  97. if (err) return cb(err)
  98. return setDestTimestampsAndMode(srcMode, src, dest, cb)
  99. })
  100. }
  101. return setDestTimestampsAndMode(srcMode, src, dest, cb)
  102. }
  103. function fileIsNotWritable (srcMode) {
  104. return (srcMode & 0o200) === 0
  105. }
  106. function makeFileWritable (dest, srcMode, cb) {
  107. return setDestMode(dest, srcMode | 0o200, cb)
  108. }
  109. function setDestTimestampsAndMode (srcMode, src, dest, cb) {
  110. setDestTimestamps(src, dest, err => {
  111. if (err) return cb(err)
  112. return setDestMode(dest, srcMode, cb)
  113. })
  114. }
  115. function setDestMode (dest, srcMode, cb) {
  116. return fs.chmod(dest, srcMode, cb)
  117. }
  118. function setDestTimestamps (src, dest, cb) {
  119. // The initial srcStat.atime cannot be trusted
  120. // because it is modified by the read(2) system call
  121. // (See https://nodejs.org/api/fs.html#fs_stat_time_values)
  122. fs.stat(src, (err, updatedSrcStat) => {
  123. if (err) return cb(err)
  124. return utimesMillis(dest, updatedSrcStat.atime, updatedSrcStat.mtime, cb)
  125. })
  126. }
  127. function onDir (srcStat, destStat, src, dest, opts, cb) {
  128. if (!destStat) return mkDirAndCopy(srcStat.mode, src, dest, opts, cb)
  129. return copyDir(src, dest, opts, cb)
  130. }
  131. function mkDirAndCopy (srcMode, src, dest, opts, cb) {
  132. fs.mkdir(dest, err => {
  133. if (err) return cb(err)
  134. copyDir(src, dest, opts, err => {
  135. if (err) return cb(err)
  136. return setDestMode(dest, srcMode, cb)
  137. })
  138. })
  139. }
  140. function copyDir (src, dest, opts, cb) {
  141. fs.readdir(src, (err, items) => {
  142. if (err) return cb(err)
  143. return copyDirItems(items, src, dest, opts, cb)
  144. })
  145. }
  146. function copyDirItems (items, src, dest, opts, cb) {
  147. const item = items.pop()
  148. if (!item) return cb()
  149. return copyDirItem(items, item, src, dest, opts, cb)
  150. }
  151. function copyDirItem (items, item, src, dest, opts, cb) {
  152. const srcItem = path.join(src, item)
  153. const destItem = path.join(dest, item)
  154. runFilter(srcItem, destItem, opts, (err, include) => {
  155. if (err) return cb(err)
  156. if (!include) return copyDirItems(items, src, dest, opts, cb)
  157. stat.checkPaths(srcItem, destItem, 'copy', opts, (err, stats) => {
  158. if (err) return cb(err)
  159. const { destStat } = stats
  160. getStats(destStat, srcItem, destItem, opts, err => {
  161. if (err) return cb(err)
  162. return copyDirItems(items, src, dest, opts, cb)
  163. })
  164. })
  165. })
  166. }
  167. function onLink (destStat, src, dest, opts, cb) {
  168. fs.readlink(src, (err, resolvedSrc) => {
  169. if (err) return cb(err)
  170. if (opts.dereference) {
  171. resolvedSrc = path.resolve(process.cwd(), resolvedSrc)
  172. }
  173. if (!destStat) {
  174. return fs.symlink(resolvedSrc, dest, cb)
  175. } else {
  176. fs.readlink(dest, (err, resolvedDest) => {
  177. if (err) {
  178. // dest exists and is a regular file or directory,
  179. // Windows may throw UNKNOWN error. If dest already exists,
  180. // fs throws error anyway, so no need to guard against it here.
  181. if (err.code === 'EINVAL' || err.code === 'UNKNOWN') return fs.symlink(resolvedSrc, dest, cb)
  182. return cb(err)
  183. }
  184. if (opts.dereference) {
  185. resolvedDest = path.resolve(process.cwd(), resolvedDest)
  186. }
  187. if (stat.isSrcSubdir(resolvedSrc, resolvedDest)) {
  188. return cb(new Error(`Cannot copy '${resolvedSrc}' to a subdirectory of itself, '${resolvedDest}'.`))
  189. }
  190. // do not copy if src is a subdir of dest since unlinking
  191. // dest in this case would result in removing src contents
  192. // and therefore a broken symlink would be created.
  193. if (stat.isSrcSubdir(resolvedDest, resolvedSrc)) {
  194. return cb(new Error(`Cannot overwrite '${resolvedDest}' with '${resolvedSrc}'.`))
  195. }
  196. return copyLink(resolvedSrc, dest, cb)
  197. })
  198. }
  199. })
  200. }
  201. function copyLink (resolvedSrc, dest, cb) {
  202. fs.unlink(dest, err => {
  203. if (err) return cb(err)
  204. return fs.symlink(resolvedSrc, dest, cb)
  205. })
  206. }
  207. module.exports = copy