165 lines
4.0 KiB
PHP
165 lines
4.0 KiB
PHP
<?php
|
|
|
|
namespace Pterodactyl\Models;
|
|
|
|
use Cron\CronExpression;
|
|
use Carbon\CarbonImmutable;
|
|
use Illuminate\Container\Container;
|
|
use Pterodactyl\Contracts\Extensions\HashidsInterface;
|
|
|
|
/**
|
|
* @property int $id
|
|
* @property int $server_id
|
|
* @property string $name
|
|
* @property string $cron_day_of_week
|
|
* @property string $cron_month
|
|
* @property string $cron_day_of_month
|
|
* @property string $cron_hour
|
|
* @property string $cron_minute
|
|
* @property bool $is_active
|
|
* @property bool $is_processing
|
|
* @property \Carbon\Carbon|null $last_run_at
|
|
* @property \Carbon\Carbon|null $next_run_at
|
|
* @property \Carbon\Carbon $created_at
|
|
* @property \Carbon\Carbon $updated_at
|
|
* @property string $hashid
|
|
* @property \Pterodactyl\Models\Server $server
|
|
* @property \Pterodactyl\Models\Task[]|\Illuminate\Support\Collection $tasks
|
|
*/
|
|
class Schedule extends Model
|
|
{
|
|
/**
|
|
* The resource name for this model when it is transformed into an
|
|
* API representation using fractal.
|
|
*/
|
|
public const RESOURCE_NAME = 'server_schedule';
|
|
|
|
/**
|
|
* The table associated with the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $table = 'schedules';
|
|
|
|
/**
|
|
* Always return the tasks associated with this schedule.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $with = ['tasks'];
|
|
|
|
/**
|
|
* Mass assignable attributes on this model.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $fillable = [
|
|
'server_id',
|
|
'name',
|
|
'cron_day_of_week',
|
|
'cron_month',
|
|
'cron_day_of_month',
|
|
'cron_hour',
|
|
'cron_minute',
|
|
'is_active',
|
|
'is_processing',
|
|
'last_run_at',
|
|
'next_run_at',
|
|
];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $casts = [
|
|
'id' => 'integer',
|
|
'server_id' => 'integer',
|
|
'is_active' => 'boolean',
|
|
'is_processing' => 'boolean',
|
|
];
|
|
|
|
/**
|
|
* Columns to mutate to a date.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $dates = [
|
|
'last_run_at',
|
|
'next_run_at',
|
|
];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $attributes = [
|
|
'name' => null,
|
|
'cron_day_of_week' => '*',
|
|
'cron_month' => '*',
|
|
'cron_day_of_month' => '*',
|
|
'cron_hour' => '*',
|
|
'cron_minute' => '*',
|
|
'is_active' => true,
|
|
'is_processing' => false,
|
|
];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
public static $validationRules = [
|
|
'server_id' => 'required|exists:servers,id',
|
|
'name' => 'required|string|max:191',
|
|
'cron_day_of_week' => 'required|string',
|
|
'cron_month' => 'required|string',
|
|
'cron_day_of_month' => 'required|string',
|
|
'cron_hour' => 'required|string',
|
|
'cron_minute' => 'required|string',
|
|
'is_active' => 'boolean',
|
|
'is_processing' => 'boolean',
|
|
'last_run_at' => 'nullable|date',
|
|
'next_run_at' => 'nullable|date',
|
|
];
|
|
|
|
/**
|
|
* Returns the schedule's execution crontab entry as a string.
|
|
*
|
|
* @return \Carbon\CarbonImmutable
|
|
*/
|
|
public function getNextRunDate()
|
|
{
|
|
$formatted = sprintf('%s %s %s %s %s', $this->cron_minute, $this->cron_hour, $this->cron_day_of_month, $this->cron_month, $this->cron_day_of_week);
|
|
|
|
return CarbonImmutable::createFromTimestamp(
|
|
CronExpression::factory($formatted)->getNextRunDate()->getTimestamp()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return a hashid encoded string to represent the ID of the schedule.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getHashidAttribute()
|
|
{
|
|
return Container::getInstance()->make(HashidsInterface::class)->encode($this->id);
|
|
}
|
|
|
|
/**
|
|
* Return tasks belonging to a schedule.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function tasks()
|
|
{
|
|
return $this->hasMany(Task::class);
|
|
}
|
|
|
|
/**
|
|
* Return the server model that a schedule belongs to.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function server()
|
|
{
|
|
return $this->belongsTo(Server::class);
|
|
}
|
|
}
|