aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/CoreModules
diff options
context:
space:
mode:
authorDiva Canto2009-12-23 17:31:30 -0800
committerDiva Canto2009-12-23 17:31:30 -0800
commit1fa938aab0b748768ff3528e41ba76dd6baa1bf3 (patch)
tree4d3247f4e48b350faf9c392fed4b6576fb856c31 /OpenSim/Region/CoreModules
parentFixes the broken build of the previous commit. (diff)
downloadopensim-SC_OLD-1fa938aab0b748768ff3528e41ba76dd6baa1bf3.zip
opensim-SC_OLD-1fa938aab0b748768ff3528e41ba76dd6baa1bf3.tar.gz
opensim-SC_OLD-1fa938aab0b748768ff3528e41ba76dd6baa1bf3.tar.bz2
opensim-SC_OLD-1fa938aab0b748768ff3528e41ba76dd6baa1bf3.tar.xz
Library Module: allows adding folders/items to the Library from IAR files placed under bin/Library. This works only for standalones.
Diffstat (limited to 'OpenSim/Region/CoreModules')
-rw-r--r--OpenSim/Region/CoreModules/Framework/Library/LibraryModule.cs219
-rw-r--r--OpenSim/Region/CoreModules/Framework/Library/LocalInventoryService.cs263
-rw-r--r--OpenSim/Region/CoreModules/Resources/CoreModulePlugin.addin.xml1
3 files changed, 483 insertions, 0 deletions
diff --git a/OpenSim/Region/CoreModules/Framework/Library/LibraryModule.cs b/OpenSim/Region/CoreModules/Framework/Library/LibraryModule.cs
new file mode 100644
index 0000000..df7df46
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Framework/Library/LibraryModule.cs
@@ -0,0 +1,219 @@
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 OpenSimulator 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 */
27using System;
28using System.Collections.Generic;
29using System.IO;
30using System.Reflection;
31
32using OpenSim.Framework;
33using OpenSim.Framework.Communications;
34using OpenSim.Framework.Communications.Cache;
35using OpenSim.Region.CoreModules.Avatar.Inventory.Archiver;
36using OpenSim.Region.Framework;
37using OpenSim.Region.Framework.Interfaces;
38using OpenSim.Region.Framework.Scenes;
39using OpenSim.Services.Interfaces;
40
41using OpenMetaverse;
42using log4net;
43using Nini.Config;
44
45namespace OpenSim.Region.CoreModules.Framework.Library
46{
47 public class LibraryModule : ISharedRegionModule
48 {
49 private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
50 private static bool m_HasRunOnce = false;
51
52 private bool m_Enabled = false;
53 private string m_LibraryName = "OpenSim Library";
54 private Scene m_Scene;
55
56 #region ISharedRegionModule
57
58 public void Initialise(IConfigSource config)
59 {
60 m_Enabled = config.Configs["Modules"].GetBoolean("LibraryModule", m_Enabled);
61 if (m_Enabled)
62 {
63 IConfig libConfig = config.Configs["LibraryModule"];
64 if (libConfig != null)
65 m_LibraryName = libConfig.GetString("LibraryName", m_LibraryName);
66 }
67 }
68
69 public bool IsSharedModule
70 {
71 get { return true; }
72 }
73
74 public string Name
75 {
76 get { return "Library Module"; }
77 }
78
79 public Type ReplaceableInterface
80 {
81 get { return null; }
82 }
83
84 public void AddRegion(Scene scene)
85 {
86 if (!m_Enabled)
87 return;
88
89 // Store only the first scene
90 if (m_Scene == null)
91 {
92 m_Scene = scene;
93 }
94 }
95
96 public void RemoveRegion(Scene scene)
97 {
98 }
99
100 public void RegionLoaded(Scene scene)
101 {
102 if (!m_Enabled)
103 return;
104
105 // This will never run more than once, even if the region is restarted
106 if (!m_HasRunOnce)
107 {
108 LoadLibrariesFromArchives();
109 //DumpLibrary();
110 m_HasRunOnce = true;
111 }
112 }
113
114 public void PostInitialise()
115 {
116 }
117
118 public void Close()
119 {
120 m_Scene = null;
121 }
122
123 #endregion ISharedRegionModule
124
125 #region LoadLibraries
126 private string pathToLibraries = "Library";
127
128 protected void LoadLibrariesFromArchives()
129 {
130 InventoryFolderImpl lib = m_Scene.CommsManager.UserProfileCacheService.LibraryRoot;
131 if (lib == null)
132 {
133 m_log.Debug("[LIBRARY MODULE]: No library.");
134 return;
135 }
136
137 lib.Name = m_LibraryName;
138
139 RegionInfo regInfo = new RegionInfo();
140 Scene m_MockScene = new Scene(regInfo);
141 m_MockScene.CommsManager = m_Scene.CommsManager;
142 LocalInventoryService invService = new LocalInventoryService((LibraryRootFolder)lib);
143 m_MockScene.RegisterModuleInterface<IInventoryService>(invService);
144 m_MockScene.RegisterModuleInterface<IAssetService>(m_Scene.AssetService);
145
146 UserProfileData profile = new UserProfileData();
147 profile.FirstName = "OpenSim";
148 profile.ID = lib.Owner;
149 profile.SurName = "Library";
150 CachedUserInfo uinfo = new CachedUserInfo(invService, profile);
151
152 foreach (string iarFileName in Directory.GetFiles(pathToLibraries, "*.iar"))
153 {
154 string simpleName = Path.GetFileNameWithoutExtension(iarFileName);
155
156 m_log.InfoFormat("[LIBRARY MODULE]: Loading library archive {0} ({1})...", iarFileName, simpleName);
157 simpleName = GetInventoryPathFromName(simpleName);
158
159 try
160 {
161 InventoryArchiveReadRequest archread = new InventoryArchiveReadRequest(m_MockScene, uinfo, simpleName, iarFileName);
162 List<InventoryNodeBase> nodes = archread.Execute();
163 if (nodes.Count == 0)
164 {
165 // didn't find the subfolder with the given name; place it on the top
166 m_log.InfoFormat("[LIBRARY MODULE]: Didn't find {0} in library. Placing archive on the top level", simpleName);
167 archread.Close();
168 archread = new InventoryArchiveReadRequest(m_MockScene, uinfo, "/", iarFileName);
169 archread.Execute();
170 }
171 archread.Close();
172 }
173 catch (Exception e)
174 {
175 m_log.DebugFormat("[LIBRARY MODULE]: Exception when processing archive {0}: {1}", iarFileName, e.Message);
176 }
177
178 }
179
180 }
181
182 private void DumpLibrary()
183 {
184 InventoryFolderImpl lib = m_Scene.CommsManager.UserProfileCacheService.LibraryRoot;
185
186 m_log.DebugFormat(" - folder {0}", lib.Name);
187 DumpFolder(lib);
188 }
189
190 private void DumpFolder(InventoryFolderImpl folder)
191 {
192 foreach (InventoryItemBase item in folder.Items.Values)
193 {
194 m_log.DebugFormat(" --> item {0}", item.Name);
195 }
196 foreach (InventoryFolderImpl f in folder.RequestListOfFolderImpls())
197 {
198 m_log.DebugFormat(" - folder {0}", f.Name);
199 DumpFolder(f);
200 }
201 }
202
203 private string GetInventoryPathFromName(string name)
204 {
205 string[] parts = name.Split(new char[] { ' ' });
206 if (parts.Length == 3)
207 {
208 name = string.Empty;
209 // cut the last part
210 for (int i = 0; i < parts.Length - 1; i++)
211 name = name + ' ' + parts[i];
212 }
213
214 return name;
215 }
216
217 #endregion LoadLibraries
218 }
219}
diff --git a/OpenSim/Region/CoreModules/Framework/Library/LocalInventoryService.cs b/OpenSim/Region/CoreModules/Framework/Library/LocalInventoryService.cs
new file mode 100644
index 0000000..2c95b5a
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Framework/Library/LocalInventoryService.cs
@@ -0,0 +1,263 @@
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 OpenSimulator 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 */
27using System;
28using System.Collections.Generic;
29using System.Reflection;
30
31using OpenSim.Framework;
32using OpenSim.Framework.Communications.Cache;
33using OpenSim.Services.Interfaces;
34
35using OpenMetaverse;
36using log4net;
37
38namespace OpenSim.Region.CoreModules.Framework.Library
39{
40 public class LocalInventoryService : IInventoryService
41 {
42 private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
43
44 private LibraryRootFolder m_Library;
45
46 public LocalInventoryService(LibraryRootFolder lib)
47 {
48 m_Library = lib;
49 }
50
51 /// <summary>
52 /// Retrieve the root inventory folder for the given user.
53 /// </summary>
54 /// <param name="userID"></param>
55 /// <returns>null if no root folder was found</returns>
56 public InventoryFolderBase GetRootFolder(UUID userID) { return m_Library; }
57
58 /// <summary>
59 /// Gets everything (folders and items) inside a folder
60 /// </summary>
61 /// <param name="userId"></param>
62 /// <param name="folderID"></param>
63 /// <returns></returns>
64 public InventoryCollection GetFolderContent(UUID userID, UUID folderID)
65 {
66 InventoryFolderImpl folder = null;
67 InventoryCollection inv = new InventoryCollection();
68 inv.UserID = m_Library.Owner;
69
70 if (folderID != m_Library.ID)
71 {
72 folder = m_Library.FindFolder(folderID);
73 if (folder == null)
74 {
75 inv.Folders = new List<InventoryFolderBase>();
76 inv.Items = new List<InventoryItemBase>();
77 return inv;
78 }
79 }
80 else
81 folder = m_Library;
82
83 inv.Folders = folder.RequestListOfFolders();
84 inv.Items = folder.RequestListOfItems();
85
86 m_log.DebugFormat("[LIBRARY MODULE]: Got content for folder {0}", folder.Name);
87 return inv;
88 }
89
90 /// <summary>
91 /// Add a new folder to the user's inventory
92 /// </summary>
93 /// <param name="folder"></param>
94 /// <returns>true if the folder was successfully added</returns>
95 public bool AddFolder(InventoryFolderBase folder)
96 {
97 //m_log.DebugFormat("[LIBRARY MODULE]: Adding folder {0} ({1}) to {2}", folder.Name, folder.ID, folder.ParentID);
98 InventoryFolderImpl parent = m_Library;
99 if (m_Library.ID != folder.ParentID)
100 parent = m_Library.FindFolder(folder.ParentID);
101
102 if (parent == null)
103 {
104 m_log.DebugFormat("[LIBRARY MODULE]: could not add folder {0} because parent folder {1} not found", folder.Name, folder.ParentID);
105 return false;
106 }
107
108 parent.CreateChildFolder(folder.ID, folder.Name, (ushort)folder.Type);
109
110 return true;
111 }
112
113 /// <summary>
114 /// Add a new item to the user's inventory
115 /// </summary>
116 /// <param name="item"></param>
117 /// <returns>true if the item was successfully added</returns>
118 public bool AddItem(InventoryItemBase item)
119 {
120 //m_log.DebugFormat("[LIBRARY MODULE]: Adding item {0} to {1}", item.Name, item.Folder);
121 InventoryFolderImpl folder = m_Library;
122 if (m_Library.ID != item.Folder)
123 folder = m_Library.FindFolder(item.Folder);
124
125 if (folder == null)
126 {
127 m_log.DebugFormat("[LIBRARY MODULE]: could not add item {0} because folder {1} not found", item.Name, item.Folder);
128 return false;
129 }
130
131 folder.Items.Add(item.ID, item);
132 return true;
133 }
134
135 public bool CreateUserInventory(UUID user) { return false; }
136
137 /// <summary>
138 /// Gets the skeleton of the inventory -- folders only
139 /// </summary>
140 /// <param name="userId"></param>
141 /// <returns></returns>
142 public List<InventoryFolderBase> GetInventorySkeleton(UUID userId) { return null; }
143
144 /// <summary>
145 /// Synchronous inventory fetch.
146 /// </summary>
147 /// <param name="userID"></param>
148 /// <returns></returns>
149 public InventoryCollection GetUserInventory(UUID userID) { return null; }
150
151 /// <summary>
152 /// Request the inventory for a user. This is an asynchronous operation that will call the callback when the
153 /// inventory has been received
154 /// </summary>
155 /// <param name="userID"></param>
156 /// <param name="callback"></param>
157 public void GetUserInventory(UUID userID, InventoryReceiptCallback callback) { }
158
159
160 /// <summary>
161 /// Gets the user folder for the given folder-type
162 /// </summary>
163 /// <param name="userID"></param>
164 /// <param name="type"></param>
165 /// <returns></returns>
166 public InventoryFolderBase GetFolderForType(UUID userID, AssetType type) { return null; }
167
168
169 /// <summary>
170 /// Gets the items inside a folder
171 /// </summary>
172 /// <param name="userID"></param>
173 /// <param name="folderID"></param>
174 /// <returns></returns>
175 public List<InventoryItemBase> GetFolderItems(UUID userID, UUID folderID) { return null; }
176
177
178 /// <summary>
179 /// Update a folder in the user's inventory
180 /// </summary>
181 /// <param name="folder"></param>
182 /// <returns>true if the folder was successfully updated</returns>
183 public bool UpdateFolder(InventoryFolderBase folder) { return false; }
184
185 /// <summary>
186 /// Move an inventory folder to a new location
187 /// </summary>
188 /// <param name="folder">A folder containing the details of the new location</param>
189 /// <returns>true if the folder was successfully moved</returns>
190 public bool MoveFolder(InventoryFolderBase folder) { return false; }
191
192 /// <summary>
193 /// Delete an item from the user's inventory
194 /// </summary>
195 /// <param name="item"></param>
196 /// <returns>true if the item was successfully deleted</returns>
197 //bool DeleteItem(InventoryItemBase item);
198 public bool DeleteFolders(UUID userID, List<UUID> folderIDs) { return false; }
199
200 /// <summary>
201 /// Purge an inventory folder of all its items and subfolders.
202 /// </summary>
203 /// <param name="folder"></param>
204 /// <returns>true if the folder was successfully purged</returns>
205 public bool PurgeFolder(InventoryFolderBase folder) { return false; }
206
207
208 /// <summary>
209 /// Update an item in the user's inventory
210 /// </summary>
211 /// <param name="item"></param>
212 /// <returns>true if the item was successfully updated</returns>
213 public bool UpdateItem(InventoryItemBase item) { return false; }
214
215 public bool MoveItems(UUID ownerID, List<InventoryItemBase> items) { return false; }
216
217 /// <summary>
218 /// Delete an item from the user's inventory
219 /// </summary>
220 /// <param name="item"></param>
221 /// <returns>true if the item was successfully deleted</returns>
222 //bool DeleteItem(InventoryItemBase item);
223 public bool DeleteItems(UUID userID, List<UUID> itemIDs) { return false; }
224
225 /// <summary>
226 /// Get an item, given by its UUID
227 /// </summary>
228 /// <param name="item"></param>
229 /// <returns></returns>
230 public InventoryItemBase GetItem(InventoryItemBase item) { return null; }
231
232 /// <summary>
233 /// Get a folder, given by its UUID
234 /// </summary>
235 /// <param name="folder"></param>
236 /// <returns></returns>
237 public InventoryFolderBase GetFolder(InventoryFolderBase folder) { return null; }
238
239 /// <summary>
240 /// Does the given user have an inventory structure?
241 /// </summary>
242 /// <param name="userID"></param>
243 /// <returns></returns>
244 public bool HasInventoryForUser(UUID userID) { return false; }
245
246 /// <summary>
247 /// Get the active gestures of the agent.
248 /// </summary>
249 /// <param name="userId"></param>
250 /// <returns></returns>
251 public List<InventoryItemBase> GetActiveGestures(UUID userId) { return null; }
252
253 /// <summary>
254 /// Get the union of permissions of all inventory items
255 /// that hold the given assetID.
256 /// </summary>
257 /// <param name="userID"></param>
258 /// <param name="assetID"></param>
259 /// <returns>The permissions or 0 if no such asset is found in
260 /// the user's inventory</returns>
261 public int GetAssetPermissions(UUID userID, UUID assetID) { return 0; }
262 }
263}
diff --git a/OpenSim/Region/CoreModules/Resources/CoreModulePlugin.addin.xml b/OpenSim/Region/CoreModules/Resources/CoreModulePlugin.addin.xml
index 9757072..beb2307 100644
--- a/OpenSim/Region/CoreModules/Resources/CoreModulePlugin.addin.xml
+++ b/OpenSim/Region/CoreModules/Resources/CoreModulePlugin.addin.xml
@@ -20,6 +20,7 @@
20 <RegionModule id="CoreAssetCache" type="OpenSim.Region.CoreModules.Asset.CoreAssetCache" /> 20 <RegionModule id="CoreAssetCache" type="OpenSim.Region.CoreModules.Asset.CoreAssetCache" />
21 <RegionModule id="GlynnTuckerAssetCache" type="OpenSim.Region.CoreModules.Asset.GlynnTuckerAssetCache" /> 21 <RegionModule id="GlynnTuckerAssetCache" type="OpenSim.Region.CoreModules.Asset.GlynnTuckerAssetCache" />
22 <RegionModule id="CenomeMemoryAssetCache" type="OpenSim.Region.CoreModules.Asset.CenomeMemoryAssetCache"/> 22 <RegionModule id="CenomeMemoryAssetCache" type="OpenSim.Region.CoreModules.Asset.CenomeMemoryAssetCache"/>
23 <RegionModule id="LibraryModule" type="OpenSim.Region.CoreModules.Framework.Library.LibraryModule"/>
23 <!-- Service connectors OUT modules --> 24 <!-- Service connectors OUT modules -->
24 <RegionModule id="LocalUserServicesConnector" type="OpenSim.Region.CoreModules.ServiceConnectorsOut.User.LocalUserServicesConnector" /> 25 <RegionModule id="LocalUserServicesConnector" type="OpenSim.Region.CoreModules.ServiceConnectorsOut.User.LocalUserServicesConnector" />
25 <RegionModule id="RemoteUserServicesConnector" type="OpenSim.Region.CoreModules.ServiceConnectorsOut.User.RemoteUserServicesConnector" /> 26 <RegionModule id="RemoteUserServicesConnector" type="OpenSim.Region.CoreModules.ServiceConnectorsOut.User.RemoteUserServicesConnector" />