sails/lib/app/Sails.js

API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)

/**
 * Module dependencies.
 */

var util = require('util');
var events = require('events');
var _ = require('@sailshq/lodash');
var CaptainsLog = require('captains-log');
var loadSails = require('./load');
var mixinAfter = require('./private/after');
var __Router = require('../router');



/**
 * Construct a Sails (app) instance.
 *
 * @constructor
 */

function Sails() {

  // Inherit methods from EventEmitter
  events.EventEmitter.call(this);

  // Remove memory-leak warning about max listeners
  // See: http://nodejs.org/docs/latest/api/events.html#events_emitter_setmaxlisteners_n
  this.setMaxListeners(0);

  // Keep track of spawned child processes
  this.childProcesses = [];

  // Ensure CaptainsLog exists
  this.log = CaptainsLog();

  // Keep a hash of loaded actions
  this._actions = {};

  // Keep a hash of loaded action middleware
  this._actionMiddleware = {};

  // Build a Router instance (which will attach itself to the sails object)
  __Router(this);

  // Mixin `load()` method to load the pieces
  // of a Sails app
  this.load = loadSails(this);

  // Mixin support for `Sails.prototype.after()`
  mixinAfter(this);

  // Bind `this` context for all `Sails.prototype.*` methods
  this.load = _.bind(this.load, this);
  this.request = _.bind(this.request, this);
  this.lift = _.bind(this.lift, this);
  this.lower = _.bind(this.lower, this);
  this.initialize = _.bind(this.initialize, this);
  this.exposeGlobals = _.bind(this.exposeGlobals, this);
  this.runBootstrap = _.bind(this.runBootstrap, this);
  this.isLocalSailsValid = _.bind(this.isLocalSailsValid, this);
  this.isSailsAppSync = _.bind(this.isSailsAppSync, this);
  this.inspect = _.bind(this.inspect, this);
  this.toString = _.bind(this.toString, this);
  this.toJSON = _.bind(this.toJSON, this);
  this.all = _.bind(this.all, this);
  this.get = _.bind(this.get, this);
  this.post = _.bind(this.post, this);
  this.put = _.bind(this.put, this);
  this['delete'] = _.bind(this['delete'], this);
  this.getActions = _.bind(this.getActions, this);
  this.registerAction = _.bind(this.registerAction, this);
  this.registerActionMiddleware = _.bind(this.registerActionMiddleware, this);
  this.reloadActions = _.bind(this.reloadActions, this);

}


// Extend from EventEmitter to allow hooks to listen to stuff
util.inherits(Sails, events.EventEmitter);


// Public methods
////////////////////////////////////////////////////////

Sails.prototype.lift = require('./lift');

Sails.prototype.lower = require('./lower');

Sails.prototype.getRouteFor = require('./get-route-for');
Sails.prototype.getUrlFor = require('./get-url-for');

Sails.prototype.reloadActions = require('./reload-actions');

Sails.prototype.getActions = require('./get-actions');
Sails.prototype.registerAction = require('./register-action');
Sails.prototype.registerActionMiddleware = require('./register-action-middleware');


// Public properties
////////////////////////////////////////////////////////

// Regular expression to match request paths that look like assets.
Sails.prototype.LOOKS_LIKE_ASSET_RX = /^[^?]*\/[^?\/]+\.[^?\/]+(\?.*)?$/;


// Experimental methods
////////////////////////////////////////////////////////

Sails.prototype.request = require('./request');


// Expose Express-esque synonyms for low-level usage of router
Sails.prototype.all = function(path, action) {
  this.router.bind(path, action);
  return this;
};
Sails.prototype.get = function(path, action) {
  this.router.bind(path, action, 'get');
  return this;
};
Sails.prototype.post = function(path, action) {
  this.router.bind(path, action, 'post');
  return this;
};
Sails.prototype.put = function(path, action) {
  this.router.bind(path, action, 'put');
  return this;
};
Sails.prototype.del = Sails.prototype['delete'] = function(path, action) {
  this.router.bind(path, action, 'delete');
  return this;
};


/**
 * .getRc()
 *
 * Get a dictionary of config from env vars, CLI opts, and `.sailsrc` file(s).
 *
 * @returns {Dictionary}
 */

Sails.prototype.getRc = require('./configuration/rc');


// FUTURE: expose a flavored version of sails-generate as `.generate()`
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// ```
// Sails.prototype.generate = function (){ /* ... */ };
// ```
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -




// Private methods:
////////////////////////////////////////////////////////

Sails.prototype.initialize = require('./private/initialize');
Sails.prototype.exposeGlobals = require('./private/exposeGlobals');
Sails.prototype.runBootstrap = require('./private/bootstrap');
Sails.prototype.isLocalSailsValid = require('./private/isLocalSailsValid');
Sails.prototype.isSailsAppSync = require('./private/isSailsAppSync');



// Presentation methods:
////////////////////////////////////////////////////////
Sails.prototype.inspect = require('./private/inspect');
Sails.prototype.toString = require('./private/toString');
Sails.prototype.toJSON = require('./private/toJSON');



// Expose Sails constructor:
////////////////////////////////////////////////////////
module.exports = Sails;