1 |
efrain |
1 |
// Copyright 2017 Google
|
|
|
2 |
//
|
|
|
3 |
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
4 |
// you may not use this file except in compliance with the License.
|
|
|
5 |
// You may obtain a copy of the License at
|
|
|
6 |
//
|
|
|
7 |
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
8 |
//
|
|
|
9 |
// Unless required by applicable law or agreed to in writing, software
|
|
|
10 |
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
12 |
// See the License for the specific language governing permissions and
|
|
|
13 |
// limitations under the License.
|
|
|
14 |
|
|
|
15 |
#import "FirebaseCore/Sources/Private/FIRLogger.h"
|
|
|
16 |
|
|
|
17 |
#import <GoogleUtilities/GULAppEnvironmentUtil.h>
|
|
|
18 |
#import <GoogleUtilities/GULLogger.h>
|
|
|
19 |
#import "FirebaseCore/Sources/Public/FirebaseCore/FIRLoggerLevel.h"
|
|
|
20 |
|
|
|
21 |
#import "FirebaseCore/Sources/Public/FirebaseCore/FIRVersion.h"
|
|
|
22 |
|
|
|
23 |
FIRLoggerService kFIRLoggerCore = @"[Firebase/Core]";
|
|
|
24 |
|
|
|
25 |
// All the FIRLoggerService definitions should be migrated to clients. Do not add new ones!
|
|
|
26 |
FIRLoggerService kFIRLoggerAnalytics = @"[Firebase/Analytics]";
|
|
|
27 |
FIRLoggerService kFIRLoggerCrash = @"[Firebase/Crash]";
|
|
|
28 |
FIRLoggerService kFIRLoggerRemoteConfig = @"[Firebase/RemoteConfig]";
|
|
|
29 |
|
|
|
30 |
/// Arguments passed on launch.
|
|
|
31 |
NSString *const kFIRDisableDebugModeApplicationArgument = @"-FIRDebugDisabled";
|
|
|
32 |
NSString *const kFIREnableDebugModeApplicationArgument = @"-FIRDebugEnabled";
|
|
|
33 |
NSString *const kFIRLoggerForceSDTERRApplicationArgument = @"-FIRLoggerForceSTDERR";
|
|
|
34 |
|
|
|
35 |
/// Key for the debug mode bit in NSUserDefaults.
|
|
|
36 |
NSString *const kFIRPersistedDebugModeKey = @"/google/firebase/debug_mode";
|
|
|
37 |
|
|
|
38 |
/// NSUserDefaults that should be used to store and read variables. If nil, `standardUserDefaults`
|
|
|
39 |
/// will be used.
|
|
|
40 |
static NSUserDefaults *sFIRLoggerUserDefaults;
|
|
|
41 |
|
|
|
42 |
static dispatch_once_t sFIRLoggerOnceToken;
|
|
|
43 |
|
|
|
44 |
// The sFIRAnalyticsDebugMode flag is here to support the -FIRDebugEnabled/-FIRDebugDisabled
|
|
|
45 |
// flags used by Analytics. Users who use those flags expect Analytics to log verbosely,
|
|
|
46 |
// while the rest of Firebase logs at the default level. This flag is introduced to support
|
|
|
47 |
// that behavior.
|
|
|
48 |
static BOOL sFIRAnalyticsDebugMode;
|
|
|
49 |
|
|
|
50 |
#ifdef DEBUG
|
|
|
51 |
/// The regex pattern for the message code.
|
|
|
52 |
static NSString *const kMessageCodePattern = @"^I-[A-Z]{3}[0-9]{6}$";
|
|
|
53 |
static NSRegularExpression *sMessageCodeRegex;
|
|
|
54 |
#endif
|
|
|
55 |
|
|
|
56 |
void FIRLoggerInitializeASL(void) {
|
|
|
57 |
dispatch_once(&sFIRLoggerOnceToken, ^{
|
|
|
58 |
// Register Firebase Version with GULLogger.
|
|
|
59 |
GULLoggerRegisterVersion(FIRFirebaseVersion());
|
|
|
60 |
|
|
|
61 |
// Override the aslOptions to ASL_OPT_STDERR if the override argument is passed in.
|
|
|
62 |
NSArray *arguments = [NSProcessInfo processInfo].arguments;
|
|
|
63 |
BOOL overrideSTDERR = [arguments containsObject:kFIRLoggerForceSDTERRApplicationArgument];
|
|
|
64 |
|
|
|
65 |
// Use the standard NSUserDefaults if it hasn't been explicitly set.
|
|
|
66 |
if (sFIRLoggerUserDefaults == nil) {
|
|
|
67 |
sFIRLoggerUserDefaults = [NSUserDefaults standardUserDefaults];
|
|
|
68 |
}
|
|
|
69 |
|
|
|
70 |
BOOL forceDebugMode = NO;
|
|
|
71 |
BOOL debugMode = [sFIRLoggerUserDefaults boolForKey:kFIRPersistedDebugModeKey];
|
|
|
72 |
if ([arguments containsObject:kFIRDisableDebugModeApplicationArgument]) { // Default mode
|
|
|
73 |
[sFIRLoggerUserDefaults removeObjectForKey:kFIRPersistedDebugModeKey];
|
|
|
74 |
} else if ([arguments containsObject:kFIREnableDebugModeApplicationArgument] ||
|
|
|
75 |
debugMode) { // Debug mode
|
|
|
76 |
[sFIRLoggerUserDefaults setBool:YES forKey:kFIRPersistedDebugModeKey];
|
|
|
77 |
forceDebugMode = YES;
|
|
|
78 |
}
|
|
|
79 |
GULLoggerInitializeASL();
|
|
|
80 |
if (overrideSTDERR) {
|
|
|
81 |
GULLoggerEnableSTDERR();
|
|
|
82 |
}
|
|
|
83 |
if (forceDebugMode) {
|
|
|
84 |
GULLoggerForceDebug();
|
|
|
85 |
}
|
|
|
86 |
});
|
|
|
87 |
}
|
|
|
88 |
|
|
|
89 |
__attribute__((no_sanitize("thread"))) void FIRSetAnalyticsDebugMode(BOOL analyticsDebugMode) {
|
|
|
90 |
sFIRAnalyticsDebugMode = analyticsDebugMode;
|
|
|
91 |
}
|
|
|
92 |
|
|
|
93 |
void FIRSetLoggerLevel(FIRLoggerLevel loggerLevel) {
|
|
|
94 |
FIRLoggerInitializeASL();
|
|
|
95 |
GULSetLoggerLevel((GULLoggerLevel)loggerLevel);
|
|
|
96 |
}
|
|
|
97 |
|
|
|
98 |
#ifdef DEBUG
|
|
|
99 |
void FIRResetLogger(void) {
|
|
|
100 |
extern void GULResetLogger(void);
|
|
|
101 |
sFIRLoggerOnceToken = 0;
|
|
|
102 |
[sFIRLoggerUserDefaults removeObjectForKey:kFIRPersistedDebugModeKey];
|
|
|
103 |
sFIRLoggerUserDefaults = nil;
|
|
|
104 |
GULResetLogger();
|
|
|
105 |
}
|
|
|
106 |
|
|
|
107 |
void FIRSetLoggerUserDefaults(NSUserDefaults *defaults) {
|
|
|
108 |
sFIRLoggerUserDefaults = defaults;
|
|
|
109 |
}
|
|
|
110 |
#endif
|
|
|
111 |
|
|
|
112 |
/**
|
|
|
113 |
* Check if the level is high enough to be loggable.
|
|
|
114 |
*
|
|
|
115 |
* Analytics can override the log level with an intentional race condition.
|
|
|
116 |
* Add the attribute to get a clean thread sanitizer run.
|
|
|
117 |
*/
|
|
|
118 |
__attribute__((no_sanitize("thread"))) BOOL FIRIsLoggableLevel(FIRLoggerLevel loggerLevel,
|
|
|
119 |
BOOL analyticsComponent) {
|
|
|
120 |
FIRLoggerInitializeASL();
|
|
|
121 |
if (sFIRAnalyticsDebugMode && analyticsComponent) {
|
|
|
122 |
return YES;
|
|
|
123 |
}
|
|
|
124 |
return GULIsLoggableLevel((GULLoggerLevel)loggerLevel);
|
|
|
125 |
}
|
|
|
126 |
|
|
|
127 |
void FIRLogBasic(FIRLoggerLevel level,
|
|
|
128 |
FIRLoggerService service,
|
|
|
129 |
NSString *messageCode,
|
|
|
130 |
NSString *message,
|
|
|
131 |
va_list args_ptr) {
|
|
|
132 |
FIRLoggerInitializeASL();
|
|
|
133 |
GULLogBasic((GULLoggerLevel)level, service,
|
|
|
134 |
sFIRAnalyticsDebugMode && [kFIRLoggerAnalytics isEqualToString:service], messageCode,
|
|
|
135 |
message, args_ptr);
|
|
|
136 |
}
|
|
|
137 |
|
|
|
138 |
/**
|
|
|
139 |
* Generates the logging functions using macros.
|
|
|
140 |
*
|
|
|
141 |
* Calling FIRLogError(kFIRLoggerCore, @"I-COR000001", @"Configure %@ failed.", @"blah") shows:
|
|
|
142 |
* yyyy-mm-dd hh:mm:ss.SSS sender[PID] <Error> [Firebase/Core][I-COR000001] Configure blah failed.
|
|
|
143 |
* Calling FIRLogDebug(kFIRLoggerCore, @"I-COR000001", @"Configure succeed.") shows:
|
|
|
144 |
* yyyy-mm-dd hh:mm:ss.SSS sender[PID] <Debug> [Firebase/Core][I-COR000001] Configure succeed.
|
|
|
145 |
*/
|
|
|
146 |
#define FIR_LOGGING_FUNCTION(level) \
|
|
|
147 |
void FIRLog##level(FIRLoggerService service, NSString *messageCode, NSString *message, ...) { \
|
|
|
148 |
va_list args_ptr; \
|
|
|
149 |
va_start(args_ptr, message); \
|
|
|
150 |
FIRLogBasic(FIRLoggerLevel##level, service, messageCode, message, args_ptr); \
|
|
|
151 |
va_end(args_ptr); \
|
|
|
152 |
}
|
|
|
153 |
|
|
|
154 |
FIR_LOGGING_FUNCTION(Error)
|
|
|
155 |
FIR_LOGGING_FUNCTION(Warning)
|
|
|
156 |
FIR_LOGGING_FUNCTION(Notice)
|
|
|
157 |
FIR_LOGGING_FUNCTION(Info)
|
|
|
158 |
FIR_LOGGING_FUNCTION(Debug)
|
|
|
159 |
|
|
|
160 |
#undef FIR_MAKE_LOGGER
|
|
|
161 |
|
|
|
162 |
#pragma mark - FIRLoggerWrapper
|
|
|
163 |
|
|
|
164 |
@implementation FIRLoggerWrapper
|
|
|
165 |
|
|
|
166 |
+ (void)logWithLevel:(FIRLoggerLevel)level
|
|
|
167 |
withService:(FIRLoggerService)service
|
|
|
168 |
withCode:(NSString *)messageCode
|
|
|
169 |
withMessage:(NSString *)message
|
|
|
170 |
withArgs:(va_list)args {
|
|
|
171 |
FIRLogBasic(level, service, messageCode, message, args);
|
|
|
172 |
}
|
|
|
173 |
|
|
|
174 |
@end
|