From e31de6707fe6296cbfe3ee5765b48eef42828541 Mon Sep 17 00:00:00 2001 From: Justin Clarke Casey Date: Mon, 16 Jun 2008 17:13:28 +0000 Subject: * refactor: Fission ArchiveWriteRequest into prepare and execute classes --- .../Modules/World/Archiver/ArchiveWriteRequest.cs | 168 --------------------- .../World/Archiver/ArchiveWriteRequestExecution.cs | 73 +++++++++ .../Archiver/ArchiveWriteRequestPreparation.cs | 142 +++++++++++++++++ .../Modules/World/Archiver/ArchiverModule.cs | 2 +- .../Modules/World/Archiver/AssetsRequest.cs | 15 +- 5 files changed, 228 insertions(+), 172 deletions(-) delete mode 100644 OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequest.cs create mode 100644 OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestExecution.cs create mode 100644 OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestPreparation.cs diff --git a/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequest.cs b/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequest.cs deleted file mode 100644 index 1d7042c..0000000 --- a/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequest.cs +++ /dev/null @@ -1,168 +0,0 @@ -/* - * Copyright (c) Contributors, http://opensimulator.org/ - * See CONTRIBUTORS.TXT for a full list of copyright holders. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * * Neither the name of the OpenSim Project nor the - * names of its contributors may be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY - * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY - * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES - * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND - * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -using OpenSim.Framework; -using OpenSim.Framework.Communications.Cache; -using OpenSim.Region.Environment.Interfaces; -using OpenSim.Region.Environment.Modules.World.Serialiser; -using OpenSim.Region.Environment.Scenes; -using System.Collections.Generic; -using System.Reflection; -using System.Threading; -using libsecondlife; -using log4net; -using Nini.Config; - -namespace OpenSim.Region.Environment.Modules.World.Archiver -{ - /// - /// Method called when all the necessary assets for an archive request have been received. - /// - public delegate void AssetsRequestCallback(IDictionary assets); - - /// - /// Handles an individual archive write request - /// - public class ArchiveWriteRequest - { - private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); - - private Scene m_scene; - private string m_savePath; - - private string m_serializedEntities; - - public ArchiveWriteRequest(Scene scene, string savePath) - { - m_scene = scene; - m_savePath = savePath; - - ArchiveRegion(); - } - - protected void ArchiveRegion() - { - Dictionary assetUuids = new Dictionary(); - - List entities = m_scene.GetEntities(); - - foreach (EntityBase entity in entities) - { - if (entity is SceneObjectGroup) - { - SceneObjectGroup sceneObject = (SceneObjectGroup)entity; - - foreach (SceneObjectPart part in sceneObject.GetParts()) - { - // XXX: Not a great way to iterate through face textures, but there's no - // other way to tell how many faces there actually are - //int i = 0; - foreach (LLObject.TextureEntryFace texture in part.Shape.Textures.FaceTextures) - { - if (texture != null) - { - //m_log.DebugFormat("[ARCHIVER]: Got face {0}", i++); - assetUuids[texture.TextureID] = 1; - } - } - - foreach (TaskInventoryItem tit in part.TaskInventory.Values) - { - if (tit.Type != (int)InventoryType.Object) - { - m_log.DebugFormat("[ARCHIVER]: Recording asset {0} in object {1}", tit.AssetID, part.UUID); - assetUuids[tit.AssetID] = 1; - } - else - { - // TODO: Need to unpack every tit and go through its textures & items, recursively - // this will mean going through the 'assets' received multiple times so that we can - // unpack objects within objects before recursively requesting the inner assets - } - } - } - } - } - - m_serializedEntities = SerializeObjects(entities); - - if (m_serializedEntities != null && m_serializedEntities.Length > 0) - { - m_log.DebugFormat("[ARCHIVER]: Successfully got serialization for {0} entities", entities.Count); - m_log.DebugFormat("[ARCHIVER]: Requiring save of {0} textures", assetUuids.Count); - - // Asynchronously request all the assets required to perform this archive operation - new AssetsRequest(ReceivedAllAssets, m_scene.AssetCache, assetUuids.Keys); - } - } - - protected internal void ReceivedAllAssets(IDictionary assets) - { - m_log.DebugFormat("[ARCHIVER]: Received all {0} textures required", assets.Count); - - // XXX: Shouldn't hijack the asset async callback thread like this - this is only temporary - - TarArchiveWriter archive = new TarArchiveWriter(); - - archive.AddFile(ArchiveConstants.PRIMS_PATH, m_serializedEntities); - - AssetsArchiver assetsArchiver = new AssetsArchiver(assets); - assetsArchiver.Archive(archive); - - archive.WriteTar(m_savePath); - - m_log.InfoFormat("[ARCHIVER]: Wrote out OpenSimulator archive {0}", m_savePath); - } - - /// - /// Get an xml representation of the given scene objects. - /// - /// - /// - protected static string SerializeObjects(List entities) - { - string serialization = ""; - - List serObjects = new List(); - - foreach (EntityBase ent in entities) - { - if (ent is SceneObjectGroup) - { - serObjects.Add(((SceneObjectGroup) ent).ToXmlString2()); - } - } - - foreach (string serObject in serObjects) - serialization += serObject; - - serialization += ""; - - return serialization; - } - } -} diff --git a/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestExecution.cs b/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestExecution.cs new file mode 100644 index 0000000..4164cea --- /dev/null +++ b/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestExecution.cs @@ -0,0 +1,73 @@ +/* + * Copyright (c) Contributors, http://opensimulator.org/ + * See CONTRIBUTORS.TXT for a full list of copyright holders. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the OpenSim Project nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +using System.Collections.Generic; +using System.Reflection; +using libsecondlife; +using log4net; +using OpenSim.Framework; + +namespace OpenSim.Region.Environment.Modules.World.Archiver +{ + /// + /// Method called when all the necessary assets for an archive request have been received. + /// + public delegate void AssetsRequestCallback(IDictionary assets); + + /// + /// Execute the write of an archive once we have received all the necessary data + /// + public class ArchiveWriteRequestExecution + { + private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); + + protected string m_savePath; + protected string m_serializedEntities; + + public ArchiveWriteRequestExecution(string serializedEntities, string savePath) + { + m_serializedEntities = serializedEntities; + m_savePath = savePath; + } + + protected internal void ReceivedAllAssets(IDictionary assets) + { + m_log.DebugFormat("[ARCHIVER]: Received all {0} assets required", assets.Count); + + TarArchiveWriter archive = new TarArchiveWriter(); + + archive.AddFile(ArchiveConstants.PRIMS_PATH, m_serializedEntities); + + AssetsArchiver assetsArchiver = new AssetsArchiver(assets); + assetsArchiver.Archive(archive); + + archive.WriteTar(m_savePath); + + m_log.InfoFormat("[ARCHIVER]: Wrote out OpenSimulator archive {0}", m_savePath); + } + } +} diff --git a/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestPreparation.cs b/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestPreparation.cs new file mode 100644 index 0000000..a93e58d --- /dev/null +++ b/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestPreparation.cs @@ -0,0 +1,142 @@ +/* + * Copyright (c) Contributors, http://opensimulator.org/ + * See CONTRIBUTORS.TXT for a full list of copyright holders. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the OpenSim Project nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +using OpenSim.Framework; +using OpenSim.Framework.Communications.Cache; +using OpenSim.Region.Environment.Interfaces; +using OpenSim.Region.Environment.Modules.World.Serialiser; +using OpenSim.Region.Environment.Scenes; +using System.Collections.Generic; +using System.Reflection; +using System.Threading; +using libsecondlife; +using log4net; +using Nini.Config; + +namespace OpenSim.Region.Environment.Modules.World.Archiver +{ + /// + /// Prepare to write out an archive. + /// + public class ArchiveWriteRequestPreparation + { + private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); + + protected Scene m_scene; + protected string m_savePath; + + public ArchiveWriteRequestPreparation(Scene scene, string savePath) + { + m_scene = scene; + m_savePath = savePath; + } + + public void ArchiveRegion() + { + Dictionary assetUuids = new Dictionary(); + + List entities = m_scene.GetEntities(); + + foreach (EntityBase entity in entities) + { + if (entity is SceneObjectGroup) + { + SceneObjectGroup sceneObject = (SceneObjectGroup)entity; + + foreach (SceneObjectPart part in sceneObject.GetParts()) + { + // XXX: Not a great way to iterate through face textures, but there's no + // other way to tell how many faces there actually are + //int i = 0; + foreach (LLObject.TextureEntryFace texture in part.Shape.Textures.FaceTextures) + { + if (texture != null) + { + //m_log.DebugFormat("[ARCHIVER]: Got face {0}", i++); + assetUuids[texture.TextureID] = 1; + } + } + + foreach (TaskInventoryItem tit in part.TaskInventory.Values) + { + if (tit.Type != (int)InventoryType.Object) + { + m_log.DebugFormat("[ARCHIVER]: Recording asset {0} in object {1}", tit.AssetID, part.UUID); + assetUuids[tit.AssetID] = 1; + } + else + { + // TODO: Need to unpack every tit and go through its textures & items, recursively + // this will mean going through the 'assets' received multiple times so that we can + // unpack objects within objects before recursively requesting the inner assets + } + } + } + } + } + + string serializedEntities = SerializeObjects(entities); + + if (serializedEntities != null && serializedEntities.Length > 0) + { + m_log.DebugFormat("[ARCHIVER]: Successfully got serialization for {0} entities", entities.Count); + m_log.DebugFormat("[ARCHIVER]: Requiring save of {0} textures", assetUuids.Count); + + // Asynchronously request all the assets required to perform this archive operation + ArchiveWriteRequestExecution awre = new ArchiveWriteRequestExecution(serializedEntities, m_savePath); + new AssetsRequest(assetUuids.Keys, m_scene.AssetCache, awre.ReceivedAllAssets).Execute(); + } + } + + /// + /// Get an xml representation of the given scene objects. + /// + /// + /// + protected static string SerializeObjects(List entities) + { + string serialization = ""; + + List serObjects = new List(); + + foreach (EntityBase ent in entities) + { + if (ent is SceneObjectGroup) + { + serObjects.Add(((SceneObjectGroup) ent).ToXmlString2()); + } + } + + foreach (string serObject in serObjects) + serialization += serObject; + + serialization += ""; + + return serialization; + } + } +} diff --git a/OpenSim/Region/Environment/Modules/World/Archiver/ArchiverModule.cs b/OpenSim/Region/Environment/Modules/World/Archiver/ArchiverModule.cs index 0e3123e..ae3d333 100644 --- a/OpenSim/Region/Environment/Modules/World/Archiver/ArchiverModule.cs +++ b/OpenSim/Region/Environment/Modules/World/Archiver/ArchiverModule.cs @@ -72,7 +72,7 @@ namespace OpenSim.Region.Environment.Modules.World.Archiver public void ArchiveRegion(string savePath) { - new ArchiveWriteRequest(m_scene, savePath); + new ArchiveWriteRequestPreparation(m_scene, savePath).ArchiveRegion(); } public void DearchiveRegion(string loadPath) diff --git a/OpenSim/Region/Environment/Modules/World/Archiver/AssetsRequest.cs b/OpenSim/Region/Environment/Modules/World/Archiver/AssetsRequest.cs index 2021b70..f41be49 100644 --- a/OpenSim/Region/Environment/Modules/World/Archiver/AssetsRequest.cs +++ b/OpenSim/Region/Environment/Modules/World/Archiver/AssetsRequest.cs @@ -41,6 +41,11 @@ namespace OpenSim.Region.Environment.Modules.World.Archiver class AssetsRequest { /// + /// uuids to request + /// + protected ICollection m_uuids; + + /// /// Callback used when all the assets requested have been received. /// protected AssetsRequestCallback m_assetsRequestCallback; @@ -60,17 +65,21 @@ namespace OpenSim.Region.Environment.Modules.World.Archiver /// protected AssetCache m_assetCache; - protected internal AssetsRequest(AssetsRequestCallback assetsRequestCallback, AssetCache assetCache, ICollection uuids) + protected internal AssetsRequest(ICollection uuids, AssetCache assetCache, AssetsRequestCallback assetsRequestCallback) { + m_uuids = uuids; m_assetsRequestCallback = assetsRequestCallback; m_assetCache = assetCache; m_repliesRequired = uuids.Count; - + } + + protected internal void Execute() + { // We can stop here if there are no assets to fetch if (m_repliesRequired == 0) m_assetsRequestCallback(m_assets); - foreach (LLUUID uuid in uuids) + foreach (LLUUID uuid in m_uuids) { m_assetCache.GetAsset(uuid, AssetRequestCallback, true); } -- cgit v1.1