Skip to content

Commit 1eee55b

Browse files
committed
Add endpoint needed for recieving and processing activity
1 parent 9b8479e commit 1eee55b

File tree

3 files changed

+170
-0
lines changed

3 files changed

+170
-0
lines changed
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
<?php
2+
3+
namespace Pterodactyl\Http\Controllers\Api\Remote;
4+
5+
use Exception;
6+
use Carbon\Carbon;
7+
use Pterodactyl\Models\User;
8+
use Webmozart\Assert\Assert;
9+
use Pterodactyl\Models\Server;
10+
use Pterodactyl\Models\ActivityLog;
11+
use Illuminate\Support\Facades\Log;
12+
use Pterodactyl\Models\ActivityLogSubject;
13+
use Pterodactyl\Http\Controllers\Controller;
14+
use Pterodactyl\Http\Requests\Api\Remote\ActivityEventRequest;
15+
16+
class ActivityProcessingController extends Controller
17+
{
18+
public function __invoke(ActivityEventRequest $request)
19+
{
20+
$tz = Carbon::now()->getTimezone();
21+
22+
/** @var \Pterodactyl\Models\Node $node */
23+
$node = $request->attributes->get('node');
24+
25+
$servers = $node->servers()->whereIn('uuid', $request->servers())->get()->keyBy('uuid');
26+
$users = User::query()->whereIn('uuid', $request->users())->get()->keyBy('uuid');
27+
28+
clock()->log($request->input('data'));
29+
30+
$logs = [];
31+
foreach ($request->input('data') as $datum) {
32+
/** @var \Pterodactyl\Models\Server|null $server */
33+
$server = $servers->get($datum['server']);
34+
if (is_null($server) || is_null($event = $this->event($datum['event']))) {
35+
continue;
36+
}
37+
38+
try {
39+
$when = Carbon::createFromFormat(
40+
Carbon::RFC3339,
41+
preg_replace('/(\.\d+)Z$/', 'Z', $datum['timestamp']),
42+
'UTC'
43+
);
44+
} catch (Exception $exception) {
45+
Log::warning($exception, ['timestamp' => $datum['timestamp']]);
46+
47+
// If we cannot parse the value for some reason don't blow up this request, just go ahead
48+
// and log the event with the current time, and set the metadata value to have the original
49+
// timestamp that was provided.
50+
$when = Carbon::now();
51+
$datum['metadata'] = array_merge($datum['metadata'] ?? [], ['original_timestamp' => $datum['timestamp']]);
52+
}
53+
54+
$log = [
55+
'ip' => empty($datum['ip']) ? '127.0.0.1' : $datum['ip'],
56+
'event' => $event,
57+
'properties' => json_encode($datum['metadata'] ?? []),
58+
// We have to change the time to the current timezone due to the way Laravel is handling
59+
// the date casting internally. If we just leave it in UTC it ends up getting double-cast
60+
// and the time is way off.
61+
'timestamp' => $when->setTimezone($tz),
62+
];
63+
64+
if ($user = $users->get($datum['user'])) {
65+
$log['actor_id'] = $user->id;
66+
$log['actor_type'] = $user->getMorphClass();
67+
}
68+
69+
if (!isset($logs[$datum['server']])) {
70+
$logs[$datum['server']] = [];
71+
}
72+
73+
$logs[$datum['server']][] = $log;
74+
}
75+
76+
foreach ($logs as $key => $data) {
77+
Assert::isInstanceOf($server = $servers->get($key), Server::class);
78+
79+
$batch = [];
80+
foreach ($data as $datum) {
81+
$id = ActivityLog::insertGetId($datum);
82+
$batch[] = [
83+
'activity_log_id' => $id,
84+
'subject_id' => $server->id,
85+
'subject_type' => $server->getMorphClass(),
86+
];
87+
}
88+
89+
ActivityLogSubject::insert($batch);
90+
}
91+
}
92+
93+
/**
94+
* Takes an event from Wings and converts it into the expected event type on
95+
* the Panel. If no matching event type can be deduced, null is returned and
96+
* the event won't be logged.
97+
*/
98+
protected function event(string $input): ?string
99+
{
100+
switch ($input) {
101+
case 'console_command':
102+
return 'server:console.command';
103+
case 'power_start':
104+
return 'server:power.start';
105+
case 'power_stop':
106+
return 'server:power.stop';
107+
case 'power_restart':
108+
return 'server:power.restart';
109+
case 'power_kill':
110+
return 'server:power.kill';
111+
default:
112+
return null;
113+
}
114+
}
115+
}
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<?php
2+
3+
namespace Pterodactyl\Http\Requests\Api\Remote;
4+
5+
use Illuminate\Support\Collection;
6+
use Illuminate\Foundation\Http\FormRequest;
7+
8+
class ActivityEventRequest extends FormRequest
9+
{
10+
public function authorize(): bool
11+
{
12+
return true;
13+
}
14+
15+
public function rules(): array
16+
{
17+
return [
18+
'data' => ['required', 'array'],
19+
'data.*' => ['array'],
20+
'data.*.user' => ['present', 'uuid'],
21+
'data.*.server' => ['required', 'uuid'],
22+
'data.*.event' => ['required', 'string'],
23+
'data.*.metadata' => ['present', 'nullable', 'array'],
24+
'data.*.ip' => ['present', 'ip'],
25+
'data.*.timestamp' => ['required', 'string'],
26+
];
27+
}
28+
29+
/**
30+
* Returns all of the unique server UUIDs that were recieved in this request.
31+
*
32+
* @return string[]
33+
*/
34+
public function servers(): array
35+
{
36+
return Collection::make($this->input('data'))->pluck('server')->unique()->toArray();
37+
}
38+
39+
/**
40+
* Returns all of the unique user UUIDs that were submitted in this request.
41+
*
42+
* @return string[]
43+
*/
44+
public function users(): array
45+
{
46+
return Collection::make($this->input('data'))
47+
->filter(function ($value) {
48+
return !empty($value['user']);
49+
})
50+
->pluck('user')
51+
->unique()
52+
->toArray();
53+
}
54+
}

routes/api-remote.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
Route::get('/servers', [Remote\Servers\ServerDetailsController::class, 'list']);
1010
Route::post('/servers/reset', [Remote\Servers\ServerDetailsController::class, 'resetState']);
11+
Route::post('/activity', Remote\ActivityProcessingController::class);
1112

1213
Route::group(['prefix' => '/servers/{uuid}'], function () {
1314
Route::get('/', Remote\Servers\ServerDetailsController::class);

0 commit comments

Comments
 (0)