Merge branch 'master' into careminster-presence-refactor

4 files changed, 123 insertions, 78 deletions

diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
index b4f1ed6..9996074 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
@@ -100,18 +100,19 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             
             List<InventoryNodeBase> loadedNodes = new List<InventoryNodeBase>();
            
-            InventoryFolderBase rootDestinationFolder 
+            List<InventoryFolderBase> folderCandidates
                 = InventoryArchiveUtils.FindFolderByPath(
                     m_scene.InventoryService, m_userInfo.PrincipalID, m_invPath);
 
-            if (null == rootDestinationFolder)
+            if (folderCandidates.Count == 0)
             {
                 // Possibly provide an option later on to automatically create this folder if it does not exist
                 m_log.ErrorFormat("[INVENTORY ARCHIVER]: Inventory path {0} does not exist", m_invPath);
 
                 return loadedNodes;
             }
-
+            
+            InventoryFolderBase rootDestinationFolder = folderCandidates[0];
             archive = new TarArchiveReader(m_loadStream);
 
             // In order to load identically named folders, we need to keep track of the folders that we have already
@@ -188,7 +189,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// <summary>
         /// Replicate the inventory paths in the archive to the user's inventory as necessary.
         /// </summary>
-        /// <param name="archivePath">The item archive path to replicate</param>
+        /// <param name="iarPath">The item archive path to replicate</param>
         /// <param name="rootDestinationFolder">The root folder for the inventory load</param>
         /// <param name="resolvedFolders">
         /// The folders that we have resolved so far for a given archive path.  
@@ -199,24 +200,24 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// </param>
         /// <returns>The last user inventory folder created or found for the archive path</returns>
         public InventoryFolderBase ReplicateArchivePathToUserInventory(
-            string archivePath, 
+            string iarPath, 
             InventoryFolderBase rootDestFolder, 
             Dictionary <string, InventoryFolderBase> resolvedFolders,
             List<InventoryNodeBase> loadedNodes)
         {
-            string originalArchivePath = archivePath;
+            string iarPathExisting = iarPath;
 
 //            m_log.DebugFormat(
 //                "[INVENTORY ARCHIVER]: Loading folder {0} {1}", rootDestFolder.Name, rootDestFolder.ID);
                         
-            InventoryFolderBase destFolder = ResolveDestinationFolder(rootDestFolder, ref archivePath, resolvedFolders);
+            InventoryFolderBase destFolder = ResolveDestinationFolder(rootDestFolder, ref iarPathExisting, resolvedFolders);
             
-//            m_log.DebugFormat(
-//                "[INVENTORY ARCHIVER]: originalArchivePath [{0}], section already loaded [{1}]", 
-//                originalArchivePath, archivePath);
+            m_log.DebugFormat(
+                "[INVENTORY ARCHIVER]: originalArchivePath [{0}], section already loaded [{1}]", 
+                iarPath, iarPathExisting);
             
-            string archivePathSectionToCreate = originalArchivePath.Substring(archivePath.Length);
-            CreateFoldersForPath(destFolder, archivePathSectionToCreate, resolvedFolders, loadedNodes);
+            string iarPathToCreate = iarPath.Substring(iarPathExisting.Length);
+            CreateFoldersForPath(destFolder, iarPathExisting, iarPathToCreate, resolvedFolders, loadedNodes);
             
             return destFolder;
         }
@@ -245,7 +246,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             InventoryFolderBase rootDestFolder,                                                             
             ref string archivePath,             
             Dictionary <string, InventoryFolderBase> resolvedFolders)
