oqtane.framework/Oqtane.Server/Infrastructure/LogManager.cs

using System;
using System.Collections.Generic;
using System.Text.Json;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;
using Oqtane.Enums;
using Oqtane.Models;
using Oqtane.Repository;
using Oqtane.Security;
using Oqtane.Shared;

namespace Oqtane.Infrastructure
{
    public class LogManager : ILogManager
    {
        private readonly ILogRepository _logs;
        private readonly ITenantManager _tenantManager;
        private readonly IConfigManager _config;
        private readonly IUserPermissions _userPermissions;
        private readonly IHttpContextAccessor _accessor;
        private readonly IUserRoleRepository _userRoles;
        private readonly INotificationRepository _notifications;
        private readonly ILogger<LogManager> _filelogger;

        public LogManager(ILogRepository logs, ITenantManager tenantManager, IConfigManager config, IUserPermissions userPermissions, IHttpContextAccessor accessor, IUserRoleRepository userRoles, INotificationRepository notifications, ILogger<LogManager> filelogger)
        {
            _logs = logs;
            _tenantManager = tenantManager;
            _config = config;
            _userPermissions = userPermissions;
            _accessor = accessor;
            _userRoles = userRoles;
            _notifications = notifications;
            _filelogger = filelogger;
        }

        public void Log(Shared.LogLevel level, object @class, LogFunction function, string message, params object[] args)
        {
            Log(-1, level, @class, function, null, message, args);
        }

        public void Log(Shared.LogLevel level, object @class, LogFunction function, Exception exception, string message, params object[] args)
        {
            Log(-1, level, @class, function, exception, message, args);
        }

        public void Log(int siteId, Shared.LogLevel level, object @class, LogFunction function, string message, params object[] args)
        {
            Log(siteId, level, @class, function, null, message, args);
        }

        public void Log(int siteId, Shared.LogLevel level, object @class, LogFunction function, Exception exception, string message, params object[] args)
        {
            Log log = new Log();

            log.SiteId = siteId;
            if (log.SiteId == -1)
            {
                var alias = _tenantManager.GetAlias();
                if (alias != null)
                {
                    log.SiteId = alias.SiteId;
                }
            }

            log.PageId = null;
            log.ModuleId = null;
            log.UserId = null;
            User user = _userPermissions.GetUser();
            if (user != null)
            {
                log.UserId = user.UserId;
            }
            log.Url = "";
            if (_accessor.HttpContext != null)
            {
                HttpRequest request = _accessor.HttpContext.Request;
                if (request != null)
                {
                    log.Url = $"{request.Scheme}://{request.Host}{request.Path}{request.QueryString}";
                }
            }

            Type type = @class.GetType();
            if (type != null && type != typeof(string))
            {
                log.Category = type.AssemblyQualifiedName;
                log.Feature = Utilities.GetTypeNameLastSegment(log.Category, 0);
            }
            else
            {
                log.Category = @class.ToString();
                log.Feature = log.Category;
            }
            log.Function = Enum.GetName(typeof(LogFunction), function);
            log.Level = Enum.GetName(typeof(Shared.LogLevel), level);
            if (exception != null)
            {
                log.Exception = exception.ToString();
            }
            log.Message = message;
            log.MessageTemplate = "";
            try
            {
                log.Properties = JsonSerializer.Serialize(args);
            }
            catch // serialization error occurred
            {
                log.Properties = "";
            }
            Log(log);
        }

        public void Log(Log log)
        {
            var minlevel = Shared.LogLevel.Information;
            var section = _config.GetSection("Logging:LogLevel:Default");
            if (section.Exists())
            {
                minlevel = Enum.Parse<Shared.LogLevel>(section.Value);
            }

            if (Enum.Parse<Shared.LogLevel>(log.Level) >= minlevel)
            {
                log.LogDate = DateTime.UtcNow;
                log.Server = Environment.MachineName;
                log.MessageTemplate = log.Message;
                log = ProcessStructuredLog(log);
                try
                {
                    if (log.SiteId != -1)
                    {
                        _logs.AddLog(log);
                        SendNotification(log);
                    }
                    else // use file logger as fallback when site cannot be determined
                    {
                        _filelogger.Log(GetLogLevel(log.Level), "[" + log.Category + "] " + log.Message);
                    }
                }
                catch
                {
                    // an error occurred writing the log
                }
            }
        }

