mirror of
https://github.com/AnimeThemes/animethemes-server.git
synced 2026-07-11 01:24:46 +02:00
Kyrch
437 lines
14 KiB
PHP
437 lines
14 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\Models\Admin;
|
|
|
|
use App\Contracts\Models\HasSubtitle;
|
|
use App\Contracts\Models\Nameable;
|
|
use App\Enums\Actions\ActionLogStatus;
|
|
use App\Models\Auth\User;
|
|
use App\Models\BaseModel;
|
|
use Filament\Facades\Filament;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
|
use Illuminate\Support\Carbon;
|
|
use Illuminate\Support\Facades\Date;
|
|
use Illuminate\Support\Str;
|
|
use Throwable;
|
|
|
|
/**
|
|
* Class ActionLog.
|
|
*
|
|
* @property int $id
|
|
* @property string $batch_id
|
|
* @property string $name
|
|
* @property string $actionable_type
|
|
* @property int $actionable_id
|
|
* @property string $target_type
|
|
* @property int $target_id
|
|
* @property string $model_type
|
|
* @property int $model_id
|
|
* @property string|null $exception
|
|
* @property Carbon|null $finished_at
|
|
* @property ActionLogStatus $status
|
|
* @property morphs $target
|
|
* @property int $user_id
|
|
* @property User $user
|
|
*/
|
|
class ActionLog extends Model implements Nameable, HasSubtitle
|
|
{
|
|
final public const TABLE = 'action_logs';
|
|
|
|
final public const ATTRIBUTE_ID = 'id';
|
|
final public const ATTRIBUTE_BATCH_ID = 'batch_id';
|
|
final public const ATTRIBUTE_NAME = 'name';
|
|
final public const ATTRIBUTE_USER = 'user_id';
|
|
|
|
final public const ATTRIBUTE_ACTIONABLE = 'actionable';
|
|
final public const ATTRIBUTE_ACTIONABLE_TYPE = 'actionable_type';
|
|
final public const ATTRIBUTE_ACTIONABLE_ID = 'actionable_id';
|
|
|
|
final public const ATTRIBUTE_TARGET = 'target';
|
|
final public const ATTRIBUTE_TARGET_TYPE = 'target_type';
|
|
final public const ATTRIBUTE_TARGET_ID = 'target_id';
|
|
|
|
final public const ATTRIBUTE_MODEL_TYPE = 'model_type';
|
|
final public const ATTRIBUTE_MODEL_ID = 'model_id';
|
|
|
|
final public const ATTRIBUTE_STATUS = 'status';
|
|
final public const ATTRIBUTE_EXCEPTION = 'exception';
|
|
final public const ATTRIBUTE_FINISHED_AT = 'finished_at';
|
|
|
|
final public const RELATION_USER = 'user';
|
|
|
|
/**
|
|
* The attributes that are mass assignable.
|
|
*
|
|
* @var array<int, string>
|
|
*/
|
|
protected $fillable = [
|
|
ActionLog::ATTRIBUTE_BATCH_ID,
|
|
ActionLog::ATTRIBUTE_NAME,
|
|
ActionLog::ATTRIBUTE_USER,
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_TYPE,
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_ID,
|
|
ActionLog::ATTRIBUTE_TARGET_TYPE,
|
|
ActionLog::ATTRIBUTE_TARGET_ID,
|
|
ActionLog::ATTRIBUTE_MODEL_TYPE,
|
|
ActionLog::ATTRIBUTE_MODEL_ID,
|
|
ActionLog::ATTRIBUTE_STATUS,
|
|
ActionLog::ATTRIBUTE_EXCEPTION,
|
|
ActionLog::ATTRIBUTE_FINISHED_AT,
|
|
];
|
|
|
|
/**
|
|
* The table associated with the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $table = ActionLog::TABLE;
|
|
|
|
/**
|
|
* The primary key associated with the table.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $primaryKey = ActionLog::ATTRIBUTE_ID;
|
|
|
|
/**
|
|
* Get the attributes that should be cast.
|
|
*
|
|
* @return array<string, string>
|
|
*/
|
|
protected function casts(): array
|
|
{
|
|
return [
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::class,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getName(): string
|
|
{
|
|
return Str::of($this->name)
|
|
->append(' - ')
|
|
->append($this->target()->getName())
|
|
->__toString();
|
|
}
|
|
|
|
/**
|
|
* Get subtitle.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getSubtitle(): string
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* Get the actionable.
|
|
*
|
|
* @return MorphTo
|
|
*/
|
|
public function actionable(): MorphTo
|
|
{
|
|
return $this->morphTo();
|
|
}
|
|
|
|
/**
|
|
* Get the user that initiated the action.
|
|
*
|
|
* @return BelongsTo<User, $this>
|
|
*/
|
|
public function user(): BelongsTo
|
|
{
|
|
return $this->belongsTo(User::class, ActionLog::ATTRIBUTE_USER);
|
|
}
|
|
|
|
/**
|
|
* Get the target of the action for user interface linking.
|
|
*
|
|
* @return MorphTo|BaseModel
|
|
*/
|
|
public function target(): MorphTo|BaseModel
|
|
{
|
|
return $this
|
|
->morphTo(ActionLog::ATTRIBUTE_TARGET, ActionLog::ATTRIBUTE_TARGET_TYPE, ActionLog::ATTRIBUTE_TARGET_ID)
|
|
->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* Get the user id for the action log.
|
|
*
|
|
* @return int
|
|
*/
|
|
public static function getUserId(): int
|
|
{
|
|
return Filament::auth()->id();
|
|
}
|
|
|
|
/**
|
|
* Register an action log for a model created.
|
|
*
|
|
* @param Model $model
|
|
* @return ActionLog
|
|
*/
|
|
public static function modelCreated(Model $model): ActionLog
|
|
{
|
|
return ActionLog::query()->create([
|
|
ActionLog::ATTRIBUTE_BATCH_ID => Str::orderedUuid()->__toString(),
|
|
ActionLog::ATTRIBUTE_USER => ActionLog::getUserId(),
|
|
ActionLog::ATTRIBUTE_NAME => 'Create',
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_TARGET_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_TARGET_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_MODEL_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_MODEL_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::FINISHED->value,
|
|
ActionLog::ATTRIBUTE_FINISHED_AT => Date::now(),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Register an action log for a model updated.
|
|
*
|
|
* @param Model $model
|
|
* @return ActionLog
|
|
*/
|
|
public static function modelUpdated(Model $model): ActionLog
|
|
{
|
|
return ActionLog::query()->create([
|
|
ActionLog::ATTRIBUTE_BATCH_ID => Str::orderedUuid()->__toString(),
|
|
ActionLog::ATTRIBUTE_USER => ActionLog::getUserId(),
|
|
ActionLog::ATTRIBUTE_NAME => 'Update',
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_TARGET_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_TARGET_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_MODEL_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_MODEL_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::FINISHED->value,
|
|
ActionLog::ATTRIBUTE_FINISHED_AT => Date::now(),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Register an action log for a model deleted.
|
|
*
|
|
* @param Model $model
|
|
* @return ActionLog
|
|
*/
|
|
public static function modelDeleted(Model $model): ActionLog
|
|
{
|
|
return ActionLog::modelSoftDeleted('Delete', $model);
|
|
}
|
|
|
|
/**
|
|
* Register an action log for a model restored.
|
|
*
|
|
* @param Model $model
|
|
* @return ActionLog
|
|
*/
|
|
public static function modelRestored(Model $model): ActionLog
|
|
{
|
|
return ActionLog::modelSoftDeleted('Restore', $model);
|
|
}
|
|
|
|
/**
|
|
* Register an action log for a model that is soft-deleted.
|
|
*
|
|
* @param string $actionName
|
|
* @param Model $model
|
|
* @return ActionLog
|
|
*/
|
|
public static function modelSoftDeleted(string $actionName, Model $model): ActionLog
|
|
{
|
|
return ActionLog::query()->create([
|
|
ActionLog::ATTRIBUTE_BATCH_ID => Str::orderedUuid()->__toString(),
|
|
ActionLog::ATTRIBUTE_USER => ActionLog::getUserId(),
|
|
ActionLog::ATTRIBUTE_NAME => $actionName,
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_TARGET_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_TARGET_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_MODEL_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_MODEL_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::FINISHED->value,
|
|
ActionLog::ATTRIBUTE_FINISHED_AT => Date::now(),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Register an action log for a model attached.
|
|
*
|
|
* @param string $action
|
|
* @param Model $related
|
|
* @param Model $parent
|
|
* @param Model $pivot
|
|
* @return ActionLog
|
|
*/
|
|
public static function modelPivot(string $action, Model $related, Model $parent, Model $pivot): ActionLog
|
|
{
|
|
return ActionLog::query()->create([
|
|
ActionLog::ATTRIBUTE_BATCH_ID => Str::orderedUuid()->__toString(),
|
|
ActionLog::ATTRIBUTE_USER => ActionLog::getUserId(),
|
|
ActionLog::ATTRIBUTE_NAME => $action,
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_TYPE => $related->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_ID => $related->getKey(),
|
|
ActionLog::ATTRIBUTE_TARGET_TYPE => $parent->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_TARGET_ID => $parent->getKey(),
|
|
ActionLog::ATTRIBUTE_MODEL_TYPE => $pivot->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_MODEL_ID => $pivot->getKey(),
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::FINISHED->value,
|
|
ActionLog::ATTRIBUTE_FINISHED_AT => Date::now(),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Register an action log for a model associated (HasMany).
|
|
*
|
|
* @param string $action
|
|
* @param Model $related
|
|
* @param Model $parent
|
|
* @return ActionLog
|
|
*/
|
|
public static function modelAssociated(string $action, Model $related, Model $parent): ActionLog
|
|
{
|
|
return ActionLog::query()->create([
|
|
ActionLog::ATTRIBUTE_BATCH_ID => Str::orderedUuid()->__toString(),
|
|
ActionLog::ATTRIBUTE_USER => ActionLog::getUserId(),
|
|
ActionLog::ATTRIBUTE_NAME => $action,
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_TYPE => $related->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_ID => $related->getKey(),
|
|
ActionLog::ATTRIBUTE_TARGET_TYPE => $parent->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_TARGET_ID => $parent->getKey(),
|
|
ActionLog::ATTRIBUTE_MODEL_TYPE => $related->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_MODEL_ID => $related->getKey(),
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::FINISHED->value,
|
|
ActionLog::ATTRIBUTE_FINISHED_AT => Date::now(),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Register an action log for when a model has an action executed.
|
|
*
|
|
* @param string $batchId
|
|
* @param mixed $action
|
|
* @param Model $model
|
|
* @return ActionLog
|
|
*/
|
|
public static function modelActioned(string $batchId, mixed $action, Model $model): ActionLog
|
|
{
|
|
return ActionLog::query()->create([
|
|
ActionLog::ATTRIBUTE_BATCH_ID => $batchId,
|
|
ActionLog::ATTRIBUTE_USER => ActionLog::getUserId(),
|
|
ActionLog::ATTRIBUTE_NAME => $action->getLabel(),
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_ACTIONABLE_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_TARGET_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_TARGET_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_MODEL_TYPE => $model->getMorphClass(),
|
|
ActionLog::ATTRIBUTE_MODEL_ID => $model->getKey(),
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::RUNNING->value,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Update the all the models status of a batch to running.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function batchRunning(): void
|
|
{
|
|
$this->query()->where(ActionLog::ATTRIBUTE_BATCH_ID, $this->batch_id)
|
|
->whereNotIn(ActionLog::ATTRIBUTE_STATUS, [ActionLogStatus::FINISHED->value, ActionLogStatus::FAILED->value])
|
|
->update([
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::RUNNING->value,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Update the all the models status of a batch to finished.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function batchFinished(): void
|
|
{
|
|
$this->query()->where(ActionLog::ATTRIBUTE_BATCH_ID, $this->batch_id)
|
|
->whereNotIn(ActionLog::ATTRIBUTE_STATUS, [ActionLogStatus::FINISHED->value, ActionLogStatus::FAILED->value])
|
|
->update([
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::FINISHED->value,
|
|
ActionLog::ATTRIBUTE_FINISHED_AT => Date::now(),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Update the all the models status of a batch to failed.
|
|
*
|
|
* @param Throwable|string|null $exception
|
|
* @return void
|
|
*/
|
|
public function batchFailed(Throwable|string|null $exception = null): void
|
|
{
|
|
$this->query()->where(ActionLog::ATTRIBUTE_BATCH_ID, $this->batch_id)
|
|
->whereNotIn(ActionLog::ATTRIBUTE_STATUS, [ActionLogStatus::FINISHED->value, ActionLogStatus::FAILED->value])
|
|
->update([
|
|
ActionLog::ATTRIBUTE_STATUS => ActionLogStatus::FAILED->value,
|
|
ActionLog::ATTRIBUTE_EXCEPTION => $exception ? Str::of($exception)->__toString() : null,
|
|
ActionLog::ATTRIBUTE_FINISHED_AT => Date::now(),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Update the model status to finished.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function finished(): void
|
|
{
|
|
$this->updateStatus(ActionLogStatus::FINISHED);
|
|
}
|
|
|
|
/**
|
|
* Update the model status to failed.
|
|
*
|
|
* @param Throwable|string|null $exception
|
|
* @return void
|
|
*/
|
|
public function failed(Throwable|string|null $exception = null): void
|
|
{
|
|
$this->updateStatus(ActionLogStatus::FAILED, $exception);
|
|
}
|
|
|
|
/**
|
|
* Check if the model status is failed.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isFailed(): bool
|
|
{
|
|
return $this->status === ActionLogStatus::FAILED;
|
|
}
|
|
|
|
/**
|
|
* Update the status of a given action event.
|
|
*
|
|
* @param ActionLogStatus $status
|
|
* @param Throwable|string|null $exception
|
|
* @return void
|
|
*/
|
|
public function updateStatus(ActionLogStatus $status, Throwable|string|null $exception = null): void
|
|
{
|
|
$this->update([
|
|
ActionLog::ATTRIBUTE_STATUS => $status->value,
|
|
ActionLog::ATTRIBUTE_EXCEPTION => Str::of($exception)->__toString(),
|
|
ActionLog::ATTRIBUTE_FINISHED_AT => Date::now(),
|
|
]);
|
|
}
|
|
}
|