This module loads and saves OpenSimulator inventory archives More...

Inheritance diagram for OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule:

Collaboration diagram for OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule:

Public Member Functions
	InventoryArchiverModule ()

void	Initialise (IConfigSource source)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...

bool	ArchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, Stream saveStream)
	Archive a user's inventory folder to the given stream More...

bool	ArchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, Stream saveStream, Dictionary< string, object > options)
	Archive a user's inventory folder to the given stream More...

bool	ArchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, string savePath, Dictionary< string, object > options)

bool	DearchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, Stream loadStream)
	Dearchive a user's inventory folder from the given stream More...

bool	DearchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, Stream loadStream, Dictionary< string, object > options)
	Dearchive a user's inventory folder from the given stream More...

bool	DearchiveInventory (UUID id, string firstName, string lastName, string invPath, string pass, string loadPath, Dictionary< string, object > options)

Protected Member Functions
void	HandleLoadInvConsoleCommand (string module, string[] cmdparams)
	Load inventory from an inventory file archive More...

void	HandleSaveInvConsoleCommand (string module, string[] cmdparams)
	Save inventory to a file archive More...

UserAccount	GetUserInfo (string firstName, string lastName, string pass)
	Get user information for the given name. More...

Protected Attributes
const string	DEFAULT_INV_BACKUP_FILENAME = "user-inventory.iar"
	The file to load and save inventory if no filename has been specified More...

List< UUID >	m_pendingConsoleTasks = new List<UUID>()

Properties
IUserAccountService	UserAccountService `[get]`

Type	ReplaceableInterface `[get]`

string	Name `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Events
InventoryArchiveSaved	OnInventoryArchiveSaved

InventoryArchiveLoaded	OnInventoryArchiveLoaded

Events inherited from OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule
InventoryArchiveSaved	OnInventoryArchiveSaved
	Fired when an archive inventory save has been completed. More...

InventoryArchiveLoaded	OnInventoryArchiveLoaded
	Fired when an archive inventory load has been completed. More...

Detailed Description

This module loads and saves OpenSimulator inventory archives

Definition at line 49 of file InventoryArchiverModule.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.InventoryArchiverModule ( )

inline

Definition at line 95 of file InventoryArchiverModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.AddRegion ( Scene scene )

inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 108 of file InventoryArchiverModule.cs.

bool OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.ArchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		Stream	saveStream
	)

inline

Archive a user's inventory folder to the given stream

Parameters

id	ID representing this request. This will later be returned in the save event
firstName
lastName
invPath	The inventory path from which the inventory should be saved.
saveStream	The stream to which the inventory archive will be saved

Returns: true if the first stage of the operation succeeded, false otherwise

Implements OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.

Definition at line 201 of file InventoryArchiverModule.cs.

bool OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.ArchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		Stream	saveStream,
		Dictionary< string, object >	options
	)

inline

Archive a user's inventory folder to the given stream

Parameters

id	ID representing this request. This will later be returned in the save event
firstName
lastName
invPath	The inventory path from which the inventory should be saved.
saveStream	The stream to which the inventory archive will be saved
options	Archiving options. Currently, there are none.

Returns: true if the first stage of the operation succeeded, false otherwise

Implements OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.

Definition at line 207 of file InventoryArchiverModule.cs.

bool OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.ArchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		string	savePath,
		Dictionary< string, object >	options
	)

inline

Definition at line 247 of file InventoryArchiverModule.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.Close ( )

inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 158 of file InventoryArchiverModule.cs.

bool OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.DearchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		Stream	loadStream
	)

inline

Dearchive a user's inventory folder from the given stream

Parameters

firstName
lastName
invPath	The inventory path in which to place the loaded folders and items
loadStream	The stream from which the inventory archive will be loaded

Returns: true if the first stage of the operation succeeded, false otherwise

Implements OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.

Definition at line 290 of file InventoryArchiverModule.cs.

bool OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.DearchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		Stream	loadStream,
		Dictionary< string, object >	options
	)

inline

Dearchive a user's inventory folder from the given stream

Parameters

firstName
lastName
invPath	The inventory path in which to place the loaded folders and items
loadStream	The stream from which the inventory archive will be loaded
options	Dearchiving options. At the moment, the only option is ("merge", true). This merges the loaded IAR with existing folders where possible.

Returns: true if the first stage of the operation succeeded, false otherwise

Implements OpenSim.Region.Framework.Interfaces.IInventoryArchiverModule.

Definition at line 295 of file InventoryArchiverModule.cs.

Here is the call graph for this function:

bool OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.DearchiveInventory	(	UUID	id,
		string	firstName,
		string	lastName,
		string	invPath,
		string	pass,
		string	loadPath,
		Dictionary< string, object >	options
	)

inline

Definition at line 343 of file InventoryArchiverModule.cs.

Here is the call graph for this function:

UserAccount OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.GetUserInfo	(	string	firstName,
		string	lastName,
		string	pass
	)

inlineprotected

Get user information for the given name.

Parameters

firstName
lastName
pass	User password

Returns

Definition at line 555 of file InventoryArchiverModule.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.HandleLoadInvConsoleCommand	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Load inventory from an inventory file archive

Parameters

cmdparams

Definition at line 392 of file InventoryArchiverModule.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.HandleSaveInvConsoleCommand	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Save inventory to a file archive

Parameters

cmdparams

Definition at line 435 of file InventoryArchiverModule.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.Initialise ( IConfigSource source )

inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 104 of file InventoryArchiverModule.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.PostInitialise ( )

inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 164 of file InventoryArchiverModule.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.RegionLoaded ( Scene scene )

inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 160 of file InventoryArchiverModule.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.RemoveRegion ( Scene scene )

inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 154 of file InventoryArchiverModule.cs.

Member Data Documentation

const string OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.DEFAULT_INV_BACKUP_FILENAME = "user-inventory.iar"

protected

The file to load and save inventory if no filename has been specified

Definition at line 64 of file InventoryArchiverModule.cs.

List<UUID> OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.m_pendingConsoleTasks = new List<UUID>()

protected

Pending save and load completions initiated from the console

Definition at line 69 of file InventoryArchiverModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.Name

get

Definition at line 173 of file InventoryArchiverModule.cs.

Type OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.ReplaceableInterface

get

Definition at line 169 of file InventoryArchiverModule.cs.

IUserAccountService OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.UserAccountService

getprotected

Definition at line 79 of file InventoryArchiverModule.cs.

Event Documentation

InventoryArchiveLoaded OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.OnInventoryArchiveLoaded

Definition at line 59 of file InventoryArchiverModule.cs.

InventoryArchiveSaved OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiverModule.OnInventoryArchiveSaved

Enable or disable checking whether the iar user is actually logged in

Definition at line 58 of file InventoryArchiverModule.cs.

The documentation for this class was generated from the following file:

Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiverModule.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation