4 files changed, 199 insertions, 136 deletions

diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
index 4c02214..ee8b1bf 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
@@ -99,36 +99,6 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             int failedAssetRestores = 0;
             int successfulItemRestores = 0;
             List<InventoryNodeBase> nodesLoaded = new List<InventoryNodeBase>();
-
-            /*
-            if (!m_userInfo.HasReceivedInventory)
-            {
-                // If the region server has access to the user admin service (by which users are created),
-                // then we'll assume that it's okay to fiddle with the user's inventory even if they are not on the
-                // server.
-                //
-                // 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 == m_scene.CommsManager.UserAdminService)
-                {
-                    m_log.ErrorFormat(
-                        "[INVENTORY ARCHIVER]: Have not yet received inventory info for user {0} {1}",
-                        m_userInfo.UserProfile.Name, m_userInfo.UserProfile.ID);
-
-                    return nodesLoaded;
-                }
-                else
-                {
-                    m_userInfo.FetchInventory();
-                    for (int i = 0 ; i < 50 ; i++)
-                    {
-                        if (m_userInfo.HasReceivedInventory == true)
-                            break;
-                        Thread.Sleep(200);
-                    }
-                }
-            }
-            */
            
             //InventoryFolderImpl rootDestinationFolder = m_userInfo.RootFolder.FindFolderByPath(m_invPath);
             InventoryFolderBase rootDestinationFolder 
@@ -159,6 +129,11 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                         successfulAssetRestores++;
                     else
                         failedAssetRestores++;
+
+                    if ((successfulAssetRestores) % 50 == 0)
+                        m_log.DebugFormat(
+                            "[INVENTORY ARCHIVER]: Loaded {0} assets...", 
+                            successfulAssetRestores);
                 }
                 else if (filePath.StartsWith(ArchiveConstants.INVENTORY_PATH))
                 {                                
@@ -168,43 +143,28 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                             rootDestinationFolder, foldersCreated, nodesLoaded);
 
                     if (TarArchiveReader.TarEntryType.TYPE_DIRECTORY != entryType)
-                    {                        
-                        // Escape back characters
-                        filePath = filePath.Replace("&#47;", "/");
-                        filePath = filePath.Replace("&amp;", "&");
-                        
-                        InventoryItemBase item = UserInventoryItemSerializer.Deserialize(data);
-                        
-                        // Don't use the item ID that's in the file
-                        item.ID = UUID.Random();
-
-                        UUID ospResolvedId = OspResolver.ResolveOspa(item.CreatorId, m_scene.CommsManager); 
-                        if (UUID.Zero != ospResolvedId)
-                            item.CreatorIdAsUuid = ospResolvedId;
-                        else
-                            item.CreatorIdAsUuid = m_userInfo.UserProfile.ID;
-                        
-                        item.Owner = m_userInfo.UserProfile.ID;
-
-                        // Reset folder ID to the one in which we want to load it
-                        item.Folder = foundFolder.ID;
-
-                        //m_userInfo.AddItem(item);
-                        m_scene.InventoryService.AddItem(item);
-                        successfulItemRestores++;
+                    {
+                        InventoryItemBase item = LoadItem(data, foundFolder);
 
-                        // If we're loading an item directly into the given destination folder then we need to record
-                        // it separately from any loaded root folders
-                        if (rootDestinationFolder == foundFolder)
-                            nodesLoaded.Add(item);
+                        if (item != null)
+                        {
+                            successfulItemRestores++;
+                            
+                            // If we're loading an item directly into the given destination folder then we need to record
+                            // it separately from any loaded root folders
+                            if (rootDestinationFolder == foundFolder)
+                                nodesLoaded.Add(item);
+                        }
                     }
                 }
             }
 
             archive.Close();
 
-            m_log.DebugFormat("[INVENTORY ARCHIVER]: Restored {0} assets", successfulAssetRestores);
-            m_log.InfoFormat("[INVENTORY ARCHIVER]: Restored {0} items", successfulItemRestores);
+            m_log.DebugFormat(
+                "[INVENTORY ARCHIVER]: Successfully loaded {0} assets with {1} failures", 
+                successfulAssetRestores, failedAssetRestores);
+            m_log.InfoFormat("[INVENTORY ARCHIVER]: Successfully loaded {0} items", successfulItemRestores);
 
             return nodesLoaded;
         }
@@ -239,7 +199,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             string originalArchivePath = archivePath;
 
             m_log.DebugFormat(
-                "[INVENTORY ARCHIVER]: Loading to folder {0} {1}", rootDestFolder.Name, rootDestFolder.ID);
+                "[INVENTORY ARCHIVER]: Loading folder {0} {1}", rootDestFolder.Name, rootDestFolder.ID);
 
             InventoryFolderBase destFolder = null;
 
