STEMMechanics/Website
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases 3 Wiki Activity

updated analytics structure

Browse Source
This commit is contained in:
James Collins
2023-05-25 19:35:20 +10:00
parent 6a6b8ed9b2
commit 2178b61602
9 changed files with 279 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
app/Conductors/AnalyticsConductor.php
View File

@@ -2,16 +2,7 @@
namespace App\Conductors;
use App\Models\Media;
use App\Models\User;
use Carbon\Carbon;
use Illuminate\Contracts\Container\BindingResolutionException;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\InvalidCastException;
use Illuminate\Database\Eloquent\MissingAttributeException;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
use LogicException;
class AnalyticsConductor extends Conductor
{
@@ -19,20 +10,14 @@ class AnalyticsConductor extends Conductor
* The Model Class
* @var string
*/
protected $class = \App\Models\Analytics::class;
/**
* The default sorting field
* @var string
*/
protected $sort = 'created_at';
protected $class = \App\Models\AnalyticsSession::class;
/**
* The default includes to include in a request.
*
* @var array
*/
protected $includes = ['duration'];
protected $includes = ['requests.type','requests.path'];
/**

85
app/Conductors/Conductor.php
View File

@@ -6,7 +6,6 @@ use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Str;
class Conductor
@@ -143,6 +142,7 @@ class Conductor
*
* @param Request $request The user request.
* @param array|null $limitFields A list of fields to limit the filter request to.
* @return void
*/
private function filter(Request $request, array|null $limitFields = null): void
{
@@ -156,6 +156,7 @@ class Conductor
}
$filterFields += $this->defaultFilters;
foreach ($filterFields as $field => $value) {
if (
is_array($limitFields) === false ||
@@ -163,7 +164,7 @@ class Conductor
) {
$value = trim($value);
$operator = '';
$join = 'OR';
$join = 'AND';
// Check if value has a operator and remove it if it's a number
if (preg_match('/^(!?=|[<>]=?|<>|!)([^=!<>].*)*$/', $value, $matches) > 0) {
@@ -209,6 +210,8 @@ class Conductor
/**
* Apple the filter array to the collection.
*
* @return void
*/
final public function applyFilters(): void
{
@@ -217,6 +220,40 @@ class Conductor
$result = null;
$join = 'AND';
$relationFilter = [];
$buildWhereFunc = function ($query, $field, $operator, $value, $join) {
if ($join === 'OR') {
if ($operator === '<>') {
$separatorPos = strpos($value, '|');
if ($separatorPos !== false) {
$query->orWhereBetween(
$field,
[substr($value, 0, $separatorPos), substr($value, ($separatorPos + 1))]
);
} else {
$query->orWhere($field, '!=', $value);
}
} else {
$query->orWhere($field, $operator, $value);
}
} else {
if ($operator === '<>') {
$separatorPos = strpos($value, '|');
if ($separatorPos !== false) {
$query->whereBetween(
$field,
[substr($value, 0, $separatorPos), substr($value, ($separatorPos + 1))]
);
} else {
$query->where($field, '!=', $value);
}
} else {
$query->where($field, $operator, $value);
}
}//end if
};
if (gettype($query) === 'array') {
$item = $query;
}
@@ -288,35 +325,17 @@ class Conductor
$operator = '=';
}
if ($join === 'OR') {
if ($operator === '<>') {
$separatorPos = strpos($value, '|');
if ($separatorPos !== false) {
$query->orWhereBetween(
$field,
[substr($value, 0, $separatorPos), substr($value, ($separatorPos + 1))]
);
} else {
$query->orWhere($field, '!=', $value);
}
} else {
$query->orWhere($field, $operator, $value);
$relationSplit = strpos($field, '.');
if ($relationSplit !== false) {
$relation = substr($field, 0, $relationSplit);
$field = substr($field, ($relationSplit + 1));
if (method_exists($this->class, $relation) === true) {
$relationFilter[$relation][] = [$field, $operator, $value, $join];
}
} else {
if ($operator === '<>') {
$separatorPos = strpos($value, '|');
if ($separatorPos !== false) {
$query->whereBetween(
$field,
[substr($value, 0, $separatorPos), substr($value, ($separatorPos + 1))]
);
} else {
$query->where($field, '!=', $value);
}
} else {
$query->where($field, $operator, $value);
}
}//end if
$buildWhereFunc($query, $field, $operator, $value, $join);
}
}//end if
}//end if
@@ -338,6 +357,14 @@ class Conductor
}//end if
}//end foreach
foreach ($relationFilter as $relation => $conditions) {
$query->whereHas($relation, function ($subQuery) use ($buildWhereFunc, $conditions) {
foreach ($conditions as $condition) {
$buildWhereFunc($subQuery, $condition[0], $condition[1], $condition[2], $condition[3]);
}
});
}
return $result;
};

