Finalize service option import/export

Author: DaneEveritt

app/Contracts/Repository/ServiceOptionRepositoryInterface.php

@@ -33,6 +33,16 @@ public function getWithVariables(int $id): ServiceOption;
      */
     public function getWithCopyAttributes(int $id): ServiceOption;
 
+    /**
+     * Return all of the data needed to export a service.
+     *
+     * @param int $id
+     * @return \Pterodactyl\Models\ServiceOption
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function getWithExportAttributes(int $id): ServiceOption;
+
     /**
      * Confirm a copy script belongs to the same service as the item trying to use it.
      *

app/Contracts/Repository/ServiceRepositoryInterface.php

@@ -10,31 +10,36 @@
 namespace Pterodactyl\Contracts\Repository;
 
 use Pterodactyl\Models\Service;
-use Illuminate\Support\Collection;
 
 interface ServiceRepositoryInterface extends RepositoryInterface
 {
     /**
      * Return a service or all services with their associated options, variables, and packs.
      *
      * @param int $id
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Service
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function getWithOptions(int $id = null): Collection;
+    public function getWithOptions(int $id = null);
 
     /**
      * Return a service or all services and the count of options, packs, and servers for that service.
      *
      * @param int|null $id
-     * @return \Illuminate\Support\Collection
+     * @return \Pterodactyl\Models\Service|\Illuminate\Database\Eloquent\Collection
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function getWithCounts(int $id = null): Collection;
+    public function getWithCounts(int $id = null);
 
     /**
      * Return a service along with its associated options and the servers relation on those options.
      *
      * @param int $id
-     * @return mixed
+     * @return \Pterodactyl\Models\Service
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getWithOptionServers(int $id): Service;
 }

app/Exceptions/Service/ServiceOption/DuplicateOptionTagException.php

@@ -0,0 +1,16 @@
+<?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\Exceptions\Service\ServiceOption;
+
+use Pterodactyl\Exceptions\DisplayException;
+
+class DuplicateOptionTagException extends DisplayException
+{
+}

app/Http/Controllers/Admin/Services/Options/OptionShareController.php

@@ -9,26 +9,38 @@
 
 namespace Pterodactyl\Http\Controllers\Admin\Services\Options;
 
+use Illuminate\Http\RedirectResponse;
 use Pterodactyl\Models\ServiceOption;
 use Pterodactyl\Http\Controllers\Controller;
 use Symfony\Component\HttpFoundation\Response;
-use Pterodactyl\Services\Services\Exporter\XMLExporterService;
+use Pterodactyl\Http\Requests\Admin\Service\OptionImportFormRequest;
+use Pterodactyl\Services\Services\Sharing\ServiceOptionExporterService;
+use Pterodactyl\Services\Services\Sharing\ServiceOptionImporterService;
 
 class OptionShareController extends Controller
 {
     /**
-     * @var \Pterodactyl\Services\Services\Exporter\XMLExporterService
+     * @var \Pterodactyl\Services\Services\Sharing\ServiceOptionExporterService
      */
     protected $exporterService;
 
+    /**
+     * @var \Pterodactyl\Services\Services\Sharing\ServiceOptionImporterService
+     */
+    protected $importerService;
+
     /**
      * OptionShareController constructor.
      *
-     * @param \Pterodactyl\Services\Services\Exporter\XMLExporterService $exporterService
+     * @param \Pterodactyl\Services\Services\Sharing\ServiceOptionExporterService $exporterService
+     * @param \Pterodactyl\Services\Services\Sharing\ServiceOptionImporterService $importerService
      */
-    public function __construct(XMLExporterService $exporterService)
-    {
+    public function __construct(
+        ServiceOptionExporterService $exporterService,
+        ServiceOptionImporterService $importerService
+    ) {
         $this->exporterService = $exporterService;
+        $this->importerService = $importerService;
     }
 
     /**
@@ -42,8 +54,25 @@ public function export(ServiceOption $option): Response
         return response($this->exporterService->handle($option->id), 200, [
             'Content-Transfer-Encoding' => 'binary',
             'Content-Description' => 'File Transfer',
-            'Content-Disposition' => 'attachment; filename=' . kebab_case($option->name) . '.xml',
-            'Content-Type' => 'application/xml',
+            'Content-Disposition' => 'attachment; filename=' . kebab_case($option->name) . '.json',
+            'Content-Type' => 'application/json',
         ]);
     }
+
+    /**
+     * Import a new service option using an XML file.
+     *
+     * @param \Pterodactyl\Http\Requests\Admin\Service\OptionImportFormRequest $request
+     * @return \Illuminate\Http\RedirectResponse
+     *
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     * @throws \Pterodactyl\Exceptions\Service\Pack\InvalidFileUploadException
+     */
+    public function import(OptionImportFormRequest $request): RedirectResponse
+    {
+        $option = $this->importerService->handle($request->file('import_file'), $request->input('import_to_service'));
+
+        return redirect()->route('admin.services.option.view', ['option' => $option->id]);
+    }
 }

