-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathEvent.php
More file actions
333 lines (292 loc) · 8.64 KB
/
Copy pathEvent.php
File metadata and controls
333 lines (292 loc) · 8.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<?php
namespace BNETDocs\Libraries\EventLog;
use \BNETDocs\Libraries\Core\DateTimeImmutable;
use \BNETDocs\Libraries\Db\MariaDb;
use \BNETDocs\Libraries\EventLog\EventTypes;
use \BNETDocs\Libraries\User\User;
use \DateTimeInterface;
use \DateTimeZone;
use \LengthException;
use \OutOfBoundsException;
use \StdClass;
class Event implements \BNETDocs\Interfaces\DatabaseObject, \JsonSerializable
{
public const MAX_ID = 0xFFFFFFFFFFFFFFFF;
public const MAX_IP_ADDRESS = 0xFF;
public const MAX_META_DATA = 0xFFFFFF;
public const MAX_TYPE_ID = 0xFFFFFFFFFFFFFFFF;
public const MAX_USER_ID = 0xFFFFFFFFFFFFFFFF;
private ?DateTimeInterface $datetime = null;
private ?int $id = null;
private ?string $ip_address = null;
private mixed $meta_data = null;
private int $type_id = 0;
private ?int $user_id = null;
public function __construct(StdClass|int|null $value = null)
{
if ($value instanceof StdClass)
{
$this->allocateObject($value);
}
else
{
$this->setId($value);
if (!$this->allocate())
{
throw new \BNETDocs\Exceptions\EventNotFoundException($value);
}
}
}
public function allocate(): bool
{
$this->setDateTime(null);
$this->setIPAddress(null);
$this->setMetaData(null);
$this->setTypeId(EventTypes::LOG_NOTE);
$this->setUserId(null);
$id = $this->getId();
if (\is_null($id)) return true;
try
{
$q = MariaDb::instance()->prepare('
SELECT
`event_datetime` AS `datetime`,
`event_type_id` AS `type_id`,
`id`,
`ip_address`,
`meta_data`,
`user_id`
FROM `event_log` WHERE `id` = ? LIMIT 1;
');
if (!$q || !$q->execute([$id]) || $q->rowCount() != 1) return false;
$this->allocateObject($q->fetchObject());
}
finally
{
if ($q) $q->closeCursor();
}
return true;
}
public static function allocateAll(mixed $filter = null, string $order_column = '', bool $descending = false, ?int $limit = null, ?int $offset = null): ?array
{
try
{
$where_clause = empty($filter) ? '' : \sprintf(
' WHERE `event_type_id` IN (%s)', \implode(',', $filter)
);
$sort = $descending ? 'DESC' : 'ASC';
$order_clause = ' ORDER BY ' . (empty($order_column) ? \sprintf('`id` %s', $sort)
: \sprintf('`%s` %s, `id` %s', $order_column, $sort, $sort));
$limit_clause = ' LIMIT ' . $offset . ',' . $limit;
$q = \sprintf('
SELECT
`event_datetime` AS `datetime`,
`event_type_id` AS `type_id`,
`id`,
`ip_address`,
`meta_data`,
`user_id`
FROM `event_log`%s%s%s;', $where_clause, $order_clause, $limit_clause
);
$q = MariaDb::instance()->prepare($q);
if (!$q || !$q->execute()) return null;
$r = [];
while ($row = $q->fetchObject()) $r[] = new self($row);
return $r;
}
finally
{
if ($q) $q->closeCursor();
}
}
public function allocateObject(StdClass $value): void
{
$this->setDateTime($value->datetime);
$this->setId($value->id);
$this->setIPAddress($value->ip_address);
$this->setMetaData(\json_decode($value->meta_data, true, 512, \JSON_PRESERVE_ZERO_FRACTION | \JSON_THROW_ON_ERROR));
$this->setTypeId($value->type_id);
$this->setUserId($value->user_id);
}
public function commit(): bool
{
try
{
$q = MariaDb::instance()->prepare('
INSERT INTO `event_log` (
`event_datetime`,
`event_type_id`,
`id`,
`ip_address`,
`meta_data`,
`user_id`
) VALUES (
:dt, :tid, :id, :ip, :md, :uid
) ON DUPLICATE KEY UPDATE
`event_datetime` = :dt,
`event_type_id` = :tid,
`id` = :id,
`ip_address` = :ip,
`meta_data` = :md,
`user_id` = :uid;
');
$p = [
':dt' => $this->getDateTime(),
':id' => $this->getId(),
':ip' => $this->getIPAddress(),
':md' => \json_encode($this->getMetaData(), \JSON_PRESERVE_ZERO_FRACTION | \JSON_THROW_ON_ERROR),
':tid' => $this->getTypeId(),
':uid' => $this->getUserId(),
];
foreach ($p as $k => $v)
{
if ($v instanceof DateTimeInterface)
{
$p[$k] = $v->format(self::DATE_SQL);
}
}
if (!$q || !$q->execute($p)) return false;
if (\is_null($p[':id'])) $this->setId(MariaDb::instance()->lastInsertId());
}
finally
{
if ($q) $q->closeCursor();
}
return true;
}
public function deallocate(): bool
{
$id = $this->getId();
if (\is_null($id)) return false;
$q = MariaDb::instance()->prepare('DELETE FROM `event_log` WHERE `id` = ? LIMIT 1;');
try { return $q && $q->execute([$id]); }
finally { if ($q) $q->closeCursor(); }
}
public static function countAll(mixed $filter = null): ?int
{
try
{
$where_clause = empty($filter) ? '' : \sprintf(
' WHERE `event_type_id` IN (%s)', \implode(',', $filter)
);
$q = MariaDb::instance()->prepare(\sprintf(
'SELECT COUNT(*) AS `count` FROM `event_log`%s;', $where_clause
));
if (!$q || !$q->execute() || $q->rowCount() != 1) return null;
return $q->fetchObject()->count;
}
finally
{
if ($q) $q->closeCursor();
}
}
public function getDateTime(): ?DateTimeInterface
{
return $this->datetime;
}
public function getId(): ?int
{
return $this->id;
}
public function getIPAddress(): ?string
{
return $this->ip_address;
}
public function getMetaData(): mixed
{
return $this->meta_data;
}
public function getTypeId(): int
{
return $this->type_id;
}
public function getTypeName(): string
{
$type = new \BNETDocs\Libraries\EventLog\EventType($this->getTypeId());
return (string) $type;
}
public function getURI(): ?string
{
$id = $this->getId();
return \is_null($id) ? null : \BNETDocs\Libraries\Core\UrlFormatter::format(\sprintf('/eventlog/view?id=%d', $id));
}
public function getUser(): ?User
{
try
{
return \is_null($this->user_id) ? null : new User($this->user_id);
}
catch (\BNETDocs\Exceptions\UserNotFoundException)
{
return null;
}
}
public function getUserId(): ?int
{
return $this->user_id;
}
public function jsonSerialize(): mixed
{
return [
'datetime' => $this->getDateTime(),
'id' => $this->getId(),
'ip_address' => $this->getIPAddress(),
'meta_data' => $this->getMetaData(),
'type_id' => $this->getTypeId(),
'user_id' => $this->getUserId(),
];
}
public function setDateTime(DateTimeInterface|string|null $value): void
{
$this->datetime = \is_null($value) ? null : (
\is_string($value) ? new DateTimeImmutable($value, new DateTimeZone(self::DATE_TZ)) : DateTimeImmutable::createFromInterface($value)
);
}
public function setId(?int $value): void
{
if (!\is_null($value) && ($value < 0 || $value > self::MAX_ID))
{
throw new OutOfBoundsException(\sprintf('value must be null or an integer between 0-%d, got: %d', self::MAX_ID, $value));
}
$this->id = $value;
}
public function setIPAddress(?string $value): void
{
if (\is_string($value))
{
$l = \strlen($value);
if ($l < 1 || $l > self::MAX_IP_ADDRESS || !\filter_var($value, \FILTER_VALIDATE_IP))
{
throw new LengthException(\sprintf('value must be null or a formatted IP address string between 1-%d characters, got: %d characters', self::MAX_IP_ADDRESS, $l));
}
}
$this->ip_address = $value;
}
public function setMetaData(mixed $value): void
{
$v = \is_null($value) ? null : \json_encode($value, \JSON_PRESERVE_ZERO_FRACTION | \JSON_THROW_ON_ERROR);
$l = \is_null($v) ? 0 : \strlen($v);
if ($l > self::MAX_META_DATA)
{
throw new LengthException(\sprintf('value must be null or a string between 0-%d characters, got: %d characters', self::MAX_META_DATA, $l));
}
$this->meta_data = $value;
}
public function setTypeId(int $value): void
{
if ($value < 0 || $value > self::MAX_TYPE_ID)
{
throw new OutOfBoundsException(\sprintf('value must be an integer between 0-%d, got: %d', self::MAX_TYPE_ID, $value));
}
$this->type_id = $value;
}
public function setUserId(User|int|null $value): void
{
$v = $value instanceof User ? $value->getId() : $value;
if (!\is_null($v) && ($v < 0 || $v > self::MAX_USER_ID))
{
throw new OutOfBoundsException(\sprintf('value must be null or an integer between 0-%d, got: %d', self::MAX_TYPE_ID, $v));
}
$this->user_id = $v;
}
}