misc_pterodactyl-panel/app/Models/ActivityLog.php

145 lines
4.4 KiB
PHP
Raw Normal View History

<?php
namespace Pterodactyl\Models;
use Carbon\Carbon;
use Illuminate\Support\Facades\Event;
use Pterodactyl\Events\ActivityLogged;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\MassPrunable;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Database\Eloquent\Model as IlluminateModel;
/**
* \Pterodactyl\Models\ActivityLog.
*
* @property int $id
* @property string|null $batch
* @property string $event
2022-05-29 17:56:39 +00:00
* @property string $ip
* @property string|null $description
* @property string|null $actor_type
* @property int|null $actor_id
* @property int|null $api_key_id
* @property \Illuminate\Support\Collection|null $properties
* @property \Carbon\Carbon $timestamp
2022-05-29 17:56:39 +00:00
* @property IlluminateModel|\Eloquent $actor
* @property \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\ActivityLogSubject[] $subjects
* @property int|null $subjects_count
* @property \Pterodactyl\Models\ApiKey|null $apiKey
*
* @method static Builder|ActivityLog forActor(\Illuminate\Database\Eloquent\Model $actor)
* @method static Builder|ActivityLog forEvent(string $action)
* @method static Builder|ActivityLog newModelQuery()
* @method static Builder|ActivityLog newQuery()
* @method static Builder|ActivityLog query()
* @method static Builder|ActivityLog whereActorId($value)
* @method static Builder|ActivityLog whereActorType($value)
* @method static Builder|ActivityLog whereApiKeyId($value)
* @method static Builder|ActivityLog whereBatch($value)
* @method static Builder|ActivityLog whereDescription($value)
2022-05-29 17:56:39 +00:00
* @method static Builder|ActivityLog whereEvent($value)
* @method static Builder|ActivityLog whereId($value)
* @method static Builder|ActivityLog whereIp($value)
* @method static Builder|ActivityLog whereProperties($value)
* @method static Builder|ActivityLog whereTimestamp($value)
*
* @mixin \Eloquent
*/
class ActivityLog extends Model
{
use MassPrunable;
public const RESOURCE_NAME = 'activity_log';
/**
* Tracks all the events we no longer wish to display to users. These are either legacy
* events or just events where we never ended up using the associated data.
*/
public const DISABLED_EVENTS = ['server:file.upload'];
public $timestamps = false;
protected $guarded = [
'id',
'timestamp',
];
protected $casts = [
'properties' => 'collection',
'timestamp' => 'datetime',
];
protected $with = ['subjects'];
public static array $validationRules = [
'event' => ['required', 'string'],
'batch' => ['nullable', 'uuid'],
2022-05-29 17:56:39 +00:00
'ip' => ['required', 'string'],
'description' => ['nullable', 'string'],
2022-05-29 17:56:39 +00:00
'properties' => ['array'],
];
public function actor(): MorphTo
{
2022-06-05 22:28:08 +00:00
$morph = $this->morphTo();
if (method_exists($morph, 'withTrashed')) {
return $morph->withTrashed();
}
return $morph;
}
public function subjects(): HasMany
{
return $this->hasMany(ActivityLogSubject::class);
}
public function apiKey(): HasOne
{
return $this->hasOne(ApiKey::class, 'id', 'api_key_id');
}
public function scopeForEvent(Builder $builder, string $action): Builder
{
return $builder->where('event', $action);
}
/**
* Scopes a query to only return results where the actor is a given model.
*/
public function scopeForActor(Builder $builder, IlluminateModel $actor): Builder
{
return $builder->whereMorphedTo('actor', $actor);
}
/**
* Returns models to be pruned.
*
* @see https://laravel.com/docs/9.x/eloquent#pruning-models
*/
public function prunable()
{
if (is_null(config('activity.prune_days'))) {
2023-02-23 19:30:16 +00:00
throw new \LogicException('Cannot prune activity logs: no "prune_days" configuration value is set.');
}
return static::where('timestamp', '<=', Carbon::now()->subDays(config('activity.prune_days')));
}
/**
* Boots the model event listeners. This will trigger an activity log event every
* time a new model is inserted which can then be captured and worked with as needed.
*/
protected static function boot()
{
parent::boot();
static::created(function (self $model) {
Event::dispatch(new ActivityLogged($model));
});
}
}