GlobalBlocking should specify block error message key
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	Tchanders
	Sep 8 2022, 12:59 PM

Description

Background

Blocks can be reported to the user via several different block error messages. BlockErrorFormatter::getBlockErrorMessageKey chooses which message to use, depending on the type of block.

After T317201: Allow extensions to modify block error message key via a hook, extensions can tell BlockErrorFormatter which error message key to use. GlobalBlocking should have a handler for this hook that uses one of the extension's block messages.

Acceptance criteria

If there is a GlobalBlock and no other block, the error message displayed is one of 'globalblocking-ipblocked', 'globalblocking-ipblocked-range' or 'globalblocking-ipblocked-xff'
~~If there is a CompositeBlock that includes a GlobalBock, the block reason is updated to include details of the global block~~ (see end of T317308#8276750)
The hooks onGlobalBlockingBlockedIpMsg, onGlobalBlockingBlockedIpRangeMsg and onGlobalBlockingBlockedIpXffMsg are run so that WikimediaMessages can alter the message keys
If there is no global block, nothing is changed

Notes

See GlobalBlocking::getUserBlockDetails for how the message keys are currently chosen

Testing notes

This task affects anywhere that throws a UserBlockedError with a global block. One example in core is SpecialUpload.

Before testing:

This should be tested with and without the WikimediaMessages extension. (This might mean it needs to be tested locally?)
This needs to be tested with T317201. (That patch has been merged, but if testing locally core may need updating.)
Where testing with WikimediaMessages, this should be tested with T321574: Override new GlobalBlocking messages on WikimediaMessages

Steps to test (without WikimediaMessages):

Globally block your IP address. (Make sure there are no local blocks or other local blocks against your IP address.)
Log out and visit Special:Upload
Before this change, the message to tell you you are blocked is blockedtext
After this change, the blocked message should be globalblocking-blockedtext-ip

Repeat this, but in the first 2 steps:

block an IP range covering your IP address. The new message should be globalblocking-blockedtext-range.
change your XFF header using a browser extension such as [[ chrome://extensions/?id=hkghghbnihliadkabmlcmcgmffllglin | this one ]], and block that IP address. The new message should be globalblocking-blockedtext-xff.

Repeat all of the above with WikimediaMessages enabled. The messages should be as above, prefixed with wikimedia-.

Details

	Subject	Repo	Branch	Lines +/-
	Override block error message for global blocks	mediawiki/extensions/GlobalBlocking	master	+81 -0

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Open		None	T231109 Remove Core coupling with GlobalBlocking extension
Open		None	T319069 Remove global-blocks-specific methods and hook from User class
Open	Spike	None	T315644 Global blocks should be treated as a subtype of blocks
Resolved		Cyndymediawiksim	T317337 Deprecate global-blocks-specific methods and hook
Resolved		Cyndymediawiksim	T317325 Remove separate checks for global blocks from APIUpload and SpecialUpload
Resolved		• AGueyte	T317334 Remove separate checks for global blocks from PasswordReset
Resolved		• TThoabala	T317342 Investigate: Remove use of User::isBlockedGlobally and User::getGlobalBlock from Wikimedia deployed extensions
Resolved		• AGueyte	T318891 Remove usage of User::isBlockedGlobally and User::getGlobalBlock in Thanks
Resolved		WMDE-Fisch	T318893 Remove use of User::isBlockedGlobally and User::getGlobalBlock in FileImporter
Resolved		• AGueyte	T318896 Remove use of User::isBlockedGlobally and User::getGlobalBlock in UploadWizard
Resolved		Cyndymediawiksim	T318897 Remove usage of User::isBlockedGlobally in UrlShortener
Resolved		Cyndymediawiksim	T318898 Remove usage of User::isBlockedGlobally and User::getGlobalBlock in VisualEditor
Open		None	T318900 Remove usage of User::isBlockedGlobally and User::getGlobalBlock in WikiForum
Open		None	T318890 Remove use of User::isBlockedGlobally in Comments extension
Open		None	T321240 Remove GlobalBlocking dependency on FileImporter
Resolved		Tchanders	T257701 Add global blocks into CompositeBlocks rather than treating them separately
Resolved		Tchanders	T317308 GlobalBlocking should specify block error message key
Resolved		• AGueyte	T317201 Allow extensions to modify block error message key via a hook

Event Timeline

Tchanders created this task.Sep 8 2022, 12:59 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 8 2022, 12:59 PM

Tchanders added a subtask: T317201: Allow extensions to modify block error message key via a hook.Sep 8 2022, 2:31 PM

Tchanders added a parent task: T257701: Add global blocks into CompositeBlocks rather than treating them separately.

Tchanders mentioned this in T257701: Add global blocks into CompositeBlocks rather than treating them separately.Sep 8 2022, 2:41 PM

Tchanders moved this task from Untriaged to Triage/To be Estimated on the Anti-Harassment board.Sep 9 2022, 3:37 PM

STran set the point value for this task to 3.Sep 13 2022, 12:26 PM

STran moved this task from Triage/To be Estimated to Cards ready for development on the Anti-Harassment board.

STran moved this task from Cards ready for development to AHT Sprint 17: The Fruit Hat on the Anti-Harassment board.Sep 27 2022, 5:07 PM

STran edited projects, added Anti-Harassment (AHT Sprint 17: The Fruit Hat); removed Anti-Harassment.

Change 837185 had a related patch set uploaded (by Tchanders; author: Tchanders):

[mediawiki/extensions/GlobalBlocking@master] WIP: Override block error message for global blocks

https://gerrit.wikimedia.org/r/837185

gerritbot added a project: Patch-For-Review.Sep 30 2022, 7:47 PM

In T317308#8276630, @gerritbot wrote:

Change 837185 had a related patch set uploaded (by Tchanders; author: Tchanders):

[mediawiki/extensions/GlobalBlocking@master] WIP: Override block error message for global blocks

https://gerrit.wikimedia.org/r/837185

I made this patch to help test T317201: Allow extensions to modify block error message key via a hook.

I noticed some problems while making it:

The messages 'globalblocking-ipblocked', 'globalblocking-ipblocked-range' or 'globalblocking-ipblocked-xff' take params in a different order from BlockErrorFormatter::getBlockErrorMessageParams. This means we can't just swap these keys in.
We could make new messages (which is what the patch does). But they would have to be kept exactly the same as the older messages, which is a maintenance burden. (These messages are carefully worded (see e.g. T310131: Update/reword wikimedia-globalblocking-.* message overrides). @MarcoAurelio Might it be feasible to migrate these messages, e.g. replace globalblocking-ipblocked with the new message in: https://gerrit.wikimedia.org/r/c/mediawiki/extensions/GlobalBlocking/+/837185/1/i18n/en.json#77
There is one parameter in 'globalblocking-ipblocked' and friends that BlockErrorFormatter does not have access to, which is the wiki of the blocker. However, that will be captured in the blocker's name (e.g. "SomeAdmin>enwiki"), so I don't think it's a problem.

If there is a CompositeBlock that includes a GlobalBock, the block reason is updated to include details of the global block

I'm no longer sure about this. It's not very nice architecturally. If there are several blocks, is it right to add specific details for global blocks in particular? If so, we should probably solve the bigger problem of how to report details of CompositeBlocks rather than hacking the block reason for global blocks here.

Tchanders claimed this task.Oct 11 2022, 2:53 PM

Tchanders moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (AHT Sprint 17: The Fruit Hat) board.

The messages 'globalblocking-ipblocked', 'globalblocking-ipblocked-range' or 'globalblocking-ipblocked-xff' take params in a different order from BlockErrorFormatter::getBlockErrorMessageParams. This means we can't just swap these keys in.

We could just swap the order of the parameters. The danger is that on-wiki overrides (e.g. this one) would no longer work, because they would have the old parameter order.

However, it looks like there aren't many overrides:

...so we could fix them manually.

ARamirez_WMF edited projects, added Anti-Harassment (AHaT Sprint 18: The Imperial State Crown); removed Anti-Harassment (AHT Sprint 17: The Fruit Hat).Oct 11 2022, 4:07 PM

ARamirez_WMF moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (AHaT Sprint 18: The Imperial State Crown) board.

Tchanders moved this task from In Progress 💪 to Code Review 🔍 on the Anti-Harassment (AHaT Sprint 18: The Imperial State Crown) board.Oct 12 2022, 5:44 PM

Tchanders updated the task description. (Show Details)Oct 17 2022, 4:04 PM

Tchanders mentioned this in T317201: Allow extensions to modify block error message key via a hook.Oct 17 2022, 5:07 PM

Tchanders updated the task description. (Show Details)

Tchanders updated the task description. (Show Details)Oct 17 2022, 5:09 PM

In T317308#8308355, @Tchanders wrote:

The messages 'globalblocking-ipblocked', 'globalblocking-ipblocked-range' or 'globalblocking-ipblocked-xff' take params in a different order from BlockErrorFormatter::getBlockErrorMessageParams. This means we can't just swap these keys in.

We could just swap the order of the parameters. The danger is that on-wiki overrides (e.g. this one) would no longer work, because they would have the old parameter order.

However, it looks like there aren't many overrides:

Globalblocking-ipblocked overrides

Globalblocking-ipblocked-range overrides

Globalblocking-ipblocked-xff overrides

...so we could fix them manually.

Swapping parameter order looks like it will be a nightmare, since we'd need simultaneous deployments of our code, WikimediaMessages, on-wiki overrides and updated translations.

However, introducing new messages would be complicated too. We'd need to:

Introduce new messages in GlobalBlocking, with the same English translations as the old messages, but a new parameter order
Get these translated
Do the same for the WikimediaMessages overrides
Get these translated too
Add on-wiki overrides for the new messages, equivalent to the old messages' overrides in T317308#8308355

@Amire80 Do you have any ideas about what we could do here?

Can you give a clearer example of what do you want to change in the message? The current English source text is:

'''Your IP address has been blocked on all wikis.'''

The block was made by $1 ($2).
The reason given is ''$3''.

* Start of block: $4
* Expiration of block: $5

You can contact $1 to discuss the block.
You cannot use the "{{int:emailuser}}" feature unless a valid email address is specified in your [[Special:Preferences|account preferences]] and you have not been blocked from using it.
Your current IP address is $6.
Please include all above details in any queries you make.

Which ones do you want to change?

In T317308#8341134, @Amire80 wrote:

Can you give a clearer example of what do you want to change in the message? The current English source text is:

'''Your IP address has been blocked on all wikis.'''

The block was made by $1 ($2).
The reason given is ''$3''.

* Start of block: $4
* Expiration of block: $5

You can contact $1 to discuss the block.
You cannot use the "{{int:emailuser}}" feature unless a valid email address is specified in your [[Special:Preferences|account preferences]] and you have not been blocked from using it.
Your current IP address is $6.
Please include all above details in any queries you make.

Which ones do you want to change?

Sure - this message would change to the following (text unchanged, param order changed):

'''Your IP address has been blocked on all wikis.'''

The block was made by $1.
The reason given is ''$2''.

* Start of block: $8
* Expiration of block: $6

You can contact $1 to discuss the block.
You cannot use the \"{{int:emailuser}}\" feature unless a valid email address is specified in your [[Special:Preferences|account preferences]] and you have not been blocked from using it.
Your current IP address is $3.
Please include all above details in any queries you make.

Tchanders mentioned this in T321574: Override new GlobalBlocking messages on WikimediaMessages.Oct 25 2022, 3:05 PM

ARamirez_WMF edited projects, added Anti-Harassment (AHaT Sprint 19: The Deerstalker); removed Anti-Harassment (AHaT Sprint 18: The Imperial State Crown).Oct 25 2022, 4:52 PM

ARamirez_WMF moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to Code Review 🔍 on the Anti-Harassment (AHaT Sprint 19: The Deerstalker) board.

Tchanders updated the task description. (Show Details)Nov 1 2022, 2:39 PM

Change 837185 merged by jenkins-bot:

[mediawiki/extensions/GlobalBlocking@master] Override block error message for global blocks

https://gerrit.wikimedia.org/r/837185

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.10; 2022-11-14).Nov 2 2022, 1:00 AM

Maintenance_bot removed a project: Patch-For-Review.Nov 2 2022, 1:30 AM

• TThoabala moved this task from Code Review 🔍 to QA/Testing 🐞 on the Anti-Harassment (AHaT Sprint 19: The Deerstalker) board.Nov 2 2022, 6:06 AM

Without WikimediaMessages

When globally blocked and going to Special:Upload, you see the message globalblocking-blockedtext-ip, globalblocking-blockedtext-range or globalblocking-blockedtext-xff (as appropriate).

If you are also blocked locally (IP or account), you only see a message for the local block(s) (e.g. blockedtext, blockedtext-partial, blockedtext-composite). This was the same before this change.

For other actions like editing you see the message globalblocking-ipblocked, globalblocking-ipblocked-range or globalblocking-ipblocked-xff, alongside any messages for local blocks.

I will test with WikimediaMessages after T321574 is merged.

Test environment: local docker GlobalBlocking – (66f7de6) 08:02, 4 November 2022.

Tchanders mentioned this in T322553: Remove use of AbstractBlock::getPermissionsError from CheckBlocksSecondaryAuthenticationProvider.Nov 7 2022, 3:33 PM

ARamirez_WMF edited projects, added Anti-Harassment (AHaT Sprint 19: The Sanbenito); removed Anti-Harassment (AHaT Sprint 19: The Deerstalker).Nov 8 2022, 5:23 AM

ARamirez_WMF moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to QA/Testing 🐞 on the Anti-Harassment (AHaT Sprint 19: The Sanbenito) board.