Package io.meeds.chat.service

Class MatrixService

java.lang.Object
io.meeds.chat.service.MatrixService
@Service public class MatrixService extends Object

  • Field Details

    • CHAT_APPLICATION_ID

      public static final String CHAT_APPLICATION_ID
      See Also:

    • USER_MATRIX_ID_CACHE_NAME

      public static final String USER_MATRIX_ID_CACHE_NAME
      See Also:

    • defaultAuthorizedSpaceTemplates

      @Value("#{\'${meeds.chat.authorized.space.templates:project,circle}\'.split(\',\')}") public List<String> defaultAuthorizedSpaceTemplates

    • USER_ACCESS_TOKEN_CACHE_NAME

      public static final String USER_ACCESS_TOKEN_CACHE_NAME
      See Also:

  • Constructor Details

    • MatrixService

      public MatrixService(MatrixRoomStorage matrixRoomStorage, org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.social.core.storage.api.IdentityStorage identityStorage, org.exoplatform.services.organization.OrganizationService organizationService, MatrixHttpClient matrixHttpClient, org.exoplatform.services.cache.CacheService cacheService, org.exoplatform.commons.api.settings.SettingService settingService, io.meeds.social.space.template.service.SpaceTemplateService spaceTemplateService)

  • Method Details

    • init

      @PostConstruct public void init()
      Kicks off the connection to the Matrix server on a background thread so that the (possibly slow, possibly retried) handshake never blocks the WAR deployment / server startup. See AsyncTaskUtils.runAsync(java.lang.String, java.lang.Runnable) for the escape hatch used by tests to run it synchronously instead.

    • isServiceEnabled

      public boolean isServiceEnabled()
      Checks if the Chat feature is enabled and that the Matrix service is available
      Returns:
      the status fo the chat service and feature

    • getUserFullMatrixID

      public String getUserFullMatrixID(String userName)
      Convert the user id into the full Matrix ID format
      Parameters:
      userName - the username
      Returns:
      formatted username

    • getAccessToken

      public String getAccessToken(String jwtToken) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Retrieves an access token for a user using a JWT token
      Parameters:
      jwtToken - the Json Web Token
      Returns:
      String the access token
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • invalidateAccessToken

      public boolean invalidateAccessToken(String accessToken)
      Invalidate a specific access token
      Parameters:
      accessToken - the access token to be invalidated
      Returns:
      true if success

    • updateUserDisplayName

      public void updateUserDisplayName(String matrixFullID, String newDisplayName)

    • getRoomBySpace

      public Room getRoomBySpace(org.exoplatform.social.core.space.model.Space space)
      Returns the ID of the room linked to a space
      Parameters:
      space - the space
      Returns:
      the roomId linked to the space

    • getRoomBySpace

      public Room getRoomBySpace(org.exoplatform.social.core.space.model.Space space, boolean includeDisabled)
      Returns the ID of the room linked to a space
      Parameters:
      space - the space
      Returns:
      the roomId linked to the space

    • getRoomBySpaceId

      public Room getRoomBySpaceId(Long spaceId)
      Returns the ID of the room linked to a space
      Parameters:
      spaceId - the space Id
      Returns:
      the roomId linked to the space

    • getRoomBySpaceId

      public Room getRoomBySpaceId(Long spaceId, boolean includeDisabled)
      Returns the ID of the room linked to a space
      Parameters:
      spaceId - the space Id
      Returns:
      the roomId linked to the space

    • getById

      public Room getById(String roomId)
      Get a room by its technical ID
      Parameters:
      roomId - the room technical ID
      Returns:
      Room

    • getById

      public Room getById(String roomId, boolean includeDisabled)
      Get a room by its technical ID
      Parameters:
      roomId - the room technical ID
      includeDisabled - return room even if it is disabled
      Returns:
      Room

    • linkSpaceToMatrixRoom

      public Room linkSpaceToMatrixRoom(org.exoplatform.social.core.space.model.Space space, String roomId)
      records the matrix ID of the room linked to the space
      Parameters:
      space - the Space
      roomId - the ID of the matrix room
      Returns:
      the room ID

    • linkSpaceToMatrixRoom

      public Room linkSpaceToMatrixRoom(long spaceId, String roomId, RoomStatus roomStatus)
      records the matrix ID of the room linked to the space
      Parameters:
      spaceId - the Space identifier
      roomId - the ID of the matrix room
      Returns:
      the room ID

    • createRoomForSpaceOnMatrix

      public String createRoomForSpaceOnMatrix(org.exoplatform.social.core.space.model.Space space) throws Exception
      Creates a room on Matrix for the space
      Parameters:
      space - the space
      Returns:
      String representing the room id
      Throws:
      Exception - when creating the room fails on Matrix

    • getMatrixIdForUser

      public String getMatrixIdForUser(String userName)
      Get the matrix ID of a defined user
      Parameters:
      userName - of the user
      Returns:
      the matrix ID

    • getJWTSessionToken

      public String getJWTSessionToken(String userNameOnMatrix)
      Returns the JWT for user authentication
      Parameters:
      userNameOnMatrix - the username of the current user
      Returns:
      String

    • saveUserAccount

      public String saveUserAccount(org.exoplatform.social.core.identity.model.Identity user, boolean isNew) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Saves a new user on Matrix
      Parameters:
      user - the user identity
      isNew - if the user has been just created
      Returns:
      the matrix user ID
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • saveUserAccount

      public String saveUserAccount(org.exoplatform.social.core.identity.model.Identity user, boolean isNew, boolean isEnableUserOperation, boolean isUserEnabled) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Saves a new user on Matrix
      Parameters:
      user - the user to create on Matrix
      isNew - boolean if the user is new, then true
      Returns:
      String the matrix user ID
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • uploadFileOnMatrix

      public String uploadFileOnMatrix(String fileName, String mimeType, byte[] fileBytes) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • updateUserAvatar

      public void updateUserAvatar(org.exoplatform.social.core.identity.model.Profile profile, String userMatrixID) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • disableAccount

      public void disableAccount(String matrixUsername) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • updateRoomDescription

      public boolean updateRoomDescription(String roomId, String description) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • updateRoomAvatar

      public void updateRoomAvatar(org.exoplatform.social.core.space.model.Space space, String roomId) throws Exception
      Throws:
      Exception

    • getRoomSettings

      public MatrixRoomPermissions getRoomSettings(String roomId) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • updateRoomSettings

      public boolean updateRoomSettings(String roomId, MatrixRoomPermissions matrixRoomPermissions) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • kickUserFromRoom

      public void kickUserFromRoom(String roomId, String matrixIdOfUser, String message) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • joinUserToRoom

      public void joinUserToRoom(String roomId, String matrixIdOfUser) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • isUserMemberOfRoom

      public boolean isUserMemberOfRoom(String roomId, String matrixIdOfUser) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Checks if the user is a member of the room
      Parameters:
      roomId - the room ID
      matrixIdOfUser - the ID of the user on Matrix
      Returns:
      true if the user is a member of the room, false otherwise
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • renameRoom

      public void renameRoom(String roomId, String spaceDisplayName) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • makeUserAdminInRoom

      public void makeUserAdminInRoom(String matrixRoomId, String matrixIdOfUser) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • createRoom

      public String createRoom(org.exoplatform.social.core.space.model.Space space) throws Exception
      This function do : - Create a room on Matrix - Links the room to the space on Meeds - Update room permissions
      Parameters:
      space - The space
      Returns:
      The room ID
      Throws:
      Exception

    • getDirectMessagingRoom

      public Room getDirectMessagingRoom(String firstParticipant, String secondParticipant)

    • deleteRoom

      public void deleteRoom(String roomId) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Delete a Matrix room
      Parameters:
      roomId - the room identifier
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException
      IOException
      InterruptedException

    • createDirectMessagingRoom

      public Room createDirectMessagingRoom(Room directMessagingRoom) throws org.exoplatform.commons.ObjectAlreadyExistsException
      Creates a one to one room
      Parameters:
      directMessagingRoom - the Object representation of a one to one room
      Returns:
      the created Room
      Throws:
      org.exoplatform.commons.ObjectAlreadyExistsException - in case a room between the same users is already created

    • getMatrixDMRoomsOfUser

      public List<Room> getMatrixDMRoomsOfUser(String user)
      Loads all the one to one rooms of a defined user
      Parameters:
      user - the username of the user
      Returns:
      List of Room

    • isUserMemberOfGroups

      public boolean isUserMemberOfGroups(String userName, String... groups) throws Exception
      Checks if the user is a member of a group defined by its name
      Parameters:
      userName - the userName
      groups - the list of groups
      Returns:
      true if the user is a member of the group
      Throws:
      Exception - error finding the user

    • getSpaceRooms

      public List<Room> getSpaceRooms()
      Returns a list of all space rooms
      Returns:
      List of Space rooms

    • extractUserId

      public String extractUserId(String fullMatrixUserId)
      Extracts the user ID from the full User Id on Matrix
      Parameters:
      fullMatrixUserId - the full Matrix user Id
      Returns:
      the user Identifier

    • extractRoomId

      public String extractRoomId(String fullMatrixUserId)
      Extracts the room ID from the full room Id on Matrix
      Parameters:
      fullMatrixUserId - the full Matrix user Id
      Returns:
      the user Identifier

    • updateUserPresence

      public String updateUserPresence(String userIdOnMatrix, String presence, String statusMessage)
      update the user presence status on Matrix
      Parameters:
      userIdOnMatrix - the user Id on Matrix
      presence - the presence value: online , unavailable, offline
      statusMessage - a personalized status message

    • canAccess

      public boolean canAccess(Room room, String userName)
      Checks if the user able to access the room
      Parameters:
      room - the room
      userName - the username of the user
      Returns:
      true if he has access, false otherwise

    • enableSpaceChat

      public Room enableSpaceChat(org.exoplatform.social.core.space.model.Space space, boolean enable) throws org.exoplatform.commons.exception.ObjectNotFoundException
      Enable the chat for the space
      Parameters:
      space - the space where the chat will be disabled/enabled
      enable - true to enable the room, false to disable it
      Returns:
      Room the updated room
      Throws:
      org.exoplatform.commons.exception.ObjectNotFoundException

    • overrideAdminRateLimit

      public void overrideAdminRateLimit(String adminUserId)
      Overrides the rate limits for the current administrator to unlimited
      Parameters:
      adminUserId - the admin username on Matrix

    • getRoomEvent

      public MatrixMessage getRoomEvent(String eventId, String roomId, String token)
      Retrieves the message related to the event ID
      Parameters:
      eventId - the event ID
      roomId - the room ID
      Returns:
      MatrixMessage the received message

    • getRoomEvent

      public MatrixMessage getRoomEvent(String eventId, String roomId)
      Retrieves the message related to the event ID
      Parameters:
      eventId - the event ID
      roomId - the room ID
      Returns:
      MatrixMessage the received message

    • findSpaceMemberByMatrixId

      public org.exoplatform.social.core.identity.model.Identity findSpaceMemberByMatrixId(String matrixId, org.exoplatform.social.core.space.model.Space space)
      Finds the identity of a user based on its Matrix ID and a space where he is a member
      Parameters:
      matrixId - the Matrix identifier of the user
      space - the space
      Returns:
      the identity of the space member

    • findUserByMatrixId

      public String findUserByMatrixId(String userMatrixId)
      find the user on Meeds based on his id on Matrix
      Parameters:
      userMatrixId - the ID of the user on Matrix
      Returns:
      the user Identity

    • cleanMatrixUsername

      public String cleanMatrixUsername(String userName)
      Cleans the username to be compatible with the usernames on Matrix server
      Parameters:
      userName - the user identifier
      Returns:
      String the cleaned username

    • getRestrictedGroups

      public String[] getRestrictedGroups()
      Returns the restricted group of users if it is configured
      Returns:
      Array of group names

    • getMediaInfo

      public Optional<MediaInfo> getMediaInfo(String mediaId) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Returns synapse media info by its ID
      Parameters:
      mediaId - synapse media id
      Returns:
      MediaInfo wrapped in Optional, or Optional.empty() if mediaId is null or blank
      Throws:
      org.exoplatform.ws.frameworks.json.impl.JsonException - if there is an error parsing the JSON response from the server
      IOException - if a network or I/O error occurs during the request
      InterruptedException - if the thread executing the request is interrupted

    • deleteMedia

      public void deleteMedia(String mediaId) throws org.exoplatform.ws.frameworks.json.impl.JsonException, IOException, InterruptedException
      Deletes synapse media by its ID
      Parameters:
      mediaId - synapse media id
      Throws:
      IllegalArgumentException - if mediaId is null or blank
      org.exoplatform.ws.frameworks.json.impl.JsonException - if there is an error parsing the JSON response from the server
      IOException - if a network or I/O error occurs during the request
      InterruptedException - if the thread executing the request is interrupted

    • loadChatSettings

      public ChatSettingsEntity loadChatSettings()
      retrieves the chat settings
      Returns:
      the status of the chat feature

    • loadChatSettings

      public ChatSettingsEntity loadChatSettings(String userName, Locale locale)
      retrieves the chat settings
      Parameters:
      userName - the caller username
      locale - the caller Locale
      Returns:
      the Chat settings

    • saveChatSettings

      public void saveChatSettings(ChatSettings chatSettings)
      Sets the settings of the chat feature
      Parameters:
      chatSettings - the new status fo the chat enabled/disabled

    • isChatAuthorizedForSpace

      public boolean isChatAuthorizedForSpace(Long spaceId)
      Check if Chat application is authorized for the space based on its template
      Parameters:
      spaceId - The space identifier
      Returns:
      boolean : true if the chat is authorized

    • isChatAuthorizedForSpace

      public boolean isChatAuthorizedForSpace(org.exoplatform.social.core.space.model.Space space)
      Check if Chat application is authorized for the space based on its template
      Parameters:
      space - The space
      Returns:
      boolean : true if the chat is authorized

    • isChatAuthorizedForSpaceTemplate

      public boolean isChatAuthorizedForSpaceTemplate(org.exoplatform.social.core.space.model.Space space)
      Checks if the Chat is authorized for the template used to create the space
      Parameters:
      space - The given space
      Returns:
      True if the chat was authorized for this space template

    • isChatAuthorizedByAdministration

      public boolean isChatAuthorizedByAdministration(org.exoplatform.social.core.space.model.Space space)
      Checks if the Chat is authorized from the administration for the space
      Parameters:
      space - The given space
      Returns:
      True if the chat was authorized for this space

    • isChatEnabledByDefault

      public boolean isChatEnabledByDefault(org.exoplatform.social.core.space.model.Space space)
      Check if the chat is enabled and synched be default for the provided space
      Parameters:
      space - the related space
      Returns:
      boolean True if the chat is enabled by default

    • changeChatRoomReadability

      public void changeChatRoomReadability(String roomId, boolean readOnly)
      Sets the room to readOnly
      Parameters:
      roomId - the room identifier
      readOnly - true if the room will be set readonly

    • getUserConversations

      public List<ChatConversation> getUserConversations(String userName)
      Lists the conversations the given user participates in: their direct messaging rooms and the rooms of the spaces they are a member of. Used by the list_chat_conversations MCP tool to give AI agents the user's chat context.
      Parameters:
      userName - the Meeds username
      Returns:
      the user's conversations, never null

    • getRoomEventAsUser

      public MatrixMessage getRoomEventAsUser(String userName, String roomId, String eventId)
      Reads one event back with the user's own Matrix identity, so an event of a room the administrator account cannot see (a direct message) resolves too.
      Parameters:
      userName - the platform user
      roomId - the room (local or full id)
      eventId - the event to read back
      Returns:
      the event, or null when it cannot be read

    • markRoomAsRead

      public boolean markRoomAsRead(String userName, String roomId, String eventId)
      Marks a room as read for a user up to an event, with the user's own Matrix identity (server-side read anchor): posts the m.read receipt so every client of the user converges through Matrix sync.
      Parameters:
      userName - the platform user
      roomId - the room (local or full id)
      eventId - the event read up to (high-water mark)
      Returns:
      true when the receipt was posted

    • getRoomMessages

      public List<ChatMessage> getRoomMessages(String userName, String roomId, int limit)
      Returns the most recent messages of a conversation, in chronological order, read as the given user so that Synapse enforces exactly what that user is allowed to see (membership, history visibility, redactions). A cheap participant pre-check avoids reading conversations the user is obviously not part of. Used by the get_chat_messages MCP tool.
      Parameters:
      userName - the Meeds username acting
      roomId - the Matrix room id of the conversation
      limit - the maximum number of messages to return (clamped to [1, 200])
      Returns:
      the conversation messages, oldest first, never null

    • getUnreadConversations

      public List<ChatUnread> getUnreadConversations(String userName)
      Returns the unread conversations of the given user, read as that user via a Matrix /sync, so only the rooms the user has joined are considered. Each entry carries the unread count and the recent messages, with a human readable title resolved from the user's conversations. Used by the get_unread_chat_messages MCP tool.
      Parameters:
      userName - the Meeds username acting
      Returns:
      the user's unread conversations, never null

    • sendMessage

      public String sendMessage(String userName, String roomId, String text)
      Sends a textual message to a conversation as the given user, after checking that the user participates in it. Synapse additionally enforces that the user is allowed to post. Used by the send_chat_message MCP tool, e.g. to let an AI agent post a real-time reply on the user's behalf.
      Parameters:
      userName - the Meeds username acting
      roomId - the Matrix room id of the conversation
      text - the plain text message to send
      Returns:
      the created event id, or null when the message could not be sent

    • searchChatMessages

      public List<ChatSearchResult> searchChatMessages(String userName, String query, String conversationId, int limit)
      Runs a full-text search of message bodies as the given user, either across all their conversations (when conversationId is blank) or scoped to a single conversation. Synapse enforces the user's Matrix visibility, and the hits are then restricted to the conversations that are tracked by the platform and accessible to the user — the same rooms the chat list shows and the row can open — so a room they still belong to on Matrix but not in the chat (created from another Matrix client, left behind by a failed space kick) is never returned. Each hit is resolved to a human readable conversation title. Backs the search_chat_messages MCP tool and the chat UI search.
      Parameters:
      userName - the Meeds username acting
      query - the free-text search term
      conversationId - the Matrix room id to scope the search to, or null/blank to search across all the user's conversations
      limit - the maximum number of hits to return (clamped to [1, 100])
      Returns:
      the matching messages, most recent first, never null