pax_global_header00006660000000000000000000000064120700746560014521gustar00rootroot0000000000000052 comment=a10f5f97534791330a86b9af185912dfc5cd918f node-growl-1.7.0/000077500000000000000000000000001207007465600136035ustar00rootroot00000000000000node-growl-1.7.0/History.md000066400000000000000000000021511207007465600155650ustar00rootroot00000000000000 1.7.0 / 2012-12-30 ================== * support transient notifications in Gnome 1.6.1 / 2012-09-25 ================== * restore compatibility with node < 0.8 [fgnass] 1.6.0 / 2012-09-06 ================== * add notification center support [drudge] 1.5.1 / 2012-04-08 ================== * Merge pull request #16 from KyleAMathews/patch-1 * Fixes #15 1.5.0 / 2012-02-08 ================== * Added windows support [perfusorius] 1.4.1 / 2011-12-28 ================== * Fixed: dont exit(). Closes #9 1.4.0 / 2011-12-17 ================== * Changed API: `growl.notify()` -> `growl()` 1.3.0 / 2011-12-17 ================== * Added support for Ubuntu/Debian/Linux users [niftylettuce] * Fixed: send notifications even if title not specified [alessioalex] 1.2.0 / 2011-10-06 ================== * Add support for priority. 1.1.0 / 2011-03-15 ================== * Added optional callbacks * Added parsing of version 1.0.1 / 2010-03-26 ================== * Fixed; sys.exec -> child_process.exec to support latest node 1.0.0 / 2010-03-19 ================== * Initial release node-growl-1.7.0/Readme.md000066400000000000000000000066471207007465600153370ustar00rootroot00000000000000# Growl for nodejs Growl support for Nodejs. This is essentially a port of my [Ruby Growl Library](http://github.com/visionmedia/growl). Ubuntu/Linux support added thanks to [@niftylettuce](http://github.com/niftylettuce). ## Installation ### Install ### Mac OS X (Darwin): Install [growlnotify(1)](http://growl.info/extras.php#growlnotify). On OS X 10.8, Notification Center is supported using [terminal-notifier](https://github.com/alloy/terminal-notifier). To install: $ sudo gem install terminal-notifier Install [npm](http://npmjs.org/) and run: $ npm install growl ### Ubuntu (Linux): Install `notify-send` through the [libnotify-bin](http://packages.ubuntu.com/libnotify-bin) package: $ sudo apt-get install libnotify-bin Install [npm](http://npmjs.org/) and run: $ npm install growl ### Windows: Download and install [Growl for Windows](http://www.growlforwindows.com/gfw/default.aspx) Download [growlnotify](http://www.growlforwindows.com/gfw/help/growlnotify.aspx) - **IMPORTANT :** Unpack growlnotify to a folder that is present in your path! Install [npm](http://npmjs.org/) and run: $ npm install growl ## Examples Callback functions are optional var growl = require('growl') growl('You have mail!') growl('5 new messages', { sticky: true }) growl('5 new emails', { title: 'Email Client', image: 'Safari', sticky: true }) growl('Message with title', { title: 'Title'}) growl('Set priority', { priority: 2 }) growl('Show Safari icon', { image: 'Safari' }) growl('Show icon', { image: 'path/to/icon.icns' }) growl('Show image', { image: 'path/to/my.image.png' }) growl('Show png filesystem icon', { image: 'png' }) growl('Show pdf filesystem icon', { image: 'article.pdf' }) growl('Show pdf filesystem icon', { image: 'article.pdf' }, function(err){ // ... notified }) ## Options - title - notification title - name - application name - priority - priority for the notification (default is 0) - sticky - weither or not the notification should remainin until closed - image - Auto-detects the context: - 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 ## License (The MIT License) Copyright (c) 2009 TJ Holowaychuk 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. node-growl-1.7.0/lib/000077500000000000000000000000001207007465600143515ustar00rootroot00000000000000node-growl-1.7.0/lib/growl.js000066400000000000000000000123211207007465600160400ustar00rootroot00000000000000// Growl - Copyright TJ Holowaychuk (MIT Licensed) /** * Module dependencies. */ var exec = require('child_process').exec , fs = require('fs') , path = require('path') , exists = fs.existsSync || path.existsSync , os = require('os') , quote = JSON.stringify , cmd; function which(name) { var paths = process.env.PATH.split(':'); var loc; for (var i = 0, len = paths.length; i < len; ++i) { loc = path.join(paths[i], name); if (exists(loc)) return loc; } } switch(os.type()) { case 'Darwin': if (which('terminal-notifier')) { cmd = { type: "Darwin-NotificationCenter" , pkg: "terminal-notifier" , msg: '-message' , title: '-title' , subtitle: '-subtitle' , priority: { cmd: '-execute' , range: [] } }; } else { cmd = { type: "Darwin-Growl" , pkg: "growlnotify" , msg: '-m' , sticky: '--sticky' , priority: { cmd: '--priority' , range: [ -2 , -1 , 0 , 1 , 2 , "Very Low" , "Moderate" , "Normal" , "High" , "Emergency" ] } }; } break; case 'Linux': 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:' , priority: { cmd: '/p:' , range: [ -2 , -1 , 0 , 1 , 2 ] } }; break; } /** * Expose `growl`. */ exports = module.exports = growl; /** * Node-growl version. */ exports.version = '1.4.1' /** * 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) * - 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('Email sent', function(){ * // ... notification sent * }) * * @param {string} msg * @param {object} options * @param {function} fn * @api public */ function growl(msg, options, fn) { var image , args , options = options || {} , fn = fn || function(){}; // noop if (!cmd) return fn(new Error('growl not supported on this platform')); args = [cmd.pkg]; // image if (image = options.image) { switch(cmd.type) { case 'Darwin-Growl': var flag, ext = path.extname(image).substr(1) flag = 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 '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 + quote(image)); break; } } // sticky if (options.sticky) args.push(cmd.sticky); // priority if (options.priority) { var priority = options.priority + ''; var checkindexOf = cmd.priority.range.indexOf(priority); if (~cmd.priority.range.indexOf(priority)) { args.push(cmd.priority, options.priority); } } // 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(quote(msg)); if (options.title) args.push(quote(options.title)); break; case 'Darwin-NotificationCenter': args.push(cmd.msg); args.push(quote(msg)); if (options.title) { args.push(cmd.title); args.push(quote(options.title)); } if (options.subtitle) { args.push(cmd.subtitle); args.push(quote(options.title)); } break; case 'Darwin-Growl': args.push(cmd.msg); args.push(quote(msg)); if (options.title) args.push(quote(options.title)); break; case 'Linux': if (options.title) { args.push(quote(options.title)); args.push(cmd.msg); args.push(quote(msg)); } else { args.push(quote(msg)); } break; case 'Windows': args.push(quote(msg)); if (options.title) args.push(cmd.title + quote(options.title)); break; } // execute exec(args.join(' '), fn); }; node-growl-1.7.0/package.json000066400000000000000000000002571207007465600160750ustar00rootroot00000000000000{ "name": "growl", "version": "1.7.0", "description": "Growl unobtrusive notifications", "author": "TJ Holowaychuk ", "main": "./lib/growl.js" } node-growl-1.7.0/test.js000066400000000000000000000016051207007465600151220ustar00rootroot00000000000000 var growl = require('./lib/growl') growl('You have mail!') growl('5 new messages', { sticky: true }) growl('5 new emails', { title: 'Email Client', image: 'Safari', sticky: true }) growl('Message with title', { title: 'Title'}) growl('Set priority', { priority: 2 }) growl('Show Safari icon', { image: 'Safari' }) growl('Show icon', { image: 'path/to/icon.icns' }) growl('Show image', { image: 'path/to/my.image.png' }) growl('Show png filesystem icon', { image: 'png' }) growl('Show pdf filesystem icon', { image: 'article.pdf' }) growl('Show pdf filesystem icon', { image: 'article.pdf' }, function(){ console.log('callback'); }) growl('Show pdf filesystem icon', { title: 'Use show()', image: 'article.pdf' }) growl('here \' are \n some \\ characters that " need escaping', {}, function(error, stdout, stderr) { if (error !== null) throw new Error('escaping failed:\n' + stdout + stderr); })