File: logreader.inc

package info (click to toggle)
php8.4 8.4.16-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 211,276 kB
  • sloc: ansic: 1,176,142; php: 35,419; sh: 11,964; cpp: 7,208; pascal: 4,951; javascript: 3,091; asm: 2,817; yacc: 2,411; makefile: 696; xml: 446; python: 301; awk: 148
file content (384 lines) | stat: -rw-r--r-- 9,843 bytes parent folder | download | duplicates (2)
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<?php

namespace FPM;

class LogReader
{
    /**
     * Log debugging.
     *
     * @var bool
     */
    private bool $debug;

    /**
     * Log descriptor.
     *
     * @var string|null
     */
    private ?string $currentSourceName = null;

    /**
     * Log descriptors.
     *
     * @var LogSource[]
     */
    private array $sources = [];

    /**
     * Log reader constructor.
     *
     * @param bool $debug
     */
    public function __construct(bool $debug = false)
    {
        $this->debug = $debug;
    }

    /**
     * Returns log descriptor source.
     *
     * @return LogSource
     * @throws \Exception
     */
    private function getSource(): LogSource
    {
        if ( ! $this->currentSourceName) {
            throw new \Exception('Log descriptor is not set');
        }

        return $this->sources[$this->currentSourceName];
    }

    /**
     * Set current stream source and create it if it does not exist.
     *
     * @param string   $name   Stream name.
     * @param resource $stream The actual stream.
     */
    public function setStreamSource(string $name, $stream)
    {
        $this->currentSourceName = $name;
        if ( ! isset($this->sources[$name])) {
            $this->sources[$name] = new LogStreamSource($stream);
        }
    }

    /**
     * Set file source as current and create it if it does not exist.
     *
     * @param string $name     Source name.
     * @param string $filePath Source file path.s
     */
    public function setFileSource(string $name, string $filePath)
    {
        $this->currentSourceName = $name;
        if ( ! isset($this->sources[$name])) {
            $this->sources[$name] = new LogFileSource($filePath);
        }
    }

    /**
     * Get a single log line.
     *
     * @param int  $timeoutSeconds      Read timeout in seconds
     * @param int  $timeoutMicroseconds Read timeout in microseconds
     * @param bool $throwOnTimeout      Whether to throw an exception on timeout
     *
     * @return null|string
     * @throws \Exception
     */
    public function getLine(
        int $timeoutSeconds = 3,
        int $timeoutMicroseconds = 0,
        bool $throwOnTimeout = false
    ): ?string {
        $line = $this->getSource()->getLine(
            $timeoutSeconds,
            $timeoutMicroseconds,
            $throwOnTimeout
        );
        $this->trace(is_null($line) ? "LINE - null" : "LINE: $line");

        return $line;
    }

    /**
     * Print separation line.
     */
    public function printSeparator(): void
    {
        echo str_repeat('-', 68) . "\n";
    }

    /**
     * Print all logs.
     */
    public function printLogs(): void
    {
        if (empty($this->sources)) {
            return;
        }
        $hasMultipleDescriptors = count($this->sources) > 1;
        echo "\nLOGS:\n";
        foreach ($this->sources as $name => $source) {
            if ($hasMultipleDescriptors) {
                echo ">>> source: $name\n";
            }
            $this->printSeparator();
            foreach ($source->getAllLines() as $line) {
                echo $line;
            }
            $this->printSeparator();
        }
        echo "\n";
    }

    /**
     * Print error and logs.
     *
     * @param string|null $errorMessage Error message to print before the logs.
     *
     * @return false
     */
    public function printError(?string $errorMessage): bool
    {
        if (is_null($errorMessage)) {
            return false;
        }
        echo "ERROR: " . $errorMessage . "\n";
        $this->printLogs();

        return false;
    }

    /**
     * Read log until matcher matches the log message or there are no more logs.
     *
     * @param callable    $matcher             Callback to identify a match
     * @param string|null $notFoundMessage     Error message if matcher does not succeed.
     * @param bool        $checkAllLogs        Whether to also check past logs.
     * @param int|null    $timeoutSeconds      Timeout in seconds for reading of all messages.
     * @param int|null    $timeoutMicroseconds Additional timeout in microseconds for reading of all messages.
     *
     * @return bool
     * @throws \Exception
     */
    public function readUntil(
        callable $matcher,
        ?string $notFoundMessage = null,
        bool $checkAllLogs = false,
        ?int $timeoutSeconds = null,
        ?int $timeoutMicroseconds = null
    ): bool {
        if (is_null($timeoutSeconds) && is_null($timeoutMicroseconds)) {
            $timeoutSeconds      = 3;
            $timeoutMicroseconds = 0;
        } elseif (is_null($timeoutSeconds)) {
            $timeoutSeconds = 0;
        } elseif (is_null($timeoutMicroseconds)) {
            $timeoutMicroseconds = 0;
        }

        $startTime = microtime(true);
        $endTime   = $startTime + $timeoutSeconds + ($timeoutMicroseconds / 1_000_000);
        if ($checkAllLogs) {
            foreach ($this->getSource()->getAllLines() as $line) {
                if ($matcher($line)) {
                    return true;
                }
            }
        }

        do {
            if (microtime(true) > $endTime) {
                return $this->printError($notFoundMessage);
            }
            $line = $this->getLine($timeoutSeconds, $timeoutMicroseconds);
            if ($line === null || microtime(true) > $endTime) {
                return $this->printError($notFoundMessage);
            }
        } while ( ! $matcher($line));

        return true;
    }