        private Log ProcessStructuredLog(Log log)
        {
            try
            {
                string message = log.Message;
                string properties = "";
                if (!string.IsNullOrEmpty(message) && message.Contains("{") && message.Contains("}") && !string.IsNullOrEmpty(log.Properties))
                {
                    // get the named holes in the message and replace values
                    object[] values = JsonSerializer.Deserialize<object[]>(log.Properties);
                    List<string> names = new List<string>();
                    int index = message.IndexOf("{");
                    while (index != -1)
                    {
                        if (message.IndexOf("}", index) != -1)
                        {
                            names.Add(message.Substring(index + 1, message.IndexOf("}", index) - index - 1));
                            if (values.Length > (names.Count - 1))
                            {
                                var value = (values[names.Count - 1] == null) ? "null" : values[names.Count - 1].ToString();
                                message = message.Replace("{" + names[names.Count - 1] + "}", value);
                            }
                        }
                        index = (index < message.Length - 1) ? message.IndexOf("{", index + 1) : -1;
                    }
                    // rebuild properties into dictionary
                    Dictionary<string, object> propertyDictionary = new Dictionary<string, object>();
                    for (int i = 0; i < values.Length; i++)
                    {
                        if (i < names.Count)
                        {
                            propertyDictionary.Add(names[i], values[i]);
                        }
                        else
                        {
                            propertyDictionary.Add("Property" + i.ToString(), values[i]);
                        }
                    }
                    properties = JsonSerializer.Serialize(propertyDictionary);
                }
                log.Message = message;
                log.Properties = properties;
            }
            catch
            {
                log.Properties = "";
            }
            return log;
        }

        private void SendNotification(Log log)
        {
            Shared.LogLevel notifylevel = Shared.LogLevel.Error;
            var section = _config.GetSection("Logging:LogLevel:Notify");
            if (section.Exists())
            {
                notifylevel = Enum.Parse<Shared.LogLevel>(section.Value);
            }
            if (Enum.Parse<Shared.LogLevel>(log.Level) >= notifylevel)
            {
                var subject = $"Site {log.Level} Notification";
                string body = $"Log Message: {log.Message}";

                var alias = _tenantManager.GetAlias();
                if (alias != null)
                {
                    subject = $"{alias.Name} Site {log.Level} Notification";
                    body = $"Log Message: {log.Message}<br /><br />Please visit {alias.Protocol}{alias.Name}/admin/log?id={log.LogId} for more information";
                }

                foreach (var userrole in _userRoles.GetUserRoles(RoleNames.Host, log.SiteId.Value))
                {
                    var notification = new Notification(log.SiteId.Value, userrole.User, subject, body);
                    _notifications.AddNotification(notification);
                }
            }
        }

        private Microsoft.Extensions.Logging.LogLevel GetLogLevel(string level)
        {
            switch (Enum.Parse<Shared.LogLevel>(level))
            {
                case Shared.LogLevel.Trace:
                    return Microsoft.Extensions.Logging.LogLevel.Trace;
                case Shared.LogLevel.Debug:
                    return Microsoft.Extensions.Logging.LogLevel.Debug;
                case Shared.LogLevel.Information:
                    return Microsoft.Extensions.Logging.LogLevel.Information;
                case Shared.LogLevel.Warning:
                    return Microsoft.Extensions.Logging.LogLevel.Warning;
                case Shared.LogLevel.Error:
                    return Microsoft.Extensions.Logging.LogLevel.Error;
                case Shared.LogLevel.Critical:
                    return Microsoft.Extensions.Logging.LogLevel.Critical;
                default:
                    return Microsoft.Extensions.Logging.LogLevel.None;
            }
        }
    }
}