ogb912/opensim
1
0
Fork 0
mirror of https://github.com/opensim/opensim.git synced 2026-08-05 00:46:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

- move OpenSim/Framework/IInventoryData.cs to

Browse Source 
OpenSim/Data/IInventoryData.cs
- trim trailing whitespace
This commit is contained in:
Mike Mazur
2009-02-03 05:20:26 +00:00
parent e12b0a2496
commit 9377c6f2b2
8 changed files with 122 additions and 115 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
OpenSim/Framework/Communications/InventoryServiceBase.cs
View File

@@ -33,6 +33,8 @@ using System.Threading;
using OpenMetaverse;
using log4net;
using OpenSim.Data;
namespace OpenSim.Framework.Communications
{
/// <summary>
@@ -50,12 +52,12 @@ namespace OpenSim.Framework.Communications
/// <summary>
/// Add a new inventory data plugin - plugins will be requested in the order they were added.
/// </summary>
/// <param name="plugin">The plugin that will provide data</param>
/// <param name="plugin">The plugin that will provide data</param>
public void AddPlugin(IInventoryDataPlugin plugin)
{
m_plugins.Add(plugin);
}
/// <summary>
/// Adds a new inventory data plugin - plugins will be requested in the order they were loaded.
/// </summary>

111
OpenSim/Framework/Communications/Tests/Cache/UserProfileCacheServiceTests.cs
View File

@@ -30,19 +30,20 @@ using log4net;
using NUnit.Framework;
using NUnit.Framework.SyntaxHelpers;
using OpenMetaverse;
using OpenSim.Framework;
//using OpenSim.Framework;
using OpenSim.Framework.Communications.Cache;
using OpenSim.Region.Communications.Local;
using OpenSim.Tests.Common.Mock;
using OpenSim.Data;
namespace OpenSim.Framework.Communications.Tests
{
{
/// <summary>
/// User profile cache service tests
/// </summary>
[TestFixture]
[TestFixture]
public class UserProfileCacheServiceTests
{
{
/// <summary>
/// Test user details get.
/// </summary>
@@ -51,17 +52,17 @@ namespace OpenSim.Framework.Communications.Tests
{
UUID nonExistingUserId = UUID.Parse("00000000-0000-0000-0000-000000000001");
UUID existingUserId = UUID.Parse("00000000-0000-0000-0000-000000000002");
TestCommunicationsManager commsManager = new TestCommunicationsManager();
CachedUserInfo existingUserInfo = UserProfileTestUtils.CreateUserWithInventory(commsManager, existingUserId);
Assert.That(existingUserInfo, Is.Not.Null, "Existing user info unexpectedly not found");
CachedUserInfo nonExistingUserInfo = commsManager.UserProfileCacheService.GetUserDetails(nonExistingUserId);
Assert.That(nonExistingUserInfo, Is.Null, "Non existing user info unexpectedly found");
Assert.That(nonExistingUserInfo, Is.Null, "Non existing user info unexpectedly found");
}
/// <summary>
/// Test requesting inventory for a user
/// </summary>
@@ -69,11 +70,11 @@ namespace OpenSim.Framework.Communications.Tests
public void TestRequestInventoryForUser()
{
TestCommunicationsManager commsManager = new TestCommunicationsManager();
CachedUserInfo userInfo = UserProfileTestUtils.CreateUserWithInventory(commsManager);
CachedUserInfo userInfo = UserProfileTestUtils.CreateUserWithInventory(commsManager);
Assert.That(userInfo.HasReceivedInventory, Is.True);
}
/// <summary>
/// Test retrieving a child folder
/// </summary>
@@ -82,45 +83,45 @@ namespace OpenSim.Framework.Communications.Tests
{
TestCommunicationsManager commsManager = new TestCommunicationsManager();
CachedUserInfo userInfo = UserProfileTestUtils.CreateUserWithInventory(commsManager);
UUID folderId = UUID.Parse("00000000-0000-0000-0000-000000000011");
Assert.That(userInfo.RootFolder.GetChildFolder(folderId), Is.Null);
Assert.That(userInfo.RootFolder.GetChildFolder(folderId), Is.Null);
userInfo.CreateFolder("testFolder", folderId, (ushort)AssetType.Animation, userInfo.RootFolder.ID);
Assert.That(userInfo.RootFolder.GetChildFolder(folderId), Is.Not.Null);
}
}
/// <summary>
/// Test creating an inventory folder
/// </summary>
[Test]
public void TestCreateFolder()
{
{
TestCommunicationsManager commsManager = new TestCommunicationsManager();
IInventoryDataPlugin inventoryDataPlugin = commsManager.InventoryDataPlugin;
CachedUserInfo userInfo = UserProfileTestUtils.CreateUserWithInventory(commsManager);
UUID folderId = UUID.Parse("00000000-0000-0000-0000-000000000010");
UUID folderId = UUID.Parse("00000000-0000-0000-0000-000000000010");
Assert.That(userInfo.RootFolder.ContainsChildFolder(folderId), Is.False);
// 1: Try a folder create that should fail because the parent id given does not exist
UUID missingFolderId = UUID.Random();
Assert.That(
userInfo.CreateFolder("testFolder1", folderId, (ushort)AssetType.Animation, missingFolderId), Is.False);
Assert.That(inventoryDataPlugin.getInventoryFolder(folderId), Is.Null);
Assert.That(userInfo.RootFolder.ContainsChildFolder(missingFolderId), Is.False);
Assert.That(userInfo.RootFolder.FindFolder(folderId), Is.Null);
// 2: Try a folder create that should work
Assert.That(
userInfo.CreateFolder("testFolder2", folderId, (ushort)AssetType.Animation, userInfo.RootFolder.ID), Is.True);
Assert.That(inventoryDataPlugin.getInventoryFolder(folderId), Is.Not.Null);
Assert.That(userInfo.RootFolder.ContainsChildFolder(folderId), Is.True);
}
/// <summary>
/// Test updating a folder
/// </summary>
@@ -129,54 +130,54 @@ namespace OpenSim.Framework.Communications.Tests
{
TestCommunicationsManager commsManager = new TestCommunicationsManager();
IInventoryDataPlugin inventoryDataPlugin = commsManager.InventoryDataPlugin;
CachedUserInfo userInfo = UserProfileTestUtils.CreateUserWithInventory(commsManager);
UUID folder1Id = UUID.Parse("00000000-0000-0000-0000-000000000060");
InventoryFolderImpl rootFolder = userInfo.RootFolder;
userInfo.CreateFolder("folder1", folder1Id, (ushort)AssetType.Animation, rootFolder.ID);
// 1: Test updates that don't involve moving the folder
{
string newFolderName1 = "newFolderName1";
ushort folderType1 = (ushort)AssetType.Texture;
userInfo.UpdateFolder(newFolderName1, folder1Id, folderType1, rootFolder.ID);
InventoryFolderImpl folder1 = rootFolder.GetChildFolder(folder1Id);
Assert.That(newFolderName1, Is.EqualTo(folder1.Name));
Assert.That(folderType1, Is.EqualTo((ushort)folder1.Type));
InventoryFolderBase dataFolder1 = inventoryDataPlugin.getInventoryFolder(folder1Id);
Assert.That(newFolderName1, Is.EqualTo(dataFolder1.Name));
Assert.That(folderType1, Is.EqualTo((ushort)dataFolder1.Type));
}
// 2: Test an update that also involves moving the folder
{
UUID folder2Id = UUID.Parse("00000000-0000-0000-0000-000000000061");
userInfo.CreateFolder("folder2", folder2Id, (ushort)AssetType.Animation, rootFolder.ID);
InventoryFolderImpl folder2 = rootFolder.GetChildFolder(folder2Id);
string newFolderName2 = "newFolderName2";
ushort folderType2 = (ushort)AssetType.Bodypart;
userInfo.UpdateFolder(newFolderName2, folder1Id, folderType2, folder2Id);
InventoryFolderImpl folder1 = folder2.GetChildFolder(folder1Id);
Assert.That(newFolderName2, Is.EqualTo(folder1.Name));
Assert.That(folderType2, Is.EqualTo((ushort)folder1.Type));
Assert.That(folder2Id, Is.EqualTo(folder1.ParentID));
Assert.That(folder2.ContainsChildFolder(folder1Id), Is.True);
Assert.That(rootFolder.ContainsChildFolder(folder1Id), Is.False);
InventoryFolderBase dataFolder1 = inventoryDataPlugin.getInventoryFolder(folder1Id);
Assert.That(newFolderName2, Is.EqualTo(dataFolder1.Name));
Assert.That(folderType2, Is.EqualTo((ushort)dataFolder1.Type));
Assert.That(folderType2, Is.EqualTo((ushort)dataFolder1.Type));
Assert.That(folder2Id, Is.EqualTo(dataFolder1.ParentID));
}
}
}
/// <summary>
/// Test moving an inventory folder
@@ -186,32 +187,32 @@ namespace OpenSim.Framework.Communications.Tests
{
TestCommunicationsManager commsManager = new TestCommunicationsManager();
IInventoryDataPlugin inventoryDataPlugin = commsManager.InventoryDataPlugin;
CachedUserInfo userInfo = UserProfileTestUtils.CreateUserWithInventory(commsManager);
UUID folder1Id = UUID.Parse("00000000-0000-0000-0000-000000000020");
UUID folder2Id = UUID.Parse("00000000-0000-0000-0000-000000000021");
UUID folderToMoveId = UUID.Parse("00000000-0000-0000-0000-000000000030");
UUID folderToMoveId = UUID.Parse("00000000-0000-0000-0000-000000000030");
InventoryFolderImpl rootFolder = userInfo.RootFolder;
userInfo.CreateFolder("folder1", folder1Id, (ushort)AssetType.Animation, rootFolder.ID);
InventoryFolderImpl folder1 = rootFolder.GetChildFolder(folder1Id);
userInfo.CreateFolder("folder2", folder2Id, (ushort)AssetType.Animation, rootFolder.ID);
InventoryFolderImpl folder2 = rootFolder.GetChildFolder(folder2Id);
// Check folder is currently in folder1
userInfo.CreateFolder("folderToMove", folderToMoveId, (ushort)AssetType.Animation, folder1Id);
Assert.That(folder1.ContainsChildFolder(folderToMoveId), Is.True);
userInfo.MoveFolder(folderToMoveId, folder2Id);
// Check folder is now in folder2 and no trace remains in folder1
Assert.That(folder2.ContainsChildFolder(folderToMoveId), Is.True);
Assert.That(inventoryDataPlugin.getInventoryFolder(folderToMoveId).ParentID, Is.EqualTo(folder2Id));
Assert.That(folder1.ContainsChildFolder(folderToMoveId), Is.False);
}
/// <summary>
/// Test purging an inventory folder
/// </summary>
@@ -219,21 +220,21 @@ namespace OpenSim.Framework.Communications.Tests
public void TestPurgeFolder()
{
//log4net.Config.XmlConfigurator.Configure();
TestCommunicationsManager commsManager = new TestCommunicationsManager();
IInventoryDataPlugin inventoryDataPlugin = commsManager.InventoryDataPlugin;
CachedUserInfo userInfo = UserProfileTestUtils.CreateUserWithInventory(commsManager);
UUID folder1Id = UUID.Parse("00000000-0000-0000-0000-000000000070");
InventoryFolderImpl rootFolder = userInfo.RootFolder;
userInfo.CreateFolder("folder1", folder1Id, (ushort)AssetType.Animation, rootFolder.ID);
Assert.That(inventoryDataPlugin.getInventoryFolder(folder1Id), Is.Not.Null);
// Test purge
userInfo.PurgeFolder(rootFolder.ID);
Assert.That(rootFolder.RequestListOfFolders(), Is.Empty);
Assert.That(inventoryDataPlugin.getInventoryFolder(folder1Id), Is.Null);
}

156
OpenSim/Framework/IInventoryData.cs
View File

@@ -1,156 +0,0 @@
/*
* 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.Collections.Generic;
using OpenMetaverse;
namespace OpenSim.Framework
{
/// <summary>
/// An interface for accessing inventory data from a storage server
/// </summary>
public interface IInventoryDataPlugin : IPlugin
{
/// <summary>
/// Initialises the interface
/// </summary>
void Initialise(string connect);
/// <summary>
/// Returns all descendent folders of this folder. Does not return the parent folder itself.
/// </summary>
/// <param name="parentID">The folder to get subfolders for</param>
/// <returns>A list of inventory folders</returns>
List<InventoryFolderBase> getFolderHierarchy(UUID parentID);
/// <summary>
/// Returns a list of inventory items contained within the specified folder
/// </summary>
/// <param name="folderID">The UUID of the target folder</param>
/// <returns>A List of InventoryItemBase items</returns>
List<InventoryItemBase> getInventoryInFolder(UUID folderID);
/// <summary>
/// Returns a list of the root folders within a users inventory
/// </summary>
/// <param name="user">The user whos inventory is to be searched</param>
/// <returns>A list of folder objects</returns>
List<InventoryFolderBase> getUserRootFolders(UUID user);
/// <summary>
/// Returns the users inventory root folder.
/// </summary>
/// <param name="user">The UUID of the user who is having inventory being returned</param>
/// <returns>Root inventory folder, null if no root inventory folder was found</returns>
InventoryFolderBase getUserRootFolder(UUID user);
/// <summary>
/// Returns a list of inventory folders contained in the folder 'parentID'
/// </summary>
/// <param name="parentID">The folder to get subfolders for</param>
/// <returns>A list of inventory folders</returns>
List<InventoryFolderBase> getInventoryFolders(UUID parentID);
/// <summary>
/// Returns an inventory item by its UUID
/// </summary>
/// <param name="item">The UUID of the item to be returned</param>
/// <returns>A class containing item information</returns>
InventoryItemBase getInventoryItem(UUID item);
/// <summary>
/// Returns a specified inventory folder by its UUID
/// </summary>
/// <param name="folder">The UUID of the folder to be returned</param>
/// <returns>A class containing folder information</returns>
InventoryFolderBase getInventoryFolder(UUID folder);
/// <summary>
/// Creates a new inventory item based on item
/// </summary>
/// <param name="item">The item to be created</param>
void addInventoryItem(InventoryItemBase item);
/// <summary>
/// Updates an inventory item with item (updates based on ID)
/// </summary>
/// <param name="item">The updated item</param>
void updateInventoryItem(InventoryItemBase item);
/// <summary>
///
/// </summary>
/// <param name="item"></param>
void deleteInventoryItem(UUID item);
/// <summary>
/// Adds a new folder specified by folder
/// </summary>
/// <param name="folder">The inventory folder</param>
void addInventoryFolder(InventoryFolderBase folder);
/// <summary>
/// Updates a folder based on its ID with folder
/// </summary>
/// <param name="folder">The inventory folder</param>
void updateInventoryFolder(InventoryFolderBase folder);
/// <summary>
/// Updates a folder based on its ID with folder
/// </summary>
/// <param name="folder">The inventory folder</param>
void moveInventoryFolder(InventoryFolderBase folder);
/// <summary>
/// Deletes a folder. Thie will delete both the folder itself and its contents (items and descendent folders)
/// </summary>
/// <param name="folder">The id of the folder</param>
void deleteInventoryFolder(UUID folder);
/// <summary>
/// Returns all activated gesture-items in the inventory of the specified avatar.
/// </summary>
/// <param name="avatarID">
/// The <see cref="UUID"/> of the avatar
/// </param>
/// <returns>
/// The list of gestures (<see cref="InventoryItemBase"/>s)
/// </returns>
List<InventoryItemBase> fetchActiveGestures(UUID avatarID);
}
public class InventoryDataInitialiser : PluginInitialiserBase
{
private string connect;
public InventoryDataInitialiser (string s) { connect = s; }
public override void Initialise (IPlugin plugin)
{
IInventoryDataPlugin p = plugin as IInventoryDataPlugin;
p.Initialise (connect);
}
}
}