Replace 'blacklist' with more neutral term 'blocklist' or 'denylist'

[toonmaster]

Expected Behavior

Rename 'blacklist' terms in the code to be a more neutral term such as 'blocklist' or 'denylist'.

Current Behavior

Currently, there is a blacklist feature to block sender addresses. There is a menu item under this name and code that utilizes the term in various ways.

Possible Solution

Rename 'blocklist' to a more neutral term.

Context

In our university setting, a directive has been given to cease using 'blacklist' and 'whitelist' in favor of other terms.

[ikedas]

FYI:

• An external plugin for Sympa (however it is described in official documentation) uses the term "whitelist".
• In a test case in the test suite, the word "sender_whitelist" is used as the name of a custom variable, though it won't appear in installed software.

IMHO alternative wording would be better also to consider those usages.

[ikedas]

Another FYI:

• I compiled translation of "blacklist" on Sympa.
  However, even in languages that use the word corresponding to "black," the meaning of such word is not exactly the same as in US English, so in languages other than English, each language should decide whether or not to replace it.

[dverdin]

For information, you can perfectly modify the template in the web interface to change the wording.
You can access templates customization through the "template" section of the listmaster administration.

[ldidry]

so in languages other than English, each language should decide whether or not to replace it.

If we replace blacklist with denylist, there is few risk that translators keep the blacklist translation.

[ikedas]

so in languages other than English, each language should decide whether or not to replace it.

If we replace blacklist with denylist, there is few risk that translators keep the blacklist translation.

On Sympa, US English messages are the keys of all translated (localized) messages in the other languages. However, there is no worry changing US English messages. A bit long description follows ---

If English "translation" in the gettext object file for US English en_US.po was changed, correct_msgid script will keep the translation of all the other languages in sync. For example, if en_US.po was changed to

#: src/lib/Sympa/Config/Schema.pm:1383
msgid "Use blacklist"
msgstr "Use denylist"

correct_msgid modifies an entry in fr.po

#: src/lib/Sympa/Config/Schema.pm:1383
msgid "Use blacklist"
msgstr "Utilise la liste noire"

to add a new entry

#: src/lib/Sympa/Config/Schema.pm:1383
msgid "Use denylist"
msgstr "Utilise la liste noire"

and also changes corresponding messages in source files.

Thus, localized messages won't be broken.

[racke]

I think that's a bad idea, why don't we change the gettext_id in Schema.pm?

[ikedas]

I think that's a bad idea, why don't we change the gettext_id in Schema.pm?

I didn't explain it well enough. correct_msgid will modify corresponding source files too.
Thus, only thing we have to do is to change entry(ies) of en_US.po on translation site.

@racke, please see what the scripts under support/ directory do in your spare time.

[racke]

OK can you provide an example for correct_msgid which replaces blacklist with denylist?

[ikedas]

OK can you provide an example for correct_msgid which replaces blacklist with denylist?

Here is an example.

• Step 1: Modify "translation" of US English catalog (en_US.po). In reality these changes would be done on Sympa Translation site.

• Step 2: Run correct_msgid script.

  As the results by this:

  • Entries to keep po files of the other languages in sync with modification of US English on Step 1 will be added.
  • The messages in source codes will be changed according to the changes on US English catalog (If you want to see the changes on source codes in advance, run correct_msgid with --dry_run option).

  In this demo commit, you can see the changes described in above.

Thus, messages in US English catalog may be changed as catalogs for the other languages may be.

[racke]

But that wouldn't get rid of blacklist in Sympa::Config::Schema.

[ikedas]

But that wouldn't get rid of blacklist in Sympa::Config::Schema.

Pardon? correct_msgid also corrects Sympa::Config::Schema.

EDIT: You may have to wait for a while until all changes will be shown.

[ikedas]

There are two features called "blacklist" on Sympa.

• The implicit scenario rules enabled by use_blacklist parameter.
  It refers to an address list contained in the file named blacklist.txt.
• Preventing people to subscribe to a list with adresses using these domains, enabled by domains_blacklist parameter.

We would also change these names of parameters and files.

[ikedas]

Hi @toonmaster,

As you see, technically speaking, we can replace the words "blacklist" that appear in Sympa software. However, since what word(s) to replace them is a cultural issue, we need specific suggestions for changes from you.

• On the messages the software may output, please modify "translation" of US English as you suggest, using US English sections of Sympa translation site:

  • The messages
  • Online help

  At first, sign-up is needed to use translation site. Please use search form to find messages to be modified. You may not modify the texts not related to your suggestion. When you complete the modification, please let us know on this issue page.

• Suggest the names to replace names of these parameters and file:

  • use_blacklist parameter and blacklist.txt file
  • domains_blacklist parameter

  According to your suggestion, we will change these names by modifying Sympa.

• There also are some of this word in the source code, but please leave it to us to fix them.

Thank you!

[toonmaster]

I have provided suggestions for The messages and Online help references (i.e., change 'blacklist' to 'blocklist'). The parameters and file can match:

use_blocklist parameter and blocklist.txt file
domains_blocklist parameter

[ikedas]

I have provided suggestions for The messages and Online help references (i.e., change 'blacklist' to 'blocklist'). The parameters and file can match:

I understand we can just mechanically replace "blacklist" in any messages with "blocklist" (taking into account the case difference, of course).

use_blocklist parameter and blocklist.txt file
domains_blocklist parameter

OK. I'll work for the changes.