93
app/Http/Controllers/Api/AnalyticsController.php
View File

@@ -6,13 +6,8 @@ use App\Conductors\AnalyticsConductor;
use App\Conductors\Conductor;
use App\Enum\HttpResponseCodes;
use App\Http\Requests\AnalyticsRequest;
use App\Models\Media;
use App\Models\Analytics;
use Illuminate\Http\JsonResponse;
use Carbon\Exceptions\InvalidFormatException;
use Illuminate\Contracts\Container\BindingResolutionException;
use Illuminate\Database\Eloquent\InvalidCastException;
use Illuminate\Database\Eloquent\MassAssignmentException;
use App\Models\AnalyticsSession;
use Illuminate\Http\Request;
class AnalyticsController extends ApiController
@@ -39,27 +34,17 @@ class AnalyticsController extends ApiController
public function index(Request $request)
{
if ($request->user() !== null && $request->user()?->hasPermission('admin/analytics') === true) {
$searchFields = ['attribute', 'type', 'useragent', 'ip'];
$request->rename([
'type' => 'requests.type',
'path' => 'requests.path'
]);
$queryRequest = new Request();
$queryRequest->merge($request->only($searchFields));
foreach ($searchFields as $field) {
unset($request[$field]);
}
$query = Analytics::query()
->selectRaw('session,
MIN(created_at) as created_at,
TIMESTAMPDIFF(MINUTE, MIN(created_at), MAX(created_at)) as duration');
$query = Conductor::filterQuery($query, $queryRequest);
list($collection, $total) = AnalyticsConductor::collection($request, $query
->groupBy('session')
->get());
list($collection, $total) = AnalyticsConductor::request($request);
return $this->respondAsResource(
$collection,
['isCollection' => true,
['resourceName' => 'session',
'isCollection' => true,
'appendData' => ['total' => $total]
]
);
@@ -71,22 +56,25 @@ class AnalyticsController extends ApiController
/**
* Display the specified resource.
*
* @param \Illuminate\Http\Request $request The endpoint request.
* @param \App\Models\Analytics $analytics The analyics model.
* @param \Illuminate\Http\Request $request The endpoint request.
* @param \App\Models\AnalyticsSession $session The analytics session.
* @return \Illuminate\Http\Response
*/
public function show(Request $request, int $session)
public function show(Request $request, AnalyticsSession $session)
{
if ($request->user() !== null && $request->user()?->hasPermission('admin/analytics') === true) {
list($collection, $total) = AnalyticsConductor::collection($request, Analytics::query()
->where('session', $session)
->get());
$session->load(['requests' => function ($query) {
$query->select('session_id', 'type', 'path', 'created_at');
}
]);
foreach ($session->requests as $requestItem) {
$requestItem->makeHidden('session_id');
}
return $this->respondAsResource(
$collection,
['isCollection' => true,
'appendData' => ['total' => $total]
]
$session,
['resourceName' => 'session']
);
}
@@ -113,10 +101,10 @@ class AnalyticsController extends ApiController
];
if ($user !== null && $user->hasPermission('admin/analytics') === true && $request->has('session') === true) {
$data['session'] = $request->input('session');
$analytics = Analytics::create($data);
$data['session_id'] = $request->input('session_id');
$analytics = AnalyticsRequest::create($data);
} else {
$analytics = Analytics::createWithSession($data);
$analytics = AnalyticsRequest::create($data);
}
return $this->respondAsResource(
@@ -127,37 +115,4 @@ class AnalyticsController extends ApiController
return $this->respondForbidden();
}//end if
}
/**
* Update the specified resource in storage.
*
* @param \App\Http\Requests\AnalyticsRequest $request The analytics update request.
* @param \App\Models\Analytics $analytics The specified analytics.
* @return \Illuminate\Http\Response
*/
public function update(AnalyticsRequest $request, Analytics $analytics)
{
if (AnalyticsConductor::updatable($analytics) === true) {
$analytics->update($request->all());
return $this->respondAsResource(AnalyticsConductor::model($request, $analytics));
}
return $this->respondForbidden();
}
/**
* Remove the specified resource from storage.
*
* @param \App\Models\Analytics $analytics The specified analytics.
* @return \Illuminate\Http\Response
*/
public function destroy(Analytics $analytics)
{
if (AnalyticsConductor::destroyable($analytics) === true) {
$analytics->delete();
return $this->respondNoContent();
} else {
return $this->respondForbidden();
}
}
}

10
app/Http/Middleware/LogRequest.php
View File

@@ -2,17 +2,19 @@
namespace App\Http\Middleware;
use App\Http\Requests\AnalyticsRequest;
use Symfony\Component\HttpFoundation\Response;
use Closure;
use Illuminate\Http\Request;
use App\Models\Analytics;
class LogRequest
{
/**
* Handle an incoming request.
*
* @param \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse) $next
* @param Illuminate\Http\Request $request HTTP Request.
* @param \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse) $next Closure.
* @return Symfony\Component\HttpFoundation\Response
*/
public function handle(Request $request, Closure $next): Response
{
@@ -20,11 +22,9 @@ class LogRequest
$response = $next($request);
try {
Analytics::createWithSession([
AnalyticsRequest::create([
'type' => 'apirequest',
'attribute' => $request->path(),
'useragent' => $request->userAgent(),
'ip' => $request->ip(),
]);
return $response;

44
app/Models/Analytics.php
View File

@@ -1,44 +0,0 @@
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
class Analytics extends Model
{
use HasFactory;
/**
* The attributes that aren't mass assignable.
*
* @var array
*/
protected $guarded = [];
/**
* Create a new row in the analytics table with the given attributes,
* automatically assigning a session value based on previous rows.
*
* @param array $attributes Model attributes.
*/
public static function createWithSession(array $attributes): static
{
$previousRow = self::where('useragent', $attributes['useragent'])
->where('ip', $attributes['ip'])
->where('created_at', '>=', now()->subMinutes(30))
->whereNotNull('session')
->orderBy('created_at', 'desc')
->first();
if ($previousRow !== null) {
$attributes['session'] = $previousRow->session;
} else {
$lastSession = self::max('session');
$attributes['session'] = ($lastSession + 1);
}
return static::create($attributes);
}
}

54
app/Models/AnalyticsRequest.php Normal file
View File

@@ -0,0 +1,54 @@
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class AnalyticsRequest extends Model
{
use HasFactory;
/**
* Model Boot.
*
* @return void
*/
protected static function boot()
{
parent::boot();
static::creating(function (AnalyticsRequest $analytics) {
if (isset($analytics->session_id) !== true) {
$request = request();
if ($request !== null) {
$session = AnalyticsSession::where('ip', $request->ip())
->where('useragent', $request->userAgent())
->where('ended_at', '>=', now()->subMinutes(30))
->first();
if ($session === null) {
$session = AnalyticsSession::create([
'ip' => $request->ip(),
'useragent' => $request->userAgent(),
'ended_at' => now()
]);
}
$analytics->session_id = $session->id;
}
}
});
}
/**
* Return the Analytics Session model.
*
* @return BelongsTo
*/
public function session(): BelongsTo
{
return $this->belongsTo(AnalyticsSession::class, 'id', 'session_id');
}
}

22
app/Models/AnalyticsSession.php Normal file
View File

@@ -0,0 +1,22 @@
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
class AnalyticsSession extends Model
{
use HasFactory;
/**
* Returns the related requests for this session.
*
* @return Illuminate\Database\Eloquent\Relations\HasMany
*/
public function requests(): HasMany {
return $this->hasMany(AnalyticsRequest::class, 'session_id', 'id');
}
}