OF-2607: Add support for XEP-0421: Occupant identifiers for semi-anonymous MUCs #2714
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @guusdk, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces support for XEP-0421: Occupant identifiers for semi-anonymous MUCs. This involves adding a privateKey column to the ofMucService table in the database, generating occupant IDs based on this key, and including the occupant ID in presence stanzas. The database schema changes are applied to various database types (DB2, HSQLDB, MySQL, Oracle, PostgreSQL, SQL Server, and Sybase). Additionally, the Openfire version is updated from 37 to 38 in the database scripts. The MUCOccupant class is modified to include the occupant ID, and the MultiUserChatServiceImpl class is updated to handle the new privateKey field.
Highlights
- XEP-0421 Support: Adds support for XEP-0421, enabling features like message reactions in semi-anonymous MUCs.
- Database Schema Changes: Introduces a
privateKeycolumn to theofMucServicetable across multiple database types. - Occupant ID Generation: Implements occupant ID generation based on a service-specific private key and includes it in presence stanzas.
- Version Update: Updates the Openfire version in the database scripts from 37 to 38.
Changelog
Click here to see the changelog
- distribution/src/database/openfire_db2.sql
- Added
privateKeycolumn toofMucServicetable. - Updated Openfire version to 38.
- Added a random private key for the default conference service.
- Added
- distribution/src/database/openfire_hsqldb.sql
- Added
privateKeycolumn toofMucServicetable. - Updated Openfire version to 38.
- Added a random private key for the default conference service.
- Added
- distribution/src/database/openfire_mysql.sql
- Added
privateKeycolumn toofMucServicetable. - Updated Openfire version to 38.
- Added a random private key for the default conference service.
- Added
- distribution/src/database/openfire_oracle.sql
- Added
privateKeycolumn toofMucServicetable. - Updated Openfire version to 38.
- Added a random private key for the default conference service.
- Added
- distribution/src/database/openfire_postgresql.sql
- Added
privateKeycolumn toofMucServicetable. - Updated Openfire version to 38.
- Added a random private key for the default conference service.
- Added
- distribution/src/database/openfire_sqlserver.sql
- Added
privateKeycolumn toofMucServicetable. - Added a random private key for the default conference service.
- Added
- distribution/src/database/openfire_sybase.sql
- Added
privateKeycolumn toofMucServicetable. - Added a random private key for the default conference service.
- Added
- distribution/src/database/upgrade/38/openfire_db2.sql
- Added
privateKeycolumn toofMucServicetable. - Generated a random private key for existing MUC services.
- Updated Openfire version to 38.
- Added
- distribution/src/database/upgrade/38/openfire_hsqldb.sql
- Added
privateKeycolumn toofMucServicetable. - Generated a random private key for existing MUC services.
- Updated Openfire version to 38.
- Added
- distribution/src/database/upgrade/38/openfire_mysql.sql
- Added
privateKeycolumn toofMucServicetable. - Generated a random private key for existing MUC services.
- Updated Openfire version to 38.
- Added
- distribution/src/database/upgrade/38/openfire_oracle.sql
- Added
privateKeycolumn toofMucServicetable. - Generated a random private key for existing MUC services.
- Updated Openfire version to 38.
- Added
- distribution/src/database/upgrade/38/openfire_postgresql.sql
- Added
privateKeycolumn toofMucServicetable. - Generated a random private key for existing MUC services.
- Updated Openfire version to 38.
- Added
- distribution/src/database/upgrade/38/openfire_sqlserver.sql
- Added
privateKeycolumn toofMucServicetable. - Generated a random private key for existing MUC services.
- Updated Openfire version to 38.
- Added
- distribution/src/database/upgrade/38/openfire_sybase.sql
- Added
privateKeycolumn toofMucServicetable. - Generated a random private key for existing MUC services.
- Updated Openfire version to 38.
- Added
- xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCOccupant.java
- Added
occupantIdfield to store the user's occupant ID. - Modified constructor to generate and set the occupant ID.
- Added getter method for
occupantId. - Modified
writeExternalandreadExternalmethods to serialize and deserialize theoccupantId.
- Added
- xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCRoom.java
- Added
generateOccupantIdmethod to create an Occupant ID based on XEP-0421.
- Added
- xmppserver/src/main/java/org/jivesoftware/openfire/muc/MultiUserChatManager.java
- Modified SQL queries to include
privateKeyfor MUC service management. - Updated
createMultiUserChatServiceto generate and store a private key for new services. - Updated
updateMultiUserChatServiceto propagate the private key. - Updated
loadServicesto load the private key from the database. - Updated
insertServiceto include the private key when creating a new service.
- Modified SQL queries to include
- xmppserver/src/main/java/org/jivesoftware/openfire/muc/MultiUserChatService.java
- Added
getPrivateKeymethod to retrieve the private key for a MUC service.
- Added
- xmppserver/src/main/java/org/jivesoftware/openfire/muc/cluster/ServiceAddedEvent.java
- Added
privateKeyfield toServiceAddedEventfor cluster communication. - Modified constructor and
writeExternal/readExternalmethods to handle theprivateKey.
- Added
- xmppserver/src/main/java/org/jivesoftware/openfire/muc/spi/MultiUserChatServiceImpl.java
- Added
privateKeyfield to store the MUC service's private key. - Modified constructor to accept and set the
privateKey. - Modified
processRegularStanzato add the occupant-id to presence and message packets. - Added
getPrivateKeymethod to retrieve the private key. - Added "urn:xmpp:occupant-id:0" to the feature list.
- Added
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Did you know?
The SHA-256 algorithm, used in HMAC for occupant ID generation, was designed by the National Security Agency (NSA).
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
Warning Gemini encountered an error creating the review. You can try again by commenting |
This adds support for XEP-0421, which in turn opens up a bunch of client functionality (like message reactions).
I'm not to sure about the approach taken in this commit. In particular, the database installation and update script changes do not sit well with me (also, they will require extensive testing, for each database type)