* Various 1.19.0.5 grid inventory request fixes. These will only take affect once the region and the grid servers have upgraded to this revision

* You may also need to clear your cache before seeing any effect.
* These fixes may or may not affect inventory on the RC client.
* These fixes should make non-root folders work better, stop inventory failure on first login, allow trash to be emptied and make texture picker in object edit view work properly
* Fixes are 1) make initial root folder request wait for async inventory delivery, 2) deliver all folders in the initial login skeleton, not just the root child ones and 3) deal 
with situations where we receive child folders from the inventory service before their parent is received.

4 files changed, 159 insertions, 27 deletions

diff --git a/OpenSim/Framework/Communications/Cache/CachedUserInfo.cs b/OpenSim/Framework/Communications/Cache/CachedUserInfo.cs
index 59e5b6e..f2dd2bf 100644
--- a/OpenSim/Framework/Communications/Cache/CachedUserInfo.cs
+++ b/OpenSim/Framework/Communications/Cache/CachedUserInfo.cs
@@ -25,6 +25,9 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+using System;
+using System.Collections.Generic;
+
 using libsecondlife;
 
 namespace OpenSim.Framework.Communications.Cache
@@ -35,50 +38,135 @@ namespace OpenSim.Framework.Communications.Cache
             = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
         
         private readonly CommunicationsManager m_parentCommsManager;
-        // Fields
+
+        // FIXME: These need to be hidden behind accessors
         public InventoryFolderImpl RootFolder = null;
         public UserProfileData UserProfile = null;
+        
+        /// <summary>
+        /// Stores received folders for which we have not yet received the parents.
+        /// </summary></param>
+        private IDictionary<LLUUID, IList<InventoryFolderImpl>> pendingCategorizationFolders 
+            = new Dictionary<LLUUID, IList<InventoryFolderImpl>>();
 
         public CachedUserInfo(CommunicationsManager commsManager)
         {
             m_parentCommsManager = commsManager;
         }
-
-        // Methods
-        public void FolderReceive(LLUUID userID, InventoryFolderImpl folderInfo)
+        
+        /// <summary>
+        /// Store a folder pending categorization when its parent is received.
+        /// </summary>
+        /// <param name="folder"></param>
+        private void AddPendingFolder(InventoryFolderImpl folder)
         {
-            //m_log.DebugFormat("[INVENTORY CACHE]: Received folder {0} {1} for user {2}", folderInfo.name, folderInfo.folderID, userID);
+            LLUUID parentFolderId = folder.parentID;
             
-            if (userID == UserProfile.UUID)
+            if (pendingCategorizationFolders.ContainsKey(parentFolderId))
+            {
+                pendingCategorizationFolders[parentFolderId].Add(folder);
+            }
+            else
+            {
+                IList<InventoryFolderImpl> folders = new List<InventoryFolderImpl>();
+                folders.Add(folder);
+                
+                pendingCategorizationFolders[parentFolderId] = folders;
+            }
+        }
+        
+        /// <summary>
+        /// Add any pending folders which are children of parent
+        /// </summary>
+        /// <param name="parentId">
+        /// A <see cref="LLUUID"/>
+        /// </param>
+        private void ResolvePendingFolders(InventoryFolderImpl parent)
+        {
+            if (pendingCategorizationFolders.ContainsKey(parent.folderID))
             {
-                if (RootFolder == null)
+                foreach (InventoryFolderImpl folder in pendingCategorizationFolders[parent.folderID])
                 {
-                    if (folderInfo.parentID == LLUUID.Zero)
+//                    m_log.DebugFormat(
+//                        "[INVENTORY CACHE]: Resolving pending received folder {0} {1} into {2} {3}",
+//                        folder.name, folder.folderID, parent.name, parent.folderID);
+                    
+                    if (!parent.SubFolders.ContainsKey(folder.folderID))
                     {
-                        RootFolder = folderInfo;
-                    }
+                        parent.SubFolders.Add(folder.folderID, folder);
+                    }                    
                 }
-                else if (RootFolder.folderID == folderInfo.parentID)
+            }
+        }
+
+        /// <summary>
+        /// Callback invoked when a folder is received from an async request to the inventory service.
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <param name="folderInfo"></param>
+        public void FolderReceive(LLUUID userID, InventoryFolderImpl folderInfo)
+        {
+            // FIXME: Exceptions thrown upwards never appear on the console.  Could fix further up if these
+            // are simply being swallowed
+            try
+            {
+//                m_log.DebugFormat(
+//                    "[INVENTORY CACHE]: Received folder {0} {1} for user {2}", 
+//                    folderInfo.name, folderInfo.folderID, userID);
+                
+                if (userID == UserProfile.UUID)
                 {
-                    if (!RootFolder.SubFolders.ContainsKey(folderInfo.folderID))
+                    if (RootFolder == null)
                     {
-                        RootFolder.SubFolders.Add(folderInfo.folderID, folderInfo);
+                        if (folderInfo.parentID == LLUUID.Zero)
+                        {
+                            RootFolder = folderInfo;
+                        }
                     }
-                }
-                else
-                {
-                    InventoryFolderImpl folder = RootFolder.HasSubFolder(folderInfo.parentID);
-                    if (folder != null)
+                    else if (RootFolder.folderID == folderInfo.parentID)
                     {
-                        if (!folder.SubFolders.ContainsKey(folderInfo.folderID))
+                        if (!RootFolder.SubFolders.ContainsKey(folderInfo.folderID))
                         {
-                            folder.SubFolders.Add(folderInfo.folderID, folderInfo);
+                            RootFolder.SubFolders.Add(folderInfo.folderID, folderInfo);
                         }
+                        else
+                        {
+                            AddPendingFolder(folderInfo);
+                        }                        
                     }
+                    else
+                    {
+                        InventoryFolderImpl folder = RootFolder.HasSubFolder(folderInfo.parentID);
+                        if (folder != null)
+                        {
+                            if (!folder.SubFolders.ContainsKey(folderInfo.folderID))
+                            {
+                                folder.SubFolders.Add(folderInfo.folderID, folderInfo);
+                            }
+                        }
+                        else
+                        {
+                            AddPendingFolder(folderInfo);
+                        }
+                    }
+                    
+                    ResolvePendingFolders(folderInfo);
                 }
             }
+            catch (Exception e)
+            {
+                m_log.ErrorFormat("[INVENTORY CACHE] {0}", e);
+            }
         }
 
