OpenSim::Data::MySQL::MySQLUserData Class Reference

A database interface class to a user profile storage system. More...

Inheritance diagram for OpenSim::Data::MySQL::MySQLUserData:


Public Member Functions
override void	Initialise ()
	Default-initialises the plugin.
MySQLSuperManager	GetLockedConnection (string why)
override void	Initialise (string connect)
	Initialise User Interface Loads and initialises the MySQL storage plugin Warns and uses the obsolete mysql_connection.ini if connect string is empty. Checks for migration.
override void	Dispose ()
override UserProfileData	GetUserByName (string user, string last)
	Returns a users profile by searching their username parts.
override void	AddNewUserFriend (UUID friendlistowner, UUID friend, uint perms)
	Adds a new friend to the database for XUser.
override void	RemoveUserFriend (UUID friendlistowner, UUID friend)
	Delete friend on friendlistowner's friendlist.
override void	UpdateUserFriendPerms (UUID friendlistowner, UUID friend, uint perms)
	Update permissions for friend on friendlistowner's friendlist.
override List< FriendListItem >	GetUserFriendList (UUID friendlistowner)
	Returns a list of FriendsListItems that describe the friends and permissions in the friend relationship for UUID friendslistowner.
override Dictionary< UUID, FriendRegionInfo >	GetFriendRegionInfos (List< UUID > uuids)
	Returns a list of <see cref="FriendRegionInfo/>s for the specified UUIDs.
override List< AvatarPickerAvatar >	GeneratePickerResults (UUID queryID, string query)
	Returns a list of UUIDs firstnames and lastnames that match string query entered into the avatar picker.
override UserProfileData	GetUserByUUID (UUID uuid)
	See IUserDataPlugin.
override UserAgentData	GetAgentByName (string name)
	Returns a user session searching by name.
override UserAgentData	GetAgentByName (string user, string last)
	Returns a user session by account name.
override void	StoreWebLoginKey (UUID AgentID, UUID WebLoginKey)
override UserAgentData	GetAgentByUUID (UUID uuid)
	Returns an agent session by account UUID.
override void	AddNewUserProfile (UserProfileData user)
	Creates a new users profile.
override void	AddNewUserAgent (UserAgentData agent)
	Creates a new agent.
override bool	UpdateUserProfile (UserProfileData user)
	Updates a user profile stored in the DB.
override bool	MoneyTransferRequest (UUID from, UUID to, uint amount)
	Performs a money transfer request between two accounts.
override bool	InventoryTransferRequest (UUID from, UUID to, UUID item)
	Performs an inventory transfer request between two accounts.
override AvatarAppearance	GetUserAppearance (UUID user)
	Appearance TODO: stubs for now to get us to a compiling state gently override.
override void	UpdateUserAppearance (UUID user, AvatarAppearance appearance)
	Updates an avatar appearence.
Hashtable	GetUserAttachments (UUID agentID)
void	UpdateUserAttachments (UUID agentID, Hashtable data)
override void	ResetAttachments (UUID userID)
override void	LogoutUsers (UUID regionID)
Public Attributes
MySQLManager	database
	Database manager for MySQL.
Dictionary< int, MySQLSuperManager >	m_dbconnections = new Dictionary<int, MySQLSuperManager>()
	Better DB manager. Swap-in replacement too.
int	m_maxConnections = 10
int	m_lastConnect
Properties
override string	Name `[get]`
	Database provider name.
override string	Version `[get]`
	Database provider version.

Detailed Description

A database interface class to a user profile storage system.

Member Function Documentation

override void OpenSim::Data::MySQL::MySQLUserData::Initialise ( ) [inline, virtual]

Default-initialises the plugin.

Implements OpenSim::Data::UserDataBase.

MySQLSuperManager OpenSim::Data::MySQL::MySQLUserData::GetLockedConnection ( string why ) [inline]