app/Http/Requests/Admin/Service/OptionImportFormRequest.php

@@ -0,0 +1,26 @@
+<?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\Requests\Admin\Service;
+
+use Pterodactyl\Http\Requests\Admin\AdminFormRequest;
+
+class OptionImportFormRequest extends AdminFormRequest
+{
+    /**
+     * @return array
+     */
+    public function rules(): array
+    {
+        return [
+            'import_file' => 'bail|required|file|max:1000|mimetypes:application/json,text/plain',
+            'import_to_service' => 'bail|required|integer|exists:services,id',
+        ];
+    }
+}

app/Models/ServiceOption.php

@@ -65,7 +65,6 @@ class ServiceOption extends Model implements CleansAttributes, ValidableContract
      */
     protected static $applicationRules = [
         'service_id' => 'required',
-        'author' => 'required',
         'name' => 'required',
         'description' => 'required',
         'tag' => 'required',
@@ -83,10 +82,10 @@ class ServiceOption extends Model implements CleansAttributes, ValidableContract
      */
     protected static $dataIntegrityRules = [
         'service_id' => 'bail|numeric|exists:services,id',
-        'author' => 'email',
+        'uuid' => 'string|size:36',
         'name' => 'string|max:255',
         'description' => 'string',
-        'tag' => 'bail|alpha_num|max:60|unique:service_options,tag',
+        'tag' => 'bail|string|max:150',
         'docker_image' => 'string|max:255',
         'startup' => 'nullable|string',
         'config_from' => 'bail|nullable|numeric|exists:service_options,id',

app/Repositories/Eloquent/ServiceOptionRepository.php

@@ -61,6 +61,25 @@ public function getWithCopyAttributes(int $id): ServiceOption
         return $instance;
     }
 
+    /**
+     * Return all of the data needed to export a service.
+     *
+     * @param int $id
+     * @return \Pterodactyl\Models\ServiceOption
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function getWithExportAttributes(int $id): ServiceOption
+    {
+        /** @var \Pterodactyl\Models\ServiceOption $instance */
+        $instance = $this->getBuilder()->with('scriptFrom', 'configFrom', 'variables')->find($id, $this->getColumns());
+        if (! $instance) {
+            throw new RecordNotFoundException;
+        }
+
+        return $instance;
+    }
+
     /**
      * Confirm a copy script belongs to the same service as the item trying to use it.
      *

app/Repositories/Eloquent/ServiceRepository.php

@@ -10,7 +10,6 @@
 namespace Pterodactyl\Repositories\Eloquent;
 
 use Pterodactyl\Models\Service;
-use Illuminate\Support\Collection;
 use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
 use Pterodactyl\Contracts\Repository\ServiceRepositoryInterface;
 
@@ -25,9 +24,14 @@ public function model()
     }
 
     /**
-     * {@inheritdoc}
+     * Return a service or all services with their associated options, variables, and packs.
+     *
+     * @param int $id
+     * @return \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Service
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function getWithOptions(int $id = null): Collection
+    public function getWithOptions(int $id = null)
     {
         $instance = $this->getBuilder()->with('options.packs', 'options.variables');
 
@@ -44,9 +48,14 @@ public function getWithOptions(int $id = null): Collection
     }
 
     /**
-     * {@inheritdoc}
+     * Return a service or all services and the count of options, packs, and servers for that service.
+     *
+     * @param int|null $id
+     * @return \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Service
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function getWithCounts(int $id = null): Collection
+    public function getWithCounts(int $id = null)
     {
         $instance = $this->getBuilder()->withCount(['options', 'packs', 'servers']);
 
@@ -63,7 +72,12 @@ public function getWithCounts(int $id = null): Collection
     }
 
     /**
-     * {@inheritdoc}
+     * Return a service along with its associated options and the servers relation on those options.
+     *
+     * @param int $id
+     * @return \Pterodactyl\Models\Service
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getWithOptionServers(int $id): Service
     {