Merge branch '5.2' into 5.3

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / util / ExceptionLogUtil.class.php

<?php
namespace wcf\util;
use wcf\system\exception\SystemException;
use wcf\system\Regex;

/**
 * Contains helper functions to process the Exception log.
 * 
 * @author	Tim Duesterhus
 * @copyright	2001-2019 WoltLab GmbH
 * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package	WoltLabSuite\Core\Util
 * @since	5.2
 */
final class ExceptionLogUtil {
	/**
	 * Splits the given string of Exceptions into an array.
	 * 
	 * @param	string		$contents
	 * @return	string[]
	 */
	public static function splitLog($contents) {
		// unify newlines
		$contents = StringUtil::unifyNewlines($contents);
				
		// split contents
		$split = new Regex('(?:^|\n<<<<\n\n)(?:<<<<<<<<([a-f0-9]{40})<<<<\n|$)');
		$contents = $split->split($contents, Regex::SPLIT_NON_EMPTY_ONLY | Regex::CAPTURE_SPLIT_DELIMITER);
		
		if (empty($contents)) {
			return [];
		}
		
		// even items become keys, odd items become values
		return array_merge(...array_map(
			function($v) {
				return [$v[0] => $v[1]];
			},
			array_chunk($contents, 2)
		));
	}
	
	/**
	 * Parses the given log entry.
	 * 
	 * @param	string		$entry
	 * @return	mixed[]
	 */
	public static function parseException($entry) {
		static $regex = null;
		static $chainRegex = null;
		if ($regex === null || $chainRegex === null) {
			$regex = new Regex("(?P<date>[MTWFS][a-z]{2}, \d{1,2} [JFMASOND][a-z]{2} \d{4} \d{2}:\d{2}:\d{2} [+-]\d{4})\s*\n".
			"Message: (?P<message>.*?)\s*\n".
			"PHP version: (?P<phpVersion>.*?)\s*\n".
			"WoltLab Suite version: (?P<wcfVersion>.*?)\s*\n".
			"Request URI: (?P<requestURI>.*?)\s*\n".
			"Referrer: (?P<referrer>.*?)\s*\n".
			"User Agent: (?P<userAgent>.*?)\s*\n".
			"Peak Memory Usage: (?<peakMemory>\d+)/(?<maxMemory>(?:\d+|-1))\s*\n".
			"(?<chain>======\n".
			".*)", Regex::DOT_ALL);
			$chainRegex = new Regex("======\n".
			"Error Class: (?P<class>.*?)\s*\n".
			"Error Message: (?P<message>.*?)\s*\n".
			"Error Code: (?P<code>[a-zA-Z0-9]+)\s*\n".
			"File: (?P<file>.*?) \((?P<line>\d+)\)\s*\n".
			"Extra Information: (?P<information>(?:-|[a-zA-Z0-9+/]+={0,2}))\s*\n".
			"Stack Trace: (?P<stack>\[[^\n]+\])", Regex::DOT_ALL);
		}
		
		if (!$regex->match($entry)) {
			throw new \InvalidArgumentException('The given entry is malformed.');
		}
		$matches = $regex->getMatches();
		$chainRegex->match($matches['chain'], true, Regex::ORDER_MATCH_BY_SET);
		
		$chainMatches = array_map(function ($item) {
			if ($item['information'] === '-') {
				$item['information'] = null;
			}
			else {
				try {
					$item['information'] = unserialize(base64_decode($item['information']), ['allowed_classes' => false]);
				}
				catch (SystemException $e) {
					throw new \InvalidArgumentException('The additional information section of the given entry is malformed.', 0, $e);
				}
			}
			
			try {
				$item['stack'] = JSON::decode($item['stack']);
			}
			catch (SystemException $e) {
				throw new \InvalidArgumentException('The stack trace of the given entry is malformed.', 0, $e);
			}
			
			return $item;
		}, $chainRegex->getMatches());
		
		$matches['stackHash'] = sha1(implode("\0", array_map(function ($item) {
			$result = "";
			foreach ($item['stack'] as $stack) {
				$result .= $stack['file']."\t".$stack['line']."\t".$stack['class'].$stack['type'].$stack['function']."\n";
			}
			return $result;
		}, $chainMatches)));
		
		$matches['date'] = strtotime($matches['date']);
		$matches['chain'] = $chainMatches;
		
		return $matches;
	}
	
	/**
	 * Forbid creation of ExceptionLogUtil objects.
	 */
	private function __construct() {
		// does nothing
	}
}