index.js

#!/usr/bin/env node

var async = require('async');
var email = require('emailjs');
var fs = require('fs');
var path = require('path');
var program = require('commander');
const Mustache = require('mustache');
var scrawl = require('./www/scrawl');
const yaml = require('js-yaml');

program
  .version('0.6.0')
  // the setup switches
  .option('-c, --config <file>', 'The YAML configuration file.')
  .option('-d, --directory <directory>', 'The directory to process.')
  // the do something switches
  .option('-m, --html', 'If set, write the minutes to an index.html file')
  .option('-e, --email', 'If set, publish the minutes to the mailing list')
  .option('-i, --index', 'Build meeting index')
  // the tweak the cli switch
  .option('-q, --quiet', 'Don\'t print status information to the console')
  .parse(process.argv);

var base_dir = __dirname;
var config = {};
if (program.config) {
  try {
    config = yaml.safeLoad(fs.readFileSync(program.config, 'utf8'));
    // paths in the config file are relative to the config files location
    base_dir = path.resolve(path.dirname(program.config));
  } catch (e) {
    console.error(e.message);
  }
}

if(!program.directory) {
  console.error('Error: You must specify a directory to process');
  program.outputHelp();
  process.exit(1);
}

if (!program.html && !program.email && !program.index) {
  console.error('Error: Nothing to do...');
  program.outputHelp();
  process.exit(1);
}

// setup global variables
const dstDir = path.resolve(path.join(program.directory));
const logFile = path.resolve(dstDir, 'irc.log');
const changesLogFile = path.resolve(dstDir, 'changes.log');
const audioFile = path.resolve(dstDir, 'audio.ogg');
const indexFile = path.resolve(dstDir, 'index.html');
const minutesDir = path.join(dstDir, '/..');

const partialsDir = ('partials' in config)
  ? path.join(base_dir, config.partials)
  : path.join(__dirname, 'www/_partials/');
const peoplePath = ('people' in config)
  ? path.join(base_dir, config.people)
  : path.join(__dirname, 'www/people.json');

var htmlHeader = fs.readFileSync(
  path.join(partialsDir, 'header.html'), {encoding: 'utf8'});
var htmlFooter = fs.readFileSync(
  path.join(partialsDir, 'footer.html'), {encoding: 'utf8'});
var peopleJson = fs.readFileSync(peoplePath, {encoding: 'utf8'});
var gLogData = '';
var haveAudio = false;
var gDate = path.basename(dstDir);
gDate = gDate.match(/([0-9]{4}-[0-9]{2}-[0-9]{2})/)[1];

// configure scrawl
scrawl.group = config.group || 'Telecon';
scrawl.people = JSON.parse(peopleJson);

// we can't make any URLs without this...so fail...
if (!('minutes_base_url' in config)) {
  console.error('Error: The `minutes_base_url` was not set in the config');
  process.exit(1);
}
// Location of date-based minutes folders; MUST end in a forward slash
scrawl.minutes_base_url = config.minutes_base_url;

/************************* Utility Functions *********************************/
function sendEmail(username, password, hostname, content, callback) {
  var server  = email.server.connect({
    //user: username,
    //password: password,
    host: hostname,
    ssl: false
  });

  // send the message
  server.send({
    text:    content,
    from: EMAIL_FROM,
    //from:    username + '@' + hostname,
    to: EMAIL_TO,
    subject: Mustache.render(EMAIL_SUBJECT, {gDate})
  }, function(err, message) {
    if(err) {
      console.log('scrawl:', err);
      return callback();
    }

    if(!program.quiet) {
      console.log(`scrawl: Sent minutes email to ${EMAIL_TO}`);
    }
    callback();
  });
}
/*************************** Main Functionality ******************************/

