From: dongsheng <dongsheng>
Date: Wed, 26 Mar 2008 01:35:04 +0000 (+0000)
Subject: MDL-14055, change to human-readable strings from hard-coded integer, thanks for Matt... 
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=6f87ef52b96c23f0b4fa37ae02952a2437f2fddd;p=moodle.git

MDL-14055, change to human-readable strings from hard-coded integer, thanks for Matt's patch.
---

diff --git a/auth/cas/auth.php b/auth/cas/auth.php
index ff01fa9a39..f3d05e46e4 100644
--- a/auth/cas/auth.php
+++ b/auth/cas/auth.php
@@ -269,7 +269,7 @@ if ( !is_object($PHPCAS_CLIENT) ) {
         if (!isset($config->groupecreators))
             {$config->groupecreators = ''; }
         if (!isset($config->removeuser))
-            {$config->removeuser = 0; }
+            {$config->removeuser = AUTH_REMOVEUSER_KEEP; }
         // save CAS settings
         set_config('hostname',    $config->hostname,    'auth/cas');
         set_config('port',        $config->port,        'auth/cas');
@@ -708,13 +708,13 @@ if ( !is_object($PHPCAS_CLIENT) ) {
             if (!empty($remove_users)) {
                 print "User entries to remove: ". count($remove_users) . "\n";
                 foreach ($remove_users as $user) {
-                    if ($this->config->removeuser == 2) {
+                    if ($this->config->removeuser == AUTH_REMOVEUSER_FULLDELETE) {
                         if (delete_user($user)) {
                             echo "\t"; print_string('auth_dbdeleteuser', 'auth', array($user->username, $user->id)); echo "\n";
                         } else {
                             echo "\t"; print_string('auth_dbdeleteusererror', 'auth', $user->username); echo "\n";
                         }
-                    } else if ($this->config->removeuser == 1) {
+                    } else if ($this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
                         $updateuser = new object();
                         $updateuser->id = $user->id;
                         $updateuser->auth = 'nologin';
@@ -731,7 +731,7 @@ if ( !is_object($PHPCAS_CLIENT) ) {
             unset($remove_users); // free mem!
         }
 /// Revive suspended users
-        if (!empty($this->config->removeuser) and $this->config->removeuser == 1) {
+        if (!empty($this->config->removeuser) and $this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
             $sql = "SELECT u.id, u.username
                     FROM $temptable e, {$CFG->prefix}user u
                     WHERE e.username=u.username
diff --git a/auth/cas/config.html b/auth/cas/config.html
index 22cd7a00d0..23f9137deb 100644
--- a/auth/cas/config.html
+++ b/auth/cas/config.html
@@ -112,7 +112,7 @@
 
      if (!isset($config->removeuser))
 
-        {$config->removeuser = 0; }
+        {$config->removeuser = AUTH_REMOVEUSER_KEEP; }
 
 
 
@@ -782,11 +782,11 @@ if (!function_exists('ldap_connect')) { // Is php4-ldap really there?
 
        $deleteopt = array();
 
-       $deleteopt['0'] = get_string('auth_remove_keep','auth');
+       $deleteopt[AUTH_REMOVEUSER_KEEP] = get_string('auth_remove_keep','auth');
 
-       $deleteopt['1'] = get_string('auth_remove_suspend','auth');
+       $deleteopt[AUTH_REMOVEUSER_SUSPEND] = get_string('auth_remove_suspend','auth');
 
-       $deleteopt['2'] = get_string('auth_remove_delete','auth');
+       $deleteopt[AUTH_REMOVEUSER_FULLDELETE] = get_string('auth_remove_delete','auth');
 
        choose_from_menu($deleteopt, 'removeuser', $config->removeuser, '');
 
@@ -825,4 +825,4 @@ print_auth_lock_options('cas', $user_fields, $help, true, true);
 
 
 ?>
-</table>
\ No newline at end of file
+</table>
diff --git a/auth/db/auth.php b/auth/db/auth.php
index 239df97e14..32f2df1e3c 100644
--- a/auth/db/auth.php
+++ b/auth/db/auth.php
@@ -255,13 +255,13 @@ class auth_plugin_db extends auth_plugin_base {
                 print_string('auth_dbuserstoremove','auth', count($remove_users)); echo "\n";
 
                 foreach ($remove_users as $user) {
-                    if ($this->config->removeuser == 2) {
+                    if ($this->config->removeuser == AUTH_REMOVEUSER_FULLDELETE) {
                         if (delete_user($user)) {
                             echo "\t"; print_string('auth_dbdeleteuser', 'auth', array($user->username, $user->id)); echo "\n";
                         } else {
                             echo "\t"; print_string('auth_dbdeleteusererror', 'auth', $user->username); echo "\n";
                         }
-                    } else if ($this->config->removeuser == 1) {
+                    } else if ($this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
                         $updateuser = new object();
                         $updateuser->id   = $user->id;
                         $updateuser->auth = 'nologin';
@@ -666,7 +666,7 @@ class auth_plugin_db extends auth_plugin_base {
             $config->debugauthdb = 0;
         }
         if (!isset($config->removeuser)) {
-            $config->removeuser = 0;
+            $config->removeuser = AUTH_REMOVEUSER_KEEP;
         }
         if (!isset($config->changepasswordurl)) {
             $config->changepasswordurl = '';
diff --git a/auth/db/config.html b/auth/db/config.html
index e4ccbe3bf9..d7aea3f814 100644
--- a/auth/db/config.html
+++ b/auth/db/config.html
@@ -44,7 +44,7 @@
         $config->setupsql = '';
     }
     if (!isset($config->removeuser)) {
-        $config->removeuser = 0;
+        $config->removeuser = AUTH_REMOVEUSER_KEEP;
     }
 
     $yesno = array( get_string('no'), get_string('yes') );
@@ -256,9 +256,9 @@
     <td>
     <?php
        $deleteopt = array();
-       $deleteopt['0'] = get_string('auth_remove_keep','auth');
-       $deleteopt['1'] = get_string('auth_remove_suspend','auth');
-       $deleteopt['2'] = get_string('auth_remove_delete','auth');
+       $deleteopt[AUTH_REMOVEUSER_KEEP] = get_string('auth_remove_keep','auth');
+       $deleteopt[AUTH_REMOVEUSER_SUSPEND] = get_string('auth_remove_suspend','auth');
+       $deleteopt[AUTH_REMOVEUSER_FULLDELETE] = get_string('auth_remove_delete','auth');
        choose_from_menu($deleteopt, 'removeuser', $config->removeuser, '');
     ?>
     </td>
diff --git a/auth/ldap/auth.php b/auth/ldap/auth.php
index 5ae7085b5c..868d950316 100644
--- a/auth/ldap/auth.php
+++ b/auth/ldap/auth.php
@@ -655,13 +655,13 @@ class auth_plugin_ldap extends auth_plugin_base {
                 print "User entries to remove: ". count($remove_users) . "\n";
 
                 foreach ($remove_users as $user) {
-                    if ($this->config->removeuser == 2) {
+                    if ($this->config->removeuser == AUTH_REMOVEUSER_FULLDELETE) {
                         if (delete_user($user)) {
                             echo "\t"; print_string('auth_dbdeleteuser', 'auth', array($user->username, $user->id)); echo "\n";
                         } else {
                             echo "\t"; print_string('auth_dbdeleteusererror', 'auth', $user->username); echo "\n";
                         }
-                    } else if ($this->config->removeuser == 1) {
+                    } else if ($this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
                         $updateuser = new object();
                         $updateuser->id = $user->id;
                         $updateuser->auth = 'nologin';
@@ -679,7 +679,7 @@ class auth_plugin_ldap extends auth_plugin_base {
         }
 
 /// Revive suspended users
-        if (!empty($this->config->removeuser) and $this->config->removeuser == 1) {
+        if (!empty($this->config->removeuser) and $this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
             $sql = "SELECT u.id, u.username
                     FROM $temptable e, {$CFG->prefix}user u
                     WHERE e.username=u.username
@@ -1971,7 +1971,7 @@ class auth_plugin_ldap extends auth_plugin_base {
         if (!isset($config->changepasswordurl))
             {$config->changepasswordurl = ''; }
         if (!isset($config->removeuser))
-            {$config->removeuser = 0; }
+            {$config->removeuser = AUTH_REMOVEUSER_KEEP; }
         if (!isset($config->ntlmsso_enabled))
             {$config->ntlmsso_enabled = 0; }
         if (!isset($config->ntlmsso_subnet))
diff --git a/auth/ldap/config.html b/auth/ldap/config.html
index 55fe2debd0..e7f4aeaa78 100644
--- a/auth/ldap/config.html
+++ b/auth/ldap/config.html
@@ -54,7 +54,7 @@
     if (!isset($config->changepasswordurl))
         {$config->changepasswordurl = ''; }
     if (!isset($config->removeuser))
-        {$config->removeuser = 0; }
+        {$config->removeuser = AUTH_REMOVEUSER_KEEP; }
     if (!isset($config->ntlmsso_enabled))
         {$config->ntlmsso_enabled = 0; }
     if (!isset($config->ntlmsso_subnet))
@@ -432,9 +432,9 @@ if (!function_exists('ldap_connect')) { // Is php4-ldap really there?
     <td>
     <?php
        $deleteopt = array();
-       $deleteopt['0'] = get_string('auth_remove_keep','auth');
-       $deleteopt['1'] = get_string('auth_remove_suspend','auth');
-       $deleteopt['2'] = get_string('auth_remove_delete','auth');
+       $deleteopt[AUTH_REMOVEUSER_KEEP] = get_string('auth_remove_keep','auth');
+       $deleteopt[AUTH_REMOVEUSER_SUSPEND] = get_string('auth_remove_suspend','auth');
+       $deleteopt[AUTH_REMOVEUSER_FULLDELETE] = get_string('auth_remove_delete','auth');
        choose_from_menu($deleteopt, 'removeuser', $config->removeuser, '');
     ?>
     </td>
diff --git a/lib/authlib.php b/lib/authlib.php
index 2cbdda31d1..835e6afd68 100644
--- a/lib/authlib.php
+++ b/lib/authlib.php
@@ -38,7 +38,10 @@ define('AUTH_CONFIRM_OK', 1);
 define('AUTH_CONFIRM_ALREADY', 2);
 define('AUTH_CONFIRM_ERROR', 3);
 
-
+# MDL-14055
+define('AUTH_REMOVEUSER_KEEP', 0);
+define('AUTH_REMOVEUSER_SUSPEND', 1);
+define('AUTH_REMOVEUSER_FULLDELETE', 2);
 
 /**
  * Abstract authentication plugin.