Initial version

audiogram/index.js

@@ -2,7 +2,7 @@ var path = require("path"),
     queue = require("d3").queue,
     mkdirp = require("mkdirp"),
     rimraf = require("rimraf"),
-    serverSettings = require("../settings/"),
+    serverSettings = require("../lib/settings/"),
     transports = require("../lib/transports/"),
     logger = require("../lib/logger/"),
     Profiler = require("../lib/profiler.js"),

bin/server

@@ -1,5 +1,8 @@
 #!/usr/bin/env node
 
+// Require settings first, for validation
+require("../lib/settings/");
+
 var dotenv = require("dotenv").config({silent: true}),
     logger = require("../lib/logger/"),
     server = require("../server/");

bin/worker

@@ -1,4 +1,8 @@
 #!/usr/bin/env node
+
+// Require settings first, for validation
+require("../lib/settings/");
+
 var dotenv = require("dotenv").config({silent: true}),
     Audiogram = require("../audiogram/"),
     transports = require("../lib/transports/");

lib/register-fonts.js

@@ -1,10 +0,0 @@
-var fonts = require("../settings/").fonts,
-    _ = require("underscore"),
-    Canvas = require("canvas");
-
-// Register custom fonts one time
-if (Array.isArray(fonts)) {
-  fonts.forEach(function(font){
-    Canvas.registerFont(font.file, _.pick(font, "family", "weight", "style"));
-  });
-}

lib/settings/index.js

@@ -0,0 +1,39 @@
+var _ = require("underscore"),
+    path = require("path"),
+    fs = require("fs");
+
+var settings = tryToLoad("settings/index.js"),
+    themes = tryToLoad("settings/themes.json");
+
+// Validate settings
+require("./validate-settings.js")(settings);
+
+// Validate themes
+require("./validate-themes.js")(themes);
+
+module.exports = settings;
+
+// Try to load modules
+function tryToLoad(filename) {
+
+  var loaded;
+
+  try {
+    loaded = require(path.join(__dirname, "..", "..", filename));
+    if (!loaded) {
+      throw new Error("Couldn't load contents of " + filename + ".");
+    }
+  } catch(e) {
+    if (e.code === "MODULE_NOT_FOUND") {
+      throw new Error("No " + filename + " file found.");
+    } else if (e instanceof SyntaxError) {
+      console.warn("Error parsing " + filename);
+      throw e;
+    } else {
+      throw e;
+    }
+  }
+
+  return loaded;
+
+}

lib/settings/validate-settings.js

@@ -0,0 +1,92 @@
+var fs = require("fs"),
+    path = require("path"),
+    Canvas = require("canvas");
+
+module.exports = function(settings) {
+
+  // Check paths
+  if (typeof settings.workingDirectory !== "string") {
+    throw new Error("settings.workingDirectory is required. See https://github.com/nypublicradio/audiogram/blob/master/SERVER.md#all-settings for details.").
+  }
+
+  if (typeof settings.storagePath !== "string" && typeof settings.s3Bucket !== "string") {
+    throw new Error("settings.storagePath or settings.s3Bucket is required. See https://github.com/nypublicradio/audiogram/blob/master/SERVER.md#all-settings for details.");
+  }
+
+  // TODO normalize workingDirectory, s3Bucket, and storagePath
+  settings.workingDirectory = normalize(settings.workingDirectory);
+  tryToCreate("workingDirectory");
+
+  if (typeof settings.s3Bucket === "string") {
+
+    // Remove s3:// and trailing slash, bucket name only
+    settings.s3Bucket = settings.s3Bucket.replace(/^(s3[:]\/\/)|\/$/g, "");
+
+    if (settings.storagePath) {
+
+      // No leading slash, one trailing slash
+      settings.storagePath = settings.storagePath.replace(/^\/|\/$/g, "");
+
+      if (settings.storagePath) {
+        settings.storagePath += "/";
+      }
+
+    } else {
+      settings.storagePath = "";
+    }
+
+  } else {
+    settings.storagePath = normalize(settings.storagePath);
+    tryToCreate("storagePath");
+  }
+
+  // Check maxUploadSize
+  if ("maxUploadSize" in settings && typeof settings.maxUploadSize !== "number") {
+    throw new TypeError("settings.maxUploadSize must be an integer. See https://github.com/nypublicradio/audiogram/blob/master/SERVER.md#all-settings for details.");
+  }
+
+  // Check fonts
+  if ("fonts" in settings) {
+    if (!Array.isArray(settings.fonts)) {
+      throw new TypeError("settings.fonts must be an array of fonts. See https://github.com/nypublicradio/audiogram/blob/master/THEMES.md#a-note-about-fonts for details.")
+    }
+
+    settings.fonts.forEach(function(font){
+
+      if (!font || typeof font.family !== "string" || typeof font.file !== "string") {
+        return console.warn("Custom font in settings.fonts missing a 'family' or 'file'. See https://github.com/nypublicradio/audiogram/blob/master/THEMES.md#a-note-about-fonts for details.");
+      }
+
+      font.file = normalize(font.file);
+
+      try {
+        fs.accessSync(font.file);
+        Canvas.registerFont(font.file, _.pick(font, "family", "weight", "style"));
+      } catch(e) {
+        // TODO catch font registration error
+        console.warn(e);
+        return console.warn("Font file " + font.file + " does not exist or is not readable.");
+      }
+
+    });
+  }
+
+};
+
+function tryToCreate(key) {
+  try {
+    mkdirp.sync(settings[key]);
+    fs.accessSync(settings[key]);
+  } catch(e) {
+    // TODO more helpful msg
+    console.warn(e);
+    throw e;
+  }
+}
+
+function normalize(p) {
+  if (path.isAbsolute(p)) {
+    return p;
+  }
+  return path.join(__dirname, "..", "..", p);
+}

