Added ability to exclude inventory items or folders when saving IAR files.

1 files changed, 59 insertions, 29 deletions

diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
index a26c73a..0ee7606 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
@@ -91,7 +91,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// Constructor
         /// </summary>
         public InventoryArchiveWriteRequest(
-            Guid id, InventoryArchiverModule module, Scene scene, 
+            Guid id, InventoryArchiverModule module, Scene scene,
             UserAccount userInfo, string invPath, string savePath)
             : this(
                 id,
@@ -107,7 +107,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// Constructor
         /// </summary>
         public InventoryArchiveWriteRequest(
-            Guid id, InventoryArchiverModule module, Scene scene, 
+            Guid id, InventoryArchiverModule module, Scene scene,
             UserAccount userInfo, string invPath, Stream saveStream)
         {
             m_id = id;
@@ -125,7 +125,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         {
             Exception reportedException = null;
             bool succeeded = true;
-             
+
             try
             {
                 m_archiveWriter.Close();
@@ -146,6 +146,21 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
 
         protected void SaveInvItem(InventoryItemBase inventoryItem, string path, Dictionary<string, object> options, IUserAccountService userAccountService)
         {
+            if (options.ContainsKey("exclude"))
+            {
+                if (((List<String>)options["exclude"]).Contains(inventoryItem.Name) ||
+                    ((List<String>)options["exclude"]).Contains(inventoryItem.ID.ToString()))
+                {
+                    if (options.ContainsKey("verbose"))
+                    {
+                        m_log.InfoFormat(
+                            "[INVENTORY ARCHIVER]: Skipping inventory item {0} {1} at {2}",
+                            inventoryItem.Name, inventoryItem.ID, path);
+                    }
+                    return;
+                }
+            }
+
             if (options.ContainsKey("verbose"))
                 m_log.InfoFormat(
                     "[INVENTORY ARCHIVER]: Saving item {0} {1} with asset {2}",
@@ -175,12 +190,27 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         /// <param name="options"></param>
         /// <param name="userAccountService"></param>
         protected void SaveInvFolder(
-            InventoryFolderBase inventoryFolder, string path, bool saveThisFolderItself, 
+            InventoryFolderBase inventoryFolder, string path, bool saveThisFolderItself,
             Dictionary<string, object> options, IUserAccountService userAccountService)
         {
+            if (options.ContainsKey("excludefolders"))
+            {
+                if (((List<String>)options["excludefolders"]).Contains(inventoryFolder.Name) ||
+                    ((List<String>)options["excludefolders"]).Contains(inventoryFolder.ID.ToString()))
+                {
+                    if (options.ContainsKey("verbose"))
+                    {
+                        m_log.InfoFormat(
+                            "[INVENTORY ARCHIVER]: Skipping folder {0} at {1}",
+                            inventoryFolder.Name, path);
+                    }
+                    return;
+                }
+            }
+
             if (options.ContainsKey("verbose"))
                 m_log.InfoFormat("[INVENTORY ARCHIVER]: Saving folder {0}", inventoryFolder.Name);
- 
+
             if (saveThisFolderItself)
             {
                 path += CreateArchiveFolderName(inventoryFolder);
@@ -189,7 +219,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 m_archiveWriter.WriteDir(path);
             }
 
-            InventoryCollection contents 
+            InventoryCollection contents
                 = m_scene.InventoryService.GetFolderContent(inventoryFolder.Owner, inventoryFolder.ID);
 
             foreach (InventoryFolderBase childFolder in contents.Folders)
@@ -216,16 +246,16 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 InventoryFolderBase inventoryFolder = null;
                 InventoryItemBase inventoryItem = null;
                 InventoryFolderBase rootFolder = m_scene.InventoryService.GetRootFolder(m_userInfo.PrincipalID);
-    
+
                 bool saveFolderContentsOnly = false;
-    
+
                 // Eliminate double slashes and any leading / on the path.
                 string[] components
                     = m_invPath.Split(
                         new string[] { InventoryFolderImpl.PATH_DELIMITER }, StringSplitOptions.RemoveEmptyEntries);
-    
+
                 int maxComponentIndex = components.Length - 1;
-    
+
                 // If the path terminates with a STAR then later on we want to archive all nodes in the folder but not the
                 // folder itself.  This may get more sophisicated later on
                 if (maxComponentIndex >= 0 && components[maxComponentIndex] == STAR_WILDCARD)
@@ -233,13 +263,13 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                     saveFolderContentsOnly = true;
                     maxComponentIndex--;
                 }
-    
+
                 m_invPath = String.Empty;
                 for (int i = 0; i <= maxComponentIndex; i++)
                 {
                     m_invPath += components[i] + InventoryFolderImpl.PATH_DELIMITER;
                 }
-    
+
                 // Annoyingly Split actually returns the original string if the input string consists only of delimiters
                 // Therefore if we still start with a / after the split, then we need the root folder
                 if (m_invPath.Length == 0)
@@ -249,25 +279,25 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 else
                 {
                     m_invPath = m_invPath.Remove(m_invPath.LastIndexOf(InventoryFolderImpl.PATH_DELIMITER));
-                    List<InventoryFolderBase> candidateFolders 
+                    List<InventoryFolderBase> candidateFolders
                         = InventoryArchiveUtils.FindFolderByPath(m_scene.InventoryService, rootFolder, m_invPath);
                     if (candidateFolders.Count > 0)
                         inventoryFolder = candidateFolders[0];
                 }
-    
+
                 // The path may point to an item instead
                 if (inventoryFolder == null)
                     inventoryItem = InventoryArchiveUtils.FindItemByPath(m_scene.InventoryService, rootFolder, m_invPath);
-    
+
                 if (null == inventoryFolder && null == inventoryItem)
                 {
-                    // We couldn't find the path indicated 
+                    // We couldn't find the path indicated
                     string errorMessage = string.Format("Aborted save.  Could not find inventory path {0}", m_invPath);
                     Exception e = new InventoryArchiverException(errorMessage);
                     m_module.TriggerInventoryArchiveSaved(m_id, false, m_userInfo, m_invPath, m_saveStream, e);
                     throw e;
                 }
-            
+
                 m_archiveWriter = new TarArchiveWriter(m_saveStream);
 
                 m_log.InfoFormat("[INVENTORY ARCHIVER]: Adding control file to archive.");
@@ -281,10 +311,10 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                 {
                     m_log.DebugFormat(
                         "[INVENTORY ARCHIVER]: Found folder {0} {1} at {2}",
-                        inventoryFolder.Name, 
-                        inventoryFolder.ID, 
+                        inventoryFolder.Name,
+                        inventoryFolder.ID,
                         m_invPath == String.Empty ? InventoryFolderImpl.PATH_DELIMITER : m_invPath);
-    
+
                     //recurse through all dirs getting dirs and files
                     SaveInvFolder(inventoryFolder, ArchiveConstants.INVENTORY_PATH, !saveFolderContentsOnly, options, userAccountService);
                 }
@@ -293,10 +323,10 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
                     m_log.DebugFormat(
                         "[INVENTORY ARCHIVER]: Found item {0} {1} at {2}",
                         inventoryItem.Name, inventoryItem.ID, m_invPath);
-    
+
                     SaveInvItem(inventoryItem, ArchiveConstants.INVENTORY_PATH, options, userAccountService);
                 }
-            
+
                 // Don't put all this profile information into the archive right now.
                 //SaveUsers();
 
@@ -355,7 +385,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         ///
         /// These names are prepended with an inventory folder's UUID so that more than one folder can have the
         /// same name
-        /// 
+        ///
         /// <param name="folder"></param>
         /// <returns></returns>
         public static string CreateArchiveFolderName(InventoryFolderBase folder)
@@ -369,7 +399,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         ///
         /// These names are prepended with an inventory item's UUID so that more than one item can have the
         /// same name
-        /// 
+        ///
         /// <param name="item"></param>
         /// <returns></returns>
         public static string CreateArchiveItemName(InventoryItemBase item)
@@ -415,7 +445,7 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
         public string CreateControlFile(Dictionary<string, object> options)
         {
             int majorVersion, minorVersion;
-            
+
             if (options.ContainsKey("home"))
             {
                 majorVersion = 1;
@@ -425,10 +455,10 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             {
                 majorVersion = 0;
                 minorVersion = 3;
-            }            
-            
+            }
+
             m_log.InfoFormat("[INVENTORY ARCHIVER]: Creating version {0}.{1} IAR", majorVersion, minorVersion);
-            
+
             StringWriter sw = new StringWriter();
             XmlTextWriter xtw = new XmlTextWriter(sw);
             xtw.Formatting = Formatting.Indented;
@@ -450,4 +480,4 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
             return s;
         }
     }
-}
\ No newline at end of file
+}