Remove whitelist/blacklist terms by bembelimen · Pull Request #29703 · joomla/joomla-cms

bembelimen · 2020-06-18T22:18:27Z

Summary of Changes

This PR removed all "whitelist" and "blacklist" terms in Joomla! 4.
Existing variables/languages strings are deprecated when needed and a replacement is implemented. Otherwise the variables/strings are renamed.

Testing Instructions

Check the area where the files are changed and look in Joomla! if everything is still working and has the new naming

@wilsonge

brianteeman · 2020-06-18T22:39:38Z

Allowlist and disallowlist are not English.

Yes I know this is what Drupal did but it doesn't change the facts.

The opposite of allow is deny

List is not a suffix it is a new word.

On a personal note this is not the same as master/slave which has historically racist meaning. Blacklist refers to a black colour book.

richard67 · 2020-06-19T08:37:22Z

@bembelimen PHPCS errors reported by Drone: https://ci.joomla.org/joomla/joomla-cms/33260/1/9

bembelimen · 2020-06-19T11:18:57Z

Allowlist and disallowlist are not English.

Yes I know this is what Drupal did but it doesn't change the facts.

The opposite of allow is deny

List is not a suffix it is a new word.

Thanks for your correction, as non-native speaker it's sometimes not easy to hit the difference. My thoughts were: I allow tags/attributes or I disallow them. What would you suggest as proper wording?

On a personal note this is not the same as master/slave which has historically racist meaning. Blacklist refers to a black colour book.

I can't judge for others if someone is offended or not as I'm not affected, I was asked to create a PR, so I'm open for the best solution for everyone.

brianteeman · 2020-06-19T11:32:03Z

"allow list" and "deny list"

brianteeman · 2020-06-19T11:52:10Z

libraries/src/Component/ComponentHelper.php

+					$disallowedAttributes = array_merge($disallowedAttributes, $tempAttributes);
 				}
-				elseif ($filterType === 'CBL')
+				// "CBL" is deprecated in Joomla! 4, will be removed in Joomla! 5


do we not need a proper @ deprecated ?

Answering my own question - later on in the code you use
// @deprecated in 4.0 remove in Joomla 5.0

N6REJ · 2020-06-19T14:33:50Z

blacklist & whitelist are long standing industry terms and not the least bit racially related.

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29703.}

wilsonge · 2020-06-20T01:14:26Z

@N6REJ and the industry is increasingly moving away from these terms:

PHP is discussing removing the terminology: https://externals.io/message/110515#110515

PHPUnit has removed the terminology: sebastianbergmann/phpunit@fe9223c#diff-7c9432f8518d7bc639d398ad1f994711

Whether you agree with the racial link or not the industry is moving away from the term so it's not really a reason either.

I suggest for our tags using the term blocked list - two advantages - one is that it's actually describing what's happening. But secondly we can still use the abbreviation BL in our code without making any b/c breaks :)
For workflows I'd use "Excluded Extensions"

particthistle · 2020-06-28T02:46:08Z

I have tested this item 🔴 unsuccessfully on 383b805

Logging a number of identified issues and examples in further comments.

Also based on the above discussion, @bembelimen is there additional changes to be made to some of the default wording values?

There's some other grammar items I've spotted looking at the files list.

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29703.}

particthistle · 2020-06-28T04:15:27Z

administrator/language/en-GB/com_config.ini

-COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom Blacklist"
-COM_CONFIG_FIELD_FILTERS_DEFAULT_BLACK_LIST="Default Blacklist"
+COM_CONFIG_FIELD_FILTERS_CUSTOM_DISALLOW_LIST="Custom DisallowList"
+COM_CONFIG_FIELD_FILTERS_DEFAULT_DISALLOW_LIST="Default DisallowList"


Missing language value following change:

COM_CONFIG_FIELD_FILTERS_DEFAULT_ALLOW_LIST="Custom AllowList"

Fixes: Global Configuration > Text Filters > Change in default text after removal of predecessor.

Further change based on the discussion on AllowList vs Allow List may need additional edit.

particthistle · 2020-06-28T04:23:44Z

