RouteStatistic.php

<?php

namespace Bilfeldt\LaravelRouteStatistics\Models;

use Bilfeldt\LaravelRouteStatistics\Jobs\CreateLog;
use Bilfeldt\RequestLogger\Contracts\RequestLoggerInterface;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Date;

class RouteStatistic extends Model implements RequestLoggerInterface
{
    use HasFactory;

    protected $guarded = [
        'id',
    ];

    public $timestamps = false;

    protected $casts = [
        'date' => 'datetime',
    ];

    //======================================================================
    // ACCESSORS
    //======================================================================

    //======================================================================
    // MUTATORS
    //======================================================================

    //======================================================================
    // SCOPES
    //======================================================================

    public function scopeWhereApi(Builder $query): Builder
    {
        return $query->where('route', 'LIKE', 'api.%');
    }

    public function scopeWhereWeb(Builder $query): Builder
    {
        return $query->where('route', 'NOT LIKE', 'api.%');
    }

    //======================================================================
    // RELATIONS
    //======================================================================

    public function user(): BelongsTo
    {
        return $this->belongsTo(config('route-statistics.user_model') ?? config('auth.providers.users.model'));
    }

    public function team(): BelongsTo
    {
        return $this->belongsTo('App\\Models\\Team');
    }

    //======================================================================
    // METHODS
    //======================================================================

    public function log(Request $request, $response, ?int $time = null, ?int $memory = null): void
    {
        if ($route = $request->route()?->getName() ?? $request->route()?->uri()) {
            $attributes = $this->getLogAttributes($request, $response, $time, $memory);

            if (config('route-statistics.queued')) {
                CreateLog::dispatch($attributes);
            } else {
                static::firstOrCreate($attributes, ['counter' => 0])->increment('counter', 1);
            }
        }
    }

    public function getLogAttributes(Request $request, $response, ?int $time = null, ?int $memory = null): array
    {
        return [
            'user_id' => $request->user()?->getKey(),
            'team_id' => $this->getRequestTeam($request)?->getKey(),
            'method' => $request->getMethod(),
            'route' => $request->route()?->getName() ?? $request->route()?->uri(),
            'parameters' => config('route-statistics.store_parameters') ? json_encode($request->route()->originalParameters()) : null,
            'status' => $response->getStatusCode(),
            'ip' => $request->ip(),
            'date' => $this->getDate(),
        ];
    }

    protected function getRequestTeam(Request $request): ?Model
    {
        if ($request->route('team') instanceof Model) {
            return $request->route('team');
        }

        if ($user = $request->user()) {
            return method_exists($user, 'currentTeam') ? $user->currentTeam : null;
        }

        return null;
    }

    protected function getDate()
    {
        $date = Date::now();
        $aggregate = config('route-statistics.aggregate');

        if ($aggregate && ! in_array($aggregate, ['YEAR', 'MONTH', 'DAY', 'HOUR', 'MINUTE', 'SECOND'])) {
            throw new \OutOfBoundsException('Invalid date aggregation');
        }

        if (in_array($aggregate, ['YEAR', 'MONTH', 'DAY', 'HOUR', 'MINUTE', 'SECOND'])) {
            $date->setMicrosecond(0);
        }

        if (in_array($aggregate, ['YEAR', 'MONTH', 'DAY', 'HOUR', 'MINUTE'])) {
            $date->setSecond(0);
        }

        if (in_array($aggregate, ['YEAR', 'MONTH', 'DAY', 'HOUR'])) {
            $date->setMinute(0);
        }

        if (in_array($aggregate, ['YEAR', 'MONTH', 'DAY'])) {
            $date->setHour(0);
        }

        if (in_array($aggregate, ['YEAR', 'MONTH'])) {
            $date->setDay(1);
        }

        if (in_array($aggregate, ['YEAR'])) {
            $date->setMonth(1);
        }

        return $date;
    }

    protected static function newFactory()
    {
        return \Bilfeldt\LaravelRouteStatistics\Database\Factories\RouteStatisticFactory::new();
    }
}