/*
* 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 System.Reflection;
using System.Text.RegularExpressions;
using libsecondlife;
using log4net;
using NHibernate;
using NHibernate.Cfg;
using NHibernate.Expression;
using NHibernate.Mapping.Attributes;
using NHibernate.Tool.hbm2ddl;
using OpenSim.Framework;
using Environment=NHibernate.Cfg.Environment;
namespace OpenSim.Data.NHibernate
{
public class NHibernateInventoryData: IInventoryData
{
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
private Configuration cfg;
private ISessionFactory factory;
///
/// Initialises the interface
///
public void Initialise(string connect)
{
// Split out the dialect, driver, and connect string
char[] split = {';'};
string[] parts = connect.Split(split, 3);
if (parts.Length != 3)
{
// TODO: make this a real exception type
throw new Exception("Malformed Inventory connection string '" + connect + "'");
}
// Establish NHibernate Connection
cfg = new Configuration();
cfg.SetProperty(Environment.ConnectionProvider,
"NHibernate.Connection.DriverConnectionProvider");
cfg.SetProperty(Environment.Dialect,
"NHibernate.Dialect." + parts[0]);
cfg.SetProperty(Environment.ConnectionDriver,
"NHibernate.Driver." + parts[1]);
cfg.SetProperty(Environment.ConnectionString, parts[2]);
cfg.AddAssembly("OpenSim.Data.NHibernate");
HbmSerializer.Default.Validate = true;
using ( MemoryStream stream =
HbmSerializer.Default.Serialize(Assembly.GetExecutingAssembly()))
cfg.AddInputStream(stream);
// If uncommented this will auto create tables, but it
// does drops of the old tables, so we need a smarter way
// to acturally manage this.
// new SchemaExport(cfg).Create(true, true);
factory = cfg.BuildSessionFactory();
InitDB();
}
private void InitDB()
{
string regex = @"no such table: Inventory";
Regex RE = new Regex(regex, RegexOptions.Multiline);
try
{
using (ISession session = factory.OpenSession())
{
session.Load(typeof(InventoryItemBase), LLUUID.Zero);
}
}
catch (ObjectNotFoundException)
{
// yes, we know it's not there, but that's ok
}
catch (ADOException e)
{
Match m = RE.Match(e.ToString());
if (m.Success)
{
// We don't have this table, so create it.
new SchemaExport(cfg).Create(true, true);
}
}
}
/*****************************************************************
*
* Basic CRUD operations on Data
*
****************************************************************/
// READ
///
/// Returns an inventory item by its UUID
///
/// The UUID of the item to be returned
/// A class containing item information
public InventoryItemBase getInventoryItem(LLUUID item)
{
using (ISession session = factory.OpenSession())
{
try
{
return session.Load(typeof(InventoryItemBase), item) as InventoryItemBase;
}
catch
{
m_log.ErrorFormat("Couldn't find inventory item: {0}", item);
return null;
}
}
}
///
/// Creates a new inventory item based on item
///
/// The item to be created
public void addInventoryItem(InventoryItemBase item)
{
if (!ExistsItem(item.ID))
{
using (ISession session = factory.OpenSession())
{
using (ITransaction transaction = session.BeginTransaction())
{
session.Save(item);
transaction.Commit();
}
}
}
else
{
m_log.ErrorFormat("Attempted to add Inventory Item {0} that already exists, updating instead", item.ID);
updateInventoryItem(item);
}
}
///
/// Updates an inventory item with item (updates based on ID)
///
/// The updated item
public void updateInventoryItem(InventoryItemBase item)
{
if (ExistsItem(item.ID))
{
using (ISession session = factory.OpenSession())
{
using (ITransaction transaction = session.BeginTransaction())
{
session.Update(item);
transaction.Commit();
}
}
}
else
{
m_log.ErrorFormat("Attempted to add Inventory Item {0} that already exists", item.ID);
}
}
///
///
///
///
public void deleteInventoryItem(LLUUID itemID)
{
using (ISession session = factory.OpenSession())
{
using (ITransaction transaction = session.BeginTransaction())
{
session.Delete(itemID);
transaction.Commit();
}
}
}
///
/// Returns an inventory folder by its UUID
///
/// The UUID of the folder to be returned
/// A class containing folder information
public InventoryFolderBase getInventoryFolder(LLUUID folder)
{
using (ISession session = factory.OpenSession())
{
try
{
return session.Load(typeof(InventoryFolderBase), folder) as InventoryFolderBase;
}
catch
{
m_log.ErrorFormat("Couldn't find inventory item: {0}", folder);
return null;
}
}
}
///
/// Creates a new inventory folder based on folder
///
/// The folder to be created
public void addInventoryFolder(InventoryFolderBase folder)
{
if (!ExistsFolder(folder.ID))
{
using (ISession session = factory.OpenSession())
{
using (ITransaction transaction = session.BeginTransaction())
{
session.Save(folder);
transaction.Commit();
}
}
}
else
{
m_log.ErrorFormat("Attempted to add Inventory Folder {0} that already exists, updating instead", folder.ID);
updateInventoryFolder(folder);
}
}
///
/// Updates an inventory folder with folder (updates based on ID)
///
/// The updated folder
public void updateInventoryFolder(InventoryFolderBase folder)
{
if (ExistsFolder(folder.ID))
{
using (ISession session = factory.OpenSession())
{
using (ITransaction transaction = session.BeginTransaction())
{
session.Update(folder);
transaction.Commit();
}
}
}
else
{
m_log.ErrorFormat("Attempted to add Inventory Folder {0} that already exists", folder.ID);
}
}
///
///
///
///
public void deleteInventoryFolder(LLUUID folderID)
{
using (ISession session = factory.OpenSession())
{
using (ITransaction transaction = session.BeginTransaction())
{
session.Delete(folderID.ToString());
transaction.Commit();
}
}
}
// useful private methods
private bool ExistsItem(LLUUID uuid)
{
return (getInventoryItem(uuid) != null) ? true : false;
}
private bool ExistsFolder(LLUUID uuid)
{
return (getInventoryFolder(uuid) != null) ? true : false;
}
public void Shutdown()
{
// TODO: DataSet commit
}
///
/// Closes the interface
///
public void Close()
{
}
///
/// The plugin being loaded
///
/// A string containing the plugin name
public string getName()
{
return "NHibernate Inventory Data Interface";
}
///
/// The plugins version
///
/// A string containing the plugin version
public string getVersion()
{
Module module = GetType().Module;
string dllName = module.Assembly.ManifestModule.Name;
Version dllVersion = module.Assembly.GetName().Version;
return
string.Format("{0}.{1}.{2}.{3}", dllVersion.Major, dllVersion.Minor, dllVersion.Build,
dllVersion.Revision);
}
// Move seems to be just update
public void moveInventoryFolder(InventoryFolderBase folder)
{
updateInventoryFolder(folder);
}
public void moveInventoryItem(InventoryItemBase item)
{
updateInventoryItem(item);
}
///
/// Returns a list of inventory items contained within the specified folder
///
/// The UUID of the target folder
/// A List of InventoryItemBase items
public List getInventoryInFolder(LLUUID folderID)
{
using (ISession session = factory.OpenSession())
{
// try {
ICriteria criteria = session.CreateCriteria(typeof(InventoryItemBase));
criteria.Add(Expression.Eq("Folder", folderID));
List list = new List();
foreach (InventoryItemBase item in criteria.List())
{
list.Add(item);
}
return list;
// }
// catch
// {
// return new List();
// }
}
}
public List getUserRootFolders(LLUUID user)
{
return new List();
}
// see InventoryItemBase.getUserRootFolder
public InventoryFolderBase getUserRootFolder(LLUUID user)
{
using (ISession session = factory.OpenSession())
{
ICriteria criteria = session.CreateCriteria(typeof(InventoryFolderBase));
criteria.Add(Expression.Eq("ParentID", LLUUID.Zero));
criteria.Add(Expression.Eq("Owner", user));
foreach (InventoryFolderBase folder in criteria.List())
{
return folder;
}
m_log.ErrorFormat("No Inventory Root Folder Found for: {0}", user);
return null;
}
}
///
/// Append a list of all the child folders of a parent folder
///
/// list where folders will be appended
/// ID of parent
private void getInventoryFolders(ref List folders, LLUUID parentID)
{
using (ISession session = factory.OpenSession())
{
ICriteria criteria = session.CreateCriteria(typeof(InventoryFolderBase));
criteria.Add(Expression.Eq("ParentID", parentID));
foreach (InventoryFolderBase item in criteria.List())
{
folders.Add(item);
}
}
}
///
/// Returns a list of inventory folders contained in the folder 'parentID'
///
/// The folder to get subfolders for
/// A list of inventory folders
public List getInventoryFolders(LLUUID parentID)
{
List folders = new List();
getInventoryFolders(ref folders, parentID);
return folders;
}
// See IInventoryData
public List getFolderHierarchy(LLUUID parentID)
{
List folders = new List();
getInventoryFolders(ref folders, parentID);
for (int i = 0; i < folders.Count; i++)
getInventoryFolders(ref folders, folders[i].ID);
return folders;
}
}
}