spreed-webrtc/static/js/services/buddylist.js

/*
 * Spreed WebRTC.
 * Copyright (C) 2013-2014 struktur AG
 *
 * This file is part of Spreed WebRTC.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
define(['jquery', 'angular', 'underscore', 'modernizr', 'avltree', 'text!partials/buddy.html', 'text!partials/buddyactions.html', 'text!partials/buddyactionsforaudiomixer.html'], function($, angular, _, Modernizr, AvlTree, templateBuddy, templateBuddyActions, templateBuddyActionsForAudioMixer) {

	var BuddyTree = function() {

		this.data = {};
		this.tree = new AvlTree(function(a, b) {
			return a.sort.localeCompare(b.sort);
		});

	};

	BuddyTree.prototype.create = function(id, scope) {

		var display = scope.display || {};
		var sort = display.displayName ? display.displayName : "session " + scope.buddyIndexSortable + " " + id;
		var data = {
			id: id,
			sort: sort + "z" + id
		}
		return data;

	};

	BuddyTree.prototype.add = function(id, scope) {

		var data = this.create(id, scope);
		this._add(id, data);
		return this.position(id);

	};

	BuddyTree.prototype._add = function(id, data) {

		if (this.tree.add(data)) {
			this.data[id] = data;
		}

	};


	BuddyTree.prototype.remove = function(id) {

		if (this.data.hasOwnProperty(id)) {
			this.tree.remove(this.data[id]);
			delete this.data[id];
		}

	};

	BuddyTree.prototype.check = function(id) {

		return this.data.hasOwnProperty(id);

	};

	/**
	 * Returns undefined when no change required. Position result otherwise.
	 */
	BuddyTree.prototype.update = function(id, scope) {

		var current = this.data[id];
		if (!current) {
			return this.add(id, scope);
		}
		var data = this.create(id, scope);
		if (data.sort !== current.sort) {
			this.tree.remove(current);
			this._add(id, data);
			return this.position(id);
		}

		return undefined;

	};

	/**
	 * Returns null when end position. Id of element to insert before otherwise.
	 */
	BuddyTree.prototype.position = function(id) {

		var result = null;
		this.tree.inOrderTraverse(function(c) {
			if (c.id !== id) {
				result = c.id;
				return true;
			}
		}, this.data[id]);
		return result;

	};

	BuddyTree.prototype.traverse = function(cb) {

		return this.tree.inOrderTraverse(cb);

	};

	BuddyTree.prototype.keys = function() {

		return _.keys(this.data);

	};

	BuddyTree.prototype.clear = function() {

		this.tree.clear();
		this.data = {};

	};

	// buddyList
	return ["$window", "$compile", "playSound", "buddyData", "buddySession", "buddyPicture", "fastScroll", "mediaStream", "animationFrame", "$q", function($window, $compile, playSound, buddyData, buddySession, buddyPicture, fastScroll, mediaStream, animationFrame, $q) {

		var buddyTemplate = $compile(templateBuddy);
		var buddyActions = $compile(templateBuddyActions);
		var buddyActionsForAudioMixer = $compile(templateBuddyActionsForAudioMixer);

		//console.log("$buddylist $get");
		var doc = $window.document;
		var buddyCount = 0;

		var Buddylist = function($element, $scope, opts) {

			this.$scope = $scope;
			this.$element = $element.find(".buddycontainer > div");
			this.options = angular.extend({}, opts);
			this.$element.empty();
			this.actionElements = {};
			this.tree = new BuddyTree();
			this.queue = [];
			this.lefts = {};
			this.playSoundLeft = false;
			this.playSoundJoined = false;
			fastScroll.apply($element, this.$element);
			$element.on("mouseenter mouseleave", ".buddy", _.bind(function(event) {
				// Hover handler for on Buddy actions.
				var buddyElement = $(event.currentTarget);
				this.hover(buddyElement, event.type === "mouseenter" ? true : false);
			}, this));
			$element.on("click", ".buddy", _.bind(function(event) {
				var buddyElement = $(event.currentTarget);
				this.click(buddyElement, event.target);
			}, this));
			$element.attr("data-xthreshold", "10");
			$element.on("swipeleft", ".buddy", _.bind(function(event) {
				event.preventDefault();
				var buddyElement = $(event.currentTarget);
				this.hover(buddyElement, !buddyElement.hasClass("hovered"));
			}, this));

			$window.setInterval(_.bind(this.soundLoop, this), 500);
			var update = _.bind(function refreshBuddies() {
				this.refreshBuddies();
			}, this);
			animationFrame.register(update);

		};

		Buddylist.prototype.addBuddyElementToScope = function(scope, before, container) {

			if (!container) {
				container = this.$element[0];
			}
			buddyTemplate(scope, function($clonedElement, $scope) {
				//console.log("create", $scope.displayName, before)
				if (before) {
					// Insert directly before another node.
					var beforeScope = buddyData.get(before);
					if (beforeScope && beforeScope.element) {
						container.insertBefore($clonedElement[0], beforeScope.element[0]);
					} else {
						// Append to end assuming before element was removed. Can this happen?
						container.appendChild($clonedElement[0]);
					}
				} else {
					// Append to end.
					container.appendChild($clonedElement[0]);
				}
				$scope.element = $clonedElement;
			});

		};

		Buddylist.prototype.onBuddyScopeCreated = function(scope, data) {

			// Init scope with our stuff.
			scope.element = null;
			scope.contact = null;
			scope.display = {};
			scope.session = buddySession.create(data);
			scope.$on("$destroy", function() {
				//console.log("destroyed");
				scope.element = null;
				scope.killed = true;
			});

		};

		Buddylist.prototype.onBuddySessionUserid = function(scope, sourceSession) {

			//console.log("session with userid", sourceSession);

			var userid = sourceSession.Userid;
			/*
			if (userid === scope.userid) {
				// The source session has our own userid, ignore it.

			}*/
			var targetScope = buddyData.get(userid);
			if (!targetScope) {
				// No scope for this userid yet - set us.
				buddyData.set(userid, scope);
				//console.log("set scope with userid", sourceSession);
				return;
			}
			var session = targetScope.session;
			if (sourceSession === session) {
				// No action.
				//console.log("source session same as target");
				return;
			}
			// Merge sessions.
			session.merge(sourceSession);
			// Cleanup old from tree and DOM.
			var id = sourceSession.Id;
			this.tree.remove(id);
			if (targetScope !== scope) {
				if (scope.element) {
					this.lefts[id] = scope.element;
					//console.log("destroying", id, scope.element);
					scope.$destroy();
				}
				buddyData.set(id, targetScope);
				delete this.actionElements[id];
				return targetScope;
			}
			return;

		};

		Buddylist.prototype.soundLoop = function() {

			if (this.playSoundLeft) {
				playSound.play("left");
				this.playSoundLeft = false;
			}
			if (this.playSoundJoined) {
				playSound.play("joined");
				this.playSoundJoined = false;
			}

		};

		Buddylist.prototype.refreshBuddies = function() {

			//console.log("processing", this.queue.length);
			var processed = 0;
			var entry;
			var scope;
			var id;
			var before;
			var action;
			var not_exists;

			// Cleanup lefts.
			var lefts = this.lefts;
			if (!_.isEmpty(lefts)) {
				_.each(lefts, function(element, k) {
					if (element) {
						element.remove();
					}
				});
				this.lefts = {};
			}

			var refresh = false;
			var queue = this.queue;

			if (queue.length) {

				//var $element = this.$element;
				var container = this.$element[0];

				while (true) {

					entry = queue.shift();
					if (!entry) {
						// Queue empty.
						break;
					}

					id = entry[1];
					scope = null;

					if (id) {
						scope = buddyData.lookup(id, false);
						if (!scope || scope.killed) {
							continue;
						}
					}

					action = entry[0];
					before = entry[2];

					not_exists = scope.element ? false : true;

					if (not_exists) {
						this.addBuddyElementToScope(scope, before, container);
					} else {
						if (typeof(before) === "undefined") {
							// No action when undefined.
						} else if (before) {
							// Move directly before another node.
							var beforeScope = buddyData.get(before);
							if (beforeScope && beforeScope.element) {
								container.insertBefore(scope.element[0], beforeScope.element[0]);
							} else {
								// Move to end, assuming before element was removed.
								container.appendChild(scope.element[0]);
							}
						} else {
							// Move to end.
							container.appendChild(scope.element[0]);
						}
					}

					processed++;
					refresh = true;
					if (processed > 10) {
						break;
					}

				}

			}

			scope = this.$scope;
			var apply = refresh;
			var loading = scope.loading;
			if (refresh) {
				if (!loading) {
					scope.loading = true;
				}
			} else {
				if (scope.loading) {
					scope.loading = false;
					apply = true;
				}
			}
			var empty = buddyCount === 0;
			if (empty != scope.empty) {
				scope.empty = empty;
				apply = true;
			}
			if (apply) {
				scope.$apply();
			}

		};

		Buddylist.prototype.setDisplay = function(id, scope, data, queueName) {

			var status = data.Status;
			var display = scope.display;
			// Set display.name.
			display.displayName = status.displayName;
			// Set display.picture.
			buddyPicture.update(display, status.buddyPicture);
			// Set display subline.
			this.updateSubline(display, status.message);
			// Add to render queue when no element exists.
			if (!scope.element) {
				var before = this.tree.add(id, scope);
				this.queue.push([queueName, id, before]);
				this.playSoundJoined = true;
			}

		};

		Buddylist.prototype.updateDisplay = function(id, scope, data, queueName) {

			//console.log("updateDisplay", data, scope);
			var status = data.Status;
			if (!status) {
				return;
			}

			var display = scope.display;
			var contact = scope.contact && scope.contact.Status;
			// Update display name.
			var displayName = display.displayName;
			if (contact) {
				display.displayName = contact.displayName;
			} else if (status.displayName) {
				display.displayName = status.displayName;
			} else {
				display.displayName = null;
			}
			// Add to status queue if sorting has changed.
			if (displayName !== status.displayName) {
				var before = this.tree.update(id, scope);
				this.queue.push([queueName, id, before]);
			}
			// Update display subline.
			if (status.message) {
				this.updateSubline(display, status.message);
			}
			// Update display picture.
			if (contact) {
				buddyPicture.update(display, contact.buddyPicture || status.buddyPicture || null);
			} else if (status.buddyPicture) {
				buddyPicture.update(display, status.buddyPicture || null);
			}

		};

		Buddylist.prototype.updateSubline = function(display, s) {

			if (!s || s === "__e") {
				display.subline = "";
				return;
			}
			if (s.length > 20) {
				display.sublineFull = s;
				s = s.substr(0, 20) + "...";
			} else {
				display.sublineFull = null;
			}
			display.subline = s;

		};

		Buddylist.prototype.onContactUpdated = function(data) {
			var scope = buddyData.get(data.Userid);
			if (scope && scope.contact) {
				scope.contact.Status = angular.extend(scope.contact.Status, data.Status);
			}
			this.updateDisplay(data.Id, scope, data, "status");
			//console.log("onContactUpdated", 'data', data, 'scope', scope);
		};

		Buddylist.prototype.onStatus = function(data) {

			//console.log("onStatus", data);
			var id = data.Id;
			var scope = buddyData.get(id, this.$scope, _.bind(function(scope) {
				this.onBuddyScopeCreated(scope, data);
			}, this), data.Userid);
			// Update session.
			var sessionData = scope.session.update(id, data, _.bind(function(session) {
				//console.log("Session is now authenticated", session);
				var newscope = this.onBuddySessionUserid(scope, session);
				if (newscope) {
					scope = newscope;
				}
			}, this));
			if (sessionData) {
				// onStatus for main session.
				this.updateDisplay(id, scope, sessionData, "status");
			}
			scope.$apply();
			return scope;

		};

		Buddylist.prototype.onJoined = function(data, noApply) {

			//console.log("Joined", data);
			var id = data.Id;
			var scope = buddyData.get(id, this.$scope, _.bind(function(scope) {
				this.onBuddyScopeCreated(scope, data);
			}, this), data.Userid);
			// Update session.
			buddyCount++;
			var sessionData = scope.session.update(id, data, _.bind(function(session) {
				//console.log("Session is now authenticated", session);
				var newscope = this.onBuddySessionUserid(scope, session);
				if (newscope) {
					scope = newscope;
				}
			}, this));
			if (sessionData && sessionData.Status) {
				this.setDisplay(id, scope, sessionData, "joined");
			} else if (!noApply) {
				scope.$apply();
			}
			return scope;

		};


		Buddylist.prototype.onLeft = function(data, force, noApply) {

			//console.log("Left", data);
			var id = data.Id;
			var scope = buddyData.get(id);
			if (!scope) {
				//console.warn("Trying to remove buddy with no registered scope", session);
				return;
			}
			// Remove current id from tree.
			this.tree.remove(id);
			buddyData.del(id);
			// Remove session.
			var session = scope.session;
			if ((session.remove(id) && scope.contact === null) || force) {
				// No session left. Cleanup.
				if (scope.element) {
					this.lefts[id] = scope.element;
					this.playSoundLeft = true;
				}
				if (session.Userid) {
					buddyData.del(session.Userid, true);
				}
				delete this.actionElements[id];
				scope.$destroy();
				if (buddyCount > 0) {
					buddyCount--;
				}
			} else {
				// Update display stuff if a session is left. This can
				// return no session in case when we got this as contact.
				var sessionData = session.get();
				if (sessionData) {
					this.updateDisplay(sessionData.Id, scope, sessionData, "status");
				} else if (scope.contact) {
					var contact = scope.contact;
					// Use it with userid as id in tree.
					if (!this.tree.check(contact.Userid)) {
						this.tree.add(contact.Userid, scope);
						buddyCount++;
					}
					if (contact.Status !== null && !contact.Status.message) {
						// Remove status message.
						contact.Status.message = "__e";
					}
					this.updateDisplay(contact.Userid, scope, contact, "status");
				}
				if (!noApply) {
					scope.$apply();
				}
			}
			return scope;

		};

		Buddylist.prototype.onClosed = function() {

			//console.log("Closed");

			// Remove pending stuff from queue.
			this.queue = [];

			// Trigger left events for all sessions.
			var data = {};
			var sessions = buddySession.sessions();
			for (var id in sessions) {
				if (sessions.hasOwnProperty(id)) {
					//console.log("close id", id);
					data.Id = id;
					this.onLeft(data, false, true);
				}
			}

		};

		Buddylist.prototype.onContactAdded = function(contact) {

			//console.log("onContactAdded", contact);
			var userid = contact.Userid;

			var scope = buddyData.get(userid);
			if (scope) {
				scope.contact = contact;
				var sessionData = scope.session.get();
				if (sessionData) {
					if (contact.Status === null && sessionData.Status) {
						// Update contact status with session.Status
						var status = contact.Status = _.extend({}, sessionData.Status);
						// Remove status message.
						delete status.message;
						// Convert buddy image.
						if (status.buddyPicture) {
							var img = buddyPicture.toString(scope.element.find(".buddyPicture img").get(0));
							if (img) {
								status.buddyPicture = img;
							} else {
								delete status.buddyPicture;
							}
						}
						console.log("Injected status into contact", contact);
					}
					this.updateDisplay(sessionData.Id, scope, contact, "status");
					scope.$apply();
				}
			} else {
				// Create new scope for contact.
				scope = this.onJoined({
					Id: contact.Userid,
					Userid: contact.Userid,
					Status: _.extend({}, contact.Status)
				});
				scope.contact = contact;
			}

		};

		Buddylist.prototype.onContactRemoved = function(contact) {

			//console.log("onContactRemoved", contact);
			var userid = contact.Userid;

			var scope = buddyData.get(userid);
			if (scope) {
				scope.contact = null;
				// Remove with left when no session for this userid.
				var sessionData = scope.session.get();
				if (!sessionData) {
					// Force left.
					this.onLeft({Id: userid}, true);
				}
			}

		};

		Buddylist.prototype.click = function(buddyElement, target) {

			var be = buddyElement.get(0);
			// Traverse up to find click action.
			var action;
			do {
				action = $(target).data("action");
				target = $(target).parent().get(0);
			} while (!action && target && target !== be);

			// Make call the default action.
			if (!action) {
				action = "chat";
			}

			var scope = buddyElement.scope();
			var session = scope.session;
			var contact = scope.contact;

			var promise = (function() {
				var deferred = $q.defer();
				var sessionData = session.get()
				if (!sessionData) {
					// Find session with help of contact.
					if (contact && contact.Token) {
						mediaStream.api.sendSessions(contact.Token, "contact", function(event, type, data) {
							//console.log("oooooooooooooooo", type, data);
							var tmpSessionData = null;
							if (data.Users && data.Users.length > 0) {
								/*
								_.each(data.Users, function(s) {
									buddyData.set(s.Id, scope);
									// NOTE(longsleep): Not sure if its a good idea to add the retrieved sessions here.
									session.add(s.Id, s);
								});
								sessionData = session.get();
								deferred.resolve(sessionData.Id);
								*/
								tmpSessionData = data.Users[0];
							}
							// Check if we got a session in the meantime.
							sessionData = session.get();
							if (!sessionData && tmpSessionData) {
								// Use temporary session as received.
								buddyData.set(tmpSessionData.Id, scope);
								sessionData = tmpSessionData;
							}
							if (sessionData) {
								// Resolve with whatever we found.
								deferred.resolve(sessionData.Id);
							}
						});
					}
				} else {
					deferred.resolve(sessionData.Id);
				}
				return deferred.promise;
			})();

			switch (action) {
			case "call":
				promise.then(function(id) {
					scope.doCall(id);
				});
				break;
			case "chat":
				promise.then(function(id) {
					scope.doChat(id);
				});
				break;
			case "contact":
				if (contact) {
					scope.doContactRemove(contact.Userid);
				} else {
					promise.then(function(id) {
						scope.doContactRequest(id);
					});
				}
				break;
			}

		};

		Buddylist.prototype.hover = function(buddyElement, hover) {

			//console.log("hover handler", buddyElement, hover);
			var scope = buddyElement.scope();
			var id = scope.session.Id;
			var buddy = $(buddyElement);
			var actionElements = this.actionElements;
			var elem;
			if (!hover) {
				buddy.removeClass("hovered");
				setTimeout(_.bind(function() {
					if (!buddy.hasClass("hovered")) {
						elem = actionElements[id];
						if (elem) {
							delete actionElements[id];
							elem.remove();
							//console.log("cleaned up actions", id);
						}
					}
				}, this), 1000);
			} else {
				elem = actionElements[id];
				if (elem) {
					buddy.addClass("hovered");
				} else {
					var template = buddyActions;
					//if (scope.status.autoCalls && _.indexOf(scope.status.autoCalls, "conference") !== -1) {
					//	template = buddyActionsForAudioMixer;
					//}
					//console.log("scope", scope, id);
					template(scope, _.bind(function(clonedElement, $scope) {
						actionElements[id] = clonedElement;
						buddy.append(clonedElement);
						_.defer(function() {
							buddy.addClass("hovered");
						});
					}, this));
					scope.$apply();
				}
			}

		};

		return {
			buddylist: function($element, $scope, opts) {
				return new Buddylist($element, $scope, opts);
			}
		}

	}];

});