Release SARAH v2.9

Author: JpEncausse

.gitattributes

@@ -0,0 +1,2 @@
+# Disable LF normalization for all files
+* -text

.gitignore

@@ -28,7 +28,7 @@ overview.docx
 README/SayStatic/
 README/ScanSoftTTS/
 README/changelog.txt
-plugins/karotz/java/jre
+plugins/
 
 
 # External tool builders

script/lib/phantom.js

@@ -2,10 +2,11 @@ var exec  = require('child_process').exec;
 var spawn = require('child_process').spawn;
 var fs    = require('fs');
 var xtend = require('./extend.js');
+var winston = require('winston');
 
 exports.action = function(cmd, data, callback, SARAH){
 
-  console.log('Fetching phantom script %s ...', cmd);
+  winston.log('info', 'Fetching phantom script %s ...', cmd);
 
   // Compute script
   var script = 'script/phantom/'+cmd+'.js';
@@ -32,18 +33,18 @@ exports.action = function(cmd, data, callback, SARAH){
   var soft = config.http.phantom || (__dirname + "/../../PhantomJS/phantomjs.exe");
   var proc = path.normalize(soft);
 
-  console.log("Phantom: ", proc, '--proxy-type=none', script, json); 
+  winston.log('info',"Phantom: ", proc, '--proxy-type=none', script, json); 
 
   var child = spawn(proc, ['--proxy-type=none', script, json]);
   child.stderr.on('data', function (data) { 
-    console.log('Error: ',getBuffer(data));
+    winston.log('warn','Error: ',getBuffer(data));
     callback({'tts' : 'Une erreur est survenue'});
   });
 
   child.stdout.on('data', function (data) { 
     var response = getBuffer(data); 
     var json = JSON.parse(response);
-    console.log('Success: ', response);
+    winston.log('info','Success: ', response);
 
     // Hook perfoming on results
     var module = false;
@@ -52,7 +53,7 @@ exports.action = function(cmd, data, callback, SARAH){
       try { module = require('./'+cmd+'.node.js'); } catch (ex) { }
     }
     if (module){
-      console.log('Running phantom callback %s ...', cmd+'.node');
+      winston.log('info','Running phantom callback %s ...', cmd+'.node');
       options.directory = data.directory;  
       module.after(options, json, SARAH);
     }

script/lib/scraper.js

@@ -1,3 +1,5 @@
+var winston = require('winston');
+
 // ------------------------------------------
 //  EVALUATE
 // ------------------------------------------
@@ -47,7 +49,7 @@ var scraper = {
 
       // Check for page load success
       if (status !== "success") {
-        console.log(JSON.stringify(results));
+        winston.log('info',JSON.stringify(results));
         //phantom.exit();
         return;
       }
@@ -56,7 +58,7 @@ var scraper = {
 
       // Load jQuery
       if (!page.injectJs(jquery)){
-        console.log(JSON.stringify(results));
+        winston.log('info',JSON.stringify(results));
         //phantom.exit();
         return;
       }

script/lib/upload.js

@@ -1,4 +1,4 @@
-
+var winston = require('winston');
 exports.action = function(req, res, config){
 
   res.writeHead(200, {'content-type': 'text/plain'});
@@ -17,7 +17,7 @@ exports.action = function(req, res, config){
     path   = req.files.file.path;
   }
 
-  console.log('Upload ' + path + ' to ' + upload+name);
+  winston.log('info','Upload ' + path + ' to ' + upload+name);
 
   var fs   = require('fs');
   var util = require('util');

script/manager/config.js

@@ -1,5 +1,8 @@
 var fs = require('fs');
 var xtend = require('../lib/extend.js');
+var winston = require('winston');
+var pwd = require('path');
+
 // ------------------------------------------
 //  REQUIRE - HELPER
 // ------------------------------------------
@@ -66,11 +69,11 @@ var loadPlugins = function(folder, conf){
 
     // Ends with .prop
     if (file.endsWith('.prop')){
-      console.log('Loading plugin properties %s ...', path);
+      winston.log('info', 'Loading plugin properties %s ...', path);
       try {
         var json   =  fs.readFileSync(path,'utf8');
         var plugin = JSON.parse(json);
-      } catch(ex){ console.log(ex); }
+      } catch(ex){ winston.warn(ex); }
       xtend.extend(true, conf, plugin);
     }
   });
@@ -81,19 +84,19 @@ var getJSON = function(name){
   var path = 'plugins/'+name+'/'+name+'.prop';
   if (!fs.existsSync(path)){ return {}; }
 
-  console.log('Loading plugin properties %s ...', path);
+  //winston.log('info', 'Loading plugin properties %s ...', path);
   try {
     var json = fs.readFileSync(path,'utf8');
     return JSON.parse(json);
-  } catch(ex){ console.log(ex); }
+  } catch(ex){ winston.warn(ex); }
 }
 
 /**
  * Load default properties
  */
 var loadProperties = function(){
   if (!fs.existsSync('script/wsrnode.prop')) { return {}; }
-  console.log('Loading core properties...');
+  winston.info('Loading core properties...');
   var json = fs.readFileSync('script/wsrnode.prop','utf8');
   return JSON.parse(json);
 }
@@ -103,11 +106,32 @@ var loadProperties = function(){
  */
 var loadCustoms = function(){
   if (!fs.existsSync('custom.prop')) { return {}; }
-  console.log('Loading custom properties...');
+  winston.info('Loading custom properties...');
   var json = fs.readFileSync('custom.prop','utf8');
   var parse = {};
-  try { parse = JSON.parse(json); } catch (ex){ console.log(ex.message); }
-  return parse
+  try { parse = JSON.parse(json); } catch (ex){ winston.error(ex.message); }
+  
+  parse['modules']  = retains(parse['modules'],  config['modules']);
+  parse['phantoms'] = retains(parse['phantoms'], config['phantoms']);
+  parse['cron']     = retains(parse['cron'],     config['cron']);
+
+  return parse;
+}
+
+var retains = function(source, target){
+  if (typeof source != 'object') return source;
+  
+  var clean  = {};
+  Object.keys(source).forEach(function(attr){
+    if (attr == 'description' || attr == 'version'){ return false; }
+    if (target[attr] === undefined
+        && attr != 'x' && attr != 'y' 
+        && attr != 'w' && attr != 'h'
+        && attr != 'c'){ return winston.log('warn', 'Bypass config: ', attr); }
+    clean[attr] = retains(source[attr], target[attr]);
+  });
+  
+  return clean;
 }
 
 // ------------------------------------------
@@ -121,9 +145,9 @@ var saveProperties = function(cfg) {
 
     //json = json.replace(/\{/g,"{\n  ").replace(/\}/g,"\n  }").replace(/,/g,",\n  ");
     fs.writeFileSync('custom.prop', json, 'utf8');
-    console.log('Properties saved successfully');
+    winston.info('Properties saved successfully');
   } catch(ex) {
-    console.log('Error while saving properties:', ex.message);
+    winston.log('error', 'Error while saving properties:', ex.message);
   }
 }
 
@@ -133,6 +157,15 @@ var saveProperties = function(cfg) {
 
 var routes = function(req, res, next){
 
+  var json = req.body.json;
+  if (json){
+    json = JSON.parse(json);
+    xtend.extend(true, config, json);
+    ConfigManager.save(config);
+    res.redirect('/home');
+    return; 
+  }
+  
   var key = req.body.key;
   if (!key){ res.redirect('/home');  return; }
 
@@ -141,7 +174,7 @@ var routes = function(req, res, next){
 
   Object.keys(req.body).forEach(function(attr){
     if (attr == 'key') { return; }
-    console.log(key+'.'+attr+' => '+req.body[attr]);
+    winston.info(key+'.'+attr+' => '+req.body[attr]);
     cnf[attr] = req.body[attr];
   });
 
@@ -156,21 +189,52 @@ var routes = function(req, res, next){
 
 var getModule = function(name, uncache){
   var module = false;
+  var path = false;
+
   try {
-    var path = '../../plugins/'+name+'/'+name+'.js';
+    path = pwd.normalize(__dirname+'/../../plugins/'+name+'/'+name+'.js');
     if (config.debug || uncache){ require.uncache(path); }
-    module = require(path); 
+    module = require(path);  
   } 
   catch (ex) { 
     try { 
-      var path = '../'+name+'.js';
+      path = pwd.normalize(__dirname+'/../'+name+'.js');
       if (config.debug || uncache){ require.uncache(path); } 
       module = require(path); 
     } catch (ex) { }
   }
+  
+  initModule(module, name); 
+  if (!module){ return false;  }
+  if (uncache){ return module; }
+  
+  // Force reload if file change
+  
+  var modified = fs.statSync(path).mtime.getTime();
+  if (!module.lastModified){
+    module.lastModified = modified;
+  } 
+  else if (module.lastModified < modified){
+    winston.log('info', 'Reloading '+name);
+    return getModule(name, true);
+  }
+  
   return module;
 }
 
+var initModule = function(module, name){
+  try {
+    if (!module) { return; }
+    
+    if (module.initialized){ return; }
+    module.initialized = true;
+     
+    winston.log('info','initModule: ', name);
+    if (!module.init){ return; }
+    module.init(SARAH);
+  } catch (ex) { winston.log('warn','initModule: ' + ex.message); }
+}
+
 // ------------------------------------------
 //  GET TICKER
 // ------------------------------------------
@@ -180,7 +244,7 @@ var getTicker = function(){
   var url = 'https://dl.dropbox.com/u/255810/Encausse.net/Sarah/plugins/ticker.json';
   var request = require('request');
   request({ 'uri' : url, json : true }, function (err, response, json){
-    if (err || response.statusCode != 200) { console.log("Can't retrieve remote ticker");  return; }
+    if (err || response.statusCode != 200) { winston.info("Can't retrieve remote ticker");  return; }
     ticker = json.message; // delayed by 1 request
   });
   return ticker;
@@ -208,7 +272,7 @@ var ConfigManager = {
       xtend.extend(true, config, loadPlugins());
       xtend.extend(true, config, loadCustoms());
     } 
-    catch(ex) { console.log('Error while loding properties:', ex.message);  }
+    catch(ex) { winston.log('error', 'Error while loding properties:', ex.message);  }
     return ConfigManager;
   },
 

script/manager/cron.js

@@ -1,3 +1,4 @@
+var winston = require('winston');
 var cronJob = require('../vendor/cron').CronJob;
 
 // ------------------------------------------
@@ -9,16 +10,16 @@ var cronJob = require('../vendor/cron').CronJob;
  */
 var startJob = function(task, module){
   if (!module){ 
-    console.log('Missing CRON module');
+    winston.warn('Missing CRON module: ', task.name);
     return; 
   }
 
   if (!task.time){
-    console.log("Missing task's name or time properties");
+    winston.warn("Missing task's name or time properties");
     return;
   }
 
-  console.log('Starting CRON Job for %s at %s', task.name, task.time);
+  winston.log('info', 'Starting CRON Job for %s at %s', task.name, task.time);
 
   // Build callback
   var callback = function(options){
@@ -29,7 +30,7 @@ var startJob = function(task, module){
   var job = new cronJob({
     cronTime: task.time,
     onTick: function() {
-      console.log('Cron: %s', task.name);
+      winston.log('info', 'Cron: %s', task.name);
       module.cron(callback, task, SARAH);
     },
     start: true
@@ -49,7 +50,7 @@ var startAll = function(){
   Object.keys(config.cron).forEach(function(key){
     var task = config.cron[key];
     var module = SARAH.ConfigManager.getModule(key);
-    console.log('Starting task %s ...', key);
+    winston.log('info', 'Starting task %s ...', key);
     CRONManager.start(task, module);
   });
 }

script/manager/phantom.js

@@ -1,6 +1,7 @@
 var url   = require('url');
 var qs    = require('querystring');
 var xtend = require('../lib/extend.js');
+var winston = require('winston');
 
 // ------------------------------------------
 //  ROUTES  PHANTOM
@@ -11,7 +12,8 @@ var routes = function(req, res, next){
   // Parse URL & QueryString
   var rUrl = url.parse(req.url);
   var rQs  = qs.parse(rUrl.query);
-  
+  rQs.body = req.body;
+    
   // Parse Command
   var cmd = rUrl.pathname;
   cmd = cmd.substring(cmd.lastIndexOf('/')+1);
@@ -20,20 +22,26 @@ var routes = function(req, res, next){
   SARAH.run(cmd, rQs, res);
 }
 
-var run = function(cmd, rQs, res){
+var run = function(cmd, rQs, res, cb){
   // Callback
   var callback = function(opts){
+    var end = (new Date()).getTime();
+    winston.log('info', 'Run '+cmd+': '+(end-start)+'ms');
+    
+    if (cb){ return cb(opts); }
+    
     var options = xtend.extend(true, rQs, opts);
     SARAH.dispatch(cmd, options, res);
   }
 
   // Call phantom
+  var start = (new Date()).getTime();
   try {
     var phantom = require('../lib/phantom.js'); 
     phantom.action(cmd, rQs, callback, SARAH);
   } 
   catch(ex){ 
-    console.log(ex);
+    winston.log('warn', 'Phantom '+cmd+': ', ex);
     SARAH.dispatch({ tts : 'Je ne comprends pas'}, res); 
   }
 }