Implement a better management interface for Settings (pterodactyl#809)

Author: DaneEveritt

.env.travis

@@ -16,3 +16,4 @@ MAIL_DRIVER=array
 QUEUE_DRIVER=sync
 
 HASHIDS_SALT=test123
+APP_ENVIRONMENT_ONLY=true

app/Contracts/Repository/SettingsRepositoryInterface.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Pterodactyl\Contracts\Repository;
+
+interface SettingsRepositoryInterface extends RepositoryInterface
+{
+    /**
+     * Store a new persistent setting in the database.
+     *
+     * @param string $key
+     * @param string $value
+     * @return mixed
+     */
+    public function set(string $key, string $value);
+
+    /**
+     * Retrieve a persistent setting from the database.
+     *
+     * @param string $key
+     * @param mixed  $default
+     * @return mixed
+     */
+    public function get(string $key, $default);
+
+    /**
+     * Remove a key from the database cache.
+     *
+     * @param string $key
+     * @return mixed
+     */
+    public function forget(string $key);
+}

app/Http/Controllers/Admin/BaseController.php

@@ -1,51 +1,25 @@
 <?php
-/**
- * Pterodactyl - Panel
- * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
 
 namespace Pterodactyl\Http\Controllers\Admin;
 
-use Krucas\Settings\Settings;
-use Prologue\Alerts\AlertsMessageBag;
+use Illuminate\View\View;
 use Pterodactyl\Http\Controllers\Controller;
-use Pterodactyl\Http\Requests\Admin\BaseFormRequest;
 use Pterodactyl\Services\Helpers\SoftwareVersionService;
 
 class BaseController extends Controller
 {
-    /**
-     * @var \Prologue\Alerts\AlertsMessageBag
-     */
-    protected $alert;
-
-    /**
-     * @var \Krucas\Settings\Settings
-     */
-    protected $settings;
-
     /**
      * @var \Pterodactyl\Services\Helpers\SoftwareVersionService
      */
-    protected $version;
+    private $version;
 
     /**
      * BaseController constructor.
      *
-     * @param \Prologue\Alerts\AlertsMessageBag                    $alert
-     * @param \Krucas\Settings\Settings                            $settings
      * @param \Pterodactyl\Services\Helpers\SoftwareVersionService $version
      */
-    public function __construct(
-        AlertsMessageBag $alert,
-        Settings $settings,
-        SoftwareVersionService $version
-    ) {
-        $this->alert = $alert;
-        $this->settings = $settings;
+    public function __construct(SoftwareVersionService $version)
+    {
         $this->version = $version;
     }
 
@@ -54,34 +28,8 @@ public function __construct(
      *
      * @return \Illuminate\View\View
      */
-    public function getIndex()
+    public function index(): View
     {
         return view('admin.index', ['version' => $this->version]);
     }
-
-    /**
-     * Return the admin settings view.
-     *
-     * @return \Illuminate\View\View
-     */
-    public function getSettings()
-    {
-        return view('admin.settings');
-    }
-
-    /**
-     * Handle settings post request.
-     *
-     * @param \Pterodactyl\Http\Requests\Admin\BaseFormRequest $request
-     * @return \Illuminate\Http\RedirectResponse
-     */
-    public function postSettings(BaseFormRequest $request)
-    {
-        $this->settings->set('company', $request->input('company'));
-        $this->settings->set('2fa', $request->input('2fa'));
-
-        $this->alert->success('Settings have been successfully updated.')->flash();
-
-        return redirect()->route('admin.settings');
-    }
 }

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');
+    }
+}