expresser

<!DOCTYPE html> <html> <head> <title>settings.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="public/stylesheets/normalize.css" /> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div class="container"> <div class="page"> <div class="header"> <h1>settings.coffee</h1> <div class="toc"> <h3>Table of Contents</h3> <ol> <li> <a class="source" href="index.html"> index.coffee </a> </li> <li> <a class="source" href="app.html"> app.coffee </a> </li> <li> <a class="source" href="cron.html"> cron.coffee </a> </li> <li> <a class="source" href="database.html"> database.coffee </a> </li> <li> <a class="source" href="downloader.html"> downloader.coffee </a> </li> <li> <a class="source" href="events.html"> events.coffee </a> </li> <li> <a class="source" href="firewall.html"> firewall.coffee </a> </li> <li> <a class="source" href="imaging.html"> imaging.coffee </a> </li> <li> <a class="source" href="logger.html"> logger.coffee </a> </li> <li> <a class="source" href="mailer.html"> mailer.coffee </a> </li> <li> <a class="source" href="settings.html"> settings.coffee </a> </li> <li> <a class="source" href="sockets.html"> sockets.coffee </a> </li> <li> <a class="source" href="utils.html"> utils.coffee </a> </li> </ol> </div> </div> <h2 id="expresser-settings">EXPRESSER SETTINGS</h2> All main settings for the Expresser platform are set and described on the settings.default.json file. Do not edit it!!! To change settings please create a settings.json file and put your values there. You can also create specific settings for different runtime environments. For example to set settings on development, create <code>settings.development.json</code> and for production a <code>settings.production.json</code> file. These will be parsed AFTER the main <code>settings.json</code> file. Please note that the <code>settings.json</code> must ne located on the root of your app!  <div class='highlight'><pre>class Settings crypto = require "crypto" fs = require "fs" lodash = require "lodash" path = require "path" utils = require "./utils.coffee" currentEnv: process.env.NODE_ENV</pre></div> <h2 id="main-methods">MAIN METHODS</h2> Load settings from settings.default.json, then settings.json, then environment specific settings. <div class='highlight'><pre> load: => @currentEnv = process.env.NODE_ENV or "development" @loadFromJson "settings.default.json" @loadFromJson "settings.json" @loadFromJson "settings.#{@currentEnv.toString().toLowerCase()}.json"</pre></div> Helper to load values from the specified settings file. @param [String] filename The filename or path to the settings file. @param [Boolean] doNotUpdateSettings If true it won’t update the Settings class, default is false. @return [Object] Returns the JSON representation of the loaded file. <div class='highlight'><pre> loadFromJson: (filename) => filename = utils.getFilePath filename settingsJson = null</pre></div> Has json? Load it. Try using UTF8 first, if failed, use ASCII. <div class='highlight'><pre> if filename? if process.versions.node.indexOf(".10.") > 0 encUtf8 = {encoding: "utf8"} encAscii = {encoding: "ascii"} else encUtf8 = "utf8" encAscii = "ascii"</pre></div> Try parsing the file with UTF8 first, if fails, try ASCII. <div class='highlight'><pre> try settingsJson = fs.readFileSync filename, encUtf8 settingsJson = utils.minifyJson settingsJson catch ex settingsJson = fs.readFileSync filename, encAscii settingsJson = utils.minifyJson settingsJson</pre></div> Helper function to overwrite properties. <div class='highlight'><pre> xtend = (source, target) -> for prop, value of source if value?.constructor is Object target[prop] = {} if not target[prop]? xtend source[prop], target[prop] else target[prop] = source[prop] xtend settingsJson, this if @general.debug and @logger.console console.log "Settings.loadFromJson", filename</pre></div> Return the JSON representation of the file (or null if not found / empty). <div class='highlight'><pre> return settingsJson</pre></div> Reset to default settings. <div class='highlight'><pre> reset: => @instance = new Settings() @instance.load()</pre></div> <h2 id="encryption">ENCRYPTION</h2> Helper to encrypt or decrypt settings files. The default encryption password defined on the <code>Settings.coffee</code> file is “ExpresserSettings”, which ideally you should change. The default cipher algorithm is AES 256. @param [Boolean] encrypt Pass true to encrypt, false to decrypt. @param [String] filename The file to be encrypted or decrypted. @param [Object] options Options to be passed to the cipher. @option options [String] cipher The cipher to be used, default is aes256. @option options [String] password The default encryption password. <div class='highlight'><pre> cryptoHelper: (encrypt, filename, options) => options = {} if not options? options = lodash.defaults options, {cipher: "aes256", password: "ExpresserSettings"} settingsJson = @loadFromJson filename, false</pre></div> Settings file not found or invalid? Stop here. <div class='highlight'><pre> if not settingsJson? and @logger.console console.warn "Settings.cryptoHelper", encrypt, filename, "File not found or invalid, abort!" return false</pre></div> If trying to encrypt and settings property <code>encrypted</code> is true, abort encryption and log to the console. <div class='highlight'><pre> if settingsJson.encrypted is true and encrypt if @logger.console console.warn "Settings.cryptoHelper", encrypt, filename, "Property 'encrypted' is true, abort!" return false</pre></div> Helper to parse and encrypt / decrypt settings data. <div class='highlight'><pre> parser = (obj) => currentValue = null for prop, value of obj if value?.constructor is Object parser obj[prop] else try currentValue = obj[prop] if encrypt</pre></div> Check the property data type and prefix the new value. <div class='highlight'><pre> if lodash.isBoolean currentValue newValue = "bool:" else if lodash.isNumber currentValue newValue = "number:" else newValue = "string:"</pre></div> Create cipher amd encrypt data. <div class='highlight'><pre> c = crypto.createCipher options.cipher, options.password newValue += c.update currentValue.toString(), @general.encoding, "hex" newValue += c.final "hex" else</pre></div> Split the data as “datatype:encryptedValue”. <div class='highlight'><pre> arrValue = currentValue.split ":" newValue = ""</pre></div> Create cipher and decrypt. <div class='highlight'><pre> c = crypto.createDecipher options.cipher, options.password newValue += c.update arrValue[1], "hex", @general.encoding newValue += c.final @general.encoding</pre></div> Cast data type (boolean, number or string). <div class='highlight'><pre> if arrValue[0] is "bool" if newValue is "true" or newValue is "1" newValue = true else newValue = false else if arrValue[0] is "number" newValue = parseFloat newValue catch ex if @logger.console console.error "Settings.cryptoHelper", encrypt, filename, ex, currentValue</pre></div> Update settings property value. <div class='highlight'><pre> obj[prop] = newValue</pre></div> Remove <code>encrypted</code> property prior to decrypting. <div class='highlight'><pre> if not encrypt delete settingsJson["encrypted"]</pre></div> Process settings data. <div class='highlight'><pre> parser settingsJson</pre></div> Add <code>encrypted</code> property after file is encrypted. <div class='highlight'><pre> if encrypt settingsJson.encrypted = true</pre></div> Stringify and save the new settings file. <div class='highlight'><pre> newSettingsJson = JSON.stringify settingsJson, null, 4 if process.versions.node.indexOf(".10.") > 0 fs.writeFileSync filename, newSettingsJson, {encoding: @general.encoding} else fs.writeFileSync filename, newSettingsJson, @general.encoding return true</pre></div> Helper to encrypt the specified settings file. Please see <code>cryptoHelper</code> above. @param [String] filename The file to be encrypted. @param [Object] options Options to be passed to the cipher. @return [Boolean] Returns true if encryption OK, false if something went wrong. <div class='highlight'><pre> encrypt: (filename, options) => @cryptoHelper true, filename, options</pre></div> Helper to decrypt the specified settings file. Please see <code>cryptoHelper</code> above. @param [String] filename The file to be decrypted. @param [Object] options Options to be passed to the cipher. @return [Boolean] Returns true if decryption OK, false if something went wrong. <div class='highlight'><pre> decrypt: (filename, options) => @cryptoHelper false, filename, options</pre></div> <h2 id="file-watcher">FILE WATCHER</h2> Enable or disable the settings files watcher to auto reload settings when file changes. The <code>callback</code> is optional in case you want to notify another module about settings updates. @param [Boolean] enable If enabled is true activate the fs watcher, otherwise deactivate. @param [Method] callback A function (event, filename) triggered when a settings file changes. <div class='highlight'><pre> watch: (enable, callback) => if callback? and not lodash.isFunction callback throw new TypeError "The callback must be a valid function, or null/undefined." logToConsole = @general.debug and @logger.console</pre></div> Add / remove watcher for the @json file if it exists. <div class='highlight'><pre> filename = utils.getFilePath "settings.json" if filename? if enable fs.watchFile filename, {persistent: true}, (evt, filename) => @loadFromJson filename console.log "Settings.watch", filename, "Reloaded!" if logToConsole callback(evt, filename) if callback? else fs.unwatchFile filename, callback</pre></div> Add / remove watcher for the settings.NODE_ENV.json file if it exists. <div class='highlight'><pre> filename = utils.getFilePath "settings.#{@currentEnv.toString().toLowerCase()}.json" if filename? if enable fs.watchFile filename, {persistent: true}, (evt, filename) => @loadFromJson filename console.log "Settings.watch", filename, "Reloaded!" if logToConsole callback(evt, filename) if callback? else fs.unwatchFile filename, callback if logToConsole console.log "Settings.watch", enable, (if callback? then "With callback" else "No callback")</pre></div> <h2 id="paas">PAAS</h2> Update settings based on Cloud Environmental variables. If a <code>filter</code> is specified, update only settings that match it, otherwise update everything. @param [String] filter Filter settings to be updated, for example “mailer” or “database”. <div class='highlight'><pre> updateFromPaaS: (filter) => env = process.env filter = false if not filter? or filter is ""</pre></div> Update app IP and port (OpenShift, AppFog). <div class='highlight'><pre> if not filter or filter.indexOf("app") >= 0 ip = env.OPENSHIFT_NODEJS_IP or env.IP port = env.OPENSHIFT_NODEJS_PORT or env.VCAP_APP_PORT or env.PORT @app.ip = ip if ip? and ip isnt "" @app.port = port if port? and port isnt ""</pre></div> Update database settings (AppFog, MongoLab, MongoHQ). <div class='highlight'><pre> if not filter or filter.indexOf("database") >= 0 vcap = env.VCAP_SERVICES vcap = JSON.parse vcap if vcap?</pre></div> Check for AppFog MongoDB variables. <div class='highlight'><pre> if vcap? and vcap isnt "" mongo = vcap["mongodb-1.8"] mongo = mongo[0]["credentials"] if mongo? if mongo? @database.connString = "mongodb://#{mongo.hostname}:#{mongo.port}/#{mongo.db}"</pre></div> Check for MongoLab variables. <div class='highlight'><pre> mongoLab = env.MONGOLAB_URI @database.connString = mongoLab if mongoLab? and mongoLab isnt ""</pre></div> Check for MongoHQ variables. <div class='highlight'><pre> mongoHq = env.MONGOHQ_URL @database.connString = mongoHq if mongoHq? and mongoHq isnt ""</pre></div> Update logger settings (Logentries and Loggly). <div class='highlight'><pre> if not filter or filter.indexOf("logger") >= 0 logentriesToken = env.LOGENTRIES_TOKEN logglyToken = env.LOGGLY_TOKEN logglySubdomain = env.LOGGLY_SUBDOMAIN @logger.logentries.token = logentriesToken if logentriesToken? and logentriesToken isnt "" @logger.loggly.token = logglyToken if logglyToken? and logglyToken isnt "" @logger.loggly.subdomain = logglySubdomain if logglySubdomain? and logglySubdomain isnt ""</pre></div> Update mailer settings (SendGrid, Mandrill, Mailgun). <div class='highlight'><pre> if not filter or filter.indexOf("mail") >= 0 currentSmtpHost = @mailer.smtp.host?.toLowerCase() currentSmtpHost = "" if not currentSmtpHost?</pre></div> Get and set SendGrid. <div class='highlight'><pre> smtpUser = env.SENDGRID_USERNAME smtpPassword = env.SENDGRID_PASSWORD if currentSmtpHost.indexOf("sendgrid") >= 0 if currentSmtpHost is "sendgrid" @mailer.smtp.host = "smtp.sendgrid.net" @mailer.smtp.port = 587 @mailer.smtp.secure = false if smtpUser? and smtpUser isnt "" and smtpPassword? and smtpPassword isnt "" @mailer.smtp.user = smtpUser @mailer.smtp.password = smtpPassword</pre></div> Get and set Mandrill. <div class='highlight'><pre> smtpUser = env.MANDRILL_USERNAME smtpPassword = env.MANDRILL_APIKEY if currentSmtpHost.indexOf("mandrill") >= 0 if currentSmtpHost is "mandrill" @mailer.smtp.host = "smtp.mandrillapp.com" @mailer.smtp.port = 587 @mailer.smtp.secure = false if smtpUser? and smtpUser isnt "" and smtpPassword? and smtpPassword isnt "" @mailer.smtp.user = smtpUser @mailer.smtp.password = smtpPassword</pre></div> Get and set Mailgun. <div class='highlight'><pre> smtpHost = env.MAILGUN_SMTP_SERVER smtpPort = env.MAILGUN_SMTP_PORT smtpUser = env.MAILGUN_SMTP_LOGIN smtpPassword = env.MAILGUN_SMTP_PASSWORD if currentSmtpHost.indexOf("mailgun") >= 0 if smtpHost? and smtpHost isnt "" and smtpPort? and smtpPort isnt "" @mailer.smtp.host = smtpHost @mailer.smtp.port = smtpPort else if currentSmtpHost is "mailgun" @mailer.smtp.host = "smtp.mailgun.org" @mailer.smtp.port = 587 @mailer.smtp.secure = false if smtpUser? and smtpUser isnt "" and smtpPassword? and smtpPassword isnt "" @mailer.smtp.user = smtpUser @mailer.smtp.password = smtpPassword</pre></div> Log to console. <div class='highlight'><pre> if @general.debug and @logger.console console.log "Settings.updateFromPaaS", "Updated!", filter</pre></div> <h2 id="singleton-implementation">Singleton implementation</h2> <div class='highlight'><pre>Settings.getInstance = -> if not @instance? @instance = new Settings()</pre></div> Load default settings and force disable console log on test. <div class='highlight'><pre> @instance.load() @instance.logger.console = false if @instance.currentEnv is "test" return @instance module.exports = exports = Settings.getInstance()</pre></div> <div class="fleur">h</div> </div> </div> </body> </html>