From 180be7de07014aa33bc6066f12a0819b731c1c9d Mon Sep 17 00:00:00 2001
From: Dr Scofield
Date: Tue, 10 Feb 2009 13:10:57 +0000
Subject: this is step 2 of 2 of the OpenSim.Region.Environment refactor.
NOTHING has been deleted or moved off to forge at this point. what has
happened is that OpenSim.Region.Environment.Modules has been split in two:
- OpenSim.Region.CoreModules: all those modules that are either
directly or indirectly referenced from other OpenSim packages, or
that provide functionality that the OpenSim developer community
considers core functionality:
CoreModules/Agent/AssetTransaction
CoreModules/Agent/Capabilities
CoreModules/Agent/TextureDownload
CoreModules/Agent/TextureSender
CoreModules/Agent/TextureSender/Tests
CoreModules/Agent/Xfer
CoreModules/Avatar/AvatarFactory
CoreModules/Avatar/Chat/ChatModule
CoreModules/Avatar/Combat
CoreModules/Avatar/Currency/SampleMoney
CoreModules/Avatar/Dialog
CoreModules/Avatar/Friends
CoreModules/Avatar/Gestures
CoreModules/Avatar/Groups
CoreModules/Avatar/InstantMessage
CoreModules/Avatar/Inventory
CoreModules/Avatar/Inventory/Archiver
CoreModules/Avatar/Inventory/Transfer
CoreModules/Avatar/Lure
CoreModules/Avatar/ObjectCaps
CoreModules/Avatar/Profiles
CoreModules/Communications/Local
CoreModules/Communications/REST
CoreModules/Framework/EventQueue
CoreModules/Framework/InterfaceCommander
CoreModules/Hypergrid
CoreModules/InterGrid
CoreModules/Scripting/DynamicTexture
CoreModules/Scripting/EMailModules
CoreModules/Scripting/HttpRequest
CoreModules/Scripting/LoadImageURL
CoreModules/Scripting/VectorRender
CoreModules/Scripting/WorldComm
CoreModules/Scripting/XMLRPC
CoreModules/World/Archiver
CoreModules/World/Archiver/Tests
CoreModules/World/Estate
CoreModules/World/Land
CoreModules/World/Permissions
CoreModules/World/Serialiser
CoreModules/World/Sound
CoreModules/World/Sun
CoreModules/World/Terrain
CoreModules/World/Terrain/DefaultEffects
CoreModules/World/Terrain/DefaultEffects/bin
CoreModules/World/Terrain/DefaultEffects/bin/Debug
CoreModules/World/Terrain/Effects
CoreModules/World/Terrain/FileLoaders
CoreModules/World/Terrain/FloodBrushes
CoreModules/World/Terrain/PaintBrushes
CoreModules/World/Terrain/Tests
CoreModules/World/Vegetation
CoreModules/World/Wind
CoreModules/World/WorldMap
- OpenSim.Region.OptionalModules: all those modules that are not core
modules:
OptionalModules/Avatar/Chat/IRC-stuff
OptionalModules/Avatar/Concierge
OptionalModules/Avatar/Voice/AsterixVoice
OptionalModules/Avatar/Voice/SIPVoice
OptionalModules/ContentManagementSystem
OptionalModules/Grid/Interregion
OptionalModules/Python
OptionalModules/SvnSerialiser
OptionalModules/World/NPC
OptionalModules/World/TreePopulator
---
.../World/Serialiser/IFileSerialiser.cs | 36 ++++
.../World/Serialiser/SerialiseObjects.cs | 125 ++++++++++++
.../World/Serialiser/SerialiseTerrain.cs | 53 +++++
.../World/Serialiser/SerialiserModule.cs | 226 +++++++++++++++++++++
4 files changed, 440 insertions(+)
create mode 100644 OpenSim/Region/CoreModules/World/Serialiser/IFileSerialiser.cs
create mode 100644 OpenSim/Region/CoreModules/World/Serialiser/SerialiseObjects.cs
create mode 100644 OpenSim/Region/CoreModules/World/Serialiser/SerialiseTerrain.cs
create mode 100644 OpenSim/Region/CoreModules/World/Serialiser/SerialiserModule.cs
(limited to 'OpenSim/Region/CoreModules/World/Serialiser')
diff --git a/OpenSim/Region/CoreModules/World/Serialiser/IFileSerialiser.cs b/OpenSim/Region/CoreModules/World/Serialiser/IFileSerialiser.cs
new file mode 100644
index 0000000..acc7bb8
--- /dev/null
+++ b/OpenSim/Region/CoreModules/World/Serialiser/IFileSerialiser.cs
@@ -0,0 +1,36 @@
+/*
+ * 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.Region.Framework.Scenes;
+
+namespace OpenSim.Region.CoreModules.World.Serialiser
+{
+ internal interface IFileSerialiser
+ {
+ string WriteToFile(Scene scene, string dir);
+ }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/CoreModules/World/Serialiser/SerialiseObjects.cs b/OpenSim/Region/CoreModules/World/Serialiser/SerialiseObjects.cs
new file mode 100644
index 0000000..ed6448f
--- /dev/null
+++ b/OpenSim/Region/CoreModules/World/Serialiser/SerialiseObjects.cs
@@ -0,0 +1,125 @@
+/*
+ * 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.IO;
+using System.IO.Compression;
+using System.Text;
+using System.Xml;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.CoreModules.World.Serialiser
+{
+ internal class SerialiseObjects : IFileSerialiser
+ {
+ #region IFileSerialiser Members
+
+ public string WriteToFile(Scene scene, string dir)
+ {
+ string targetFileName = dir + "objects.xml";
+
+ SaveSerialisedToFile(targetFileName, scene);
+
+ return "objects.xml";
+ }
+
+ #endregion
+
+ public void SaveSerialisedToFile(string fileName, Scene scene)
+ {
+ string xmlstream = GetObjectXml(scene);
+
+ MemoryStream stream = ReformatXmlString(xmlstream);
+
+ stream.Seek(0, SeekOrigin.Begin);
+ CreateXmlFile(stream, fileName);
+
+ stream.Seek(0, SeekOrigin.Begin);
+ CreateCompressedXmlFile(stream, fileName);
+ }
+
+ private static MemoryStream ReformatXmlString(string xmlstream)
+ {
+ MemoryStream stream = new MemoryStream();
+ XmlTextWriter formatter = new XmlTextWriter(stream, Encoding.UTF8);
+ XmlDocument doc = new XmlDocument();
+
+ doc.LoadXml(xmlstream);
+ formatter.Formatting = Formatting.Indented;
+ doc.WriteContentTo(formatter);
+ formatter.Flush();
+ return stream;
+ }
+
+ private static string GetObjectXml(Scene scene)
+ {
+ string xmlstream = "";
+
+ List EntityList = scene.GetEntities();
+ List EntityXml = new List();
+
+ foreach (EntityBase ent in EntityList)
+ {
+ if (ent is SceneObjectGroup)
+ {
+ EntityXml.Add(((SceneObjectGroup) ent).ToXmlString2());
+ }
+ }
+ EntityXml.Sort();
+
+ foreach (string xml in EntityXml)
+ xmlstream += xml;
+
+ xmlstream += "";
+ return xmlstream;
+ }
+
+ private static void CreateXmlFile(MemoryStream xmlStream, string fileName)
+ {
+ FileStream objectsFile = new FileStream(fileName, FileMode.Create);
+
+ xmlStream.WriteTo(objectsFile);
+ objectsFile.Flush();
+ objectsFile.Close();
+ }
+
+ private static void CreateCompressedXmlFile(MemoryStream xmlStream, string fileName)
+ {
+ #region GZip Compressed Version
+
+ FileStream objectsFileCompressed = new FileStream(fileName + ".gzs", FileMode.Create);
+ MemoryStream gzipMSStream = new MemoryStream();
+ GZipStream gzipStream = new GZipStream(gzipMSStream, CompressionMode.Compress);
+ xmlStream.WriteTo(gzipStream);
+ gzipMSStream.WriteTo(objectsFileCompressed);
+ objectsFileCompressed.Flush();
+ objectsFileCompressed.Close();
+
+ #endregion
+ }
+ }
+}
diff --git a/OpenSim/Region/CoreModules/World/Serialiser/SerialiseTerrain.cs b/OpenSim/Region/CoreModules/World/Serialiser/SerialiseTerrain.cs
new file mode 100644
index 0000000..924218a
--- /dev/null
+++ b/OpenSim/Region/CoreModules/World/Serialiser/SerialiseTerrain.cs
@@ -0,0 +1,53 @@
+/*
+ * 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.Region.CoreModules.World.Terrain;
+using OpenSim.Region.CoreModules.World.Terrain.FileLoaders;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.CoreModules.World.Serialiser
+{
+ internal class SerialiseTerrain : IFileSerialiser
+ {
+ #region IFileSerialiser Members
+
+ public string WriteToFile(Scene scene, string dir)
+ {
+ ITerrainLoader fileSystemExporter = new RAW32();
+ string targetFileName = dir + "heightmap.r32";
+
+ lock (scene.Heightmap)
+ {
+ fileSystemExporter.SaveFile(targetFileName, scene.Heightmap);
+ }
+
+ return "heightmap.r32";
+ }
+
+ #endregion
+ }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/CoreModules/World/Serialiser/SerialiserModule.cs b/OpenSim/Region/CoreModules/World/Serialiser/SerialiserModule.cs
new file mode 100644
index 0000000..7080d5f
--- /dev/null
+++ b/OpenSim/Region/CoreModules/World/Serialiser/SerialiserModule.cs
@@ -0,0 +1,226 @@
+/*
+ * 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;
+using System.Collections.Generic;
+using System.IO;
+using OpenMetaverse;
+using Nini.Config;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.CoreModules.Framework.InterfaceCommander;
+
+namespace OpenSim.Region.CoreModules.World.Serialiser
+{
+ public class SerialiserModule : IRegionModule, IRegionSerialiserModule
+ {
+ private Commander m_commander = new Commander("export");
+ private List m_regions = new List();
+ private string m_savedir = "exports" + "/";
+ private List m_serialisers = new List();
+
+ #region IRegionModule Members
+
+ public void Initialise(Scene scene, IConfigSource source)
+ {
+ scene.RegisterModuleCommander(m_commander);
+ scene.EventManager.OnPluginConsole += EventManager_OnPluginConsole;
+ scene.RegisterModuleInterface(this);
+
+ lock (m_regions)
+ {
+ m_regions.Add(scene);
+ }
+ }
+
+ public void PostInitialise()
+ {
+ lock (m_serialisers)
+ {
+ m_serialisers.Add(new SerialiseTerrain());
+ m_serialisers.Add(new SerialiseObjects());
+ }
+
+ LoadCommanderCommands();
+ }
+
+ public void Close()
+ {
+ m_regions.Clear();
+ }
+
+ public string Name
+ {
+ get { return "ExportSerialisationModule"; }
+ }
+
+ public bool IsSharedModule
+ {
+ get { return true; }
+ }
+
+ #endregion
+
+ #region IRegionSerialiser Members
+
+ public void LoadPrimsFromXml(Scene scene, string fileName, bool newIDS, Vector3 loadOffset)
+ {
+ SceneXmlLoader.LoadPrimsFromXml(scene, fileName, newIDS, loadOffset);
+ }
+
+ public void SavePrimsToXml(Scene scene, string fileName)
+ {
+ SceneXmlLoader.SavePrimsToXml(scene, fileName);
+ }
+
+ public void LoadPrimsFromXml2(Scene scene, string fileName)
+ {
+ SceneXmlLoader.LoadPrimsFromXml2(scene, fileName);
+ }
+
+ public void LoadPrimsFromXml2(Scene scene, TextReader reader, bool startScripts)
+ {
+ SceneXmlLoader.LoadPrimsFromXml2(scene, reader, startScripts);
+ }
+
+ public void SavePrimsToXml2(Scene scene, string fileName)
+ {
+ SceneXmlLoader.SavePrimsToXml2(scene, fileName);
+ }
+
+ public void SavePrimsToXml2(Scene scene, TextWriter stream, Vector3 min, Vector3 max)
+ {
+ SceneXmlLoader.SavePrimsToXml2(scene, stream, min, max);
+ }
+
+ public void SaveNamedPrimsToXml2(Scene scene, string primName, string fileName)
+ {
+ SceneXmlLoader.SaveNamedPrimsToXml2(scene, primName, fileName);
+ }
+
+ public SceneObjectGroup DeserializeGroupFromXml2(string xmlString)
+ {
+ return SceneXmlLoader.DeserializeGroupFromXml2(xmlString);
+ }
+
+ public string SaveGroupToXml2(SceneObjectGroup grp)
+ {
+ return SceneXmlLoader.SaveGroupToXml2(grp);
+ }
+
+ public void SavePrimListToXml2(List entityList, string fileName)
+ {
+ SceneXmlLoader.SavePrimListToXml2(entityList, fileName);
+ }
+
+ public void SavePrimListToXml2(List entityList, TextWriter stream, Vector3 min, Vector3 max)
+ {
+ SceneXmlLoader.SavePrimListToXml2(entityList, stream, min, max);
+ }
+
+ public List SerialiseRegion(Scene scene, string saveDir)
+ {
+ List results = new List();
+
+ if (!Directory.Exists(saveDir))
+ {
+ Directory.CreateDirectory(saveDir);
+ }
+
+ lock (m_serialisers)
+ {
+ foreach (IFileSerialiser serialiser in m_serialisers)
+ {
+ results.Add(serialiser.WriteToFile(scene, saveDir));
+ }
+ }
+
+ TextWriter regionInfoWriter = new StreamWriter(saveDir + "README.TXT");
+ regionInfoWriter.WriteLine("Region Name: " + scene.RegionInfo.RegionName);
+ regionInfoWriter.WriteLine("Region ID: " + scene.RegionInfo.RegionID.ToString());
+ regionInfoWriter.WriteLine("Backup Time: UTC " + DateTime.UtcNow.ToString());
+ regionInfoWriter.WriteLine("Serialise Version: 0.1");
+ regionInfoWriter.Close();
+
+ TextWriter manifestWriter = new StreamWriter(saveDir + "region.manifest");
+ foreach (string line in results)
+ {
+ manifestWriter.WriteLine(line);
+ }
+ manifestWriter.Close();
+
+ return results;
+ }
+
+ #endregion
+
+ private void EventManager_OnPluginConsole(string[] args)
+ {
+ if (args[0] == "export")
+ {
+ string[] tmpArgs = new string[args.Length - 2];
+ int i = 0;
+ for (i = 2; i < args.Length; i++)
+ tmpArgs[i - 2] = args[i];
+
+ m_commander.ProcessConsoleCommand(args[1], tmpArgs);
+ }
+ }
+
+ private void InterfaceSaveRegion(Object[] args)
+ {
+ foreach (Scene region in m_regions)
+ {
+ if (region.RegionInfo.RegionName == (string) args[0])
+ {
+ // List results = SerialiseRegion(region, m_savedir + region.RegionInfo.RegionID.ToString() + "/");
+ SerialiseRegion(region, m_savedir + region.RegionInfo.RegionID.ToString() + "/");
+ }
+ }
+ }
+
+ private void InterfaceSaveAllRegions(Object[] args)
+ {
+ foreach (Scene region in m_regions)
+ {
+ // List results = SerialiseRegion(region, m_savedir + region.RegionInfo.RegionID.ToString() + "/");
+ SerialiseRegion(region, m_savedir + region.RegionInfo.RegionID.ToString() + "/");
+ }
+ }
+
+ private void LoadCommanderCommands()
+ {
+ Command serialiseSceneCommand = new Command("save", CommandIntentions.COMMAND_NON_HAZARDOUS, InterfaceSaveRegion, "Saves the named region into the exports directory.");
+ serialiseSceneCommand.AddArgument("region-name", "The name of the region you wish to export", "String");
+
+ Command serialiseAllScenesCommand = new Command("save-all",CommandIntentions.COMMAND_NON_HAZARDOUS, InterfaceSaveAllRegions, "Saves all regions into the exports directory.");
+
+ m_commander.RegisterCommand("save", serialiseSceneCommand);
+ m_commander.RegisterCommand("save-all", serialiseAllScenesCommand);
+ }
+ }
+}
--
cgit v1.1