* Apply http://opensimulator.org/mantis/view.php?id=3166

* Adds estate access list supports to NHibernate data module
* Thanks Tommil

1 files changed, 150 insertions, 37 deletions

diff --git a/OpenSim/Data/NHibernate/NHibernateManager.cs b/OpenSim/Data/NHibernate/NHibernateManager.cs
index 26bc219..cef98f2 100644
--- a/OpenSim/Data/NHibernate/NHibernateManager.cs
+++ b/OpenSim/Data/NHibernate/NHibernateManager.cs
@@ -45,6 +45,43 @@ namespace OpenSim.Data.NHibernate
         private Configuration configuration;
         private ISessionFactory sessionFactory;
 
+        #region Initialization
+
+        /// <summary>
+        /// Initiate NHibernate Manager
+        /// </summary>
+        /// <param name="connect">NHibernate dialect, driver and connection string separated by ';'</param>
+        /// <param name="store">Name of the store</param>
+        public NHibernateManager(string connect, string store)
+        {
+            ParseConnectionString(connect);
+
+            //To create sql file uncomment code below and write the name of the file
+            //SchemaExport exp = new SchemaExport(cfg);
+            //exp.SetOutputFile("nameofthefile.sql");
+            //exp.Create(false, true); 
+
+            Assembly assembly = GetType().Assembly;
+
+            sessionFactory = configuration.BuildSessionFactory();
+            RunMigration(dialect, assembly, store);
+        }
+
+        /// <summary>
+        /// Initiate NHibernate Manager with spesific assembly
+        /// </summary>
+        /// <param name="connect">NHibernate dialect, driver and connection string separated by ';'</param>
+        /// <param name="store">Name of the store</param>
+        /// <param name="assembly">Outside assembly to be included </param>
+        public NHibernateManager(string connect, string store, Assembly assembly)
+        {
+            ParseConnectionString(connect);
+
+            configuration.AddAssembly(assembly);
+            sessionFactory = configuration.BuildSessionFactory();
+            RunMigration(dialect, assembly, store);
+        }
+
         /// <summary>
         /// Parses the connection string and creates the NHibernate configuration
         /// </summary>
@@ -72,7 +109,6 @@ namespace OpenSim.Data.NHibernate
                             "NHibernate.Driver." + parts[1]);
             configuration.SetProperty(Environment.ConnectionString, parts[2]);
             configuration.AddAssembly("OpenSim.Data.NHibernate");
-
         }
 
         /// <summary>
@@ -96,44 +132,42 @@ namespace OpenSim.Data.NHibernate
             migration.Update();
         }
 
+        #endregion
+
         /// <summary>
-        /// Initiate NHibernate Manager
+        /// Gets object of given type from database with given id. 
+        /// Uses stateless session for efficiency.
         /// </summary>
-        /// <param name="connect">NHibernate dialect, driver and connection string separated by ';'</param>
-        /// <param name="store">Name of the store</param>
-        public NHibernateManager(string connect, string store)
+        /// <param name="type">Type of the object.</param>
+        /// <param name="id">Id of the object.</param>
+        /// <returns>The object or null if object was not found.</returns>
+        public object Get(Type type, Object id)
         {
-            ParseConnectionString(connect);
-
-            //To create sql file uncomment code below and write the name of the file
-            //SchemaExport exp = new SchemaExport(cfg);
-            //exp.SetOutputFile("nameofthefile.sql");
-            //exp.Create(false, true); 
-
-            Assembly assembly = GetType().Assembly;
-
-            sessionFactory = configuration.BuildSessionFactory();
-            RunMigration(dialect, assembly, store);
+            using (IStatelessSession session = sessionFactory.OpenStatelessSession())
+            {
+                object obj = null;
+                try
+                {
+                    obj = session.Get(type.FullName, id);
+                }
+                catch (Exception e)
+                {
+                    m_log.ErrorFormat("[NHIBERNATE] {0} of id {1} loading threw exception: " + e.ToString(), type.Name, id);
+                }
+                return obj;
+            }            
         }
 
         /// <summary>
-        /// Initiate NHibernate Manager with spesific assembly
+        /// Gets object of given type from database with given id. 
+        /// Use this method for objects containing collections. For flat objects stateless mode is more efficient.
         /// </summary>