lib/settings/validate-themes.js

@@ -0,0 +1,42 @@
+var path = require("path"),
+    _ = require("underscore"),
+    fs = require("fs");
+
+module.exports = function(themes) {
+
+  if (!themes || !_.keys(_.omit(themes, "default")).length) {
+    throw new Error("No themes found in settings/themes.json. See https://github.com/nypublicradio/audiogram/blob/master/THEMES.md for details.");
+  }
+
+  for (var key in themes) {
+    if (key !== "default") {
+      validateTheme(key, _.extend({}, themes.default || {}, themes[key]));
+    }
+  }
+
+};
+
+function validateTheme(name, options) {
+
+  var fullBackgroundImagePath;
+
+  if (!options || !_.keys(options).length) {
+    return console.warn("Theme '" + name + "' is not defined.");
+  }
+
+  ["width", "height", "framesPerSecond", "samplesPerFrame"].forEach(function(key){
+    if (typeof options[key] !== "number") {
+      console.warn("The required property '" + key +"' is missing from theme '" + name + "' or invalid.");
+    }
+  });
+
+  if (typeof options.backgroundImage === "string") {
+    fullBackgroundImagePath = path.join(__dirname, "..", "..", "settings/backgrounds/", options.backgroundImage);
+
+    try {
+      fs.accessSync(fullBackgroundImagePath);
+    } catch(e) {
+      console.warn("Background image for theme '" + name + "' (" + fullBackgroundImagePath + ") does not exist or is not readable.");
+    }
+  }
+}

lib/transports/index.js

@@ -1,5 +1,5 @@
 var extend = require("underscore").extend,
-    serverSettings = require("../../settings/"),
+    serverSettings = require("../settings/"),
     s3 = require("./s3")(serverSettings),
     redis = require("./redis")(serverSettings);
 

lib/transports/s3/fake.js

@@ -5,12 +5,6 @@ var fs = require("fs"),
 
 module.exports = function(storagePath) {
 
-  storagePath = storagePath || "";
-
-  if (!path.isAbsolute(storagePath)) {
-    storagePath = path.join(__dirname, "..", "..", "..", storagePath);
-  }
-
   function copy(source, destination, cb) {
 
     if (!path.isAbsolute(source)) {

lib/transports/s3/remote.js

@@ -3,21 +3,6 @@ var AWS = require("aws-sdk"),
 
 module.exports = function(bucket, storagePath) {
 
-  storagePath = storagePath || "";
-
-  // Normalize slashes in path
-  if (storagePath.length) {
-    storagePath = storagePath.replace(/^\/|\/$/g, "") + "/";
-  }
-
-  // Catch single slash path
-  if (storagePath === "/") {
-    storagePath = "";
-  }
-
-  // Remove s3:// just in case
-  bucket = bucket.replace(/^(s3[:]\/\/)|\/$/g, "");
-
   var s3 = new AWS.S3({ params: { Bucket: bucket } });
 
   // Test credentials

server/error.js

@@ -1,4 +1,4 @@
-var serverSettings = require("../settings/");
+var serverSettings = require("../lib/settings/");
 
 module.exports = function(err, req, res, next) {
 

server/index.js

@@ -13,7 +13,7 @@ var logger = require("../lib/logger/"),
     errorHandlers = require("./error.js");
 
 // Settings
-var serverSettings = require("../settings/");
+var serverSettings = require("../lib/settings/");
 
 var app = express();
 
@@ -43,20 +43,12 @@ if (serverSettings.maxUploadSize) {
   };
 }
 
-if (typeof serverSettings.workingDirectory !== "string") {
-  throw new TypeError("No workingDirectory set in settings/index.js");
-}
-
 // On submission, check upload, validate input, and start generating a video
 app.post("/submit/", [multer(fileOptions).single("audio"), render.validate, render.route]);
 
 // If not using S3, serve videos locally
 if (!serverSettings.s3Bucket) {
-  if (typeof serverSettings.storagePath !== "string") {
-    throw new TypeError("No storagePath set in settings/index.js");
-  }
-  var storagePath =  path.isAbsolute(serverSettings.storagePath) ? serverSettings.storagePath : path.join(__dirname, "..", serverSettings.storagePath);
-  app.use("/video/", express.static(path.join(storagePath, "video")));
+  app.use("/video/", express.static(path.join(serverSettings.storagePath, "video")));
 }
 
 // Check the status of a current video

server/render.js

@@ -1,4 +1,4 @@
-var serverSettings = require("../settings/"),
+var serverSettings = require("../lib/settings/"),
     spawn = require("child_process").spawn,
     path = require("path"),
     _ = require("underscore"),

test/patch-settings.js

@@ -1,4 +1,4 @@
-var serverSettings = require("../settings/");
+var serverSettings = require("../lib/settings/");
 
 module.exports = function(newSettings) {
   for (var key in serverSettings) {