misc_pterodactyl-panel/app/Models/Model.php

188 lines
5.4 KiB
PHP
Raw Normal View History

<?php
namespace Pterodactyl\Models;
2022-10-29 23:58:55 +00:00
use Carbon\CarbonImmutable;
use Illuminate\Support\Arr;
2022-05-14 20:03:50 +00:00
use Illuminate\Support\Str;
use Illuminate\Support\Carbon;
use Illuminate\Validation\Rule;
use Illuminate\Container\Container;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Validation\ValidationException;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Pterodactyl\Exceptions\Model\DataValidationException;
use Illuminate\Database\Eloquent\Model as IlluminateModel;
use Illuminate\Contracts\Validation\Factory as ValidationFactory;
abstract class Model extends IlluminateModel
{
use HasFactory;
/**
* Set to true to return immutable Carbon date instances from the model.
*/
protected bool $immutableDates = false;
/**
* Determines if the model should undergo data validation before it is saved
* to the database.
*/
protected bool $skipValidation = false;
protected static ValidationFactory $validatorFactory;
public static array $validationRules = [];
/**
* Listen for the model saving event and fire off the validation
* function before it is saved.
*
* @throws \Illuminate\Contracts\Container\BindingResolutionException
*/
protected static function boot()
{
parent::boot();
static::$validatorFactory = Container::getInstance()->make(ValidationFactory::class);
static::saving(function (Model $model) {
try {
$model->validate();
} catch (ValidationException $exception) {
throw new DataValidationException($exception->validator, $model);
}
return true;
});
}
/**
* Returns the model key to use for route model binding. By default, we'll
* assume every model uses a UUID field for this. If the model does not have
* a UUID and is using a different key it should be specified on the model
* itself.
*
* You may also optionally override this on a per-route basis by declaring
* the key name in the URL definition, like "{user:id}".
*/
public function getRouteKeyName(): string
{
return 'uuid';
}
/**
* Set the model to skip validation when saving.
*/
public function skipValidation(): self
{
$this->skipValidation = true;
return $this;
}
/**
* Returns the validator instance used by this model.
*/
public function getValidator(): Validator
{
$rules = $this->exists ? static::getRulesForUpdate($this) : static::getRules();
return static::$validatorFactory->make([], $rules, [], []);
}
/**
* Returns the rules associated with this model.
*/
public static function getRules(): array
{
$rules = static::$validationRules;
foreach ($rules as $key => &$rule) {
$rule = is_array($rule) ? $rule : explode('|', $rule);
}
return $rules;
}
/**
* Returns the rules for a specific field. If the field is not found an empty
* array is returned.
*/
public static function getRulesForField(string $field): array
{
return Arr::get(static::getRules(), $field) ?? [];
}
/**
* Returns the rules associated with the model, specifically for updating the given model
* rather than just creating it.
*/
2022-10-24 00:14:50 +00:00
public static function getRulesForUpdate($model, string $column = 'id'): array
{
if ($model instanceof Model) {
[$id, $column] = [$model->getKey(), $model->getKeyName()];
}
$rules = static::getRules();
foreach ($rules as $key => &$data) {
// For each rule in a given field, iterate over it and confirm if the rule
// is one for a unique field. If that is the case, append the ID of the current
// working model, so we don't run into errors due to the way that field validation
// works.
foreach ($data as &$datum) {
2021-01-23 20:33:34 +00:00
if (!is_string($datum) || !Str::startsWith($datum, 'unique')) {
continue;
}
2019-09-23 19:30:51 +00:00
[, $args] = explode(':', $datum);
$args = explode(',', $args);
$datum = Rule::unique($args[0], $args[1] ?? $key)->ignore($id ?? $model, $column);
}
}
return $rules;
}
/**
* Determines if the model is in a valid state or not.
*
* @throws \Illuminate\Validation\ValidationException
*/
public function validate(): void
{
if ($this->skipValidation) {
return;
}
$validator = $this->getValidator();
$validator->setData(
// Trying to do self::toArray() here will leave out keys based on the whitelist/blacklist
// for that model. Doing this will return all the attributes in a format that can
// properly be validated.
2020-03-28 23:06:36 +00:00
$this->addCastAttributesToArray(
2021-01-23 20:33:34 +00:00
$this->getAttributes(),
$this->getMutatedAttributes()
2020-03-28 23:06:36 +00:00
)
);
if (!$validator->passes()) {
throw new ValidationException($validator);
}
}
/**
* Return a timestamp as DateTime object.
*
* @param mixed $value
*/
protected function asDateTime($value): Carbon|CarbonImmutable
{
2021-01-23 20:33:34 +00:00
if (!$this->immutableDates) {
return parent::asDateTime($value);
}
2020-04-04 18:37:10 +00:00
return parent::asDateTime($value)->toImmutable();
}
}