MDL-69050 lang: Improve the wording of the comments
authorDavid Mudrák <david@moodle.com>
Wed, 16 Sep 2020 06:45:46 +0000 (08:45 +0200)
committerDavid Mudrák <david@moodle.com>
Thu, 24 Sep 2020 17:32:40 +0000 (19:32 +0200)
Stop using the terms whitelist/blacklist when used to allow/deny things.

admin/webservice/testclient.php
calendar/lib.php
filter/algebra/filter.php
lib/classes/component.php
lib/deprecatedlib.php
lib/enrollib.php
lib/externallib.php
lib/filelib.php
message/lib.php
user/editlib.php

index e56c325..c7b77cc 100644 (file)
@@ -61,7 +61,7 @@ foreach ($allfunctions as $f) {
     }
 }
 
-// whitelisting security
+// Allow only functions available for testing.
 if (!isset($functions[$function])) {
     $function = '';
 }
@@ -81,7 +81,9 @@ foreach ($active_protocols as $p) {
     }
     $protocols[$p] = get_string('pluginname', 'webservice_'.$p);
 }
-if (!isset($protocols[$protocol])) { // whitelisting security
+
+// Allow only protocols supporting the test client.
+if (!isset($protocols[$protocol])) {
     $protocol = '';
 }
 
index 9755765..107306e 100644 (file)
@@ -3257,7 +3257,7 @@ function calendar_get_calendar_context($subscription) {
 }
 
 /**
- * Implements callback user_preferences, whitelists preferences that users are allowed to update directly
+ * Implements callback user_preferences, lists preferences that users are allowed to update directly
  *
  * Used in {@see core_user::fill_preferences_cache()}, see also {@see useredit_update_user_preference()}
  *
index 61fe8e7..a0a3a4c 100644 (file)
@@ -227,7 +227,8 @@ class filter_algebra extends moodle_text_filter {
                   $texexp = preg_replace('/\\\int\\\left\((.+?),(.+?),(.+?)\\\right\)/s','\int_'. "{\$2}^{\$3}\$1 ",$texexp);
                   $texexp = preg_replace('/\\\int\\\left\((.+?d[a-z])\\\right\)/s','\int '. "\$1 ",$texexp);
                   $texexp = preg_replace('/\\\lim\\\left\((.+?),(.+?),(.+?)\\\right\)/s','\lim_'. "{\$2\\to \$3}\$1 ",$texexp);
-                  $texexp = str_replace('\mbox', '', $texexp); // now blacklisted in tex, sorry
+                  // Remove a forbidden keyword.
+                  $texexp = str_replace('\mbox', '', $texexp);
                   $texcache = new stdClass();
                   $texcache->filter = 'algebra';
                   $texcache->version = 1;
index fd96e72..fa25ae4 100644 (file)
@@ -733,7 +733,7 @@ $cache = '.var_export($cache, true).';
     /**
      * List all core subsystems and their location
      *
-     * This is a whitelist of components that are part of the core and their
+     * This is a list of components that are part of the core and their
      * language strings are defined in /lang/en/<<subsystem>>.php. If a given
      * plugin is not listed here and it does not have proper plugintype prefix,
      * then it is considered as course activity module.
index e20ad23..61db87c 100644 (file)
@@ -49,7 +49,7 @@ function events_trigger() {
 /**
  * List all core subsystems and their location
  *
- * This is a whitelist of components that are part of the core and their
+ * This is a list of components that are part of the core and their
  * language strings are defined in /lang/en/<<subsystem>>.php. If a given
  * plugin is not listed here and it does not have proper plugintype prefix,
  * then it is considered as course activity module.
index fbb5c39..193f0c5 100644 (file)
@@ -1158,7 +1158,6 @@ function enrol_selfenrol_available($courseid) {
             continue;
         }
         if ($instance->enrol === 'guest') {
-            // blacklist known temporary guest plugins
             continue;
         }
         if ($plugins[$instance->enrol]->show_enrolme_link($instance)) {
index 7f33390..8c1a21e 100644 (file)
@@ -1105,7 +1105,7 @@ function external_generate_token_for_current_user($service) {
             $unsettoken = true;
         }
 
-        // Remove token if its ip not in whitelist.
+        // Remove token if its IP is restricted.
         if (isset($token->iprestriction) and !address_in_subnet(getremoteaddr(), $token->iprestriction)) {
             $unsettoken = true;
         }
index 3fcdf93..6ec5d7b 100644 (file)
@@ -3571,7 +3571,7 @@ class curl {
      * @return bool
      */
     protected function request($url, $options = array()) {
-        // Reset here so that the data is valid when result returned from cache, or if we return due to a blacklist hit.
+        // Reset here so that the data is valid when result returned from cache, or if we return due to a blocked URL hit.
         $this->reset_request_state_vars();
 
         if ((defined('PHPUNIT_TEST') && PHPUNIT_TEST)) {
@@ -3581,8 +3581,8 @@ class curl {
             }
         }
 
-        // If curl security is enabled, check the URL against the blacklist before calling curl_exec.
-        // Note: This will only check the base url. In the case of redirects, the blacklist is also after the curl_exec.
+        // If curl security is enabled, check the URL against the list of blocked URLs before calling curl_exec.
+        // Note: This will only check the base url. In the case of redirects, the blocking check is also after the curl_exec.
         if (!$this->ignoresecurity && $this->securityhelper->url_is_blocked($url)) {
             $this->error = $this->securityhelper->get_blocked_url_string();
             return $this->error;
@@ -3605,7 +3605,7 @@ class curl {
         $this->errno = curl_errno($curl);
         // Note: $this->response and $this->rawresponse are filled by $hits->formatHeader callback.
 
-        // In the case of redirects (which curl blindly follows), check the post-redirect URL against the blacklist entries too.
+        // In the case of redirects (which curl blindly follows), check the post-redirect URL against the list of blocked list too.
         if (intval($this->info['redirect_count']) > 0 && !$this->ignoresecurity
             && $this->securityhelper->url_is_blocked($this->info['url'])) {
             $this->reset_request_state_vars();
index 406465c..03a7a09 100644 (file)
@@ -729,7 +729,7 @@ function core_message_can_edit_message_profile($user) {
 }
 
 /**
- * Implements callback user_preferences, whitelists preferences that users are allowed to update directly
+ * Implements callback user_preferences, lists preferences that users are allowed to update directly
  *
  * Used in {@see core_user::fill_preferences_cache()}, see also {@see useredit_update_user_preference()}
  *
index 9704a78..56c2670 100644 (file)
@@ -152,7 +152,7 @@ function useredit_load_preferences(&$user, $reload=true) {
  * Updates the user preferences for the given user
  *
  * Only preference that can be updated directly will be updated here. This method is called from various WS
- * updating users and should be used when updating user details. Plugins may whitelist preferences that can
+ * updating users and should be used when updating user details. Plugins may list preferences that can
  * be updated by defining 'user_preferences' callback, {@see core_user::fill_preferences_cache()}
  *
  * Some parts of code may use user preference table to store internal data, in these cases it is acceptable