Refactor startup modification and environment variable services

Better setup, more flexibility, more tests.

Author: DaneEveritt

app/Contracts/Repository/ServerRepositoryInterface.php

@@ -69,12 +69,11 @@ public function getPrimaryAllocation($server, bool $refresh = false): Server;
     /**
      * Return enough data to be used for the creation of a server via the daemon.
      *
-     * @param int $id
-     * @return \Illuminate\Database\Eloquent\Collection|\Illuminate\Database\Eloquent\Model
-     *
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     * @param \Pterodactyl\Models\Server $server
+     * @param bool                       $refresh
+     * @return \Pterodactyl\Models\Server
      */
-    public function getDataForCreation($id);
+    public function getDataForCreation(Server $server, bool $refresh = false): Server;
 
     /**
      * Return a server as well as associated databases and their hosts.

app/Http/Controllers/Admin/ServersController.php

@@ -11,6 +11,7 @@
 
 use Javascript;
 use Illuminate\Http\Request;
+use Pterodactyl\Models\User;
 use Pterodactyl\Models\Server;
 use Prologue\Alerts\AlertsMessageBag;
 use Pterodactyl\Exceptions\DisplayException;
@@ -570,10 +571,8 @@ public function delete(Request $request, Server $server)
      */
     public function saveStartup(Request $request, Server $server)
     {
-        $this->startupModificationService->isAdmin()->handle(
-            $server,
-            $request->except('_token')
-        );
+        $this->startupModificationService->setUserLevel(User::USER_LEVEL_ADMIN);
+        $this->startupModificationService->handle($server, $request->except('_token'));
         $this->alert->success(trans('admin/server.alerts.startup_changed'))->flash();
 
         return redirect()->route('admin.servers.view.startup', $server->id);

app/Http/Controllers/Server/Settings/StartupController.php

@@ -3,6 +3,7 @@
 namespace Pterodactyl\Http\Controllers\Server\Settings;
 
 use Illuminate\Http\Request;
+use Pterodactyl\Models\User;
 use Illuminate\Http\RedirectResponse;
 use Prologue\Alerts\AlertsMessageBag;
 use Pterodactyl\Http\Controllers\Controller;
@@ -84,6 +85,7 @@ public function index(Request $request)
      */
     public function update(UpdateStartupParametersFormRequest $request): RedirectResponse
     {
+        $this->modificationService->setUserLevel(User::USER_LEVEL_USER);
         $this->modificationService->handle($request->attributes->get('server'), $request->normalize());
         $this->alert->success(trans('server.config.startup.edited'))->flash();
 

app/Models/Node.php

@@ -20,6 +20,8 @@ class Node extends Model implements CleansAttributes, ValidableContract
 {
     use Eloquence, Notifiable, Validable;
 
+    const DAEMON_SECRET_LENGTH = 36;
+
     /**
      * The table associated with the model.
      *

app/Models/User.php

@@ -32,6 +32,9 @@ class User extends Model implements
 {
     use Authenticatable, Authorizable, CanResetPassword, Eloquence, Notifiable, Validable;
 
+    const USER_LEVEL_USER = 0;
+    const USER_LEVEL_ADMIN = 1;
+
     /**
      * Level of servers to display when using access() on a user.
      *

app/Repositories/Eloquent/ServerRepository.php

@@ -137,16 +137,21 @@ public function getVariablesWithValues($id, $returnWithObject = false)
     }
 
     /**
-     * {@inheritdoc}
+     * Return enough data to be used for the creation of a server via the daemon.
+     *
+     * @param \Pterodactyl\Models\Server $server
+     * @param bool                       $refresh
+     * @return \Pterodactyl\Models\Server
      */
-    public function getDataForCreation($id)
+    public function getDataForCreation(Server $server, bool $refresh = false): Server
     {
-        $instance = $this->getBuilder()->with(['allocation', 'allocations', 'pack', 'egg'])->find($id, $this->getColumns());
-        if (! $instance) {
-            throw new RecordNotFoundException();
+        foreach (['allocation', 'allocations', 'pack', 'egg'] as $relation) {
+            if (! $server->relationLoaded($relation) || $refresh) {
+                $server->load($relation);
+            }
         }
 
-        return $instance;
+        return $server;
     }
 
     /**

app/Services/Servers/EnvironmentService.php

@@ -1,42 +1,37 @@
 <?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\Services\Servers;
 
 use Pterodactyl\Models\Server;
+use Illuminate\Contracts\Config\Repository as ConfigRepository;
 use Pterodactyl\Contracts\Repository\ServerRepositoryInterface;
 
 class EnvironmentService
 {
-    const ENVIRONMENT_CASTS = [
-        'STARTUP' => 'startup',
-        'P_SERVER_LOCATION' => 'location.short',
-        'P_SERVER_UUID' => 'uuid',
-    ];
-
     /**
      * @var array
      */
-    protected $additional = [];
+    private $additional = [];
+
+    /**
+     * @var \Illuminate\Contracts\Config\Repository
+     */
+    private $config;
 
     /**
      * @var \Pterodactyl\Contracts\Repository\ServerRepositoryInterface
      */
-    protected $repository;
+    private $repository;
 
     /**
      * EnvironmentService constructor.
      *
+     * @param \Illuminate\Contracts\Config\Repository                     $config
      * @param \Pterodactyl\Contracts\Repository\ServerRepositoryInterface $repository
      */
-    public function __construct(ServerRepositoryInterface $repository)
+    public function __construct(ConfigRepository $config, ServerRepositoryInterface $repository)
     {
+        $this->config = $config;
         $this->repository = $repository;
     }
 
@@ -46,42 +41,70 @@ public function __construct(ServerRepositoryInterface $repository)
      *
      * @param string   $key
      * @param callable $closure
-     * @return $this
      */
-    public function setEnvironmentKey($key, callable $closure)
+    public function setEnvironmentKey(string $key, callable $closure)
     {
-        $this->additional[] = [$key, $closure];
+        $this->additional[$key] = $closure;
+    }
 
-        return $this;
+    /**
+     * Return the dynamically added additional keys.
+     *
+     * @return array
+     */
+    public function getEnvironmentKeys(): array
+    {
+        return $this->additional;
     }
 
     /**
      * Take all of the environment variables configured for this server and return
      * them in an easy to process format.
      *
-     * @param int|\Pterodactyl\Models\Server $server
+     * @param \Pterodactyl\Models\Server $server
      * @return array
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function process($server)
+    public function handle(Server $server): array
     {
-        if (! $server instanceof Server) {
-            $server = $this->repository->find($server);
-        }
-
         $variables = $this->repository->getVariablesWithValues($server->id);
 
-        // Process static environment variables defined in this file.
-        foreach (self::ENVIRONMENT_CASTS as $key => $object) {
+        // Process environment variables defined in this file. This is done first
+        // in order to allow run-time and config defined variables to take
+        // priority over built-in values.
+        foreach ($this->getEnvironmentMappings() as $key => $object) {
             $variables[$key] = object_get($server, $object);
         }
 
+        // Process variables set in the configuration file.
+        foreach ($this->config->get('pterodactyl.environment_mappings', []) as $key => $object) {
+            if (is_callable($object)) {
+                $variables[$key] = call_user_func($object, $server);
+            } else {
+                $variables[$key] = object_get($server, $object);
+            }
+        }
+
         // Process dynamically included environment variables.
-        foreach ($this->additional as $item) {
-            $variables[$item[0]] = call_user_func($item[1], $server);
+        foreach ($this->additional as $key => $closure) {
+            $variables[$key] = call_user_func($closure, $server);
         }
 
         return $variables;
     }
+
+    /**
+     * Return a mapping of Panel default environment variables.
+     *
+     * @return array
+     */
+    final private function getEnvironmentMappings(): array
+    {
+        return [
+            'STARTUP' => 'startup',
+            'P_SERVER_LOCATION' => 'location.short',
+            'P_SERVER_UUID' => 'uuid',
+        ];
+    }
 }

app/Services/Servers/ServerConfigurationStructureService.php

@@ -19,12 +19,12 @@ class ServerConfigurationStructureService
     /**
      * @var \Pterodactyl\Services\Servers\EnvironmentService
      */
-    protected $environment;
+    private $environment;
 
     /**
      * @var \Pterodactyl\Contracts\Repository\ServerRepositoryInterface
      */
-    protected $repository;
+    private $repository;
 
     /**
      * ServerConfigurationStructureService constructor.
@@ -41,19 +41,21 @@ public function __construct(
     }
 
     /**
-     * @param int|\Pterodactyl\Models\Server $server
+     * Return a configuration array for a specific server when passed a server model.
+     *
+     * @param \Pterodactyl\Models\Server $server
      * @return array
+     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function handle($server): array
+    public function handle(Server $server): array
     {
-        if (! $server instanceof Server || array_diff(self::REQUIRED_RELATIONS, $server->getRelations())) {
-            $server = $this->repository->getDataForCreation(is_digit($server) ? $server : $server->id);
+        if (array_diff(self::REQUIRED_RELATIONS, $server->getRelations())) {
+            $server = $this->repository->getDataForCreation($server);
         }
 
         return [
             'uuid' => $server->uuid,
-            'user' => $server->username,
             'build' => [
                 'default' => [
                     'ip' => $server->allocation->ip,
@@ -62,15 +64,14 @@ public function handle($server): array
                 'ports' => $server->allocations->groupBy('ip')->map(function ($item) {
                     return $item->pluck('port');
                 })->toArray(),
-                'env' => $this->environment->process($server),
+                'env' => $this->environment->handle($server),
                 'memory' => (int) $server->memory,
                 'swap' => (int) $server->swap,
                 'io' => (int) $server->io,
                 'cpu' => (int) $server->cpu,
                 'disk' => (int) $server->disk,
                 'image' => $server->image,
             ],
-            'keys' => [],
             'service' => [
                 'egg' => $server->egg->uuid,
                 'pack' => object_get($server, 'pack.uuid'),