Merge lp:~dangarner/xibo/client-164 into lp:xibo/1.6

[Dan Garner]

=== modified file 'client/dotNET/XiboTraceListener.cs'
--- client/dotNET/XiboTraceListener.cs	2013-09-28 14:00:01 +0000
+++ client/dotNET/XiboTraceListener.cs	2014-10-03 14:12:11 +0000
@@ -26,6 +26,8 @@
 using System.Collections.ObjectModel;
 using System.Windows.Forms;
 using System.Security;
+using System.Threading;
+using XiboClient.Properties;
 
 /// 17/02/12 Dan Changed to always Log audit if no category is given
 
@@ -33,11 +35,10 @@
 {
     class XiboTraceListener : TraceListener
     {
+        private static readonly Object _locker = new Object();
+
         private Collection<TraceMessage> _traceMessages;
-        private String _logPath;
-        private Boolean _xmdsProcessing;
-        private xmds.xmds _xmds;
-        private String _lastSubmit;
+        private string _logPath;
         private HardwareKey _hardwareKey;
 
         public XiboTraceListener()
@@ -47,60 +48,88 @@
 
         public XiboTraceListener(string r_strListenerName)
             : base(r_strListenerName)
-		{
-			InitializeListener() ;
-		}
+        {
+            InitializeListener();
+        }
 
         private void InitializeListener()
         {
             // Make a new collection of TraceMessages
             _traceMessages = new Collection<TraceMessage>();
-            _logPath = Application.UserAppDataPath + @"/" + Properties.Settings.Default.logLocation;
-
-            _xmdsProcessing = false;
-            _xmds = new xmds.xmds();
-
-            // Register a listener for the XMDS stats
-            _xmds.SubmitLogCompleted += new XiboClient.xmds.SubmitLogCompletedEventHandler(_xmds_SubmitLogCompleted);
+            _logPath = Settings.Default.LibraryPath + @"\" + Settings.Default.logLocation;
 
             // Get the key for this display
             _hardwareKey = new HardwareKey();
         }
 
+        /// <summary>
+        /// Get the LogType from a string
+        /// </summary>
+        /// <param name="category"></param>
+        /// <returns></returns>
+        private static LogType GetLogTypeFromString(string category)
+        {
+            LogType logType;
+
+            if (category == LogType.Audit.ToString())
+                logType = LogType.Audit;
+            else if (category == LogType.Error.ToString())
+                logType = LogType.Error;
+            else if (category == LogType.Info.ToString())
+                logType = LogType.Info;
+            else
+                logType = LogType.Audit;
+
+            return logType;
+        }
+
         private void AddToCollection(string message, string category)
         {
-            TraceMessage traceMessage;
-
-            traceMessage.category = category;
-            traceMessage.dateTime = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss");
-            traceMessage.message = message;
-
-            _traceMessages.Add(traceMessage);
+            if (Settings.Default.LogLevel == "off")
+                return;
+
+            LogType logtype = GetLogTypeFromString(category);
+
+            // Determine if we should log this or not.
+            if (Settings.Default.LogLevel == "error" && logtype != LogType.Error)
+                return;
+
+            if (Settings.Default.LogLevel == "info" && (logtype != LogType.Error && logtype != LogType.Info))
+                return;
+
+            _traceMessages.Add(new TraceMessage
+            {
+                category = category,
+                dateTime = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"),
+                message = message
+            });
+
+            // Flush if we have build up a backlog.
+            if (_traceMessages.Count > 25)
+                Flush();
         }
 
         private void FlushToFile()
         {
-            if (_traceMessages.Count < 1) return;
+            if (_traceMessages.Count < 1)
+                return;
 
             try
             {
                 // Open the Text Writer
-                StreamWriter tw = new StreamWriter(File.Open(_logPath, FileMode.Append, FileAccess.Write, FileShare.Read), Encoding.UTF8);
-
-                String theMessage;
-
-                foreach (TraceMessage message in _traceMessages)
+                using (StreamWriter tw = new StreamWriter(File.Open(string.Format("{0}_{1}", _logPath, DateTime.Now.ToFileTimeUtc().ToString()), FileMode.Append, FileAccess.Write, FileShare.Read), Encoding.UTF8))
                 {
-                    String traceMsg = message.message.ToString();
-
-                    theMessage = String.Format("<trace date=\"{0}\" category=\"{1}\">{2}</trace>", message.dateTime, message.category, traceMsg);
-                    tw.WriteLine(theMessage);
+                    string theMessage;
+
+                    foreach (TraceMessage message in _traceMessages)
+                    {
+                        string traceMsg = message.message.ToString();
+
+                        theMessage = string.Format("<trace date=\"{0}\" category=\"{1}\">{2}</trace>", message.dateTime, message.category, traceMsg);
+                        tw.WriteLine(theMessage);
+                    }
                 }
 
-                // Close the tw.
-                tw.Close();
-                tw.Dispose();
-
                 // Remove the messages we have just added
                 _traceMessages.Clear();
             }
@@ -117,84 +146,43 @@
         /// <summary>
         /// Flush the log to XMDS
         /// </summary>
-        private void FlushToXmds()
-        {
-            String log;
-
-            log = "<log>";
-
-            // Load the Stats collection into a string
-            try
-            {
-                foreach (TraceMessage traceMessage in _traceMessages)
-                {
-                    String traceMsg = traceMessage.message.ToString();
-
-                    if (!traceMsg.Contains("<message>"))
-                        traceMsg = SecurityElement.Escape(traceMsg);
-
-                    log += String.Format("<trace date=\"{0}\" category=\"{1}\">{2}</trace>", traceMessage.dateTime, traceMessage.category, traceMsg);
-                }
-            }
-            catch (Exception ex)
-            {
-                System.Diagnostics.Trace.WriteLine(new LogMessage("FlushToXmds", String.Format("Error converting stat to a string {0}", ex.Message)), LogType.Error.ToString());
-            }
-
-            log += "</log>";
-
-            // Store the stats as the last sent (so we have a record if it fails)
-            _lastSubmit = log;
-
-            // Clear the stats collection
-            _traceMessages.Clear();
-
-            // Submit the string to XMDS
-            _xmdsProcessing = true;
-
-            _xmds.SubmitLogAsync(Properties.Settings.Default.Version, Properties.Settings.Default.ServerKey, _hardwareKey.Key, log);
-        }
-
-        /// <summary>
-        /// Capture the XMDS call and see if it went well
-        /// </summary>
-        /// <param name="sender"></param>
-        /// <param name="e"></param>
-        void _xmds_SubmitLogCompleted(object sender, XiboClient.xmds.SubmitLogCompletedEventArgs e)
-        {
-            _xmdsProcessing = false;
-
-            // Test if we succeeded or not
-            if (e.Error != null)
-            {
-                // We had an error, log it.
-                System.Diagnostics.Trace.WriteLine(new LogMessage("_xmds_SubmitLogCompleted", String.Format("Error during Submit to XMDS {0}", e.Error.Message)), LogType.Error.ToString());
-
-                // Dump the stats to a file instead
-                if (_lastSubmit != "")
-                {
-                    try
+        public void ProcessQueueToXmds()
+        {
+            lock (_locker)
+            {
+                // Get a list of all the log files waiting to be sent to XMDS.
+                string[] logFiles = Directory.GetFiles(Settings.Default.LibraryPath, "*" + Settings.Default.logLocation + "*");
+
+                foreach (string fileName in logFiles)
+                {
+                    // If we have some, create an XMDS object
+                    using (xmds.xmds logtoXmds = new xmds.xmds())
                     {
-                        // Open the Text Writer
-                        StreamWriter tw = new StreamWriter(File.Open(_logPath, FileMode.Append, FileAccess.Write, FileShare.Read), Encoding.UTF8);
+                        logtoXmds.Url = Settings.Default.XiboClient_xmds_xmds;
+
+                        // construct the log message
+                        StringBuilder builder = new StringBuilder();
+                        builder.Append("<log>");
+
+                        foreach (string entry in File.ReadAllLines(fileName))
+                            builder.Append(entry);
+
+                        builder.Append("</log>");
 
                         try
                         {
-                            tw.Write(_lastSubmit);
+                            logtoXmds.SubmitLog(Settings.Default.Version, Settings.Default.ServerKey, _hardwareKey.Key, builder.ToString());
+
+                            // Delete the file we are on
+                            File.Delete(fileName);
                         }
-                        catch {}
-                        finally
+                        catch (Exception e)
                         {
-                            tw.Close();
-                            tw.Dispose();
+                            Trace.WriteLine(new LogMessage("FlushToXmds", string.Format("Exception when submitting to XMDS: {0}", e.Message)), LogType.Error.ToString());
                         }
                     }
-                    catch {}
                 }
             }
-
-            // Clear the last sumbit
-            _lastSubmit = "";
         }
 
         public override void Write(string message)
@@ -253,48 +241,33 @@
             AddToCollection(message, detailMessage);
         }
 
+        /// <summary>
+        /// Close the Trace Listener
+        /// </summary>
         public override void Close()
         {
             // Determine if there is anything to flush
-            if (_traceMessages.Count < 1) return;
-
-            // As we are closing if XMDS is already busy just log to file.
-            if (_xmdsProcessing)
-            {
-                FlushToFile();
-            }
-            else
-            {
-                int threshold = ((int)Properties.Settings.Default.collectInterval * 5);
-
-                // Determine where we want to log.
-                if (Properties.Settings.Default.XmdsLastConnection.AddSeconds(threshold) < DateTime.Now)
-                {
-                    FlushToFile();
-                }
-                else
-                {
-                    FlushToXmds();
-                }
-            }
+            if (_traceMessages.Count < 1)
+                return;
+
+            // Flush to file (we will send these next time we start up)
+            FlushToFile();
         }
 
+        /// <summary>
+        /// Flush the Listener
+        /// </summary>
         public override void Flush()
         {
             // Determine if there is anything to flush
-            if (_traceMessages.Count < 1 || _xmdsProcessing) return;
-
-            int threshold = ((int)Properties.Settings.Default.collectInterval * 5);
-
-            // Determine where we want to log.
-            if (Properties.Settings.Default.XmdsLastConnection.AddSeconds(threshold) < DateTime.Now)
-            {
-                FlushToFile();
-            }
-            else
-            {
-                FlushToXmds();
-            }
+            if (_traceMessages.Count < 1)
+                return;
+
+            FlushToFile();
+
+            // See if there are any records to flush to XMDS
+            Thread logSubmit = new Thread(new ThreadStart(ProcessQueueToXmds));
+            logSubmit.Start();
         }
     }