1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
node-red/editor/js/ui/tab-info.js

450 lines
19 KiB
JavaScript
Raw Normal View History

/**
* 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.
**/
2014-08-08 01:01:35 +02:00
RED.sidebar.info = (function() {
2015-01-29 21:47:30 +01:00
marked.setOptions({
renderer: new marked.Renderer(),
gfm: true,
tables: true,
breaks: false,
pedantic: false,
sanitize: true,
smartLists: true,
smartypants: false
});
2017-04-07 00:17:06 +02:00
var content;
var sections;
var nodeSection;
var infoSection;
var tipBox;
2017-04-05 17:19:23 +02:00
var expandedSections = {
2017-04-07 00:17:06 +02:00
"property": false
2017-04-05 17:19:23 +02:00
};
2015-07-01 00:42:03 +02:00
function init() {
2017-04-07 00:17:06 +02:00
content = document.createElement("div");
content.className = "sidebar-node-info"
RED.actions.add("core:show-info-tab",show);
2017-04-07 12:21:30 +02:00
var stackContainer = $("<div>",{class:"sidebar-node-info-stack"}).appendTo(content);
2017-04-07 00:17:06 +02:00
sections = RED.stack.create({
2017-04-07 12:21:30 +02:00
container: stackContainer
2017-04-07 00:17:06 +02:00
}).hide();
nodeSection = sections.add({
2017-09-20 11:30:07 +02:00
title: RED._("sidebar.info.info"),
collapsible: true
2017-04-07 00:17:06 +02:00
});
2017-09-20 11:30:07 +02:00
nodeSection.expand();
2017-04-07 00:17:06 +02:00
infoSection = sections.add({
title: RED._("sidebar.info.nodeHelp"),
2017-09-20 11:30:07 +02:00
collapsible: true
2017-04-07 00:17:06 +02:00
});
2017-09-20 11:30:07 +02:00
infoSection.expand();
2017-04-07 00:17:06 +02:00
infoSection.content.css("padding","6px");
infoSection.container.css("border-bottom","none");
2017-04-07 12:21:30 +02:00
var tipContainer = $('<div class="node-info-tips"></div>').appendTo(content);
2017-04-07 12:21:30 +02:00
tipBox = $('<div class="node-info-tip"></div>').appendTo(tipContainer);
var tipButtons = $('<div class="node-info-tips-buttons"></div>').appendTo(tipContainer);
var tipRefresh = $('<a href="#" class="workspace-footer-button"><i class="fa fa-refresh"></a>').appendTo(tipButtons);
tipRefresh.click(function(e) {
e.preventDefault();
tips.next();
})
var tipClose = $('<a href="#" class="workspace-footer-button"><i class="fa fa-times"></a>').appendTo(tipButtons);
tipClose.click(function(e) {
e.preventDefault();
RED.actions.invoke("core:toggle-show-tips");
RED.notify(RED._("sidebar.info.showTips"));
});
2017-04-07 12:21:30 +02:00
RED.sidebar.addTab({
id: "info",
label: RED._("sidebar.info.label"),
name: RED._("sidebar.info.name"),
2018-05-23 11:25:10 +02:00
iconClass: "fa fa-info",
content: content,
2018-05-23 11:25:10 +02:00
pinned: true,
enableOnEdit: true
});
2017-05-03 22:27:08 +02:00
if (tips.enabled()) {
tips.start();
} else {
tips.stop();
}
2017-04-07 12:21:30 +02:00
}
2014-11-11 11:15:02 +01:00
function show() {
RED.sidebar.show("info");
}
2017-09-20 11:30:07 +02:00
// TODO: DRY - projects.js
function addTargetToExternalLinks(el) {
$(el).find("a").each(function(el) {
var href = $(this).attr('href');
if (/^https?:/.test(href)) {
$(this).attr('target','_blank');
}
});
return el;
}
function refresh(node) {
if (node === undefined) {
refreshSelection();
return;
}
2017-04-07 00:17:06 +02:00
sections.show();
$(nodeSection.content).empty();
$(infoSection.content).empty();
var propRow;
2015-07-01 00:42:03 +02:00
2017-09-20 11:30:07 +02:00
var table = $('<table class="node-info"></table>').appendTo(nodeSection.content);
var tableBody = $('<tbody>').appendTo(table);
var subflowNode;
var subflowUserCount;
2017-09-20 11:30:07 +02:00
var activeProject = RED.projects.getActiveProject();
if (activeProject) {
propRow = $('<tr class="node-info-node-row"><td>Project</td><td></td></tr>').appendTo(tableBody);
$(propRow.children()[1]).text(activeProject.name||"");
2017-09-20 11:30:07 +02:00
$('<tr class="node-info-property-expand blank"><td colspan="2"></td></tr>').appendTo(tableBody);
$('<button class="editor-button editor-button-small" style="position:absolute;right:2px;"><i class="fa fa-ellipsis-h"></i></button>')
.appendTo(propRow.children()[1])
.click(function(evt) {
evt.preventDefault();
RED.projects.editProject();
});
2017-09-20 11:30:07 +02:00
}
infoSection.container.show();
if (node === null) {
2017-09-20 11:30:07 +02:00
return;
} else if (Array.isArray(node)) {
infoSection.container.hide();
propRow = $('<tr class="node-info-node-row"><td>'+RED._("sidebar.info.selection")+"</td><td></td></tr>").appendTo(tableBody);
$(propRow.children()[1]).text(RED._("sidebar.info.nodes",{count:node.length}))
2017-09-20 11:30:07 +02:00
} else {
var m = /^subflow(:(.+))?$/.exec(node.type);
2017-04-07 00:17:06 +02:00
if (m) {
if (m[2]) {
subflowNode = RED.nodes.subflow(m[2]);
} else {
subflowNode = node;
}
2017-04-07 00:17:06 +02:00
2017-09-20 11:30:07 +02:00
subflowUserCount = 0;
2017-04-07 00:17:06 +02:00
var subflowType = "subflow:"+subflowNode.id;
RED.nodes.eachNode(function(n) {
if (n.type === subflowType) {
2017-09-20 11:30:07 +02:00
subflowUserCount++;
2017-04-07 00:17:06 +02:00
}
});
}
2017-09-20 11:30:07 +02:00
if (node.type === "tab" || node.type === "subflow") {
propRow = $('<tr class="node-info-node-row"><td>'+RED._("sidebar.info."+(node.type==='tab'?'flow':'subflow'))+'</td><td></td></tr>').appendTo(tableBody);
RED.utils.createObjectElement(node.id).appendTo(propRow.children()[1]);
propRow = $('<tr class="node-info-node-row"><td>'+RED._("sidebar.info.tabName")+"</td><td></td></tr>").appendTo(tableBody);
$(propRow.children()[1]).text(node.label||node.name||"");
2017-09-20 11:30:07 +02:00
if (node.type === "tab") {
propRow = $('<tr class="node-info-node-row"><td>'+RED._("sidebar.info.status")+'</td><td></td></tr>').appendTo(tableBody);
$(propRow.children()[1]).text((!!!node.disabled)?RED._("sidebar.info.enabled"):RED._("sidebar.info.disabled"))
} else if (node.type === "subflow") {
propRow = $('<tr class="node-info-node-row"><td>'+RED._("subflow.category")+'</td><td></td></tr>').appendTo(tableBody);
var category = node.category||"subflows";
$(propRow.children()[1]).text(RED._("palette.label."+category,{defaultValue:category}))
2017-09-20 11:30:07 +02:00
}
} else {
propRow = $('<tr class="node-info-node-row"><td>'+RED._("sidebar.info.node")+"</td><td></td></tr>").appendTo(tableBody);
RED.utils.createObjectElement(node.id).appendTo(propRow.children()[1]);
2017-04-05 17:19:23 +02:00
if (node.type !== "subflow" && node.type !== "unknown" && node.name) {
propRow = $('<tr class="node-info-node-row"><td>'+RED._("common.label.name")+'</td><td></td></tr>').appendTo(tableBody);
$('<span class="bidiAware" dir="'+RED.text.bidi.resolveBaseTextDir(node.name)+'"></span>').text(node.name).appendTo(propRow.children()[1]);
2017-09-20 11:30:07 +02:00
}
if (!m) {
propRow = $('<tr class="node-info-node-row"><td>'+RED._("sidebar.info.type")+"</td><td></td></tr>").appendTo(tableBody);
$(propRow.children()[1]).text((node.type === "unknown")?node._orig.type:node.type);
if (node.type === "unknown") {
$('<span style="float: right; font-size: 0.8em"><i class="fa fa-warning"></i></span>').prependTo($(propRow.children()[1]))
}
2017-09-20 11:30:07 +02:00
}
if (!m && node.type != "subflow" && node.type != "comment") {
var defaults;
if (node.type === 'unknown') {
defaults = {};
Object.keys(node._orig).forEach(function(k) {
if (k !== 'type') {
defaults[k] = {};
}
})
} else if (node._def) {
defaults = node._def.defaults;
}
if (defaults) {
2017-09-20 11:30:07 +02:00
var count = 0;
for (var n in defaults) {
if (n != "name" && defaults.hasOwnProperty(n)) {
var val = node[n];
var type = typeof val;
count++;
propRow = $('<tr class="node-info-property-row'+(expandedSections.property?"":" hide")+'"><td>'+n+"</td><td></td></tr>").appendTo(tableBody);
if (defaults[n].type) {
var configNode = RED.nodes.node(val);
if (!configNode) {
RED.utils.createObjectElement(undefined).appendTo(propRow.children()[1]);
} else {
var configLabel = RED.utils.getNodeLabel(configNode,val);
var container = propRow.children()[1];
var div = $('<span>',{class:""}).appendTo(container);
var nodeDiv = $('<div>',{class:"palette_node palette_node_small"}).appendTo(div);
var colour = configNode._def.color;
var icon_url = RED.utils.getNodeIcon(configNode._def);
nodeDiv.css({'backgroundColor':colour, "cursor":"pointer"});
var iconContainer = $('<div/>',{class:"palette_icon_container"}).appendTo(nodeDiv);
$('<div/>',{class:"palette_icon",style:"background-image: url("+icon_url+")"}).appendTo(iconContainer);
var nodeContainer = $('<span></span>').css({"verticalAlign":"top","marginLeft":"6px"}).text(configLabel).appendTo(container);
2017-09-20 11:30:07 +02:00
nodeDiv.on('dblclick',function() {
RED.editor.editConfig("", configNode.type, configNode.id);
})
}
} else {
RED.utils.createObjectElement(val).appendTo(propRow.children()[1]);
}
}
}
if (count > 0) {
$('<tr class="node-info-property-expand blank"><td colspan="2"><a href="#" class=" node-info-property-header'+(expandedSections.property?" expanded":"")+'"><span class="node-info-property-show-more">'+RED._("sidebar.info.showMore")+'</span><span class="node-info-property-show-less">'+RED._("sidebar.info.showLess")+'</span> <i class="fa fa-caret-down"></i></a></td></tr>').appendTo(tableBody);
}
}
}
if (node.type !== 'tab') {
if (m) {
$('<tr class="blank"><th colspan="2">'+RED._("sidebar.info.subflow")+'</th></tr>').appendTo(tableBody);
$('<tr class="node-info-subflow-row"><td>'+RED._("common.label.name")+'</td><td><span class="bidiAware" dir=\"'+RED.text.bidi.resolveBaseTextDir(subflowNode.name)+'">'+subflowNode.name+'</span></td></tr>').appendTo(tableBody);
}
}
}
if (m) {
propRow = $('<tr class="node-info-node-row"><td>'+RED._("subflow.category")+'</td><td></td></tr>').appendTo(tableBody);
var category = subflowNode.category||"subflows";
$(propRow.children()[1]).text(RED._("palette.label."+category,{defaultValue:category}))
2017-09-20 11:30:07 +02:00
$('<tr class="node-info-subflow-row"><td>'+RED._("sidebar.info.instances")+"</td><td>"+subflowUserCount+'</td></tr>').appendTo(tableBody);
}
2017-09-20 11:30:07 +02:00
var infoText = "";
if (!subflowNode && node.type !== "comment" && node.type !== "tab") {
infoSection.title.text(RED._("sidebar.info.nodeHelp"));
2017-09-20 11:30:07 +02:00
var helpText = $("script[data-help-name='"+node.type+"']").html()||('<span class="node-info-none">'+RED._("sidebar.info.none")+'</span>');
infoText = helpText;
} else if (node.type === "tab") {
infoSection.title.text(RED._("sidebar.info.flowDesc"));
2017-09-20 11:30:07 +02:00
infoText = marked(node.info||"")||('<span class="node-info-none">'+RED._("sidebar.info.none")+'</span>');
}
2015-07-01 00:42:03 +02:00
2017-09-20 11:30:07 +02:00
if (subflowNode) {
infoText = infoText + (marked(subflowNode.info||"")||('<span class="node-info-none">'+RED._("sidebar.info.none")+'</span>'));
infoSection.title.text(RED._("sidebar.info.subflowDesc"));
2017-09-20 11:30:07 +02:00
} else if (node._def && node._def.info) {
infoSection.title.text(RED._("sidebar.info.nodeHelp"));
2017-09-20 11:30:07 +02:00
var info = node._def.info;
var textInfo = (typeof info === "function" ? info.call(node) : info);
// TODO: help
infoText = infoText + marked(textInfo);
}
if (infoText) {
setInfoText(infoText);
}
$(".node-info-property-header").click(function(e) {
e.preventDefault();
expandedSections["property"] = !expandedSections["property"];
$(this).toggleClass("expanded",expandedSections["property"]);
$(".node-info-property-row").toggle(expandedSections["property"]);
});
}
}
function setInfoText(infoText) {
var info = addTargetToExternalLinks($('<div class="node-help"><span class="bidiAware" dir=\"'+RED.text.bidi.resolveBaseTextDir(infoText)+'">'+infoText+'</span></div>')).appendTo(infoSection.content);
info.find(".bidiAware").contents().filter(function() { return this.nodeType === 3 && this.textContent.trim() !== "" }).wrap( "<span></span>" );
var foldingHeader = "H3";
info.find(foldingHeader).wrapInner('<a class="node-info-header expanded" href="#"></a>')
.find("a").prepend('<i class="fa fa-angle-right">').click(function(e) {
e.preventDefault();
var isExpanded = $(this).hasClass('expanded');
var el = $(this).parent().next();
while(el.length === 1 && el[0].nodeName !== foldingHeader) {
el.toggle(!isExpanded);
el = el.next();
}
$(this).toggleClass('expanded',!isExpanded);
})
}
2017-01-06 00:33:19 +01:00
var tips = (function() {
var enabled = true;
var startDelay = 1000;
2017-01-09 23:09:06 +01:00
var cycleDelay = 15000;
2017-01-06 00:33:19 +01:00
var startTimeout;
var refreshTimeout;
var tipCount = -1;
RED.actions.add("core:toggle-show-tips",function(state) {
if (state === undefined) {
RED.userSettings.toggle("view-show-tips");
} else {
enabled = state;
if (enabled) {
2017-04-07 12:21:30 +02:00
startTips();
} else {
stopTips();
}
}
});
2017-01-06 00:33:19 +01:00
function setTip() {
var r = Math.floor(Math.random() * tipCount);
var tip = RED._("infotips:info.tip"+r);
var m;
while ((m=/({{(.*?)}})/.exec(tip))) {
var shortcut = RED.keyboard.getShortcut(m[2]);
if (shortcut) {
tip = tip.replace(m[1],RED.keyboard.formatKey(shortcut.key));
} else {
return;
}
}
while ((m=/(\[(.*?)\])/.exec(tip))) {
tip = tip.replace(m[1],RED.keyboard.formatKey(m[2]));
}
2017-04-07 00:17:06 +02:00
tipBox.html(tip).fadeIn(200);
2017-01-06 00:33:19 +01:00
if (startTimeout) {
startTimeout = null;
refreshTimeout = setInterval(cycleTips,cycleDelay);
}
}
function cycleTips() {
2017-04-07 00:17:06 +02:00
tipBox.fadeOut(300,function() {
2017-01-06 00:33:19 +01:00
setTip();
})
}
function startTips() {
2017-04-07 12:21:30 +02:00
$(".sidebar-node-info").addClass('show-tips');
if (enabled) {
2017-01-06 00:33:19 +01:00
if (!startTimeout && !refreshTimeout) {
if (tipCount === -1) {
do {
tipCount++;
} while(RED._("infotips:info.tip"+tipCount)!=="infotips:info.tip"+tipCount);
}
startTimeout = setTimeout(setTip,startDelay);
}
}
}
function stopTips() {
2017-04-07 12:21:30 +02:00
$(".sidebar-node-info").removeClass('show-tips');
clearInterval(refreshTimeout);
clearTimeout(startTimeout);
refreshTimeout = null;
startTimeout = null;
}
function nextTip() {
clearInterval(refreshTimeout);
startTimeout = true;
setTip();
}
return {
start: startTips,
stop: stopTips,
2017-05-03 22:27:08 +02:00
next: nextTip,
enabled: function() { return enabled; }
}
2017-01-06 00:33:19 +01:00
})();
function clear() {
2017-09-20 11:30:07 +02:00
// sections.hide();
refresh(null);
2015-03-12 01:08:47 +01:00
}
2015-07-01 00:42:03 +02:00
2017-09-20 11:30:07 +02:00
function set(html,title) {
2017-04-07 12:21:30 +02:00
// tips.stop();
2017-09-20 11:30:07 +02:00
// sections.show();
// nodeSection.container.hide();
infoSection.title.text(title||"");
refresh(null);
$(infoSection.content).empty();
setInfoText(html);
$(".sidebar-node-info-stack").scrollTop(0);
2015-07-18 16:33:31 +02:00
}
2015-10-23 23:14:21 +02:00
function refreshSelection(selection) {
if (selection === undefined) {
selection = RED.view.selection();
}
2015-03-12 01:08:47 +01:00
if (selection.nodes) {
if (selection.nodes.length == 1) {
var node = selection.nodes[0];
if (node.type === "subflow" && node.direction) {
refresh(RED.nodes.subflow(node.z));
} else {
refresh(node);
}
2017-09-20 11:30:07 +02:00
} else {
refresh(selection.nodes);
2015-03-12 01:08:47 +01:00
}
} else {
2017-04-07 00:17:06 +02:00
var activeWS = RED.workspaces.active();
var flow = RED.nodes.workspace(activeWS) || RED.nodes.subflow(activeWS);
if (flow) {
refresh(flow);
2015-03-12 01:08:47 +01:00
} else {
var workspace = RED.nodes.workspace(RED.workspaces.active());
if (workspace && workspace.info) {
refresh(workspace);
} else {
refresh(null)
2017-09-20 11:30:07 +02:00
// clear();
}
2015-03-12 01:08:47 +01:00
}
}
}
RED.events.on("view:selection-changed",refreshSelection);
return {
init: init,
2014-11-11 11:15:02 +01:00
show: show,
refresh: refresh,
2015-07-18 16:33:31 +02:00
clear: clear,
set: set
}
2014-08-08 01:01:35 +02:00
})();