AFHTTPClientLogger.m

// AFHTTPClientLogger.m
//
// Copyright (c) 2012-2016 Jon Parise
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#import "AFHTTPClientLogger.h"

#import <AFNetworking/AFHTTPRequestOperation.h>

#import <objc/runtime.h>


#if __has_include(<CocoaLumberjack/DDLogMacros.h>)
#import <CocoaLumberjack/DDLogMacros.h>
// Global log level for the whole library, not per-file.
const DDLogLevel ddLogLevel = DDLogLevelVerbose;
#else
#define DDLogError(...)   NSLog(__VA_ARGS__)
#define DDLogWarn(...)    NSLog(__VA_ARGS__)
#define DDLogInfo(...)    NSLog(__VA_ARGS__)
#define DDLogDebug(...)   NSLog(__VA_ARGS__)
#define DDLogVerbose(...) NSLog(__VA_ARGS__)
#endif


typedef NSString * (^AFHTTPClientLoggerFormatBlock)(AFHTTPRequestOperation *operation, AFHTTPClientLogLevel level);

@interface AFHTTPClientLogger ()
@property (readwrite, nonatomic) NSString *baseURLString;
@property (readwrite, nonatomic, copy) AFHTTPClientLoggerFormatBlock requestStartFormatBlock;
@property (readwrite, nonatomic, copy) AFHTTPClientLoggerFormatBlock requestFinishFormatBlock;
@property (readwrite, nonatomic, strong) NSOperationQueue *notificationHandlerQueue;
@property (readwrite, nonatomic, strong) id <NSObject> startNotificationObserver;
@property (readwrite, nonatomic, strong) id <NSObject> finishNotificationObserver;
@end

#pragma mark -

@implementation AFHTTPClientLogger

- (instancetype)initWithBaseURL:(NSURL *)baseURL {
    if ((self = [super init])) {
        _baseURLString = [baseURL absoluteString];
        _level = AFHTTPClientLogLevelInfo;
        _notificationHandlerQueue = [[NSOperationQueue alloc] init];
    }

    return self;
}

- (void)dealloc {
    [_notificationHandlerQueue cancelAllOperations];
    [[NSNotificationCenter defaultCenter] removeObserver:_startNotificationObserver name:AFNetworkingOperationDidStartNotification object:nil];
    [[NSNotificationCenter defaultCenter] removeObserver:_finishNotificationObserver name:AFNetworkingOperationDidFinishNotification object:nil];
}

- (void)setEnabled:(BOOL)enabled {
    if (enabled != _enabled) {
        if (enabled) {
            // weakify and strongify
            __weak typeof(self) weakSelf = self;
            self.startNotificationObserver = [[NSNotificationCenter defaultCenter] addObserverForName:AFNetworkingOperationDidStartNotification
                                                                object:nil
                                                                 queue:self.notificationHandlerQueue
                                                            usingBlock:^(NSNotification * _Nonnull notification) {
                                                                AFHTTPClientLogger *strongSelf = weakSelf;
                                                                [strongSelf operationDidStart:notification];
                                                            }];
            self.finishNotificationObserver = [[NSNotificationCenter defaultCenter] addObserverForName:AFNetworkingOperationDidFinishNotification
                                                              object:nil
                                                               queue:self.notificationHandlerQueue
                                                          usingBlock:^(NSNotification * _Nonnull notification) {
                                                              AFHTTPClientLogger *strongSelf = weakSelf;
                                                              [strongSelf operationDidFinish:notification];
                                                          }];
        } else {
            if (self.startNotificationObserver) {
                [[NSNotificationCenter defaultCenter] removeObserver:self.startNotificationObserver name:AFNetworkingOperationDidStartNotification object:nil];
            }
            if (self.finishNotificationObserver) {
                [[NSNotificationCenter defaultCenter] removeObserver:self.finishNotificationObserver name:AFNetworkingOperationDidFinishNotification object:nil];
            }
        }

        _enabled = enabled;
    }
}