override void OpenSim::Data::MySQL::MySQLUserData::Initialise ( string connect ) [inline, virtual]

Initialise User Interface Loads and initialises the MySQL storage plugin Warns and uses the obsolete mysql_connection.ini if connect string is empty. Checks for migration.

Parameters:

connect

connect string.

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::Dispose ( ) [inline, virtual]

Implements OpenSim::Data::UserDataBase.

override UserProfileData OpenSim::Data::MySQL::MySQLUserData::GetUserByName	(	string	user,
		string	last
	)			`[inline, virtual]`

Returns a users profile by searching their username parts.

Parameters:

	fname	Account firstname
	lname	Account lastname

Returns:: The user data profile

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::AddNewUserFriend	(	UUID	friendlistowner,
		UUID	friend,
		uint	perms
	)			`[inline, virtual]`

Adds a new friend to the database for XUser.

Parameters:

	friendlistowner	The agent that who's friends list is being added to
	friend	The agent that being added to the friends list of the friends list owner
	perms	A uint bit vector for set perms that the friend being added has; 0 = none, 1=This friend can see when they sign on, 2 = map, 4 edit objects

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::RemoveUserFriend	(	UUID	friendlistowner,
		UUID	friend
	)			`[inline, virtual]`

Delete friend on friendlistowner's friendlist.

Parameters:

	friendlistowner	The agent that who's friends list is being updated
	friend	The Ex-friend agent

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::UpdateUserFriendPerms	(	UUID	friendlistowner,
		UUID	friend,
		uint	perms
	)			`[inline, virtual]`

Update permissions for friend on friendlistowner's friendlist.

Parameters:

	friendlistowner	The agent that who's friends list is being updated
	friend	The agent that is getting or loosing permissions
	perms	A uint bit vector for set perms that the friend being added has; 0 = none, 1=This friend can see when they sign on, 2 = map, 4 edit objects

Implements OpenSim::Data::UserDataBase.

override List<FriendListItem> OpenSim::Data::MySQL::MySQLUserData::GetUserFriendList ( UUID friendlistowner ) [inline, virtual]

Returns a list of FriendsListItems that describe the friends and permissions in the friend relationship for UUID friendslistowner.

Parameters:

friendlistowner

The agent that we're retreiving the friends Data.

Implements OpenSim::Data::UserDataBase.

override Dictionary<UUID, FriendRegionInfo> OpenSim::Data::MySQL::MySQLUserData::GetFriendRegionInfos ( List< UUID > uuids ) [inline, virtual]

Returns a list of <see cref="FriendRegionInfo/>s for the specified UUIDs.

Parameters:

uuids

A List of <see cref="UUID/>s to fetch info for

Returns:: A Dictionary, mapping the UUIDs to FriendRegionInfos.

Implements OpenSim::Data::UserDataBase.

override List<AvatarPickerAvatar> OpenSim::Data::MySQL::MySQLUserData::GeneratePickerResults	(	UUID	queryID,
		string	query
	)			`[inline, virtual]`

Returns a list of UUIDs firstnames and lastnames that match string query entered into the avatar picker.

Parameters:

	queryID	ID associated with the user's query. This must match what the client sent
	query	The filtered contents of the search box when the user hit search.

Returns:: The user data profile

Implements OpenSim::Data::UserDataBase.

override UserProfileData OpenSim::Data::MySQL::MySQLUserData::GetUserByUUID ( UUID uuid ) [inline, virtual]

See IUserDataPlugin.

Parameters:

uuid

User UUID

Returns:: User profile data

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::MySQL::MySQLUserData::GetAgentByName ( string name ) [inline, virtual]

Returns a user session searching by name.

Parameters:

name

The account name : "Username Lastname"

Returns:: The users session

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::MySQL::MySQLUserData::GetAgentByName	(	string	user,
		string	last
	)			`[inline, virtual]`

Returns a user session by account name.

Parameters:

	user	First part of the users account name
	last	Second part of the users account name

