expresser

<!DOCTYPE html> <html> <head> <title>utils.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>utils.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-utils">EXPRESSER UTILS</h2> General network, IO, client and server utilities. As this module can’t reference any other module but Settings, all its logging will be done to the console only. <div class='highlight'><pre>class Utils crypto = require "crypto" fs = require "fs" lodash = require "lodash" moment = require "moment" os = require "os" path = require "path" settings = require "./settings.coffee"</pre></div> <h2 id="server-info-utils">SERVER INFO UTILS</h2> Helper to get the correct filename for general files. For example the settings.json file or cron.json for cron jobs. This will look into the current directory, the running directory and the root directory of the app. Returns null if no file is found. @param [String] filename The base filename (with extension) of the config file. @return [String] The full path to the config file if one was found, or null. <div class='highlight'><pre> getFilePath: (filename) -> originalFilename = "./" + filename.toString() if fs.existsSync? exists = fs.existsSync else exists = path.existsSync</pre></div> Check if file exists. <div class='highlight'><pre> hasJson = exists filename return filename if hasJson</pre></div> Try current path.. <div class='highlight'><pre> filename = path.resolve __dirname, originalFilename hasJson = exists filename return filename if hasJson</pre></div> Try parent path.. <div class='highlight'><pre> filename = path.resolve __dirname, "../", originalFilename hasJson = exists filename return filename if hasJson</pre></div> If file does not exist on local path, try application root path. <div class='highlight'><pre> filename = path.resolve path.dirname(require.main.filename), originalFilename hasJson = exists filename return filename if hasJson</pre></div> Nothing found, so return null. <div class='highlight'><pre> return null</pre></div> Returns a list of valid server IP addresses. If <code>firstOnly</code> is true it will return only the very first IP address found. @param [Boolean] firstOnly Optional, default is false which returns an array with all valid IPs, true returns a String will first valid IP. @return The server IPv4 address, or null. <div class='highlight'><pre> getServerIP: (firstOnly) -> ifaces = os.networkInterfaces() result = []</pre></div> Parse network interfaces and try getting the server IPv4 address. <div class='highlight'><pre> for i of ifaces ifaces[i].forEach (details) -> if details.family is "IPv4" and not details.internal result.push details.address</pre></div> Return only first IP or all of them? <div class='highlight'><pre> if firstOnly return result[0] else return result</pre></div> Return an object with general information about the server. @return [Object] Results with process pid, platform, memory, uptime and IP. <div class='highlight'><pre> getServerInfo: => result = {}</pre></div> Save parsed OS info to the result object. <div class='highlight'><pre> result.uptime = moment.duration(process.uptime, "s").humanize() result.hostname = os.hostname() result.title = path.basename process.title result.platform = os.platform() + " " + os.arch() + " " + os.release() result.memoryTotal = (os.totalmem() / 1024 / 1024).toFixed(0) + " MB" result.memoryUsage = 100 - (os.freemem() / os.totalmem() * 100).toFixed(0) result.loadAvg = os.loadavg() result.ips = @getServerIP() result.process = {pid: process.pid, memoryUsage: (process.memoryUsage().rss / 1024 / 1024).toFixed(0) + " MB"} return result</pre></div> <h2 id="client-info-utils">CLIENT INFO UTILS</h2> Get the client or browser IP. Works for http and socket requests, even when behind a proxy. @param [Object] reqOrSocket The request or socket object. @return [String] The client IP address, or null. <div class='highlight'><pre> getClientIP: (reqOrSocket) -> return null if not reqOrSocket?</pre></div> Try getting the xforwarded header first. <div class='highlight'><pre> if reqOrSocket.header? xfor = reqOrSocket.header "X-Forwarded-For" if xfor? and xfor isnt "" return xfor.split(",")[0]</pre></div> Get remote address. <div class='highlight'><pre> if reqOrSocket.connection? return reqOrSocket.connection.remoteAddress else return reqOrSocket.remoteAddress</pre></div> Get the client’s device. This identifier string is based on the user agent. @param [Object] req The request object. @return [String] The client’s device. <div class='highlight'><pre> getClientDevice: (req) -> ua = req.headers["user-agent"]</pre></div> Find mobile devices. <div class='highlight'><pre> return "mobile-wp-8" if ua.indexOf("Windows Phone 8") > 0 return "mobile-wp-7" if ua.indexOf("Windows Phone 7") > 0 return "mobile-wp" if ua.indexOf("Windows Phone") > 0 return "mobile-iphone-5" if ua.indexOf("iPhone5") > 0 return "mobile-iphone-4" if ua.indexOf("iPhone4") > 0 return "mobile-iphone" if ua.indexOf("iPhone") > 0 return "mobile-android-5" if ua.indexOf("Android 5") > 0 return "mobile-android-4" if ua.indexOf("Android 4") > 0 return "mobile-android" if ua.indexOf("Android") > 0</pre></div> Find desktop browsers. <div class='highlight'><pre> return "desktop-chrome" if ua.indexOf("Chrome/") > 0 return "desktop-firefox" if ua.indexOf("Firefox/") > 0 return "desktop-safari" if ua.indexOf("Safari/") > 0 return "desktop-opera" if ua.indexOf("Opera/") > 0 return "desktop-ie-11" if ua.indexOf("MSIE 11") > 0 return "desktop-ie-10" if ua.indexOf("MSIE 10") > 0 return "desktop-ie-9" if ua.indexOf("MSIE 9") > 0 return "desktop-ie" if ua.indexOf("MSIE") > 0</pre></div> Return default desktop value if no specific devices were found on user agent. <div class='highlight'><pre> return "desktop"</pre></div> <h2 id="io-and-datautils">IO AND DATAUTILS</h2> Copy the <code>src</code> file to the <code>target</code>, both must be the full file path. @param [String] src The full source file path. @param [String] target The full target file path. <div class='highlight'><pre> copyFileSync: (src, target) => srcContents = fs.readFileSync src fs.writeFileSync target, srcContents</pre></div> Minify the passed JSON value. Removes comments, unecessary white spaces etc. @param [String] source The JSON text to be minified. @param [Boolean] asString If true, return as string instead of JSON object. @return [String] The minified JSON, or an empty string if there’s an error. <div class='highlight'><pre> minifyJson: (source, asString) -> source = JSON.stringify source if typeof source is "object" index = 0 length = source.length result = "" symbol = undefined position = undefined</pre></div> Main iterator. <div class='highlight'><pre> while index < length symbol = source.charAt index switch symbol</pre></div> Ignore whitespace tokens. According to ES 5.1 section 15.12.1.1, whitespace tokens include tabs, carriage returns, line feeds, and space characters. <div class='highlight'><pre> when "\t", "\r" , "\n" , " " index += 1</pre></div> Ignore line and block comments. <div class='highlight'><pre> when "/" symbol = source.charAt(index += 1) switch symbol</pre></div> Line comments. <div class='highlight'><pre> when "/" position = source.indexOf("\n", index)</pre></div> Check for CR-style line endings. <div class='highlight'><pre> position = source.indexOf("\r", index) if position < 0 index = (if position > -1 then position else length)</pre></div> Block comments. <div class='highlight'><pre> when "*" position = source.indexOf("*/", index) if position > -1</pre></div> Advance the scanner’s position past the end of the comment. <div class='highlight'><pre> index = position += 2 break throw SyntaxError("Unterminated block comment.") else throw SyntaxError("Invalid comment.")</pre></div> Parse strings separately to ensure that any whitespace characters and JavaScript-style comments within them are preserved. <div class='highlight'><pre> when "\"" position = index while index < length symbol = source.charAt(index += 1) if symbol is "\\"</pre></div> Skip past escaped characters. <div class='highlight'><pre> index += 1 else break if symbol is "\"" if source.charAt(index) is "\"" result += source.slice(position, index += 1) break throw SyntaxError("Unterminated string.")</pre></div> Preserve all other characters. <div class='highlight'><pre> else result += symbol index += 1</pre></div> Check if should return as string or JSON. <div class='highlight'><pre> if asString return result else return JSON.parse result</pre></div> Helper to convert HSL colour to HEX. Used by Philips Hue and other colored lights. @param [Number] h The hue value. @param [Number] s The saturation value. @param [Number] l The brightness value. @return [String] The colour in HEX format. <div class='highlight'><pre> hslToHex: (h, s, l) -> x = h y = s z = 1.0 - x - y Y = l X = (Y / y) * x Z = (Y / y) * z r = X * 1.612 - Y * 0.203 - Z * 0.302 g = -X * 0.509 + Y * 1.412 + Z * 0.066 b = X * 0.026 - Y * 0.072 + Z * 0.962 r = (if r <= 0.0031308 then 12.92 * r else (1.0 + 0.055) * Math.pow(r, (1.0 / 2.4)) - 0.055) g = (if g <= 0.0031308 then 12.92 * g else (1.0 + 0.055) * Math.pow(g, (1.0 / 2.4)) - 0.055) b = (if b <= 0.0031308 then 12.92 * b else (1.0 + 0.055) * Math.pow(b, (1.0 / 2.4)) - 0.055) cap = (x) -> Math.max 0, Math.min(1, x)</pre></div> Helper to convert RGB to hex. <div class='highlight'><pre> rgbhex = (v) -> v = Math.round(v * 255) s = "0" + v.toString(16) return s.substr -2</pre></div> Cap and transform RGB values. <div class='highlight'><pre> r = rgbhex cap r g = rgbhex cap g b = rgbhex cap b</pre></div> Convert RGB to hex and return result. <div class='highlight'><pre> return "##{r}#{g}#{b}"</pre></div> <h2 id="singleton-implementation">Singleton implementation</h2> <div class='highlight'><pre>Utils.getInstance = -> @instance = new Utils() if not @instance? return @instance module.exports = exports = Utils.getInstance()</pre></div> <div class="fleur">h</div> </div> </div> </body> </html>