Source: components/app-service-bot.js

  1. "use strict";
  3. /**
  4.  * Construct an AS bot user which has various helper methods.
  5.  * @constructor
  6.  * @param {MatrixClient} client The client instance configured for the AS bot.
  7.  * @param {AppServiceRegistration} registration The registration that the bot
  8.  * is following. Used to determine which user IDs it is controlling.
  9.  * @param {MembershipCache} memberCache The bridges membership cache instance,
  10.  * for storing membership the bot has discovered.
  11.  */
  12. function AppServiceBot(client, registration, memberCache) {
  13.     this.client = client;
  14.     this.registration = registration.getOutput();
  15.     this.memberCache = memberCache;
  16.     var self = this;
  17.     // yank out the exclusive user ID regex strings
  18.     this.exclusiveUserRegexes = [];
  19.     if (this.registration.namespaces && this.registration.namespaces.users) {
  20.         this.registration.namespaces.users.forEach(function(userEntry) {
  21.             if (!userEntry.exclusive) {
  22.                 return;
  23.             }
  24.             self.exclusiveUserRegexes.push(userEntry.regex);
  25.         });
  26.     }
  27. }
  29. AppServiceBot.prototype.getClient = function() {
  30.     return this.client;
  31. };
  33. AppServiceBot.prototype.getUserId = function() {
  34.     return this.client.credentials.userId;
  35. };
  37. /**
  38.  * Get a list of joined room IDs for the AS bot.
  39.  * @return {Promise<string[],Error>} Resolves to a list of room IDs.
  40.  */
  41. AppServiceBot.prototype.getJoinedRooms = function() {
  42.     return this.client.getJoinedRooms().then((res) => {
  43.         if (!res.joined_rooms) {
  44.             return [];
  45.         }
  46.         return res.joined_rooms;
  47.     });
  48. };
  50. /**
  51.  * Get a map of joined user IDs for the given room ID. The values in the map are objects
  52.  * with a 'display_name' and 'avatar_url' properties. These properties may be null.
  53.  * @param {string} roomId The room to get a list of joined user IDs in.
  54.  * @return {Promise<Object,Error>} Resolves to a map of user ID => display_name avatar_url
  55.  */
  56. AppServiceBot.prototype.getJoinedMembers = function(roomId) {
  57.     return this.client.getJoinedRoomMembers(roomId).then((res) => {
  58.         if (!res.joined) {
  59.             return {};
  60.         }
  61.         for (const member in res.joined) {
  62.             if (this.isRemoteUser(member)) {
  63.                 this.memberCache.setMemberEntry(roomId, member, "join");
  64.             }
  65.         }
  66.         return res.joined;
  67.     });
  68. };
  70. /**
  71.  * @deprecated
  72.  * @throws {Error} This will always throw because /sync is no longer supported.
  73.  */
  74. AppServiceBot.prototype.getMemberLists = function() {
  75.     throw new Error(
  76.         "The appservice bot can no longer /sync because this functionality was removed." +
  77.         "Please use getJoinedRooms and getJoinedMembers"
  78.     );
  79. };
  81. AppServiceBot.prototype._getRoomInfo = function(roomId, joinedRoom) {
  82.     var self = this;
  83.     var stateEvents = joinedRoom.state ? joinedRoom.state.events : [];
  84.     var roomInfo = {
  85.         id: roomId,
  86.         state: stateEvents,
  87.         realJoinedUsers: [],
  88.         remoteJoinedUsers: []
  89.     };
  90.     stateEvents.forEach(function(event) {
  91.         if (event.type !== "m.room.member" || event.content.membership !== "join") {
  92.             return;
  93.         }
  94.         var userId = event.state_key;
  95.         if (userId === self.getUserId()) {
  96.             return;
  97.         }
  98.         if (self.isRemoteUser(userId)) {
  99.             roomInfo.remoteJoinedUsers.push(userId);
  100.         }
  101.         else {
  102.             roomInfo.realJoinedUsers.push(userId);
  103.         }
  104.     });
  105.     return roomInfo;
  106. }
  108. /**
  109.  * Test a userId to determine if it's a user within the exclusive regexes of the bridge.
  110.  * @return {boolean} True if it is a remote user, false otherwise.
  111.  */
  112. AppServiceBot.prototype.isRemoteUser = function(userId) {
  113.     for (var i = 0; i < this.exclusiveUserRegexes.length; i++) {
  114.         var regex = new RegExp(this.exclusiveUserRegexes[i]);
  115.         if (regex.test(userId)) {
  116.             return true;
  117.         }
  118.     }
  119.     return false;
  120. };
  122. // Backwards compatible for many bridges that make use of _isRemoteUser
  123. AppServiceBot.prototype._isRemoteUser = AppServiceBot.prototype.isRemoteUser;
  125. module.exports = AppServiceBot;
  127. /**
  128.  * @typedef AppServiceBot~RoomInfo
  129.  * @type {Object}
  130.  * @property {string} id The matrix room ID
  131.  * @property {Object[]} state The raw state events for this room
  132.  * @property {string[]} realJoinedUsers A list of user IDs of real matrix users
  133.  * that have joined this room.
  134.  * @property {string[]} remoteJoinedUsers A list of user IDs of remote users
  135.  * (provisioned by the AS) that have joined this room.
  136.  */