Merge pull request pterodactyl#678 from Pterodactyl/feature/service-export-import

Overhaul service system and add ability to export/import them.

Author: DaneEveritt

.env.example

@@ -32,6 +32,4 @@ QUEUE_HIGH=high
 QUEUE_STANDARD=standard
 QUEUE_LOW=low
 
-SQS_KEY=aws-public
-SQS_SECRET=aws-secret
-SQS_QUEUE_PREFIX=aws-queue-prefix
+SERVICE_AUTHOR=undefined@unknown-author.com

.travis.yml

@@ -15,7 +15,7 @@ before_install:
 before_script:
   - cp .env.travis .env
   - composer install --no-interaction --prefer-dist --no-suggest --verbose
-  - php artisan migrate --seed -v
+  - php artisan migrate -v
 script:
   - vendor/bin/phpunit --coverage-clover coverage.xml
 notifications:

CHANGELOG.md

@@ -12,6 +12,7 @@ This project follows [Semantic Versioning](http://semver.org) guidelines.
 * New CLI command to disabled 2-Factor Authentication on an account if necessary.
 * Ability to delete users and locations via the CLI.
 * You can now require 2FA for all users, admins only, or at will using a simple configuration in the Admin CP.
+* Added ability to export and import service options and their associated settings and environment variables via the Admin CP.
 
 ### Changed
 * Theme colors and login pages updated to give a more unique feel to the project.

app/Console/Commands/Environment/AppSettingsCommand.php

@@ -9,7 +9,6 @@
 
 namespace Pterodactyl\Console\Commands\Environment;
 
-use Ramsey\Uuid\Uuid;
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Console\Kernel;
 use Pterodactyl\Traits\Commands\EnvironmentWriterTrait;
@@ -38,6 +37,7 @@ class AppSettingsCommand extends Command
      * @var string
      */
     protected $signature = 'p:environment:setup
+                            {--author= : The email that services created on this instance should be linked to.}
                             {--url= : The URL that this Panel is running on.}
                             {--timezone= : The timezone to use for Panel times.}
                             {--cache= : The cache driver backend to use.}
@@ -72,9 +72,10 @@ public function __construct(ConfigRepository $config, Kernel $command)
      */
     public function handle()
     {
-        if (is_null($this->config->get('pterodactyl.service.author'))) {
-            $this->variables['SERVICE_AUTHOR'] = Uuid::uuid4()->toString();
-        }
+        $this->output->comment(trans('command/messages.environment.app.author_help'));
+        $this->variables['SERVICE_AUTHOR'] = $this->option('author') ?? $this->ask(
+            trans('command/messages.environment.app.author'), $this->config->get('pterodactyl.service.author', 'undefined@unknown-author.com')
+        );
 
         $this->output->comment(trans('command/messages.environment.app.app_url_help'));
         $this->variables['APP_URL'] = $this->option('url') ?? $this->ask(

app/Console/Commands/Server/RebuildServerCommand.php

@@ -12,12 +12,17 @@
 use Webmozart\Assert\Assert;
 use Illuminate\Console\Command;
 use GuzzleHttp\Exception\RequestException;
-use Pterodactyl\Services\Servers\EnvironmentService;
 use Pterodactyl\Contracts\Repository\ServerRepositoryInterface;
+use Pterodactyl\Services\Servers\ServerConfigurationStructureService;
 use Pterodactyl\Contracts\Repository\Daemon\ServerRepositoryInterface as DaemonServerRepositoryInterface;
 
 class RebuildServerCommand extends Command
 {
+    /**
+     * @var \Pterodactyl\Services\Servers\ServerConfigurationStructureService
+     */
+    protected $configurationStructureService;
+
     /**
      * @var \Pterodactyl\Contracts\Repository\Daemon\ServerRepositoryInterface
      */
@@ -28,11 +33,6 @@ class RebuildServerCommand extends Command
      */
     protected $description = 'Rebuild a single server, all servers on a node, or all servers on the panel.';
 
-    /**
-     * @var \Pterodactyl\Services\Servers\EnvironmentService
-     */
-    protected $environmentService;
-
     /**
      * @var \Pterodactyl\Contracts\Repository\ServerRepositoryInterface
      */
@@ -49,18 +49,18 @@ class RebuildServerCommand extends Command
      * RebuildServerCommand constructor.
      *
      * @param \Pterodactyl\Contracts\Repository\Daemon\ServerRepositoryInterface $daemonRepository
-     * @param \Pterodactyl\Services\Servers\EnvironmentService                   $environmentService
+     * @param \Pterodactyl\Services\Servers\ServerConfigurationStructureService  $configurationStructureService
      * @param \Pterodactyl\Contracts\Repository\ServerRepositoryInterface        $repository
      */
     public function __construct(
         DaemonServerRepositoryInterface $daemonRepository,
-        EnvironmentService $environmentService,
+        ServerConfigurationStructureService $configurationStructureService,
         ServerRepositoryInterface $repository
     ) {
         parent::__construct();
 
+        $this->configurationStructureService = $configurationStructureService;
         $this->daemonRepository = $daemonRepository;
-        $this->environmentService = $environmentService;
         $this->repository = $repository;
     }
 
@@ -74,19 +74,7 @@ public function handle()
 
         $servers->each(function ($server) use ($bar) {
             $bar->clear();
-            $json = [
-                'build' => [
-                    'image' => $server->image,
-                    'env|overwrite' => $this->environmentService->process($server),
-                ],
-                'service' => [
-                    'type' => $server->option->service->folder,
-                    'option' => $server->option->tag,
-                    'pack' => object_get($server, 'pack.uuid'),
-                    'skip_scripts' => $server->skip_scripts,
-                ],
-                'rebuild' => true,
-            ];
+            $json = array_merge($this->configurationStructureService->handle($server), ['rebuild' => true]);
 
             try {
                 $this->daemonRepository->setNode($server->node_id)->setAccessServer($server->uuid)->update($json);

app/Contracts/Repository/Daemon/ServerRepositoryInterface.php

@@ -9,17 +9,20 @@
 
 namespace Pterodactyl\Contracts\Repository\Daemon;
 
+use Psr\Http\Message\ResponseInterface;
+
 interface ServerRepositoryInterface extends BaseRepositoryInterface
 {
     /**
      * Create a new server on the daemon for the panel.
      *
-     * @param int   $id
+     * @param array $structure
      * @param array $overrides
-     * @param bool  $start
      * @return \Psr\Http\Message\ResponseInterface
+     *
+     * @throws \GuzzleHttp\Exception\RequestException
      */
-    public function create($id, array $overrides = [], $start = false);
+    public function create(array $structure, array $overrides = []): ResponseInterface;
 
     /**
      * Update server details on the daemon.

app/Contracts/Repository/EggRepositoryInterface.php

@@ -0,0 +1,61 @@
+<?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\Contracts\Repository;
+
+use Pterodactyl\Models\Egg;
+use Illuminate\Database\Eloquent\Collection;
+
+interface EggRepositoryInterface extends RepositoryInterface
+{
+    /**
+     * Return an egg with the variables relation attached.
+     *
+     * @param int $id
+     * @return \Pterodactyl\Models\Egg
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function getWithVariables(int $id): Egg;
+
+    /**
+     * Return all eggs and their relations to be used in the daemon API.
+     *
+     * @return \Illuminate\Database\Eloquent\Collection
+     */
+    public function getAllWithCopyAttributes(): Collection;
+
+    /**
+     * Return an egg with the scriptFrom and configFrom relations loaded onto the model.
+     *
+     * @param int|string $value
+     * @param string     $column
+     * @return \Pterodactyl\Models\Egg
+     */
+    public function getWithCopyAttributes($value, string $column = 'id'): Egg;
+
+    /**
+     * Return all of the data needed to export a service.
+     *
+     * @param int $id
+     * @return \Pterodactyl\Models\Egg
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function getWithExportAttributes(int $id): Egg;
+
+    /**
+     * Confirm a copy script belongs to the same nest as the item trying to use it.
+     *
+     * @param int $copyFromId
+     * @param int $service
+     * @return bool
+     */
+    public function isCopiableScript(int $copyFromId, int $service): bool;
+}

…ry/OptionVariableRepositoryInterface.php …itory/EggVariableRepositoryInterface.phpapp/Contracts/Repository/OptionVariableRepositoryInterface.php renamed to app/Contracts/Repository/EggVariableRepositoryInterface.php app/Contracts/Repository/OptionVariableRepositoryInterface.php renamed to app/Contracts/Repository/EggVariableRepositoryInterface.php

@@ -9,6 +9,6 @@
 
 namespace Pterodactyl\Contracts\Repository;
 
-interface OptionVariableRepositoryInterface extends RepositoryInterface
+interface EggVariableRepositoryInterface extends RepositoryInterface
 {
 }

app/Contracts/Repository/NestRepositoryInterface.php

@@ -0,0 +1,45 @@
+<?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\Contracts\Repository;
+
+use Pterodactyl\Models\Nest;
+
+interface NestRepositoryInterface extends RepositoryInterface
+{
+    /**
+     * Return a nest or all nests with their associated eggs, variables, and packs.
+     *
+     * @param int $id
+     * @return \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Nest
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function getWithEggs(int $id = null);
+
+    /**
+     * Return a nest or all nests and the count of eggs, packs, and servers for that nest.
+     *
+     * @param int|null $id
+     * @return \Pterodactyl\Models\Nest|\Illuminate\Database\Eloquent\Collection
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function getWithCounts(int $id = null);
+
+    /**
+     * Return a nest along with its associated eggs and the servers relation on those eggs.
+     *
+     * @param int $id
+     * @return \Pterodactyl\Models\Nest
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function getWithEggServers(int $id): Nest;
+}

app/Contracts/Repository/PackRepositoryInterface.php

@@ -14,12 +14,12 @@
 interface PackRepositoryInterface extends RepositoryInterface, SearchableInterface
 {
     /**
-     * Return a paginated listing of packs with their associated option and server count.
+     * Return a paginated listing of packs with their associated egg and server count.
      *
      * @param int $paginate
      * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
      */
-    public function paginateWithOptionAndServerCount($paginate = 50);
+    public function paginateWithEggAndServerCount($paginate = 50);
 
     /**
      * Return a pack with the associated server models attached to it.