2019-11-12 15:29:07 +03:00
|
|
|
/*
|
2019-11-18 12:16:29 +03:00
|
|
|
Copyright 2019 The Matrix.org Foundation C.I.C.
|
2019-11-12 15:29:07 +03:00
|
|
|
|
|
|
|
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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2019-11-19 11:26:46 +03:00
|
|
|
* Object holding the global EventIndex object. Can only be initialized if the
|
2019-11-18 16:29:03 +03:00
|
|
|
* platform supports event indexing.
|
2019-11-12 15:29:07 +03:00
|
|
|
*/
|
|
|
|
|
2019-11-19 14:52:12 +03:00
|
|
|
import PlatformPeg from "../PlatformPeg";
|
|
|
|
import EventIndex from "../indexing/EventIndex";
|
2020-01-23 13:47:49 +03:00
|
|
|
import SettingsStore, {SettingLevel} from '../settings/SettingsStore';
|
2019-11-12 15:29:07 +03:00
|
|
|
|
|
|
|
class EventIndexPeg {
|
|
|
|
constructor() {
|
|
|
|
this.index = null;
|
2020-01-23 13:47:49 +03:00
|
|
|
this._supportIsInstalled = false;
|
2019-11-12 15:29:07 +03:00
|
|
|
}
|
|
|
|
|
2019-11-18 12:27:10 +03:00
|
|
|
/**
|
2020-01-23 13:47:49 +03:00
|
|
|
* Initialize the EventIndexPeg and if event indexing is enabled initialize
|
|
|
|
* the event index.
|
2019-11-13 18:21:26 +03:00
|
|
|
*
|
2020-01-23 13:47:49 +03:00
|
|
|
* @return {Promise<boolean>} A promise that will resolve to true if an
|
2019-11-13 18:21:26 +03:00
|
|
|
* EventIndex was successfully initialized, false otherwise.
|
2019-11-12 15:29:07 +03:00
|
|
|
*/
|
|
|
|
async init() {
|
2019-11-13 14:25:16 +03:00
|
|
|
const indexManager = PlatformPeg.get().getEventIndexingManager();
|
2020-01-23 13:47:49 +03:00
|
|
|
if (!indexManager) {
|
|
|
|
console.log("EventIndex: Platform doesn't support event indexing, not initializing.");
|
2019-11-13 17:39:39 +03:00
|
|
|
return false;
|
|
|
|
}
|
2019-11-12 15:29:07 +03:00
|
|
|
|
2020-01-23 13:47:49 +03:00
|
|
|
this._supportIsInstalled = await indexManager.supportsEventIndexing();
|
|
|
|
|
|
|
|
if (!this.supportIsInstalled()) {
|
|
|
|
console.log("EventIndex: Event indexing isn't installed for the platform, not initializing.");
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!SettingsStore.getValueAt(SettingLevel.DEVICE, 'enableEventIndexing')) {
|
|
|
|
console.log("EventIndex: Event indexing is disabled, not initializing");
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return this.initEventIndex();
|
|
|
|
}
|
|
|
|
|
2020-01-24 13:16:49 +03:00
|
|
|
/**
|
|
|
|
* Initialize the event index.
|
2020-01-23 13:47:49 +03:00
|
|
|
*
|
|
|
|
* @returns {boolean} True if the event index was succesfully initialized,
|
|
|
|
* false otherwise.
|
|
|
|
*/
|
|
|
|
async initEventIndex() {
|
2019-11-13 17:39:39 +03:00
|
|
|
const index = new EventIndex();
|
|
|
|
|
|
|
|
try {
|
2019-11-14 16:13:49 +03:00
|
|
|
await index.init();
|
2019-11-13 17:39:39 +03:00
|
|
|
} catch (e) {
|
|
|
|
console.log("EventIndex: Error initializing the event index", e);
|
2019-11-14 18:01:14 +03:00
|
|
|
return false;
|
2019-11-13 17:39:39 +03:00
|
|
|
}
|
|
|
|
|
2019-11-12 15:29:07 +03:00
|
|
|
this.index = index;
|
|
|
|
|
2019-11-13 12:30:38 +03:00
|
|
|
return true;
|
2019-11-12 15:29:07 +03:00
|
|
|
}
|
|
|
|
|
2020-01-23 13:47:49 +03:00
|
|
|
/**
|
|
|
|
* Check if the current platform has support for event indexing.
|
|
|
|
*
|
|
|
|
* @return {boolean} True if it has support, false otherwise. Note that this
|
|
|
|
* does not mean that support is installed.
|
|
|
|
*/
|
|
|
|
platformHasSupport(): boolean {
|
|
|
|
return PlatformPeg.get().getEventIndexingManager() !== null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if event indexing support is installed for the platfrom.
|
|
|
|
*
|
|
|
|
* Event indexing might require additional optional modules to be installed,
|
|
|
|
* this tells us if those are installed. Note that this should only be
|
|
|
|
* called after the init() method was called.
|
|
|
|
*
|
|
|
|
* @return {boolean} True if support is installed, false otherwise.
|
|
|
|
*/
|
|
|
|
supportIsInstalled(): boolean {
|
|
|
|
return this._supportIsInstalled;
|
|
|
|
}
|
|
|
|
|
2019-11-13 18:21:26 +03:00
|
|
|
/**
|
2019-11-14 18:13:22 +03:00
|
|
|
* Get the current event index.
|
|
|
|
*
|
|
|
|
* @return {EventIndex} The current event index.
|
2019-11-13 18:21:26 +03:00
|
|
|
*/
|
2019-11-14 18:13:22 +03:00
|
|
|
get() {
|
|
|
|
return this.index;
|
|
|
|
}
|
|
|
|
|
2019-11-26 15:37:53 +03:00
|
|
|
start() {
|
|
|
|
if (this.index === null) return;
|
|
|
|
this.index.startCrawler();
|
|
|
|
}
|
|
|
|
|
2019-11-12 17:40:49 +03:00
|
|
|
stop() {
|
|
|
|
if (this.index === null) return;
|
2019-11-14 18:13:22 +03:00
|
|
|
this.index.stopCrawler();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unset our event store
|
|
|
|
*
|
|
|
|
* After a call to this the init() method will need to be called again.
|
|
|
|
*
|
|
|
|
* @return {Promise} A promise that will resolve once the event index is
|
|
|
|
* closed.
|
|
|
|
*/
|
|
|
|
async unset() {
|
|
|
|
if (this.index === null) return;
|
2020-03-13 13:33:58 +03:00
|
|
|
await this.index.close();
|
2019-11-12 17:40:49 +03:00
|
|
|
this.index = null;
|
2019-11-12 15:29:07 +03:00
|
|
|
}
|
|
|
|
|
2019-11-13 18:21:26 +03:00
|
|
|
/**
|
|
|
|
* Delete our event indexer.
|
|
|
|
*
|
|
|
|
* After a call to this the init() method will need to be called again.
|
|
|
|
*
|
|
|
|
* @return {Promise} A promise that will resolve once the event index is
|
|
|
|
* deleted.
|
|
|
|
*/
|
2019-11-12 15:29:07 +03:00
|
|
|
async deleteEventIndex() {
|
2019-11-14 18:13:22 +03:00
|
|
|
const indexManager = PlatformPeg.get().getEventIndexingManager();
|
|
|
|
|
|
|
|
if (indexManager !== null) {
|
2020-03-13 13:33:58 +03:00
|
|
|
await this.unset();
|
2019-11-14 18:13:22 +03:00
|
|
|
console.log("EventIndex: Deleting event index.");
|
|
|
|
await indexManager.deleteEventIndex();
|
|
|
|
}
|
2019-11-12 15:29:07 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!global.mxEventIndexPeg) {
|
|
|
|
global.mxEventIndexPeg = new EventIndexPeg();
|
|
|
|
}
|
2019-12-20 03:45:24 +03:00
|
|
|
export default global.mxEventIndexPeg;
|