+        /// <summary>
+        /// Callback invoked when an item is received from an async request to the inventory service.
+        /// 
+        /// FIXME: We're assuming here that items are always received after all the folders have been
+        /// received.
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <param name="folderInfo"></param>        
         public void ItemReceive(LLUUID userID, InventoryItemBase itemInfo)
         {
             if ((userID == UserProfile.UUID) && (RootFolder != null))
diff --git a/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs b/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs
index 67022c7..c3f51da 100644
--- a/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs
+++ b/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs
@@ -27,7 +27,10 @@
 
 using System;
 using System.Collections.Generic;
+using System.Threading;
+
 using libsecondlife;
+
 using OpenSim.Framework.Console;
 
 namespace OpenSim.Framework.Communications.Cache
@@ -65,9 +68,7 @@ namespace OpenSim.Framework.Communications.Cache
 
                     if (userInfo.UserProfile != null)
                     {
-                        // The request itself will occur when the agent finishes logging on to the region
-                        // so there's no need to do it here.
-                        //RequestInventoryForUser(userID, userInfo);
+                        // The inventory will be populated when the user actually enters the scene
                         m_userProfiles.Add(userID, userInfo);
                     }
                     else
@@ -219,10 +220,34 @@ namespace OpenSim.Framework.Communications.Cache
             CachedUserInfo userProfile;
             if (m_userProfiles.TryGetValue(remoteClient.AgentId, out userProfile))
             {
+                // XXX: When a client crosses into a scene, their entire inventory is fetched
+                // asynchronously.  However, if the client is logging on and does not have a cached root 
+                // folder, then the root folder request usually comes in *before* the async completes, leading to 
+                // inventory failure.
+                //
+                // This is a crude way of dealing with that by retrying the lookup.
+                if (userProfile.RootFolder == null)
+                {
+                    int attempts = 5;
+                    while (attempts-- > 0)
+                    {
+                        Thread.Sleep(3000);
+                        
+                        if (userProfile.RootFolder != null)
+                        {
+                            break;
+                        }
+                    }
+                }
+                
                 if (userProfile.RootFolder != null)
                 {
                     if (userProfile.RootFolder.folderID == folderID)
                     {
+//                        m_log.DebugFormat(
+//                            "[AGENT INVENTORY]: Found root folder {0} for client {1}", 
+//                            folderID, remoteClient.AgentId);
+                        
                         remoteClient.SendInventoryFolderDetails(
                             remoteClient.AgentId, folderID, userProfile.RootFolder.RequestListOfItems(),
                             userProfile.RootFolder.RequestListOfFolders(),
@@ -234,6 +259,10 @@ namespace OpenSim.Framework.Communications.Cache
                     {
                         if ((fold = userProfile.RootFolder.HasSubFolder(folderID)) != null)
                         {
+//                            m_log.DebugFormat(
+//                                "[AGENT INVENTORY]: Found folder {0} for client {1}", 
+//                                folderID, remoteClient.AgentId);
+                            
                             remoteClient.SendInventoryFolderDetails(
                                 remoteClient.AgentId, folderID, fold.RequestListOfItems(),
                                 fold.RequestListOfFolders(), fetchFolders, fetchItems);
diff --git a/OpenSim/Framework/Communications/InventoryServiceBase.cs b/OpenSim/Framework/Communications/InventoryServiceBase.cs
index 6e909da..5515c77 100644
--- a/OpenSim/Framework/Communications/InventoryServiceBase.cs
+++ b/OpenSim/Framework/Communications/InventoryServiceBase.cs
@@ -76,12 +76,27 @@ namespace OpenSim.Framework.Communications
         
         #region IInventoryServices methods
 
-        // See IInventoryServices
+        /// <summary>
+        /// Guid to UUID wrapper for same name IInventoryServices method
+        /// </summary>
+        /// <param name="rawUserID"></param>
+        /// <returns></returns>
         public List<InventoryFolderBase> RequestFirstLevelFolders(Guid rawUserID)
         {
             LLUUID userID = new LLUUID(rawUserID);
             return RequestFirstLevelFolders(userID);
         }
+        
+        /// <summary>
+        /// Guid to UUID wrapper for same name IInventoryServices method
+        /// </summary>
+        /// <param name="rawUserID"></param>
+        /// <returns></returns>        
+        public List<InventoryFolderBase> GetInventorySkeleton(Guid rawUserID)
+        {
+            LLUUID userID = new LLUUID(rawUserID);
+            return GetInventorySkeleton(userID);
+        }        
 
         // See IInventoryServices
         public List<InventoryFolderBase> RequestFirstLevelFolders(LLUUID userID)
@@ -112,7 +127,7 @@ namespace OpenSim.Framework.Communications
         // See IInventoryServices
         public List<InventoryFolderBase> GetInventorySkeleton(LLUUID userId)
         {
-//            m_log.DebugFormat("[AGENT INVENTORY]: Getting inventory skeleton for {0}", userId);
+            m_log.DebugFormat("[AGENT INVENTORY]: Getting inventory skeleton for {0}", userId);
             
             List<InventoryFolderBase> userFolders = new List<InventoryFolderBase>();
             
@@ -173,7 +188,7 @@ namespace OpenSim.Framework.Communications
             
             if (null != existingRootFolder)
             {
-                m_log.ErrorFormat("[AGENTINVENTORY]: " +
+                m_log.ErrorFormat("[AGENT INVENTORY]: " +
                                   "Did not create a new inventory for user {0} since they already have "
                                   + "a root inventory folder with id {1}", user, existingRootFolder);
             }
diff --git a/OpenSim/Framework/Communications/LoginService.cs b/OpenSim/Framework/Communications/LoginService.cs
index e738d0b..cbe8783 100644
--- a/OpenSim/Framework/Communications/LoginService.cs
+++ b/OpenSim/Framework/Communications/LoginService.cs
@@ -272,7 +272,7 @@ namespace OpenSim.Framework.UserManagement
                     }
                     catch (Exception e)
                     {
-                        m_log.Info("[LOGIN]: Login failed, exception" + e.ToString());
+                        m_log.Info("[LOGIN]: Login failed, " + e.ToString());
                     }
                 }