Added delete option to adldap:import command

- The `delete` option will soft-delete users who are disabled in active
directory. If the log option is set to true, only newly deleted users
will be logged. Previously deleted users will not.
- Closes #183

Author: stevebauman

src/Commands/Import.php

@@ -5,8 +5,8 @@
 use Adldap\Models\User;
 use Adldap\Laravel\Traits\ImportsUsers;
 use Illuminate\Console\Command;
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputArgument;
 
 class Import extends Command
 {
@@ -41,6 +41,7 @@ public function handle()
             $adldap->connect();
         }
 
+        // Generate a new user search.
         $search = $adldap->search()->users();
 
         if ($filter = $this->getFilter()) {
@@ -70,11 +71,11 @@ public function handle()
      * Imports the specified users and returns the total
      * number of users successfully imported.
      *
-     * @param mixed $users
+     * @param array $users
      *
      * @return int
      */
-    public function import($users = [])
+    public function import(array $users = [])
     {
         $imported = 0;
 
@@ -93,6 +94,22 @@ public function import($users = [])
                             logger()->info("Imported user {$user->getCommonName()}");
                         }
                     }
+
+                    if (
+                        $this->isDeleting() &&
+                        method_exists($model, 'trashed') &&
+                        ! $model->trashed() &&
+                        $user->isDisabled()
+                    ) {
+                        // If deleting is enabled, the model supports soft deletes, the model
+                        // isn't already deleted, and the AD user is disabled, we'll
+                        // go ahead and delete the users model.
+                        $model->delete();
+
+                        if ($this->isLogging()) {
+                            logger()->info("Soft-deleted user {$user->getCommonName()}. Their AD user account is disabled.");
+                        }
+                    }
                 } catch (\Exception $e) {
                     // Log the unsuccessful import.
                     if ($this->isLogging()) {
@@ -115,6 +132,16 @@ public function isLogging()
         return $this->option('log') == 'true';
     }
 
+    /**
+     * Returns true / false if users are being deleted if they are disabled in AD.
+     *
+     * @return bool
+     */
+    public function isDeleting()
+    {
+        return $this->option('delete') == 'true';
+    }
+
     /**
      * Returns the limitation filter for the user query.
      *
@@ -150,6 +177,8 @@ public function getOptions()
             ['log', true, InputOption::VALUE_OPTIONAL, 'Log successful and unsuccessful imported users.'],
 
             ['connection', null, InputOption::VALUE_OPTIONAL, 'The LDAP connection to use to import users.'],
+
+            ['delete', false, InputOption::VALUE_OPTIONAL, 'Soft-delete the users model if the AD user is disabled.'],
         ];
     }