More repository/service/refactor changes

This commit is contained in:
Dane Everitt 2017-08-12 15:29:01 -05:00
parent 2c77d5c44d
commit b8d7d99096
No known key found for this signature in database
GPG key ID: EEA66103B3D71F53
44 changed files with 977 additions and 669 deletions

View file

@ -1,241 +0,0 @@
<?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\Repositories;
use DB;
use Validator;
use InvalidArgumentException;
use Pterodactyl\Models\ServiceOption;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Exceptions\DisplayValidationException;
class OptionRepository
{
/**
* Store the requested service option.
*
* @var \Pterodactyl\Models\ServiceOption
*/
protected $model;
/**
* OptionRepository constructor.
*
* @param null|int|\Pterodactyl\Models\ServiceOption $option
*/
public function __construct($option = null)
{
if (is_null($option)) {
return;
}
if ($option instanceof ServiceOption) {
$this->model = $option;
} else {
if (! is_numeric($option)) {
throw new InvalidArgumentException(
sprintf('Variable passed to constructor must be integer or instance of \Pterodactyl\Models\ServiceOption.')
);
}
$this->model = ServiceOption::findOrFail($option);
}
}
/**
* Return the eloquent model for the given repository.
*
* @return null|\Pterodactyl\Models\ServiceOption
*/
public function getModel()
{
return $this->model;
}
/**
* Update the currently assigned model by re-initalizing the class.
*
* @param null|int|\Pterodactyl\Models\ServiceOption $option
* @return $this
*/
public function setModel($option)
{
self::__construct($option);
return $this;
}
/**
* Creates a new service option on the system.
*
* @param array $data
* @return \Pterodactyl\Models\ServiceOption
*
* @throws \Pterodactyl\Exceptions\DisplayException
* @throws \Pterodactyl\Exceptions\DisplayValidationException
*/
public function create(array $data)
{
$validator = Validator::make($data, [
'service_id' => 'required|numeric|exists:services,id',
'name' => 'required|string|max:255',
'description' => 'required|string',
'tag' => 'required|alpha_num|max:60|unique:service_options,tag',
'docker_image' => 'sometimes|string|max:255',
'startup' => 'sometimes|nullable|string',
'config_from' => 'sometimes|required|numeric|exists:service_options,id',
'config_startup' => 'required_without:config_from|json',
'config_stop' => 'required_without:config_from|string|max:255',
'config_logs' => 'required_without:config_from|json',
'config_files' => 'required_without:config_from|json',
]);
if ($validator->fails()) {
throw new DisplayValidationException(json_encode($validator->errors()));
}
if (isset($data['config_from'])) {
if (! ServiceOption::where('service_id', $data['service_id'])->where('id', $data['config_from'])->first()) {
throw new DisplayException('The `configuration from` directive must be a child of the assigned service.');
}
}
return $this->setModel(ServiceOption::create($data))->getModel();
}
/**
* Deletes a service option from the system.
*
* @param int $id
* @return void
*
* @throws \Exception
* @throws \Pterodactyl\Exceptions\DisplayException
* @throws \Throwable
*/
public function delete($id)
{
$this->model->load('variables', 'servers');
if ($this->model->servers->count() > 0) {
throw new DisplayException('You cannot delete a service option that has servers associated with it.');
}
DB::transaction(function () use ($option) {
foreach ($option->variables as $variable) {
(new VariableRepository)->delete($variable->id);
}
$option->delete();
});
}
/**
* Updates a service option in the database which can then be used
* on nodes.
*
* @param int $id
* @param array $data
* @return \Pterodactyl\Models\ServiceOption
*
* @throws \Pterodactyl\Exceptions\DisplayException
* @throws \Pterodactyl\Exceptions\DisplayValidationException
*/
public function update($id, array $data)
{
$option = ServiceOption::findOrFail($id);
// Due to code limitations (at least when I am writing this currently)
// we have to make an assumption that if config_from is not passed
// that we should be telling it that no config is wanted anymore.
//
// This really is only an issue if we open API access to this function,
// in which case users will always need to pass `config_from` in order
// to keep it assigned.
if (! isset($data['config_from']) && ! is_null($option->config_from)) {
$option->config_from = null;
}
$validator = Validator::make($data, [
'name' => 'sometimes|required|string|max:255',
'description' => 'sometimes|required|string',
'tag' => 'sometimes|required|string|max:255|unique:service_options,tag,' . $option->id,
'docker_image' => 'sometimes|required|string|max:255',
'startup' => 'sometimes|required|string',
'config_from' => 'sometimes|required|numeric|exists:service_options,id',
]);
$validator->sometimes([
'config_startup', 'config_logs', 'config_files',
], 'required_without:config_from|json', function ($input) use ($option) {
return ! (! $input->config_from && ! is_null($option->config_from));
});
$validator->sometimes('config_stop', 'required_without:config_from|string|max:255', function ($input) use ($option) {
return ! (! $input->config_from && ! is_null($option->config_from));
});
if ($validator->fails()) {
throw new DisplayValidationException(json_encode($validator->errors()));
}
if (isset($data['config_from'])) {
if (! ServiceOption::where('service_id', $option->service_id)->where('id', $data['config_from'])->first()) {
throw new DisplayException('The `configuration from` directive must be a child of the assigned service.');
}
}
$option->fill($data)->save();
return $option;
}
/**
* Updates a service option's scripts in the database.
*
* @param array $data
*
* @throws \Pterodactyl\Exceptions\DisplayException
*/
public function scripts(array $data)
{
$data['script_install'] = empty($data['script_install']) ? null : $data['script_install'];
if (isset($data['copy_script_from']) && ! empty($data['copy_script_from'])) {
$select = ServiceOption::whereNull('copy_script_from')
->where('id', $data['copy_script_from'])
->where('service_id', $this->model->service_id)
->first();
if (! $select) {
throw new DisplayException('The service option selected to copy a script from either does not exist, or is copying from a higher level.');
}
} else {
$data['copy_script_from'] = null;
}
$this->model->fill($data)->save();
}
}

