Allow changing of Backend user passwords through CLI. (#4836)

Adds an Artisan command "october:passwd" to change the password of a Backend User through CLI. This command may only be run through CLI - it will not work if called through a web handler.

Refs: #3521, #4835. Docs: 1f3bfc719e

modules/system/ServiceProvider.php

@@ -247,6 +247,7 @@ class ServiceProvider extends ModuleServiceProvider
         $this->registerConsoleCommand('october.fresh', 'System\Console\OctoberFresh');
         $this->registerConsoleCommand('october.env', 'System\Console\OctoberEnv');
         $this->registerConsoleCommand('october.install', 'System\Console\OctoberInstall');
+        $this->registerConsoleCommand('october.passwd', 'System\Console\OctoberPasswd');
 
         $this->registerConsoleCommand('plugin.install', 'System\Console\PluginInstall');
         $this->registerConsoleCommand('plugin.remove', 'System\Console\PluginRemove');

modules/system/console/OctoberPasswd.php

@@ -0,0 +1,112 @@
+<?php namespace System\Console;
+
+use Str;
+use Backend\Models\User;
+use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Question\Question;
+
+/**
+ * Console command to change the password of a Backend user via CLI.
+ *
+ * @package october\system
+ */
+class OctoberPasswd extends Command
+{
+    /**
+     * @var string The console command name.
+     */
+    protected $name = 'october:passwd';
+
+    /**
+     * @var string The console command description.
+     */
+    protected $description = 'Change the password of a Backend user.';
+
+    /**
+     * @var bool Was the password automatically generated?
+     */
+    protected $generatedPassword = false;
+
+    /**
+     * Execute the console command.
+     */
+    public function handle()
+    {
+        $username = $this->argument('username')
+            ?? $this->ask(
+                'Which user would you like to change the password for?'
+            );
+
+        // Check that the user exists
+        try {
+            $user = User::where('login', $username)
+                ->orWhere('email', $username)
+                ->firstOrFail();
+        } catch (ModelNotFoundException $e) {
+            $this->error('The specified user does not exist.');
+            exit(1);
+        }
+
+        $password = $this->argument('password')
+            ?? (
+                $this->optionalSecret(
+                    'Enter in a new password, or press ENTER to use a generated password',
+                    false,
+                    false
+                ) ?: $this->generatePassword()
+            );
+
+        // Change password
+        $user->password = $password;
+        $user->forceSave();
+
+        $this->info('Password successfully changed.');
+        if (!$this->generatedPassword) {
+            $this->output->writeLn('The new password is <info>' . $password . '</info>.');
+        }
+        exit(0);
+    }
+
+    /**
+     * Get the console command options.
+     */
+    protected function getArguments()
+    {
+        return [
+            ['username', InputArgument::OPTIONAL, 'The username of the Backend user'],
+            ['password', InputArgument::OPTIONAL, 'The new password']
+        ];
+    }
+
+    /**
+     * Prompt the user for input but hide the answer from the console.
+     *
+     * Also allows for a default to be specified.
+     *
+     * @param  string  $question
+     * @param  bool    $fallback
+     * @return string
+     */
+    protected function optionalSecret($question, $fallback = true, $default = null)
+    {
+        $question = new Question($question, $default);
+
+        $question->setHidden(true)->setHiddenFallback($fallback);
+
+        return $this->output->askQuestion($question);
+    }
+
+    /**
+     * Generate a password and flag it as an automatically-generated password.
+     *
+     * @return string
+     */
+    protected function generatePassword()
+    {
+        $this->generatedPassword = true;
+
+        return Str::random(22);
+    }
+}