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
#![warn(missing_docs)]
use std::fmt;
use std::io::{self, Cursor, Read};
use anylog::LogEntry;
use bytes::{Buf, Bytes};
use chrono::{DateTime, TimeZone, Utc};
use compress::zlib;
use failure::Fail;
use lazy_static::lazy_static;
use regex::Regex;
use serde::Serialize;
use crate::context::Unreal4Context;
lazy_static! {
static ref LOG_FIRST_LINE: Regex = Regex::new(r"Log file open, (?P<month>\d\d)/(?P<day>\d\d)/(?P<year>\d\d) (?P<hour>\d\d):(?P<minute>\d\d):(?P<second>\d\d)$").unwrap();
}
mod context;
struct Header {
pub directory_name: String,
pub file_name: String,
pub uncompressed_size: i32,
pub file_count: i32,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Unreal4FileType {
Minidump,
Log,
Config,
Context,
Unknown,
}
impl Unreal4FileType {
pub fn name(self) -> &'static str {
match self {
Unreal4FileType::Minidump => "minidump",
Unreal4FileType::Log => "log",
Unreal4FileType::Config => "config",
Unreal4FileType::Context => "context",
Unreal4FileType::Unknown => "unknown",
}
}
}
impl fmt::Display for Unreal4FileType {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.name())
}
}
#[derive(Clone, Debug)]
pub struct Unreal4CrashFile {
pub index: usize,
pub file_name: String,
pub offset: usize,
pub len: usize,
}
#[derive(Serialize)]
pub struct Unreal4LogEntry {
#[serde(skip_serializing_if = "Option::is_none")]
pub timestamp: Option<DateTime<Utc>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub component: Option<String>,
pub message: String,
}
impl Unreal4CrashFile {
pub fn ty(&self) -> Unreal4FileType {
match self.file_name.as_str() {
"UE4Minidump.dmp" => Unreal4FileType::Minidump,
"CrashReportClient.ini" => Unreal4FileType::Config,
"CrashContext.runtime-xml" => Unreal4FileType::Context,
name => {
if name.ends_with(".log") {
Unreal4FileType::Log
} else {
Unreal4FileType::Unknown
}
}
}
}
}
#[derive(Fail, Debug)]
pub enum Unreal4Error {
#[fail(display = "unknown bytes format")]
UnknownBytesFormat,
#[fail(display = "empty crash")]
Empty,
#[fail(display = "out of bounds")]
OutOfBounds,
#[fail(display = "bad compression")]
BadCompression(io::Error),
#[fail(display = "invalid log entry")]
InvalidLogEntry(std::str::Utf8Error),
#[fail(display = "invalid xml")]
InvalidXml(elementtree::Error),
}
#[derive(Debug)]
pub struct Unreal4Crash {
bytes: Bytes,
files: Vec<Unreal4CrashFile>,
}
impl Unreal4Crash {
pub fn from_slice(bytes: &[u8]) -> Result<Unreal4Crash, Unreal4Error> {
if bytes.is_empty() {
return Err(Unreal4Error::Empty);
}
let mut zlib_decoder = zlib::Decoder::new(bytes);
let mut decompressed = Vec::new();
zlib_decoder
.read_to_end(&mut decompressed)
.map_err(Unreal4Error::BadCompression)?;
let decompressed = Bytes::from(decompressed);
let file_meta = get_files_from_slice(&decompressed)?;
Ok(Unreal4Crash {
bytes: decompressed,
files: file_meta,
})
}
pub fn files(&self) -> impl Iterator<Item = &Unreal4CrashFile> {
self.files.iter()
}
pub fn file_count(&self) -> usize {
self.files.len() as usize
}
pub fn file_by_index(&self, index: usize) -> Option<&Unreal4CrashFile> {
self.files().find(|f| f.index == index)
}
pub fn file_contents_by_index(&self, index: usize) -> Result<Option<&[u8]>, Unreal4Error> {
match self.file_by_index(index) {
Some(f) => Ok(Some(self.get_file_contents(f)?)),
None => Ok(None),
}
}
pub fn get_minidump_slice(&self) -> Result<Option<&[u8]>, Unreal4Error> {
self.get_file_slice(Unreal4FileType::Minidump)
}
pub fn get_file_slice(
&self,
file_type: Unreal4FileType,
) -> Result<Option<&[u8]>, Unreal4Error> {
let file = match self.files().find(|f| f.ty() == file_type) {
Some(m) => m,
None => return Ok(None),
};
Ok(Some(self.get_file_contents(file)?))
}
pub fn get_file_contents(&self, file_meta: &Unreal4CrashFile) -> Result<&[u8], Unreal4Error> {
let end = file_meta
.offset
.checked_add(file_meta.len)
.ok_or(Unreal4Error::OutOfBounds)?;
self.bytes
.get(file_meta.offset..end)
.ok_or(Unreal4Error::OutOfBounds)
}
pub fn get_context(&self) -> Result<Option<Unreal4Context>, Unreal4Error> {
Unreal4Context::from_crash(self)
}
pub fn get_logs(&self, limit: usize) -> Result<Vec<Unreal4LogEntry>, Unreal4Error> {
match self.get_file_slice(Unreal4FileType::Log)? {
Some(f) => parse_log_from_slice(f, limit),
None => Ok(Vec::new()),
}
}
}
fn parse_log_from_slice(
log_slice: &[u8],
limit: usize,
) -> Result<Vec<Unreal4LogEntry>, Unreal4Error> {
let mut fallback_timestamp = None;
let logs_utf8 = std::str::from_utf8(log_slice).map_err(Unreal4Error::InvalidLogEntry)?;
if let Some(first_line) = logs_utf8.lines().next() {
if let Some(captures) = LOG_FIRST_LINE.captures(&first_line) {
fallback_timestamp = Some(
Utc.ymd(
captures["year"].parse::<i32>().unwrap() + 2000,
captures["month"].parse::<u32>().unwrap(),
captures["day"].parse::<u32>().unwrap(),
)
.and_hms(
captures["hour"].parse::<u32>().unwrap(),
captures["minute"].parse::<u32>().unwrap(),
captures["second"].parse::<u32>().unwrap(),
),
);
}
}
let mut logs: Vec<_> = logs_utf8
.lines()
.rev()
.take(limit)
.map(|line| {
let entry = LogEntry::parse(line.as_bytes());
let (component, message) = entry.component_and_message();
fallback_timestamp = entry.utc_timestamp().or(fallback_timestamp);
Unreal4LogEntry {
timestamp: fallback_timestamp,
component,
message,
}
})
.collect();
logs.reverse();
Ok(logs)
}
fn read_ansi_string(buffer: &mut Cursor<&[u8]>) -> String {
let size = buffer.get_u32_le() as usize;
let dir_name = String::from_utf8_lossy(&Buf::bytes(&buffer)[..size]).into_owned();
buffer.advance(size);
dir_name.trim_end_matches('\0').into()
}
fn read_header(cursor: &mut Cursor<&[u8]>) -> Header {
Header {
directory_name: read_ansi_string(cursor),
file_name: read_ansi_string(cursor),
uncompressed_size: cursor.get_i32_le(),
file_count: cursor.get_i32_le(),
}
}
fn get_files_from_slice(bytes: &Bytes) -> Result<Vec<Unreal4CrashFile>, Unreal4Error> {
let mut rv = vec![];
let file_count = Cursor::new(
&bytes
.get(bytes.len() - 4..)
.ok_or(Unreal4Error::OutOfBounds)?,
)
.get_i32_le();
let mut cursor = Cursor::new(&bytes[..]);
read_header(&mut cursor);
for _ in 0..file_count {
let meta = Unreal4CrashFile {
index: cursor.get_i32_le() as usize,
file_name: read_ansi_string(&mut cursor),
len: cursor.get_i32_le() as usize,
offset: cursor.position() as usize,
};
cursor.advance(meta.len);
rv.push(meta);
}
Ok(rv)
}
#[test]
fn test_from_slice_empty_buffer() {
let crash = &[];
let result = Unreal4Crash::from_slice(crash);
assert!(match result.expect_err("empty crash") {
Unreal4Error::Empty => true,
_ => false,
})
}
#[test]
fn test_from_slice_invalid_input() {
let crash = &[0u8; 1];
let result = Unreal4Crash::from_slice(crash);
let err = match result.expect_err("empty crash") {
Unreal4Error::BadCompression(b) => b.to_string(),
_ => panic!(),
};
assert_eq!("unexpected EOF", err)
}
#[test]
fn test_parse_log_from_slice_no_entries_with_timestamp() {
let log_bytes = br"Log file open, 12/13/18 15:54:53
LogWindows: Failed to load 'aqProf.dll' (GetLastError=126)
LogWindows: File 'aqProf.dll' does not exist";
let logs = parse_log_from_slice(log_bytes, 1000).expect("logs");
assert_eq!(logs.len(), 3);
assert_eq!(logs[2].component.as_ref().expect("component"), "LogWindows");
assert_eq!(
logs[2].timestamp.expect("timestamp").to_rfc3339(),
"2018-12-13T15:54:53+00:00"
);
assert_eq!(logs[2].message, "File 'aqProf.dll' does not exist");
}