View file

@ -1,170 +0,0 @@
<?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\Repositories;
use DB;
use Validator;
use Pterodactyl\Models\ServiceOption;
use Pterodactyl\Models\ServiceVariable;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Exceptions\DisplayValidationException;
class VariableRepository
{
/**
* Create a new service variable.
*
* @param int $option
* @param array $data
* @return \Pterodactyl\Models\ServiceVariable
*
* @throws \Pterodactyl\Exceptions\DisplayException
* @throws \Pterodactyl\Exceptions\DisplayValidationException
*/
public function create($option, array $data)
{
$option = ServiceOption::select('id')->findOrFail($option);
$validator = Validator::make($data, [
'name' => 'required|string|min:1|max:255',
'description' => 'sometimes|nullable|string',
'env_variable' => 'required|regex:/^[\w]{1,255}$/',
'default_value' => 'string',
'options' => 'sometimes|required|array',
'rules' => 'bail|required|string',
]);
// Ensure the default value is allowed by the rules provided.
$validator->sometimes('default_value', $data['rules'] ?? null, function ($input) {
return $input->default_value;
});
if ($validator->fails()) {
throw new DisplayValidationException(json_encode($validator->errors()));
}
if (in_array($data['env_variable'], ServiceVariable::reservedNames())) {
throw new DisplayException('The environment variable name provided is a reserved keyword for the daemon.');
}
$search = ServiceVariable::where('env_variable', $data['env_variable'])->where('option_id', $option->id);
if ($search->first()) {
throw new DisplayException('The envionment variable name assigned to this variable must be unique for this service option.');
}
if (! isset($data['options']) || ! is_array($data['options'])) {
$data['options'] = [];
}
$data['option_id'] = $option->id;
$data['user_viewable'] = (in_array('user_viewable', $data['options']));
$data['user_editable'] = (in_array('user_editable', $data['options']));
// Remove field that isn't used.
unset($data['options']);
return ServiceVariable::create($data);
}
/**
* Deletes a specified option variable as well as all server
* variables currently assigned.
*
* @param int $id
* @return void
*/
public function delete($id)
{
$variable = ServiceVariable::with('serverVariable')->findOrFail($id);
DB::transaction(function () use ($variable) {
foreach ($variable->serverVariable as $v) {
$v->delete();
}
$variable->delete();
});
}
/**
* Updates a given service variable.
*
* @param int $id
* @param array $data
* @return \Pterodactyl\Models\ServiceVariable
*
* @throws \Pterodactyl\Exceptions\DisplayException
* @throws \Pterodactyl\Exceptions\DisplayValidationException
*/
public function update($id, array $data)
{
$variable = ServiceVariable::findOrFail($id);
$validator = Validator::make($data, [
'name' => 'required|string|min:1|max:255',
'description' => 'nullable|string',
'env_variable' => 'required|regex:/^[\w]{1,255}$/',
'rules' => 'bail|required|string',
'options' => 'sometimes|required|array',
]);
// Ensure the default value is allowed by the rules provided.
$rules = (isset($data['rules'])) ? $data['rules'] : $variable->rules;
$validator->sometimes('default_value', $rules, function ($input) {
return $input->default_value;
});
if ($validator->fails()) {
throw new DisplayValidationException(json_encode($validator->errors()));
}
if (isset($data['env_variable'])) {
if (in_array($data['env_variable'], ServiceVariable::reservedNames())) {
throw new DisplayException('The environment variable name provided is a reserved keyword for the daemon.');
}
$search = ServiceVariable::where('env_variable', $data['env_variable'])
->where('option_id', $variable->option_id)
->where('id', '!=', $variable->id);
if ($search->first()) {
throw new DisplayException('The envionment variable name assigned to this variable must be unique for this service option.');
}
}
if (! isset($data['options']) || ! is_array($data['options'])) {
$data['options'] = [];
}
$data['user_viewable'] = (in_array('user_viewable', $data['options']));
$data['user_editable'] = (in_array('user_editable', $data['options']));
// Remove field that isn't used.
unset($data['options']);
$variable->fill($data)->save();
return $variable;
}
}