Loading...

XML

Word

Printable

Type: Bug
Resolution: Fixed
Priority: Minor
Fix Version/s: 4.4.6, 4.5.2
Affects Version/s: 4.3.3, 4.4.5, 4.5
Component/s: Communication
Labels:

Affected Branches:
MOODLE_403_STABLE, MOODLE_404_STABLE, MOODLE_405_STABLE
Fixed Branches:
MOODLE_404_STABLE, MOODLE_405_STABLE
Pull from Repository:
https://github.com/mark-webster-catalyst/moodle
Pull 4.4 Branch:
~~MDL-81685~~_matrix_homeserver_name_404
Pull 4.4 Diff URL:
https://github.com/moodle/moodle/compare/MOODLE_404_STABLE...mark-webster-catalyst:moodle:MDL-81685_matrix_homeserver_name_404
Pull 4.5 Branch:
~~MDL-81685~~_matrix_homeserver_name_405
Pull 4.5 Diff URL:
https://github.com/moodle/moodle/compare/MOODLE_405_STABLE...mark-webster-catalyst:moodle:MDL-81685_matrix_homeserver_name_405
Pull Main Branch:
~~MDL-81685~~_matrix_homeserver_name_main
Pull Main Diff URL:
https://github.com/moodle/moodle/compare/main...mark-webster-catalyst:moodle:MDL-81685_matrix_homeserver_name_main

Testing Instructions:

Hide

Setup

Clone Andrew's helper repository:

git clone https://github.com/andrewnicols/moodle-synapse

cd moodle-synapse

chmod 777 *_data

* Add server_name: "synapse.local" to synapse_data/homeserver.yaml

Run the docker-compose up command:

docker compose up -d

Wait for about 10 seconds for the first run to complete
Update {setup.sh}
to change both instances of @moodlebot:synapse to @moodlebot:synapse.local

Run the setup script:

./setup.sh

Copy the command it outputs
Change into your Moodle directory
Paste in the command, for EXAMPLE:

cd path/to/moodle

sed -i '/^require_once.{*}lib.*setup.php.{*}$/i require_once("/Users/nicols/git/moodlehq/synapse/moodle-config.php");' config.php

cd -

* If you have not done so already, edit your /etc/hosts file to add:

127.0.0.1 element.container.docker.internal element

127.0.0.1 synapse.container.docker.internal synapse

127.0.0.1 keycloak.container.docker.internal keycloak

# Follow the instructions at https://github.com/andrewnicols/moodle-synapse#trusting to trust the root CA that is used for this.

In moodle, navigate to /admin/settings.php?section=communication_matrix and set Homeserver Name to synapse.local

Test Scenario

Create a test course
Create new User
Go to More > Communication
Set the Provider to 'Matrix'
Set Room name to 'Test room'
Save changes.
Run the queued ad-hoc tasks by running cron from the command line php admin/cli/cron.php
Refresh your course page and go to your newly created Matrix room using the link/icon in the bottom right corner.
Log in using the user created during the setup (moodlebot)
CONFIRM username is @moodlebot:synapse.local
Go to Participants page
Enrol new User as student
Run the queued ad-hoc tasks by running cron from the command line php admin/cli/cron.php
Go back to your Matrix room
CONFIRM New user created as @username:synapse.local

Show

Setup Clone Andrew's helper repository: git clone https://github.com/andrewnicols/moodle-synapse cd moodle-synapse chmod 777 *_data * Add server_name: "synapse.local" to synapse_data/homeserver.yaml Run the docker-compose up command: docker compose up -d Wait for about 10 seconds for the first run to complete Update {setup.sh} to change both instances of @moodlebot:synapse to @moodlebot:synapse.local Run the setup script: ./setup.sh Copy the command it outputs Change into your Moodle directory Paste in the command, for EXAMPLE: cd path/to/moodle sed -i '/^require_once.{*}lib.*setup.php.{*}$/i require_once("/Users/nicols/git/moodlehq/synapse/moodle-config.php");' config.php cd - * If you have not done so already, edit your /etc/hosts file to add: 127.0.0.1 element.container.docker.internal element 127.0.0.1 synapse.container.docker.internal synapse 127.0.0.1 keycloak.container.docker.internal keycloak # Follow the instructions at https://github.com/andrewnicols/moodle-synapse#trusting to trust the root CA that is used for this. In moodle, navigate to /admin/settings.php?section=communication_matrix and set Homeserver Name to synapse.local Test Scenario Create a test course Create new User Go to More > Communication Set the Provider to 'Matrix' Set Room name to 'Test room' Save changes. Run the queued ad-hoc tasks by running cron from the command line php admin/cli/cron.php Refresh your course page and go to your newly created Matrix room using the link/icon in the bottom right corner. Log in using the user created during the setup (moodlebot) CONFIRM username is @moodlebot:synapse.local Go to Participants page Enrol new User as student Run the queued ad-hoc tasks by running cron from the command line php admin/cli/cron.php Go back to your Matrix room CONFIRM New user created as @username:synapse.local

