Added support for post-write file events

jackbrookes · jackbrookes · commit e1318d8563e5 · 2018-08-07T11:06:18.000+01:00
diff --git a/Assets/UXF/Prefabs/[UXF_Rig].prefab b/Assets/UXF/Prefabs/[UXF_Rig].prefab
@@ -2673,7 +2673,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 62bd92b5564a1d343b07363d3453a980, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
-  debug: 1
+  debug: 0
 --- !u!114 &114344481789201668
 MonoBehaviour:
   m_ObjectHideFlags: 1
diff --git a/Assets/UXF/Scripts/Etc/Events.cs b/Assets/UXF/Scripts/Etc/Events.cs
@@ -1,4 +1,5 @@
 using System;
+using System.IO;
 using UnityEngine;
 using UnityEngine.Events;
 
@@ -23,5 +24,35 @@ public class TrialEvent : UnityEvent<Trial>
 
     }
 
+    /// <summary>
+    /// Event containing a WriteFileInfo object as a parameter
+    /// </summary>
+    [Serializable]
+    public class WriteFileEvent : UnityEvent<WriteFileInfo>
+    {
+
+    }
+
+
+    public struct WriteFileInfo
+    {
+        public WriteFileType fileType;
+        public string basePath;
+        public string[] paths;
+        public string RelativePath { get { return Extensions.CombinePaths("", paths); }}
+        public string FullPath { get { return Extensions.CombinePaths(basePath, paths); } }
+        public WriteFileInfo(WriteFileType fileType, string basePath, params string[] paths)
+        {
+            this.fileType = fileType;
+            this.basePath = basePath;
+            this.paths = paths;
+        }
+
+    }
+
+    public enum WriteFileType
+    {
+        Test, Trials, Tracker, Dictionary, ParticipantList, Log
+    }
 
 }
diff --git a/Assets/UXF/Scripts/FileIOManager.cs b/Assets/UXF/Scripts/FileIOManager.cs
@@ -22,22 +22,30 @@ public class FileIOManager : MonoBehaviour
         [Tooltip("Enable to print debug messages to the console.")]
         public bool debug = false;
 
+        /// <summary>
+        /// Event(s) to trigger when we write a file. Not performed in amin thread so cannot include most Unity actions.
+        /// </summary>
+        /// <returns></returns>
+        [Tooltip("Event(s) to trigger when we write a file. Not performed in amin thread so cannot include most Unity actions.")]
+        public WriteFileEvent onWriteFile = new WriteFileEvent();
+
         /// <summary>
         /// Queue of actions which gets emptied on each frame in the main thread.
         /// </summary>
         public readonly Queue<System.Action> executeOnMainThreadQueue = new Queue<System.Action>();
 
-        BlockingQueue<System.Action> bq = new BlockingQueue<System.Action>();
-        Thread t;
-
-        bool quitting = false;
-        
         /// <summary>
         /// An action which does nothing. Useful if a method requires an Action
         /// </summary>
         /// <returns></returns>
         public static System.Action doNothing = () => { };
 
