/*
* 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.Data;
using libsecondlife;
using Mono.Data.SqliteClient;
using OpenSim.Framework.Console;
namespace OpenSim.Framework.Data.SQLite
{
///
/// A User storage interface for the SQLite database system
///
public class SQLiteUserData : SQLiteBase, IUserData
{
///
/// The database manager
///
///
/// Artificial constructor called upon plugin load
///
private const string userSelect = "select * from users";
private const string userFriendsSelect = "select a.ownerID as ownerID,a.friendID as friendID,a.friendPerms as friendPerms,b.friendPerms as ownerperms, b.ownerID as fownerID, b.friendID as ffriendID from userfriends as a, userfriends as b";
private DataSet ds;
private SqliteDataAdapter da;
private SqliteDataAdapter daf;
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));
daf = new SqliteDataAdapter(new SqliteCommand(userFriendsSelect, conn));
lock (ds)
{
ds.Tables.Add(createUsersTable());
ds.Tables.Add(createUserAgentsTable());
ds.Tables.Add(createUserFriendsTable());
setupUserCommands(da, conn);
da.Fill(ds.Tables["users"]);
setupUserFriendsCommands(daf, conn);
try
{
daf.Fill(ds.Tables["userfriends"]);
}
catch (SqliteSyntaxException)
{
MainLog.Instance.Verbose("SQLITE", "userfriends table not found, creating.... ");
InitDB(conn);
daf.Fill(ds.Tables["userfriends"]);
}
}
return;
}
// see IUserData
public UserProfileData GetUserByUUID(LLUUID uuid)
{
lock (ds)
{
DataRow row = ds.Tables["users"].Rows.Find(Util.ToRawUuidString(uuid));
if (row != null)
{
UserProfileData user = buildUserProfile(row);
row = ds.Tables["useragents"].Rows.Find(Util.ToRawUuidString(uuid));
if (row != null)
{
user.currentAgent = buildUserAgent(row);
}
return user;
}
else
{
return null;
}
}
}
// see IUserData
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(Util.ToRawUuidString(user.UUID));
if (row != null)
{
user.currentAgent = buildUserAgent(row);
}
return user;
}
else
{
return null;
}
}
}
#region User Friends List Data
public void AddNewUserFriend(LLUUID friendlistowner, LLUUID friend, uint perms)
{
//do stuff;
MainLog.Instance.Verbose("FRIEND", "Stub AddNewUserFriend called");
DataTable friends = ds.Tables["userfriends"];
DataTable ua = ds.Tables["userfriends"];
lock (ds)
{
DataRow row = friends.NewRow();
fillFriendRow(row, friendlistowner,friend,perms);
friends.Rows.Add(row);
row = friends.NewRow();
fillFriendRow(row, friend, friendlistowner, perms);
friends.Rows.Add(row);
MainLog.Instance.Verbose("SQLITE",
"Adding Friend: " + ds.Tables["userfriends"].Rows.Count + " friends stored");
// save changes off to disk
daf.Update(ds, "userfriends");
}
}
public void RemoveUserFriend(LLUUID friendlistowner, LLUUID friend)
{
DataTable ua = ds.Tables["userfriends"];
string select = "a.ownernID '" + friendlistowner.UUID.ToString() + "' and b.friendID ='" + friend.UUID.ToString() + "';";
lock (ds)
{
DataRow[] rows = ds.Tables["userfriends"].Select(select);
if ( rows != null)
{
if (rows.Length > 0)
{
for (int i = 0; i < rows.Length; i++)
{
FriendListItem user = new FriendListItem();
DataRow row = rows[i];
row.Delete();
}
daf.Update(ds, "userfriends");
}
}
}
MainLog.Instance.Verbose("FRIEND", "Stub RemoveUserFriend called");
}
public void UpdateUserFriendPerms(LLUUID friendlistowner, LLUUID friend, uint perms)
{
DataTable ua = ds.Tables["userfriends"];
string select = "a.ownernID '" + friendlistowner.UUID.ToString() + "' and b.friendID ='" + friend.UUID.ToString() + "';";
lock (ds)
{
DataRow[] rows = ds.Tables["userfriends"].Select(select);
if ( rows != null)
{
if (rows.Length > 0)
{
for (int i = 0; i < rows.Length; i++)
{
FriendListItem user = new FriendListItem();
DataRow row = rows[i];
row["friendPerms"] = Convert.ToInt32(perms);
}
daf.Update(ds, "userfriends");
}
}
}
MainLog.Instance.Verbose("FRIEND", "Stub UpdateUserFriendPerms called");
}
public List GetUserFriendList(LLUUID friendlistowner)
{
List returnlist = new List();
string select = "ownerID = '" + friendlistowner.UUID.ToString() + "' and fownerID = friendID and ffriendID = ownerID";
lock (ds)
{
DataRow[] rows = ds.Tables["userfriends"].Select(select);
if (rows.Length > 0)
{
for (int i = 0; i < rows.Length; i++)
{
FriendListItem user = new FriendListItem();
DataRow row = rows[i];
user.FriendListOwner = new LLUUID((string)row[0]);
user.Friend = new LLUUID((string)row[1]);
user.FriendPerms = Convert.ToUInt32(row[2]);
user.FriendListOwnerPerms = Convert.ToUInt32(row[3]);
returnlist.Add(user);
}
}
}
return returnlist;
}
#endregion
public void UpdateUserCurrentRegion(LLUUID avatarid, LLUUID regionuuid)
{
MainLog.Instance.Verbose("USER", "Stub UpdateUserCUrrentRegion called");
}
public void LogOffUser(LLUUID avatarid)
{
MainLog.Instance.Verbose("USER", "Stub LogOffUser called");
}
public List GeneratePickerResults(LLUUID queryID, string query)
{
List returnlist = new List();
string[] querysplit;
querysplit = query.Split(' ');
if (querysplit.Length == 2)
{
string select = "username like '" + querysplit[0] + "%' and surname like '" + querysplit[1] + "%'";
lock (ds)
{
DataRow[] rows = ds.Tables["users"].Select(select);
if (rows.Length > 0)
{
for (int i = 0; i < rows.Length; i++)
{
Framework.AvatarPickerAvatar user = new Framework.AvatarPickerAvatar();
DataRow row = rows[i];
user.AvatarID = new LLUUID((string) row["UUID"]);
user.firstName = (string) row["username"];
user.lastName = (string) row["surname"];
returnlist.Add(user);
}
}
}
}
else if (querysplit.Length == 1)
{
string select = "username like '" + querysplit[0] + "%' OR surname like '" + querysplit[0] + "%'";
lock (ds)
{
DataRow[] rows = ds.Tables["users"].Select(select);
if (rows.Length > 0)
{
for (int i = 0; i < rows.Length; i++)
{
Framework.AvatarPickerAvatar user = new Framework.AvatarPickerAvatar();
DataRow row = rows[i];
user.AvatarID = new LLUUID((string) row[0]);
user.firstName = (string) row[1];
user.lastName = (string) row[2];
returnlist.Add(user);
}
}
}
}
return returnlist;
}
///
/// Returns a user by UUID direct
///
/// The user's account ID
/// A matching user 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 user's 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 user's account name
/// The second part of the user's 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(Util.ToRawUuidString(user.UUID));
if (row == null)
{
row = users.NewRow();
fillUserRow(row, user);
users.Rows.Add(row);
}
else
{
fillUserRow(row, user);
}
// This is why we're getting the 'logins never log-off'.. because It isn't clearing the
// useragents table once the useragent is null
//
// A database guy should look at this and figure out the best way to clear the useragents table.
if (user.currentAgent != null)
{
DataTable ua = ds.Tables["useragents"];
row = ua.Rows.Find(Util.ToRawUuidString(user.UUID));
if (row == null)
{
row = ua.NewRow();
fillUserAgentRow(row, user.currentAgent);
ua.Rows.Add(row);
}
else
{
fillUserAgentRow(row, user.currentAgent);
}
}
else
{
// I just added this to help the standalone login situation.
//It still needs to be looked at by a Database guy
DataTable ua = ds.Tables["useragents"];
row = ua.Rows.Find(Util.ToRawUuidString(user.UUID));
if (row == null)
{
// do nothing
}
else
{
row.Delete();
ua.AcceptChanges();
}
}
MainLog.Instance.Verbose("SQLITE",
"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
/// Receivers 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 (String));
createCol(users, "username", typeof (String));
createCol(users, "surname", typeof (String));
createCol(users, "passwordHash", typeof (String));
createCol(users, "passwordSalt", typeof (String));
createCol(users, "homeRegionX", typeof (Int32));
createCol(users, "homeRegionY", typeof (Int32));
createCol(users, "homeLocationX", typeof (Double));
createCol(users, "homeLocationY", typeof (Double));
createCol(users, "homeLocationZ", typeof (Double));
createCol(users, "homeLookAtX", typeof (Double));
createCol(users, "homeLookAtY", typeof (Double));
createCol(users, "homeLookAtZ", typeof (Double));
createCol(users, "created", typeof (Int32));
createCol(users, "lastLogin", typeof (Int32));
createCol(users, "rootInventoryFolderID", typeof (String));
createCol(users, "userInventoryURI", typeof (String));
createCol(users, "userAssetURI", typeof (String));
createCol(users, "profileCanDoMask", typeof (Int32));
createCol(users, "profileWantDoMask", typeof (Int32));
createCol(users, "profileAboutText", typeof (String));
createCol(users, "profileFirstText", typeof (String));
createCol(users, "profileImage", typeof (String));
createCol(users, "profileFirstImage", typeof (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 (String));
createCol(ua, "agentIP", typeof (String));
createCol(ua, "agentPort", typeof (Int32));
createCol(ua, "agentOnline", typeof (Boolean));
createCol(ua, "sessionID", typeof (String));
createCol(ua, "secureSessionID", typeof (String));
createCol(ua, "regionID", typeof (String));
createCol(ua, "loginTime", typeof (Int32));
createCol(ua, "logoutTime", typeof (Int32));
createCol(ua, "currentRegion", typeof (String));
createCol(ua, "currentHandle", typeof (String));
// vectors
createCol(ua, "currentPosX", typeof (Double));
createCol(ua, "currentPosY", typeof (Double));
createCol(ua, "currentPosZ", typeof (Double));
// constraints
ua.PrimaryKey = new DataColumn[] {ua.Columns["UUID"]};
return ua;
}
private DataTable createUserFriendsTable()
{
DataTable ua = new DataTable("userfriends");
// table contains user <----> user relationship with perms
createCol(ua, "ownerID", typeof(String));
createCol(ua, "friendID", typeof(String));
createCol(ua, "friendPerms", typeof(Int32));
createCol(ua, "ownerPerms", typeof(Int32));
createCol(ua, "datetimestamp", typeof(Int32));
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.username = (String) row["username"];
user.surname = (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 fillFriendRow(DataRow row, LLUUID ownerID, LLUUID friendID, uint perms)
{
row["ownerID"] = ownerID.UUID.ToString();
row["friendID"] = friendID.UUID.ToString();
row["friendPerms"] = perms;
foreach (DataColumn col in ds.Tables["userfriends"].Columns)
{
if (row[col] == null)
{
row[col] = "";
}
}
}
private void fillUserRow(DataRow row, UserProfileData user)
{
row["UUID"] = Util.ToRawUuidString(user.UUID);
row["username"] = user.username;
row["surname"] = user.surname;
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.ToUInt64(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.ToString();
// 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 (String)));
delete.Connection = conn;
da.DeleteCommand = delete;
}
private void setupUserFriendsCommands(SqliteDataAdapter daf, SqliteConnection conn)
{
daf.InsertCommand = createInsertCommand("userfriends", ds.Tables["userfriends"]);
daf.InsertCommand.Connection = conn;
daf.UpdateCommand = createUpdateCommand("userfriends", "ownerID=:ownerID and friendID=:friendID", ds.Tables["userfriends"]);
daf.UpdateCommand.Connection = conn;
SqliteCommand delete = new SqliteCommand("delete from users where ownerID=:ownerID and friendID=:friendID");
delete.Parameters.Add(createSqliteParameter("ownerID", typeof(String)));
delete.Parameters.Add(createSqliteParameter("friendID", typeof(String)));
delete.Connection = conn;
daf.DeleteCommand = delete;
}
private void InitDB(SqliteConnection conn)
{
string createUsers = defineTable(createUsersTable());
string createFriends = defineTable(createUserFriendsTable());
SqliteCommand pcmd = new SqliteCommand(createUsers, conn);
SqliteCommand fcmd = new SqliteCommand(createFriends, conn);
conn.Open();
try
{
pcmd.ExecuteNonQuery();
}
catch (System.Exception)
{
MainLog.Instance.Verbose("USERS", "users table already exists");
}
try
{
fcmd.ExecuteNonQuery();
}
catch (System.Exception)
{
MainLog.Instance.Verbose("USERS", "userfriends table already exists");
}
conn.Close();
}
private bool TestTables(SqliteConnection conn)
{
SqliteCommand cmd = new SqliteCommand(userSelect, conn);
SqliteCommand fcmd = new SqliteCommand(userFriendsSelect, conn);
SqliteDataAdapter pDa = new SqliteDataAdapter(cmd);
SqliteDataAdapter fDa = new SqliteDataAdapter(cmd);
DataSet tmpDS = new DataSet();
DataSet tmpDS2 = new DataSet();
try
{
pDa.Fill(tmpDS, "users");
fDa.Fill(tmpDS2, "userfriends");
}
catch (SqliteSyntaxException)
{
MainLog.Instance.Verbose("DATASTORE", "SQLite Database doesn't exist... creating");
InitDB(conn);
}
return true;
}
}
}