mecano

`download([goptions], options, callback)` ----------------------------------------- Download files using various protocols. When executed locally: the `http` protocol is handled with the "request" module; the `ftp` protocol is handled with the "jsftp"; the `file` protocol is handle with the navite `fs` module. fs = require 'ssh2-fs' url = require 'url' Ftp = require 'jsftp' each = require 'each' request = require 'request' curl = require './misc/curl' misc = require './misc' conditions = require './misc/conditions' child = require './misc/child' execute = require './execute' remove = require './remove' move = require './move' `options` Command options include: * `source` File, HTTP URL, FTP, GIT repository. File is the default protocol if source is provided without any. * `destination` Path where the file is downloaded. * `force` Overwrite destination file if it exists. * `stdout` Writable Stream in which commands output will be piped. * `stderr` Writable Stream in which commands error will be piped. `callback` Received parameters are: * `err` Error object if any. * `downloaded` Number of downloaded files File example ```coffee mecano.download source: 'file://path/to/something' destination: 'node-sigar.tgz' , (err, downloaded) -> ... ``` HTTP example ```coffee mecano.download source: 'https://github.com/wdavidw/node-sigar/tarball/v0.0.1' destination: 'node-sigar.tgz' , (err, downloaded) -> ... ``` FTP example ```coffee mecano.download source: 'ftp://myhost.com:3334/wdavidw/node-sigar/tarball/v0.0.1' destination: 'node-sigar.tgz' user: "johndoe", pass: "12345" , (err, downloaded) -> ... ``` module.exports = (goptions, options, callback) -> [goptions, options, callback] = misc.args arguments result = child() finish = (err, downloaded) -> callback err, downloaded if callback result.end err, downloaded misc.options options, (err, options) -> return finish err if err downloaded = 0 each( options ) .parallel(goptions.parallel) .on 'item', (options, next) -> # Validate parameters {destination, source, md5sum} = options # md5sum is used to validate the download return next new Error "Missing source: #{source}" unless source return next new Error "Missing destination: #{destination}" unless destination options.force ?= false stageDestination = "#{destination}.#{Date.now()}#{Math.round(Math.random()*1000)}" # Start real work prepare = () -> options.log? "Check if destination exists" # Note about next line: ssh might be null with file, not very clear fs.exists options.ssh, destination, (err, exists) -> # If we are forcing if options.force # Note, we should be able to move this before the "exists" check just above # because we don't seem to use. Maybe it still here because we were # expecting to remove the existing destination before downloading. download() # If the file exists and we have a checksum to compare and we are not forcing else if exists and md5sum # then we compute the checksum of the file misc.file.hash options.ssh, destination, 'md5', (err, hash) -> return next err if err # And compare with the checksum provided by the user return next() if hash is md5sum fs.unlink options.ssh, destination, (err) -> return next err if err download() # Get the checksum of the current file else if exists download() else download() download = () -> options.log? "Download the source" u = url.parse source if options.ssh if u.protocol is 'http:' cmd = "curl #{source} -o #{stageDestination}" cmd += " -s" # silent cmd += " -x #{options.proxy}" if options.proxy execute ssh: options.ssh cmd: cmd log: options.log stdout: options.stdout stderr: options.stderr , (err, executed, stdout, stderr) -> return next curl.error err if err checksum() else if u.protocol is 'ftp:' return next new Error 'FTP download not supported over SSH' else fs.createReadStream options.ssh, u.pathname, (err, rs) -> return next err if err fs.createWriteStream null, stageDestination, (err, ws) -> return next err if err rs.pipe(ws) .on 'close', -> checksum() .on 'error', next # options.ssh.sftp (err, sftp) -> # return next err if err # rs = sftp.createReadStream u.pathname # ws = rs.pipe fs.createWriteStream stageDestination # ws.on 'close', -> # checksum() # ws.on 'error', next else fs.createWriteStream null, stageDestination, (err, ws) -> return next err if err if u.protocol is 'http:' options.url = source request(options).pipe(ws) else if u.protocol is 'ftp:' options.host ?= u.hostname options.port ?= u.port if u.auth {user, pass} = u.auth.split ':' options.user ?= user options.pass ?= pass ftp = new Ftp options ftp.getGetSocket u.pathname, (err, rs) -> return next err if err rs.pipe ws rs.resume() else fs.createReadStream null, u.pathname, (err, rs) -> rs.pipe ws ws.on 'close', () -> checksum() ws.on 'error', (err) -> # No test agains this but error in case # of connection issue leave an empty file remove ws, (err) -> next err checksum = -> return unstage() unless md5sum options.log? "Compare the downloaded file with the user-provided checksum" misc.file.hash options.ssh, stageDestination, 'md5', (err, hash) -> return unstage() if hash is md5sum # Download is invalid, cleaning up misc.file.remove options.ssh, stageDestination, (err) -> return next err if err next new Error "Invalid checksum, found \"#{hash}\" instead of \"#{md5sum}\"" unstage = -> # Note about next line: ssh might be null with file, not very clear # fs.rename options.ssh, stageDestination, destination, (err) -> # return next err if err # downloaded++ # next() options.log? "Move the downloaded file" move ssh: options.ssh source: stageDestination destination: destination source_md5: md5sum , (err, moved) -> return next err if err downloaded++ if moved next() prepare() .on 'both', (err) -> finish err, downloaded