Add PLAYERS_ONLINE datapoint

Author: AuroraLS3

Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/auth/WebPermission.java

@@ -158,6 +158,8 @@ public enum WebPermission implements Supplier<String>, Lang {
     DATA_NETWORK_PLAYTIME_PER_PLAYER_AVERAGE("See Average playtime per player datapoint of network"),
     DATA_SERVER_PLAYERS_ONLINE_PEAK("See Player online peak -datapoint of servers"),
     DATA_NETWORK_PLAYERS_ONLINE_PEAK("See Player online peak -datapoint of network"),
+    DATA_SERVER_PLAYERS_ONLINE("See Players online -datapoint of servers"),
+    DATA_NETWORK_PLAYERS_ONLINE("See Players online -datapoint of network"),
     DATA_PLAYER_MOB_KILLS("See Mob kills datapoint of players"),
     DATA_SERVER_MOB_KILLS("See Mob kills datapoint of servers"),
     DATA_NETWORK_MOB_KILLS("See Mob kills datapoint of network"),

Plan/common/src/main/java/com/djrapitops/plan/delivery/export/NetworkPageExporter.java

@@ -150,6 +150,7 @@ public void exportJSON(Path toDirectory, ServerUUID serverUUID) throws IOExcepti
                 datapointType + DatapointType.NEW_PLAYERS + afterMillis + TimeUnit.DAYS.toMillis(7),
                 datapointType + DatapointType.NEW_PLAYERS + afterMillis + TimeUnit.DAYS.toMillis(1),
                 datapointType + DatapointType.REGULAR_PLAYERS,
+                datapointType + DatapointType.PLAYERS_ONLINE,
                 datapointType + DatapointType.PLAYERS_ONLINE_PEAK + afterMillis + TimeUnit.DAYS.toMillis(2),
                 datapointType + DatapointType.PLAYERS_ONLINE_PEAK,
                 datapointType + DatapointType.SESSION_COUNT,

Plan/common/src/main/java/com/djrapitops/plan/delivery/export/ServerPageExporter.java

@@ -159,6 +159,7 @@ public void exportJSON(Path toDirectory, ServerUUID serverUUID) throws IOExcepti
                 datapointType + DatapointType.REGULAR_PLAYERS + server,
                 datapointType + DatapointType.PLAYERS_ONLINE_PEAK + afterMillis + TimeUnit.DAYS.toMillis(2) + server,
                 datapointType + DatapointType.PLAYERS_ONLINE_PEAK + server,
+                datapointType + DatapointType.PLAYERS_ONLINE + server,
                 datapointType + DatapointType.SESSION_COUNT + server,
                 datapointType + DatapointType.SESSION_COUNT + after + server,
                 datapointType + DatapointType.PLAYTIME_PER_PLAYER_AVERAGE + server,

Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/DatapointType.java

@@ -44,6 +44,7 @@ public enum DatapointType {
     SESSION_LENGTH_AVERAGE(SessionLengthAverage.class, DatapointCacheKey.SESSION),
     PLAYTIME_PER_PLAYER_AVERAGE(PlaytimePerPlayerAverage.class, DatapointCacheKey.SESSION),
     PLAYERS_ONLINE_PEAK(PlayersOnlinePeak.class, DatapointCacheKey.TPS),
+    PLAYERS_ONLINE(PlayersOnline.class, DatapointCacheKey.TPS),
     MOB_KILLS(MobKills.class, DatapointCacheKey.SESSION),
     PLAYER_KILLS(PlayerKills.class, DatapointCacheKey.SESSION),
     DEATHS(Deaths.class, DatapointCacheKey.SESSION);

Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/DatapointModule.java

@@ -92,6 +92,10 @@ public interface DatapointModule {
     @IntoSet
     Datapoint<?> bindPlayerOnlinePeak(PlayersOnlinePeak playersOnlinePeak);
 
+    @Binds
+    @IntoSet
+    Datapoint<?> bindPlayersOnline(PlayersOnline playersOnline);
+
     @Binds
     @IntoSet
     Datapoint<?> bindMobKills(MobKills mobKills);

Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/PlayersOnline.java

@@ -0,0 +1,108 @@
+/*
+ *  This file is part of Player Analytics (Plan).
+ *
+ *  Plan is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Lesser General Public License v3 as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Plan is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public License
+ *  along with Plan. If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.djrapitops.plan.delivery.rendering.json.datapoint.types;
+
+import com.djrapitops.plan.delivery.domain.auth.WebPermission;
+import com.djrapitops.plan.delivery.domain.datatransfer.GenericFilter;
+import com.djrapitops.plan.delivery.rendering.json.datapoint.Datapoint;
+import com.djrapitops.plan.delivery.rendering.json.datapoint.DatapointType;
+import com.djrapitops.plan.delivery.web.resolver.exception.BadRequestException;
+import com.djrapitops.plan.gathering.ServerSensor;
+import com.djrapitops.plan.gathering.domain.TPS;
+import com.djrapitops.plan.identification.ServerInfo;
+import com.djrapitops.plan.identification.ServerUUID;
+import com.djrapitops.plan.storage.database.DBSystem;
+import com.djrapitops.plan.storage.database.queries.objects.TPSQueries;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import java.util.List;
+import java.util.Optional;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Datapoint for looking up current Players online count.
+ *
+ * @author AuroraLS3
+ */
+@Singleton
+public class PlayersOnline implements Datapoint<Integer> {
+
+    private final DBSystem dbSystem;
+    private final ServerInfo serverInfo;
+    private final ServerSensor<?> serverSensor;
+
+    @Inject
+    public PlayersOnline(DBSystem dbSystem, ServerInfo serverInfo, ServerSensor<?> serverSensor) {
+        this.dbSystem = dbSystem;
+        this.serverInfo = serverInfo;
+        this.serverSensor = serverSensor;
+    }
+
+    @Override
+    public Optional<Integer> getValue(GenericFilter filter) {
+        if (filter.getPlayerUUID().isPresent()) {
+            throw new BadRequestException("PLAYERS_ONLINE does not support player parameter");
+        }
+
+        List<ServerUUID> serverUUIDs = filter.getServerUUIDs();
+        if (serverUUIDs.isEmpty()) {
+            return Optional.of(serverSensor.getOnlinePlayerCount());
+        }
+
+        if (serverUUIDs.size() == 1) {
+            ServerUUID serverUUID = serverUUIDs.get(0);
+            if (serverUUID.equals(serverInfo.getServerUUID())) {
+                return Optional.of(serverSensor.getOnlinePlayerCount());
+            }
+            return Optional.of(dbSystem.getDatabase().query(TPSQueries.fetchLatestTPSEntryForServer(serverUUID))
+                    .filter(tps -> tps.getDate() > System.currentTimeMillis() - TimeUnit.MINUTES.toMillis(2))
+                    .map(TPS::getPlayers)
+                    .orElse(0)
+            );
+        }
+
+        // Multiple servers: sum of latest online counts
+        int total = 0;
+        for (ServerUUID serverUUID : serverUUIDs) {
+            if (serverUUID.equals(serverInfo.getServerUUID())) {
+                total += serverSensor.getOnlinePlayerCount();
+            } else {
+                total += dbSystem.getDatabase().query(TPSQueries.fetchLatestTPSEntryForServer(serverUUID))
+                        .filter(tps -> tps.getDate() > System.currentTimeMillis() - TimeUnit.MINUTES.toMillis(2))
+                        .map(TPS::getPlayers).orElse(0);
+            }
+        }
+        return Optional.of(total);
+    }
+
+    @Override
+    public WebPermission getPermission(GenericFilter filter) {
+        if (filter.getPlayerUUID().isPresent()) {
+            return WebPermission.DATA_PLAYER;
+        } else if (!filter.getServerUUIDs().isEmpty()) {
+            return WebPermission.DATA_SERVER_PLAYERS_ONLINE;
+        } else {
+            return WebPermission.DATA_NETWORK_PLAYERS_ONLINE;
+        }
+    }
+
+    @Override
+    public DatapointType getType() {
+        return DatapointType.PLAYERS_ONLINE;
+    }
+}

Plan/common/src/test/java/com/djrapitops/plan/delivery/webserver/AccessControlTest.java

@@ -219,6 +219,9 @@ static Stream<Arguments> testCases() {
                 Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE_PEAK", WebPermission.DATA_NETWORK_PLAYERS_ONLINE_PEAK, 200, 403),
                 Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE_PEAK&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_PLAYERS_ONLINE_PEAK, 200, 403),
                 Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE_PEAK&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER, 400, 403),
+                Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE", WebPermission.DATA_NETWORK_PLAYERS_ONLINE, 200, 403),
+                Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_PLAYERS_ONLINE, 200, 403),
+                Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER, 400, 403),
                 Arguments.of("/v1/datapoint?type=REGULAR_PLAYERS", WebPermission.DATA_NETWORK_REGULAR_PLAYERS, 200, 403),
                 Arguments.of("/v1/datapoint?type=REGULAR_PLAYERS&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_REGULAR_PLAYERS, 200, 403),
                 Arguments.of("/v1/datapoint?type=REGULAR_PLAYERS&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER, 400, 403),

Plan/react/dashboard/src/components/cards/server/values/ServerAsNumbersCard.jsx

@@ -2,7 +2,6 @@ import {useTranslation} from "react-i18next";
 import {Card} from "react-bootstrap";
 import {FontAwesomeIcon as Fa} from "@fortawesome/react-fontawesome";
 import {faBookOpen, faChartLine, faCrosshairs, faSkull, faUser, faUsers} from "@fortawesome/free-solid-svg-icons";
-import Datapoint from "../../../datapoint/Datapoint.tsx";
 import {faCalendarCheck, faClock} from "@fortawesome/free-regular-svg-icons";
 import React from "react";
 import {CardLoader} from "../../../navigation/Loader.tsx";
@@ -45,9 +44,10 @@ const ServerAsNumbersCard = ({data}) => {
                                         color={'players-regular'} icon={faUsers}
                                         dataType={DatapointType.REGULAR_PLAYERS}
                                         filter={filter} bold/>
-                        <Datapoint name={t('html.label.playersOnline')}
-                                   color={'players-online'} icon={faUser}
-                                   value={data.online_players} bold/>
+                        <QueryDatapoint name={t('html.label.playersOnline')}
+                                        color={'players-online'} icon={faUser}
+                                        dataType={DatapointType.PLAYERS_ONLINE}
+                                        filter={filter} bold/>
                         <hr/>
                         <QueryDatapoint
                             name={t('html.label.lastPeak')}

Plan/react/dashboard/src/dataHooks/model/datapoint/Datapoint.ts

@@ -20,6 +20,7 @@ export enum DatapointType {
     UNIQUE_PLAYERS = "UNIQUE_PLAYERS",
     NEW_PLAYERS = "NEW_PLAYERS",
     REGULAR_PLAYERS = "REGULAR_PLAYERS",
+    PLAYERS_ONLINE = "PLAYERS_ONLINE",
     PLAYERS_ONLINE_PEAK = "PLAYERS_ONLINE_PEAK",
     SESSION_COUNT = "SESSION_COUNT",
     SESSION_LENGTH_AVERAGE = "SESSION_LENGTH_AVERAGE",
@@ -37,6 +38,7 @@ export type DatapointTypeMap = {
     UNIQUE_PLAYERS: number;
     NEW_PLAYERS: number;
     REGULAR_PLAYERS: number;
+    PLAYERS_ONLINE: number;
     SESSION_COUNT: number;
     SESSION_LENGTH_AVERAGE: number;
     PLAYTIME_PER_PLAYER_AVERAGE: number;