async.waterfall([ function(callback) {
  // check to make sure the log file exists in the given directory
  //console.log("dstDir:", dstDir, "\nlogFile:", logFile);
  fs.exists(logFile, function(exists) {
    if(exists) {
      callback();
    } else {
      callback('Error: ' + logFile +
        ' does not exist, required for processing.');
    }
  });
}, function(callback) {
  fs.exists(audioFile, function(exists) {
    haveAudio = exists;
    callback();
  });
}, function(callback) {
  // read the IRC log file
  let log = fs.readFileSync(logFile, 'utf8');
  // read the changes log file if it exists
  try {
    log += '\n';
    log += fs.readFileSync(changesLogFile, 'utf8');
  } catch(e) {
    // ignore if the file doesn't exist
  }
  callback(null, log);
}, function(data, callback) {
  gLogData = data;
  // generate the index.html file
  var minutes =
    htmlHeader +
    '<div><div><div class="container">' +
    '<div class="row"><div class="col-md-8 col-md-offset-2">' +
    scrawl.generateMinutes(gLogData, 'html', gDate, haveAudio) +
    '</div></div></div></div></div>' + htmlFooter;
  callback(null, minutes);
}, function(minutes, callback) {
  // write the index.html file to disk
  if(program.html) {
    if(!program.quiet) {
      console.log('scrawl: Writing minutes to', indexFile);
    }
    fs.writeFile(indexFile, minutes, {}, callback);
  } else {
    callback();
  }
}, function(callback) {
  // write the index.html file to disk
  if(program.index) {
    if(!program.quiet) {
      console.log('scrawl: Writing meeting summaries to',
                  `${minutesDir}/index.html`);
    }
    // uses constant minutesDir
    var logFiles = [];
    async.auto({
      readDirs: function(callback) {
        fs.readdir(minutesDir, callback);
      },
      findLogs: ['readDirs', function(callback, results) {
        async.each(results.readDirs, function(item, callback) {
          var ircLog = minutesDir + '/' + item + '/irc.log';
          fs.exists(ircLog, function(exists) {
            if(exists) {
              logFiles.push(ircLog);
            }
            callback();
          });
        }, function(err) {
          callback(err, logFiles);
        });
      }],
      buildSummaries: ['findLogs', function(callback, results) {
        var summaries = {};
        async.each(results.findLogs, function(item, callback) {
          fs.readFile(item, "utf8", function(err, data) {
            if(err) {
              return callback(err);
            }

            // generate summary items
            var summary = {
              topic: [],
              resolution: []
            };
            if(data.search(/agendum \d+\s+\-\- (.*) \-\-/i)) {
              summary.topic = data.match(/agendum \d+\s+\-\- (.*) \-\-/i);
            } else if(data.search(/(?<!sub)topic: (.*)/ig)) {
              summary.topic = data.match(/(?<!sub)topic: (.*)/ig);
            }
            summary.topic = data.match(/(?<!sub)topic: (.*)/ig);
            summary.resolution = data.match(/resolved: (.*)/ig);

            // strip extraneous information
            for(var i in summary.topic) {
              summary.topic[i] = summary.topic[i].replace(/topic: /ig, '');
            }
            for(var j in summary.resolution) {
              summary.resolution[j] =
                summary.resolution[j].replace(/resolved: /ig, '');
            }

            var date = item.match(/([0-9]{4}-[0-9]{2}-[0-9]{2}-?[^\/]*)/)[1];
            summaries[date] = summary;
            callback();
          });
        }, function(err) {
          callback(err, summaries);
        });
      }]
    }, function(err, results) {
      if(err) {
        return callback(err);
      }

      const summaryIntro = fs.readFileSync(
        path.join(partialsDir, 'summary-intro.html'), {encoding: 'utf8'});

      // write out summary file
      var summaryHtml = htmlHeader + '<div id="info">' + summaryIntro;

      var summaryKeys = Object.keys(results.buildSummaries).sort().reverse();
      for(var k in summaryKeys) {
        var key = summaryKeys[k];
        var summary = results.buildSummaries[key];
        summaryHtml += '<h3><a href="' + key + '/">Meeting for ' + key + '</a></h3>\n';
        if(summary.topic && summary.topic.length > 0) {
          summaryHtml += '<h4>Topics</h4><ol>\n';
          for(var t in summary.topic) {
            var tcounter = parseInt(t) + 1;
            summaryHtml +=
              '<li><a href="' + key + '/#topic-' + tcounter + '">' +
              summary.topic[t] + '</a></li>\n';
          }
          summaryHtml += '</ol>\n';
        }
        if(summary.resolution && summary.resolution.length > 0) {
          summaryHtml += '<h4>Resolutions</h4><ol>\n';
          for(var r in summary.resolution) {
            var rcounter = parseInt(r) + 1;
            summaryHtml +=
              '<li><a href="' + key + '/#resolution-' + rcounter + '">' +
              summary.resolution[r] + '</a></li>\n';
          }
          summaryHtml += '</ol>\n';
        }
      }
      summaryHtml += htmlFooter;

      fs.writeFileSync(path.join(minutesDir + '/index.html'), summaryHtml, 'utf-8');
      callback();
    });
  } else {
    callback();
  }
}, function(callback) {
  // send the email about the meeting
  if(program.email) {
    if(!program.quiet) {
      console.log('scrawl: Sending new minutes email.');
    }

    if (!('email' in config)) {
      callback('Error: Email configuration is missing');
      return;
    } else if (!('from' in config.email) || !('to' in config.email)) {
      callback('Error: You must supply a `to` and `from` config value');
      return;
    }

    // see sendEmail()
    // TODO: don't use global constants...
    const EMAIL_TO = config.email.to;
    const EMAIL_FROM = config.email.from;

    // Mustache template -- vars: gDate
    // TODO: dates are always Eastern Time...maybe the world is round?
    // TODO: also the time is still hard coded T_T
    const EMAIL_SUBJECT = config.email.subject || '[MINUTES] {{gDate}} 12pm ET';
    // Mustache template -- vars: scribe, gDate, content, minutes_base_url, haveAudio
    const EMAIL_BODY = config.email.body || `Thanks to {{scribe}} for scribing this week! The minutes
for this week's telecon are now available:

{{{minutes_base_url}}}{{gDate}}/

Full text of the discussion follows for archival purposes.
{{#haveAudio}}Audio from the meeting is available as well (link provided below).{{/haveAudio}}

----------------------------------------------------------------
{{{content}}}`;

    // generate the body of the email
    var content = scrawl.generateMinutes(gLogData, 'text', gDate, haveAudio);
    var scribe = content.match(/Scribe:\n\s(.*)\n/g)[0]
      .replace(/\n/g, '').replace('Scribe:  ', '');
    content = Mustache.render(EMAIL_BODY,
                              {scribe, gDate, content,
                                minutes_base_url: scrawl.minutes_base_url,
                                haveAudio});

    if(process.env.SCRAWL_EMAIL_USERNAME && process.env.SCRAWL_EMAIL_PASSWORD &&
      process.env.SCRAWL_EMAIL_SERVER) {
      sendEmail(
        process.env.SCRAWL_EMAIL_USERNAME, process.env.SCRAWL_EMAIL_PASSWORD,
        process.env.SCRAWL_EMAIL_SERVER, content, callback);
    } else {
      var prompt = require('prompt');
      prompt.start();
      prompt.get({
        properties: {
          server: {
            description: 'Enter your email server',
            pattern: /^.{4,}$/,
            message: 'The server name must be at least 4 characters.',
            'default': 'mail.digitalbazaar.com'
          },
          username: {
            description: 'Enter your email login name',
            pattern: /^.{1,}$/,
            message: 'The username must be at least 4 characters.',
            'default': 'msporny'
          },
          password: {
            description: 'Enter your email password',
            pattern: /^.{4,}$/,
            message: 'The password must be at least 4 characters.',
            hidden: true,
            'default': 'password'
          }
        }
      }, function(err, results) {
        sendEmail(results.username, results.password, results.server,
          content, callback);
      });
    }
  } else {
    callback();
  }
}], function(err) {
  // check to ensure there were no errors
  if(err) {
    console.log('Error:', err);
  }
});