administrator/language/en-GB/com_media.ini

 COM_MEDIA_FIELD_IGNORED_EXTENSIONS_DESC="Ignored file extensions for MIME type checking and restricted uploads."
 COM_MEDIA_FIELD_IGNORED_EXTENSIONS_LABEL="Ignored Extensions"
-COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of illegal MIME types to upload (blacklist)."
+COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of illegal MIME types to upload."


Suggested change

COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of illegal MIME types to upload."

COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of MIME types that can not be uploaded."

Improves the phrasing of the field description for Illegal MIME types, as ones listed in this field can not be uploaded.

to:

particthistle · 2020-06-28T04:38:55Z

administrator/language/en-GB/joomla.ini

-JWORKFLOW_EXTENSION_BLACKLIST_LABEL="Extension Blacklist"
-JWORKFLOW_EXTENSION_WHITELIST_DESCRIPTION="Activate this plugin only for listed extensions. If used all other extensions are disabled."
-JWORKFLOW_EXTENSION_WHITELIST_LABEL="Extension Whitelist"
+JWORKFLOW_EXTENSION_DISALLOW_LIST_DESCRIPTION="Disable this plugin for listed extensions."


To test these strings:
System > Plugins > search for Workflow plugins.

@bembelimen side question: Do the plugins typically function on Articles component when the Extension Whitelist is empty, or should there be a default set for the Workflow plugins?

particthistle · 2020-06-28T04:42:40Z

language/en-GB/com_media.ini

 COM_MEDIA_FIELD_IGNORED_EXTENSIONS_DESC="Ignored file extensions for MIME type checking and restricted uploads."
 COM_MEDIA_FIELD_IGNORED_EXTENSIONS_LABEL="Ignored Extensions"
-COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of illegal MIME types to upload (blacklist)."
+COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of illegal MIME types to upload."


Similar to administrator language file:

Suggested change

COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of illegal MIME types to upload."

COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of MIME types that can not be uploaded."

particthistle · 2020-06-28T04:50:18Z

I doubt any instances have been missed in applying the blacklists, but without significantly testing actual values, it's hard to check all of that.

The few language suggestions that I'm making clarify the purposes of the fields or what the allow/disallow lists are doing.

I agree with @wilsonge on the better terminology pairings: "Allow List" and "Blocked List" as blocking vs disallowing are slightly different terms, and blocking is what the lists are doing.

particthistle

Reviewed the files again and formalised the wording to show as separate words. Quality improvement in language use.

DisallowList becomes Disallow List
AllowList becomes Allow List

particthistle · 2020-07-25T11:13:12Z

administrator/language/en-GB/com_config.ini

 COM_CONFIG_FIELD_FILESYSTEM_PATH_LABEL="Session Save Path"
-COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom Blacklist"
-COM_CONFIG_FIELD_FILTERS_DEFAULT_BLACK_LIST="Default Blacklist"
+COM_CONFIG_FIELD_FILTERS_CUSTOM_DISALLOW_LIST="Custom DisallowList"


Suggested change

COM_CONFIG_FIELD_FILTERS_CUSTOM_DISALLOW_LIST="Custom DisallowList"

COM_CONFIG_FIELD_FILTERS_CUSTOM_DISALLOW_LIST="Custom Disallow List"

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:13:22Z

administrator/language/en-GB/com_config.ini

-COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom Blacklist"
-COM_CONFIG_FIELD_FILTERS_DEFAULT_BLACK_LIST="Default Blacklist"
+COM_CONFIG_FIELD_FILTERS_CUSTOM_DISALLOW_LIST="Custom DisallowList"
+COM_CONFIG_FIELD_FILTERS_DEFAULT_DISALLOW_LIST="Default DisallowList"


Suggested change

COM_CONFIG_FIELD_FILTERS_DEFAULT_DISALLOW_LIST="Default DisallowList"

COM_CONFIG_FIELD_FILTERS_DEFAULT_DISALLOW_LIST="Default Disallow List"

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:13:37Z

administrator/language/en-GB/com_config.ini

+COM_CONFIG_FIELD_FILTERS_CUSTOM_DISALLOW_LIST="Custom DisallowList"
+COM_CONFIG_FIELD_FILTERS_DEFAULT_DISALLOW_LIST="Default DisallowList"
+; Deprecate in Joomla! 4, remove in Joomla! 5
+COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom DisallowList"