+        BlockingQueue<System.Action> bq = new BlockingQueue<System.Action>();
+        Thread t;
+
+        bool quitting = false;
+        
+
         void Awake()
         {
             Begin();
@@ -160,10 +168,11 @@ public void ReadJSON(string fpath, System.Action<Dictionary<string, object>> cal
         /// </summary>
         /// <param name="destFileName"></param>
         /// <param name="serializableObject"></param>
-        public void WriteJson(string destFileName, object serializableObject)
+        public void WriteJson(object serializableObject, WriteFileInfo writeFileInfo)
         {            
             string ppJson = MiniJSON.Json.Serialize(serializableObject);
-            File.WriteAllText(destFileName, ppJson);
+            File.WriteAllText(writeFileInfo.FullPath, ppJson);
+            onWriteFile.Invoke(writeFileInfo);
         }
 
         /// <summary>
@@ -172,7 +181,7 @@ public void WriteJson(string destFileName, object serializableObject)
         /// <param name="dataDict"></param>
         /// <param name="headers"></param>
         /// <param name="fpath"></param>
-        public void WriteTrials(List<OrderedResultDict> dataDict, string[] headers, string fpath)
+        public void WriteTrials(List<OrderedResultDict> dataDict, string[] headers, WriteFileInfo writeFileInfo)
         {
             string[] csvRows = new string[dataDict.Count + 1];
             csvRows[0] = string.Join(",", headers.ToArray());
@@ -188,23 +197,25 @@ public void WriteTrials(List<OrderedResultDict> dataDict, string[] headers, stri
                 }
             }
 
-            File.WriteAllLines(fpath, csvRows);
+            File.WriteAllLines(writeFileInfo.FullPath, csvRows);
+            onWriteFile.Invoke(writeFileInfo);
         }
 
         /// <summary>
         /// Writes a list of string arrays with a given header to a file at given path.
         /// </summary>
-        /// <param name="header"></param>
+        /// <param name="header">Row of headers</param>
         /// <param name="data"></param>
         /// <param name="fpath"></param>
-        public void WriteCSV(string[] header, IList<string[]> data, string fpath)
+        public void WriteCSV(string[] header, IList<string[]> data, WriteFileInfo writeFileInfo)
         {
             string[] csvRows = new string[data.Count + 1];
             csvRows[0] = string.Join(",", header);
             for (int i = 1; i <= data.Count; i++)
                 csvRows[i] = string.Join(",", data[i-1]);
 
-            File.WriteAllLines(fpath, csvRows);
+            File.WriteAllLines(writeFileInfo.FullPath, csvRows);
+            onWriteFile.Invoke(writeFileInfo);
         }
 
         /// <summary>
@@ -221,7 +232,7 @@ public void ReadCSV(string fpath, System.Action<DataTable> callback)
             }
             catch (FileNotFoundException)
             {
-
+                Debug.LogErrorFormat("Cannot find file {0}", fpath);
             }
 
             System.Action action = new System.Action(() => callback.Invoke(data));
@@ -233,11 +244,12 @@ public void ReadCSV(string fpath, System.Action<DataTable> callback)
         /// </summary>
         /// <param name="data"></param>
         /// <param name="fpath"></param>
-        public void WriteCSV(DataTable data, string fpath)
+        public void WriteCSV(DataTable data, WriteFileInfo writeFileInfo)
         {
-            var writer = new CSVFile.CSVWriter(fpath);
+            var writer = new CSVFile.CSVWriter(writeFileInfo.FullPath);
             writer.Write(data, true);
             writer.Dispose();
+            onWriteFile.Invoke(writeFileInfo);
         }
 
         /// <summary>
@@ -257,7 +269,7 @@ void OnDestroy()
         } 
 
         /// <summary>
