update info messages visibility

CHANGES.md

@@ -61,6 +61,7 @@ Soon we'll deprecate the latter, so prepare now.
 - #2213: added CustomElement to converse.env
 - #2220: fix rendering of emojis in case `use_system_emojis == false` (again).
 - #2092: fixes room list update loop when having the `locked_muc_domain` truthy or `'hidden'`
+- #2259: Rename configuration setting `muc_show_join_leave` to `muc_show_info_messages`. Now accepts a list of events to show instead of a boolean.
 - #2285: Rename config option `muc_hats_from_vcard` to [muc_hats](https://conversejs.org/docs/html/configuration.html#muc-hats). Now accepts a list instead of a boolean and allows for more flexible choices regarding user badges.
 - #2300: Fix message reorder issue after message correction.
 - #2304: Custom emojis (stickers) images not shown

docs/source/configuration.rst

@@ -1379,13 +1379,53 @@ Example:
 
     muc_roomid_policy_hint: '<br><b>Policy for groupchat id:</b><br>- between 5 and 40 characters,<br>- lowercase from a to z (no special characters) or<br>- digits or<br>- dots (.) or<br>- underlines (_) or<br>- hyphens (-),<br>- no spaces<br>',
 
-muc_show_join_leave
--------------------
+muc_show_info_messages
+----------------------
 
-* Default; ``true``
+* Default: List composed of MUC status codes, role changes, join and leave events
+and affiliation changes. The values of converse.MUC_INFO_CODES below are joined to 
+build the default list:
+
+.. code-block:: javascript
+    converse.MUC_AFFILIATION_CHANGES_LIST = ['owner', 'admin', 'member', 'exowner', 'exadmin', 'exmember', 'exoutcast']
+    converse.MUC_ROLE_CHANGES_LIST = ['op', 'deop', 'voice', 'mute'];
+    converse.MUC_TRAFFIC_STATES_LIST = ['entered', 'exited'];
+
+    converse.MUC_INFO_CODES = {
+        'visibility_changes': ['100', '102', '103', '172', '173', '174'],
+        'self': ['110'],
+        'non_privacy_changes': ['104', '201'],
+        'muc_logging_changes': ['170', '171'],
+        'nickname_changes': ['210', '303'],
+        'disconnect_messages': ['301', '307', '321', '322', '332', '333'],
+        'affiliation_changes': [...converse.AFFILIATION_CHANGES_LIST],
+        'join_leave_events': [...converse.MUC_TRAFFIC_STATES_LIST],
+        'role_changes': [...converse.MUC_ROLE_CHANGES_LIST],
+    };
+
+This setting determines which info messages will Converse show inside a chatroom.
+It is recommended to use the aforementioned Converse object in the following fashion
+to build the list of desired info messages that will be shown:
+
+.. code-block:: javascript
+    muc_show_info_messages: [
+        ...converse.MUC_INFO_CODES.visibility_changes,
+        ...converse.MUC_INFO_CODES.self,
+        ...converse.MUC_INFO_CODES.non_privacy_changes,
+        ...converse.MUC_INFO_CODES.muc_logging_changes,
+        ...converse.MUC_INFO_CODES.nickname_changes,
+        ...converse.MUC_INFO_CODES.disconnect_messages,
+        ...converse.MUC_INFO_CODES.affiliation_changes,
+        ...converse.MUC_INFO_CODES.join_leave_events,
+        ...converse.MUC_INFO_CODES.role_changes,
+    ]
+
+By default all info messages are shown.
+
+The behaviour of this setting is whitelisting, so if it is overriden all the desired
+events must be specified.
 
-Determines whether Converse will show info messages inside a chatroom
-whenever a user joins or leaves it.
+If an empty list is provided, no info message will be displayed at all.
 
 muc_show_logs_before_join
 -------------------------

spec/muc.js

@@ -1302,9 +1302,9 @@ describe("Groupchats", function () {
             done();
         }));
 
-        it("doesn't show the disconnection messages when muc_show_join_leave is false",
+        it("doesn't show the disconnection messages when join_leave_events is not in muc_show_info_messages setting",
             mock.initConverse(
-                ['rosterGroupsFetched', 'chatBoxesFetched'], {'muc_show_join_leave': false},
+                ['rosterGroupsFetched', 'chatBoxesFetched'], {'muc_show_info_messages': []},
                 async function (done, _converse) {
 
             spyOn(_converse.ChatRoom.prototype, 'onOccupantAdded').and.callThrough();

src/converse-muc-views.js

@@ -172,9 +172,14 @@ export const ChatRoomView = ChatBoxView.extend({
 
     getNotifications () {
         const actors_per_state = this.model.notifications.toJSON();
-        const states = api.settings.get('muc_show_join_leave') ?
-            [...converse.CHAT_STATES, ...converse.MUC_TRAFFIC_STATES, ...converse.MUC_ROLE_CHANGES] :
-            converse.CHAT_STATES;
+
+        const role_changes = api.settings.get('muc_show_info_messages')
+            .filter(role_change => converse.MUC_ROLE_CHANGES_LIST.includes(role_change));
+
+        const join_leave_events = api.settings.get('muc_show_info_messages')
+            .filter(join_leave_event => converse.MUC_TRAFFIC_STATES_LIST.includes(join_leave_event));
+
+        const states = [...converse.CHAT_STATES, ...join_leave_events, ...role_changes];
 
         return states.reduce((result, state) => {
             const existing_actors = actors_per_state[state];