Actions/FTP-Deploy-Action
1
Fork 0
mirror of https://github.com/SamKirkland/FTP-Deploy-Action.git synced 2025-10-31 16:24:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

v4.3.4 (#385)

Browse Source 
- updated basic-ftp
- new vx.x.x tags
This commit is contained in:
Sam Kirkland 2023-03-15 00:50:07 -05:00 committed by GitHub
parent 89e533f02c
commit 8a24039354
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 3106 additions and 1792 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -23,7 +23,7 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.3.3 uses: SamKirkland/FTP-Deploy-Action@v4.3.4
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@ -99,7 +99,7 @@ jobs:
npm run build npm run build
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.3.3 uses: SamKirkland/FTP-Deploy-Action@v4.3.4
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@ -119,7 +119,7 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.3.3 uses: SamKirkland/FTP-Deploy-Action@v4.3.4
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@ -142,7 +142,7 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.3.3 uses: SamKirkland/FTP-Deploy-Action@v4.3.4
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName
@ -164,7 +164,7 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: 📂 Sync files - name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@4.3.3 uses: SamKirkland/FTP-Deploy-Action@v4.3.4
with: with:
server: ftp.samkirkland.com server: ftp.samkirkland.com
username: myFtpUserName username: myFtpUserName

220
dist/index.js vendored
View File

@ -4116,12 +4116,12 @@ const netUtils_1 = __nccwpck_require__(6288);
const transfer_1 = __nccwpck_require__(5803); const transfer_1 = __nccwpck_require__(5803);
const parseControlResponse_1 = __nccwpck_require__(9948); const parseControlResponse_1 = __nccwpck_require__(9948);
// Use promisify to keep the library compatible with Node 8. // Use promisify to keep the library compatible with Node 8.
const fsReadDir = util_1.promisify(fs_1.readdir); const fsReadDir = (0, util_1.promisify)(fs_1.readdir);
const fsMkDir = util_1.promisify(fs_1.mkdir); const fsMkDir = (0, util_1.promisify)(fs_1.mkdir);
const fsStat = util_1.promisify(fs_1.stat); const fsStat = (0, util_1.promisify)(fs_1.stat);
const fsOpen = util_1.promisify(fs_1.open); const fsOpen = (0, util_1.promisify)(fs_1.open);
const fsClose = util_1.promisify(fs_1.close); const fsClose = (0, util_1.promisify)(fs_1.close);
const fsUnlink = util_1.promisify(fs_1.unlink); const fsUnlink = (0, util_1.promisify)(fs_1.unlink);
const LIST_COMMANDS_DEFAULT = ["LIST -a", "LIST"]; const LIST_COMMANDS_DEFAULT = ["LIST -a", "LIST"];
const LIST_COMMANDS_MLSD = ["MLSD", "LIST -a", "LIST"]; const LIST_COMMANDS_MLSD = ["MLSD", "LIST -a", "LIST"];
/** /**
@ -4174,7 +4174,7 @@ class Client {
host, host,
port, port,
family: this.ftp.ipFamily family: this.ftp.ipFamily
}, () => this.ftp.log(`Connected to ${netUtils_1.describeAddress(this.ftp.socket)} (${netUtils_1.describeTLS(this.ftp.socket)})`)); }, () => this.ftp.log(`Connected to ${(0, netUtils_1.describeAddress)(this.ftp.socket)} (${(0, netUtils_1.describeTLS)(this.ftp.socket)})`));
return this._handleConnectResponse(); return this._handleConnectResponse();
} }
/** /**
@ -4183,7 +4183,7 @@ class Client {
*/ */
connectImplicitTLS(host = "localhost", port = 21, tlsOptions = {}) { connectImplicitTLS(host = "localhost", port = 21, tlsOptions = {}) {
this.ftp.reset(); this.ftp.reset();
this.ftp.socket = tls_1.connect(port, host, tlsOptions, () => this.ftp.log(`Connected to ${netUtils_1.describeAddress(this.ftp.socket)} (${netUtils_1.describeTLS(this.ftp.socket)})`)); this.ftp.socket = (0, tls_1.connect)(port, host, tlsOptions, () => this.ftp.log(`Connected to ${(0, netUtils_1.describeAddress)(this.ftp.socket)} (${(0, netUtils_1.describeTLS)(this.ftp.socket)})`));
this.ftp.tlsOptions = tlsOptions; this.ftp.tlsOptions = tlsOptions;
return this._handleConnectResponse(); return this._handleConnectResponse();
} }
@ -4196,14 +4196,13 @@ class Client {
// The connection has been destroyed by the FTPContext at this point. // The connection has been destroyed by the FTPContext at this point.
task.reject(res); task.reject(res);
} }
else if (parseControlResponse_1.positiveCompletion(res.code)) { else if ((0, parseControlResponse_1.positiveCompletion)(res.code)) {
task.resolve(res); task.resolve(res);
} }
// Reject all other codes, including 120 "Service ready in nnn minutes". // Reject all other codes, including 120 "Service ready in nnn minutes".
else { else {
// Don't stay connected but don't replace the socket yet by using reset() // Don't stay connected but don't replace the socket yet by using reset()
// so the user can inspect properties of this instance. // so the user can inspect properties of this instance.
this.ftp.socket.destroy();
task.reject(new FtpContext_1.FTPError(res)); task.reject(new FtpContext_1.FTPError(res));
} }
}); });
@ -4244,9 +4243,9 @@ class Client {
*/ */
async useTLS(options = {}, command = "AUTH TLS") { async useTLS(options = {}, command = "AUTH TLS") {
const ret = await this.send(command); const ret = await this.send(command);
this.ftp.socket = await netUtils_1.upgradeSocket(this.ftp.socket, options); this.ftp.socket = await (0, netUtils_1.upgradeSocket)(this.ftp.socket, options);
this.ftp.tlsOptions = options; // Keep the TLS options for later data connections that should use the same options. this.ftp.tlsOptions = options; // Keep the TLS options for later data connections that should use the same options.
this.ftp.log(`Control socket is using: ${netUtils_1.describeTLS(this.ftp.socket)}`); this.ftp.log(`Control socket is using: ${(0, netUtils_1.describeTLS)(this.ftp.socket)}`);
return ret; return ret;
} }
/** /**
@ -4256,12 +4255,12 @@ class Client {
* @param password Password to use for login. Optional, default is "guest". * @param password Password to use for login. Optional, default is "guest".
*/ */
login(user = "anonymous", password = "guest") { login(user = "anonymous", password = "guest") {
this.ftp.log(`Login security: ${netUtils_1.describeTLS(this.ftp.socket)}`); this.ftp.log(`Login security: ${(0, netUtils_1.describeTLS)(this.ftp.socket)}`);
return this.ftp.handle("USER " + user, (res, task) => { return this.ftp.handle("USER " + user, (res, task) => {
if (res instanceof Error) { if (res instanceof Error) {
task.reject(res); task.reject(res);
} }
else if (parseControlResponse_1.positiveCompletion(res.code)) { // User logged in proceed OR Command superfluous else if ((0, parseControlResponse_1.positiveCompletion)(res.code)) { // User logged in proceed OR Command superfluous
task.resolve(res); task.resolve(res);
} }
else if (res.code === 331) { // User name okay, need password else if (res.code === 331) { // User name okay, need password
@ -4351,7 +4350,7 @@ class Client {
const res = await this.sendIgnoringError("FEAT"); const res = await this.sendIgnoringError("FEAT");
const features = new Map(); const features = new Map();
// Not supporting any special features will be reported with a single line. // Not supporting any special features will be reported with a single line.
if (res.code < 400 && parseControlResponse_1.isMultiline(res.message)) { if (res.code < 400 && (0, parseControlResponse_1.isMultiline)(res.message)) {
// The first and last line wrap the multiline response, ignore them. // The first and last line wrap the multiline response, ignore them.
res.message.split("\n").slice(1, -1).forEach(line => { res.message.split("\n").slice(1, -1).forEach(line => {
// A typical lines looks like: " REST STREAM" or " MDTM". // A typical lines looks like: " REST STREAM" or " MDTM".
@ -4383,7 +4382,7 @@ class Client {
const validPath = await this.protectWhitespace(path); const validPath = await this.protectWhitespace(path);
const res = await this.send(`MDTM ${validPath}`); const res = await this.send(`MDTM ${validPath}`);
const date = res.message.slice(4); const date = res.message.slice(4);
return parseListMLSD_1.parseMLSxDate(date); return (0, parseListMLSD_1.parseMLSxDate)(date);
} }
/** /**
* Get the size of a file. * Get the size of a file.
@ -4467,7 +4466,7 @@ class Client {
*/ */
async _uploadLocalFile(localPath, remotePath, command, options) { async _uploadLocalFile(localPath, remotePath, command, options) {
const fd = await fsOpen(localPath, "r"); const fd = await fsOpen(localPath, "r");
const source = fs_1.createReadStream("", { const source = (0, fs_1.createReadStream)("", {
fd, fd,
start: options.localStart, start: options.localStart,
end: options.localEndInclusive, end: options.localEndInclusive,
@ -4491,7 +4490,7 @@ class Client {
await this.prepareTransfer(this.ftp); await this.prepareTransfer(this.ftp);
// Keep the keyword `await` or the `finally` clause below runs too early // Keep the keyword `await` or the `finally` clause below runs too early
// and removes the event listener for the source stream too early. // and removes the event listener for the source stream too early.
return await transfer_1.uploadFrom(source, { return await (0, transfer_1.uploadFrom)(source, {
ftp: this.ftp, ftp: this.ftp,
tracker: this._progressTracker, tracker: this._progressTracker,
command, command,
@ -4529,7 +4528,7 @@ class Client {
const appendingToLocalFile = startAt > 0; const appendingToLocalFile = startAt > 0;
const fileSystemFlags = appendingToLocalFile ? "r+" : "w"; const fileSystemFlags = appendingToLocalFile ? "r+" : "w";
const fd = await fsOpen(localPath, fileSystemFlags); const fd = await fsOpen(localPath, fileSystemFlags);
const destination = fs_1.createWriteStream("", { const destination = (0, fs_1.createWriteStream)("", {
fd, fd,
start: startAt, start: startAt,
autoClose: false autoClose: false
@ -4561,7 +4560,7 @@ class Client {
await this.prepareTransfer(this.ftp); await this.prepareTransfer(this.ftp);
// Keep the keyword `await` or the `finally` clause below runs too early // Keep the keyword `await` or the `finally` clause below runs too early
// and removes the event listener for the source stream too early. // and removes the event listener for the source stream too early.
return await transfer_1.downloadTo(destination, { return await (0, transfer_1.downloadTo)(destination, {
ftp: this.ftp, ftp: this.ftp,
tracker: this._progressTracker, tracker: this._progressTracker,
command: startAt > 0 ? `REST ${startAt}` : `RETR ${validPath}`, command: startAt > 0 ? `REST ${startAt}` : `RETR ${validPath}`,
@ -4606,7 +4605,7 @@ class Client {
*/ */
async _requestListWithCommand(command) { async _requestListWithCommand(command) {
const buffer = new StringWriter_1.StringWriter(); const buffer = new StringWriter_1.StringWriter();
await transfer_1.downloadTo(buffer, { await (0, transfer_1.downloadTo)(buffer, {
ftp: this.ftp, ftp: this.ftp,
tracker: this._progressTracker, tracker: this._progressTracker,
command, command,
@ -4679,7 +4678,7 @@ class Client {
async _uploadToWorkingDir(localDirPath) { async _uploadToWorkingDir(localDirPath) {
const files = await fsReadDir(localDirPath); const files = await fsReadDir(localDirPath);
for (const file of files) { for (const file of files) {
const fullPath = path_1.join(localDirPath, file); const fullPath = (0, path_1.join)(localDirPath, file);
const stats = await fsStat(fullPath); const stats = await fsStat(fullPath);
if (stats.isFile()) { if (stats.isFile()) {
await this.uploadFrom(fullPath, file); await this.uploadFrom(fullPath, file);
@ -4711,7 +4710,7 @@ class Client {
async _downloadFromWorkingDir(localDirPath) { async _downloadFromWorkingDir(localDirPath) {
await ensureLocalDirectory(localDirPath); await ensureLocalDirectory(localDirPath);
for (const file of await this.list()) { for (const file of await this.list()) {
const localPath = path_1.join(localDirPath, file.name); const localPath = (0, path_1.join)(localDirPath, file.name);
if (file.isDirectory) { if (file.isDirectory) {
await this.cd(file.name); await this.cd(file.name);
await this._downloadFromWorkingDir(localPath); await this._downloadFromWorkingDir(localPath);
@ -4781,26 +4780,26 @@ class Client {
* Try all available transfer strategies and pick the first one that works. Update `client` to * Try all available transfer strategies and pick the first one that works. Update `client` to
* use the working strategy for all successive transfer requests. * use the working strategy for all successive transfer requests.
* *
* @param transferModes
* @returns a function that will try the provided strategies. * @returns a function that will try the provided strategies.
*/ */
_enterFirstCompatibleMode(transferModes) { _enterFirstCompatibleMode(strategies) {
return async (ftp) => { return async (ftp) => {
ftp.log("Trying to find optimal transfer mode..."); ftp.log("Trying to find optimal transfer strategy...");
for (const transferMode of transferModes) { let lastError = undefined;
for (const strategy of strategies) {
try { try {
const res = await transferMode(ftp); const res = await strategy(ftp);
ftp.log("Optimal transfer mode found."); ftp.log("Optimal transfer strategy found.");
this.prepareTransfer = transferMode; // eslint-disable-line require-atomic-updates this.prepareTransfer = strategy; // eslint-disable-line require-atomic-updates
return res; return res;
} }
catch (err) { catch (err) {
// Try the next candidate no matter the exact error. It's possible that a server // Try the next candidate no matter the exact error. It's possible that a server
// answered incorrectly to a strategy, for example a PASV answer to an EPSV. // answered incorrectly to a strategy, for example a PASV answer to an EPSV.
ftp.log(`Transfer mode failed: "${err.message}", will try next.`); lastError = err;
} }
} }
throw new Error("None of the available transfer modes work."); throw new Error(`None of the available transfer strategies work. Last error response was '${lastError}'.`);
}; };
} }
/** /**
@ -5038,7 +5037,8 @@ class FTPContext {
return; return;
} }
this._closingError = err; this._closingError = err;
// Before giving the user's task a chance to react, make sure we won't be bothered with any inputs. this.send("QUIT"); // Don't wait for an answer
// Close the sockets but don't fully reset this context to preserve `this._closingError`.
this._closeSocket(this._socket); this._closeSocket(this._socket);
this._closeSocket(this._dataSocket); this._closeSocket(this._dataSocket);
// Give the user's task a chance to react, maybe cleanup resources. // Give the user's task a chance to react, maybe cleanup resources.
@ -5071,16 +5071,17 @@ class FTPContext {
set socket(socket) { set socket(socket) {
// No data socket should be open in any case where the control socket is set or upgraded. // No data socket should be open in any case where the control socket is set or upgraded.
this.dataSocket = undefined; this.dataSocket = undefined;
// This being a reset, reset any other state apart from the socket.
this.tlsOptions = {}; this.tlsOptions = {};
// This being a soft reset, remove any remaining partial response.
this._partialResponse = ""; this._partialResponse = "";
if (this._socket) { if (this._socket) {
// Only close the current connection if the new is not an upgrade. const newSocketUpgradesExisting = socket.localPort === this._socket.localPort;
const isUpgrade = socket.localPort === this._socket.localPort; if (newSocketUpgradesExisting) {
if (!isUpgrade) { this._removeSocketListeners(this.socket);
this._socket.destroy(); }
else {
this._closeSocket(this.socket);
} }
this._removeSocketListeners(this._socket);
} }
if (socket) { if (socket) {
// Setting a completely new control socket is in essence something like a reset. That's // Setting a completely new control socket is in essence something like a reset. That's
@ -5168,7 +5169,6 @@ class FTPContext {
*/ */
handle(command, responseHandler) { handle(command, responseHandler) {
if (this._task) { if (this._task) {
// The user or client instance called `handle()` while a task is still running.
const err = new Error("User launched a task while another one is still running. Forgot to use 'await' or '.then()'?"); const err = new Error("User launched a task while another one is still running. Forgot to use 'await' or '.then()'?");
err.stack += `\nRunning task launched at: ${this._task.stack}`; err.stack += `\nRunning task launched at: ${this._task.stack}`;
this.closeWithError(err); this.closeWithError(err);
@ -5176,27 +5176,25 @@ class FTPContext {
// because the context closed already. That way, users will receive an exception where // because the context closed already. That way, users will receive an exception where
// they called this method by mistake. // they called this method by mistake.
} }
return new Promise((resolvePromise, rejectPromise) => { return new Promise((resolveTask, rejectTask) => {
const stack = new Error().stack || "Unknown call stack";
const resolver = {
resolve: (arg) => {
this._stopTrackingTask();
resolvePromise(arg);
},
reject: err => {
this._stopTrackingTask();
rejectPromise(err);
}
};
this._task = { this._task = {
stack, stack: new Error().stack || "Unknown call stack",
resolver, responseHandler,
responseHandler resolver: {
resolve: arg => {
this._stopTrackingTask();
resolveTask(arg);
},
reject: err => {
this._stopTrackingTask();
rejectTask(err);
}
}
}; };
if (this._closingError) { if (this._closingError) {
// This client has been closed. Provide an error that describes this one as being caused // This client has been closed. Provide an error that describes this one as being caused
// by `_closingError`, include stack traces for both. // by `_closingError`, include stack traces for both.
const err = new Error("Client is closed"); // Type 'Error' is not correctly defined, doesn't have 'code'. const err = new Error(`Client is closed because ${this._closingError.message}`); // Type 'Error' is not correctly defined, doesn't have 'code'.
err.stack += `\nClosing reason: ${this._closingError.stack}`; err.stack += `\nClosing reason: ${this._closingError.stack}`;
err.code = this._closingError.code !== undefined ? this._closingError.code : "0"; err.code = this._closingError.code !== undefined ? this._closingError.code : "0";
this._passToHandler(err); this._passToHandler(err);
@ -5244,7 +5242,7 @@ class FTPContext {
this.log(`< ${chunk}`); this.log(`< ${chunk}`);
// This chunk might complete an earlier partial response. // This chunk might complete an earlier partial response.
const completeResponse = this._partialResponse + chunk; const completeResponse = this._partialResponse + chunk;
const parsed = parseControlResponse_1.parseControlResponse(completeResponse); const parsed = (0, parseControlResponse_1.parseControlResponse)(completeResponse);
// Remember any incomplete remainder. // Remember any incomplete remainder.
this._partialResponse = parsed.rest; this._partialResponse = parsed.rest;
// Each response group is passed along individually. // Each response group is passed along individually.
@ -5285,7 +5283,10 @@ class FTPContext {
this.closeWithError(new Error(`Socket closed due to transmission error (${identifier})`)); this.closeWithError(new Error(`Socket closed due to transmission error (${identifier})`));
} }
}); });
socket.once("timeout", () => this.closeWithError(new Error(`Timeout (${identifier})`))); socket.once("timeout", () => {
socket.destroy();
this.closeWithError(new Error(`Timeout (${identifier})`));
});
} }
/** /**
* Close a socket. * Close a socket.
@ -5293,8 +5294,11 @@ class FTPContext {
*/ */
_closeSocket(socket) { _closeSocket(socket) {
if (socket) { if (socket) {
socket.destroy();
this._removeSocketListeners(socket); this._removeSocketListeners(socket);
socket.on("error", () => { });
socket.on("timeout", () => socket.destroy());
socket.setTimeout(this.timeout);
socket.end();
} }
} }
/** /**
@ -5453,7 +5457,11 @@ exports.StringWriter = StringWriter;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k; if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) { }) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k; if (k2 === undefined) k2 = k;
o[k2] = m[k]; o[k2] = m[k];
@ -5515,7 +5523,7 @@ function upgradeSocket(socket, options) {
const tlsOptions = Object.assign({}, options, { const tlsOptions = Object.assign({}, options, {
socket socket
}); });
const tlsSocket = tls_1.connect(tlsOptions, () => { const tlsSocket = (0, tls_1.connect)(tlsOptions, () => {
const expectCertificate = tlsOptions.rejectUnauthorized !== false; const expectCertificate = tlsOptions.rejectUnauthorized !== false;
if (expectCertificate && !tlsSocket.authorized) { if (expectCertificate && !tlsSocket.authorized) {
reject(tlsSocket.authorizationError); reject(tlsSocket.authorizationError);
@ -5545,7 +5553,8 @@ function ipIsPrivateV4Address(ip = "") {
const octets = ip.split(".").map(o => parseInt(o, 10)); const octets = ip.split(".").map(o => parseInt(o, 10));
return octets[0] === 10 // 10.0.0.0 - 10.255.255.255 return octets[0] === 10 // 10.0.0.0 - 10.255.255.255
|| (octets[0] === 172 && octets[1] >= 16 && octets[1] <= 31) // 172.16.0.0 - 172.31.255.255 || (octets[0] === 172 && octets[1] >= 16 && octets[1] <= 31) // 172.16.0.0 - 172.31.255.255
|| (octets[0] === 192 && octets[1] === 168); // 192.168.0.0 - 192.168.255.255 || (octets[0] === 192 && octets[1] === 168) // 192.168.0.0 - 192.168.255.255
|| ip === "127.0.0.1";
} }
exports.ipIsPrivateV4Address = ipIsPrivateV4Address; exports.ipIsPrivateV4Address = ipIsPrivateV4Address;
@ -5634,7 +5643,11 @@ function isNotBlank(str) {
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k; if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) { }) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k; if (k2 === undefined) k2 = k;
o[k2] = m[k]; o[k2] = m[k];
@ -5668,9 +5681,12 @@ const availableParsers = [
function firstCompatibleParser(line, parsers) { function firstCompatibleParser(line, parsers) {
return parsers.find(parser => parser.testLine(line) === true); return parsers.find(parser => parser.testLine(line) === true);
} }
function stringIsNotBlank(str) { function isNotBlank(str) {
return str.trim() !== ""; return str.trim() !== "";
} }
function isNotMeta(str) {
return !str.startsWith("total");
}
const REGEX_NEWLINE = /\r?\n/; const REGEX_NEWLINE = /\r?\n/;
/** /**
* Parse raw directory listing. * Parse raw directory listing.
@ -5678,7 +5694,8 @@ const REGEX_NEWLINE = /\r?\n/;
function parseList(rawList) { function parseList(rawList) {
const lines = rawList const lines = rawList
.split(REGEX_NEWLINE) .split(REGEX_NEWLINE)
.filter(stringIsNotBlank); .filter(isNotBlank)
.filter(isNotMeta);
if (lines.length === 0) { if (lines.length === 0) {
return []; return [];
} }
@ -5797,7 +5814,7 @@ const factHandlersByName = {
if (value.startsWith("OS.unix=slink")) { if (value.startsWith("OS.unix=slink")) {
info.type = FileInfo_1.FileType.SymbolicLink; info.type = FileInfo_1.FileType.SymbolicLink;
info.link = value.substr(value.indexOf(":") + 1); info.link = value.substr(value.indexOf(":") + 1);
return 1 /* Continue */; return 1 /* FactHandlerResult.Continue */;
} }
switch (value) { switch (value) {
case "file": case "file":
@ -5813,11 +5830,11 @@ const factHandlersByName = {
break; break;
case "cdir": // Current directory being listed case "cdir": // Current directory being listed
case "pdir": // Parent directory case "pdir": // Parent directory
return 2 /* IgnoreFile */; // Don't include these entries in the listing return 2 /* FactHandlerResult.IgnoreFile */; // Don't include these entries in the listing
default: default:
info.type = FileInfo_1.FileType.Unknown; info.type = FileInfo_1.FileType.Unknown;
} }
return 1 /* Continue */; return 1 /* FactHandlerResult.Continue */;
}, },
"unix.mode": (value, info) => { "unix.mode": (value, info) => {
const digits = value.substr(-3); const digits = value.substr(-3);
@ -5898,7 +5915,7 @@ function parseLine(line) {
continue; continue;
} }
const result = factHandler(factValue, info); const result = factHandler(factValue, info);
if (result === 2 /* IgnoreFile */) { if (result === 2 /* FactHandlerResult.IgnoreFile */) {
return undefined; return undefined;
} }
} }
@ -5996,7 +6013,7 @@ const JA_YEAR = "\u5e74";
* {@code @} file has extended attributes * {@code @} file has extended attributes
*/ */
const RE_LINE = new RegExp("([bcdelfmpSs-])" // file type const RE_LINE = new RegExp("([bcdelfmpSs-])" // file type
+ "(((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-])))\\+?" // permissions + "(((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-]?)))\\+?" // permissions
+ "\\s*" // separator TODO why allow it to be omitted?? + "\\s*" // separator TODO why allow it to be omitted??
+ "(\\d+)" // link count + "(\\d+)" // link count
+ "\\s+" // separator + "\\s+" // separator
@ -6126,6 +6143,7 @@ function parseMode(r, w, x) {
Object.defineProperty(exports, "__esModule", ({ value: true })); Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.downloadTo = exports.uploadFrom = exports.connectForPassiveTransfer = exports.parsePasvResponse = exports.enterPassiveModeIPv4 = exports.parseEpsvResponse = exports.enterPassiveModeIPv6 = void 0; exports.downloadTo = exports.uploadFrom = exports.connectForPassiveTransfer = exports.parsePasvResponse = exports.enterPassiveModeIPv4 = exports.parseEpsvResponse = exports.enterPassiveModeIPv6 = void 0;
const netUtils_1 = __nccwpck_require__(6288); const netUtils_1 = __nccwpck_require__(6288);
const stream_1 = __nccwpck_require__(2781);
const tls_1 = __nccwpck_require__(4404); const tls_1 = __nccwpck_require__(4404);
const parseControlResponse_1 = __nccwpck_require__(9948); const parseControlResponse_1 = __nccwpck_require__(9948);
/** /**
@ -6176,7 +6194,7 @@ async function enterPassiveModeIPv4(ftp) {
// We can't always perform this replacement because it's possible (although unlikely) that the FTP server // We can't always perform this replacement because it's possible (although unlikely) that the FTP server
// indeed uses a different host for data connections. // indeed uses a different host for data connections.
const controlHost = ftp.socket.remoteAddress; const controlHost = ftp.socket.remoteAddress;
if (netUtils_1.ipIsPrivateV4Address(target.host) && controlHost && !netUtils_1.ipIsPrivateV4Address(controlHost)) { if ((0, netUtils_1.ipIsPrivateV4Address)(target.host) && controlHost && !(0, netUtils_1.ipIsPrivateV4Address)(controlHost)) {
target.host = controlHost; target.host = controlHost;
} }
await connectForPassiveTransfer(target.host, target.port, ftp); await connectForPassiveTransfer(target.host, target.port, ftp);
@ -6200,15 +6218,21 @@ function parsePasvResponse(message) {
exports.parsePasvResponse = parsePasvResponse; exports.parsePasvResponse = parsePasvResponse;
function connectForPassiveTransfer(host, port, ftp) { function connectForPassiveTransfer(host, port, ftp) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
let socket = ftp._newSocket();
const handleConnErr = function (err) { const handleConnErr = function (err) {
err.message = "Can't open data connection in passive mode: " + err.message; err.message = "Can't open data connection in passive mode: " + err.message;
reject(err); reject(err);
}; };
let socket = ftp._newSocket(); const handleTimeout = function () {
socket.destroy();
reject(new Error(`Timeout when trying to open data connection to ${host}:${port}`));
};
socket.setTimeout(ftp.timeout);
socket.on("error", handleConnErr); socket.on("error", handleConnErr);
socket.on("timeout", handleTimeout);
socket.connect({ port, host, family: ftp.ipFamily }, () => { socket.connect({ port, host, family: ftp.ipFamily }, () => {
if (ftp.socket instanceof tls_1.TLSSocket) { if (ftp.socket instanceof tls_1.TLSSocket) {
socket = tls_1.connect(Object.assign({}, ftp.tlsOptions, { socket = (0, tls_1.connect)(Object.assign({}, ftp.tlsOptions, {
socket, socket,
// Reuse the TLS session negotiated earlier when the control connection // Reuse the TLS session negotiated earlier when the control connection
// was upgraded. Servers expect this because it provides additional // was upgraded. Servers expect this because it provides additional
@ -6227,6 +6251,7 @@ function connectForPassiveTransfer(host, port, ftp) {
} }
// Let the FTPContext listen to errors from now on, remove local handler. // Let the FTPContext listen to errors from now on, remove local handler.
socket.removeListener("error", handleConnErr); socket.removeListener("error", handleConnErr);
socket.removeListener("timeout", handleTimeout);
ftp.dataSocket = socket; ftp.dataSocket = socket;
resolve(); resolve();
}); });
@ -6336,18 +6361,22 @@ function uploadFrom(source, config) {
// 'secureConnect'. If this hasn't happened yet, getCipher() returns undefined. // 'secureConnect'. If this hasn't happened yet, getCipher() returns undefined.
const canUpload = "getCipher" in dataSocket ? dataSocket.getCipher() !== undefined : true; const canUpload = "getCipher" in dataSocket ? dataSocket.getCipher() !== undefined : true;
onConditionOrEvent(canUpload, dataSocket, "secureConnect", () => { onConditionOrEvent(canUpload, dataSocket, "secureConnect", () => {
config.ftp.log(`Uploading to ${netUtils_1.describeAddress(dataSocket)} (${netUtils_1.describeTLS(dataSocket)})`); config.ftp.log(`Uploading to ${(0, netUtils_1.describeAddress)(dataSocket)} (${(0, netUtils_1.describeTLS)(dataSocket)})`);
resolver.onDataStart(config.remotePath, config.type); resolver.onDataStart(config.remotePath, config.type);
source.pipe(dataSocket).once("finish", () => { (0, stream_1.pipeline)(source, dataSocket, err => {
dataSocket.destroy(); // Explicitly close/destroy the socket to signal the end. if (err) {
resolver.onDataDone(task); resolver.onError(task, err);
}
else {
resolver.onDataDone(task);
}
}); });
}); });
} }
else if (parseControlResponse_1.positiveCompletion(res.code)) { // Transfer complete else if ((0, parseControlResponse_1.positiveCompletion)(res.code)) { // Transfer complete
resolver.onControlDone(task, res); resolver.onControlDone(task, res);
} }
else if (parseControlResponse_1.positiveIntermediate(res.code)) { else if ((0, parseControlResponse_1.positiveIntermediate)(res.code)) {
resolver.onUnexpectedRequest(res); resolver.onUnexpectedRequest(res);
} }
// Ignore all other positive preliminary response codes (< 200) // Ignore all other positive preliminary response codes (< 200)
@ -6358,9 +6387,6 @@ function downloadTo(destination, config) {
if (!config.ftp.dataSocket) { if (!config.ftp.dataSocket) {
throw new Error("Download will be initiated but no data connection is available."); throw new Error("Download will be initiated but no data connection is available.");
} }
// It's possible that data transmission begins before the control socket
// receives the announcement. Start listening for data immediately.
config.ftp.dataSocket.pipe(destination);
const resolver = new TransferResolver(config.ftp, config.tracker); const resolver = new TransferResolver(config.ftp, config.tracker);
return config.ftp.handle(config.command, (res, task) => { return config.ftp.handle(config.command, (res, task) => {
if (res instanceof Error) { if (res instanceof Error) {
@ -6372,17 +6398,24 @@ function downloadTo(destination, config) {
resolver.onError(task, new Error("Download should begin but no data connection is available.")); resolver.onError(task, new Error("Download should begin but no data connection is available."));
return; return;
} }
config.ftp.log(`Downloading from ${netUtils_1.describeAddress(dataSocket)} (${netUtils_1.describeTLS(dataSocket)})`); config.ftp.log(`Downloading from ${(0, netUtils_1.describeAddress)(dataSocket)} (${(0, netUtils_1.describeTLS)(dataSocket)})`);
resolver.onDataStart(config.remotePath, config.type); resolver.onDataStart(config.remotePath, config.type);
onConditionOrEvent(isWritableFinished(destination), destination, "finish", () => resolver.onDataDone(task)); (0, stream_1.pipeline)(dataSocket, destination, err => {
if (err) {
resolver.onError(task, err);
}
else {
resolver.onDataDone(task);
}
});
} }
else if (res.code === 350) { // Restarting at startAt. else if (res.code === 350) { // Restarting at startAt.
config.ftp.send("RETR " + config.remotePath); config.ftp.send("RETR " + config.remotePath);
} }
else if (parseControlResponse_1.positiveCompletion(res.code)) { // Transfer complete else if ((0, parseControlResponse_1.positiveCompletion)(res.code)) { // Transfer complete
resolver.onControlDone(task, res); resolver.onControlDone(task, res);
} }
else if (parseControlResponse_1.positiveIntermediate(res.code)) { else if ((0, parseControlResponse_1.positiveIntermediate)(res.code)) {
resolver.onUnexpectedRequest(res); resolver.onUnexpectedRequest(res);
} }
// Ignore all other positive preliminary response codes (< 200) // Ignore all other positive preliminary response codes (< 200)
@ -6406,18 +6439,6 @@ function onConditionOrEvent(condition, emitter, eventName, action) {
emitter.once(eventName, () => action()); emitter.once(eventName, () => action());
} }
} }
/**
* Detect whether a writable stream is finished, supporting Node 8.
* From https://github.com/nodejs/node/blob/3e2a3007107b7a100794f4e4adbde19263fc7464/lib/internal/streams/end-of-stream.js#L28-L33
*/
function isWritableFinished(stream) {
if (stream.writableFinished)
return true;
const wState = stream._writableState;
if (!wState || wState.errored)
return false;
return wState.finished || (wState.ended && wState.length === 0);
}
/***/ }), /***/ }),
@ -9037,7 +9058,8 @@ async function runDeployment() {
"dangerous-clean-slate": (0, parse_1.optionalBoolean)("dangerous-clean-slate", core.getInput("dangerous-clean-slate")), "dangerous-clean-slate": (0, parse_1.optionalBoolean)("dangerous-clean-slate", core.getInput("dangerous-clean-slate")),
"exclude": (0, parse_1.optionalStringArray)("exclude", core.getMultilineInput("exclude")), "exclude": (0, parse_1.optionalStringArray)("exclude", core.getMultilineInput("exclude")),
"log-level": (0, parse_1.optionalLogLevel)("log-level", core.getInput("log-level")), "log-level": (0, parse_1.optionalLogLevel)("log-level", core.getInput("log-level")),
"security": (0, parse_1.optionalSecurity)("security", core.getInput("security")) "security": (0, parse_1.optionalSecurity)("security", core.getInput("security")),
"timeout": (0, parse_1.optionalInt)("timeout", core.getInput("timeout"))
}; };
await (0, ftp_deploy_1.deploy)(args); await (0, ftp_deploy_1.deploy)(args);
} }

2
migration.md
View File

@ -27,7 +27,7 @@ Most features have been carried forward and improved upon. However, some feature
### How to upgrade ### How to upgrade
1) Remove `with: fetch-depth: 2`. It is no longer needed and removing it will _slightly_ speed up deployments. 1) Remove `with: fetch-depth: 2`. It is no longer needed and removing it will _slightly_ speed up deployments.
2) Change the version to `4.X.X`, for example `SamKirkland/FTP-Deploy-Action@4.3.1` (please check readme for latest version) 2) Change the version to `4.X.X`, for example `SamKirkland/FTP-Deploy-Action@v4.3.4` (please check readme for latest version)
3) If you have a `.git-ftp-include` file you should delete it. Version 4 tracks files differently and no longer needs this config file. 3) If you have a `.git-ftp-include` file you should delete it. Version 4 tracks files differently and no longer needs this config file.
4) If you have a `.git-ftp-ignore` file, you should transfer the options to the new `exclude` argument. _Note: Version 4 excludes any `.git*` and `node_modules/` files/folders by default_ 4) If you have a `.git-ftp-ignore` file, you should transfer the options to the new `exclude` argument. _Note: Version 4 excludes any `.git*` and `node_modules/` files/folders by default_
5) Update your arguments to reflect the following changes 5) Update your arguments to reflect the following changes

4656
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

10
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "ftp-deploy-action", "name": "ftp-deploy-action",
"version": "4.3.3", "version": "4.3.4",
"private": true, "private": true,
"description": "Automate deploying websites and more with this GitHub action", "description": "Automate deploying websites and more with this GitHub action",
"main": "dist/index.js", "main": "dist/index.js",
@ -23,10 +23,10 @@
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@actions/core": "^1.9.1", "@actions/core": "^1.9.1",
"@samkirkland/ftp-deploy": "^1.2.2", "@samkirkland/ftp-deploy": "^1.2.3",
"@types/jest": "^28.1.7", "@types/jest": "^29.4.1",
"jest": "^28.1.3", "jest": "^29.5.0",
"ts-jest": "^28.0.8", "ts-jest": "^29.0.5",
"ts-node-dev": "^2.0.0" "ts-node-dev": "^2.0.0"
}, },
"devDependencies": { "devDependencies": {