Source: components/event-bridge-store.js

  1. /*
  2. Copyright 2019 The Matrix.org Foundation C.I.C.
  4. Licensed under the Apache License, Version 2.0 (the "License");
  5. you may not use this file except in compliance with the License.
  6. You may obtain a copy of the License at
  7.     http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. */
  15. const BridgeStore = require("./bridge-store");
  16. const StoredEvent = require("../models/events/event");
  17. const util = require("util");
  19. /**
  20.  * Construct a store suitable for event mapping information. Data is stored
  21.  * as {@link StoredEvent}s.
  22.  * @constructor
  23.  * @param {Datastore} db The connected NEDB database instance
  24.  */
  25. function EventBridgeStore(db) {
  26.     this.db = db;
  27. }
  29. util.inherits(EventBridgeStore, BridgeStore);
  31. /**
  32.  * Insert an event, clobbering based on the ID of the StoredEvent.
  33.  * @param {StoredEvent} event
  34.  * @return {Promise}
  35.  */
  36. EventBridgeStore.prototype.upsertEvent = function(event) {
  37.     return this.upsert({
  38.         id: event.getId()
  39.     }, event.serialize());
  40. }
  42. /**
  43.  * Get an existing event based on the provided matrix IDs.
  44.  * @param {string} roomId The ID of the room.
  45.  * @param {string} eventId The ID of the event.
  46.  * @return {?StoredEvent} A promise which resolves to the StoredEvent or null.
  47.  */
  48. EventBridgeStore.prototype.getEntryByMatrixId = function(roomId, eventId) {
  49.     return this.selectOne({
  50.         "matrix.roomId": roomId,
  51.         "matrix.eventId": eventId,
  52.     }, this.convertTo(function(doc) {
  53.         return StoredEvent.deserialize(doc);
  54.     }));
  55. }
  57. /**
  58.  * Get an existing event based on the provided remote IDs.
  59.  * @param {string} roomId The ID of the room.
  60.  * @param {string} eventId The ID of the event.
  61.  * @return {?StoredEvent} A promise which resolves to the StoredEvent or null.
  62.  */
  63. EventBridgeStore.prototype.getEntryByRemoteId = function(roomId, eventId) {
  64.     return this.selectOne({
  65.         "remote.roomId": roomId,
  66.         "remote.eventId": eventId,
  67.     }, this.convertTo(function(doc) {
  68.         return StoredEvent.deserialize(doc);
  69.     }));
  70. }
  72. /**
  73.  * Remove entries based on the event data.
  74.  * @param {StoredEvent} event The event to remove.
  75.  * @return {Promise}
  76.  */
  77. EventBridgeStore.prototype.removeEvent = function(event) {
  78.     return this.delete({
  79.         id: event.getId(),
  80.     });
  81. };
  83. /**
  84.  * Remove entries based on the matrix IDs.
  85.  * @param {string} roomId The ID of the room.
  86.  * @param {string} eventId The ID of the event.
  87.  * @return {Promise}
  88.  */
  89. EventBridgeStore.prototype.removeEventByMatrixId = function(roomId, eventId) {
  90.     return this.delete({
  91.         "matrix.roomId": roomId,
  92.         "matrix.eventId": eventId,
  93.     });
  94. };
  96. /**
  97.  * Remove entries based on the matrix IDs.
  98.  * @param {string} roomId The ID of the room.
  99.  * @param {string} eventId The ID of the event.
  100.  * @return {Promise}
  101.  */
  102. EventBridgeStore.prototype.removeEventByRemoteId = function(roomId, eventId) {
  103.     return this.delete({
  104.         "remote.roomId": roomId,
  105.         "remote.eventId": eventId,
  106.     });
  107. };
  109. module.exports = EventBridgeStore;