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.

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

fix(SSH Node): Replace ~ with /home/username #6269

Merged
merged 5 commits into from
May 18, 2023
Merged
Changes from 4 commits
Commits
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
51 changes: 45 additions & 6 deletions packages/nodes-base/nodes/Ssh/Ssh.node.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type {
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { BINARY_ENCODING } from 'n8n-workflow';
import { BINARY_ENCODING, NodeOperationError } from 'n8n-workflow';

import { rm, writeFile } from 'fs/promises';

Expand All @@ -15,6 +15,29 @@ import type { Config } from 'node-ssh';
import { NodeSSH } from 'node-ssh';
import type { Readable } from 'stream';

async function resolveHomeDir(
this: IExecuteFunctions,
path: string,
ssh: NodeSSH,
itemIndex: number,
) {
if (path.startsWith('~/')) {
return path.replace('~', (await ssh.execCommand('echo $HOME')).stdout);
}

if (path.startsWith('~')) {
throw new NodeOperationError(
this.getNode(),
'Invalid path. Replace "~" with home directory or "~/"',
{
itemIndex,
},
);
}

return path;
}

export class Ssh implements INodeType {
description: INodeTypeDescription = {
displayName: 'SSH',
Expand Down Expand Up @@ -226,7 +249,7 @@ export class Ssh implements INodeType {
displayOptions: {
show: {
resource: ['file'],
operation: ['upload'],
operation: ['upload', 'download'],
},
},
default: {},
Expand Down Expand Up @@ -292,7 +315,12 @@ export class Ssh implements INodeType {
if (resource === 'command') {
if (operation === 'execute') {
const command = this.getNodeParameter('command', i) as string;
const cwd = this.getNodeParameter('cwd', i) as string;
const cwd = await resolveHomeDir.call(
this,
this.getNodeParameter('cwd', i) as string,
ssh,
i,
);
returnItems.push({
json: (await ssh.execCommand(command, { cwd })) as unknown as IDataObject,
pairedItem: {
Expand All @@ -305,7 +333,12 @@ export class Ssh implements INodeType {
if (resource === 'file') {
if (operation === 'download') {
const dataPropertyNameDownload = this.getNodeParameter('binaryPropertyName', i);
const parameterPath = this.getNodeParameter('path', i) as string;
const parameterPath = await resolveHomeDir.call(
this,
this.getNodeParameter('path', i) as string,
ssh,
i,
);

const { path } = await tmpFile({ prefix: 'n8n-ssh-' });
temporaryFiles.push(path);
Expand All @@ -329,14 +362,20 @@ export class Ssh implements INodeType {

items[i] = newItem;

const fileName = this.getNodeParameter('options.fileName', i, '') as string;
items[i].binary![dataPropertyNameDownload] = await this.nodeHelpers.copyBinaryFile(
path,
parameterPath,
fileName || parameterPath,
);
}

if (operation === 'upload') {
const parameterPath = this.getNodeParameter('path', i) as string;
const parameterPath = await resolveHomeDir.call(
this,
this.getNodeParameter('path', i) as string,
ssh,
i,
);
const fileName = this.getNodeParameter('options.fileName', i, '') as string;

const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i);
Expand Down