Search user messages WIP (#145)

conversejs/custom/index.js

@@ -44,6 +44,7 @@ import './plugins/singleton/index.js'
 import './plugins/fullscreen/index.js'
 
 import '../custom/plugins/size/index.js'
+import '../custom/plugins/mam-search/index.js'
 import '../custom/plugins/notes/index.js'
 import '../custom/plugins/tasks/index.js'
 import '../custom/plugins/terms/index.js'
@@ -61,6 +62,7 @@ CORE_PLUGINS.push('livechat-converse-tasks')
 CORE_PLUGINS.push('livechat-converse-terms')
 CORE_PLUGINS.push('livechat-converse-poll')
 CORE_PLUGINS.push('livechat-converse-notes')
+CORE_PLUGINS.push('livechat-converse-mam-search')
 // We must also add our custom ROOM_FEATURES, so that they correctly resets
 // (see headless/plugins/muc, getDiscoInfoFeatures, which loops on this const)
 ROOM_FEATURES.push('x_peertubelivechat_mute_anonymous')

conversejs/custom/plugins/mam-search/api.js

@@ -0,0 +1,100 @@
+// SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
+//
+// SPDX-License-Identifier: AGPL-3.0-only
+
+import { api, converse } from '../../../src/headless/index.js'
+import { XMLNS_MAM_SEARCH } from './constants.js'
+
+const env = converse.env
+const {
+  $iq,
+  Strophe,
+  sizzle,
+  log,
+  TimeoutError,
+  __,
+  u
+} = env
+const NS = Strophe.NS
+
+async function query (options) {
+  if (!api.connection.connected()) {
+    throw new Error('Can\'t call `api.livechat_mam_search.query` before having established an XMPP session')
+  }
+
+  if (!options?.room) {
+    throw new Error('api.livechat_mam_search.query: Missing room parameter.')
+  }
+
+  const attrs = {
+    type: 'set',
+    to: options.room
+  }
+
+  const jid = attrs.to
+  const supported = await api.disco.supports(XMLNS_MAM_SEARCH, jid)
+  if (!supported) {
+    log.warn(`Did not search MAM archive for ${jid} because it doesn't support ${XMLNS_MAM_SEARCH}`)
+    return { messages: [] }
+  }
+
+  const queryid = u.getUniqueId()
+  const stanza = $iq(attrs).c('query', { xmlns: XMLNS_MAM_SEARCH, queryid: queryid })
+
+  stanza.c('x', { xmlns: NS.XFORM, type: 'submit' })
+    .c('field', { var: 'FORM_TYPE', type: 'hidden' })
+    .c('value').t(XMLNS_MAM_SEARCH).up().up()
+
+  if (options.from) {
+    stanza.c('field', { var: 'from' }).c('value')
+      .t(options.from).up().up()
+  }
+  if (options.occupant_id) {
+    stanza.c('field', { var: 'occupant_id' }).c('value')
+      .t(options.occupant_id).up().up()
+  }
+  stanza.up()
+
+  // TODO: handle RSM (pagination.)
+
+  const connection = api.connection.get()
+
+  const messages = []
+  const messageHandler = connection.addHandler((stanza) => {
+    const result = sizzle(`message > result[xmlns="${NS.MAM}"]`, stanza).pop()
+    if (result === undefined || result.getAttribute('queryid') !== queryid) {
+      return true
+    }
+    const from = stanza.getAttribute('from')
+    if (from !== attrs.to) {
+      log.warn(`Ignoring alleged groupchat MAM message from ${from}`)
+      return true
+    }
+    messages.push(stanza)
+    return true
+  }, NS.MAM)
+
+  let error
+  const timeout = api.settings.get('message_archiving_timeout')
+  const iqResult = await api.sendIQ(stanza, timeout, false)
+
+  if (iqResult === null) {
+    const errMsg = __('Timeout while trying to fetch archived messages.')
+    log.error(errMsg)
+    error = new TimeoutError(errMsg)
+    return { messages, error }
+  } else if (u.isErrorStanza(iqResult)) {
+    const errMsg = __('An error occurred while querying for archived messages.')
+    log.error(errMsg)
+    log.error(iqResult)
+    error = new Error(errMsg)
+    return { messages, error }
+  }
+  connection.deleteHandler(messageHandler)
+
+  return { messages }
+}
+
+export default {
+  query
+}

conversejs/custom/plugins/mam-search/constants.js

@@ -0,0 +1,5 @@
+// SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
+//
+// SPDX-License-Identifier: AGPL-3.0-only
+
+export const XMLNS_MAM_SEARCH = 'urn:xmpp:mam:2#x-search'

conversejs/custom/plugins/mam-search/index.js

@@ -0,0 +1,71 @@
+// SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
+//
+// SPDX-License-Identifier: AGPL-3.0-only
+
+import { api, converse } from '../../../src/headless/index.js'
+import { XMLNS_MAM_SEARCH } from './constants.js'
+import mamSearchApi from './api.js'
+import { __ } from 'i18n'
+
+converse.plugins.add('livechat-converse-mam-search', {
+  dependencies: ['converse-muc', 'converse-muc-views'],
+  async initialize () {
+    const _converse = this._converse
+
+    Object.assign(api, {
+      livechat_mam_search: mamSearchApi
+    })
+
+    // Adding buttons on message:
+    _converse.api.listen.on('getMessageActionButtons', getMessageActionButtons)
+
+    // FIXME: should we listen to any event (feature/affiliation change?, mam_enabled?) to refresh messageActionButtons?
+  }
+})
+
+function getMessageActionButtons (messageActionsEl, buttons) {
+  const messageModel = messageActionsEl.model
+  if (messageModel.get('type') !== 'groupchat') {
+    // only on groupchat message.
+    return buttons
+  }
+
+  if (!messageModel.occupant) {
+    return buttons
+  }
+
+  const muc = messageModel.collection?.chatbox
+  if (!muc) {
+    return buttons
+  }
+
+  if (!muc.features?.get?.(XMLNS_MAM_SEARCH)) {
+    return buttons
+  }
+
+  const myself = muc.getOwnOccupant()
+  if (!myself || !['admin', 'owner'].includes(myself.get('affiliation'))) {
+    return buttons
+  }
+
+  // eslint-disable-next-line no-undef
+  const i18nSearch = __(LOC_search_occupant_message)
+
+  buttons.push({
+    i18n_text: i18nSearch,
+    handler: async (ev) => {
+      ev.preventDefault()
+      console.log(await api.livechat_mam_search.query({
+        room: muc.get('jid'),
+        // FIXME: shouldn't we escape the nick? cant see any code that escapes it in Converse.
+        from: messageModel.occupant.get('from') || muc.get('jid') + '/' + (messageModel.occupant.get('nick') ?? ''),
+        occupant_id: messageModel.occupant.get('occupant_id')
+      }))
+    },
+    button_class: '',
+    icon_class: 'fa fa-magnifying-glass',
+    name: 'muc-mam-search'
+  })
+
+  return buttons
+}

conversejs/custom/plugins/notes/utils.js

@@ -43,39 +43,41 @@ export function getMessageActionButtons (messageActionsEl, buttons) {
     return buttons
   }
 
+  if (!messageModel.occupant) {
+    return buttons
+  }
+
   const muc = messageModel.collection?.chatbox
   if (!muc?.notes) {
     return buttons
   }
 
-  if (messageModel.occupant) {
-    // eslint-disable-next-line no-undef
-    const i18nCreate = __(LOC_moderator_note_create_for_participant)
-    // eslint-disable-next-line no-undef
-    const i18nSearch = __(LOC_moderator_note_search_for_participant)
+  // eslint-disable-next-line no-undef
+  const i18nCreate = __(LOC_moderator_note_create_for_participant)
+  // eslint-disable-next-line no-undef
+  const i18nSearch = __(LOC_moderator_note_search_for_participant)
 
-    buttons.push({
-      i18n_text: i18nCreate,
-      handler: async (ev) => {
-        ev.preventDefault()
-        await api.livechat_notes.openCreateNoteForm(messageModel.occupant)
-      },
-      button_class: '',
-      icon_class: 'fa fa-note-sticky',
-      name: 'muc-note-create-for-occupant'
-    })
+  buttons.push({
+    i18n_text: i18nCreate,
+    handler: async (ev) => {
+      ev.preventDefault()
+      await api.livechat_notes.openCreateNoteForm(messageModel.occupant)
+    },
+    button_class: '',
+    icon_class: 'fa fa-note-sticky',
+    name: 'muc-note-create-for-occupant'
+  })
 
-    buttons.push({
-      i18n_text: i18nSearch,
-      handler: async (ev) => {
-        ev.preventDefault()
-        await api.livechat_notes.searchNotesAbout(messageModel.occupant)
-      },
-      button_class: '',
-      icon_class: 'fa fa-magnifying-glass',
-      name: 'muc-note-search-for-occupant'
-    })
-  }
+  buttons.push({
+    i18n_text: i18nSearch,
+    handler: async (ev) => {
+      ev.preventDefault()
+      await api.livechat_notes.searchNotesAbout(messageModel.occupant)
+    },
+    button_class: '',
+    icon_class: 'fa fa-magnifying-glass',
+    name: 'muc-note-search-for-occupant'
+  })
 
   return buttons
 }