-        /// <param name="connect">NHibernate dialect, driver and connection string separated by ';'</param>
-        /// <param name="store">Name of the store</param>
-        /// <param name="assembly">Outside assembly to be included </param>
-        public NHibernateManager(string connect, string store, Assembly assembly)
+        /// <param name="type">Type of the object.</param>
+        /// <param name="id">Id of the object.</param>
+        /// <returns>The object or null if object was not found.</returns>
+        public object GetWithStatefullSession(Type type, Object id)
         {
-            ParseConnectionString(connect);
-
-            configuration.AddAssembly(assembly);
-            sessionFactory = configuration.BuildSessionFactory();
-            RunMigration(dialect, assembly, store);
-        }
-
-        public object Load(Type type, Object id)
-        {
-            using (IStatelessSession session = sessionFactory.OpenStatelessSession())
+            using (ISession session = sessionFactory.OpenSession())
             {
                 object obj = null;
                 try
@@ -146,9 +180,15 @@ namespace OpenSim.Data.NHibernate
                 }
                 return obj;
             }
-            
+
         }
 
+        /// <summary>
+        /// Inserts given object to database.
+        /// Uses stateless session for efficiency.
+        /// </summary>
+        /// <param name="obj">Object to be insterted.</param>
+        /// <returns>Identifier of the object. Useful for situations when NHibernate generates the identifier.</returns>
         public object Insert(object obj)
         {
             try
@@ -170,6 +210,39 @@ namespace OpenSim.Data.NHibernate
             }
         }
 
+        /// <summary>
+        /// Inserts given object to database.
+        /// Use this method for objects containing collections. For flat objects stateless mode is more efficient.
+        /// </summary>
+        /// <param name="obj">Object to be insterted.</param>
+        /// <returns>Identifier of the object. Useful for situations when NHibernate generates the identifier.</returns>
+        public object InsertWithStatefullSession(object obj)
+        {
+            try
+            {
+                using (ISession session = sessionFactory.OpenSession())
+                {
+                    using (ITransaction transaction = session.BeginTransaction())
+                    {
+                        Object identifier = session.Save(obj);
+                        transaction.Commit();
+                        return identifier;
+                    }
+                }
+            }
+            catch (Exception e)
+            {
+                m_log.Error("[NHIBERNATE] issue inserting object ", e);
+                return null;
+            }
+        }
+
+        /// <summary>
+        /// Updates given object to database.
+        /// Uses stateless session for efficiency.
+        /// </summary>
+        /// <param name="obj">Object to be updated.</param>
+        /// <returns>True if operation was succesful.</returns>
         public bool Update(object obj)
         {
             try
@@ -191,6 +264,38 @@ namespace OpenSim.Data.NHibernate
             }
         }
 
+        /// <summary>
+        /// Updates given object to database.
+        /// Use this method for objects containing collections. For flat objects stateless mode is more efficient.
+        /// </summary>
+        /// <param name="obj">Object to be updated.</param>
+        /// <returns>True if operation was succesful.</returns>
+        public bool UpdateWithStatefullSession(object obj)
+        {
+            try
+            {
+                using (ISession session = sessionFactory.OpenSession())
+                {
+                    using (ITransaction transaction = session.BeginTransaction())
+                    {
+                        session.Update(obj);
+                        transaction.Commit();
+                        return true;
+                    }
+                }
+            }
+            catch (Exception e)
+            {
+                m_log.Error("[NHIBERNATE] issue updating object ", e);
+                return false;
+            }
+        }
+
+        /// <summary>
+        /// Deletes given object from database.
+        /// </summary>
+        /// <param name="obj">Object to be deleted.</param>
+        /// <returns>True if operation was succesful.</returns>
         public bool Delete(object obj)
         {
             try
@@ -212,6 +317,18 @@ namespace OpenSim.Data.NHibernate
             }
         }
 
+        /// <summary>
+        /// Returns statefull session which can be used to execute custom nhibernate or sql queries.
+        /// </summary>
+        /// <returns>Statefull session</returns>
+        public ISession GetSession()
+        {
+            return sessionFactory.OpenSession();
+        }
+
+        /// <summary>
+        /// Drops the database schema. This exist for unit tests. It should not be invoked from other than test teardown.
+        /// </summary>
         public void DropSchema()
         {
             SchemaExport export = new SchemaExport(this.configuration);
@@ -219,14 +336,10 @@ namespace OpenSim.Data.NHibernate
 
             using (ISession session = sessionFactory.OpenSession())
             {
-                ISQLQuery sqlQuery=session.CreateSQLQuery("drop table migrations");
+                ISQLQuery sqlQuery = session.CreateSQLQuery("drop table migrations");
                 sqlQuery.ExecuteUpdate();
             }
         }
 
-        public ISession GetSession()
-        {
-            return sessionFactory.OpenSession();
-        }
     }
 }