['required', 'string'],
'batch' => ['nullable', 'uuid'],
'ip' => ['required', 'string'],
'description' => ['nullable', 'string'],
'properties' => ['array'],
];
protected function casts(): array
{
return [
'properties' => 'collection',
'timestamp' => 'datetime',
];
}
public function actor(): MorphTo
{
return $this->morphTo()->withTrashed();
}
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, Model $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(): Builder
{
if (is_null(config('activity.prune_days'))) {
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(): void
{
parent::boot();
static::creating(function (self $model) {
$model->timestamp = Carbon::now();
});
static::created(function (self $model) {
Event::dispatch(new ActivityLogged($model));
});
}
public function getIcon(): string
{
if ($this->apiKey) {
return 'tabler-api';
}
if ($this->actor instanceof User) {
return 'tabler-user';
}
return $this->actor_id === null ? 'tabler-device-desktop' : 'tabler-user-off';
}
public function getLabel(): string
{
$properties = $this->wrapProperties();
return trans_choice('activity.'.str($this->event)->replace(':', '.'), array_key_exists('count', $properties) ? $properties['count'] : 1, $properties);
}
public function htmlable(): string
{
$user = $this->actor;
if (!$user instanceof User) {
$user = new User([
'email' => 'system@pelican.dev',
'username' => 'system',
]);
}
return "
$user->username — $this->event
{$this->getLabel()}
$this->ip — {$this->timestamp->diffForHumans()}
";
}
public function wrapProperties(): array
{
if (!$this->properties || $this->properties->isEmpty()) {
return [];
}
$properties = $this->properties->mapWithKeys(function ($value, $key) {
if (!is_array($value)) {
// Perform some directory normalization at this point.
if ($key === 'directory') {
$value = str_replace('//', '/', '/' . trim($value, '/') . '/');
}
return [$key => $value];
}
$first = array_first($value);
// Backwards compatibility for old logs
if (is_array($first)) {
return ["{$key}_count" => count($value)];
}
return [$key => $first, "{$key}_count" => count($value)];
});
$keys = $properties->keys()->filter(fn ($key) => Str::endsWith($key, '_count'))->values();
if ($keys->containsOneItem()) {
$properties = $properties->merge(['count' => $properties->get($keys[0])])->except([$keys[0]]);
}
return $properties->toArray();
}
/**
* Determines if there are any log properties that we've not already exposed
* in the response language string and that are not just the IP address or
* the browser useragent.
*
* This is used by the front-end to selectively display an "additional metadata"
* button that is pointless if there is nothing the user can't already see from
* the event description.
*/
public function hasAdditionalMetadata(): bool
{
if (!$this->properties || $this->properties->isEmpty()) {
return false;
}
$properties = $this->wrapProperties();
$event = trans_choice('activity.'.str($this->event)->replace(':', '.'), array_key_exists('count', $properties) ? $properties['count'] : 1);
preg_match_all('/:(?[\w.-]+\w)(?:[^\w:]?|$)/', $event, $matches);
$exclude = array_merge($matches['key'], ['ip', 'useragent', 'using_sftp']);
foreach ($this->properties->keys() as $key) {
if (!in_array($key, $exclude, true)) {
return true;
}
}
return false;
}
}