Implement a better management interface for Settings (#809)

app/Http/Controllers/Admin/Settings/AdvancedController.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Pterodactyl\Http\Controllers\Admin\Settings;
+
+use Illuminate\View\View;
+use Illuminate\Http\RedirectResponse;
+use Prologue\Alerts\AlertsMessageBag;
+use Illuminate\Contracts\Console\Kernel;
+use Pterodactyl\Http\Controllers\Controller;
+use Illuminate\Contracts\Config\Repository as ConfigRepository;
+use Pterodactyl\Contracts\Repository\SettingsRepositoryInterface;
+use Pterodactyl\Http\Requests\Admin\Settings\AdvancedSettingsFormRequest;
+
+class AdvancedController extends Controller
+{
+    /**
+     * @var \Prologue\Alerts\AlertsMessageBag
+     */
+    private $alert;
+
+    /**
+     * @var \Illuminate\Contracts\Config\Repository
+     */
+    private $config;
+
+    /**
+     * @var \Illuminate\Contracts\Console\Kernel
+     */
+    private $kernel;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\SettingsRepositoryInterface
+     */
+    private $settings;
+
+    /**
+     * AdvancedController constructor.
+     *
+     * @param \Prologue\Alerts\AlertsMessageBag                             $alert
+     * @param \Illuminate\Contracts\Config\Repository                       $config
+     * @param \Illuminate\Contracts\Console\Kernel                          $kernel
+     * @param \Pterodactyl\Contracts\Repository\SettingsRepositoryInterface $settings
+     */
+    public function __construct(
+        AlertsMessageBag $alert,
+        ConfigRepository $config,
+        Kernel $kernel,
+        SettingsRepositoryInterface $settings
+    ) {
+        $this->alert = $alert;
+        $this->config = $config;
+        $this->kernel = $kernel;
+        $this->settings = $settings;
+    }
+
+    /**
+     * Render advanced Panel settings UI.
+     *
+     * @return \Illuminate\View\View
+     */
+    public function index(): View
+    {
+        $showRecaptchaWarning = false;
+        if (
+            $this->config->get('recaptcha._shipped_secret_key') === $this->config->get('recaptcha.secret_key')
+            || $this->config->get('recaptcha._shipped_website_key') === $this->config->get('recaptcha.website_key')
+        ) {
+            $showRecaptchaWarning = true;
+        }
+
+        return view('admin.settings.advanced', [
+            'showRecaptchaWarning' => $showRecaptchaWarning,
+        ]);
+    }
+
+    /**
+     * @param \Pterodactyl\Http\Requests\Admin\Settings\AdvancedSettingsFormRequest $request
+     * @return \Illuminate\Http\RedirectResponse
+     */
+    public function update(AdvancedSettingsFormRequest $request): RedirectResponse
+    {
+        foreach ($request->normalize() as $key => $value) {
+            $this->settings->set('settings::' . $key, $value);
+        }
+
+        $this->kernel->call('queue:restart');
+        $this->alert->success('Advanced settings have been updated successfully and the queue worker was restarted to apply these changes.')->flash();
+
+        return redirect()->route('admin.settings.advanced');
+    }
+}

app/Http/Controllers/Admin/Settings/IndexController.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Pterodactyl\Http\Controllers\Admin\Settings;
+
+use Illuminate\View\View;
+use Illuminate\Http\RedirectResponse;
+use Prologue\Alerts\AlertsMessageBag;
+use Illuminate\Contracts\Console\Kernel;
+use Pterodactyl\Http\Controllers\Controller;
+use Pterodactyl\Traits\Helpers\AvailableLanguages;
+use Pterodactyl\Services\Helpers\SoftwareVersionService;
+use Pterodactyl\Contracts\Repository\SettingsRepositoryInterface;
+use Pterodactyl\Http\Requests\Admin\Settings\BaseSettingsFormRequest;
+
+class IndexController extends Controller
+{
+    use AvailableLanguages;
+
+    /**
+     * @var \Prologue\Alerts\AlertsMessageBag
+     */
+    private $alert;
+
+    /**
+     * @var \Illuminate\Contracts\Console\Kernel
+     */
+    private $kernel;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\SettingsRepositoryInterface
+     */
+    private $settings;
+
+    /**
+     * @var \Pterodactyl\Services\Helpers\SoftwareVersionService
+     */
+    private $versionService;
+
+    /**
+     * IndexController constructor.
+     *
+     * @param \Prologue\Alerts\AlertsMessageBag                             $alert
+     * @param \Illuminate\Contracts\Console\Kernel                          $kernel
+     * @param \Pterodactyl\Contracts\Repository\SettingsRepositoryInterface $settings
+     * @param \Pterodactyl\Services\Helpers\SoftwareVersionService          $versionService
+     */
+    public function __construct(
+        AlertsMessageBag $alert,
+        Kernel $kernel,
+        SettingsRepositoryInterface $settings,
+        SoftwareVersionService $versionService)
+    {
+        $this->alert = $alert;
+        $this->kernel = $kernel;
+        $this->settings = $settings;
+        $this->versionService = $versionService;
+    }
+
+    /**
+     * Render the UI for basic Panel settings.
+     *
+     * @return \Illuminate\View\View
+     */
+    public function index(): View
+    {
+        return view('admin.settings.index', [
+            'version' => $this->versionService,
+            'languages' => $this->getAvailableLanguages(true),
+        ]);
+    }
+
+    /**
+     * Handle settings update.
+     *
+     * @param \Pterodactyl\Http\Requests\Admin\Settings\BaseSettingsFormRequest $request
+     * @return \Illuminate\Http\RedirectResponse
+     */
+    public function update(BaseSettingsFormRequest $request): RedirectResponse
+    {
+        foreach ($request->normalize() as $key => $value) {
+            $this->settings->set('settings::' . $key, $value);
+        }
+
+        $this->kernel->call('queue:restart');
+        $this->alert->success('Panel settings have been updated successfully and the queue worker was restarted to apply these changes.')->flash();
+
+        return redirect()->route('admin.settings');
+    }
+}

app/Http/Controllers/Admin/Settings/MailController.php

@@ -0,0 +1,112 @@
+<?php
+
+namespace Pterodactyl\Http\Controllers\Admin\Settings;
+
+use Illuminate\View\View;
+use Illuminate\Http\RedirectResponse;
+use Prologue\Alerts\AlertsMessageBag;
+use Illuminate\Contracts\Console\Kernel;
+use Pterodactyl\Exceptions\DisplayException;
+use Pterodactyl\Http\Controllers\Controller;
+use Illuminate\Contracts\Encryption\Encrypter;
+use Pterodactyl\Providers\SettingsServiceProvider;
+use Illuminate\Contracts\Config\Repository as ConfigRepository;
+use Pterodactyl\Contracts\Repository\SettingsRepositoryInterface;
+use Pterodactyl\Http\Requests\Admin\Settings\MailSettingsFormRequest;
+
+class MailController extends Controller
+{
+    /**
+     * @var \Prologue\Alerts\AlertsMessageBag
+     */
+    private $alert;
+
+    /**
+     * @var \Illuminate\Contracts\Config\Repository
+     */
+    private $config;
+
+    /**
+     * @var \Illuminate\Contracts\Encryption\Encrypter
+     */
+    private $encrypter;
+
+    /**
+     * @var \Illuminate\Contracts\Console\Kernel
+     */
+    private $kernel;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\SettingsRepositoryInterface
+     */
+    private $settings;
+
+    /**
+     * MailController constructor.
+     *
+     * @param \Prologue\Alerts\AlertsMessageBag                             $alert
+     * @param \Illuminate\Contracts\Config\Repository                       $config
+     * @param \Illuminate\Contracts\Encryption\Encrypter                    $encrypter
+     * @param \Illuminate\Contracts\Console\Kernel                          $kernel
+     * @param \Pterodactyl\Contracts\Repository\SettingsRepositoryInterface $settings
+     */
+    public function __construct(
+        AlertsMessageBag $alert,
+        ConfigRepository $config,
+        Encrypter $encrypter,
+        Kernel $kernel,
+        SettingsRepositoryInterface $settings
+    ) {
+        $this->alert = $alert;
+        $this->config = $config;
+        $this->encrypter = $encrypter;
+        $this->kernel = $kernel;
+        $this->settings = $settings;
+    }
+
+    /**
+     * Render UI for editing mail settings. This UI should only display if
+     * the server is configured to send mail using SMTP.
+     *
+     * @return \Illuminate\View\View
+     */
+    public function index(): View
+    {
+        return view('admin.settings.mail', [
+            'disabled' => $this->config->get('mail.driver') !== 'smtp',
+        ]);
+    }
+
+    /**
+     * Handle request to update SMTP mail settings.
+     *
+     * @param \Pterodactyl\Http\Requests\Admin\Settings\MailSettingsFormRequest $request
+     * @return \Illuminate\Http\RedirectResponse
+     *
+     * @throws \Pterodactyl\Exceptions\DisplayException
+     */
+    public function update(MailSettingsFormRequest $request): RedirectResponse
+    {
+        if ($this->config->get('mail.driver') !== 'smtp') {
+            throw new DisplayException('This feature is only available if SMTP is the selected email driver for the Panel.');
+        }
+
+        $values = $request->normalize();
+        if (array_get($values, 'mail:password') === '!e') {
+            $values['mail:password'] = '';
+        }
+
+        foreach ($values as $key => $value) {
+            if (in_array($key, SettingsServiceProvider::getEncryptedKeys()) && ! empty($value)) {
+                $value = $this->encrypter->encrypt($value);
+            }
+
+            $this->settings->set('settings::' . $key, $value);
+        }
+
+        $this->kernel->call('queue:restart');
+        $this->alert->success('Mail settings have been updated successfully and the queue worker was restarted to apply these changes.')->flash();
+
+        return redirect()->route('admin.settings.mail');
+    }
+}