├── README.md
├── LICENSE
└── KnuckleLog.php


/README.md:
--------------------------------------------------------------------------------
 1 | # KnuckleLog
 2 | 
 3 | Standalone PHP fast & low memory usage class for Nginx access log parsing.
 4 | 
 5 | This class is designed to parsing small or large NGINX access log files.
 6 | 
 7 | Its feature is that it handles part of the file with a row limit, and it also returns the total number of rows in the file.
 8 | 
 9 | Tests on access.log => 500 MB.
10 | 
11 | Docs coming soon...
12 | 
13 | ## Usage
14 | 
15 | ```php
16 | 
17 | // Initialize (parse nginx accesss log in default format with offset = 0 and limit 10 lines 
18 | $data = new KnuckleLog('/var/log/nginx/access.log', '%h %l %u %t "%r" %>s %O "%{Referer}i" \"%{User-Agent}i"', 0, 10);
19 | 
20 | // Get array of data & data count
21 | $array = $data->worker();
22 | 
23 | // Total lines in log file
24 | echo '<h1>'.$array['totalLines'].'</h1>';
25 | 
26 | // Dump data array
27 | echo '<pre>';
28 | print_r($array['data']);
29 | echo '</pre>';
30 | 
31 | ```
32 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2017 Igor Pankov
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/KnuckleLog.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | class KnuckleLog
  4 | {
  5 |     protected static $defaultFormat = '%h %l %u %t "%r" %>s %b';
  6 |     protected $pcreFormat;
  7 |     protected $handler = null;
  8 |     protected $fbuffer = [];
  9 |     protected $offsetLines = 0;
 10 |     protected $limitLines = 0;
 11 |     protected $patterns = [
 12 |         '%%' => '(?P<percent>\%)',
 13 |         '%a' => '(?P<remoteIp>)',
 14 |         '%A' => '(?P<localIp>)',
 15 |         '%h' => '(?P<host>[a-zA-Z0-9\-\._:]+)',
 16 |         '%l' => '(?P<logname>(?:-|[\w-]+))',
 17 |         '%m' => '(?P<requestMethod>OPTIONS|GET|HEAD|POST|PUT|DELETE|TRACE|CONNECT|PATCH|PROPFIND)',
 18 |         '%p' => '(?P<port>\d+)',
 19 |         '%r' => '(?P<request>(?:(?:[A-Z]+) .+? HTTP/[1-3].(?:0|1))|-|)',
 20 |         '%t' => '\[(?P<time>\d{2}/(?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)/\d{4}:\d{2}:\d{2}:\d{2} (?:-|\+)\d{4})\]',
 21 |         '%u' => '(?P<user>(?:-|[\w-]+))',
 22 |         '%U' => '(?P<URL>.+?)',
 23 |         '%v' => '(?P<serverName>([a-zA-Z0-9]+)([a-z0-9.-]*))',
 24 |         '%V' => '(?P<canonicalServerName>([a-zA-Z0-9]+)([a-z0-9.-]*))',
 25 |         '%>s' => '(?P<status>\d{3}|-)',
 26 |         '%b' => '(?P<responseBytes>(\d+|-))',
 27 |         '%T' => '(?P<requestTime>(\d+\.?\d*))',
 28 |         '%O' => '(?P<sentBytes>[0-9]+)',
 29 |         '%I' => '(?P<receivedBytes>[0-9]+)',
 30 |         '\%\{(?P<name>[a-zA-Z]+)(?P<name2>[-]?)(?P<name3>[a-zA-Z]+)\}i' => '(?P<Header\\1\\3>.*?)',
 31 |         '%D' => '(?P<timeServeRequest>[0-9]+)',
 32 |     ];
 33 | 
 34 |     public static function getDefaultFormat()
 35 |     {
 36 |         return self::$defaultFormat;
 37 |     }
 38 | 
 39 |     public function __construct($fileName = null, $format = null, $offset = 0, $limit = 10)
 40 |     {
 41 | 
 42 |         $this->offsetLines = $offset;
 43 |         $this->limitLines = $limit;
 44 | 
 45 |         if(!($this->handler = fopen($fileName, "rb"))) {
 46 |             throw new \Exception("Cannot open the file");
 47 |         }
 48 | 
 49 |         // Set IPv4 & IPv6 recognition patterns
 50 |         $ipPatterns = implode('|', array(
 51 |             'ipv4' => '(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9]))',
 52 |             'ipv6full' => '([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7})', // 1:1:1:1:1:1:1:1
 53 |             'ipv6null' => '(::)',
 54 |             'ipv6leading' => '(:(:[0-9A-Fa-f]{1,4}){1,7})', // ::1:1:1:1:1:1:1
 55 |             'ipv6mid' => '(([0-9A-Fa-f]{1,4}:){1,6}(:[0-9A-Fa-f]{1,4}){1,6})', // 1:1:1::1:1:1
 56 |             'ipv6trailing' => '(([0-9A-Fa-f]{1,4}:){1,7}:)', // 1:1:1:1:1:1:1::
 57 |         ));
 58 |         $this->patterns['%a'] = '(?P<remoteIp>'.$ipPatterns.')';
 59 |         $this->patterns['%A'] = '(?P<localIp>'.$ipPatterns.')';
 60 |         $this->setFormat($format ?: self::getDefaultFormat());
 61 |     }
 62 | 
 63 |     public function readLog($countLine = 10)
 64 |     {
 65 |         if(!$this->handler) {
 66 |             throw new Exception("Invalid file pointer");
 67 |         }
 68 | 
 69 |         while(!feof($this->handler)) {
 70 |             $this->fbuffer[] = fgets($this->handler);
 71 |             $countLine--;
 72 |             if($countLine == 0) break;
 73 |         }
 74 | 
 75 |         return $this->fbuffer;
 76 |     }
 77 | 
 78 |     public function setOffset($line = 0)
 79 |     {
 80 |         if(!$this->handler) {
 81 |             throw new \Exception("Invalid file pointer");
 82 |         }
 83 | 
 84 |         while(!feof($this->handler) && $line--) {
 85 |             fgets($this->handler);
 86 |         }
 87 |     }
 88 | 
 89 |     public function addPattern($placeholder, $pattern)
 90 |     {
 91 |         $this->patterns[$placeholder] = $pattern;
 92 |     }
 93 | 
 94 |     public function setFormat($format)
 95 |     {
 96 |         // strtr won't work for "complex" header patterns
 97 |         // $this->pcreFormat = strtr("#^{$format}$#", $this->patterns);
 98 |         $expr = "#^{$format}$#";
 99 |         foreach ($this->patterns as $pattern => $replace) {
100 |             $expr = preg_replace("/{$pattern}/", $replace, $expr);
101 |         }
102 |         $this->pcreFormat = $expr;
103 |     }
104 | 
105 |     public function parse($line)
106 |     {
107 |         if (!preg_match($this->pcreFormat, $line, $matches)) {
108 |             throw new \Exception("Error parsing line, check offset and limits");
109 |         }
110 |         $entry = new \stdClass();
111 |         foreach (array_filter(array_keys($matches), 'is_string') as $key) {
112 |             if ('time' === $key && true !== $stamp = strtotime($matches[$key])) {
113 |                 $entry->stamp = $stamp;
114 |             }
115 |             $entry->{$key} = $matches[$key];
116 |         }
117 |         return $entry;
118 |     }
119 | 
120 |     public function getPCRE()
121 |     {
122 |         return (string) $this->pcreFormat;
123 |     }
124 | 
125 |     public function getLines()
126 |     {
127 |         if(!$this->handler) {
128 |             throw new \Exception("Invalid file pointer");
129 |         }
130 |         $lines = 0;
131 |         while(!feof($this->handler)) {
132 |             $lines += substr_count(fread($this->handler, 8192), "\n");
133 |         }
134 |         fclose($this->handler);
135 |         return $lines;
136 |     }
137 | 
138 |     public function worker()
139 |     {
140 |         $this->setOffset($this->offsetLines);
141 |         $result = $this->readLog($this->limitLines);
142 |         $entry = [];
143 |         foreach ($result as $line) {
144 |             $entry[] = $this->parse($line);
145 |         }
146 |         return ['data' => $entry ?? null, 'totalLines' => $this->getLines() ?? null];
147 |     }
148 | }
149 | 


--------------------------------------------------------------------------------