@@ -250,8 +210,8 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 {
                     if (foldersCreated.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 = foldersCreated[archivePath];
                     }
                     else
@@ -294,10 +254,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
 
                 string newFolderName = rawDirsToCreate[i].Remove(identicalNameIdentifierIndex);
 
-                // Escape back characters
-                newFolderName = newFolderName.Replace("&#47;", "/");
-                newFolderName = newFolderName.Replace("&amp;", "&");
-                
+                newFolderName = InventoryArchiveUtils.UnescapeArchivePath(newFolderName);                
                 UUID newFolderId = UUID.Random();
 
                 // Asset type has to be Unknown here rather than Folder, otherwise the created folder can't be
@@ -370,6 +327,37 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         }
 
         /// <summary>
+        /// Load an item from the archive
+        /// </summary>
+        /// <param name="filePath">The archive path for the item</param>
+        /// <param name="data">The raw item data</param>
+        /// <param name="rootDestinationFolder">The root destination folder for loaded items</param>
+        /// <param name="nodesLoaded">All the inventory nodes (items and folders) loaded so far</param>
+        protected InventoryItemBase LoadItem(byte[] data, InventoryFolderBase loadFolder)
+        {
+            InventoryItemBase item = UserInventoryItemSerializer.Deserialize(data);
+            
+            // Don't use the item ID that's in the file
+            item.ID = UUID.Random();
+
+            UUID ospResolvedId = OspResolver.ResolveOspa(item.CreatorId, m_scene.CommsManager); 
+            if (UUID.Zero != ospResolvedId)
+                item.CreatorIdAsUuid = ospResolvedId;
+            else
+                item.CreatorIdAsUuid = m_userInfo.UserProfile.ID;
+            
+            item.Owner = m_userInfo.UserProfile.ID;
+
+            // Reset folder ID to the one in which we want to load it
+            item.Folder = loadFolder.ID;
+
+            //m_userInfo.AddItem(item);
+            m_scene.InventoryService.AddItem(item);            
+        
+            return item;
+        }
+
+        /// <summary>
         /// Load an asset
         /// </summary>
         /// <param name="assetFilename"></param>
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs
index a822d10..247cee4 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs
@@ -27,6 +27,9 @@
 
 using System;
 using System.Collections.Generic;
+using System.Reflection;
+using System.Text;
+using log4net;
 using OpenMetaverse;
 using OpenSim.Framework;
 using OpenSim.Services.Interfaces;