-        /// Aborts the FileIOManager's thread.
+        /// Aborts the FileIOManager's thread and joins the thread to the calling thread.
         /// </summary>
         public void End()
         {
diff --git a/Assets/UXF/Scripts/Session.cs b/Assets/UXF/Scripts/Session.cs
@@ -22,7 +22,7 @@ public class Session : MonoBehaviour
         /// </summary>
         [Tooltip("Enable to automatically safely end the session when this object is destroyed (or the application stops running).")]
         public bool endOnDestroy = true;
-        
+
         /// <summary>
         /// List of blocks for this experiment
         /// </summary>
@@ -71,6 +71,7 @@ public class Session : MonoBehaviour
         [Tooltip("Event(s) to trigger when a trial ends. Can pass the instance of the Trial as a dynamic argument")]
         public TrialEvent onTrialEnd = new TrialEvent();
 
+
         [Header("Session information")]
 
         [ReadOnly]
@@ -171,7 +172,11 @@ public class Session : MonoBehaviour
 
         List<string> baseHeaders = new List<string> { "experiment", "ppid", "session_num", "trial_num", "block_num", "trial_num_in_block", "start_time", "end_time" };
 
-        string basePath;
+        /// <summary>
+        /// The path in which the experiment data are stored.
+        /// </summary>
+        /// <value></value>
+        public string basePath { get; private set; }
 
 
         /// <summary>
@@ -187,7 +192,11 @@ public class Session : MonoBehaviour
         /// </summary>
         public string path { get { return Path.Combine(ppPath, folderName); } }
 
-        private string folderName { get { return SessionNumToName(number); } }
+        /// <summary>
+        /// Name of the Session folder 
+        /// </summary>
+        /// <returns></returns>
+        public string folderName { get { return SessionNumToName(number); } }
 
 
         /// <summary>
@@ -198,7 +207,7 @@ public class Session : MonoBehaviour
         /// <summary>
         /// Stores combined list of headers for the behavioural output.
         /// </summary>
-        public List<string> headers { get { return baseHeaders.Concat(settingsToLog).Concat(customHeaders).Concat(trackingHeaders).ToList(); }}
+        public List<string> headers { get { return baseHeaders.Concat(settingsToLog).Concat(customHeaders).Concat(trackingHeaders).ToList(); } }
 
         /// <summary>
         /// Dictionary of objects for datapoints collected via the UI, or otherwise.
@@ -235,7 +244,7 @@ void InitFolder()
             if (!System.IO.Directory.Exists(ppPath))
                 System.IO.Directory.CreateDirectory(ppPath);
             if (System.IO.Directory.Exists(path))
-                Debug.LogWarning("Warning: Session already exists! Continuing will overwrite"); 
+                Debug.LogWarning("Warning: Session already exists! Continuing will overwrite");
             else
                 System.IO.Directory.CreateDirectory(path);
         }
@@ -248,16 +257,22 @@ void InitFolder()
         public string SaveTrackerData(Tracker tracker)
         {
             string fname = string.Format("{0}_{1}_T{2:000}.csv", tracker.objectName, tracker.measurementDescriptor, currentTrialNum);
-            string fpath = Path.Combine(path, fname);
+
+            WriteFileInfo fileInfo = new WriteFileInfo(
+                WriteFileType.Tracker,
+                this.basePath,
+                experimentName,
+                ppid,
+                folderName,
+                fname
+                );
 
             List<string[]> dataCopy = tracker.GetDataCopy();
 
-            fileIOManager.ManageInWorker(() => fileIOManager.WriteCSV(tracker.header, dataCopy, fpath));
+            fileIOManager.ManageInWorker(() => fileIOManager.WriteCSV(tracker.header, dataCopy, fileInfo));
 
             // return relative path so it can be stored in behavioural data
-            Uri fullPath = new Uri(fpath);
-            Uri basePath = new Uri(experimentPath);
-            return basePath.MakeRelativeUri(fullPath).ToString();
+            return fileInfo.RelativePath;
 
         }
 
