func-exec.html

<!--
Copyright 2013, 2015 IBM Corp.

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.
-->

<script type="text/x-red" data-template-name="func-exec">
	<div class="form-row">
		<label for="node-input-name"><i class="fa fa-tag"></i> <span>Name</span></label>
		<input type="text" id="node-input-name" placeholder="Enter a name">
	</div>
	<div class="form-row" style="margin-bottom: 0px;">
		<label for="node-input-func"><i class="fa fa-wrench"></i> <span>Function</span></label>
		<input type="hidden" id="node-input-func" autofocus="autofocus">
		<input type="hidden" id="node-input-noerr">
	</div>
	<div class="form-row node-text-editor-row">
		<div style="height: 250px;" class="node-text-editor" id="node-input-func-editor" ></div>
	</div>
	<div class="form-row">
		<label for="node-input-outputs"><i class="fa fa-random"></i> <span>Outputs</span></label>
		<input id="node-input-outputs" style="width: 60px; height: 1.7em;" value="1">
	</div>
	<div class="form-tips"><span>See the Info tab for help writing functions.</span></div>
</script>

<script type="text/x-red" data-help-name="func-exec">
	<p>A function block where you can write your own code to execute func-exec nodejs library.</p>
	<p><em>Example of using func-exec inside this function block:</em></p>
	<p><code>
		var exec = child_process.exec('cat *.js bad_file | wc -l', (error, stdout, stderr) => { <br/>
		  if (error) { <br/>
		    console.error(`exec error: ${error}`); <br/>
		    return; <br/>
		  } <br/>
		  console.log(`stdout: ${stdout}`); <br/>
		  console.log(`stderr: ${stderr}`); <br/>
		  callback(msg); <br/>
		}); <br/>
	</code></p>
	<p>Supported libraries: child_process, request, console, util.</p>
</script>

<script type="text/javascript">
	RED.nodes.registerType('func-exec', {
		color : "#FFCC66",
		category : 'function',
		defaults : {
			name : {
				value : ""
			},
			func : {
				value : "\nreturn msg;"
			},
			outputs : {
				value : 1
			},
			noerr : {
				value : 0,
				required : true,
				validate : function(v) {
					return ((!v) || (v === 0)) ? true : false;
				}
			}
		},
		inputs : 1,
		outputs : 1,
		align: "left",
		icon : "function.png",
		label : function() {
			return this.name || "func-exec";
		},
		oneditprepare : function() {
			var that = this;
			$("#node-input-outputs").spinner({
				min : 1
			});

			function functionDialogResize() {
				var rows = $("#dialog-form>div:not(.node-text-editor-row)");
				var height = $("#dialog-form").height();
				for (var i = 0; i < rows.size(); i++) {
					height -= $(rows[i]).outerHeight(true);
				}
				var editorRow = $("#dialog-form>div.node-text-editor-row");
				height -= (parseInt(editorRow.css("marginTop")) + parseInt(editorRow.css("marginBottom")));
				$(".node-text-editor").css("height", height + "px");
				that.editor.resize();
			}


			$("#dialog").on("dialogresize", functionDialogResize);
			$("#dialog").one("dialogopen", function(ev) {
				var size = $("#dialog").dialog('option', 'sizeCache-function');
				if (size) {
					$("#dialog").dialog('option', 'width', size.width);
					$("#dialog").dialog('option', 'height', size.height);
					functionDialogResize();
				}
			});
			$("#dialog").one("dialogclose", function(ev, ui) {
				var height = $("#dialog").dialog('option', 'height');
				$("#dialog").off("dialogresize", functionDialogResize);
			});

			this.editor = RED.editor.createEditor({
				id : 'node-input-func-editor',
				mode : 'ace/mode/javascript',
				value : $("#node-input-func").val()
			});

			RED.library.create({
				url : "functions", // where to get the data from
				type : "function", // the type of object the library is for
				editor : this.editor, // the field name the main text body goes to
				mode : "ace/mode/javascript",
				fields : ['name', 'outputs']
			});
			this.editor.focus();
		},
		oneditsave : function() {
			var annot = this.editor.getSession().getAnnotations();
			this.noerr = 0;
			$("#node-input-noerr").val(0);
			for (var k = 0; k < annot.length; k++) {
				if (annot[k].type === "error") {
					$("#node-input-noerr").val(annot.length);
					this.noerr = annot.length;
				}
			}
			$("#node-input-func").val(this.editor.getValue());
			delete this.editor;
		}
	}); 
</script>