copy.js 7.6 KB

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