LibraryService.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  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. */
  27. using System;
  28. using System.Collections.Generic;
  29. using System.IO;
  30. using System.Reflection;
  31. using System.Xml;
  32. using OpenSim.Framework;
  33. using OpenSim.Services.Base;
  34. using OpenSim.Services.Interfaces;
  35. using log4net;
  36. using Nini.Config;
  37. using OpenMetaverse;
  38. namespace OpenSim.Services.InventoryService
  39. {
  40. /// <summary>
  41. /// Basically a hack to give us a Inventory library while we don't have a inventory server
  42. /// once the server is fully implemented then should read the data from that
  43. /// </summary>
  44. public class LibraryService : ServiceBase, ILibraryService
  45. {
  46. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  47. private InventoryFolderImpl m_LibraryRootFolder;
  48. public InventoryFolderImpl LibraryRootFolder
  49. {
  50. get { return m_LibraryRootFolder; }
  51. }
  52. private UUID libOwner = new UUID("11111111-1111-0000-0000-000100bba000");
  53. /// <summary>
  54. /// Holds the root library folder and all its descendents. This is really only used during inventory
  55. /// setup so that we don't have to repeatedly search the tree of library folders.
  56. /// </summary>
  57. protected Dictionary<UUID, InventoryFolderImpl> libraryFolders
  58. = new Dictionary<UUID, InventoryFolderImpl>();
  59. public LibraryService(IConfigSource config)
  60. : base(config)
  61. {
  62. string pLibrariesLocation = Path.Combine("inventory", "Libraries.xml");
  63. string pLibName = "OpenSim Library";
  64. IConfig libConfig = config.Configs["LibraryService"];
  65. if (libConfig != null)
  66. {
  67. pLibrariesLocation = libConfig.GetString("DefaultLibrary", pLibrariesLocation);
  68. pLibName = libConfig.GetString("LibraryName", pLibName);
  69. }
  70. m_log.Debug("[LIBRARY]: Starting library service...");
  71. m_LibraryRootFolder = new InventoryFolderImpl();
  72. m_LibraryRootFolder.Owner = libOwner;
  73. m_LibraryRootFolder.ID = new UUID("00000112-000f-0000-0000-000100bba000");
  74. m_LibraryRootFolder.Name = pLibName;
  75. m_LibraryRootFolder.ParentID = UUID.Zero;
  76. m_LibraryRootFolder.Type = (short)8;
  77. m_LibraryRootFolder.Version = (ushort)1;
  78. libraryFolders.Add(m_LibraryRootFolder.ID, m_LibraryRootFolder);
  79. LoadLibraries(pLibrariesLocation);
  80. }
  81. public InventoryItemBase CreateItem(UUID inventoryID, UUID assetID, string name, string description,
  82. int assetType, int invType, UUID parentFolderID)
  83. {
  84. InventoryItemBase item = new InventoryItemBase();
  85. item.Owner = libOwner;
  86. item.CreatorId = libOwner.ToString();
  87. item.ID = inventoryID;
  88. item.AssetID = assetID;
  89. item.Description = description;
  90. item.Name = name;
  91. item.AssetType = assetType;
  92. item.InvType = invType;
  93. item.Folder = parentFolderID;
  94. item.BasePermissions = 0x7FFFFFFF;
  95. item.EveryOnePermissions = 0x7FFFFFFF;
  96. item.CurrentPermissions = 0x7FFFFFFF;
  97. item.NextPermissions = 0x7FFFFFFF;
  98. return item;
  99. }
  100. /// <summary>
  101. /// Use the asset set information at path to load assets
  102. /// </summary>
  103. /// <param name="path"></param>
  104. /// <param name="assets"></param>
  105. protected void LoadLibraries(string librariesControlPath)
  106. {
  107. m_log.InfoFormat("[LIBRARY INVENTORY]: Loading library control file {0}", librariesControlPath);
  108. LoadFromFile(librariesControlPath, "Libraries control", ReadLibraryFromConfig);
  109. }
  110. /// <summary>
  111. /// Read a library set from config
  112. /// </summary>
  113. /// <param name="config"></param>
  114. protected void ReadLibraryFromConfig(IConfig config, string path)
  115. {
  116. string basePath = Path.GetDirectoryName(path);
  117. string foldersPath
  118. = Path.Combine(
  119. basePath, config.GetString("foldersFile", String.Empty));
  120. LoadFromFile(foldersPath, "Library folders", ReadFolderFromConfig);
  121. string itemsPath
  122. = Path.Combine(
  123. basePath, config.GetString("itemsFile", String.Empty));
  124. LoadFromFile(itemsPath, "Library items", ReadItemFromConfig);
  125. }
  126. /// <summary>
  127. /// Read a library inventory folder from a loaded configuration
  128. /// </summary>
  129. /// <param name="source"></param>
  130. private void ReadFolderFromConfig(IConfig config, string path)
  131. {
  132. InventoryFolderImpl folderInfo = new InventoryFolderImpl();
  133. folderInfo.ID = new UUID(config.GetString("folderID", m_LibraryRootFolder.ID.ToString()));
  134. folderInfo.Name = config.GetString("name", "unknown");
  135. folderInfo.ParentID = new UUID(config.GetString("parentFolderID", m_LibraryRootFolder.ID.ToString()));
  136. folderInfo.Type = (short)config.GetInt("type", 8);
  137. folderInfo.Owner = libOwner;
  138. folderInfo.Version = 1;
  139. if (libraryFolders.ContainsKey(folderInfo.ParentID))
  140. {
  141. InventoryFolderImpl parentFolder = libraryFolders[folderInfo.ParentID];
  142. libraryFolders.Add(folderInfo.ID, folderInfo);
  143. parentFolder.AddChildFolder(folderInfo);
  144. // m_log.InfoFormat("[LIBRARY INVENTORY]: Adding folder {0} ({1})", folderInfo.name, folderInfo.folderID);
  145. }
  146. else
  147. {
  148. m_log.WarnFormat(
  149. "[LIBRARY INVENTORY]: Couldn't add folder {0} ({1}) since parent folder with ID {2} does not exist!",
  150. folderInfo.Name, folderInfo.ID, folderInfo.ParentID);
  151. }
  152. }
  153. /// <summary>
  154. /// Read a library inventory item metadata from a loaded configuration
  155. /// </summary>
  156. /// <param name="source"></param>
  157. private void ReadItemFromConfig(IConfig config, string path)
  158. {
  159. InventoryItemBase item = new InventoryItemBase();
  160. item.Owner = libOwner;
  161. item.CreatorId = libOwner.ToString();
  162. item.ID = new UUID(config.GetString("inventoryID", m_LibraryRootFolder.ID.ToString()));
  163. item.AssetID = new UUID(config.GetString("assetID", item.ID.ToString()));
  164. item.Folder = new UUID(config.GetString("folderID", m_LibraryRootFolder.ID.ToString()));
  165. item.Name = config.GetString("name", String.Empty);
  166. item.Description = config.GetString("description", item.Name);
  167. item.InvType = config.GetInt("inventoryType", 0);
  168. item.AssetType = config.GetInt("assetType", item.InvType);
  169. item.CurrentPermissions = (uint)config.GetLong("currentPermissions", 0x7FFFFFFF);
  170. item.NextPermissions = (uint)config.GetLong("nextPermissions", 0x7FFFFFFF);
  171. item.EveryOnePermissions = (uint)config.GetLong("everyonePermissions", 0x7FFFFFFF);
  172. item.BasePermissions = (uint)config.GetLong("basePermissions", 0x7FFFFFFF);
  173. item.Flags = (uint)config.GetInt("flags", 0);
  174. if (libraryFolders.ContainsKey(item.Folder))
  175. {
  176. InventoryFolderImpl parentFolder = libraryFolders[item.Folder];
  177. try
  178. {
  179. parentFolder.Items.Add(item.ID, item);
  180. }
  181. catch (Exception)
  182. {
  183. m_log.WarnFormat("[LIBRARY INVENTORY] Item {1} [{0}] not added, duplicate item", item.ID, item.Name);
  184. }
  185. }
  186. else
  187. {
  188. m_log.WarnFormat(
  189. "[LIBRARY INVENTORY]: Couldn't add item {0} ({1}) since parent folder with ID {2} does not exist!",
  190. item.Name, item.ID, item.Folder);
  191. }
  192. }
  193. private delegate void ConfigAction(IConfig config, string path);
  194. /// <summary>
  195. /// Load the given configuration at a path and perform an action on each Config contained within it
  196. /// </summary>
  197. /// <param name="path"></param>
  198. /// <param name="fileDescription"></param>
  199. /// <param name="action"></param>
  200. private static void LoadFromFile(string path, string fileDescription, ConfigAction action)
  201. {
  202. if (File.Exists(path))
  203. {
  204. try
  205. {
  206. XmlConfigSource source = new XmlConfigSource(path);
  207. for (int i = 0; i < source.Configs.Count; i++)
  208. {
  209. action(source.Configs[i], path);
  210. }
  211. }
  212. catch (XmlException e)
  213. {
  214. m_log.ErrorFormat("[LIBRARY INVENTORY]: Error loading {0} : {1}", path, e);
  215. }
  216. }
  217. else
  218. {
  219. m_log.ErrorFormat("[LIBRARY INVENTORY]: {0} file {1} does not exist!", fileDescription, path);
  220. }
  221. }
  222. /// <summary>
  223. /// Looks like a simple getter, but is written like this for some consistency with the other Request
  224. /// methods in the superclass
  225. /// </summary>
  226. /// <returns></returns>
  227. public Dictionary<UUID, InventoryFolderImpl> GetAllFolders()
  228. {
  229. Dictionary<UUID, InventoryFolderImpl> fs = new Dictionary<UUID, InventoryFolderImpl>();
  230. fs.Add(m_LibraryRootFolder.ID, m_LibraryRootFolder);
  231. List<InventoryFolderImpl> fis = TraverseFolder(m_LibraryRootFolder);
  232. foreach (InventoryFolderImpl f in fis)
  233. {
  234. fs.Add(f.ID, f);
  235. }
  236. //return libraryFolders;
  237. return fs;
  238. }
  239. private List<InventoryFolderImpl> TraverseFolder(InventoryFolderImpl node)
  240. {
  241. List<InventoryFolderImpl> folders = node.RequestListOfFolderImpls();
  242. List<InventoryFolderImpl> subs = new List<InventoryFolderImpl>();
  243. foreach (InventoryFolderImpl f in folders)
  244. subs.AddRange(TraverseFolder(f));
  245. folders.AddRange(subs);
  246. return folders;
  247. }
  248. }
  249. }