-        {
+        {                       
             string originalArchivePath = archivePath;
 
             InventoryFolderBase destFolder = null;
@@ -254,10 +255,12 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             {
                 while (null == destFolder && archivePath.Length > 0)
                 {
+                    m_log.DebugFormat("[INVENTORY ARCHIVER]: Trying to resolve destination folder {0}", archivePath);
+                    
                     if (resolvedFolders.ContainsKey(archivePath))
                     {
-//                        m_log.DebugFormat(
-//                            "[INVENTORY ARCHIVER]: Found previously created folder from archive path {0}", archivePath);
+                        m_log.DebugFormat(
+                            "[INVENTORY ARCHIVER]: Found previously created folder from archive path {0}", archivePath);
                         destFolder = resolvedFolders[archivePath];
                     }
                     else
@@ -294,8 +297,11 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// <param name="destFolder">
         /// The root folder from which the creation will take place.
         /// </param>
-        /// <param name="path">
-        /// The path to create
+        /// <param name="iarPathExisting">
+        /// the part of the iar path that already exists
+        /// </param>
+        /// <param name="iarPathToReplicate">
+        /// The path to replicate in the user's inventory from iar
         /// </param>
         /// <param name="resolvedFolders">
         /// The folders that we have resolved so far for a given archive path.
@@ -304,11 +310,13 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// Track the inventory nodes created.
         /// </param>
         protected void CreateFoldersForPath(
-            InventoryFolderBase destFolder, string path, Dictionary <string, InventoryFolderBase> resolvedFolders, 
+            InventoryFolderBase destFolder, 
+            string iarPathExisting,
+            string iarPathToReplicate, 
+            Dictionary <string, InventoryFolderBase> resolvedFolders, 
             List<InventoryNodeBase> loadedNodes)
         {
-            string pathCreated = "";
-            string[] rawDirsToCreate = path.Split(new char[] { '/' }, StringSplitOptions.RemoveEmptyEntries);
+            string[] rawDirsToCreate = iarPathToReplicate.Split(new char[] { '/' }, StringSplitOptions.RemoveEmptyEntries);
             int i = 0;
 
             while (i < rawDirsToCreate.Length)
@@ -340,9 +348,9 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 m_scene.InventoryService.AddFolder(destFolder);
 
                 // Record that we have now created this folder
-                pathCreated += rawDirsToCreate[i] + "/";
-                m_log.DebugFormat("[INVENTORY ARCHIVER]: Created folder {0} from IAR", pathCreated);
-                resolvedFolders[pathCreated] = destFolder;
+                iarPathExisting += rawDirsToCreate[i] + "/";
+                m_log.DebugFormat("[INVENTORY ARCHIVER]: Created folder {0} from IAR", iarPathExisting);
+                resolvedFolders[iarPathExisting] = destFolder;
 
                 if (0 == i)
                     loadedNodes.Add(destFolder);
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs
index 47b18d8..ca33968 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs
@@ -55,8 +55,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         ///
         /// This method does not handle paths that contain multiple delimitors
         ///
-        /// FIXME: We do not yet handle situations where folders have the same name.  We could handle this by some
-        /// XPath like expression
+        /// FIXME: We have no way of distinguishing folders with the same path
         ///
         /// FIXME: Delimitors which occur in names themselves are not currently escapable.
         ///
@@ -70,14 +69,14 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// The path to the required folder.
         /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned.
         /// </param>
-        /// <returns>null if the folder is not found</returns>
-        public static InventoryFolderBase FindFolderByPath(
+        /// <returns>An empty list if the folder is not found, otherwise a list of all folders that match the name</returns>
+        public static List<InventoryFolderBase> FindFolderByPath(
             IInventoryService inventoryService, UUID userId, string path)
         {
             InventoryFolderBase rootFolder = inventoryService.GetRootFolder(userId);
 
             if (null == rootFolder)
-                return null;
+                return new List<InventoryFolderBase>();
 
             return FindFolderByPath(inventoryService, rootFolder, path);
         }
@@ -88,8 +87,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         ///
         /// This method does not handle paths that contain multiple delimitors
         ///
-        /// FIXME: We do not yet handle situations where folders have the same name.  We could handle this by some
-        /// XPath like expression
+        /// FIXME: We have no way of distinguishing folders with the same path.
         ///
         /// FIXME: Delimitors which occur in names themselves are not currently escapable.
         ///
@@ -103,17 +101,25 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// The path to the required folder.
         /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned.
         /// </param>
-        /// <returns>null if the folder is not found</returns>
-        public static InventoryFolderBase FindFolderByPath(
+        /// <returns>An empty list if the folder is not found, otherwise a list of all folders that match the name</returns>
+        public static List<InventoryFolderBase> FindFolderByPath(
             IInventoryService inventoryService, InventoryFolderBase startFolder, string path)
         {
+            List<InventoryFolderBase> foundFolders = new List<InventoryFolderBase>();
+            
             if (path == string.Empty)
-                return startFolder;
+            {
+                foundFolders.Add(startFolder);
+                return foundFolders;
+            }
 
             path = path.Trim();
 
             if (path == PATH_DELIMITER.ToString())
-                return startFolder;
+            {
+                foundFolders.Add(startFolder);
+                return foundFolders;
+            }
 
             string[] components = SplitEscapedPath(path);
             components[0] = UnescapePath(components[0]);
@@ -127,14 +133,13 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 if (folder.Name == components[0])
                 {
                     if (components.Length > 1)
-                        return FindFolderByPath(inventoryService, folder, components[1]);
+                        foundFolders.AddRange(FindFolderByPath(inventoryService, folder, components[1]));
                     else
-                        return folder;
+                        foundFolders.Add(folder);
                 }
             }
 
-            // We didn't find a folder with the right name
-            return null;
+            return foundFolders;
         }
 
         /// <summary>
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
index 8f3f65b..2c2724e 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
@@ -249,9 +249,10 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             else
             {
                 m_invPath = m_invPath.Remove(m_invPath.LastIndexOf(InventoryFolderImpl.PATH_DELIMITER));
-                inventoryFolder 
+                List<InventoryFolderBase> candidateFolders 
                     = InventoryArchiveUtils.FindFolderByPath(m_scene.InventoryService, rootFolder, m_invPath);
-                //inventoryFolder = m_userInfo.RootFolder.FindFolderByPath(m_invPath);
+                if (candidateFolders.Count > 0)
+                    inventoryFolder = candidateFolders[0];
             }
 
             // The path may point to an item instead
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
index 00bd27a..5130fa5 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
@@ -117,7 +117,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
             item1.AssetID = asset1.FullID;
             item1.ID = item1Id;
             InventoryFolderBase objsFolder 
-                = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, userId, "Objects");
+                = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, userId, "Objects")[0];
             item1.Folder = objsFolder.ID;
             scene.AddInventoryItem(userId, item1);
 
@@ -327,7 +327,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
             item1.AssetID = asset1.FullID;
             item1.ID = item1Id;
             InventoryFolderBase objsFolder 
-                = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, userId, "Objects");
+                = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, userId, "Objects")[0];
             item1.Folder = objsFolder.ID;
             scene.AddInventoryItem(userId, item1);
 
@@ -508,7 +508,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
         public void TestNewIarPath()
         {
             TestHelper.InMethod();
-            //log4net.Config.XmlConfigurator.Configure();
+//            log4net.Config.XmlConfigurator.Configure();
             
             Scene scene = SceneSetupHelpers.SetupScene("inventory");
             UserAccount ua1 = UserProfileTestUtils.CreateUserWithInventory(scene);
@@ -516,33 +516,60 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
             Dictionary <string, InventoryFolderBase> foldersCreated = new Dictionary<string, InventoryFolderBase>();
             List<InventoryNodeBase> nodesLoaded = new List<InventoryNodeBase>();
             
-            string folder1Name = "a";
-            string folder2Name = "b";
-            string itemName = "c.lsl";
+            string folder1Name = "1";
+            string folder2aName = "2a";
+            string folder2bName = "2b";
             
             string folder1ArchiveName = InventoryArchiveWriteRequest.CreateArchiveFolderName(folder1Name, UUID.Random());
-            string folder2ArchiveName = InventoryArchiveWriteRequest.CreateArchiveFolderName(folder2Name, UUID.Random());
-            string itemArchiveName = InventoryArchiveWriteRequest.CreateArchiveItemName(itemName, UUID.Random());
+            string folder2aArchiveName = InventoryArchiveWriteRequest.CreateArchiveFolderName(folder2aName, UUID.Random());
+            string folder2bArchiveName = InventoryArchiveWriteRequest.CreateArchiveFolderName(folder2bName, UUID.Random());
             
-            string itemArchivePath
-                = string.Format(
-                    "{0}{1}{2}{3}", 
-                    ArchiveConstants.INVENTORY_PATH, folder1ArchiveName, folder2ArchiveName, itemArchiveName);
+            string iarPath1 = string.Join("", new string[] { folder1ArchiveName, folder2aArchiveName });            
+            string iarPath2 = string.Join("", new string[] { folder1ArchiveName, folder2bArchiveName });  
 
-            new InventoryArchiveReadRequest(scene, ua1, null, (Stream)null)
-                .ReplicateArchivePathToUserInventory(
-                    itemArchivePath, scene.InventoryService.GetRootFolder(ua1.PrincipalID), 
-                    foldersCreated, nodesLoaded);
-
-            InventoryFolderBase folder1 
-                = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, ua1.PrincipalID, "a");
-            Assert.That(folder1, Is.Not.Null, "Could not find folder a");
-            InventoryFolderBase folder2 = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, folder1, "b");
-            Assert.That(folder2, Is.Not.Null, "Could not find folder b");
+            {
+                // Test replication of path1
+                new InventoryArchiveReadRequest(scene, ua1, null, (Stream)null)
+                    .ReplicateArchivePathToUserInventory(
+                        iarPath1, scene.InventoryService.GetRootFolder(ua1.PrincipalID), 
+                        foldersCreated, nodesLoaded);
+    
+                List<InventoryFolderBase> folder1Candidates
+                    = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, ua1.PrincipalID, folder1Name);
+                Assert.That(folder1Candidates.Count, Is.EqualTo(1));
+                
+                InventoryFolderBase folder1 = folder1Candidates[0];            
+                List<InventoryFolderBase> folder2aCandidates 
+                    = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, folder1, folder2aName);
+                Assert.That(folder2aCandidates.Count, Is.EqualTo(1));
+            }
+            
+            {
+                // Test replication of path2
+                new InventoryArchiveReadRequest(scene, ua1, null, (Stream)null)
+                    .ReplicateArchivePathToUserInventory(
+                        iarPath2, scene.InventoryService.GetRootFolder(ua1.PrincipalID), 
+                        foldersCreated, nodesLoaded);
+    
+                List<InventoryFolderBase> folder1Candidates
+                    = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, ua1.PrincipalID, folder1Name);
+                Assert.That(folder1Candidates.Count, Is.EqualTo(1));
+                
+                InventoryFolderBase folder1 = folder1Candidates[0]; 
+                
+                List<InventoryFolderBase> folder2aCandidates 
+                    = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, folder1, folder2aName);
+                Assert.That(folder2aCandidates.Count, Is.EqualTo(1));           
+                
+                List<InventoryFolderBase> folder2bCandidates 
+                    = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, folder1, folder2bName);
+                Assert.That(folder2bCandidates.Count, Is.EqualTo(1));                           
+            }
         }
         
         /// <summary>
