Feature #14: Device Details

Initial Commit - LAN/WAN MAC Addresses
2013-09-12 13:39:39 +10:00
parent 75ebfdaa80
commit 2e820cd720
20 changed files with 474 additions and 24 deletions
@@ -0,0 +1,123 @@
+using Disco.BI.Extensions;
+using Disco.Data.Repository;
+using Disco.Services.Logging;
+using Disco.Services.Tasks;
+using Quartz;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Disco.BI.DeviceBI.Migration
+{
+    public class LogMacAddressImporting : ScheduledTask
+    {
+        public override string TaskName { get { return "Migration: Logs to Device Mac Address Details"; } }
+
+        public override bool SingleInstanceTask { get { return true; } }
+        public override bool CancelInitiallySupported { get { return false; } }
+
+        #region Required Helpers
+        private static string RequiredFilePath(DiscoDataContext dbContext)
+        {
+            if (dbContext.DiscoConfiguration.DataStoreLocation != null)
+                return System.IO.Path.Combine(dbContext.DiscoConfiguration.DataStoreLocation, "_LogMacAddressImportingRequired.txt");
+            else
+                return null;
+        }
+
+        public static bool IsRequired(DiscoDataContext dbContext)
+        {
+            var requiredFilePath = RequiredFilePath(dbContext);
+
+            if (requiredFilePath == null)
+                return false;
+            else
+                return System.IO.File.Exists(requiredFilePath);
+        }
+        public static void SetRequired(DiscoDataContext dbContext)
+        {
+            var requiredFilePath = RequiredFilePath(dbContext);
+
+            if (requiredFilePath != null)
+            {
+                System.IO.File.WriteAllText(requiredFilePath, "This file exists to indicate an Importing of Mac Address from the Disco Logs is required. It will automatically be deleted when the import completes.");
+                System.IO.File.SetAttributes(requiredFilePath, System.IO.FileAttributes.Hidden);
+            }
+            // ELSE: Could never be required if no DataStoreLocation is set (no logs to process)
+        }
+        #endregion
+
+        public override void InitalizeScheduledTask(DiscoDataContext dbContext)
+        {
+            if (IsRequired(dbContext))
+            {
+                // Schedule in 15mins
+                var trigger = TriggerBuilder.Create()
+                    .StartAt(DateTimeOffset.Now.AddMinutes(15));
+
+                this.ScheduleTask(trigger);
+            }
+        }
+
+        public static ScheduledTaskStatus ScheduleImmediately()
+        {
+            var existingTask = ScheduledTasks.GetTaskStatuses(typeof(LogMacAddressImporting)).Where(s => s.IsRunning).FirstOrDefault();
+            if (existingTask != null)
+                return existingTask;
+
+            var instance = new LogMacAddressImporting();
+            return instance.ScheduleTask();
+        }
+
+        protected override void ExecuteTask()
+        {
+            using (DiscoDataContext dbContext = new DiscoDataContext())
+            {
+                Status.UpdateStatus(0, "Importing MAC Addresses", "Querying Logs for Details");
+                // Load Logs
+                var logRetriever = new ReadLogContext()
+                {
+                    Module = DeviceBI.EnrolmentLog.Current.ModuleId,
+                    EventTypes = new List<int>() { (int)DeviceBI.EnrolmentLog.EventTypeIds.SessionDeviceInfo }
+                };
+                var results = logRetriever.Query(dbContext);
+
+                Status.UpdateStatus(50, string.Format("Passing {0} logs", results.Count));
+
+                Dictionary<string, Tuple<string, string>> addresses = new Dictionary<string, Tuple<string, string>>();
+
+                foreach (var result in results.OrderBy(r => r.Timestamp))
+                    addresses[((string)result.Arguments[1]).ToLower()] = new Tuple<string, string>((string)result.Arguments[4], (string)result.Arguments[5]);
+
+                Status.UpdateStatus(75, string.Format("Importing {0} details", addresses.Count));
+
+                var devices = dbContext.Devices.Include("DeviceDetails").ToList();
+
+                Tuple<string, string> addressResult;
+                foreach (var device in devices)
+                {
+                    if (addresses.TryGetValue(device.SerialNumber.ToLower(), out addressResult))
+                    {
+                        if (!string.IsNullOrEmpty(addressResult.Item1))
+                            device.DeviceDetails.LanMacAddress(device, addressResult.Item1);
+                        if (!string.IsNullOrEmpty(addressResult.Item2))
+                            device.DeviceDetails.WLanMacAddress(device, addressResult.Item2);
+                    }
+                }
+
+                Status.UpdateStatus(90, "Saving to Database");
+
+                dbContext.SaveChanges();
+
+                // Finished - Remove Placeholder File
+                var requiredFilePath = RequiredFilePath(dbContext);
+                if (System.IO.File.Exists(requiredFilePath))
+                    System.IO.File.Delete(requiredFilePath);
+            }
+        }
+
+
+    }
+}
@@ -10,7 +10,8 @@ namespace Disco.BI.DeviceBI
 {
    public static class Searching
    {
-        private static List<DeviceSearchResultItem> Search_SelectDeviceSearchResultItem(IQueryable<Device> Query, int? LimitCount = null){
+        private static List<DeviceSearchResultItem> Search_SelectDeviceSearchResultItem(IQueryable<Device> Query, int? LimitCount = null)
+        {
            if (LimitCount.HasValue)
                Query = Query.Take(LimitCount.Value);

@@ -28,15 +29,34 @@ namespace Disco.BI.DeviceBI
            }).ToList();
        }

-        public static List<DeviceSearchResultItem> Search(DiscoDataContext dbContext, string Term, int? LimitCount = null)
+        public static List<DeviceSearchResultItem> Search(DiscoDataContext dbContext, string Term, int? LimitCount = null, bool SearchDetails = false)
        {
-            return Search_SelectDeviceSearchResultItem(dbContext.Devices.Where(d =>
-                d.AssetNumber.Contains(Term) ||
-                d.ComputerName.Contains(Term) ||
-                d.SerialNumber.Contains(Term) ||
-                d.Location.Contains(Term) ||
-                Term.Contains(d.SerialNumber)
-                ), LimitCount);
+            IQueryable<Device> query;
+
+            query = null;
+
+            if (SearchDetails)
+            {
+                query = dbContext.Devices.Where(d =>
+                    d.AssetNumber.Contains(Term) ||
+                    d.ComputerName.Contains(Term) ||
+                    d.SerialNumber.Contains(Term) ||
+                    d.Location.Contains(Term) ||
+                    Term.Contains(d.SerialNumber) ||
+                    d.DeviceDetails.Any(dd => dd.Value.Contains(Term))
+                    );
+            }
+            else
+            {
+                query = dbContext.Devices.Where(d =>
+                    d.AssetNumber.Contains(Term) ||
+                    d.ComputerName.Contains(Term) ||
+                    d.SerialNumber.Contains(Term) ||
+                    d.Location.Contains(Term) ||
+                    Term.Contains(d.SerialNumber));
+            }
+            
+            return Search_SelectDeviceSearchResultItem(query, LimitCount);
        }

        public static List<DeviceSearchResultItem> SearchDeviceModel(DiscoDataContext dbContext, int DeviceModelId, int? LimitCount = null)
@@ -0,0 +1,109 @@
+using Disco.Models.Repository;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.CompilerServices;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Disco.BI.Extensions
+{
+    public static class DeviceDetailExtensions
+    {
+
+        #region Scope Declaration
+
+        public const string ScopeHardware = "Hardware";
+        
+        #endregion
+
+        #region Helpers
+        private static string GetDetail(this IEnumerable<DeviceDetail> details, string Scope, string Key)
+        {
+            if (details == null)
+                throw new ArgumentNullException("details");
+            if (string.IsNullOrEmpty(Scope))
+                throw new ArgumentNullException("Scope");
+            if (string.IsNullOrEmpty(Key))
+                throw new ArgumentNullException("Key");
+
+            var detail = details.Where(d => d.Key == Key).FirstOrDefault();
+
+            if (detail == null)
+                return null;
+            else
+                return detail.Value;
+        }
+
+        private static void SetDetail(this Device device, string Scope, string Key, string Value)
+        {
+            if (device == null)
+                throw new ArgumentNullException("device");
+            if (string.IsNullOrEmpty(Scope))
+                throw new ArgumentNullException("Scope");
+            if (string.IsNullOrEmpty(Key))
+                throw new ArgumentNullException("Key");
+
+            var detail = device.DeviceDetails.Where(d => d.Scope == Scope && d.Key == Key).FirstOrDefault();
+
+            // No Detail Stored & Set to Null
+            if (detail == null && Value == null)
+                return;
+
+            if (detail == null)
+            {
+                detail = new DeviceDetail()
+                {
+                    DeviceSerialNumber = device.SerialNumber,
+                    Scope = Scope,
+                    Key = Key,
+                    Value = Value
+                };
+                device.DeviceDetails.Add(detail);
+            }
+
+            if (detail.Value != Value)
+                detail.Value = Value;
+        } 
+        #endregion
+
+        #region LanMacAddress
+        public const string KeyLanMacAddress = "LanMacAddress";
+        /// <summary>
+        /// Gets the LanMacAddress Device Detail Value
+        /// </summary>
+        /// <returns>The LanMacAddress or null</returns>
+        public static string LanMacAddress(this IEnumerable<DeviceDetail> details)
+        {
+            return details.GetDetail(ScopeHardware, KeyLanMacAddress);
+        }
+        /// <summary>
+        /// Sets the LanMacAddress Device Detail Value
+        /// </summary>
+        public static void LanMacAddress(this IEnumerable<DeviceDetail> details, Device device, string LanMacAddress)
+        {
+            device.SetDetail(ScopeHardware, KeyLanMacAddress, LanMacAddress);
+        } 
+        #endregion
+
+        #region WLanMacAddress
+        public const string KeyWLanMacAddress = "WLanMacAddress";
+        /// <summary>
+        /// Gets the WLanMacAddress Device Detail Value
+        /// </summary>
+        /// <returns>The WLanMacAddress or null</returns>
+        public static string WLanMacAddress(this IEnumerable<DeviceDetail> details)
+        {
+            return details.GetDetail(ScopeHardware, KeyWLanMacAddress);
+        }
+        /// <summary>
+        /// Sets the WLanMacAddress Device Detail Value
+        /// </summary>
+        public static void WLanMacAddress(this IEnumerable<DeviceDetail> details, Device device, string WLanMacAddress)
+        {
+            device.SetDetail(ScopeHardware, KeyWLanMacAddress, WLanMacAddress);
+        } 
+        #endregion
+
+    }
+}
@@ -127,6 +127,7 @@
    <Compile Include="BI\DeviceBI\Importing\Import.cs" />
    <Compile Include="BI\DeviceBI\Importing\ImportParseTask.cs" />
    <Compile Include="BI\DeviceBI\Importing\ImportProcessTask.cs" />
+    <Compile Include="BI\DeviceBI\Migration\LogMacAddressImporting.cs" />
    <Compile Include="BI\DeviceBI\Searching.cs" />
    <Compile Include="BI\DisposableImageCollection.cs" />
    <Compile Include="BI\DocumentTemplateBI\DocumentTemplateQRCodeLocationCache.cs" />
@@ -146,6 +147,7 @@
    <Compile Include="BI\Extensions\DeviceActionExtensions.cs" />
    <Compile Include="BI\Extensions\DeviceBatchExtensions.cs" />
    <Compile Include="BI\Extensions\DeviceCertificateExtensions.cs" />
+    <Compile Include="BI\Extensions\DeviceDetailExtensions.cs" />
    <Compile Include="BI\Extensions\DeviceModelExtensions.cs" />
    <Compile Include="BI\Extensions\DeviceProfileExtensions.cs" />
    <Compile Include="BI\Extensions\JobActionExtensions.cs" />
@@ -256,7 +258,7 @@
  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
  <ProjectExtensions>
    <VisualStudio>
-      <UserProperties BuildVersion_StartDate="2011/7/1" BuildVersion_BuildAction="Both" BuildVersion_DetectChanges="False" BuildVersion_UseGlobalSettings="False" BuildVersion_BuildVersioningStyle="None.DeltaBaseYear.MonthAndDayStamp.TimeStamp" BuildVersion_UpdateAssemblyVersion="True" BuildVersion_UpdateFileVersion="True" />
+      <UserProperties BuildVersion_UpdateFileVersion="True" BuildVersion_UpdateAssemblyVersion="True" BuildVersion_BuildVersioningStyle="None.DeltaBaseYear.MonthAndDayStamp.TimeStamp" BuildVersion_UseGlobalSettings="False" BuildVersion_DetectChanges="False" BuildVersion_BuildAction="Both" BuildVersion_StartDate="2011/7/1" />
    </VisualStudio>
  </ProjectExtensions>
  <Import Project="$(SolutionDir)\.nuget\nuget.targets" />