Suggested change

COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom DisallowList"

COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom Disallow List"

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:13:46Z

administrator/language/en-GB/com_config.ini

+; Deprecate in Joomla! 4, remove in Joomla! 5
+COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom DisallowList"
+; Deprecate in Joomla! 4, remove in Joomla! 5
+COM_CONFIG_FIELD_FILTERS_DEFAULT_BLACK_LIST="Default DisallowList"


Suggested change

COM_CONFIG_FIELD_FILTERS_DEFAULT_BLACK_LIST="Default DisallowList"

COM_CONFIG_FIELD_FILTERS_DEFAULT_BLACK_LIST="Default Disallow List"

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:14:12Z

administrator/language/en-GB/com_config.ini

 COM_CONFIG_FIELD_FILTERS_NO_FILTER="No Filtering"
 COM_CONFIG_FIELD_FILTERS_NO_HTML="No HTML"
-COM_CONFIG_FIELD_FILTERS_WHITE_LIST="Whitelist"
+COM_CONFIG_FIELD_FILTERS_ALLOW_LIST="AllowList"


Suggested change

COM_CONFIG_FIELD_FILTERS_ALLOW_LIST="AllowList"

COM_CONFIG_FIELD_FILTERS_ALLOW_LIST="Allow List"

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:26:30Z

libraries/src/Component/ComponentHelper.php

-				// Remove the whitelisted tags and attributes from the black-list.
-				$blackListTags       = array_diff($blackListTags, $whiteListTags);
-				$blackListAttributes = array_diff($blackListAttributes, $whiteListAttributes);
+				// Remove the allowed tags and attributes from the disallowList.


Suggested change

// Remove the allowed tags and attributes from the disallowList.

// Remove the allowed tags and attributes from the Disallow List.

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:27:11Z

libraries/src/Component/ComponentHelper.php


-				// Remove whitelisted tags from filter's default blacklist
-				if ($whiteListTags)
+				// Remove allowed tags from filter's default disallowList


Suggested change

// Remove allowed tags from filter's default disallowList

// Remove allowed tags from filter's default Disallow List

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:27:27Z

libraries/src/Component/ComponentHelper.php


-				// Remove whitelisted attributes from filter's default blacklist
-				if ($whiteListAttributes)
+				// Remove allowed attributes from filter's default disallowList


Suggested change

// Remove allowed attributes from filter's default disallowList

// Remove allowed attributes from filter's default Disallow List

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:27:40Z

libraries/src/Component/ComponentHelper.php

 			}
-			// Whitelists take third precedence.
-			elseif ($whiteList)
+			// AllowLists take third precedence.


Suggested change

// AllowLists take third precedence.

// Allow Lists take third precedence.

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:29:17Z

plugins/editors/tinymce/tinymce.php

 			}
-			// Blacklists take second precedence.
-			elseif ($blackList)
+			// DisallowList take second precedence.


Suggested change

// DisallowList take second precedence.

// Disallow List take second precedence.

Formalise the wording to show as separate words.

particthistle · 2020-07-25T11:37:35Z

Will leave someone to make a final decision on this for the desired combination.

Currently the reviewed code has "Allow List" and "Disallow List" now throughout - matching the language tags. Also follows familiar terminology used in Robots.txt.

@wilsonge should it be "Blocked List" in which case I'm happy to go through and review my review.

@bembelimen once review has been accepted I'll then test again.

…-blacklist

bembelimen · 2021-01-14T05:53:48Z

I think, if this happens, it should be made from scratch again to cover the new suggestion from Brian.

Probably @particthistle you want to give it a try?

particthistle · 2021-01-14T06:50:41Z

Someone can feel free to open an RFC discussion to put forward an agreed upon linguistic standard to use, and then we can build this again.

brianteeman · 2021-01-14T13:16:01Z

I just spent some time looking at this and it will never be a simple search and replace. After thinking about it for a while I think in most cases it will be enough to just changed to allowed and forbidden but there will be some occasions where for linguistic reasons it will need to be allowed list and forbidden list

The second issue is should this be everywhere or just in the visible strings. Everywhere means changing comments and variable names and to me the time to do that has now passed. But some might argue that if you still have a variable called $blacklist then you're not really desensitizing the language.

