Merge pull request pterodactyl#401 from Pterodactyl/feature/option-scripts

Feature/option scripts

Author: DaneEveritt

CHANGELOG.md

@@ -3,6 +3,15 @@ This file is a running track of new features and fixes to each version of the pa
 
 This project follows [Semantic Versioning](http://semver.org) guidelines.
 
+## v0.6.0-beta.2.1 (Courageous Carniadactylus)
+### Fixed
+* `[beta.2.1]` — Fixed a bug preventing the deletion of a server.
+
+### Added
+* Added new scripts for service options that allows installation of software in a privileged Docker container on the node prior to marking a server as installed.
+* Added ability to reinstall a server using the currently assigned service and option.
+* Added ability to change a server's service and service option, as well as change pack assignments and other management services in that regard.
+
 ## v0.6.0-beta.2.1 (Courageous Carniadactylus)
 ### Fixed
 * `[beta.2]` — Suspended servers now show as suspended.

app/Http/Controllers/Admin/OptionController.php

@@ -95,7 +95,7 @@ public function createVariable(Request $request, $id)
         $repo = new VariableRepository;
 
         try {
-            $variable = $repo->create($id, $request->only([
+            $variable = $repo->create($id, $request->intersect([
                 'name', 'description', 'env_variable',
                 'default_value', 'options', 'rules',
             ]));
@@ -137,6 +137,18 @@ public function viewVariables(Request $request, $id)
         return view('admin.services.options.variables', ['option' => ServiceOption::with('variables')->findOrFail($id)]);
     }
 
+    /**
+     * Display script management page for an option.
+     *
+     * @param  Request $request
+     * @param  int     $id
+     * @return \Illuminate\View\View
+     */
+    public function viewScripts(Request $request, $id)
+    {
+        return view('admin.services.options.scripts', ['option' => ServiceOption::findOrFail($id)]);
+    }
+
     /**
      * Handles POST when editing a configration for a service option.
      *
@@ -188,7 +200,7 @@ public function editVariable(Request $request, $option, $variable)
 
         try {
             if ($request->input('action') !== 'delete') {
-                $variable = $repo->update($variable, $request->only([
+                $variable = $repo->update($variable, $request->intersect([
                     'name', 'description', 'env_variable',
                     'default_value', 'options', 'rules',
                 ]));
@@ -208,4 +220,30 @@ public function editVariable(Request $request, $option, $variable)
 
         return redirect()->route('admin.services.option.variables', $option);
     }
+
+    /**
+     * Handles POST when updating scripts for a service option.
+     *
+     * @param  Request $request
+     * @param  int     $id
+     * @return \Illuminate\Response\RedirectResponse
+     */
+    public function updateScripts(Request $request, $id)
+    {
+        $repo = new OptionRepository;
+
+        try {
+            $repo->scripts($id, $request->only([
+                'script_install', 'script_entry', 'script_container',
+            ]));
+            Alert::success('Successfully updated option scripts to be run when servers are installed.')->flash();
+        } catch (DisplayValidationException $ex) {
+            return redirect()->route('admin.services.option.scripts', $id)->withErrors(json_decode($ex->getMessage()));
+        } catch (\Exception $ex) {
+            Log::error($ex);
+            Alert::danger('An unhandled exception was encountered while attempting to process that request. This error has been logged.')->flash();
+        }
+
+        return redirect()->route('admin.services.option.scripts', $id);
+    }
 }

app/Http/Controllers/Admin/ServersController.php

@@ -198,7 +198,24 @@ public function viewStartup(Request $request, $id)
             return $item;
         });
 
-        return view('admin.servers.view.startup', ['server' => $server]);
+        $services = Models\Service::with('options.packs', 'options.variables')->get();
+        Javascript::put([
+            'services' => $services->map(function ($item) {
+                return array_merge($item->toArray(), [
+                    'options' => $item->options->keyBy('id')->toArray(),
+                ]);
+            })->keyBy('id'),
+            'server_variables' => $server->variables->mapWithKeys(function ($item) {
+                return ['env_' . $item->variable_id => [
+                    'value' => $item->variable_value,
+                ]];
+            })->toArray(),
+        ]);
+
+        return view('admin.servers.view.startup', [
+            'server' => $server,
+            'services' => $services,
+        ]);
     }
 
     /**
@@ -322,6 +339,30 @@ public function toggleInstall(Request $request, $id)
         return redirect()->route('admin.servers.view.manage', $id);
     }
 
+    /**
+     * Reinstalls the server with the currently assigned pack and service.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  int                       $id
+     * @return \Illuminate\Http\RedirectResponse
+     */
+    public function reinstallServer(Request $request, $id)
+    {
+        $repo = new ServerRepository;
+        try {
+            $repo->reinstall($id);
+
+            Alert::success('Server successfully marked for reinstallation.')->flash();
+        } catch (DisplayException $ex) {
+            Alert::danger($ex->getMessage())->flash();
+        } catch (\Exception $ex) {
+            Log::error($ex);
+            Alert::danger('An unhandled exception occured while attemping to perform this reinstallation. This error has been logged.')->flash();
+        }
+
+        return redirect()->route('admin.servers.view.manage', $id);
+    }
+
     /**
      * Setup a server to have a container rebuild.
      *
@@ -455,9 +496,13 @@ public function saveStartup(Request $request, $id)
         $repo = new ServerRepository;
 
         try {
-            $repo->updateStartup($id, $request->except('_token'), true);
+            if ($repo->updateStartup($id, $request->except('_token'), true)) {
+                Alert::success('Service configuration successfully modfied for this server, reinstalling now.')->flash();
 
-            Alert::success('Startup variables were successfully modified and assigned for this server.')->flash();
+                return redirect()->route('admin.servers.view', $id);
+            } else {
+                Alert::success('Startup variables were successfully modified and assigned for this server.')->flash();
+            }
         } catch (DisplayValidationException $ex) {
             return redirect()->route('admin.servers.view.startup', $id)->withErrors(json_decode($ex->getMessage()));
         } catch (DisplayException $ex) {

app/Http/Controllers/Daemon/OptionController.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Pterodactyl - Panel
+ * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace Pterodactyl\Http\Controllers\Daemon;
+
+use Illuminate\Http\Request;
+use Pterodactyl\Models\Server;
+use Pterodactyl\Models\ServiceOption;
+use Pterodactyl\Http\Controllers\Controller;
+
+class OptionController extends Controller
+{
+    public function details(Request $request, $server)
+    {
+        $server = Server::with('allocation', 'option', 'variables.variable')->where('uuid', $server)->firstOrFail();
+
+        $environment = $server->variables->map(function ($item) {
+            return sprintf('%s=%s', $item->variable->env_variable, $item->variable_value);
+        });
+
+        return response()->json([
+            'scripts' => [
+                'install' => (! $server->option->script_install) ? null : str_replace(["\r\n", "\n", "\r"], "\n", $server->option->script_install),
+                'privileged' => $server->option->script_is_privileged,
+            ],
+            'config' => [
+                'container' => $server->option->script_container,
+                'entry' => $server->option->script_entry,
+            ],
+            'env' => $environment->merge([
+                'STARTUP=' . $server->startup,
+                'SERVER_MEMORY=' . $server->memory,
+                'SERVER_IP=' . $server->allocation->ip,
+                'SERVER_PORT=' . $server->allocation->port,
+            ])->toArray(),
+        ]);
+    }
+}

app/Models/Server.php

@@ -72,6 +72,7 @@ class Server extends Model
      */
     protected $casts = [
         'node_id' => 'integer',
+        'skip_scripts' => 'boolean',
         'suspended' => 'integer',
         'owner_id' => 'integer',
         'memory' => 'integer',

app/Models/ServiceOption.php

@@ -42,14 +42,15 @@ class ServiceOption extends Model
      */
     protected $guarded = ['id', 'created_at', 'updated_at'];
 
-    /**
-     * Cast values to correct type.
-     *
-     * @var array
-     */
-    protected $casts = [
-        'service_id' => 'integer',
-    ];
+     /**
+      * Cast values to correct type.
+      *
+      * @var array
+      */
+     protected $casts = [
+         'service_id' => 'integer',
+         'script_is_privileged' => 'boolean',
+     ];
 
     /**
      * Returns the display startup string for the option and will use the parent

app/Repositories/OptionRepository.php

@@ -154,4 +154,35 @@ public function update($id, array $data)
 
         return $option;
     }
+
+    /**
+     * Updates a service option's scripts in the database.
+     *
+     * @param  int    $id
+     * @param  array  $data
+     * @return \Pterodactyl\Models\ServiceOption
+     *
+     * @throws \Pterodactyl\Exceptions\DisplayValidationException
+     */
+    public function scripts($id, array $data)
+    {
+        $option = ServiceOption::findOrFail($id);
+
+        $data['script_install'] = empty($data['script_install']) ? null : $data['script_install'];
+
+        $validator = Validator::make($data, [
+            'script_install' => 'sometimes|nullable|string',
+            'script_is_privileged' => 'sometimes|required|boolean',
+            'script_entry' => 'sometimes|required|string',
+            'script_container' => 'sometimes|required|string',
+        ]);
+
+        if ($validator->fails()) {
+            throw new DisplayValidationException(json_encode($validator->errors()));
+        }
+
+        $option->fill($data)->save();
+
+        return $option;
+    }
 }