Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FTP Node] Recursively Make Directories on SFTP Rename #3001

Merged
merged 5 commits into from
Apr 1, 2022
Merged

[FTP Node] Recursively Make Directories on SFTP Rename #3001

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d0eaa17
Recursively Make Directories on SFTP Rename
rhyswilliamsza Mar 17, 2022
163936f
Linting
rhyswilliamsza Mar 17, 2022
6404e31
:zap: Improvement
RicardoE105 Mar 30, 2022
ac1c5f8
:zap: Rename "Move" to "Create Directories"
RicardoE105 Mar 31, 2022
e2c9d29
Change "Create Directories" description
RicardoE105 Mar 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 48 additions & 18 deletions packages/nodes-base/nodes/Ftp/Ftp.node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export class Ftp implements INodeType {
outputs: ['main'],
credentials: [
{
// nodelinter-ignore-next-line
name: 'ftp',
required: true,
displayOptions: {
Expand All @@ -62,6 +63,7 @@ export class Ftp implements INodeType {
},
},
{
// nodelinter-ignore-next-line
name: 'sftp',
required: true,
displayOptions: {
Expand Down Expand Up @@ -124,6 +126,7 @@ export class Ftp implements INodeType {
],
default: 'download',
description: 'Operation to perform.',
noDataExpression: true,
},

// ----------------------------------
Expand Down Expand Up @@ -253,6 +256,29 @@ export class Ftp implements INodeType {
description: 'The new path',
required: true,
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
operation: [
'rename',
],
},
},
options: [
{
displayName: 'Create Directories',
name: 'createDirectories',
type: 'boolean',
default: false,
description: `Recursively create destination directory when renaming an existing file or folder`,
},
],
},

// ----------------------------------
// upload
Expand Down Expand Up @@ -381,8 +407,8 @@ export class Ftp implements INodeType {
throw new NodeOperationError(this.getNode(), 'Failed to get credentials!');
}

let ftp : ftpClient;
let sftp : sftpClient;
let ftp: ftpClient;
let sftp: sftpClient;

if (protocol === 'sftp') {
sftp = new sftpClient();
Expand Down Expand Up @@ -452,9 +478,13 @@ export class Ftp implements INodeType {

if (operation === 'rename') {
const oldPath = this.getNodeParameter('oldPath', i) as string;

const { createDirectories = false } = this.getNodeParameter('options', i) as { createDirectories: boolean };
const newPath = this.getNodeParameter('newPath', i) as string;

if (createDirectories) {
await recursivelyCreateSftpDirs(sftp!, newPath);
}

responseData = await sftp!.rename(oldPath, newPath);

returnItems.push({ json: { success: true } });
Expand All @@ -475,16 +505,7 @@ export class Ftp implements INodeType {

if (operation === 'upload') {
const remotePath = this.getNodeParameter('path', i) as string;

// Check if dir path exists
const dirPath = dirname(remotePath);
const dirExists = await sftp!.exists(dirPath);

// If dir does not exist, create all recursively in path
if (!dirExists) {
// Create directory
await sftp!.mkdir(dirPath, true);
}
await recursivelyCreateSftpDirs(sftp!, remotePath);

if (this.getNodeParameter('binaryData', i) === true) {
// Is binary file to upload
Expand Down Expand Up @@ -635,7 +656,7 @@ export class Ftp implements INodeType {

} catch (error) {
if (this.continueOnFail()) {
return this.prepareOutputData([{json:{ error: error.message }}]);
return this.prepareOutputData([{ json: { error: error.message } }]);
}

throw error;
Expand All @@ -661,17 +682,17 @@ function normalizeSFtpItem(input: sftpClient.FileInfo, path: string, recursive =
}

async function callRecursiveList(path: string, client: sftpClient | ftpClient, normalizeFunction: (input: ftpClient.ListingElement & sftpClient.FileInfo, path: string, recursive?: boolean) => void) {
const pathArray : string[] = [path];
const pathArray: string[] = [path];
let currentPath = path;
const directoryItems : sftpClient.FileInfo[] = [];
const directoryItems: sftpClient.FileInfo[] = [];
let index = 0;

do {
// tslint:disable-next-line: array-type
const returnData : sftpClient.FileInfo[] | (string | ftpClient.ListingElement)[] = await client.list(pathArray[index]);
const returnData: sftpClient.FileInfo[] | (string | ftpClient.ListingElement)[] = await client.list(pathArray[index]);

// @ts-ignore
returnData.map((item : sftpClient.FileInfo) => {
returnData.map((item: sftpClient.FileInfo) => {
if ((pathArray[index] as string).endsWith('/')) {
currentPath = `${pathArray[index]}${item.name}`;
} else {
Expand All @@ -693,3 +714,12 @@ async function callRecursiveList(path: string, client: sftpClient | ftpClient, n

return directoryItems;
}

async function recursivelyCreateSftpDirs(sftp: sftpClient, path: string) {
const dirPath = dirname(path);
const dirExists = await sftp!.exists(dirPath);

if (!dirExists) {
await sftp!.mkdir(dirPath, true);
}
}