Source: models/users/matrix.js

  1. "use strict";
  3. /**
  4.  * Construct a Matrix user.
  5.  * @constructor
  6.  * @param {string} userId The user_id of the user.
  7.  * @param {Object=} data Serialized data values
  8.  * @param {boolean} escape [true] Escape the user's localpart. Modify {@link MatrixUser~ESCAPE_DEFAULT}
  9.  *                  to change the default value.
  10.  */
  11. function MatrixUser(userId, data, escape=MatrixUser.ESCAPE_DEFAULT) {
  12.     if (!userId) {
  13.         throw new Error("Missing user_id");
  14.     }
  15.     if (data && Object.prototype.toString.call(data) !== "[object Object]") {
  16.         throw new Error("data arg must be an Object");
  17.     }
  18.     this.userId = userId;
  19.     const split = this.userId.split(":");
  20.     this.localpart = split[0].substring(1);
  21.     this.host = split[1];
  22.     if (escape) {
  23.         this.escapeUserId();
  24.     }
  25.     this._data = data || {};
  26. }
  28. /**
  29.  * Get the matrix user's ID.
  30.  * @return {string} The user ID
  31.  */
  32. MatrixUser.prototype.getId = function() {
  33.     return this.userId;
  34. };
  36. /**
  37.  * Get the display name for this Matrix user.
  38.  * @return {?string} The display name.
  39.  */
  40. MatrixUser.prototype.getDisplayName = function() {
  41.     return this._data.displayName;
  42. };
  44. /**
  45.  * Set the display name for this Matrix user.
  46.  * @param {string} name The Matrix display name.
  47.  */
  48. MatrixUser.prototype.setDisplayName = function(name) {
  49.     this._data.displayName = name;
  50. };
  52. /**
  53.  * Set an arbitrary bridge-specific data value for this user.
  54.  * @param {string} key The key to store the data value under.
  55.  * @param {*} val The data value. This value should be serializable via
  56.  * <code>JSON.stringify(data)</code>.
  57.  */
  58. MatrixUser.prototype.set = function(key, val) {
  59.     this._data[key] = val;
  60. };
  62. /**
  63.  * Get the data value for the given key.
  64.  * @param {string} key An arbitrary bridge-specific key.
  65.  * @return {*} Stored data for this key. May be undefined.
  66.  */
  67. MatrixUser.prototype.get = function(key) {
  68.     return this._data[key];
  69. };
  71. /**
  72.  * Serialize all the data about this user, excluding the user ID.
  73.  * @return {Object} The serialised data
  74.  */
  75. MatrixUser.prototype.serialize = function() {
  76.     this._data.localpart = this.localpart;
  77.     return this._data;
  78. };
  80. /**
  81.  * Make a userId conform to the matrix spec using QP escaping.
  82.  * Grammar taken from: https://matrix.org/docs/spec/appendices.html#identifier-grammar
  83.  */
  84. MatrixUser.prototype.escapeUserId = function() {
  85.     // NOTE: Currently Matrix accepts / in the userId, although going forward it will be removed.
  86.     // NOTE: We also allow uppercase for the time being.
  87.     const badChars = new Set(this.localpart.replace(/([A-Z]|[a-z]|[0-9]|-|\.|=|_)+/g, ""));
  88.     let res = this.localpart;
  89.     badChars.forEach((c) => {
  90.         const hex = c.charCodeAt(0).toString(16).toLowerCase();
  91.         res = res.replace(
  92.             new RegExp(`\\${c}`, "g"),
  93.             `=${hex}`
  94.         );
  95.     });
  96.     this.localpart = res;
  97.     this.userId = `@${this.localpart}:${this.host}`;
  98. };
  100. /**
  101.  * @static
  102.  * This is a global variable to modify the default escaping behaviour of MatrixUser.
  103.  */
  104. MatrixUser.ESCAPE_DEFAULT = true;
  107. /** The MatrixUser class */
  108. module.exports = MatrixUser;