Logger.swift

//
//  Logger.swift
//  NoMAD
//
//  Created by Joel Rennich on 9/6/16.
//  Copyright © 2016 Orchard & Grove Inc. All rights reserved.
//

/// A singleton `Logger` instance for the app to use.

let myLogger = Logger()

import Foundation
import os.log

/// The individual logging levels to use when logging in NoMAD
///
/// - base: General errors
/// - info: Positive info
/// - notice: Nice to know issues that may, or may not, cause issues
/// - debug: Lots of verbose logging
enum LogLevel: Int {
    
    /// General errors
    case base = 0
    
    /// Positive info
    case info = 1
    
    /// Nice to know issues that may, or may not, cause issues
    case notice = 2
    
    /// Lots of verbose logging
    case debug = 3
}

var log: OSLog? {
    if #available(OSX 10.12, *) {
        return OSLog(subsystem: "menu.nomad.login.ad", category: "framework")
    } else {
        return nil
    }
}



/// Simple class to handle logging levels. Use the `LogLevel` enum to specify the logging details.
class Logger {
    
    /// Set to a level from `LogLevel` enum to control what gets logged.
    var loglevel: LogLevel
    
    /// Init method simply check to see if Verbose logging is enabled or not for the Logger object.
    init() {
        
        let defaults = UserDefaults.init(suiteName: "menu.nomad.login.ad")
        
        if defaults?.bool(forKey: "Verbose") ?? false {
            NSLog("Enaging verbose logging")
            loglevel = .debug
        } else {
            loglevel = .base
        }
    }
    
    /// Simple wrapper around NSLog to provide control of logging.
    ///
    /// - Parameters:
    ///   - level: A value from `LogLevel` enum
    ///   - message: A `String` that describes the information to be logged
    func logit(_ level: LogLevel, message: String) {
        if (level.rawValue <= loglevel.rawValue) {
            if #available(OSX 10.12, *) {
                os_log("%{public}@", log: log!, type: .debug, message)
            } else {
                NSLog("level: \(level) - " + message)
            }
        }
    }
}