n8n/packages/nodes-base/nodes/Dropbox/Dropbox.node.ts

680 lines
15 KiB
TypeScript
Raw Normal View History

2019-06-23 03:35:23 -07:00
import {
BINARY_ENCODING,
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeTypeDescription,
INodeExecutionData,
INodeType,
} from 'n8n-workflow';
import { OptionsWithUri } from 'request';
export class Dropbox implements INodeType {
description: INodeTypeDescription = {
displayName: 'Dropbox',
name: 'dropbox',
icon: 'file:dropbox.png',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
2019-06-23 03:35:23 -07:00
description: 'Access data on Dropbox',
defaults: {
name: 'Dropbox',
color: '#22BB44',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'dropboxApi',
required: true,
}
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'File',
value: 'file',
},
{
name: 'Folder',
value: 'folder',
},
],
default: 'file',
description: 'The resource to operate on.',
},
// ----------------------------------
// operations
// ----------------------------------
2019-06-23 03:35:23 -07:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'file',
],
},
},
2019-06-23 03:35:23 -07:00
options: [
{
name: 'Copy',
value: 'copy',
description: 'Copy a file',
2019-06-23 03:35:23 -07:00
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a file',
2019-06-23 03:35:23 -07:00
},
{
name: 'Download',
value: 'download',
description: 'Download a file',
2019-06-23 03:35:23 -07:00
},
{
name: 'Move',
value: 'move',
description: 'Move a file',
2019-06-23 03:35:23 -07:00
},
{
name: 'Upload',
value: 'upload',
description: 'Upload a file',
2019-06-23 03:35:23 -07:00
},
],
default: 'upload',
2019-06-23 03:35:23 -07:00
description: 'The operation to perform.',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'folder',
],
},
},
options: [
{
name: 'Copy',
value: 'copy',
description: 'Copy a folder',
},
{
name: 'Create',
value: 'create',
description: 'Create a folder',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a folder',
},
{
name: 'List',
value: 'list',
description: 'Return the files and folders in a given folder',
},
{
name: 'Move',
value: 'move',
description: 'Move a folder',
},
],
default: 'create',
description: 'The operation to perform.',
},
2019-06-23 03:35:23 -07:00
// ----------------------------------
// file
// ----------------------------------
// ----------------------------------
// file/folder:copy
2019-06-23 03:35:23 -07:00
// ----------------------------------
{
displayName: 'From Path',
name: 'path',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'copy'
],
resource: [
'file',
'folder',
],
2019-06-23 03:35:23 -07:00
},
},
placeholder: '/invoices/original.txt',
description: 'The path of file or folder to copy.',
},
{
displayName: 'To Path',
name: 'toPath',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'copy'
],
resource: [
'file',
'folder',
],
2019-06-23 03:35:23 -07:00
},
},
placeholder: '/invoices/copy.txt',
description: 'The destination path of file or folder.',
},
// ----------------------------------
// file/folder:delete
2019-06-23 03:35:23 -07:00
// ----------------------------------
{
displayName: 'Delete Path',
name: 'path',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'delete'
],
resource: [
'file',
'folder',
],
2019-06-23 03:35:23 -07:00
},
},
placeholder: '/invoices/2019/invoice_1.pdf',
description: 'The path to delete. Can be a single file or a whole folder.',
},
2019-06-23 03:35:23 -07:00
// ----------------------------------
// file/folder:move
2019-06-23 03:35:23 -07:00
// ----------------------------------
{
displayName: 'From Path',
2019-06-23 03:35:23 -07:00
name: 'path',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'move'
2019-06-23 03:35:23 -07:00
],
resource: [
'file',
'folder',
2019-06-23 03:35:23 -07:00
],
},
},
placeholder: '/invoices/old_name.txt',
description: 'The path of file or folder to move.',
2019-06-23 03:35:23 -07:00
},
{
displayName: 'To Path',
name: 'toPath',
2019-06-23 03:35:23 -07:00
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'move'
],
resource: [
'file',
'folder',
2019-06-23 03:35:23 -07:00
],
},
},
placeholder: '/invoices/new_name.txt',
description: 'The new path of file or folder.',
2019-06-23 03:35:23 -07:00
},
// ----------------------------------
// file:download
2019-06-23 03:35:23 -07:00
// ----------------------------------
{
displayName: 'File Path',
2019-06-23 03:35:23 -07:00
name: 'path',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'download'
],
resource: [
'file',
2019-06-23 03:35:23 -07:00
],
},
},
placeholder: '/invoices/2019/invoice_1.pdf',
description: 'The file path of the file to download. Has to contain the full path.',
2019-06-23 03:35:23 -07:00
},
{
displayName: 'Binary Property',
name: 'binaryPropertyName',
2019-06-23 03:35:23 -07:00
type: 'string',
required: true,
default: 'data',
2019-06-23 03:35:23 -07:00
displayOptions: {
show: {
operation: [
'download'
],
resource: [
'file',
2019-06-23 03:35:23 -07:00
],
},
},
description: 'Name of the binary property to which to<br />write the data of the read file.',
2019-06-23 03:35:23 -07:00
},
// ----------------------------------
// file:upload
2019-06-23 03:35:23 -07:00
// ----------------------------------
{
displayName: 'File Path',
name: 'path',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'upload'
],
resource: [
'file',
2019-06-23 03:35:23 -07:00
],
},
},
placeholder: '/invoices/2019/invoice_1.pdf',
description: 'The file path of the file to upload. Has to contain the full path. The parent folder has to exist. Existing files get overwritten.',
},
{
displayName: 'Binary Data',
name: 'binaryData',
type: 'boolean',
default: false,
displayOptions: {
show: {
operation: [
'upload'
],
resource: [
'file',
2019-06-23 03:35:23 -07:00
],
},
},
description: 'If the data to upload should be taken from binary field.',
},
{
displayName: 'File Content',
name: 'fileContent',
type: 'string',
default: '',
displayOptions: {
show: {
operation: [
'upload'
],
resource: [
'file',
2019-06-23 03:35:23 -07:00
],
binaryData: [
false
],
},
},
placeholder: '',
description: 'The text content of the file to upload.',
},
{
displayName: 'Binary Property',
name: 'binaryPropertyName',
type: 'string',
default: 'data',
required: true,
displayOptions: {
show: {
operation: [
'upload'
],
resource: [
'file',
2019-06-23 03:35:23 -07:00
],
binaryData: [
true
],
},
},
placeholder: '',
description: 'Name of the binary property which contains<br />the data for the file to be uploaded.',
},
// ----------------------------------
// folder
// ----------------------------------
// ----------------------------------
// folder:create
// ----------------------------------
{
displayName: 'Folder',
name: 'path',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create'
],
resource: [
'folder',
],
},
},
placeholder: '/invoices/2019',
description: 'The folder to create. The parent folder has to exist.',
},
// ----------------------------------
// folder:list
// ----------------------------------
{
displayName: 'Folder Path',
name: 'path',
type: 'string',
default: '',
displayOptions: {
show: {
operation: [
'list'
],
resource: [
'folder',
],
},
},
placeholder: '/invoices/2019/',
description: 'The path of which to list the content.',
},
2019-06-23 03:35:23 -07:00
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const credentials = this.getCredentials('dropboxApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const resource = this.getNodeParameter('resource', 0) as string;
2019-06-23 03:35:23 -07:00
const operation = this.getNodeParameter('operation', 0) as string;
let endpoint = '';
let requestMethod = '';
let body: IDataObject | Buffer;
let isJson = false;
let headers: IDataObject;
for (let i = 0; i < items.length; i++) {
body = {};
headers = {
'Authorization': `Bearer ${credentials.accessToken}`,
};
if (resource === 'file') {
if (operation === 'download') {
// ----------------------------------
// download
// ----------------------------------
2019-06-23 03:35:23 -07:00
requestMethod = 'POST';
headers['Dropbox-API-Arg'] = JSON.stringify({
path: this.getNodeParameter('path', i) as string,
});
2019-06-23 03:35:23 -07:00
endpoint = 'https://content.dropboxapi.com/2/files/download';
2019-06-23 03:35:23 -07:00
} else if (operation === 'upload') {
// ----------------------------------
// upload
// ----------------------------------
2019-06-23 03:35:23 -07:00
requestMethod = 'POST';
headers['Content-Type'] = 'application/octet-stream';
headers['Dropbox-API-Arg'] = JSON.stringify({
mode: 'overwrite',
path: this.getNodeParameter('path', i) as string,
});
2019-06-23 03:35:23 -07:00
endpoint = 'https://content.dropboxapi.com/2/files/upload';
2019-06-23 03:35:23 -07:00
if (this.getNodeParameter('binaryData', i) === true) {
// Is binary file to upload
const item = items[i];
2019-06-23 03:35:23 -07:00
if (item.binary === undefined) {
throw new Error('No binary data exists on item!');
}
2019-06-23 03:35:23 -07:00
const propertyNameUpload = this.getNodeParameter('binaryPropertyName', i) as string;
2019-06-23 03:35:23 -07:00
if (item.binary[propertyNameUpload] === undefined) {
throw new Error(`No binary data property "${propertyNameUpload}" does not exists on item!`);
}
2019-06-23 03:35:23 -07:00
body = Buffer.from(item.binary[propertyNameUpload].data, BINARY_ENCODING);
} else {
// Is text file
body = Buffer.from(this.getNodeParameter('fileContent', i) as string, 'utf8');
}
}
2019-06-23 03:35:23 -07:00
} else if (resource === 'folder') {
if (operation === 'create') {
// ----------------------------------
// create
// ----------------------------------
2019-06-23 03:35:23 -07:00
requestMethod = 'POST';
isJson = true;
body = {
path: this.getNodeParameter('path', i) as string,
};
2019-06-23 03:35:23 -07:00
endpoint = 'https://api.dropboxapi.com/2/files/create_folder_v2';
2019-06-23 03:35:23 -07:00
} else if (operation === 'list') {
// ----------------------------------
// list
// ----------------------------------
2019-06-23 03:35:23 -07:00
requestMethod = 'POST';
isJson = true;
body = {
path: this.getNodeParameter('path', i) as string,
limit: 2000,
};
2019-06-23 03:35:23 -07:00
// TODO: If more files than the max-amount exist it has to be possible to
// also request them.
2019-06-23 03:35:23 -07:00
endpoint = 'https://api.dropboxapi.com/2/files/list_folder';
2019-06-23 03:35:23 -07:00
}
}
if (['file', 'folder'].includes(resource)) {
if (operation === 'copy') {
// ----------------------------------
// copy
// ----------------------------------
requestMethod = 'POST';
isJson = true;
body = {
from_path: this.getNodeParameter('path', i) as string,
to_path: this.getNodeParameter('toPath', i) as string,
};
endpoint = 'https://api.dropboxapi.com/2/files/copy_v2';
} else if (operation === 'delete') {
// ----------------------------------
// delete
// ----------------------------------
requestMethod = 'POST';
isJson = true;
body = {
path: this.getNodeParameter('path', i) as string,
};
endpoint = 'https://api.dropboxapi.com/2/files/delete_v2';
} else if (operation === 'move') {
// ----------------------------------
// move
// ----------------------------------
requestMethod = 'POST';
isJson = true;
body = {
from_path: this.getNodeParameter('path', i) as string,
to_path: this.getNodeParameter('toPath', i) as string,
};
endpoint = 'https://api.dropboxapi.com/2/files/move_v2';
2019-06-23 03:35:23 -07:00
}
} else {
throw new Error(`The resource "${resource}" is not known!`);
2019-06-23 03:35:23 -07:00
}
const options: OptionsWithUri = {
headers,
method: requestMethod,
qs: {},
uri: endpoint,
json: isJson,
};
if (Object.keys(body).length) {
options.body = body;
}
if (resource === 'file' && operation === 'download') {
2019-06-23 03:35:23 -07:00
// Return the data as a buffer
options.encoding = null;
}
let responseData;
try {
responseData = await this.helpers.request(options);
} catch (error) {
if (error.statusCode === 401) {
// Return a clear error
throw new Error('The Dropbox credentials are not valid!');
}
if (error.error && error.error.error_summary) {
// Try to return the error prettier
throw new Error(`Dropbox error response [${error.statusCode}]: ${error.error.error_summary}`);
}
// If that data does not exist for some reason return the actual error
throw error;
}
2019-06-23 03:35:23 -07:00
if (resource === 'file' && operation === 'download') {
2019-06-23 03:35:23 -07:00
// TODO: Has to check if it already exists and only add if not
if (items[i].binary === undefined) {
items[i].binary = {};
}
const dataPropertyNameDownload = this.getNodeParameter('binaryPropertyName', i) as string;
const filePathDownload = this.getNodeParameter('path', i) as string;
items[i].binary![dataPropertyNameDownload] = await this.helpers.prepareBinaryData(responseData, filePathDownload);
} else if (resource === 'folder' && operation === 'list') {
2019-06-23 03:35:23 -07:00
const propNames: { [key: string]: string } = {
'id': 'id',
'name': 'name',
'client_modified': 'lastModifiedClient',
'server_modified': 'lastModifiedServer',
'rev': 'rev',
'size': 'contentSize',
'.tag': 'type',
'content_hash': 'contentHash',
};
for (const item of responseData.entries) {
const newItem: IDataObject = {};
// Get the props and save them under a proper name
for (const propName of Object.keys(propNames)) {
if (item[propName] !== undefined) {
newItem[propNames[propName]] = item[propName];
}
}
returnData.push(newItem as IDataObject);
}
} else if (resource === 'file' && operation === 'upload') {
returnData.push(JSON.parse(responseData) as IDataObject);
2019-06-23 03:35:23 -07:00
} else {
returnData.push(responseData as IDataObject);
}
}
if (resource === 'file' && operation === 'download') {
2019-06-23 03:35:23 -07:00
// For file downloads the files get attached to the existing items
return this.prepareOutputData(items);
} else {
// For all other ones does the output items get replaced
2019-06-23 03:35:23 -07:00
return [this.helpers.returnJsonArray(returnData)];
}
}
}