If @wilsonge and @bembelimen can make a decision on that I can easily do the work

HLeithner · 2021-01-14T13:18:59Z

Changing the variable names it self is not the problem but the b/c break that can happen if they are public, also formfields are hard to change and have to be migrated (or both fields are considered till 5.0).

bembelimen added 2 commits June 19, 2020 00:12

Remove whitelist/blacklist terms

85d3d80

Fix class variable loading

eb52ca3

bembelimen requested a review from HLeithner as a code owner June 18, 2020 22:18

joomla-cms-bot added Language Change This is for Translators PR-4.0-dev labels Jun 18, 2020

Fix CS

7df1ecc

CS

383b805

brianteeman reviewed Jun 19, 2020

View reviewed changes

particthistle reviewed Jun 28, 2020

View reviewed changes

particthistle reviewed Jul 25, 2020

View reviewed changes

Merge branch '4.0-dev' of github.com:joomla/joomla-cms into 4.0/white…

b8403d2

…-blacklist

Quy added the Updates Requested Indicates that this pull request needs an update from the author and should not be tested. label Sep 14, 2020

Quy added the Conflicting Files label Oct 27, 2020

bembelimen closed this Jan 14, 2021

brianteeman mentioned this pull request Jan 14, 2021

[4.0] whitelist strings #32030

Merged

bembelimen deleted the 4.0/white-blacklist branch January 23, 2024 00:15

	COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of illegal MIME types to upload."
	COM_MEDIA_FIELD_ILLEGAL_MIME_TYPES_DESC="A comma separated list of MIME types that can not be uploaded."

	COM_CONFIG_FIELD_FILTERS_CUSTOM_DISALLOW_LIST="Custom DisallowList"
	COM_CONFIG_FIELD_FILTERS_CUSTOM_DISALLOW_LIST="Custom Disallow List"

	COM_CONFIG_FIELD_FILTERS_DEFAULT_DISALLOW_LIST="Default DisallowList"
	COM_CONFIG_FIELD_FILTERS_DEFAULT_DISALLOW_LIST="Default Disallow List"

	COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom DisallowList"
	COM_CONFIG_FIELD_FILTERS_CUSTOM_BLACK_LIST="Custom Disallow List"

	COM_CONFIG_FIELD_FILTERS_DEFAULT_BLACK_LIST="Default DisallowList"
	COM_CONFIG_FIELD_FILTERS_DEFAULT_BLACK_LIST="Default Disallow List"

	COM_CONFIG_FIELD_FILTERS_ALLOW_LIST="AllowList"
	COM_CONFIG_FIELD_FILTERS_ALLOW_LIST="Allow List"

	// Remove the allowed tags and attributes from the disallowList.
	// Remove the allowed tags and attributes from the Disallow List.

	// Remove allowed tags from filter's default disallowList
	// Remove allowed tags from filter's default Disallow List

	// Remove allowed attributes from filter's default disallowList
	// Remove allowed attributes from filter's default Disallow List

	// AllowLists take third precedence.
	// Allow Lists take third precedence.

	// DisallowList take second precedence.
	// Disallow List take second precedence.

Uh oh!

Comments

Conversation

bembelimen commented Jun 18, 2020

Summary of Changes

Testing Instructions

Uh oh!

brianteeman commented Jun 18, 2020

Uh oh!

richard67 commented Jun 19, 2020

Uh oh!

bembelimen commented Jun 19, 2020

Uh oh!

brianteeman commented Jun 19, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

N6REJ commented Jun 19, 2020

Uh oh!

wilsonge commented Jun 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

particthistle commented Jun 28, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

particthistle Jun 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

particthistle commented Jun 28, 2020

Uh oh!

particthistle left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

particthistle commented Jul 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bembelimen commented Jan 14, 2021

Uh oh!

particthistle commented Jan 14, 2021

Uh oh!

brianteeman commented Jan 14, 2021

Uh oh!

HLeithner commented Jan 14, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

wilsonge commented Jun 20, 2020 •

edited

Loading

particthistle Jun 28, 2020 •

edited

Loading

particthistle commented Jul 25, 2020 •

edited

Loading