growl.js
7.75 KB
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
'use strict';
// Growl - Copyright TJ Holowaychuk <tj@vision-media.ca> (MIT Licensed)
/**
* Module dependencies.
*/
const spawn = require('child_process').spawn;
const fs = require('fs');
const path = require('path');
const os = require('os');
const exists = fs.existsSync || path.existsSync;
let cmd;
function which(name) {
const paths = process.env.PATH.split(':');
let loc;
for (let i = 0, len = paths.length; i < len; i += 1) {
loc = path.join(paths[i], name);
if (exists(loc)) return loc;
}
return false;
}
function setupCmd() {
switch (os.type()) {
case 'Darwin':
if (which('terminal-notifier')) {
cmd = {
type: 'Darwin-NotificationCenter',
pkg: 'terminal-notifier',
msg: '-message',
title: '-title',
subtitle: '-subtitle',
icon: '-appIcon',
sound: '-sound',
url: '-open',
priority: {
cmd: '-execute',
range: [],
},
};
} else {
cmd = {
type: 'Darwin-Growl',
pkg: 'growlnotify',
msg: '-m',
sticky: '--sticky',
url: '--url',
priority: {
cmd: '--priority',
range: [
-2,
-1,
0,
1,
2,
'Very Low',
'Moderate',
'Normal',
'High',
'Emergency',
],
},
};
}
break;
case 'Linux':
if (which('growl')) {
cmd = {
type: 'Linux-Growl',
pkg: 'growl',
msg: '-m',
title: '-title',
subtitle: '-subtitle',
host: {
cmd: '-H',
hostname: '192.168.33.1',
},
};
} else {
cmd = {
type: 'Linux',
pkg: 'notify-send',
msg: '',
sticky: '-t 0',
icon: '-i',
priority: {
cmd: '-u',
range: [
'low',
'normal',
'critical',
],
},
};
}
break;
case 'Windows_NT':
cmd = {
type: 'Windows',
pkg: 'growlnotify',
msg: '',
sticky: '/s:true',
title: '/t:',
icon: '/i:',
url: '/cu:',
priority: {
cmd: '/p:',
range: [
-2,
-1,
0,
1,
2,
],
},
};
break;
default:
break;
}
}
/**
* Send growl notification _msg_ with _options_.
*
* Options:
*
* - title Notification title
* - sticky Make the notification stick (defaults to false)
* - priority Specify an int or named key (default is 0)
* - name Application name (defaults to growlnotify)
* - sound Sound efect ( in OSx defined in preferences -> sound -> effects)
* works only in OSX > 10.8x
* - image
* - path to an icon sets --iconpath
* - path to an image sets --image
* - capitalized word sets --appIcon
* - filename uses extname as --icon
* - otherwise treated as --icon
*
* Examples:
*
* growl('New email')
* growl('5 new emails', { title: 'Thunderbird' })
* growl('5 new emails', { title: 'Thunderbird', sound: 'Purr' })
* growl('Email sent', function(){
* // ... notification sent
* })
*
* @param {string} msg
* @param {object} opts
* @param {function} callback
* @api public
*/
function growl(msg, opts, callback) {
let image;
const options = opts || {};
const fn = callback || function noop() {};
setupCmd();
if (options.exec) {
cmd = {
type: 'Custom',
pkg: options.exec,
range: [],
};
}
// noop
if (!cmd) {
fn(new Error('growl not supported on this platform'));
return;
}
const args = [cmd.pkg];
// image
if (image || options.image) {
image = options.image;
switch (cmd.type) {
case 'Darwin-Growl': {
let flag;
const ext = path.extname(image).substr(1);
flag = ext === 'icns' && 'iconpath';
flag = flag || (/^[A-Z]/.test(image) && 'appIcon');
flag = flag || (/^png|gif|jpe?g$/.test(ext) && 'image');
flag = flag || (ext && (image = ext) && 'icon');
flag = flag || 'icon';
args.push(`--${flag}`, image);
break;
}
case 'Darwin-NotificationCenter':
args.push(cmd.icon, image);
break;
case 'Linux':
args.push(cmd.icon, image);
// libnotify defaults to sticky, set a hint for transient notifications
if (!options.sticky) args.push('--hint=int:transient:1');
break;
case 'Windows':
args.push(cmd.icon + image);
break;
default:
break;
}
}
// sticky
if (options.sticky) args.push(cmd.sticky);
// priority
if (options.priority) {
const priority = `${options.priority}`;
const checkindexOf = cmd.priority.range.indexOf(priority);
if (checkindexOf > -1) {
args.push(cmd.priority, options.priority);
}
}
// sound
if (options.sound && cmd.type === 'Darwin-NotificationCenter') {
args.push(cmd.sound, options.sound);
}
// name
if (options.name && cmd.type === 'Darwin-Growl') {
args.push('--name', options.name);
}
switch (cmd.type) {
case 'Darwin-Growl':
args.push(cmd.msg);
args.push(msg.replace(/\\n/g, '\n'));
if (options.title) args.push(options.title);
if (options.url) {
args.push(cmd.url);
args.push(options.url);
}
break;
case 'Darwin-NotificationCenter': {
args.push(cmd.msg);
const stringifiedMsg = msg;
const escapedMsg = stringifiedMsg.replace(/\\n/g, '\n');
args.push(escapedMsg);
if (options.title) {
args.push(cmd.title);
args.push(options.title);
}
if (options.subtitle) {
args.push(cmd.subtitle);
args.push(options.subtitle);
}
if (options.url) {
args.push(cmd.url);
args.push(options.url);
}
break;
}
case 'Linux-Growl':
args.push(cmd.msg);
args.push(msg.replace(/\\n/g, '\n'));
if (options.title) args.push(options.title);
if (cmd.host) {
args.push(cmd.host.cmd, cmd.host.hostname);
}
break;
case 'Linux':
if (options.title) {
args.push(options.title);
args.push(cmd.msg);
args.push(msg.replace(/\\n/g, '\n'));
} else {
args.push(msg.replace(/\\n/g, '\n'));
}
break;
case 'Windows':
args.push(msg.replace(/\\n/g, '\n'));
if (options.title) args.push(cmd.title + options.title);
if (options.url) args.push(cmd.url + options.url);
break;
case 'Custom': {
const customCmd = args[0];
const message = options.title
? `${options.title}: ${msg}`
: msg;
let command = customCmd.replace(/(^|[^%])%s/g, `$1${message}`);
const splitCmd = command.split(' ');
if (splitCmd.length > 1) {
command = splitCmd.shift();
Array.prototype.push.apply(args, splitCmd);
}
if (customCmd.indexOf('%s') < 0) {
args.push(message);
}
args[0] = command;
break;
}
default:
break;
}
const cmdToExec = args.shift();
const child = spawn(cmdToExec, args);
let stdout = '';
let stderr = '';
let error;
child.on('error', (err) => {
console.error('An error occured.', err);
error = err;
});
child.stdout.on('data', (data) => {
stdout += data;
});
child.stderr.on('data', (data) => {
stderr += data;
});
child.on('close', (code) => {
error = error || code === 0 ? null : code;
if (typeof fn === 'function') {
fn(error, stdout, stderr);
}
});
}
/**
* Expose `growl`.
*/
module.exports = growl;