1
0

IInventoryArchiverModule.cs 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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 OpenSim.Services.Interfaces;
  31. using OpenMetaverse;
  32. namespace OpenSim.Region.Framework.Interfaces
  33. {
  34. /// <summary>
  35. /// Used for the OnInventoryArchiveSaved event.
  36. /// </summary>
  37. /// <param name="id">Request id</param>
  38. /// <param name="succeeded">true if the save succeeded, false otherwise</param>
  39. /// <param name="userInfo">The user for whom the save was conducted</param>
  40. /// <param name="invPath">The inventory path saved</param>
  41. /// <param name="savePath">The stream to which the archive was saved</param>
  42. /// <param name="reportedException">Contains the exception generated if the save did not succeed</param>
  43. /// <param name="saveCount">Number of inventory items saved to archive</param>
  44. /// <param name="filterCount">Number of inventory items skipped due to perm filter option</param>
  45. public delegate void InventoryArchiveSaved(
  46. UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream saveStream, Exception reportedException, int saveCount, int filterCount);
  47. /// <summary>
  48. /// Used for the OnInventoryArchiveLoaded event.
  49. /// </summary>
  50. /// <param name="id">Request id</param>
  51. /// <param name="succeeded">true if the load succeeded, false otherwise</param>
  52. /// <param name="userInfo">The user for whom the load was conducted</param>
  53. /// <param name="invPath">The inventory path loaded</param>
  54. /// <param name="savePath">The stream from which the archive was loaded</param>
  55. /// <param name="reportedException">Contains the exception generated if the load did not succeed</param>
  56. /// <param name="loadCount">Number of inventory items loaded from archive</param>
  57. public delegate void InventoryArchiveLoaded(
  58. UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream loadStream, Exception reportedException, int loadCount);
  59. public interface IInventoryArchiverModule
  60. {
  61. /// <summary>
  62. /// Fired when an archive inventory save has been completed.
  63. /// </summary>
  64. event InventoryArchiveSaved OnInventoryArchiveSaved;
  65. /// <summary>
  66. /// Fired when an archive inventory load has been completed.
  67. /// </summary>
  68. event InventoryArchiveLoaded OnInventoryArchiveLoaded;
  69. /// <summary>
  70. /// Dearchive a user's inventory folder from the given stream
  71. /// </summary>
  72. /// <param name="firstName"></param>
  73. /// <param name="lastName"></param>
  74. /// <param name="invPath">The inventory path in which to place the loaded folders and items</param>
  75. /// <param name="loadStream">The stream from which the inventory archive will be loaded</param>
  76. /// <returns>true if the first stage of the operation succeeded, false otherwise</returns>
  77. bool DearchiveInventory(UUID id, string firstName, string lastName, string invPath, string pass, Stream loadStream);
  78. /// <summary>
  79. /// Dearchive a user's inventory folder from the given stream
  80. /// </summary>
  81. /// <param name="firstName"></param>
  82. /// <param name="lastName"></param>
  83. /// <param name="invPath">The inventory path in which to place the loaded folders and items</param>
  84. /// <param name="loadStream">The stream from which the inventory archive will be loaded</param>
  85. /// <param name="options">Dearchiving options. At the moment, the only option is ("merge", true). This merges
  86. /// the loaded IAR with existing folders where possible.</param>
  87. /// <returns>true if the first stage of the operation succeeded, false otherwise</returns>
  88. bool DearchiveInventory(
  89. UUID id, string firstName, string lastName, string invPath, string pass, Stream loadStream,
  90. Dictionary<string, object> options);
  91. /// <summary>
  92. /// Archive a user's inventory folder to the given stream
  93. /// </summary>
  94. /// <param name="id">ID representing this request. This will later be returned in the save event</param>
  95. /// <param name="firstName"></param>
  96. /// <param name="lastName"></param>
  97. /// <param name="invPath">The inventory path from which the inventory should be saved.</param>
  98. /// <param name="saveStream">The stream to which the inventory archive will be saved</param>
  99. /// <returns>true if the first stage of the operation succeeded, false otherwise</returns>
  100. bool ArchiveInventory(UUID id, string firstName, string lastName, string invPath, string pass, Stream saveStream);
  101. /// <summary>
  102. /// Archive a user's inventory folder to the given stream
  103. /// </summary>
  104. /// <param name="id">ID representing this request. This will later be returned in the save event</param>
  105. /// <param name="firstName"></param>
  106. /// <param name="lastName"></param>
  107. /// <param name="invPath">The inventory path from which the inventory should be saved.</param>
  108. /// <param name="saveStream">The stream to which the inventory archive will be saved</param>
  109. /// <param name="options">Archiving options. Currently, there are none.</param>
  110. /// <returns>true if the first stage of the operation succeeded, false otherwise</returns>
  111. bool ArchiveInventory(
  112. UUID id, string firstName, string lastName, string invPath, string pass, Stream saveStream,
  113. Dictionary<string, object> options);
  114. }
  115. }