Returns:: The users session

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::StoreWebLoginKey	(	UUID	AgentID,
		UUID	WebLoginKey
	)			`[inline, virtual]`

Parameters:

	AgentID
	WebLoginKey

is it still used ?

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::MySQL::MySQLUserData::GetAgentByUUID ( UUID uuid ) [inline, virtual]

Returns an agent session by account UUID.

Parameters:

uuid

The accounts UUID

Returns:: The users session

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::AddNewUserProfile ( UserProfileData user ) [inline, virtual]

Creates a new users profile.

Parameters:

user

The user profile to create

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::AddNewUserAgent ( UserAgentData agent ) [inline, virtual]

Creates a new agent.

Parameters:

agent

The agent to create

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::MySQL::MySQLUserData::UpdateUserProfile ( UserProfileData user ) [inline, virtual]

Updates a user profile stored in the DB.

Parameters:

user

The profile data to use to update the DB

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::MySQL::MySQLUserData::MoneyTransferRequest	(	UUID	from,
		UUID	to,
		uint	amount
	)			`[inline, virtual]`

Performs a money transfer request between two accounts.

Parameters:

	from	The senders account ID
	to	The receivers account ID
	amount	The amount to transfer

Returns:: Success?

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::MySQL::MySQLUserData::InventoryTransferRequest	(	UUID	from,
		UUID	to,
		UUID	item
	)			`[inline, virtual]`

Performs an inventory transfer request between two accounts.

TODO: Move to inventory server

Parameters:

	from	The senders account ID
	to	The receivers account ID
	item	The item to transfer

Returns:: Success?

Implements OpenSim::Data::UserDataBase.

override AvatarAppearance OpenSim::Data::MySQL::MySQLUserData::GetUserAppearance ( UUID user ) [inline, virtual]

Appearance TODO: stubs for now to get us to a compiling state gently override.

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::UpdateUserAppearance	(	UUID	user,
		AvatarAppearance	appearance
	)			`[inline, virtual]`

Updates an avatar appearence.

Parameters:

	user	The user UUID
	appearance	The avatar appearance

Implements OpenSim::Data::UserDataBase.

Hashtable OpenSim::Data::MySQL::MySQLUserData::GetUserAttachments ( UUID agentID ) [inline]

void OpenSim::Data::MySQL::MySQLUserData::UpdateUserAttachments	(	UUID	agentID,
		Hashtable	data
	)			`[inline]`

override void OpenSim::Data::MySQL::MySQLUserData::ResetAttachments ( UUID userID ) [inline, virtual]

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::MySQL::MySQLUserData::LogoutUsers ( UUID regionID ) [inline, virtual]

Implements OpenSim::Data::UserDataBase.

Member Data Documentation

MySQLManager OpenSim::Data::MySQL::MySQLUserData::database

Database manager for MySQL.

Dictionary<int, MySQLSuperManager> OpenSim::Data::MySQL::MySQLUserData::m_dbconnections = new Dictionary<int, MySQLSuperManager>()

Better DB manager. Swap-in replacement too.

int OpenSim::Data::MySQL::MySQLUserData::m_maxConnections = 10

int OpenSim::Data::MySQL::MySQLUserData::m_lastConnect

Property Documentation

override string OpenSim::Data::MySQL::MySQLUserData::Name [get]

Database provider name.

Returns:: Provider name

Reimplemented from OpenSim::Data::UserDataBase.

override string OpenSim::Data::MySQL::MySQLUserData::Version [get]

Database provider version.

Returns:: provider version

Reimplemented from OpenSim::Data::UserDataBase.

The documentation for this class was generated from the following file:

/home/sdague/opensim-docs/OpenSim/Data/MySQL/MySQLUserData.cs

Generated on Tue Jan 6 01:00:46 2009 for OpenSim by

1.5.1

OpenSim::Data::MySQL::MySQLUserData Class Reference

Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation