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
|
/*
* Copyright (c) 2023 Hofi <hofione@gmail.com>
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 as published
* by the Free Software Foundation, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As an additional exemption you are allowed to compile & link against the
* OpenSSL libraries as published by the OpenSSL project. See the file
* COPYING for details.
*
*/
#include "darwinosl-source-oslog.h"
#include "messages.h"
/* https://stackoverflow.com/questions/23684727/nsdateformatter-milliseconds-bug */
static NSString *customBugFixDateFormat = @"yyyy-MM-dd'T'HH:mm:ss'.%06.0f'ZZZZZ";
@implementation NSDateFormatter (BugFix)
- (NSString *) stringFromDateWithMicroseconds:(NSDate *)theDate
{
NSDateComponents *components = [self.calendar components:NSCalendarUnitNanosecond
fromDate:theDate];
double microseconds = lrint((double)components.nanosecond / (double)1000);
NSString *dateTimeFormatString = [self stringFromDate:theDate];
NSString *formattedString = [NSString stringWithFormat:dateTimeFormatString, microseconds];
return formattedString;
}
@end
@interface OSLogSource ()
@property (strong, nonatomic) OSLogStore *logStore;
@property (strong, nonatomic) OSLogPosition *logPosition;
@property (strong, nonatomic) OSLogEnumerator *enumerator;
@property (assign, nonatomic) OSLogEnumeratorOptions enumeratorOptions;
@property (strong, nonatomic) NSPredicate *filterPredicate;
@end
@implementation OSLogSource
+ (NSDateFormatter *) defaultDateFormatter
{
NSDateFormatter *formatter = [[NSDateFormatter alloc] init];
formatter.locale = [NSLocale localeWithLocaleIdentifier:@"en_US_POSIX"];
formatter.dateFormat = customBugFixDateFormat;
formatter.timeZone = [NSTimeZone localTimeZone];
return formatter;
}
+ (NSDateFormatter *) RFC3339DateFormatter
{
static NSDateFormatter *_RFC3339DateFormatter = nil;
if (_RFC3339DateFormatter == nil)
_RFC3339DateFormatter = OSLogSource.defaultDateFormatter;
return _RFC3339DateFormatter;
}
- (OSLogStore *) openStore
{
g_assert(self.logStore == nil);
NSError *error = nil;
if (@available(macOS 12.0, *))
self.logStore = [OSLogStore storeWithScope:OSLogStoreSystem error:&error];
else
self.logStore = [OSLogStore localStoreAndReturnError:&error];
if (self.logStore == nil)
msg_error("darwinosl: Error getting handle to OSLog store",
evt_tag_long("error_code", error.code),
evt_tag_str("error", error.localizedDescription.UTF8String));
return self.logStore;
}
- (OSLogEnumerator *) openEnumeratorWithDate:(NSDate *)startDate
filterString:(NSString *)filterString
options:(OSLogEnumeratorOptions)options
{
g_assert(self.enumerator == nil);
// NOTE: This still can rise an uncought exception regardless the try/catch block here,
// see darwinosl-source.m _try_test_filter_predicate_str for more info
@try
{
NSPredicate *filterPredicate = (filterString.length > 0 ? [NSPredicate predicateWithFormat:filterString] : nil);
NSError *error = nil;
self.enumeratorOptions = options;
self.filterPredicate = filterPredicate;
self.logPosition = [self.logStore positionWithDate:startDate];
self.enumerator = [self.logStore entriesEnumeratorWithOptions:self.enumeratorOptions
position:self.logPosition
predicate:self.filterPredicate
error:&error];
if (self.enumerator == nil)
msg_error("darwinosl: Could not get OSLog enumerator",
evt_tag_long("error_code", error.code),
evt_tag_str("error", error.localizedDescription.UTF8String));
}
@catch(NSException *e)
{
msg_error("darwinosl: Could not open enumerator with filter predicate",
evt_tag_str("predicate", filterString.length ? filterString.UTF8String : ""),
evt_tag_str("error", [NSString stringWithFormat:@"%@", e].UTF8String));
}
return self.enumerator;
}
- (void) closeAll
{
self.logPosition = nil;
self.enumerator = nil;
self.logStore = nil;
}
- (OSLogEntry *) fetchNextEntry
{
OSLogEntry *nextLogEntry = [self.enumerator nextObject];
return nextLogEntry;
}
+ (int) darwinOSLogLevelToPriority:(OSLogEntryLogLevel)level
{
struct
{
const OSLogEntryLogLevel level;
const int pri;
} levels [] =
{
{ OSLogEntryLogLevelUndefined, LOG_NOTICE }, // 5
{ OSLogEntryLogLevelDebug, LOG_DEBUG }, // 7
{ OSLogEntryLogLevelInfo, LOG_INFO }, // 6
{ OSLogEntryLogLevelNotice, LOG_NOTICE }, // 5
{ OSLogEntryLogLevelError, LOG_ERR }, // 3
{ OSLogEntryLogLevelFault, LOG_CRIT }, // 2
};
const int maxLevels = sizeof(levels) / sizeof(levels[0]);
return (level >= 0 && level < maxLevels ? levels[level].pri : LOG_NOTICE);
}
- (NSString *) stringFromDarwinOSLogEntry:(OSLogEntry *)nextLogEntry
{
BOOL hasProcessData = [nextLogEntry conformsToProtocol:@protocol(OSLogEntryFromProcess)];
BOOL hasPayLoad = [nextLogEntry conformsToProtocol:@protocol(OSLogEntryWithPayload)];
BOOL hasLevel = [nextLogEntry respondsToSelector:@selector(level)];
OSLogEntry<OSLogEntryFromProcess, OSLogEntryWithPayload> *logEntry =
(OSLogEntry<OSLogEntryFromProcess, OSLogEntryWithPayload> *) nextLogEntry;
NSString *appName = (hasProcessData ?
/* RFC5424 does not allow 0x20 in APP-NAME */
[[logEntry process] stringByReplacingOccurrencesOfString:@" "
withString:@"\\0x20"] :
@"-");
NSString *procIDStr = (hasProcessData ? [NSNumber numberWithUnsignedInt:[logEntry processIdentifier]].stringValue :
@"-");
NSString *timeStampStr = [OSLogSource.RFC3339DateFormatter stringFromDateWithMicroseconds:logEntry.date];
os_activity_id_t activity = (hasProcessData ? [logEntry activityIdentifier] : 0);
int priority = (int) (hasLevel ? [OSLogSource darwinOSLogLevelToPriority:[(OSLogEntryLog *) logEntry level]] : 0);
NSString *subsystem = (hasPayLoad && [logEntry subsystem] ?
[NSString stringWithFormat:@" (%@)", [logEntry subsystem]] :
@"");
NSString *category = (hasPayLoad && [logEntry category] ?
[NSString stringWithFormat:@" [%@]", [logEntry category]] :
@"");
/* By default using the RFC5424 Syslog Protocol
SYSLOG-MSG = <PRI>VERSION SP -|TIMESTAMP SP -|HOSTNAME SP -|APP-NAME SP -|PROCID SP -|MSGID SP -|STRUCTURED-DATA [SP MSG] */
NSString *formattedMsg = [NSString stringWithFormat:@"<%d>1 %@ - %@ %@ - - %lu%@%@ %@",
priority, /* PRI */
/* VERSION is hardcoded already */
timeStampStr, /* TIMESTAMP */
/* HOSTNAME is skipped */
appName, /* APP-NAME */
procIDStr, /* PROCID */
/* MSGID is skipped */
/* STRUCTURED-DATA is skipped */
/* Optional MSG part is from here
TODO: These additional properties might go into STRUCTURED-DATA */
(unsigned long) activity,
subsystem,
category,
logEntry.composedMessage];
return formattedMsg;
}
@end
|
