* Establish InventoryArchiveSaved event for unit tests

* This is done on the inventory archiver module directly rather than Scene.EventManager - the module seems the more appropriate location

3 files changed, 67 insertions, 32 deletions

diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
index d916eba..456831d 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
@@ -45,9 +45,9 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);      
         
         protected TarArchiveWriter archive = new TarArchiveWriter();
-        protected CommunicationsManager commsManager;
         protected Dictionary<UUID, int> assetUuids = new Dictionary<UUID, int>();
         
+        private InventoryArchiverModule m_module;
         private CachedUserInfo m_userInfo;
         private string m_invPath;
         
@@ -60,12 +60,12 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// Constructor
         /// </summary>        
         public InventoryArchiveWriteRequest(
-            CachedUserInfo userInfo, string invPath, string savePath, CommunicationsManager commsManager)
+            InventoryArchiverModule module, CachedUserInfo userInfo, string invPath, string savePath)
             : this(
+                module,
                 userInfo,
                 invPath, 
-                new GZipStream(new FileStream(savePath, FileMode.Create), CompressionMode.Compress),
-                commsManager)
+                new GZipStream(new FileStream(savePath, FileMode.Create), CompressionMode.Compress))
         {
         }
         
@@ -73,19 +73,33 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// Constructor
         /// </summary>        
         public InventoryArchiveWriteRequest(
-             CachedUserInfo userInfo, string invPath, Stream saveStream, CommunicationsManager commsManager)
+            InventoryArchiverModule module, CachedUserInfo userInfo, string invPath, Stream saveStream)
         {
+            m_module = module;
             m_userInfo = userInfo;
             m_invPath = invPath;
-            m_saveStream = saveStream;                        
-            this.commsManager = commsManager;
+            m_saveStream = saveStream;             
         }
 
         protected void ReceivedAllAssets(IDictionary<UUID, AssetBase> assetsFound, ICollection<UUID> assetsNotFoundUuids)
         {
             AssetsArchiver assetsArchiver = new AssetsArchiver(assetsFound);
             assetsArchiver.Archive(archive);
-            archive.WriteTar(m_saveStream);
+            
+            Exception reportedException = null;
+            bool succeeded = true;
+            
+            try
+            {
+                archive.WriteTar(m_saveStream);
+            } 
+            catch (IOException e)
+            {
+                reportedException = e;
+                succeeded = false;
+            }
+                   
+            m_module.TriggerInventoryArchiveSaved(succeeded, m_userInfo, m_invPath, m_saveStream, reportedException);          
         }
 
         protected void saveInvItem(InventoryItemBase inventoryItem, string path)
@@ -115,9 +129,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             writer.WriteString(inventoryItem.Owner.ToString());
             writer.WriteEndElement();
             writer.WriteStartElement("Description");
-            if (inventoryItem.Description.Length > 0)
-                writer.WriteString(inventoryItem.Description);
-            else writer.WriteString("No Description");
+            writer.WriteString(inventoryItem.Description);
             writer.WriteEndElement();
             writer.WriteStartElement("AssetType");
             writer.WriteString(inventoryItem.AssetType.ToString());
@@ -191,7 +203,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 //
                 // FIXME: FetchInventory should probably be assumed to by async anyway, since even standalones might
                 // use a remote inventory service, though this is vanishingly rare at the moment.
-                if (null == commsManager.UserAdminService)
+                if (null == m_module.CommsManager.UserAdminService)
                 {
                     m_log.ErrorFormat(
                         "[INVENTORY ARCHIVER]: Have not yet received inventory info for user {0} {1}",
@@ -242,7 +254,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 }
                 else
                 {
-                    m_log.InfoFormat(
+                    m_log.DebugFormat(
                         "[INVENTORY ARCHIVER]: Found item {0} {1} at {2}", 
                         inventoryItem.Name, inventoryItem.ID, m_invPath);
                     
@@ -252,7 +264,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             }
             else
             {
-                m_log.InfoFormat(
+                m_log.DebugFormat(
                     "[INVENTORY ARCHIVER]: Found folder {0} {1} at {2}", 
                     inventoryFolder.Name, inventoryFolder.ID, m_invPath);
                 
@@ -260,7 +272,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 saveInvDir(inventoryFolder, "");
             }
 
-            new AssetsRequest(assetUuids.Keys, commsManager.AssetCache, ReceivedAllAssets).Execute();
+            new AssetsRequest(assetUuids.Keys, m_module.CommsManager.AssetCache, ReceivedAllAssets).Execute();
         }
     }
 }
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiverModule.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiverModule.cs
index 786cbeb..1997562 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiverModule.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiverModule.cs
@@ -25,6 +25,7 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Reflection;
@@ -38,7 +39,7 @@ using OpenSim.Region.Framework.Interfaces;
 using OpenSim.Region.Framework.Scenes;
 
 namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
