WIP: Block users #3164
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,157 +1,66 @@ | ||
| import log from '@converse/headless/log.js'; | ||
| import { _converse, api, converse } from "@converse/headless/core.js"; | ||
| import { sendBlockingStanza } from './utils.js'; | ||
|
|
||
| const { Strophe } = converse.env; | ||
|
|
||
|
|
||
| export default { | ||
|
|
||
| blocking: { | ||
| /** | ||
| * Checks if XEP-0191 is supported | ||
| */ | ||
| async supported () { | ||
| const has_feature = await api.disco.features.has(Strophe.NS.BLOCKING, _converse.domain); | ||
| if (!has_feature) { | ||
| log.info("XEP-0191 not supported, no blocklist available"); | ||
| return false; | ||
| } | ||
| log.debug("XEP-0191 available"); | ||
| return true; | ||
| }, | ||
| /** | ||
| * Retrieves the blocklist held by the logged in user at a JID by sending an IQ stanza. | ||
| * @private | ||
| * @method api.blocking.refresh | ||
| */ | ||
| async refresh () { | ||
| if (!_converse.connection) { | ||
| return false; | ||
| } | ||
| log.debug("refreshing blocklist"); | ||
| const available = await this.supported(); | ||
| if (!available) { | ||
| log.debug("XEP-0191 NOT available, not refreshing..."); | ||
| return false; | ||
| } | ||
| log.debug("getting blocklist..."); | ||
| return sendBlockingStanza( 'blocklist', 'get' ); | ||
| }, | ||
| /** | ||
| * Blocks JIDs by sending an IQ stanza | ||
| * @method api.blocking.block | ||
| * | ||
| * @param { Array } [jid_list] - The list of JIDs to block | ||
| */ | ||
| block ( jid_list ) { | ||
|
There was a problem hiding this comment. Would be nice if this first parameter can either be a string (single JID) or an array of JIDs. Similarly to how it's done here: Same for the function below. |
||
| sendBlockingStanza( 'block', 'set', jid_list ); | ||
| }, | ||
| /** | ||
| * Unblocks JIDs by sending an IQ stanza to the server JID specified | ||
| * @method api.blocking.unblock | ||
| * @param { Array } [jid_list] - The list of JIDs to unblock | ||
| */ | ||
| unblock ( jid_list ) { | ||
| sendBlockingStanza( 'unblock', 'set', jid_list ); | ||
| }, | ||
| /** | ||
| * Retrieve the blocked set | ||
| * @method api.blocking.blocklist | ||
| */ | ||
| blocklist () { | ||
| return _converse.blocking._blocked?.get('set') ?? new Set(); | ||
| }, | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,87 @@ | ||
| import log from '@converse/headless/log.js'; | ||
| import { _converse, api, converse } from "@converse/headless/core.js"; | ||
| import { __ } from 'i18n'; | ||
|
|
||
| const { Strophe, $iq, sizzle, u } = converse.env; | ||
|
|
||
| /** | ||
| * Handle incoming iq stanzas in the BLOCKING namespace. Adjusts the global blocking._blocked.set. | ||
| * @method handleBlockingStanza | ||
| * @param { Object } [stanza] - The incoming stanza to handle | ||
| */ | ||
| function handleBlockingStanza ( stanza ) { | ||
| const action = stanza.firstElementChild.tagName; | ||
| const items = sizzle('item', stanza).map(item => item.getAttribute('jid')); | ||
| const msg_type = stanza.getAttribute('type'); | ||
|
|
||
| log.debug(`handle blocking stanza Type ${msg_type} action ${action}`); | ||
| if (msg_type == 'result' && action == 'blocklist' ) { | ||
| log.debug(`resetting blocklist: ${items}`); | ||
| _converse.blocking._blocked.set({'set': new Set()}); | ||
| items.forEach((item) => { _converse.blocking._blocked.get('set').add(item)}); | ||
|
|
||
| /** | ||
| * Triggered once the _converse.blocking._blocked list has been fetched | ||
| * @event _converse#blockListFetched | ||
| * @example _converse.api.listen.on('blockListFetched', () => { ... }); | ||
| */ | ||
| api.trigger('blockListFetched', _converse.blocking._blocked.get('set')); | ||
| log.debug("triggered blockListFetched"); | ||
|
|
||
| } else if (msg_type == 'set' && action == 'block') { | ||
| log.debug(`adding people to blocklist: ${items}`); | ||
| items.forEach((item) => { _converse.blocking._blocked.get('set').add(item)}); | ||
| api.trigger('blockListUpdated', _converse.blocking._blocked.get('set')); | ||
| } else if (msg_type == 'set' && action == 'unblock') { | ||
| log.debug(`removing people from blocklist: ${items}`); | ||
| items.forEach((item) => { _converse.blocking._blocked.get('set').delete(item)}); | ||
| api.trigger('blockListUpdated', _converse.blocking._blocked.get('set')); | ||
| } else { | ||
| log.error("Received a blocklist push update but could not interpret it"); | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| export function onConnected () { | ||
| _converse.connection.addHandler( | ||
| handleBlockingStanza, Strophe.NS.BLOCKING, 'iq', ['set', 'result'] | ||
| ); | ||
| api.blocking.refresh(); | ||
| } | ||
|
|
||
| /** | ||
| * Send block/unblock IQ stanzas to the server for the JID specified | ||
| * @method api.sendBlockingStanza | ||
| * @param { String } action - "block", "unblock" or "blocklist" | ||
| * @param { String } iq_type - "get" or "set" | ||
| * @param { Array } [jid_list] - (optional) The list of JIDs to block or unblock | ||
| */ | ||
| export async function sendBlockingStanza ( action, iq_type = 'set', jid_list = [] ) { | ||
| if (!_converse.connection) { | ||
| return false; | ||
| } | ||
|
|
||
| const element = Strophe.xmlElement(action, {'xmlns': Strophe.NS.BLOCKING}); | ||
| jid_list.forEach((jid) => { | ||
| const item = Strophe.xmlElement('item', { 'jid': jid }); | ||
| element.append(item); | ||
| }); | ||
|
There was a problem hiding this comment.
|
||
|
|
||
| const iq = $iq({ | ||
| 'type': iq_type, | ||
| 'id': u.getUniqueId(action) | ||
| }).cnode(element); | ||
|
|
||
| const result = await api.sendIQ(iq).catch(e => { log.fatal(e); return false }); | ||
|
There was a problem hiding this comment. I think it might be better to here handle the We can then use The advantage of doing it like this is that the caller of the API method can decide to |
||
| const err_msg = `An error occured while trying to ${action} user(s) ${jid_list}`; | ||
| if (result === null) { | ||
| api.alert('error', __('Error'), err_msg); | ||
| log(err_msg, Strophe.LogLevel.WARN); | ||
| return false; | ||
| } else if (u.isErrorStanza(result)) { | ||
| log.error(err_msg); | ||
| log.error(result); | ||
| return false; | ||
| } | ||
| return true; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This already looks much better thanks. However, I think
blocklistwould be a better namespace thanblocking.The reason being that it allows us to write the API in a more readable way.
I would make the following renamings:
api.blocking.block->api.blocklist.addapi.blocking.unblock->api.blocklist.removeapi.blocking.blocklist->api.blocklist.getThe
supportedandrefreshmethods can stay as they are.I realize you may have called the namespace
blockingbecause that's the name of the plugin's folder. I don't think we generally follow a convention of keeping the plugin folder and api namespace names the same (although an argument could be made we should), at least not explicitly. In any case, if such conformity is desired, I'd rather rename the plugin folder toblocklistas well. I don't think it's necessary though.