summaryrefslogtreecommitdiffstats
path: root/library/Icinga/Protocol/File/LogFileIterator.php
blob: 67a4d99d11482253e9d4dc301edefc3f1017d40f (plain)
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
<?php
/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */

namespace Icinga\Protocol\File;

use Icinga\Exception\IcingaException;
use SplFileObject;
use Iterator;

/**
 * Iterate over a log file, yielding the regex fields of the log messages
 */
class LogFileIterator implements Iterator
{
    /**
     * Log file
     *
     * @var SplFileObject
     */
    protected $file;

    /**
     * A PCRE string with the fields to extract
     * from the log messages as named subpatterns
     *
     * @var string
     */
    protected $fields;

    /**
     * Value for static::current()
     *
     * @var array
     */
    protected $current;

    /**
     * Index for static::key()
     *
     * @var int
     */
    protected $index;

    /**
     * Value for static::valid()
     *
     * @var boolean
     */
    protected $valid;

    /**
     * @var string
     */
    protected $next = null;

    /**
     * @param string $filename      The log file's name
     * @param string $fields        A PCRE string with the fields to extract
     *                              from the log messages as named subpatterns
     */
    public function __construct($filename, $fields)
    {
        $this->file = new SplFileObject($filename);
        $this->file->setFlags(
            SplFileObject::DROP_NEW_LINE |
            SplFileObject::READ_AHEAD
        );
        $this->fields = $fields;
    }

    public function rewind(): void
    {
        $this->file->rewind();
        $this->index = 0;
        $this->nextMessage();
    }

    public function next(): void
    {
        $this->file->next();
        ++$this->index;
        $this->nextMessage();
    }

    public function current(): array
    {
        return $this->current;
    }

    public function key(): int
    {
        return $this->index;
    }

    public function valid(): bool
    {
        return $this->valid;
    }

    protected function nextMessage()
    {
        $message = $this->next === null ? array() : array($this->next);
        $this->valid = null;
        while ($this->file->valid()) {
            if (false === ($res = preg_match(
                $this->fields,
                $current = $this->file->current()
            ))) {
                throw new IcingaException('Failed at preg_match()');
            }
            if (empty($message)) {
                if ($res === 1) {
                    $message[] = $current;
                }
            } elseif ($res === 1) {
                $this->next = $current;
                $this->valid = true;
                break;
            } else {
                $message[] = $current;
            }

            $this->file->next();
        }
        if ($this->valid === null) {
            $this->next = null;
            $this->valid = ! empty($message);
        }

        if ($this->valid) {
            while (! empty($message)) {
                $matches = array();
                if (false === ($res = preg_match(
                    $this->fields,
                    implode(PHP_EOL, $message),
                    $matches
                ))) {
                    throw new IcingaException('Failed at preg_match()');
                }
                if ($res === 1) {
                    $this->current = $matches;
                    return;
                }
                array_pop($message);
            }
            $this->valid = false;
        }
    }
}