    /**
     * Print tracing message - only in debug .
     *
     * @param string $msg Message to print.
     */
    private function trace(string $msg): void
    {
        if ($this->debug) {
            print "LogReader - $msg";
        }
    }
}

class LogTimoutException extends \Exception
{
}

abstract class LogSource
{
    /**
     * Get single line from the source.
     *
     * @param int  $timeoutSeconds      Read timeout in seconds
     * @param int  $timeoutMicroseconds Read timeout in microseconds
     * @param bool $throwOnTimeout      Whether to throw an exception on timeout
     *
     * @return string|null
     * @throws LogTimoutException
     */
    public abstract function getLine(
        int $timeoutSeconds,
        int $timeoutMicroseconds,
        bool $throwOnTimeout = false
    ): ?string;

    /**
     * Get all lines that has been returned by getLine() method.
     *
     * @return string[]
     */
    public abstract function getAllLines(): array;
}

class LogStreamSource extends LogSource
{
    /**
     * @var resource
     */
    private $stream;

    /**
     * @var array
     */
    private array $lines = [];

    public function __construct($stream)
    {
        $this->stream = $stream;
    }

    /**
     * Get single line from the stream.
     *
     * @param int  $timeoutSeconds      Read timeout in seconds
     * @param int  $timeoutMicroseconds Read timeout in microseconds
     * @param bool $throwOnTimeout      Whether to throw an exception on timeout
     *
     * @return string|null
     * @throws LogTimoutException
     */
    public function getLine(
        int $timeoutSeconds,
        int $timeoutMicroseconds,
        bool $throwOnTimeout = false
    ): ?string {
        if (feof($this->stream)) {
            return null;
        }
        $read   = [$this->stream];
        $write  = null;
        $except = null;
        if (stream_select($read, $write, $except, $timeoutSeconds, $timeoutMicroseconds)) {
            $line          = fgets($this->stream);
            $this->lines[] = $line;

            return $line;
        } else {
            if ($throwOnTimeout) {
                throw new LogTimoutException('Timout exceeded when reading line');
            }

            return null;
        }
    }

    /**
     * Get all stream read lines.
     *
     * @return string[]
     */
    public function getAllLines(): array
    {
        return $this->lines;
    }
}

class LogFileSource extends LogSource
{
    /**
     * @var string
     */
    private string $filePath;

    /**
     * @var int
     */
    private int $position;

    /**
     * @var array
     */
    private array $lines = [];

    public function __construct(string $filePath)
    {
        $this->filePath = $filePath;
        $this->position = 0;
    }

    /**
     * Get single line from the file.
     *
     * @param int  $timeoutSeconds      Read timeout in seconds
     * @param int  $timeoutMicroseconds Read timeout in microseconds
     * @param bool $throwOnTimeout      Whether to throw an exception on timeout
     *
     * @return string|null
     * @throws LogTimoutException
     */
    public function getLine(
        int $timeoutSeconds,
        int $timeoutMicroseconds,
        bool $throwOnTimeout = false
    ): ?string {
        $endTime = microtime(true) + $timeoutSeconds + ($timeoutMicroseconds / 1_000_000);
        while ($this->position >= count($this->lines)) {
            if (is_file($this->filePath)) {
                $lines = file($this->filePath);
                if ($lines === false) {
                    return null;
                }
                $this->lines = $lines;
                if ($this->position < count($lines)) {
                    break;
                }
            }
            usleep(50_000);
            if (microtime(true) > $endTime) {
                if ($throwOnTimeout) {
                    throw new LogTimoutException('Timout exceeded when reading line');
                }

                return null;
            }
        }

        return $this->lines[$this->position++];
    }

    /**
     * Get all returned lines from the file.
     *
     * @return string[]
     */
    public function getAllLines(): array
    {
        return array_slice($this->lines, 0, $this->position);
    }
}