@@ -279,11 +294,21 @@ public void CopyFileToSessionFolder(string filePath)
         /// <param name="objectName">Name of the object (is used for file name)</param>
         public void WriteDictToSessionFolder(Dictionary<string, object> dict, string objectName)
         {
+
             if (hasInitialised)
             {
                 string fileName = string.Format("{0}.json", objectName);
-                string filePath = Path.Combine(path, fileName);
-                fileIOManager.ManageInWorker(() => fileIOManager.WriteJson(filePath, dict));
+
+                WriteFileInfo fileInfo = new WriteFileInfo(
+                    WriteFileType.Dictionary,
+                    this.basePath,
+                    experimentName,
+                    ppid,
+                    folderName,
+                    fileName
+                );
+
+                fileIOManager.ManageInWorker(() => fileIOManager.WriteJson(dict, fileInfo));
             }
             else
             {
@@ -345,7 +370,7 @@ public void Begin(string experimentName, string participantId, string baseFolder
             onSessionBegin.Invoke(this);
 
             // copy Settings to session folder
-            
+
             WriteDictToSessionFolder(
                 new Dictionary<string, object>(settings.baseDict), // makes a copy
                 "settings");
@@ -369,13 +394,13 @@ public Block CreateBlock()
         public Block CreateBlock(int numberOfTrials)
         {
             if (numberOfTrials > 0)
-                return new Block((uint) numberOfTrials, this);
+                return new Block((uint)numberOfTrials, this);
             else
                 throw new Exception("Invalid number of trials supplied");
         }
 
         /// <summary>
-        /// Get currently active trial.
+        /// Get currently active trial. When not in a trial, gets previous trial.
         /// </summary>
         /// <returns>Currently active trial.</returns>
         public Trial GetTrial()
@@ -437,7 +462,7 @@ public void BeginNextTrial()
         Trial PrevTrial()
         {
             try
-            { 
+            {
                 // non zero indexed
                 return trials.ToList()[currentTrialNum - 2];
             }
@@ -463,7 +488,7 @@ Trial FirstTrial()
         /// <returns></returns>
         Trial LastTrial()
         {
-            var lastBlock = blocks[blocks.Count- 1];
+            var lastBlock = blocks[blocks.Count - 1];
             return lastBlock.trials[lastBlock.trials.Count - 1];
         }
 
@@ -500,7 +525,7 @@ public void End()
                 // end logger
                 if (logger != null)
                     logger.Finalise();
-                
+
                 blocks = new List<Block>();
                 _hasInitialised = false;
             }
@@ -510,10 +535,18 @@ void SaveResults()
         {
             List<OrderedResultDict> results = trials.Select(t => t.result).ToList();
             string fileName = "trial_results.csv";
-            string filePath = Path.Combine(path, fileName);
+
+            WriteFileInfo fileInfo = new WriteFileInfo(
+                WriteFileType.Trials,
+                this.basePath,
+                experimentName,
+                ppid,
+                folderName,
+                fileName
+                );
 
             // in this case, write in main thread to block aborting
-            fileIOManager.ManageInWorker(() => fileIOManager.WriteTrials(results, headers.ToArray(), filePath));
+            fileIOManager.ManageInWorker(() => fileIOManager.WriteTrials(results, headers.ToArray(), fileInfo));
         }
 
 
@@ -534,7 +567,7 @@ void OnDestroy()
                 End();
             }
         }
-        
+
         /// <summary>
         /// Convert a session number to a session name
         /// </summary>
@@ -551,7 +584,7 @@ public static string SessionNumToName(int num)
     /// Exception thrown in cases where we try to access a trial that does not exist.
     /// </summary>
     public class NoSuchTrialException : Exception
-    {   
+    {
         public NoSuchTrialException()
         {
         }
diff --git a/Assets/UXF/Scripts/SessionLogger.cs b/Assets/UXF/Scripts/SessionLogger.cs
@@ -69,8 +69,16 @@ void HandleLog(string logString, string stackTrace, LogType type)
         /// </summary>
         public void Finalise()
 		{
-			string filepath = Path.Combine(session.path, "log.csv");
-			fileIOManager.ManageInWorker(() => fileIOManager.WriteCSV(table, filepath));
+            WriteFileInfo fileInfo = new WriteFileInfo(
+                WriteFileType.Log,
+                session.basePath,
+                session.experimentName,
+                session.ppid,
+                session.folderName,
+                "log.csv"
+                );
+
+			fileIOManager.ManageInWorker(() => fileIOManager.WriteCSV(table, fileInfo));
             Application.logMessageReceived -= HandleLog;
         }
 
diff --git a/Assets/UXF/Scripts/Tests/Editor/TestFileIOManager.cs b/Assets/UXF/Scripts/Tests/Editor/TestFileIOManager.cs
diff --git a/Assets/UXF/Scripts/UI/ParticipantListSelection.cs b/Assets/UXF/Scripts/UI/ParticipantListSelection.cs