- (void)operationDidStart:(NSNotification *)notification {
    AFHTTPRequestOperation *operation = [notification object];
    if (![[[operation.request URL] absoluteString] hasPrefix:self.baseURLString]) {
        return;
    }

    if (self.requestStartFormatBlock) {
        NSString *formattedString = self.requestStartFormatBlock(operation, self.level);
        if (formattedString) {
            DDLogError(@"%@", formattedString);
        }
        return;
    }

    id body = nil;
    if ([operation.request HTTPBody] && self.level <= AFHTTPClientLogLevelVerbose) {
        NSError *error = nil;
        body = [NSJSONSerialization JSONObjectWithData:[operation.request HTTPBody] options:NSJSONReadingAllowFragments error:&error];
        if (error) {
            body = [[NSString alloc] initWithData:[operation.request HTTPBody] encoding:NSUTF8StringEncoding];
        }
    }

    switch (self.level) {
        case AFHTTPClientLogLevelVerbose:
            if (body) {
              DDLogVerbose(@">> %@ %@\n%@\n%@", [operation.request HTTPMethod], [[operation.request URL] absoluteString], [operation.request allHTTPHeaderFields], body);
            } else {
              DDLogVerbose(@">> %@ %@\n%@", [operation.request HTTPMethod], [[operation.request URL] absoluteString], [operation.request allHTTPHeaderFields]);
            }
            break;
        case AFHTTPClientLogLevelDebug:
            if (body) {
              DDLogDebug(@">> %@ %@\n%@", [operation.request HTTPMethod], [[operation.request URL] absoluteString], body);
            } else {
              DDLogDebug(@">> %@ %@", [operation.request HTTPMethod], [[operation.request URL] absoluteString]);
            }
            break;
        case AFHTTPClientLogLevelInfo:
            DDLogInfo(@">> %@ %@", [operation.request HTTPMethod], [[operation.request URL] absoluteString]);
            break;
        default:
            break;
    }
}

- (void)operationDidFinish:(NSNotification *)notification {
    AFHTTPRequestOperation *operation = [notification object];
    if (![[[operation.request URL] absoluteString] hasPrefix:self.baseURLString]) {
        return;
    }

    if (self.requestFinishFormatBlock) {
        NSString *formattedString = self.requestFinishFormatBlock(operation, self.level);
        if (formattedString) {
            DDLogError(@"%@", formattedString);
        }
        return;
    }

    NSURL *URL = (operation.response) ? [operation.response URL] : [operation.request URL];
    id responseObject = operation.responseObject;

    if (operation.error && operation.error.code == NSURLErrorCancelled) {
        switch (self.level) {
          case AFHTTPClientLogLevelVerbose:
              DDLogVerbose(@"Canceled %@: %@", [URL absoluteString], operation.error);
              break;
          case AFHTTPClientLogLevelDebug:
          case AFHTTPClientLogLevelInfo:
              DDLogDebug(@"Canceled %@: %@", [URL absoluteString], [operation.error localizedDescription]);
              break;
          default:
              break;
        }
    } else if (operation.error) {
        switch (self.level) {
            case AFHTTPClientLogLevelVerbose:
                DDLogInfo(@"!! %ld %@: %@", (long)[operation.response statusCode], [URL absoluteString], operation.error);
                break;
            case AFHTTPClientLogLevelDebug:
            case AFHTTPClientLogLevelInfo:
            case AFHTTPClientLogLevelError:
                DDLogError(@"!! %ld %@: %@", (long)[operation.response statusCode], [URL absoluteString], [operation.error localizedDescription]);
                break;
        }
    } else {
        switch (self.level) {
            case AFHTTPClientLogLevelVerbose:
                if (operation.responseString) {
                    DDLogVerbose(@"<< %ld %@\n%@\n%@", (long)[operation.response statusCode], [URL absoluteString], [operation.response allHeaderFields], responseObject);
                } else {
                    DDLogVerbose(@"<< %ld %@\n%@", (long)[operation.response statusCode], [URL absoluteString], [operation.response allHeaderFields]);
                }
                break;
            case AFHTTPClientLogLevelDebug:
                if (operation.responseString) {
                    DDLogDebug(@"<< %ld %@\n%@", (long)[operation.response statusCode], [URL absoluteString], responseObject);
                } else {
                    DDLogDebug(@"<< %ld %@", (long)[operation.response statusCode], [URL absoluteString]);
                }
                break;
            case AFHTTPClientLogLevelInfo:
                DDLogInfo(@"<< %ld %@", (long)[operation.response statusCode], [URL absoluteString]);
                break;
            default:
                break;
        }
    }
}

@end

#pragma mark -

@implementation AFHTTPRequestOperationManager (Logging)

static char AFHTTPClientLoggerObject;

- (AFHTTPClientLogger *)logger {
    AFHTTPClientLogger *logger = objc_getAssociatedObject(self, &AFHTTPClientLoggerObject);
    if (logger == nil) {
        logger = [[AFHTTPClientLogger alloc] initWithBaseURL:self.baseURL];
        objc_setAssociatedObject(self, &AFHTTPClientLoggerObject, logger, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }

    return logger;
}

@end