2015-09-18 19:39:16 +02:00
|
|
|
/*
|
2016-01-07 05:06:39 +01:00
|
|
|
Copyright 2015, 2016 OpenMarket Ltd
|
2018-03-06 18:48:21 +01:00
|
|
|
Copyright 2018 New Vector Ltd
|
2019-12-20 01:45:24 +01:00
|
|
|
Copyright 2019 The Matrix.org Foundation C.I.C.
|
2015-09-18 19:39:16 +02: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.
|
|
|
|
*/
|
|
|
|
|
2021-10-23 00:23:32 +02:00
|
|
|
import { logger } from "matrix-js-sdk/src/logger";
|
|
|
|
|
2021-06-29 14:11:58 +02:00
|
|
|
import { MatrixClientPeg } from "./MatrixClientPeg";
|
2020-05-14 04:41:41 +02:00
|
|
|
import dis from "./dispatcher/dispatcher";
|
2022-12-12 12:24:14 +01:00
|
|
|
import Timer from "./utils/Timer";
|
2021-06-29 14:11:58 +02:00
|
|
|
import { ActionPayload } from "./dispatcher/payloads";
|
2015-09-18 19:39:16 +02:00
|
|
|
|
2020-10-13 18:39:29 +02:00
|
|
|
// Time in ms after that a user is considered as unavailable/away
|
2017-10-11 18:56:17 +02:00
|
|
|
const UNAVAILABLE_TIME_MS = 3 * 60 * 1000; // 3 mins
|
2020-10-13 18:39:29 +02:00
|
|
|
|
|
|
|
enum State {
|
|
|
|
Online = "online",
|
|
|
|
Offline = "offline",
|
|
|
|
Unavailable = "unavailable",
|
|
|
|
}
|
2015-09-18 19:39:16 +02:00
|
|
|
|
2015-10-26 14:54:54 +01:00
|
|
|
class Presence {
|
2023-02-13 18:01:43 +01:00
|
|
|
private unavailableTimer: Timer | null = null;
|
|
|
|
private dispatcherRef: string | null = null;
|
|
|
|
private state: State | null = null;
|
2020-10-13 18:39:29 +02:00
|
|
|
|
2015-09-18 19:39:16 +02:00
|
|
|
/**
|
|
|
|
* Start listening the user activity to evaluate his presence state.
|
2019-02-01 01:52:39 +01:00
|
|
|
* Any state change will be sent to the homeserver.
|
2015-09-18 19:39:16 +02:00
|
|
|
*/
|
2023-01-12 14:25:14 +01:00
|
|
|
public async start(): Promise<void> {
|
2020-10-13 18:39:29 +02:00
|
|
|
this.unavailableTimer = new Timer(UNAVAILABLE_TIME_MS);
|
2018-12-11 16:16:00 +01:00
|
|
|
// the user_activity_start action starts the timer
|
2020-10-13 18:39:29 +02:00
|
|
|
this.dispatcherRef = dis.register(this.onAction);
|
|
|
|
while (this.unavailableTimer) {
|
2018-12-11 16:16:00 +01:00
|
|
|
try {
|
2020-10-13 18:39:29 +02:00
|
|
|
await this.unavailableTimer.finished();
|
|
|
|
this.setState(State.Unavailable);
|
2022-12-12 12:24:14 +01:00
|
|
|
} catch (e) {
|
|
|
|
/* aborted, stop got called */
|
|
|
|
}
|
2015-09-18 19:39:16 +02:00
|
|
|
}
|
2015-10-26 14:54:54 +01:00
|
|
|
}
|
2015-09-18 19:39:16 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Stop tracking user activity
|
|
|
|
*/
|
2023-01-12 14:25:14 +01:00
|
|
|
public stop(): void {
|
2020-10-13 18:39:29 +02:00
|
|
|
if (this.dispatcherRef) {
|
|
|
|
dis.unregister(this.dispatcherRef);
|
|
|
|
this.dispatcherRef = null;
|
2018-12-11 16:16:00 +01:00
|
|
|
}
|
2020-10-13 18:39:29 +02:00
|
|
|
if (this.unavailableTimer) {
|
|
|
|
this.unavailableTimer.abort();
|
|
|
|
this.unavailableTimer = null;
|
2015-09-18 19:39:16 +02:00
|
|
|
}
|
2015-10-26 14:54:54 +01:00
|
|
|
}
|
2015-09-18 19:39:16 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the current presence state.
|
|
|
|
* @returns {string} the presence state (see PRESENCE enum)
|
|
|
|
*/
|
2023-02-13 18:01:43 +01:00
|
|
|
public getState(): State | null {
|
2015-10-26 14:54:54 +01:00
|
|
|
return this.state;
|
|
|
|
}
|
2015-09-18 19:39:16 +02:00
|
|
|
|
2023-01-12 14:25:14 +01:00
|
|
|
private onAction = (payload: ActionPayload): void => {
|
2022-12-12 12:24:14 +01:00
|
|
|
if (payload.action === "user_activity") {
|
2020-10-13 18:39:29 +02:00
|
|
|
this.setState(State.Online);
|
2023-02-13 18:01:43 +01:00
|
|
|
this.unavailableTimer?.restart();
|
2018-12-11 16:16:00 +01:00
|
|
|
}
|
2021-06-29 14:11:58 +02:00
|
|
|
};
|
2018-12-11 16:16:00 +01:00
|
|
|
|
2015-09-18 19:39:16 +02:00
|
|
|
/**
|
|
|
|
* Set the presence state.
|
2019-02-01 01:52:39 +01:00
|
|
|
* If the state has changed, the homeserver will be notified.
|
2015-09-18 19:39:16 +02:00
|
|
|
* @param {string} newState the new presence state (see PRESENCE enum)
|
|
|
|
*/
|
2023-01-12 14:25:14 +01:00
|
|
|
private async setState(newState: State): Promise<void> {
|
2017-12-25 22:25:13 +01:00
|
|
|
if (newState === this.state) {
|
2015-09-18 19:39:16 +02:00
|
|
|
return;
|
|
|
|
}
|
2020-10-13 18:39:29 +02:00
|
|
|
|
2019-09-18 10:27:43 +02:00
|
|
|
const oldState = this.state;
|
2015-10-26 14:54:54 +01:00
|
|
|
this.state = newState;
|
2016-01-05 14:24:05 +01:00
|
|
|
|
|
|
|
if (MatrixClientPeg.get().isGuest()) {
|
|
|
|
return; // don't try to set presence when a guest; it won't work.
|
|
|
|
}
|
|
|
|
|
2018-12-11 16:16:00 +01:00
|
|
|
try {
|
2021-06-29 14:11:58 +02:00
|
|
|
await MatrixClientPeg.get().setPresence({ presence: this.state });
|
2021-10-15 16:32:15 +02:00
|
|
|
logger.info("Presence:", newState);
|
2019-09-18 10:27:43 +02:00
|
|
|
} catch (err) {
|
2021-10-15 16:30:53 +02:00
|
|
|
logger.error("Failed to set presence:", err);
|
2019-09-18 10:27:43 +02:00
|
|
|
this.state = oldState;
|
2018-03-06 18:48:21 +01:00
|
|
|
}
|
2015-10-26 14:54:54 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-12-20 01:45:24 +01:00
|
|
|
export default new Presence();
|