-{      
+{          
     /// <summary>
     /// This module loads and saves OpenSimulator inventory archives
     /// </summary>    
@@ -50,10 +51,12 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         
         public bool IsSharedModule { get { return true; } }
         
+        public event InventoryArchiveSaved OnInventoryArchiveSaved;        
+        
         /// <summary>
         /// The file to load and save inventory if no filename has been specified
         /// </summary>
-        protected const string DEFAULT_INV_BACKUP_FILENAME = "user-inventory_iar.tar.gz";        
+        protected const string DEFAULT_INV_BACKUP_FILENAME = "user-inventory_iar.tar.gz";               
         
         /// <value>
         /// All scenes that this module knows about
@@ -63,14 +66,14 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// <value>
         /// The comms manager we will use for all comms requests
         /// </value>
-        private CommunicationsManager m_commsManager;
+        protected internal CommunicationsManager CommsManager;
 
         public void Initialise(Scene scene, IConfigSource source)
         {            
             if (m_scenes.Count == 0)
             {
                 scene.RegisterModuleInterface<IInventoryArchiverModule>(this);
-                m_commsManager = scene.CommsManager;                                
+                CommsManager = scene.CommsManager;                                
                 
                 scene.AddCommand(
                     this, "load iar",
@@ -89,6 +92,17 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         public void PostInitialise() {}
 
         public void Close() {}
+        
+        /// <summary>
+        /// Trigger the inventory archive saved event.
+        /// </summary>
+        protected internal void TriggerInventoryArchiveSaved(
+            bool succeeded, CachedUserInfo userInfo, string invPath, Stream saveStream, Exception reportedException)
+        {
+            InventoryArchiveSaved handlerInventoryArchiveSaved = OnInventoryArchiveSaved;
+            if (handlerInventoryArchiveSaved != null)
+                handlerInventoryArchiveSaved(succeeded, userInfo, invPath, saveStream, reportedException);
+        }
                
         public void DearchiveInventory(string firstName, string lastName, string invPath, Stream loadStream)
         {
@@ -99,7 +113,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 if (userInfo != null)
                 {
                     InventoryArchiveReadRequest request = 
-                        new InventoryArchiveReadRequest(userInfo, invPath, loadStream, m_commsManager);                
+                        new InventoryArchiveReadRequest(userInfo, invPath, loadStream, CommsManager);                
                     UpdateClientWithLoadedNodes(userInfo, request.Execute());
                 }
             }            
@@ -112,7 +126,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 CachedUserInfo userInfo = GetUserInfo(firstName, lastName);
 
                 if (userInfo != null)
-                    new InventoryArchiveWriteRequest(userInfo, invPath, saveStream, m_commsManager).Execute();
+                    new InventoryArchiveWriteRequest(this, userInfo, invPath, saveStream).Execute();
             }              
         }
         
@@ -125,7 +139,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 if (userInfo != null)
                 {
                     InventoryArchiveReadRequest request = 
-                        new InventoryArchiveReadRequest(userInfo, invPath, loadPath, m_commsManager);                
+                        new InventoryArchiveReadRequest(userInfo, invPath, loadPath, CommsManager);                
                     UpdateClientWithLoadedNodes(userInfo, request.Execute());
                 }
             }                
@@ -138,7 +152,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 CachedUserInfo userInfo = GetUserInfo(firstName, lastName);
                 
                 if (userInfo != null)
-                    new InventoryArchiveWriteRequest(userInfo, invPath, savePath, m_commsManager).Execute();
+                    new InventoryArchiveWriteRequest(this, userInfo, invPath, savePath).Execute();
             }            
         }                
         
@@ -208,7 +222,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// <returns></returns>
         protected CachedUserInfo GetUserInfo(string firstName, string lastName)
         {
-            UserProfileData userProfile = m_commsManager.UserService.GetUserProfile(firstName, lastName);
+            UserProfileData userProfile = CommsManager.UserService.GetUserProfile(firstName, lastName);
             
             if (null == userProfile)
             {
@@ -216,7 +230,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 return null;
             }
 
-            CachedUserInfo userInfo = m_commsManager.UserProfileCacheService.GetUserDetails(userProfile.ID);
+            CachedUserInfo userInfo = CommsManager.UserProfileCacheService.GetUserDetails(userProfile.ID);
             if (null == userInfo)
             {
                 m_log.ErrorFormat(
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
index bc5e564..d1956b4 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
@@ -26,7 +26,9 @@
  */
 
 using System;
+using System.IO;
 using System.Text;
+using System.Threading;
 using NUnit.Framework;
 using OpenMetaverse;
 using OpenSim.Data;
@@ -42,10 +44,18 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
     [TestFixture]
     public class InventoryArchiverTests
     {
+        private EventWaitHandle m_waitHandle = new AutoResetEvent(false);
+        
+        private void SaveCompleted(
+            bool succeeded, CachedUserInfo userInfo, string invPath, Stream saveStream, Exception reportedException)
+        {
+            m_waitHandle.Set();
+        }
+        
         /// <summary>
         /// Test saving a V0.1 OpenSim Inventory Archive (subject to change since there is no fixed format yet).
         /// </summary>
-        [Test]        
+        [Test]
         public void TestSaveIarV0p1()
         {        
             //log4net.Config.XmlConfigurator.Configure();
@@ -94,16 +104,15 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
             item1.Name = "My Little Dog";
             item1.AssetID = asset1.FullID;
             item1.Folder = userInfo.RootFolder.FindFolderByPath("Objects").ID;            
-            scene.AddInventoryItem(userId, item1);
-            
-            /*
+            scene.AddInventoryItem(userId, item1);            
             
             MemoryStream archiveWriteStream = new MemoryStream();
-            
-            scene.EventManager.OnOarFileSaved += SaveCompleted;
-            archiverModule.ArchiveRegion(archiveWriteStream);            
+            archiverModule.OnInventoryArchiveSaved += SaveCompleted;                
+             
+            archiverModule.ArchiveInventory(userFirstName, userLastName, "Objects", archiveWriteStream);            
             m_waitHandle.WaitOne(60000, true);
 
+            /*
             byte[] archive = archiveWriteStream.ToArray();           
             MemoryStream archiveReadStream = new MemoryStream(archive);
             TarArchiveReader tar = new TarArchiveReader(archiveReadStream);