Pre-check results:
Hide

Code verified against automated checks.

Checked ~~MDL-81685~~ using repository: https://github.com/mark-webster-catalyst/moodle

MOODLE_404_STABLE (0 errors / 0 warnings) [branch: MDL-81685_matrix_homeserver_name_404 | CI Job]

MOODLE_405_STABLE (0 errors / 0 warnings) [branch: MDL-81685_matrix_homeserver_name_405 | CI Job]

main (0 errors / 0 warnings) [branch: MDL-81685_matrix_homeserver_name_main | CI Job]

_{More information about this report}

Built on: Tue Jan 21 12:48:45 PM UTC 2025
Show
Code verified against automated checks. Checked MDL-81685 using repository: https://github.com/mark-webster-catalyst/moodle MOODLE_404_STABLE (0 errors / 0 warnings) [branch: MDL-81685_matrix_homeserver_name_404 | CI Job ] MOODLE_405_STABLE (0 errors / 0 warnings) [branch: MDL-81685_matrix_homeserver_name_405 | CI Job ] main (0 errors / 0 warnings) [branch: MDL-81685_matrix_homeserver_name_main | CI Job ] More information about this report Built on: Tue Jan 21 12:48:45 PM UTC 2025
Automated test results:
Hide

Launching automatic jobs for branch ~~MDL-81685~~_matrix_homeserver_name_404

https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17361/ PHPUnit (sqlsrv)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59246/ Behat (NonJS - boost and classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59247/ Behat (Firefox - boost)

Launching automatic jobs for branch ~~MDL-81685~~_matrix_homeserver_name_405

https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17362/ PHPUnit (sqlsrv)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59248/ Behat (NonJS - boost and classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59249/ Behat (Firefox - boost)

Launching automatic jobs for branch ~~MDL-81685~~_matrix_homeserver_name_main

https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17363/ PHPUnit (sqlsrv)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59250/ Behat (NonJS - boost and classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59251/ Behat (Firefox - boost)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59252/ Behat (Firefox - classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59253/ App tests (stable app version)

Built on: Fri Nov 15 10:27:16 UTC 2024
Show
Launching automatic jobs for branch MDL-81685 _matrix_homeserver_name_404 https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17361/ PHPUnit (sqlsrv) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59246/ Behat (NonJS - boost and classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59247/ Behat (Firefox - boost) Launching automatic jobs for branch MDL-81685 _matrix_homeserver_name_405 https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17362/ PHPUnit (sqlsrv) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59248/ Behat (NonJS - boost and classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59249/ Behat (Firefox - boost) Launching automatic jobs for branch MDL-81685 _matrix_homeserver_name_main https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17363/ PHPUnit (sqlsrv) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59250/ Behat (NonJS - boost and classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59251/ Behat (Firefox - boost) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59252/ Behat (Firefox - classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59253/ App tests (stable app version) Built on: Fri Nov 15 10:27:16 UTC 2024

When configuring a Matrix server a matrixhomeserverurl of "https://matrix.example.com" Moodle assumes that the Matrix userid should be "@user:matrix.example.com".
This is often not the case, though.
On our Matrix instance the userids look like "@user:example.com", though the server is "https://matrixserver.example.com".

The relevant function is:

get_formatted_matrix_userid()

in:

communication/provider/matrix/classes/matrix_user_manager.php

I would suggest to add a configuration option to define the userid format.

- - Sort By Name
  - Sort By Date
  - Ascending
  - Descending
  - Thumbnails
  - List
  - Download All

01.png
78 kB
16/Jan/25 8:12 AM
MDL-81685.png
311 kB
23/Jan/25 12:48 PM

has a non-specific relationship to

MDL-83771 Matrix integration can create incorrect usernames for logging in via SAML

Open

MDL-84293 Matrix Communication Provider: Advanced Matrix User ID Synchronization and Dynamic Account Management

Open

Assignee:: Mark Webster

Reporter:: Tobias Marx

Peer reviewer:: Mark Johnson

Integrator:: Safat Shahin

Tester:: Ron Carl Alfon Yu

Participants:: CiBoT, Huong Nguyen, Mark Johnson, Mark Webster, Michael Hawkins, Robert van_Garderen, Ron Carl Alfon Yu, Safat Shahin, Tobias Marx

Votes:: 1 Vote for this issue

Watchers:: 8 Start watching this issue

Created:: 25/Apr/24 6:01 PM

Updated:: 07/Feb/25 1:37 PM

Resolved:: 24/Jan/25 1:07 AM

Estimated:

Remaining:

Logged:

4h 52m

Details

Setup

Test Scenario

Description

Attachments

Attachments

Issue Links

Activity

People

Dates

Time Tracking

Clockify