/*
* 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.IO;
using libsecondlife;
using OpenSim.Framework.Types;
using OpenSim.Framework.Utilities;
using System.Data;
using System.Data.SqlTypes;
using Mono.Data.SqliteClient;
using OpenSim.Framework.Console;
namespace OpenSim.Framework.Data.SQLite
{
///
/// A User storage interface for the DB4o database system
///
public class SQLiteUserData : SQLiteBase, IUserData
{
///
/// The database manager
///
///
/// Artificial constructor called upon plugin load
///
private const string userSelect = "select * from users";
private DataSet ds;
private SqliteDataAdapter da;
public void Initialise()
{
SqliteConnection conn = new SqliteConnection("URI=file:userprofiles.db,version=3");
TestTables(conn);
ds = new DataSet();
da = new SqliteDataAdapter(new SqliteCommand(userSelect, conn));
lock (ds) {
ds.Tables.Add(createUsersTable());
ds.Tables.Add(createUserAgentsTable());
setupUserCommands(da, conn);
da.Fill(ds.Tables["users"]);
}
return;
}
///
/// Loads a specified user profile from a UUID
///
/// The users UUID
/// A user profile
public UserProfileData GetUserByUUID(LLUUID uuid)
{
lock (ds) {
DataRow row = ds.Tables["users"].Rows.Find(uuid);
if(row != null) {
UserProfileData user = buildUserProfile(row);
row = ds.Tables["useragents"].Rows.Find(uuid);
if(row != null) {
user.CurrentAgent = buildUserAgent(row);
}
return user;
} else {
return null;
}
}
}
///
/// Returns a user by searching for its name
///
/// The users account name
/// A matching users profile
public UserProfileData GetUserByName(string name)
{
return GetUserByName(name.Split(' ')[0], name.Split(' ')[1]);
}
///
/// Returns a user by searching for its name
///
/// The first part of the users account name
/// The second part of the users account name
/// A matching users profile
public UserProfileData GetUserByName(string fname, string lname)
{
string select = "surname = '" + lname + "' and username = '" + fname + "'";
lock (ds) {
DataRow[] rows = ds.Tables["users"].Select(select);
if(rows.Length > 0) {
UserProfileData user = buildUserProfile(rows[0]);
DataRow row = ds.Tables["useragents"].Rows.Find(user.UUID);
if(row != null) {
user.CurrentAgent = buildUserAgent(row);
}
return user;
} else {
return null;
}
}
}
///
/// Returns a user by UUID direct
///
/// The users account ID
/// A matching users profile
public UserAgentData GetAgentByUUID(LLUUID uuid)
{
try
{
return GetUserByUUID(uuid).CurrentAgent;
}
catch (Exception)
{
return null;
}
}
///
/// Returns a session by account name
///
/// The account name
/// The users session agent
public UserAgentData GetAgentByName(string name)
{
return GetAgentByName(name.Split(' ')[0], name.Split(' ')[1]);
}
///
/// Returns a session by account name
///
/// The first part of the users account name
/// The second part of the users account name
/// A user agent
public UserAgentData GetAgentByName(string fname, string lname)
{
try
{
return GetUserByName(fname,lname).CurrentAgent;
}
catch (Exception)
{
return null;
}
}
///
/// Creates a new user profile
///
/// The profile to add to the database
public void AddNewUserProfile(UserProfileData user)
{
DataTable users = ds.Tables["users"];
lock (ds) {
DataRow row = users.Rows.Find(user.UUID);
if (row == null)
{
row = users.NewRow();
fillUserRow(row, user);
users.Rows.Add(row);
}
else
{
fillUserRow(row, user);
}
if(user.CurrentAgent != null) {
DataTable ua = ds.Tables["useragents"];
row = ua.Rows.Find(user.UUID);
if (row == null)
{
row = ua.NewRow();
fillUserAgentRow(row, user.CurrentAgent);
ua.Rows.Add(row);
}
else
{
fillUserAgentRow(row, user.CurrentAgent);
}
}
MainLog.Instance.Verbose("Syncing user database: " + ds.Tables["users"].Rows.Count + " users stored");
// save changes off to disk
da.Update(ds, "users");
}
}
///
/// Creates a new user profile
///
/// The profile to add to the database
/// True on success, false on error
public bool UpdateUserProfile(UserProfileData user)
{
try {
AddNewUserProfile(user);
return true;
} catch (Exception) {
return false;
}
}
///
/// Creates a new user agent
///
/// The agent to add to the database
public void AddNewUserAgent(UserAgentData agent)
{
// Do nothing. yet.
}
///
/// Transfers money between two user accounts
///
/// Starting account
/// End account
/// The amount to move
/// Success?
public bool MoneyTransferRequest(LLUUID from, LLUUID to, uint amount)
{
return true;
}
///
/// Transfers inventory between two accounts
///
/// Move to inventory server
/// Senders account
/// Recievers account
/// Inventory item
/// Success?
public bool InventoryTransferRequest(LLUUID from, LLUUID to, LLUUID item)
{
return true;
}
///
/// Returns the name of the storage provider
///
/// Storage provider name
public string getName()
{
return "Sqlite Userdata";
}
///
/// Returns the version of the storage provider
///
/// Storage provider version
public string GetVersion()
{
return "0.1";
}
/***********************************************************************
*
* DataTable creation
*
**********************************************************************/
/***********************************************************************
*
* Database Definition Functions
*
* This should be db agnostic as we define them in ADO.NET terms
*
**********************************************************************/
private DataTable createUsersTable()
{
DataTable users = new DataTable("users");
createCol(users, "UUID", typeof(System.String));
createCol(users, "username", typeof(System.String));
createCol(users, "surname", typeof(System.String));
createCol(users, "passwordHash", typeof(System.String));
createCol(users, "passwordSalt", typeof(System.String));
createCol(users, "homeRegionX", typeof(System.Int32));
createCol(users, "homeRegionY", typeof(System.Int32));
createCol(users, "homeLocationX", typeof(System.Double));
createCol(users, "homeLocationY", typeof(System.Double));
createCol(users, "homeLocationZ", typeof(System.Double));
createCol(users, "homeLookAtX", typeof(System.Double));
createCol(users, "homeLookAtY", typeof(System.Double));
createCol(users, "homeLookAtZ", typeof(System.Double));
createCol(users, "created", typeof(System.Int32));
createCol(users, "lastLogin", typeof(System.Int32));
createCol(users, "rootInventoryFolderID", typeof(System.String));
createCol(users, "userInventoryURI", typeof(System.String));
createCol(users, "userAssetURI", typeof(System.String));
createCol(users, "profileCanDoMask", typeof(System.Int32));
createCol(users, "ProfileWantDoMask", typeof(System.Int32));
createCol(users, "ProfileAboutText", typeof(System.String));
createCol(users, "profileFirstText", typeof(System.String));
createCol(users, "profileImage", typeof(System.String));
createCol(users, "profileFirstImage", typeof(System.String));
// Add in contraints
users.PrimaryKey = new DataColumn[] { users.Columns["UUID"] };
return users;
}
private DataTable createUserAgentsTable()
{
DataTable ua = new DataTable("useragents");
// this is the UUID of the user
createCol(ua, "UUID", typeof(System.String));
createCol(ua, "agentIP", typeof(System.String));
createCol(ua, "agentPort", typeof(System.Int32));
createCol(ua, "agentOnline", typeof(System.Boolean));
createCol(ua, "sessionID", typeof(System.String));
createCol(ua, "secureSessionID", typeof(System.String));
createCol(ua, "regionID", typeof(System.String));
createCol(ua, "loginTime", typeof(System.Int32));
createCol(ua, "logoutTime", typeof(System.Int32));
createCol(ua, "currentRegion", typeof(System.String));
createCol(ua, "currentHandle", typeof(System.Int32));
// vectors
createCol(ua, "currentPosX", typeof(System.Double));
createCol(ua, "currentPosY", typeof(System.Double));
createCol(ua, "currentPosZ", typeof(System.Double));
// constraints
ua.PrimaryKey = new DataColumn[] { ua.Columns["UUID"] };
return ua;
}
/***********************************************************************
*
* Convert between ADO.NET <=> OpenSim Objects
*
* These should be database independant
*
**********************************************************************/
private UserProfileData buildUserProfile(DataRow row)
{
// TODO: this doesn't work yet because something more
// interesting has to be done to actually get these values
// back out. Not enough time to figure it out yet.
UserProfileData user = new UserProfileData();
user.UUID = new LLUUID((String)row["UUID"]);
user.Firstname = (String)row["username"];
user.Lastname = (String)row["surname"];
user.PasswordHash = (String)row["passwordHash"];
user.PasswordSalt = (String)row["passwordSalt"];
user.HomeRegionX = Convert.ToUInt32(row["homeRegionX"]);
user.HomeRegionY = Convert.ToUInt32(row["homeRegionY"]);
user.HomeLocation = new LLVector3(
Convert.ToSingle(row["homeLocationX"]),
Convert.ToSingle(row["homeLocationY"]),
Convert.ToSingle(row["homeLocationZ"])
);
user.HomeLookAt = new LLVector3(
Convert.ToSingle(row["homeLookAtX"]),
Convert.ToSingle(row["homeLookAtY"]),
Convert.ToSingle(row["homeLookAtZ"])
);
user.Created = Convert.ToInt32(row["created"]);
user.LastLogin = Convert.ToInt32(row["lastLogin"]);
user.RootInventoryFolderId = new LLUUID((String)row["rootInventoryFolderID"]);
user.UserInventoryUri = (String)row["userInventoryURI"];
user.UserAssetUri = (String)row["userAssetURI"];
user.ProfileCanDoMask = Convert.ToUInt32(row["profileCanDoMask"]);
user.ProfileWantDoMask = Convert.ToUInt32(row["ProfileWantDoMask"]);
user.ProfileAboutText = (String)row["ProfileAboutText"];
user.ProfileFirstText = (String)row["profileFirstText"];
user.ProfileImage = new LLUUID((String)row["profileImage"]);
user.ProfileFirstImage = new LLUUID((String)row["profileFirstImage"]);
return user;
}
private void fillUserRow(DataRow row, UserProfileData user)
{
row["UUID"] = user.UUID;
row["username"] = user.Firstname;
row["surname"] = user.Lastname;
row["passwordHash"] = user.PasswordHash;
row["passwordSalt"] = user.PasswordSalt;
row["homeRegionX"] = user.HomeRegionX;
row["homeRegionY"] = user.HomeRegionY;
row["homeLocationX"] = user.HomeLocation.X;
row["homeLocationY"] = user.HomeLocation.Y;
row["homeLocationZ"] = user.HomeLocation.Z;
row["homeLookAtX"] = user.HomeLookAt.X;
row["homeLookAtY"] = user.HomeLookAt.Y;
row["homeLookAtZ"] = user.HomeLookAt.Z;
row["created"] = user.Created;
row["lastLogin"] = user.LastLogin;
row["rootInventoryFolderID"] = user.RootInventoryFolderId;
row["userInventoryURI"] = user.UserInventoryUri;
row["userAssetURI"] = user.UserAssetUri;
row["profileCanDoMask"] = user.ProfileCanDoMask;
row["ProfileWantDoMask"] = user.ProfileWantDoMask;
row["ProfileAboutText"] = user.ProfileAboutText;
row["profileFirstText"] = user.ProfileFirstText;
row["profileImage"] = user.ProfileImage;
row["profileFirstImage"] = user.ProfileFirstImage;
// ADO.NET doesn't handle NULL very well
foreach (DataColumn col in ds.Tables["users"].Columns) {
if (row[col] == null) {
row[col] = "";
}
}
}
private UserAgentData buildUserAgent(DataRow row)
{
UserAgentData ua = new UserAgentData();
ua.UUID = new LLUUID((String)row["UUID"]);
ua.agentIP = (String)row["agentIP"];
ua.agentPort = Convert.ToUInt32(row["agentPort"]);
ua.agentOnline = Convert.ToBoolean(row["agentOnline"]);
ua.sessionID = new LLUUID((String)row["sessionID"]);
ua.secureSessionID = new LLUUID((String)row["secureSessionID"]);
ua.regionID = new LLUUID((String)row["regionID"]);
ua.loginTime = Convert.ToInt32(row["loginTime"]);
ua.logoutTime = Convert.ToInt32(row["logoutTime"]);
ua.currentRegion = new LLUUID((String)row["currentRegion"]);
ua.currentHandle = Convert.ToUInt32(row["currentHandle"]);
ua.currentPos = new LLVector3(
Convert.ToSingle(row["currentPosX"]),
Convert.ToSingle(row["currentPosY"]),
Convert.ToSingle(row["currentPosZ"])
);
return ua;
}
private void fillUserAgentRow(DataRow row, UserAgentData ua)
{
row["UUID"] = ua.UUID;
row["agentIP"] = ua.agentIP;
row["agentPort"] = ua.agentPort;
row["agentOnline"] = ua.agentOnline;
row["sessionID"] = ua.sessionID;
row["secureSessionID"] = ua.secureSessionID;
row["regionID"] = ua.regionID;
row["loginTime"] = ua.loginTime;
row["logoutTime"] = ua.logoutTime;
row["currentRegion"] = ua.currentRegion;
row["currentHandle"] = ua.currentHandle;
// vectors
row["currentPosX"] = ua.currentPos.X;
row["currentPosY"] = ua.currentPos.Y;
row["currentPosZ"] = ua.currentPos.Z;
}
/***********************************************************************
*
* Database Binding functions
*
* These will be db specific due to typing, and minor differences
* in databases.
*
**********************************************************************/
private void setupUserCommands(SqliteDataAdapter da, SqliteConnection conn)
{
da.InsertCommand = createInsertCommand("users", ds.Tables["users"]);
da.InsertCommand.Connection = conn;
da.UpdateCommand = createUpdateCommand("users", "UUID=:UUID", ds.Tables["users"]);
da.UpdateCommand.Connection = conn;
SqliteCommand delete = new SqliteCommand("delete from users where UUID = :UUID");
delete.Parameters.Add(createSqliteParameter("UUID", typeof(System.String)));
delete.Connection = conn;
da.DeleteCommand = delete;
}
private void InitDB(SqliteConnection conn)
{
string createUsers = defineTable(createUsersTable());
SqliteCommand pcmd = new SqliteCommand(createUsers, conn);
conn.Open();
pcmd.ExecuteNonQuery();
conn.Close();
}
private bool TestTables(SqliteConnection conn)
{
SqliteCommand cmd = new SqliteCommand(userSelect, conn);
SqliteDataAdapter pDa = new SqliteDataAdapter(cmd);
DataSet tmpDS = new DataSet();
try {
pDa.Fill(tmpDS, "users");
} catch (Mono.Data.SqliteClient.SqliteSyntaxException) {
MainLog.Instance.Verbose("DATASTORE", "SQLite Database doesn't exist... creating");
InitDB(conn);
}
return true;
}
}
}