645 lines
22 KiB
JavaScript
645 lines
22 KiB
JavaScript
/*
|
|
Copyright 2014 OpenMarket Ltd
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
/*
|
|
This service wraps up Matrix API calls.
|
|
|
|
This serves to isolate the caller from changes to the underlying url paths, as
|
|
well as attach common params (e.g. access_token) to requests.
|
|
*/
|
|
angular.module('matrixService', [])
|
|
.factory('matrixService', ['$http', '$q', '$rootScope', function($http, $q, $rootScope) {
|
|
|
|
/*
|
|
* Permanent storage of user information
|
|
* The config contains:
|
|
* - homeserver url
|
|
* - Identity server url
|
|
* - user_id
|
|
* - access_token
|
|
* - version: the version of this cache
|
|
*/
|
|
var config;
|
|
|
|
var roomIdToAlias = {};
|
|
var aliasToRoomId = {};
|
|
|
|
// Current version of permanent storage
|
|
var configVersion = 0;
|
|
var prefixPath = "/_matrix/client/api/v1";
|
|
var MAPPING_PREFIX = "alias_for_";
|
|
|
|
var doRequest = function(method, path, params, data, $httpParams) {
|
|
if (!config) {
|
|
console.warn("No config exists. Cannot perform request to "+path);
|
|
return;
|
|
}
|
|
|
|
// Inject the access token
|
|
if (!params) {
|
|
params = {};
|
|
}
|
|
|
|
params.access_token = config.access_token;
|
|
|
|
if (path.indexOf(prefixPath) !== 0) {
|
|
path = prefixPath + path;
|
|
}
|
|
|
|
return doBaseRequest(config.homeserver, method, path, params, data, undefined, $httpParams);
|
|
};
|
|
|
|
var doBaseRequest = function(baseUrl, method, path, params, data, headers, $httpParams) {
|
|
|
|
var request = {
|
|
method: method,
|
|
url: baseUrl + path,
|
|
params: params,
|
|
data: data,
|
|
headers: headers
|
|
};
|
|
|
|
// Add additional $http parameters
|
|
if ($httpParams) {
|
|
angular.extend(request, $httpParams);
|
|
}
|
|
|
|
return $http(request);
|
|
};
|
|
|
|
return {
|
|
/****** Home server API ******/
|
|
prefix: prefixPath,
|
|
|
|
// Register an user
|
|
register: function(user_name, password, threepidCreds, useCaptcha) {
|
|
// The REST path spec
|
|
var path = "/register";
|
|
|
|
var data = {
|
|
user_id: user_name,
|
|
password: password,
|
|
threepidCreds: threepidCreds
|
|
};
|
|
|
|
if (useCaptcha) {
|
|
// Not all home servers will require captcha on signup, but if this flag is checked,
|
|
// send captcha information.
|
|
// TODO: Might be nice to make this a bit more flexible..
|
|
var challengeToken = Recaptcha.get_challenge();
|
|
var captchaEntry = Recaptcha.get_response();
|
|
var captchaType = "m.login.recaptcha";
|
|
|
|
data.captcha = {
|
|
type: captchaType,
|
|
challenge: challengeToken,
|
|
response: captchaEntry
|
|
};
|
|
}
|
|
|
|
return doRequest("POST", path, undefined, data);
|
|
},
|
|
|
|
// Create a room
|
|
create: function(room_alias, visibility) {
|
|
// The REST path spec
|
|
var path = "/createRoom";
|
|
|
|
var req = {
|
|
"visibility": visibility
|
|
};
|
|
if (room_alias) {
|
|
req.room_alias_name = room_alias;
|
|
}
|
|
|
|
return doRequest("POST", path, undefined, req);
|
|
},
|
|
|
|
// Get the user's current state: his presence, the list of his rooms with
|
|
// the last {limit} events
|
|
initialSync: function(limit, feedback) {
|
|
// The REST path spec
|
|
|
|
var path = "/initialSync";
|
|
|
|
var params = {};
|
|
if (limit) {
|
|
params.limit = limit;
|
|
}
|
|
if (feedback) {
|
|
params.feedback = feedback;
|
|
}
|
|
|
|
return doRequest("GET", path, params);
|
|
},
|
|
|
|
// Joins a room
|
|
join: function(room_id) {
|
|
return this.membershipChange(room_id, undefined, "join");
|
|
},
|
|
|
|
joinAlias: function(room_alias) {
|
|
var path = "/join/$room_alias";
|
|
room_alias = encodeURIComponent(room_alias);
|
|
|
|
path = path.replace("$room_alias", room_alias);
|
|
|
|
// TODO: PUT with txn ID
|
|
return doRequest("POST", path, undefined, {});
|
|
},
|
|
|
|
// Invite a user to a room
|
|
invite: function(room_id, user_id) {
|
|
return this.membershipChange(room_id, user_id, "invite");
|
|
},
|
|
|
|
// Leaves a room
|
|
leave: function(room_id) {
|
|
return this.membershipChange(room_id, undefined, "leave");
|
|
},
|
|
|
|
membershipChange: function(room_id, user_id, membershipValue) {
|
|
// The REST path spec
|
|
var path = "/rooms/$room_id/$membership";
|
|
path = path.replace("$room_id", encodeURIComponent(room_id));
|
|
path = path.replace("$membership", encodeURIComponent(membershipValue));
|
|
|
|
var data = {};
|
|
if (user_id !== undefined) {
|
|
data = { user_id: user_id };
|
|
}
|
|
|
|
// TODO: Use PUT with transaction IDs
|
|
return doRequest("POST", path, undefined, data);
|
|
},
|
|
|
|
// Change the membership of an another user
|
|
setMembership: function(room_id, user_id, membershipValue, reason) {
|
|
|
|
// The REST path spec
|
|
var path = "/rooms/$room_id/state/m.room.member/$user_id";
|
|
path = path.replace("$room_id", encodeURIComponent(room_id));
|
|
path = path.replace("$user_id", user_id);
|
|
|
|
return doRequest("PUT", path, undefined, {
|
|
membership : membershipValue,
|
|
reason: reason
|
|
});
|
|
},
|
|
|
|
// Bans a user from a room
|
|
ban: function(room_id, user_id, reason) {
|
|
var path = "/rooms/$room_id/ban";
|
|
path = path.replace("$room_id", encodeURIComponent(room_id));
|
|
|
|
return doRequest("POST", path, undefined, {
|
|
user_id: user_id,
|
|
reason: reason
|
|
});
|
|
},
|
|
|
|
// Unbans a user in a room
|
|
unban: function(room_id, user_id) {
|
|
// FIXME: To update when there will be homeserver API for unban
|
|
// For now, do an unban by resetting the user membership to "leave"
|
|
return this.setMembership(room_id, user_id, "leave");
|
|
},
|
|
|
|
// Kicks a user from a room
|
|
kick: function(room_id, user_id, reason) {
|
|
// Set the user membership to "leave" to kick him
|
|
return this.setMembership(room_id, user_id, "leave", reason);
|
|
},
|
|
|
|
// Retrieves the room ID corresponding to a room alias
|
|
resolveRoomAlias:function(room_alias) {
|
|
var path = "/_matrix/client/api/v1/directory/room/$room_alias";
|
|
room_alias = encodeURIComponent(room_alias);
|
|
|
|
path = path.replace("$room_alias", room_alias);
|
|
|
|
return doRequest("GET", path, undefined, {});
|
|
},
|
|
|
|
setTopic: function(room_id, topic) {
|
|
var data = {
|
|
topic: topic
|
|
};
|
|
return this.sendStateEvent(room_id, "m.room.topic", data);
|
|
},
|
|
|
|
|
|
sendStateEvent: function(room_id, eventType, content, state_key) {
|
|
var path = "/rooms/$room_id/state/"+eventType;
|
|
if (state_key !== undefined) {
|
|
path += "/" + state_key;
|
|
}
|
|
room_id = encodeURIComponent(room_id);
|
|
path = path.replace("$room_id", room_id);
|
|
|
|
return doRequest("PUT", path, undefined, content);
|
|
},
|
|
|
|
sendEvent: function(room_id, eventType, txn_id, content) {
|
|
// The REST path spec
|
|
var path = "/rooms/$room_id/send/"+eventType+"/$txn_id";
|
|
|
|
if (!txn_id) {
|
|
txn_id = "m" + new Date().getTime();
|
|
}
|
|
|
|
// Like the cmd client, escape room ids
|
|
room_id = encodeURIComponent(room_id);
|
|
|
|
// Customize it
|
|
path = path.replace("$room_id", room_id);
|
|
path = path.replace("$txn_id", txn_id);
|
|
|
|
return doRequest("PUT", path, undefined, content);
|
|
},
|
|
|
|
sendMessage: function(room_id, txn_id, content) {
|
|
return this.sendEvent(room_id, 'm.room.message', txn_id, content);
|
|
},
|
|
|
|
// Send a text message
|
|
sendTextMessage: function(room_id, body, msg_id) {
|
|
var content = {
|
|
msgtype: "m.text",
|
|
body: body
|
|
};
|
|
|
|
return this.sendMessage(room_id, msg_id, content);
|
|
},
|
|
|
|
// Send an image message
|
|
sendImageMessage: function(room_id, image_url, image_body, msg_id) {
|
|
var content = {
|
|
msgtype: "m.image",
|
|
url: image_url,
|
|
body: image_body
|
|
};
|
|
|
|
return this.sendMessage(room_id, msg_id, content);
|
|
},
|
|
|
|
// Send an emote message
|
|
sendEmoteMessage: function(room_id, body, msg_id) {
|
|
var content = {
|
|
msgtype: "m.emote",
|
|
body: body
|
|
};
|
|
|
|
return this.sendMessage(room_id, msg_id, content);
|
|
},
|
|
|
|
// get a snapshot of the members in a room.
|
|
getMemberList: function(room_id) {
|
|
// Like the cmd client, escape room ids
|
|
room_id = encodeURIComponent(room_id);
|
|
|
|
var path = "/rooms/$room_id/members";
|
|
path = path.replace("$room_id", room_id);
|
|
return doRequest("GET", path);
|
|
},
|
|
|
|
paginateBackMessages: function(room_id, from_token, limit) {
|
|
var path = "/rooms/$room_id/messages";
|
|
path = path.replace("$room_id", room_id);
|
|
var params = {
|
|
from: from_token,
|
|
limit: limit,
|
|
dir: 'b'
|
|
};
|
|
return doRequest("GET", path, params);
|
|
},
|
|
|
|
// get a list of public rooms on your home server
|
|
publicRooms: function() {
|
|
var path = "/publicRooms";
|
|
return doRequest("GET", path);
|
|
},
|
|
|
|
// get a user's profile
|
|
getProfile: function(userId) {
|
|
return this.getProfileInfo(userId);
|
|
},
|
|
|
|
// get a display name for this user ID
|
|
getDisplayName: function(userId) {
|
|
return this.getProfileInfo(userId, "displayname");
|
|
},
|
|
|
|
// get the profile picture url for this user ID
|
|
getProfilePictureUrl: function(userId) {
|
|
return this.getProfileInfo(userId, "avatar_url");
|
|
},
|
|
|
|
// update your display name
|
|
setDisplayName: function(newName) {
|
|
var content = {
|
|
displayname: newName
|
|
};
|
|
return this.setProfileInfo(content, "displayname");
|
|
},
|
|
|
|
// update your profile picture url
|
|
setProfilePictureUrl: function(newUrl) {
|
|
var content = {
|
|
avatar_url: newUrl
|
|
};
|
|
return this.setProfileInfo(content, "avatar_url");
|
|
},
|
|
|
|
setProfileInfo: function(data, info_segment) {
|
|
var path = "/profile/$user/" + info_segment;
|
|
path = path.replace("$user", config.user_id);
|
|
return doRequest("PUT", path, undefined, data);
|
|
},
|
|
|
|
getProfileInfo: function(userId, info_segment) {
|
|
var path = "/profile/"+userId
|
|
if (info_segment) path += '/' + info_segment;
|
|
return doRequest("GET", path);
|
|
},
|
|
|
|
login: function(userId, password) {
|
|
// TODO We should be checking to make sure the client can support
|
|
// logging in to this HS, else use the fallback.
|
|
var path = "/login";
|
|
var data = {
|
|
"type": "m.login.password",
|
|
"user": userId,
|
|
"password": password
|
|
};
|
|
return doRequest("POST", path, undefined, data);
|
|
},
|
|
|
|
// hit the Identity Server for a 3PID request.
|
|
linkEmail: function(email, clientSecret, sendAttempt) {
|
|
var path = "/_matrix/identity/api/v1/validate/email/requestToken";
|
|
var data = "clientSecret="+clientSecret+"&email=" + encodeURIComponent(email)+"&sendAttempt="+sendAttempt;
|
|
var headers = {};
|
|
headers["Content-Type"] = "application/x-www-form-urlencoded";
|
|
return doBaseRequest(config.identityServer, "POST", path, {}, data, headers);
|
|
},
|
|
|
|
authEmail: function(clientSecret, sid, code) {
|
|
var path = "/_matrix/identity/api/v1/validate/email/submitToken";
|
|
var data = "token="+code+"&sid="+sid+"&clientSecret="+clientSecret;
|
|
var headers = {};
|
|
headers["Content-Type"] = "application/x-www-form-urlencoded";
|
|
return doBaseRequest(config.identityServer, "POST", path, {}, data, headers);
|
|
},
|
|
|
|
bindEmail: function(userId, tokenId, clientSecret) {
|
|
var path = "/_matrix/identity/api/v1/3pid/bind";
|
|
var data = "mxid="+encodeURIComponent(userId)+"&sid="+tokenId+"&clientSecret="+clientSecret;
|
|
var headers = {};
|
|
headers["Content-Type"] = "application/x-www-form-urlencoded";
|
|
return doBaseRequest(config.identityServer, "POST", path, {}, data, headers);
|
|
},
|
|
|
|
lookup3pid: function(medium, address) {
|
|
var path = "/_matrix/identity/api/v1/lookup?medium="+encodeURIComponent(medium)+"&address="+encodeURIComponent(address);
|
|
return doBaseRequest(config.identityServer, "GET", path, {}, undefined, {});
|
|
},
|
|
|
|
uploadContent: function(file) {
|
|
var path = "/_matrix/content";
|
|
var headers = {
|
|
"Content-Type": undefined // undefined means angular will figure it out
|
|
};
|
|
var params = {
|
|
access_token: config.access_token
|
|
};
|
|
|
|
// If the file is actually a Blob object, prevent $http from JSON-stringified it before sending
|
|
// (Equivalent to jQuery ajax processData = false)
|
|
var $httpParams;
|
|
if (file instanceof Blob) {
|
|
$httpParams = {
|
|
transformRequest: angular.identity
|
|
};
|
|
}
|
|
|
|
return doBaseRequest(config.homeserver, "POST", path, params, file, headers, $httpParams);
|
|
},
|
|
|
|
/**
|
|
* Start listening on /events
|
|
* @param {String} from the token from which to listen events to
|
|
* @param {Integer} serverTimeout the time in ms the server will hold open the connection
|
|
* @param {Integer} clientTimeout the timeout in ms used at the client HTTP request level
|
|
* @returns a promise
|
|
*/
|
|
getEventStream: function(from, serverTimeout, clientTimeout) {
|
|
var path = "/events";
|
|
var params = {
|
|
from: from,
|
|
timeout: serverTimeout
|
|
};
|
|
|
|
var $httpParams;
|
|
if (clientTimeout) {
|
|
// If the Internet connection is lost, this timeout is used to be able to
|
|
// cancel the current request and notify the client so that it can retry with a new request.
|
|
$httpParams = {
|
|
timeout: clientTimeout
|
|
};
|
|
}
|
|
|
|
return doRequest("GET", path, params, undefined, $httpParams);
|
|
},
|
|
|
|
// Indicates if user authentications details are stored in cache
|
|
isUserLoggedIn: function() {
|
|
var config = this.config();
|
|
|
|
// User is considered logged in if his cache is not empty and contains
|
|
// an access token
|
|
if (config && config.access_token) {
|
|
return true;
|
|
}
|
|
else {
|
|
return false;
|
|
}
|
|
},
|
|
|
|
// Enum of presence state
|
|
presence: {
|
|
offline: "offline",
|
|
unavailable: "unavailable",
|
|
online: "online",
|
|
free_for_chat: "free_for_chat"
|
|
},
|
|
|
|
// Set the logged in user presence state
|
|
setUserPresence: function(presence) {
|
|
var path = "/presence/$user_id/status";
|
|
path = path.replace("$user_id", config.user_id);
|
|
return doRequest("PUT", path, undefined, {
|
|
presence: presence
|
|
});
|
|
},
|
|
|
|
|
|
/****** Permanent storage of user information ******/
|
|
|
|
// Returns the current config
|
|
config: function() {
|
|
if (!config) {
|
|
config = localStorage.getItem("config");
|
|
if (config) {
|
|
config = JSON.parse(config);
|
|
|
|
// Reset the cache if the version loaded is not the expected one
|
|
if (configVersion !== config.version) {
|
|
config = undefined;
|
|
this.saveConfig();
|
|
}
|
|
}
|
|
}
|
|
return config;
|
|
},
|
|
|
|
// Set a new config (Use saveConfig to actually store it permanently)
|
|
setConfig: function(newConfig) {
|
|
config = newConfig;
|
|
console.log("new IS: "+config.identityServer);
|
|
},
|
|
|
|
// Commits config into permanent storage
|
|
saveConfig: function() {
|
|
config.version = configVersion;
|
|
localStorage.setItem("config", JSON.stringify(config));
|
|
},
|
|
|
|
|
|
/****** Room aliases management ******/
|
|
|
|
/**
|
|
* Get the room_alias & room_display_name which are computed from data
|
|
* already retrieved from the server.
|
|
* @param {Room object} room one element of the array returned by the response
|
|
* of rooms() and publicRooms()
|
|
* @returns {Object} {room_alias: "...", room_display_name: "..."}
|
|
*/
|
|
getRoomAliasAndDisplayName: function(room) {
|
|
var result = {
|
|
room_alias: undefined,
|
|
room_display_name: undefined
|
|
};
|
|
var alias = this.getRoomIdToAliasMapping(room.room_id);
|
|
if (alias) {
|
|
// use the existing alias from storage
|
|
result.room_alias = alias;
|
|
result.room_display_name = alias;
|
|
}
|
|
// XXX: this only lets us learn aliases from our local HS - we should
|
|
// make the client stop returning this if we can trust m.room.aliases state events
|
|
else if (room.aliases && room.aliases[0]) {
|
|
// save the mapping
|
|
// TODO: select the smarter alias from the array
|
|
this.createRoomIdToAliasMapping(room.room_id, room.aliases[0]);
|
|
result.room_display_name = room.aliases[0];
|
|
result.room_alias = room.aliases[0];
|
|
}
|
|
else if (room.membership === "invite" && "inviter" in room) {
|
|
result.room_display_name = room.inviter + "'s room";
|
|
}
|
|
else {
|
|
// last resort use the room id
|
|
result.room_display_name = room.room_id;
|
|
}
|
|
return result;
|
|
},
|
|
|
|
createRoomIdToAliasMapping: function(roomId, alias) {
|
|
roomIdToAlias[roomId] = alias;
|
|
aliasToRoomId[alias] = roomId;
|
|
// localStorage.setItem(MAPPING_PREFIX+roomId, alias);
|
|
},
|
|
|
|
getRoomIdToAliasMapping: function(roomId) {
|
|
var alias = roomIdToAlias[roomId]; // was localStorage.getItem(MAPPING_PREFIX+roomId)
|
|
//console.log("looking for alias for " + roomId + "; found: " + alias);
|
|
return alias;
|
|
},
|
|
|
|
getAliasToRoomIdMapping: function(alias) {
|
|
var roomId = aliasToRoomId[alias];
|
|
//console.log("looking for roomId for " + alias + "; found: " + roomId);
|
|
return roomId;
|
|
},
|
|
|
|
/****** Power levels management ******/
|
|
|
|
/**
|
|
* Return the power level of an user in a particular room
|
|
* @param {String} room_id the room id
|
|
* @param {String} user_id the user id
|
|
* @returns {Number} a value between 0 and 10
|
|
*/
|
|
getUserPowerLevel: function(room_id, user_id) {
|
|
var powerLevel = 0;
|
|
var room = $rootScope.events.rooms[room_id];
|
|
if (room && room["m.room.power_levels"]) {
|
|
if (user_id in room["m.room.power_levels"].content) {
|
|
powerLevel = room["m.room.power_levels"].content[user_id];
|
|
}
|
|
else {
|
|
// Use the room default user power
|
|
powerLevel = room["m.room.power_levels"].content["default"];
|
|
}
|
|
}
|
|
return powerLevel;
|
|
},
|
|
|
|
/**
|
|
* Change or reset the power level of a user
|
|
* @param {String} room_id the room id
|
|
* @param {String} user_id the user id
|
|
* @param {Number} powerLevel a value between 0 and 10
|
|
* If undefined, the user power level will be reset, ie he will use the default room user power level
|
|
* @returns {promise} an $http promise
|
|
*/
|
|
setUserPowerLevel: function(room_id, user_id, powerLevel) {
|
|
|
|
// Hack: currently, there is no home server API so do it by hand by updating
|
|
// the current m.room.power_levels of the room and send it to the server
|
|
var room = $rootScope.events.rooms[room_id];
|
|
if (room && room["m.room.power_levels"]) {
|
|
var content = angular.copy(room["m.room.power_levels"].content);
|
|
content[user_id] = powerLevel;
|
|
|
|
var path = "/rooms/$room_id/state/m.room.power_levels";
|
|
path = path.replace("$room_id", encodeURIComponent(room_id));
|
|
|
|
return doRequest("PUT", path, undefined, content);
|
|
}
|
|
|
|
// The room does not exist or does not contain power_levels data
|
|
var deferred = $q.defer();
|
|
deferred.reject({data:{error: "Invalid room: " + room_id}});
|
|
return deferred.promise;
|
|
}
|
|
|
|
};
|
|
}]);
|