mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
615 lines
21 KiB
JavaScript
615 lines
21 KiB
JavaScript
/**
|
|
* Copyright JS Foundation and other contributors, http://js.foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
**/
|
|
|
|
|
|
var fs = require('fs-extra');
|
|
var when = require('when');
|
|
var fspath = require("path");
|
|
|
|
var gitTools = require("./git");
|
|
var util = require("../util");
|
|
var defaultFileSet = require("./defaultFileSet");
|
|
|
|
var settings;
|
|
var runtime;
|
|
var log;
|
|
|
|
var projectsDir;
|
|
|
|
var authCache = {};
|
|
|
|
function getAuth(project,remote) {
|
|
if (authCache.hasOwnProperty(project) && authCache[project].hasOwnProperty(remote)) {
|
|
return authCache[project][remote];
|
|
}
|
|
return null;
|
|
}
|
|
function Project(name) {
|
|
this.name = name;
|
|
this.path = fspath.join(projectsDir,name);
|
|
this.paths = {};
|
|
this.auth = {origin:{}};
|
|
|
|
this.missingFiles = [];
|
|
|
|
this.credentialSecret = null;
|
|
}
|
|
Project.prototype.load = function () {
|
|
var project = this;
|
|
var globalProjectSettings = settings.get("projects");
|
|
// console.log(globalProjectSettings)
|
|
var projectSettings = {};
|
|
if (globalProjectSettings) {
|
|
projectSettings = globalProjectSettings.projects[this.name]||{};
|
|
}
|
|
|
|
this.credentialSecret = projectSettings.credentialSecret;
|
|
|
|
this.remote = projectSettings.remote;
|
|
|
|
// this.paths.flowFile = fspath.join(this.path,"flow.json");
|
|
// this.paths.credentialsFile = fspath.join(this.path,"flow_cred.json");
|
|
|
|
var promises = [];
|
|
return checkProjectFiles(project).then(function(missingFiles) {
|
|
if (missingFiles.length > 0) {
|
|
project.missingFiles = missingFiles;
|
|
}
|
|
if (missingFiles.indexOf('package.json') === -1) {
|
|
project.paths['package.json'] = fspath.join(project.path,"package.json");
|
|
promises.push(fs.readFile(project.paths['package.json'],"utf8").then(function(content) {
|
|
try {
|
|
project.package = util.parseJSON(content);
|
|
if (project.package.hasOwnProperty('node-red')) {
|
|
if (project.package['node-red'].hasOwnProperty('settings')) {
|
|
project.paths.flowFile = project.package['node-red'].settings.flowFile;
|
|
project.paths.credentialsFile = project.package['node-red'].settings.credentialsFile;
|
|
}
|
|
} else {
|
|
// TODO: package.json doesn't have a node-red section
|
|
// is that a bad thing?
|
|
}
|
|
} catch(err) {
|
|
// package.json isn't valid JSON... is a merge underway?
|
|
project.package = {};
|
|
}
|
|
}));
|
|
} else {
|
|
project.package = {};
|
|
}
|
|
if (missingFiles.indexOf('README.md') === -1) {
|
|
project.paths['README.md'] = fspath.join(project.path,"README.md");
|
|
promises.push(fs.readFile(project.paths['README.md'],"utf8").then(function(content) {
|
|
project.description = content;
|
|
}));
|
|
} else {
|
|
project.description = "";
|
|
}
|
|
// if (missingFiles.indexOf('flow.json') !== -1) {
|
|
// console.log("MISSING FLOW FILE");
|
|
// } else {
|
|
// project.paths.flowFile = fspath.join(project.path,"flow.json");
|
|
// }
|
|
// if (missingFiles.indexOf('flow_cred.json') !== -1) {
|
|
// console.log("MISSING CREDS FILE");
|
|
// } else {
|
|
// project.paths.credentialsFile = fspath.join(project.path,"flow_cred.json");
|
|
// }
|
|
|
|
promises.push(gitTools.getRemotes(project.path).then(function(remotes) {
|
|
project.remotes = remotes;
|
|
}));
|
|
promises.push(gitTools.getBranchInfo(project.path).then(function(branches) {
|
|
project.branches = branches;
|
|
}));
|
|
|
|
return when.settle(promises).then(function() {
|
|
return project;
|
|
})
|
|
});
|
|
};
|
|
|
|
Project.prototype.update = function (data) {
|
|
|
|
var promises = [];
|
|
var project = this;
|
|
var saveSettings = false;
|
|
var saveREADME = false;
|
|
var savePackage = false;
|
|
var flowFilesChanged = false;
|
|
var credentialSecretChanged = false;
|
|
|
|
var globalProjectSettings = settings.get("projects");
|
|
if (!globalProjectSettings.projects.hasOwnProperty(this.name)) {
|
|
globalProjectSettings.projects[this.name] = {};
|
|
saveSettings = true;
|
|
}
|
|
|
|
|
|
if (data.credentialSecret && data.credentialSecret !== this.credentialSecret) {
|
|
var existingSecret = data.currentCredentialSecret;
|
|
var isReset = data.resetCredentialSecret;
|
|
var secret = data.credentialSecret;
|
|
|
|
// console.log("updating credentialSecret");
|
|
// console.log("request:");
|
|
// console.log(JSON.stringify(data,"",4));
|
|
// console.log(" this.credentialSecret",this.credentialSecret);
|
|
// console.log(" this.info", this.info);
|
|
|
|
if (!isReset && // not a reset
|
|
this.credentialSecret && // key already set
|
|
!this.credentialSecretInvalid && // key not invalid
|
|
this.credentialSecret !== existingSecret) { // key doesn't match provided existing key
|
|
var e = new Error("Cannot change credentialSecret without current key");
|
|
e.code = "missing_current_credential_key";
|
|
return when.reject(e);
|
|
}
|
|
this.credentialSecret = secret;
|
|
|
|
globalProjectSettings.projects[this.name].credentialSecret = project.credentialSecret;
|
|
delete this.credentialSecretInvalid;
|
|
saveSettings = true;
|
|
credentialSecretChanged = true;
|
|
}
|
|
|
|
if (data.hasOwnProperty('description')) {
|
|
saveREADME = true;
|
|
this.description = data.description;
|
|
}
|
|
if (data.hasOwnProperty('dependencies')) {
|
|
savePackage = true;
|
|
this.package.dependencies = data.dependencies;
|
|
}
|
|
if (data.hasOwnProperty('summary')) {
|
|
savePackage = true;
|
|
this.package.description = data.summary;
|
|
}
|
|
if (data.hasOwnProperty('remote')) {
|
|
authCache[project.name] = authCache[project.name]||{};
|
|
for (var remote in data.remote) {
|
|
if (data.remote.hasOwnProperty(remote)) {
|
|
authCache[project.name][remote] = data.remote[remote];
|
|
}
|
|
}
|
|
}
|
|
if (data.hasOwnProperty('files')) {
|
|
this.package['node-red'] = this.package['node-red'] || { settings: {}};
|
|
if (data.files.hasOwnProperty('flow') && this.package['node-red'].settings.flowFile !== data.files.flow) {
|
|
this.paths.flowFile = data.files.flow;
|
|
this.package['node-red'].settings.flowFile = data.files.flow;
|
|
savePackage = true;
|
|
flowFilesChanged = true;
|
|
}
|
|
if (data.files.hasOwnProperty('credentials') && this.package['node-red'].settings.credentialsFile !== data.files.credentials) {
|
|
this.paths.credentialsFile = data.files.credentials;
|
|
this.package['node-red'].settings.credentialsFile = data.files.credentials;
|
|
// Don't know if the credSecret is invalid or not so clear the flag
|
|
delete this.credentialSecretInvalid;
|
|
|
|
savePackage = true;
|
|
flowFilesChanged = true;
|
|
}
|
|
}
|
|
if (saveSettings) {
|
|
promises.push(settings.set("projects",globalProjectSettings));
|
|
}
|
|
if (saveREADME) {
|
|
promises.push(util.writeFile(this.paths['README.md'], this.description));
|
|
}
|
|
if (savePackage) {
|
|
promises.push(util.writeFile(this.paths['package.json'], JSON.stringify(this.package,"",4)));
|
|
}
|
|
return when.settle(promises).then(function(res) {
|
|
return {
|
|
flowFilesChanged: flowFilesChanged,
|
|
credentialSecretChanged: credentialSecretChanged
|
|
}
|
|
})
|
|
};
|
|
|
|
Project.prototype.getFiles = function () {
|
|
return gitTools.getFiles(this.path);
|
|
};
|
|
Project.prototype.stageFile = function(file) {
|
|
return gitTools.stageFile(this.path,file);
|
|
};
|
|
Project.prototype.unstageFile = function(file) {
|
|
return gitTools.unstageFile(this.path,file);
|
|
}
|
|
Project.prototype.commit = function(options) {
|
|
return gitTools.commit(this.path,options.message);
|
|
}
|
|
Project.prototype.getFileDiff = function(file,type) {
|
|
return gitTools.getFileDiff(this.path,file,type);
|
|
}
|
|
Project.prototype.getCommits = function(options) {
|
|
return gitTools.getCommits(this.path,options);
|
|
}
|
|
Project.prototype.getCommit = function(sha) {
|
|
return gitTools.getCommit(this.path,sha);
|
|
}
|
|
Project.prototype.getFile = function (filePath,treeish) {
|
|
if (treeish !== "_") {
|
|
return gitTools.getFile(this.path, filePath, treeish);
|
|
} else {
|
|
return fs.readFile(fspath.join(this.path,filePath),"utf8");
|
|
}
|
|
};
|
|
|
|
Project.prototype.status = function() {
|
|
var self = this;
|
|
|
|
var fetchPromise;
|
|
if (this.remote) {
|
|
fetchPromise = gitTools.fetch(this.path,getAuth(this.name,'origin'));
|
|
} else {
|
|
fetchPromise = when.resolve();
|
|
}
|
|
|
|
var completeStatus = function(fetchError) {
|
|
var promises = [
|
|
gitTools.getStatus(self.path),
|
|
fs.exists(fspath.join(self.path,".git","MERGE_HEAD"))
|
|
];
|
|
return when.all(promises).then(function(results) {
|
|
var result = results[0];
|
|
if (results[1]) {
|
|
result.merging = true;
|
|
}
|
|
self.branches.local = result.branches.local;
|
|
self.branches.remote = result.branches.remote;
|
|
if (fetchError) {
|
|
result.branches.remoteError = {
|
|
code: fetchError.code
|
|
}
|
|
}
|
|
return result;
|
|
});
|
|
}
|
|
return fetchPromise.then(completeStatus).catch(function(e) {
|
|
if (e.code === 'git_auth_failed') {
|
|
console.log("Fetch auth failed");
|
|
} else {
|
|
console.log("Fetch failed");
|
|
console.log(e);
|
|
}
|
|
return completeStatus(e);
|
|
})
|
|
};
|
|
|
|
Project.prototype.push = function (remoteBranchName,setRemote) {
|
|
return gitTools.push(this.path, remoteBranchName, setRemote, getAuth(this.name,'origin'));
|
|
};
|
|
|
|
Project.prototype.pull = function (remoteBranchName,setRemote) {
|
|
if (setRemote) {
|
|
return gitTools.setUpstream(this.path, remoteBranchName).then(function() {
|
|
return gitTools.pull(this.path, null, getAuth(this.name,'origin'));
|
|
})
|
|
} else {
|
|
return gitTools.pull(this.path, remoteBranchName, getAuth(this.name,'origin'));
|
|
}
|
|
};
|
|
|
|
Project.prototype.resolveMerge = function (file,resolutions) {
|
|
var filePath = fspath.join(this.path,file);
|
|
var self = this;
|
|
return fs.readFile(filePath,"utf8").then(function(content) {
|
|
var lines = content.split("\n");
|
|
var result = [];
|
|
var ignoreBlock = false;
|
|
var currentBlock;
|
|
for (var i=1;i<=lines.length;i++) {
|
|
if (resolutions.hasOwnProperty(i)) {
|
|
currentBlock = resolutions[i];
|
|
if (currentBlock.selection === "A") {
|
|
ignoreBlock = false;
|
|
} else {
|
|
ignoreBlock = true;
|
|
}
|
|
continue;
|
|
}
|
|
if (currentBlock) {
|
|
if (currentBlock.separator === i) {
|
|
if (currentBlock.selection === "A") {
|
|
ignoreBlock = true;
|
|
} else {
|
|
ignoreBlock = false;
|
|
}
|
|
continue;
|
|
} else if (currentBlock.changeEnd === i) {
|
|
currentBlock = null;
|
|
continue;
|
|
} else if (ignoreBlock) {
|
|
continue;
|
|
}
|
|
}
|
|
result.push(lines[i-1]);
|
|
}
|
|
var finalResult = result.join("\n");
|
|
return util.writeFile(filePath,finalResult).then(function() {
|
|
return self.stageFile(file);
|
|
})
|
|
});
|
|
};
|
|
Project.prototype.abortMerge = function () {
|
|
return gitTools.abortMerge(this.path);
|
|
};
|
|
|
|
Project.prototype.getBranches = function (remote) {
|
|
var self = this;
|
|
var fetchPromise;
|
|
if (remote) {
|
|
fetchPromise = gitTools.fetch(this.path,getAuth(this.name,'origin'))
|
|
} else {
|
|
fetchPromise = when.resolve();
|
|
}
|
|
return fetchPromise.then(function() {
|
|
return gitTools.getBranches(self.path,remote);
|
|
});
|
|
};
|
|
Project.prototype.setBranch = function (branchName, isCreate) {
|
|
var self = this;
|
|
return gitTools.checkoutBranch(this.path, branchName, isCreate).then(function() {
|
|
return self.load();
|
|
})
|
|
};
|
|
Project.prototype.getBranchStatus = function (branchName) {
|
|
return gitTools.getBranchStatus(this.path,branchName);
|
|
};
|
|
Project.prototype.getFlowFile = function() {
|
|
console.log("Project.getFlowFile = ",this.paths.flowFile);
|
|
if (this.paths.flowFile) {
|
|
return fspath.join(this.path,this.paths.flowFile);
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
Project.prototype.getFlowFileBackup = function() {
|
|
return getBackupFilename(this.getFlowFile());
|
|
}
|
|
Project.prototype.getCredentialsFile = function() {
|
|
console.log("Project.getCredentialsFile = ",this.paths.credentialsFile);
|
|
if (this.paths.credentialsFile) {
|
|
return fspath.join(this.path,this.paths.credentialsFile);
|
|
} else {
|
|
return this.paths.credentialsFile;
|
|
}
|
|
}
|
|
Project.prototype.getCredentialsFileBackup = function() {
|
|
return getBackupFilename(this.getCredentialsFile());
|
|
}
|
|
|
|
Project.prototype.toJSON = function () {
|
|
|
|
return {
|
|
name: this.name,
|
|
summary: this.package.description,
|
|
description: this.description,
|
|
dependencies: this.package.dependencies||{},
|
|
settings: {
|
|
credentialsEncrypted: (typeof this.credentialSecret === "string"),
|
|
credentialSecretInvalid: this.credentialSecretInvalid
|
|
},
|
|
files: {
|
|
flow: this.paths.flowFile,
|
|
credentials: this.paths.credentialsFile
|
|
},
|
|
remotes: this.remotes,
|
|
branches: this.branches
|
|
}
|
|
};
|
|
|
|
|
|
function getCredentialsFilename(filename) {
|
|
// TODO: DRY - ./index.js
|
|
var ffDir = fspath.dirname(filename);
|
|
var ffExt = fspath.extname(filename);
|
|
var ffBase = fspath.basename(filename,ffExt);
|
|
return fspath.join(ffDir,ffBase+"_cred"+ffExt);
|
|
}
|
|
function getBackupFilename(filename) {
|
|
// TODO: DRY - ./index.js
|
|
var ffName = fspath.basename(filename);
|
|
var ffDir = fspath.dirname(filename);
|
|
return fspath.join(ffDir,"."+ffName+".backup");
|
|
}
|
|
|
|
function checkProjectExists(project) {
|
|
var projectPath = fspath.join(projectsDir,project);
|
|
return fs.pathExists(projectPath).then(function(exists) {
|
|
if (!exists) {
|
|
var e = new Error("NLS: project not found");
|
|
e.code = "project_not_found";
|
|
throw e;
|
|
}
|
|
});
|
|
}
|
|
|
|
function createProjectDirectory(project) {
|
|
var projectPath = fspath.join(projectsDir,project);
|
|
return fs.ensureDir(projectPath);
|
|
}
|
|
|
|
function createDefaultProject(project) {
|
|
var projectPath = fspath.join(projectsDir,project.name);
|
|
// Create a basic skeleton of a project
|
|
return gitTools.initRepo(projectPath).then(function() {
|
|
var promises = [];
|
|
for (var file in defaultFileSet) {
|
|
if (defaultFileSet.hasOwnProperty(file)) {
|
|
promises.push(util.writeFile(fspath.join(projectPath,file),defaultFileSet[file](project)));
|
|
}
|
|
}
|
|
if (project.files) {
|
|
if (project.files.flow && !/\.\./.test(project.files.flow)) {
|
|
var flowFilePath = fspath.join(projectPath,project.files.flow);
|
|
promises.push(util.writeFile(flowFilePath,"[]"));
|
|
var credsFilePath = getCredentialsFilename(flowFilePath);
|
|
promises.push(util.writeFile(credsFilePath,"{}"));
|
|
}
|
|
}
|
|
return when.all(promises).then(function() {
|
|
var files = Object.keys(defaultFileSet);
|
|
if (project.files) {
|
|
if (project.files.flow && !/\.\./.test(project.files.flow)) {
|
|
files.push(project.files.flow);
|
|
files.push(getCredentialsFilename(flowFilePath))
|
|
}
|
|
}
|
|
return gitTools.stageFile(projectPath,files);
|
|
}).then(function() {
|
|
return gitTools.commit(projectPath,"Create project");
|
|
})
|
|
});
|
|
}
|
|
|
|
function checkProjectFiles(project) {
|
|
var projectPath = project.path;
|
|
var promises = [];
|
|
var paths = [];
|
|
for (var file in defaultFileSet) {
|
|
if (defaultFileSet.hasOwnProperty(file)) {
|
|
paths.push(file);
|
|
promises.push(fs.stat(fspath.join(projectPath,file)));
|
|
}
|
|
}
|
|
return when.settle(promises).then(function(results) {
|
|
var missing = [];
|
|
results.forEach(function(result,i) {
|
|
if (result.state === 'rejected') {
|
|
missing.push(paths[i]);
|
|
}
|
|
});
|
|
return missing;
|
|
}).then(function(missing) {
|
|
// if (createMissing) {
|
|
// var promises = [];
|
|
// missing.forEach(function(file) {
|
|
// promises.push(util.writeFile(fspath.join(projectPath,file),defaultFileSet[file](project)));
|
|
// });
|
|
// return promises;
|
|
// } else {
|
|
return missing;
|
|
// }
|
|
});
|
|
}
|
|
|
|
function createProject(metadata) {
|
|
var project = metadata.name;
|
|
return when.promise(function(resolve,reject) {
|
|
var projectPath = fspath.join(projectsDir,project);
|
|
fs.stat(projectPath, function(err,stat) {
|
|
if (!err) {
|
|
var e = new Error("NLS: Project already exists");
|
|
e.code = "project_exists";
|
|
return reject(e);
|
|
}
|
|
createProjectDirectory(project).then(function() {
|
|
var projects = settings.get('projects');
|
|
projects.projects[project] = {};
|
|
if (metadata.hasOwnProperty('credentialSecret')) {
|
|
projects.projects[project].credentialSecret = metadata.credentialSecret;
|
|
}
|
|
if (metadata.remote) {
|
|
projects.projects[project].remote = metadata.remote;
|
|
}
|
|
return settings.set('projects',projects);
|
|
}).then(function() {
|
|
if (metadata.remote) {
|
|
var auth;
|
|
if (metadata.remote.hasOwnProperty("username") && metadata.remote.hasOwnProperty("password")) {
|
|
authCache[project] = {
|
|
origin: { // TODO: hardcoded remote name
|
|
username: metadata.remote.username,
|
|
password: metadata.remote.password
|
|
}
|
|
}
|
|
auth = authCache[project].origin;
|
|
}
|
|
|
|
return gitTools.clone(metadata.remote,auth,projectPath).then(function(result) {
|
|
// Check this is a valid project
|
|
// If it is empty
|
|
// - if 'populate' flag is set, call populateProject
|
|
// - otherwise reject with suitable error to allow UI to confirm population
|
|
// If it is missing package.json/flow.json/flow_cred.json
|
|
// - reject as invalid project
|
|
|
|
// checkProjectFiles(project).then(function(results) {
|
|
// console.log("checkProjectFiles");
|
|
// console.log(results);
|
|
// });
|
|
|
|
resolve(getProject(project));
|
|
}).catch(function(error) {
|
|
fs.remove(projectPath,function() {
|
|
reject(error);
|
|
});
|
|
})
|
|
} else {
|
|
createDefaultProject(metadata).then(function() { resolve(getProject(project))}).catch(reject);
|
|
}
|
|
}).catch(reject);
|
|
})
|
|
})
|
|
}
|
|
|
|
var currentProject;
|
|
|
|
function getProject(name) {
|
|
return checkProjectExists(name).then(function() {
|
|
if (currentProject && currentProject.name === name) {
|
|
return currentProject;
|
|
}
|
|
currentProject = new Project(name);
|
|
return currentProject.load();
|
|
});
|
|
}
|
|
|
|
function listProjects() {
|
|
return fs.readdir(projectsDir).then(function(fns) {
|
|
var dirs = [];
|
|
fns.sort().filter(function(fn) {
|
|
var fullPath = fspath.join(projectsDir,fn);
|
|
if (fn[0] != ".") {
|
|
var stats = fs.lstatSync(fullPath);
|
|
if (stats.isDirectory()) {
|
|
dirs.push(fn);
|
|
}
|
|
}
|
|
});
|
|
return dirs;
|
|
});
|
|
}
|
|
|
|
function init(_settings, _runtime) {
|
|
settings = _settings;
|
|
runtime = _runtime;
|
|
log = runtime.log;
|
|
projectsDir = fspath.join(settings.userDir,"projects");
|
|
}
|
|
|
|
module.exports = {
|
|
init: init,
|
|
get: getProject,
|
|
create: createProject,
|
|
list: listProjects
|
|
|
|
}
|