-        /// Test replication of a partly existing archive path to the user's inventory.
+        /// Test replication of a partly existing archive path to the user's inventory.  This should create
+        /// a duplicate path without the merge option.
         /// </summary>
         [Test]
         public void TestPartExistingIarPath()
@@ -555,7 +582,6 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
             
             string folder1ExistingName = "a";
             string folder2Name = "b";
-            string itemName = "c.lsl";
             
             InventoryFolderBase folder1 
                 = UserInventoryTestUtils.CreateInventoryFolder(
@@ -563,28 +589,33 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
             
             string folder1ArchiveName = InventoryArchiveWriteRequest.CreateArchiveFolderName(folder1ExistingName, UUID.Random());
             string folder2ArchiveName = InventoryArchiveWriteRequest.CreateArchiveFolderName(folder2Name, UUID.Random());
-            string itemArchiveName = InventoryArchiveWriteRequest.CreateArchiveItemName(itemName, UUID.Random());
             
-            string itemArchivePath
-                = string.Format(
-                    "{0}{1}{2}{3}", 
-                    ArchiveConstants.INVENTORY_PATH, folder1ArchiveName, folder2ArchiveName, itemArchiveName);
-
+            string itemArchivePath = string.Join("", new string[] { folder1ArchiveName, folder2ArchiveName });
+            
             new InventoryArchiveReadRequest(scene, ua1, null, (Stream)null)
                 .ReplicateArchivePathToUserInventory(
                     itemArchivePath, scene.InventoryService.GetRootFolder(ua1.PrincipalID), 
                     new Dictionary<string, InventoryFolderBase>(), new List<InventoryNodeBase>());
 
-            InventoryFolderBase folder1Post 
+            List<InventoryFolderBase> folder1PostCandidates 
                 = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, ua1.PrincipalID, folder1ExistingName);
-            Assert.That(folder1Post.ID, Is.EqualTo(folder1.ID));
-            /*
-            InventoryFolderBase folder2 
+            Assert.That(folder1PostCandidates.Count, Is.EqualTo(2));
+            
+            // FIXME: Temporarily, we're going to do something messy to make sure we pick up the created folder.
+            InventoryFolderBase folder1Post = null;
+            foreach (InventoryFolderBase folder in folder1PostCandidates)
+            {
+                if (folder.ID != folder1.ID)
+                {
+                    folder1Post = folder;
+                    break;
+                }
+            }
+//            Assert.That(folder1Post.ID, Is.EqualTo(folder1.ID));
+
+            List<InventoryFolderBase> folder2PostCandidates 
                 = InventoryArchiveUtils.FindFolderByPath(scene.InventoryService, folder1Post, "b");
-            Assert.That(folder2, Is.Not.Null);
-            InventoryItemBase item = InventoryArchiveUtils.FindItemByPath(scene.InventoryService, folder2, itemName);
-            Assert.That(item, Is.Not.Null);
-            */
+            Assert.That(folder2PostCandidates.Count, Is.EqualTo(1));
         }       
     }
 }
\ No newline at end of file