@@ -38,7 +41,13 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
     /// </summary>
     public static class InventoryArchiveUtils
     {
-        public static readonly string PATH_DELIMITER = "/";
+//        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        // Character used for escaping the path delimter ("\/") and itself ("\\") in human escaped strings
+        public static readonly char ESCAPE_CHARACTER = '\\';
+
+        // The character used to separate inventory path components (different folders and items)
+        public static readonly char PATH_DELIMITER = '/';
 
         /// <summary>
         /// Find a folder given a PATH_DELIMITER delimited path starting from a user's root folder
@@ -103,10 +112,14 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
 
             path = path.Trim();
 
-            if (path == PATH_DELIMITER)
+            if (path == PATH_DELIMITER.ToString())
                 return startFolder;
 
-            string[] components = path.Split(new string[] { PATH_DELIMITER }, 2, StringSplitOptions.None);
+            string[] components = SplitEscapedPath(path);
+            components[0] = UnescapePath(components[0]);            
+
+            //string[] components = path.Split(new string[] { PATH_DELIMITER.ToString() }, 2, StringSplitOptions.None);
+            
             InventoryCollection contents = inventoryService.GetFolderContent(startFolder.Owner, startFolder.ID);
 
             foreach (InventoryFolderBase folder in contents.Folders)
@@ -181,10 +194,15 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         public static InventoryItemBase FindItemByPath(
             IInventoryService inventoryService, InventoryFolderBase startFolder, string path)
         {
-            string[] components = path.Split(new string[] { PATH_DELIMITER }, 2, StringSplitOptions.None);
+            string[] components = SplitEscapedPath(path);
+            components[0] = UnescapePath(components[0]);
+                            
+            //string[] components = path.Split(new string[] { PATH_DELIMITER }, 2, StringSplitOptions.None);
 
             if (components.Length == 1)
             {
+//                m_log.DebugFormat("FOUND SINGLE COMPONENT [{0}]", components[0]);
+                
                 List<InventoryItemBase> items = inventoryService.GetFolderItems(startFolder.Owner, startFolder.ID);
                 foreach (InventoryItemBase item in items)
                 {
@@ -194,6 +212,8 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             }
             else
             {
+//                m_log.DebugFormat("FOUND COMPONENTS [{0}] and [{1}]", components[0], components[1]);
+                
                 InventoryCollection contents = inventoryService.GetFolderContent(startFolder.Owner, startFolder.ID);
                 
                 foreach (InventoryFolderBase folder in contents.Folders)
@@ -206,5 +226,97 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             // We didn't find an item or intermediate folder with the given name
             return null;
         }
+
+        /// <summary>
+        /// Split a human escaped path into two components if it contains an unescaped path delimiter, or one component
+        /// if no delimiter is present
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns>
+        /// The split path.  We leave the components in their originally unescaped state (though we remove the delimiter
+        /// which originally split them if applicable).
+        /// </returns>
+        public static string[] SplitEscapedPath(string path)
+        {
+//            m_log.DebugFormat("SPLITTING PATH {0}", path);
+            
+            bool singleEscapeChar = false;
+            
+            for (int i = 0; i < path.Length; i++)
+            {
+                if (path[i] == ESCAPE_CHARACTER && !singleEscapeChar)
+                {
+                    singleEscapeChar = true;
+                }
+                else
+                {
+                    if (PATH_DELIMITER == path[i] && !singleEscapeChar)
+                        return new string[2] { path.Remove(i), path.Substring(i + 1) };
+                    else
+                        singleEscapeChar = false;
+                }
+            }
+
+            // We didn't find a delimiter
+            return new string[1] { path };
+        }
+
+        /// <summary>
+        /// Unescapes a human escaped path.  This means that "\\" goes to "\", and "\/" goes to "/"
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>
+        public static string UnescapePath(string path)
+        {
+//            m_log.DebugFormat("ESCAPING PATH {0}", path);
+            
+            StringBuilder sb = new StringBuilder();
+
+            bool singleEscapeChar = false;
+            for (int i = 0; i < path.Length; i++)
+            {
+                if (path[i] == ESCAPE_CHARACTER && !singleEscapeChar)
+                    singleEscapeChar = true;
+                else
+                    singleEscapeChar = false;
+
+                if (singleEscapeChar)
+                {
+                    if (PATH_DELIMITER == path[i])
+                        sb.Append(PATH_DELIMITER);
+                }
+                else
+                {
+                    sb.Append(path[i]);
+                }
+            }
+
+//            m_log.DebugFormat("ESCAPED PATH TO {0}", sb);
+            
+            return sb.ToString();
+        }
+
+        /// <summary>
+        /// Escape an archive path.
+        /// </summary>
+        /// This has to be done differently from human paths because we can't leave in any "/" characters (due to
+        /// problems if the archive is built from or extracted to a filesystem
+        /// <param name="path"></param>
+        /// <returns></returns>
+        public static string EscapeArchivePath(string path)
+        {
+            // Only encode ampersands (for escaping anything) and / (since this is used as general dir separator).
+            return path.Replace("&", "&amp;").Replace("/", "&#47;");            
+        }
+
+        /// <summary>
+        /// Unescape an archive path.
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>        
+        public static string UnescapeArchivePath(string path)
+        {
+            return path.Replace("&#47;", "/").Replace("&amp;", "&");            
+        }
     }
 }
\ No newline at end of file
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
index af0b72f..bbb49f6 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
@@ -217,37 +217,6 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             InventoryItemBase inventoryItem = null;
             InventoryFolderBase rootFolder = m_scene.InventoryService.GetRootFolder(m_userInfo.UserProfile.ID);
 
-            // XXX: Very temporarily, drop and refetch inventory to make sure we have any newly created items in cache
-            // This will disappear very soon once we stop using the old cached inventory.
-            /*
-            m_userInfo.DropInventory();
-            m_userInfo.FetchInventory();
-            */
-
-            /*
-            if (!m_userInfo.HasReceivedInventory)
-            {
-                // If the region server has access to the user admin service (by which users are created),
-                // then we'll assume that it's okay to fiddle with the user's inventory even if they are not on the
-                // server.
-                //
-                // 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 == m_scene.CommsManager.UserAdminService)
-                {
-                    m_log.ErrorFormat(
-                        "[INVENTORY ARCHIVER]: Have not yet received inventory info for user {0} {1}",
-                        m_userInfo.UserProfile.Name, m_userInfo.UserProfile.ID);
-
-                    return;
-                }
-                else
-                {
-                    m_userInfo.FetchInventory();
-                }
-            }
-            */
-
             bool foundStar = false;
 
             // Eliminate double slashes and any leading / on the path.
@@ -294,34 +263,33 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
 
             m_archiveWriter = new TarArchiveWriter(m_saveStream);
 
-            if (null == inventoryFolder)
-            {
-                if (null == inventoryItem)
-                {
-                    // We couldn't find the path indicated 
-                    m_saveStream.Close();
-                    m_module.TriggerInventoryArchiveSaved(
-                        m_id, false, m_userInfo, m_invPath, m_saveStream,
-                        new Exception(string.Format("Could not find inventory entry at path {0}", m_invPath)));
-                    return;
-                }
-                else
-                {
-                    m_log.DebugFormat(
-                        "[INVENTORY ARCHIVER]: Found item {0} {1} at {2}",
-                        inventoryItem.Name, inventoryItem.ID, m_invPath);
-
-                    SaveInvItem(inventoryItem, ArchiveConstants.INVENTORY_PATH);
-                }
-            }
-            else
+            if (inventoryFolder != null)
             {
                 m_log.DebugFormat(
                     "[INVENTORY ARCHIVER]: Found folder {0} {1} at {2}",
                     inventoryFolder.Name, inventoryFolder.ID, m_invPath);
 
                 //recurse through all dirs getting dirs and files
-                SaveInvFolder(inventoryFolder, ArchiveConstants.INVENTORY_PATH, !foundStar);
+                SaveInvFolder(inventoryFolder, ArchiveConstants.INVENTORY_PATH, !foundStar);                                
+            }
+            else if (inventoryItem != null)
+            {
+                m_log.DebugFormat(
+                    "[INVENTORY ARCHIVER]: Found item {0} {1} at {2}",
+                    inventoryItem.Name, inventoryItem.ID, m_invPath);
+
+                SaveInvItem(inventoryItem, ArchiveConstants.INVENTORY_PATH);                
+            }
+            else
+            {
+                // We couldn't find the path indicated 
+                m_saveStream.Close();
+                string errorMessage = string.Format("Aborted save.  Could not find inventory path {0}", m_invPath);
+                m_log.ErrorFormat("[INVENTORY ARCHIVER]: {0}", errorMessage);
+                m_module.TriggerInventoryArchiveSaved(
+                    m_id, false, m_userInfo, m_invPath, m_saveStream,
+                    new Exception(errorMessage));                
+                return;
             }
 
             // Don't put all this profile information into the archive right now.
@@ -394,13 +362,9 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// <returns></returns>
         public static string CreateArchiveFolderName(string name, UUID id)
         {
-            // Only encode ampersands (for escaping anything) and / (since this is used as general dir separator).
-            name = name.Replace("&", "&amp;");
-            name = name.Replace("/", "&#47;");
-            
             return string.Format(
                 "{0}{1}{2}/",
-                name,
+                InventoryArchiveUtils.EscapeArchivePath(name),
                 ArchiveConstants.INVENTORY_NODE_NAME_COMPONENT_SEPARATOR,
                 id);
         }
@@ -413,12 +377,9 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// <returns></returns>
         public static string CreateArchiveItemName(string name, UUID id)
         {
-            name = name.Replace("&", "&amp;");
-            name = name.Replace("/", "&#47;");
-            
             return string.Format(
                 "{0}{1}{2}.xml",
-                name,
+                InventoryArchiveUtils.EscapeArchivePath(name),
                 ArchiveConstants.INVENTORY_NODE_NAME_COMPONENT_SEPARATOR,
                 id);
         }
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
index e300eb1..99d02c4 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
@@ -295,7 +295,8 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
             TestHelper.InMethod();
             log4net.Config.XmlConfigurator.Configure();
 
-            string itemName = "You & you are a mean man";
+            string itemName = "You & you are a mean/man/";
+            string humanEscapedItemName = @"You & you are a mean\/man\/";
             string userPassword = "meowfood";
 
             InventoryArchiverModule archiverModule = new InventoryArchiverModule(true);
@@ -360,7 +361,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
                 Guid.NewGuid(), userFirstName, userLastName, "Objects", userPassword, archiveWriteStream);
             mre.WaitOne(60000, false);           
 
-            /// LOAD ITEM
+            // LOAD ITEM
             MemoryStream archiveReadStream = new MemoryStream(archiveWriteStream.ToArray());
             
             archiverModule.DearchiveInventory(userFirstName, userLastName, "Scripts", userPassword, archiveReadStream);
@@ -369,7 +370,8 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
                 = scene.CommsManager.UserProfileCacheService.GetUserDetails(userFirstName, userLastName);
 
             InventoryItemBase foundItem1
-                = InventoryArchiveUtils.FindItemByPath(scene.InventoryService, userId, "Scripts/Objects/" + itemName);
+                = InventoryArchiveUtils.FindItemByPath(
+                    scene.InventoryService, userId, "Scripts/Objects/" + humanEscapedItemName);
             
             Assert.That(foundItem1, Is.Not.Null, "Didn't find loaded item 1");
 //            Assert.That(