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

1 files changed, 362 insertions, 0 deletions

diff --git a/OpenSim/Region/OptionalModules/ContentManagementSystem/CMModel.cs b/OpenSim/Region/OptionalModules/ContentManagementSystem/CMModel.cs
new file mode 100644
index 0000000..761dca9
--- /dev/null
+++ b/OpenSim/Region/OptionalModules/ContentManagementSystem/CMModel.cs
@@ -0,0 +1,362 @@
+/*
+ * 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.
+ */
+
+#region Header
+
+// CMModel.cs
+// User: bongiojp
+//
+//
+
+#endregion Header
+
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Diagnostics;
+
+using OpenMetaverse;
+
+using OpenSim;
+using OpenSim.Framework;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.Physics.Manager;
+
+using log4net;
+
+namespace OpenSim.Region.OptionalModules.ContentManagement
+{
+    public class CMModel
+    {
+        #region Static Fields
+
+        static float TimeToUpdate = 0;
+        static float TimeToConvertXml = 0;
+        private static readonly log4net.ILog m_log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
+
+        #endregion Static Fields
+
+        #region Fields
+
+        /// <value>
+        /// The class that contains all auras and metaentities used in the CMS.
+        /// </value>
+        CMEntityCollection m_MetaEntityCollection = new CMEntityCollection();
+        IContentDatabase m_database = null;
+
+        #endregion Fields
+
+        #region Constructors
+
+        public CMModel()
+        {
+        }
+
+        #endregion Constructors
+
+        #region Public Properties
+
+        public CMEntityCollection MetaEntityCollection
+        {
+            get { return m_MetaEntityCollection; }
+        }
+
+        #endregion Public Properties
+
+        #region Public Methods
+
+        /// <summary>
+        /// Compares the scene's object group list to the list of meta entities. If there is an object group that does not have a corresponding meta entity
+        /// it is a new part that must have a green aura (for diff mode).
+        /// Returns list of ContentManagementEntities
+        /// </summary>
+        public ArrayList CheckForNewEntitiesMissingAuras(Scene scene)
+        {
+            ArrayList missingList = null;
+            ArrayList newList = new ArrayList();
+
+            m_log.Debug("[CONTENT MANAGEMENT] Checking for new scene object parts in scene: " + scene.RegionInfo.RegionName);
+
+            //Check if the current scene has groups not included in the current list of MetaEntities
+            //If so, then the current scene's parts that are new should be marked green.
+            missingList = m_MetaEntityCollection.CheckForMissingEntities(scene.GetEntities());
+
+            foreach (Object missingPart in missingList)
+            {
+                if (m_MetaEntityCollection.Auras.ContainsKey(((SceneObjectPart)missingPart).UUID))
+                    continue;
+                newList.Add(m_MetaEntityCollection.CreateAuraForNewlyCreatedEntity((SceneObjectPart)missingPart));                
+            }
+            m_log.Info("Number of missing objects found: " + newList.Count);
+            return newList;
+        }
+
+        /// <summary>
+        /// Uses the database to serialize all current scene objects into xml and save into a database with an accompanying log message.
+        /// </summary>
+        public void CommitRegion(Scene scene, String logMessage)
+        {
+            m_log.Debug("[CONTENT MANAG] saving " + scene.RegionInfo.RegionName + " with log message: " + logMessage + " length of message: " + logMessage.Length);
+            m_database.SaveRegion(scene.RegionInfo.RegionID, scene.RegionInfo.RegionName, logMessage);
+            m_log.Debug("[CONTENT MANAG] the region name we are dealing with heeeeeeeere: " + scene.RegionInfo.RegionName );
+        }
+
+        public void DeleteAllMetaObjects()
+        {
+            m_MetaEntityCollection.ClearAll();
+        }
+
+        public ContentManagementEntity FindMetaEntityAffectedByUndo(UUID uuid)
+        {
+            ContentManagementEntity ent = GetMetaGroupByPrim(uuid);
+            return ent;
+        }
+
+        //-------------------------------- HELPERS --------------------------------------------------------------------//
+        public ContentManagementEntity GetMetaGroupByPrim(UUID uuid)
+        {
+            foreach (Object ent in m_MetaEntityCollection.Entities.Values)
+            {
+                if (((ContentManagementEntity)ent).HasChildPrim(uuid))
+                    return (ContentManagementEntity)ent;
+            }
+            return null;
+        }
+
+        public void Initialise(string database)
+        {
+            if (database == "FileSystemDatabase")
+                m_database = new FileSystemDatabase();
+            else if (database == "GitDatabase")
+                m_database = new GitDatabase();
+        }
+
+        public void InitialiseDatabase(Scene scene, string dir)
+        {
+            m_database.Initialise(scene, dir);
+        }
+
+        /// <summary>
+        /// Should be called just once to finish initializing the database.
+        /// </summary>
+        public void PostInitialise()
+        {
+            m_database.PostInitialise();
+        }
+
+        /// <summary>
+        /// Removes the green aura when an a new scene object group is deleted.
+        /// </summary>
+        public void RemoveOrUpdateDeletedEntity(SceneObjectGroup group)
+        {
+            // Deal with new parts not revisioned that have been deleted.
+            foreach (SceneObjectPart part in group.Children.Values)
+                if (m_MetaEntityCollection.Auras.ContainsKey(part.UUID))
+                    m_MetaEntityCollection.RemoveNewlyCreatedEntityAura(part.UUID);
+        }
+
+        /// <summary>
+        /// Retrieves the latest revision of a region in xml form,
+        /// converts it to scene object groups and scene presences,
+        /// swaps the current scene's entity list with the revision's list.
+        /// Note: Since deleted objects while
+        /// </summary>
+        public void RollbackRegion(Scene scene)
+        {
+            System.Collections.ArrayList xmllist = null;
+            SceneObjectGroup temp = null;
+            System.Collections.Hashtable deleteListUUIDs = new Hashtable();
+//            Dictionary<LLUUID, EntityBase> SearchList = new Dictionary<LLUUID,EntityBase>();
+            Dictionary<UUID, EntityBase> ReplacementList = new Dictionary<UUID,EntityBase>();
+            int revision = m_database.GetMostRecentRevision(scene.RegionInfo.RegionID);
+//            EntityBase[] searchArray;
+
+            xmllist = m_database.GetRegionObjectXMLList(scene.RegionInfo.RegionID, revision);
+            if (xmllist == null)
+            {
+                m_log.Info("[CMMODEL]: Region (" + scene.RegionInfo.RegionID + ") does not have given revision number (" + revision + ").");
+                return;
+            }
+
+            m_log.Info("[CMMODEL]: Region (" + scene.RegionInfo.RegionID + ") revision number (" + revision + ").");
+            m_log.Info("[CMMODEL]: Scene Objects = " + xmllist.Count);
+            m_log.Info("[CMMODEL]: Converting scene entities list to specified revision.");
+
+            m_log.ErrorFormat("[CMMODEL]: 1");
+
+            foreach (string xml in xmllist)
+            {
+                try{
+                    temp = new SceneObjectGroup(xml);
+                    temp.SetScene(scene);
+                    foreach (SceneObjectPart part in temp.Children.Values)
+                        part.RegionHandle = scene.RegionInfo.RegionHandle;
+                    ReplacementList.Add(temp.UUID, (EntityBase)temp);
+                }
+                catch(Exception e)
+                {
+                    m_log.Info("[CMMODEL]: Error while creating replacement list for rollback: " + e);
+                }
+            }
+
+            //If in scene but not in revision and not a client, remove them
+            while (true)
+            {
+                try
+                {
+                    foreach (EntityBase entity in scene.GetEntities())
+                    {
+                        if (entity == null)
+                            continue;
+
+                        if (entity is ScenePresence)
+                        {
+                            ReplacementList.Add(entity.UUID, entity);
+                            continue;
+                        }
+                        else //if (!ReplacementList.ContainsKey(entity.UUID))
+                            deleteListUUIDs.Add(entity.UUID, 0);
+                    }
+                }
+                catch(Exception e)
+                {
+                    m_log.ErrorFormat("[CMMODEL]: " + e);
+                    deleteListUUIDs.Clear();
+                    ReplacementList.Clear();
+                    continue;
+                }
+                break;
+            }
+
+            foreach (UUID uuid in deleteListUUIDs.Keys)
+            {
+                try
+                {
+                    // I thought that the DeleteGroup() function would handle all of this, but it doesn't. I'm not sure WHAT it handles.
+                    ((SceneObjectGroup)scene.Entities[uuid]).DetachFromBackup();
+                    scene.PhysicsScene.RemovePrim(((SceneObjectGroup)scene.Entities[uuid]).RootPart.PhysActor);
+                    scene.SendKillObject(scene.Entities[uuid].LocalId);
+                    scene.m_sceneGraph.DeleteSceneObject(uuid, false);
+                    ((SceneObjectGroup)scene.Entities[uuid]).DeleteGroup(false);
+                }
+                catch(Exception e)
+                {
+                    m_log.ErrorFormat("[CMMODEL]: Error while removing objects from scene: " + e);
+                }
+            }
+
+            lock (scene)
+            {
+                scene.Entities.Clear();
+
+                foreach (KeyValuePair<UUID,EntityBase> kvp in ReplacementList)
+                {
+                    scene.Entities.Add(kvp.Value);
+                }
+            }
+
+            foreach (EntityBase ent in ReplacementList.Values)
+            {
+                try
+                {
+                    if (!(ent is SceneObjectGroup))
+                        continue;
+
+                    if ((((SceneObjectGroup)ent).RootPart.GetEffectiveObjectFlags() & (uint) PrimFlags.Phantom) == 0)
+                        ((SceneObjectGroup)ent).ApplyPhysics(true);
+                    ((SceneObjectGroup)ent).AttachToBackup();
+                    ((SceneObjectGroup)ent).HasGroupChanged = true; // If not true, then attaching to backup does nothing because no change is detected.
+                    ((SceneObjectGroup)ent).ScheduleGroupForFullUpdate();
+                }
+                catch(Exception e)
+                {
+                    m_log.ErrorFormat("[CMMODEL]: Error while attaching new scene entities to backup and scheduling for a full update: " + e);
+                }
+            }
+            m_log.Info("[CMMODEL]: Scheduling a backup of new scene object groups to backup.");
+            scene.Backup();
+        }
+
+        /// <summary>
+        /// Downloads the latest revision of the given scene and converts the xml file to CMEntities. After this method, the view can find the differences
+        /// and display the differences to clients.
+        /// </summary>
+        public void UpdateCMEntities(Scene scene)
+        {
+            Stopwatch x = new Stopwatch();
+            x.Start();
+
+            System.Collections.ArrayList xmllist = null;
+            m_log.Debug("[CONTENT MANAGEMENT] Retrieving object xml files for region: " + scene.RegionInfo.RegionID);
+            xmllist = m_database.GetRegionObjectXMLList(scene.RegionInfo.RegionID);
+            m_log.Info("[FSDB]: got list");
+            if (xmllist == null)
+                return;
+
+            Stopwatch y = new Stopwatch();
+            y.Start();
+            foreach (string xml in xmllist)
+                m_MetaEntityCollection.CreateNewEntity(xml, scene);
+            y.Stop();
+            TimeToConvertXml += y.ElapsedMilliseconds;
+            m_log.Info("[FileSystemDatabase] Time spent converting xml to metaentities for " + scene.RegionInfo.RegionName + ": " + y.ElapsedMilliseconds);
+            m_log.Info("[FileSystemDatabase] Time spent converting xml to metaentities so far: " + TimeToConvertXml);
+
+            m_log.Info("[FSDB]: checking for new scene object parts missing green auras and create the auras");
+            CheckForNewEntitiesMissingAuras(scene);
+
+            x.Stop();
+            TimeToUpdate += x.ElapsedMilliseconds;
+            m_log.Info("[FileSystemDatabase] Time spent Updating entity list for " + scene.RegionInfo.RegionName + ": " + x.ElapsedMilliseconds);
+            m_log.Info("[FileSystemDatabase] Time spent Updating so far: " + TimeToUpdate);
+        }
+
+        /// <summary>
+        /// Detects if a scene object group from the scene list has moved or changed scale. The green aura
+        /// that surrounds the object is then moved or scaled with the group.
+        /// </summary>
+        public System.Collections.ArrayList UpdateNormalEntityEffects(SceneObjectGroup group)
+        {
+            System.Collections.ArrayList auraList = new System.Collections.ArrayList();
+            if (group == null)
+                return null;
+            foreach (SceneObjectPart part in group.Children.Values)
+            {
+                if (m_MetaEntityCollection.Auras.ContainsKey(part.UUID))
+                {
+                    ((AuraMetaEntity)m_MetaEntityCollection.Auras[part.UUID]).SetAura(new Vector3(0,254,0), part.Scale);
+                    ((AuraMetaEntity)m_MetaEntityCollection.Auras[part.UUID]).RootPart.GroupPosition = part.GetWorldPosition();
+                    auraList.Add((AuraMetaEntity)m_MetaEntityCollection.Auras[part.UUID]);
+                }
+            }
+            return auraList;
+        }
+
+        #endregion Public Methods
+    }
+}