Source: components/membership-cache.js

  1. /**
  2.  * Caches membership of virtual users to rooms in memory
  3.  * and also stores the state of whether users are registered.
  4.  */
  5. class MembershipCache {
  6.     constructor () {
  7.         this._membershipMap = {
  8.             // room_id: { user_id: "join|invite|leave|ban|null" }   null=unknown
  9.         };
  10.         this._registeredUsers = new Set();
  11.     }
  13.     /**
  14.      * Get's the *cached* state of a user's membership for a room.
  15.      * This DOES NOT check to verify the value is correct (i.e the
  16.      * room may have state reset and left the user from the room).
  17.      *
  18.      * This only caches users from the appservice.
  19.      *
  20.      * @param {string}} roomId Room id to check the state of.
  21.      * @param {string} userId The userid to check the state of.
  22.      * @returns {string} The membership state of the user, e.g. "joined"
  23.      */
  24.     getMemberEntry(roomId, userId) {
  25.         if (this._membershipMap[roomId] === undefined) {
  26.             return null;
  27.         }
  28.         return this._membershipMap[roomId][userId];
  29.     }
  31.     /**
  32.      * Set the *cached* state of a user's membership for a room.
  33.      * Use this to optimise intents so that they do not attempt
  34.      * to join a room if we know they are joined.
  35.      * This DOES NOT set the actual membership of the room.
  36.      *
  37.      * This only caches users from the appservice.
  38.      * @param {string} roomId Room id to set the state of.
  39.      * @param {string} userId The userid to set the state of.
  40.      * @param {string} membership The membership value to set for the user
  41.      *                       e.g joined.
  42.      */
  43.     setMemberEntry(roomId, userId, membership) {
  44.         if (this._membershipMap[roomId] === undefined) {
  45.             this._membershipMap[roomId] = {};
  46.         }
  48.         // Bans and invites do not mean the user exists.
  49.         if (membership === "join" || membership === "leave") {
  50.             this._registeredUsers.add(userId);
  51.         }
  53.         this._membershipMap[roomId][userId] = membership;
  54.     }
  56.     isUserRegistered(userId) {
  57.         return this._registeredUsers.has(userId);
  58.     }
  59. }
  61. module.exports = MembershipCache;