nodebb-plugin-admin-chats 3.6.1 → 3.8.0

package/lib/activity.js

@@ -0,0 +1,88 @@
+'use strict';
+
+// Last-activity ordering for the admin chat list. Core only keeps such
+// ordering per user (`uid:<uid>:chat:rooms`, bumped on every message) — the
+// global `chat:rooms` set is scored once at room creation and never again,
+// so listing from it sorts by creation date and buries active rooms. This
+// module maintains a plugin-owned set scored like the per-user one.
+
+const Messaging = nodebb.require('./src/messaging');
+const db = nodebb.require('./src/database');
+
+const ACTIVITY_SET = 'admin-chats:rooms:lastpost';
+const BACKFILL_BATCH_SIZE = 100;
+
+function overrideForActivityTracking() {
+    if (typeof Messaging.addRoomToUsers === 'function' && !Messaging.addRoomToUsers._adminChatsActivityWrapped) {
+        const originalAddRoomToUsers = Messaging.addRoomToUsers;
+
+        // addRoomToUsers is core's own "bump this private room" signal — it runs
+        // on private room creation (src/messaging/rooms.js) and on every message
+        // (src/messaging/create.js), always with the activity timestamp.
+        const wrappedAddRoomToUsers = async function (roomId, uids, timestamp) {
+            await db.sortedSetAdd(ACTIVITY_SET, timestamp, roomId);
+            return await originalAddRoomToUsers.call(this, roomId, uids, timestamp);
+        };
+
+        wrappedAddRoomToUsers._adminChatsActivityWrapped = true;
+        Messaging.addRoomToUsers = wrappedAddRoomToUsers;
+    }
+
+    if (typeof Messaging.deleteRooms === 'function' && !Messaging.deleteRooms._adminChatsActivityWrapped) {
+        const originalDeleteRooms = Messaging.deleteRooms;
+
+        const wrappedDeleteRooms = async function (roomIds) {
+            const result = await originalDeleteRooms.call(this, roomIds);
+            await db.sortedSetRemove(ACTIVITY_SET, Array.isArray(roomIds) ? roomIds : [roomIds]);
+            return result;
+        };
+
+        wrappedDeleteRooms._adminChatsActivityWrapped = true;
+        Messaging.deleteRooms = wrappedDeleteRooms;
+    }
+}
+
+// Reconcile on startup: private rooms not yet in the activity set (created
+// before this feature existed, or while the plugin was disabled) get scored
+// by their last message's timestamp, falling back to room creation time.
+async function backfillActivitySet() {
+    const allRooms = await db.getSortedSetRangeWithScores('chat:rooms', 0, -1);
+    if (!allRooms.length) {
+        return;
+    }
+
+    const roomIds = allRooms.map(item => item.value);
+    const [inActivitySet, isPublic] = await Promise.all([
+        db.isSortedSetMembers(ACTIVITY_SET, roomIds),
+        db.isSortedSetMembers('chat:rooms:public', roomIds),
+    ]);
+
+    const missing = allRooms.filter((item, index) => !inActivitySet[index] && !isPublic[index]);
+
+    for (let offset = 0; offset < missing.length; offset += BACKFILL_BATCH_SIZE) {
+        const batch = missing.slice(offset, offset + BACKFILL_BATCH_SIZE);
+        const lastMessages = await Promise.all(
+            batch.map(item => db.getSortedSetRevRangeWithScores(`chat:room:${item.value}:mids`, 0, 0))
+        );
+        await db.sortedSetAddBulk(batch.map((item, index) => [
+            ACTIVITY_SET,
+            (lastMessages[index][0] && lastMessages[index][0].score) || item.score,
+            item.value,
+        ]));
+    }
+}
+
+// Entries whose room no longer resolves (deleted outside deleteRooms, or
+// before this module wrapped it) are pruned lazily by the room list.
+async function pruneActivityEntries(roomIds) {
+    if (roomIds.length) {
+        await db.sortedSetRemove(ACTIVITY_SET, roomIds);
+    }
+}
+
+module.exports = {
+    ACTIVITY_SET,
+    overrideForActivityTracking,
+    backfillActivitySet,
+    pruneActivityEntries,
+};

package/lib/routes.js

@@ -11,9 +11,9 @@ const sockets = nodebb.require('./src/socket.io');
 const { canAccessAdminChats, canManageAdminChats } = require('./access');
 const { getMessageEditHistory, deleteRevision } = require('./history');
 const { roomExists, lockRoom, unlockRoom, getRoomLockData } = require('./lock');
+const { ACTIVITY_SET, pruneActivityEntries } = require('./activity');
 
 const ADMIN_CHAT_PAGE_SIZE = 30;
