IUserData.cs 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSim Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System.Collections.Generic;
  28. using libsecondlife;
  29. namespace OpenSim.Framework
  30. {
  31. /// <summary>
  32. /// An interface for connecting to user storage servers.
  33. /// </summary>
  34. public interface IUserData
  35. {
  36. /// <summary>
  37. /// Returns a user profile from a database via their UUID
  38. /// </summary>
  39. /// <param name="user">The user's UUID</param>
  40. /// <returns>The user data profile. Returns null if no user is found</returns>
  41. UserProfileData GetUserByUUID(LLUUID user);
  42. /// <summary>
  43. /// Returns a users profile by searching their username parts
  44. /// </summary>
  45. /// <param name="fname">Account firstname</param>
  46. /// <param name="lname">Account lastname</param>
  47. /// <returns>The user data profile</returns>
  48. UserProfileData GetUserByName(string fname, string lname);
  49. /// <summary>
  50. /// Returns a list of UUIDs firstnames and lastnames that match string query entered into the avatar picker.
  51. /// </summary>
  52. /// <param name="queryID">ID associated with the user's query. This must match what the client sent</param>
  53. /// <param name="query">The filtered contents of the search box when the user hit search.</param>
  54. /// <returns>The user data profile</returns>
  55. List<AvatarPickerAvatar> GeneratePickerResults(LLUUID queryID, string query);
  56. /// <summary>
  57. /// Returns the current agent for a user searching by it's UUID
  58. /// </summary>
  59. /// <param name="user">The users UUID</param>
  60. /// <returns>The current agent session</returns>
  61. UserAgentData GetAgentByUUID(LLUUID user);
  62. /// <summary>
  63. /// Returns the current session agent for a user searching by username
  64. /// </summary>
  65. /// <param name="name">The users account name</param>
  66. /// <returns>The current agent session</returns>
  67. UserAgentData GetAgentByName(string name);
  68. /// <summary>
  69. /// Returns the current session agent for a user searching by username parts
  70. /// </summary>
  71. /// <param name="fname">The users first account name</param>
  72. /// <param name="lname">The users account surname</param>
  73. /// <returns>The current agent session</returns>
  74. UserAgentData GetAgentByName(string fname, string lname);
  75. /// <summary>
  76. /// Stores new web-login key for user during web page login
  77. /// </summary>
  78. /// <param name="webLoginKey"></param>
  79. void StoreWebLoginKey(LLUUID agentID, LLUUID webLoginKey);
  80. /// <summary>
  81. /// Adds a new User profile to the database
  82. /// </summary>
  83. /// <param name="user">UserProfile to add</param>
  84. void AddNewUserProfile(UserProfileData user);
  85. /// <summary>
  86. /// Updates an existing user profile
  87. /// </summary>
  88. /// <param name="user">UserProfile to update</param>
  89. bool UpdateUserProfile(UserProfileData user);
  90. /// <summary>
  91. /// Updates the current region the User is in
  92. /// </summary>
  93. /// <param name="avatarid">User Region the Avatar is IN</param>
  94. /// <param name="retionuuid">User Region the Avatar is IN</param>
  95. void UpdateUserCurrentRegion(LLUUID avatarid, LLUUID regionuuid);
  96. /// <summary>
  97. /// Adds a new agent to the database
  98. /// </summary>
  99. /// <param name="agent">The agent to add</param>
  100. void AddNewUserAgent(UserAgentData agent);
  101. /// <summary>
  102. /// Adds a new friend to the database for XUser
  103. /// </summary>
  104. /// <param name="friendlistowner">The agent that who's friends list is being added to</param>
  105. /// <param name="friend">The agent that being added to the friends list of the friends list owner</param>
  106. /// <param name="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 </param>
  107. void AddNewUserFriend(LLUUID friendlistowner, LLUUID friend, uint perms);
  108. /// <summary>
  109. /// Delete friend on friendlistowner's friendlist.
  110. /// </summary>
  111. /// <param name="friendlistowner">The agent that who's friends list is being updated</param>
  112. /// <param name="friend">The Ex-friend agent</param>
  113. void RemoveUserFriend(LLUUID friendlistowner, LLUUID friend);
  114. /// <summary>
  115. /// Update permissions for friend on friendlistowner's friendlist.
  116. /// </summary>
  117. /// <param name="friendlistowner">The agent that who's friends list is being updated</param>
  118. /// <param name="friend">The agent that is getting or loosing permissions</param>
  119. /// <param name="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 </param>
  120. void UpdateUserFriendPerms(LLUUID friendlistowner, LLUUID friend, uint perms);
  121. /// <summary>
  122. /// Returns a list of FriendsListItems that describe the friends and permissions in the friend relationship for LLUUID friendslistowner
  123. /// </summary>
  124. /// <param name="friendlistowner">The agent that we're retreiving the friends Data.</param>
  125. List<FriendListItem> GetUserFriendList(LLUUID friendlistowner);
  126. /// <summary>
  127. /// Attempts to move currency units between accounts (NOT RELIABLE / TRUSTWORTHY. DONT TRY RUN YOUR OWN CURRENCY EXCHANGE WITH REAL VALUES)
  128. /// </summary>
  129. /// <param name="from">The account to transfer from</param>
  130. /// <param name="to">The account to transfer to</param>
  131. /// <param name="amount">The amount to transfer</param>
  132. /// <returns>Successful?</returns>
  133. bool MoneyTransferRequest(LLUUID from, LLUUID to, uint amount);
  134. /// <summary>
  135. /// Attempts to move inventory between accounts, if inventory is copyable it will be copied into the target account.
  136. /// </summary>
  137. /// <param name="from">User to transfer from</param>
  138. /// <param name="to">User to transfer to</param>
  139. /// <param name="inventory">Specified inventory item</param>
  140. /// <returns>Successful?</returns>
  141. bool InventoryTransferRequest(LLUUID from, LLUUID to, LLUUID inventory);
  142. /// <summary>
  143. /// Returns the plugin version
  144. /// </summary>
  145. /// <returns>Plugin version in MAJOR.MINOR.REVISION.BUILD format</returns>
  146. string GetVersion();
  147. /// <summary>
  148. /// Returns the plugin name
  149. /// </summary>
  150. /// <returns>Plugin name, eg MySQL User Provider</returns>
  151. string getName();
  152. /// <summary>
  153. /// Initialises the plugin (artificial constructor)
  154. /// </summary>
  155. void Initialise();
  156. }
  157. }