File: platform/plugins/Users/classes/Users/User.js

/**
 * Class representing user rows.
 *
 * @module Users
 */
var Q = require('Q');
var Db = Q.require('Db');
var Users = Q.require('Users');

/**
 * Class representing 'User' rows in the 'Users' database
 * @namespace Users
 * @class User
 * @extends Base.Users.User
 * @constructor
 * @param fields {object} The fields values to initialize table row as
 * an associative array of `{column: value}` pairs
 */
function Users_User (fields) {

	// Run constructors of mixed in objects
	Users_User.constructors.apply(this, arguments);

	/*
	 * Add any privileged methods to the model class here.
	 * Public methods should probably be added further below.
	 * If file 'User.js.inc' exists, its content is included
	 * * * */

	/* * * */
}

/**
 * Get all the socket clients that a user has online
 * @method clientsOnline
 * @static
 * @param {String} userId The id of a user
 * @param {String} [sessionId] Optionally provide a session id, to filter clients by
 * @return {Object} Contains {clientId: client} pairs
 */
Users_User.clientsOnline = function(userId, sessionId) {
	var clients = Users.clients[userId] || {};
	if (!sessionId) {
	    return clients;
	}
	var result = {};
	for (var cid in clients) {
		if (clients[cid].sessionId === sessionId) {
			result[cid] = clients[cid];
		}
	}
	return result;
};

/**
 * Gets an array of all devices associated with userId and passes it to callback.
 * Data is filtered for platforms listed in config array {App}/cordova/platforms
 * @method devices
 * @static
 * @param {String} userId The id of a user
 * @param {Object} appIds An object of {platform: appIds} pairs, where
 *   keys are the names of a platform in "Users"/"apps"/"platforms" array,
 *   and values are a string or array with the external app id registered with the platform.
 * @param {Function} callback The first parameter contains {platformName: devicesArray}
 */
Users_User.devices = function (userId, appIds, callback) {
	var p = new Q.Pipe();
	var waitFor = [];
	for (var platform in appIds) {
		waitFor.push(platform);
		Users.Device.SELECT('*').where({
			userId: userId,
			platform: platform,
			appId: appIds[platform]
		}).execute(p.fill(platform));
	}
	p.add(waitFor, 1, function(params, subjects) {
		var devices = {};
		for (platform in params) {
			var p = params[platform];
			var err = p[0], rows = p[1];
			if (err) {
				return;
			}
			if (!devices[platform]) {
			    devices[platform] = [];
			}
			for (var i=0; i<rows.length; i++) {
				devices[platform].push(rows[i].fields.deviceId);
			}
		}
		callback.call(Users, devices);
	})
};

/**
 * Calculate the url of a user's icon
 * @method
 * @param {Number} [size=40] the size of the icon to render.
 * @return {String} the url
 */
Users_User.prototype.iconUrl = function Users_User_iconUrl(size) {
	return Users.iconUrl(this.fields.icon.interpolate({
		userId: this.fields.id.splitId()
	}), size);
};

Q.mixin(Users_User, Q.require('Base/Users/User'));

/*
 * Add any public methods here by assigning them to Users_User.prototype
 */

 /**
  * The setUp() method is called the first time
  * an object of this class is constructed.
  * @method setUp
  */
 Users_User.prototype.setUp = function () {
 	// put any code here
 	// overrides the Base class
 };

module.exports = Users_User;