-const ADMIN_CHAT_SCAN_SIZE = 100;
 
 async function assertAdminChatsAccess(req, res) {
     if (!req.uid || !await canAccessAdminChats(req.uid)) {
@@ -132,34 +132,32 @@ async function getPrivateRoomCount() {
 }
 
 async function getAdminRecentChats(uid, start, limit) {
-    let cursor = Math.max(0, parseInt(start, 10) || 0);
-    const roomPairs = [];
+    const cursor = Math.max(0, parseInt(start, 10) || 0);
 
-    while (roomPairs.length < limit) {
-        const roomIds = await db.getSortedSetRevRange('chat:rooms', cursor, cursor + ADMIN_CHAT_SCAN_SIZE - 1);
-        if (!roomIds.length) {
-            break;
-        }
+    // The activity set is scored by each room's last message (see lib/activity.js),
+    // so a plain reverse range yields the same most-recent-first ordering the
+    // user's own chats page gets from `uid:<uid>:chat:rooms`.
+    const allRoomIds = await db.getSortedSetRevRange(ACTIVITY_SET, cursor, cursor + limit - 1);
+    const allRooms = await Messaging.getRoomsData(allRoomIds);
 
-        const rooms = await Messaging.getRoomsData(roomIds);
-        rooms.forEach((room, index) => {
-            if (room && !room.public && roomPairs.length < limit) {
-                roomPairs.push({ roomId: roomIds[index], room });
-            }
-        });
-
-        cursor += roomIds.length;
-        if (roomIds.length < ADMIN_CHAT_SCAN_SIZE) {
-            break;
+    const roomPairs = [];
+    const staleRoomIds = [];
+    allRooms.forEach((room, index) => {
+        if (room && !room.public) {
+            roomPairs.push({ roomId: allRoomIds[index], room });
+        } else if (!room) {
+            staleRoomIds.push(allRoomIds[index]);
         }
-    }
+    });
+
+    await pruneActivityEntries(staleRoomIds);
 
     const rooms = roomPairs.map(item => item.room);
     const roomIds = roomPairs.map(item => item.roomId);
 
     await enrichAdminRecentRooms(uid, roomIds, rooms);
 
-    return { rooms, nextStart: cursor };
+    return { rooms, nextStart: cursor + allRoomIds.length };
 }
 
 async function enrichAdminRecentRooms(uid, roomIds, rooms) {
@@ -354,6 +352,36 @@ function registerRoutes(app, router, middleware) {
         }
     });
 
+    // Room deletion from the admin-chats page. Core's DELETE
+    // /api/v3/admin/chats/:roomId is gated on real admin privileges
+    // (middleware.admin.checkPrivileges), so holders of the
+    // admin-chats:manage privilege cannot use it — this endpoint accepts
+    // them too. Goes through Messaging.deleteRooms, so the activity-set
+    // wrapper (lib/activity.js) prunes the deleted room from the admin list.
+    router.delete('/api/admin-chats/:roomId', ...routeMiddleware, async (req, res) => {
+        try {
+            const roomId = parseInt(req.params.roomId, 10);
+
+            if (!req.uid || Number.isNaN(roomId)) {
+                return res.status(400).json({ status: { code: 'bad-request', message: 'Invalid room id' } });
+            }
+
+            if (!await User.isAdministrator(req.uid) && !await canManageAdminChats(req.uid)) {
+                return res.status(403).json({ status: { code: 'forbidden', message: 'Admin or manage privilege required' } });
+            }
+
+            if (!await roomExists(roomId)) {
+                return res.status(404).json({ status: { code: 'not-found', message: 'Room not found' } });
+            }
+
+            await Messaging.deleteRooms([roomId]);
+
+            return res.json({ status: { code: 'ok', message: 'Room deleted' }, roomId });
+        } catch (err) {
+            return res.status(500).json({ status: { code: 'error', message: err.message } });
+        }
+    });
+
     router.get('/api/admin-chats/:roomId/lock', ...routeMiddleware, async (req, res) => {
         try {
             const roomId = parseInt(req.params.roomId, 10);

package/library.js

@@ -3,6 +3,7 @@
 const hooks = require('./lib/hooks');
 const { registerRoutes, renderAdminChatsPage } = require('./lib/routes');
 const { overrideMessagingFunctions, overrideChatsApi, overrideCoreChatRedirect } = require('./lib/overrides');
+const { overrideForActivityTracking, backfillActivitySet } = require('./lib/activity');
 
 const plugin = Object.assign({}, hooks);
 
@@ -11,6 +12,8 @@ plugin.init = async function (params) {
     overrideMessagingFunctions();
     overrideChatsApi();
     overrideCoreChatRedirect(params.controllers, renderAdminChatsPage);
+    overrideForActivityTracking();
+    await backfillActivitySet();
 };
 
 module.exports = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-admin-chats",
-  "version": "3.6.1",
+  "version": "3.8.0",
   "description": "A plugin that allows the administrator to view and manage user chats.",
   "main": "library.js",
   "nbbpm": {

package/plugin.json

@@ -8,6 +8,7 @@
   "scripts": [
     "static/lib/switch-chat.js",
     "static/lib/lock-toggle.js",
+    "static/lib/delete-room.js",
     "static/lib/live-updates.js",
     "static/lib/profile-link.js",
     "static/lib/message-history.js"

package/public/languages/ar/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/de/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/de-CH/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/el/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/en/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/en-GB/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/es/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/fr/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/fr-CH/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/he/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "לא ניתן לטעון או לעדכן את היסטוריית העריכות.",
   "history.restore": "שחזור גרסה",
   "history.restored": "ההודעה שוחזרה לגרסה שנבחרה",
-  "history.restoreDescription": "שחזור יציב את תוכן הגרסה שנבחרה כגרסה הנוכחית; הגרסה שהוחלפה תישמר בהיסטוריה."
+  "history.restoreDescription": "שחזור יציב את תוכן הגרסה שנבחרה כגרסה הנוכחית; הגרסה שהוחלפה תישמר בהיסטוריה.",
+  "errors.delete": "לא ניתן למחוק את חדר הצ'אט."
 }

package/public/languages/hi/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/it/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/it-CH/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/ja/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/nl/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/pl/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/pt-BR/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/rm-CH/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/ru/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/uk/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/zh-CN/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/public/languages/zh-TW/admin-chats.json

@@ -18,5 +18,6 @@
   "errors.history": "Unable to load or update the edit history.",
   "history.restore": "Restore version",
   "history.restored": "Message restored to the selected version",
-  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history."
+  "history.restoreDescription": "Restoring sets the selected version as the current one; the replaced version is kept in the history.",
+  "errors.delete": "Unable to delete the chat room."
 }

package/static/lib/delete-room.js

@@ -0,0 +1,67 @@
+'use strict';
+
+// The Delete Room menu item on the admin-all-chats page is rendered
+// server-side (templates/partials/chats/options.tpl, gated on the manage
+// privilege via room.isAdmin). It deliberately does NOT use core's
+// data-action="delete": core's handler calls the admin-only
+// DELETE /api/v3/admin/chats/:roomId endpoint, which rejects non-admin
+// holders of the admin-chats:manage privilege — so the click goes through
+// the plugin's own endpoint, which accepts them too.
+$(document).ready(function () {
+    async function deleteRoom(roomId) {
+        const response = await fetch(`${config.relative_path || ''}/api/admin-chats/${roomId}`, {
+            method: 'DELETE',
+            headers: {
+                'x-csrf-token': config.csrf_token,
+            },
+            credentials: 'same-origin',
+        });
+
+        if (!response.ok) {
+            throw new Error('Unable to delete room');
+        }
+
+        return await response.json();
+    }
+
+    $(document).on('click', '.admin-chat-delete-room-item', function (ev) {
+        ev.preventDefault();
+
+        const $button = $(this);
+        const roomId = parseInt($button.attr('data-room-id'), 10);
+
+        if (!roomId || $button.hasClass('disabled')) {
+            return;
+        }
+
+        require(['modals', 'forum/chats'], function (modals, Chats) {
+            // Same confirm dialog core shows for its own Delete Room item
+            modals.confirm({
+                size: 'small',
+                title: '[[modules:chat.delete]]',
+                message: '<p>[[modules:chat.delete-prompt]]</p>',
+                callback: async function (ok) {
+                    if (!ok) {
+                        return;
+                    }
+
+                    $button.addClass('disabled').attr('aria-disabled', 'true');
+
+                    try {
+                        await deleteRoom(roomId);
+                        // Drop the room from the sidebar lists and close the
+                        // open chat window (the patched switchChat renders the
+                        // empty state for a falsy roomId)
+                        $(`[component="chat/nav-wrapper"] [data-roomid="${roomId}"]`).remove();
+                        if (Chats && Chats.switchChat) {
+                            Chats.switchChat('');
+                        }
+                    } catch (err) {
+                        app.alertError('[[admin-chats:errors.delete]]');
+                        $button.removeClass('disabled').removeAttr('aria-disabled');
+                    }
+                },
+            });
+        });
+    });
+});

package/templates/partials/chats/options.tpl

@@ -81,13 +81,20 @@
 				</a>
 			</li>
 			{{{ end }}}
-			{{{ if (public && isAdmin) }}}
+			{{{ if ((public && isAdmin) && !adminAllChats) }}}
 			<li>
 				<a class="dropdown-item rounded-1 d-flex align-items-center gap-2" href="#" data-action="delete" role="menuitem">
 					<i class="fa fa-fw text-danger fa-trash"></i> {{tx("modules:chat.delete-room")}}
 				</a>
 			</li>
 			{{{ end }}}
+			{{{ if (adminAllChats && isAdmin) }}}
+			<li>
+				<a class="dropdown-item rounded-1 d-flex align-items-center gap-2 admin-chat-delete-room-item" href="#" data-room-id="{roomId}" role="menuitem">
+					<i class="fa fa-fw text-danger fa-trash"></i> {{tx("modules:chat.delete-room")}}
+				</a>
+			</li>
+			{{{ end }}}
 		</ul>
 	</div>