-
Notifications
You must be signed in to change notification settings - Fork 2
/
later.js
161 lines (145 loc) · 6.85 KB
/
later.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*
The MIT License (MIT)
Copyright (c) 2015 Lighthouse Automation
https://github.com/Lighthouse-Automation/node-red-contrib-later
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
//For jslint linter
/*jslint node: true */
"use strict";
module.exports = function (RED) {
var later = require('later'),
fs = require('fs'),
path = require('path'),
debug = require('debug')('later');
function laterNode(config) {
RED.nodes.createNode(this, config);
this.name = config.name;
this.schedule = config.schedule;
var node = this,
//Global object to keep track of running timers
runningSchedules = {},
//Function that does the work of running a schedule
runSched = function (msg, sched) {
//Only do anything if the schedule has a next event
if (later.schedule(sched).next(1)) {
runningSchedules[msg.later.id] = later.setTimeout(function () {
//Run this again to schedule the next event
/*IMPORTANT that this is done before the message is sent
to avoid a race condition in the case this message triggers
a downstream node to cancel the flow*/
runSched(msg, sched);
//Send out the message
msg.later.count += 1;
node.send(msg);
}, sched);
debug('Started timer for schedule : ' + msg.later.id);
} else {
//This schedule has finished, remove any references to previous timers
debug('Schedule has ended : ' + msg.later.id);
delete runningSchedules[msg.later.id];
}
},
parsePayloadForLater = function (payload) {
var res = "";
if (typeof payload === 'object' && typeof payload.later === 'string') {
res = payload.later;
}
return res;
};
node.on('input', function (msg) {
//Add a 'later' object to the msg for downstream nodes to use, or not
if (!msg.later) {
msg.later = {};
//Generate a kind of unique number for the 'later' id.
msg.later.id = (3 + Math.random() * 6763504675).toString(16);
}
//Initialise the count, if necessary
if (!msg.later.count) {
msg.later.count = 0;
}
//If this message has no (or null) payload, stop any running timers
//remove this schedule from the list, and do no further processing
if (!msg.payload && runningSchedules[msg.later.id]) {
debug("Removing scheduled timer : " + msg.later.id);
runningSchedules[msg.later.id].clear();
delete runningSchedules[msg.later.id];
return;
}
//Set a local var for this schedeule string
var schedStr = (node.schedule.length > 0) ? node.schedule : parsePayloadForLater(msg.payload),
thisSched = later.parse.text(schedStr, true);
//If we have a string, try and parse it, otherwise just send msg on
if (schedStr && schedStr.length > 0) {
//If there are errors parsing this, send the msg, and warn.
if (thisSched.error > -1) {
node.warn("Later could not parse : <" + schedStr + "> the error is at : " + thisSched.error);
node.send(msg);
} else {
//Later could parse it, so set it to go once. Send the msg once the timer fires.
debug("Got a valid schedule, starting it running : " + schedStr);
runSched(msg, thisSched);
}
} else {
debug("No valid schedule, sending msg through.");
node.send(msg);
}
});
//Listener for the close event, clear timers, tidy up
node.on('close', function (done) {
var id;
debug("Close called, emptying running timers.");
for (id in runningSchedules) {
if (runningSchedules.hasOwnProperty(id)) {
debug("Removing timer : " + id);
runningSchedules[id].clear();
}
}
runningSchedules = {};
done();
});
debug("New node created : %s", (node.name.length > 0) ? node.name : 'Later');
}
//Set later to use the local time rather than UTC
later.date.localTime();
//Register the node creation fn with RED
RED.nodes.registerType("later", laterNode);
//Add a route to the 'later.js' instance installed with this node, so the html file can use it
RED.httpAdmin.get('/node-red-contrib-later/:file', function (req, res) {
var laterDir = false;
try {
laterDir = path.dirname(require.resolve('later'));
}
catch(e) {
debug("'Later' node path not resolved - " + e.name + ':' + e.message);
}
fs.readFile(path.join(laterDir, req.params.file), function (err, data) {
if (err) {
/* For some reason we can't load the parser for the editor....
Send some dummy script for the html, basically DON'T CRASH THE EDITOR */
debug('Could not serve later :' + err.message);
res.set('Content-Type', 'text/javascript').send(
'later = function() {return { get_error: "' + err.message + '"};}();');
} else {
debug('Later loaded from :' + laterDir);
res.set('Content-Type', 'text/javascript').send(data);
}
});
});
//Debug output now we are loaded
debug("Later node loaded....");
};