refactor: Move "friends show cache" console command out into separate FriendsCommandsModule.

Expose required methods on IFriendsModule.  Rename GetFriends() -> GetFriendsFromCache() for self-documentation

1 files changed, 21 insertions, 4 deletions

diff --git a/OpenSim/Region/Framework/Interfaces/IFriendsModule.cs b/OpenSim/Region/Framework/Interfaces/IFriendsModule.cs
index 10bef1e..7e87006 100644
--- a/OpenSim/Region/Framework/Interfaces/IFriendsModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IFriendsModule.cs
@@ -25,15 +25,32 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+using System.Collections.Generic;
 using OpenMetaverse;
 using OpenSim.Framework;
-using System.Collections.Generic;
+using FriendInfo = OpenSim.Services.Interfaces.FriendInfo;
 
 namespace OpenSim.Region.Framework.Interfaces
 {
     public interface IFriendsModule
     {
         /// <summary>
+        /// Are friends cached on this simulator for a particular user?
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <returns></returns>
+        bool AreFriendsCached(UUID userID);
+
+        /// <summary>
+        /// Get friends from local cache only
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <returns>
+        /// An empty array if the user has no friends or friends have not been cached.
+        /// </returns>
+        FriendInfo[] GetFriendsFromCache(UUID userID);
+
+        /// <summary>
         /// Add a friendship between two users.
         /// </summary>
         /// <remarks>
@@ -58,10 +75,10 @@ namespace OpenSim.Region.Framework.Interfaces
         /// <summary>
         /// Get permissions granted by a friend.
         /// </summary>
-        /// <param name="PrincipalID">The user.</param>
-        /// <param name="FriendID">The friend that granted.</param>
+        /// <param name="userID">The user.</param>
+        /// <param name="friendID">The friend that granted.</param>
         /// <returns>The permissions.  These come from the FriendRights enum.</returns>
-        int GetRightsGrantedByFriend(UUID PrincipalID, UUID FriendID);
+        int GetRightsGrantedByFriend(UUID userID, UUID friendID);
 
         /// <summary>
         /// Grant permissions for a friend.