OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule:
Collaboration graph
[legend]

Public Member Functions

void Initialise (IConfigSource config)
 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 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 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 HandleBypassPermissions (string module, string[] args)
 
void HandleForcePermissions (string module, string[] args)
 
void HandleDebugPermissions (string module, string[] args)
 
bool PropagatePermissions ()
 
bool BypassPermissions ()
 
void SetBypassPermissions (bool value)
 
uint GenerateClientFlags (UUID user, UUID objID)
 
PermissionClass GetPermissionClass (UUID user, SceneObjectPart obj)
 Returns the type of permissions that the user has over an object. More...
 
bool GenericEstatePermission (UUID user)
 

Protected Member Functions

void SendPermissionError (UUID user, string reason)
 
void DebugPermissionInformation (string permissionCalled)
 
bool IsGroupMember (UUID groupID, UUID userID, ulong powers)
 Checks if the given group is active and if the user is a group member with the powers requested (powers = 0 for no powers check) More...
 
bool IsAdministrator (UUID user)
 Is the user regarded as an administrator? More...
 
bool IsGridGod (UUID user, Scene scene)
 Is the given user a God throughout the grid (not just in the current scene)? More...
 
bool IsFriendWithPerms (UUID user, UUID objectOwner)
 
bool IsEstateManager (UUID user)
 
bool GenericObjectPermission (UUID currentUser, UUID objId, bool denyOnLocked)
 General permissions checks for any operation involving an object. These supplement more specific checks implemented by callers. More...
 
bool GenericCommunicationPermission (UUID user, UUID target)
 
bool GenericParcelPermission (UUID user, ILandObject parcel, ulong groupPowers)
 
bool GenericParcelOwnerPermission (UUID user, ILandObject parcel, ulong groupPowers, bool allowEstateManager)
 
bool GenericParcelPermission (UUID user, Vector3 pos, ulong groupPowers)
 

Protected Attributes

Scene m_scene
 
bool m_Enabled
 

Properties

InventoryFolderImpl LibraryRootFolder [get]
 
string Name [get]
 
Type ReplaceableInterface [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...
 

Detailed Description

Definition at line 47 of file PermissionsModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 253 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.BypassPermissions ( )
inline

Definition at line 588 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.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 347 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.DebugPermissionInformation ( string  permissionCalled)
inlineprotected

Definition at line 444 of file PermissionsModule.cs.

uint OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.GenerateClientFlags ( UUID  user,
UUID  objID 
)
inline

Definition at line 600 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.GenericCommunicationPermission ( UUID  user,
UUID  target 
)
inlineprotected

Definition at line 841 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.GenericEstatePermission ( UUID  user)
inline

Definition at line 860 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.GenericObjectPermission ( UUID  currentUser,
UUID  objId,
bool  denyOnLocked 
)
inlineprotected

General permissions checks for any operation involving an object. These supplement more specific checks implemented by callers.

Parameters
currentUser
objIdThis is a scene object group UUID
denyOnLocked
Returns

Definition at line 745 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.GenericParcelOwnerPermission ( UUID  user,
ILandObject  parcel,
ulong  groupPowers,
bool  allowEstateManager 
)
inlineprotected

Definition at line 907 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.GenericParcelPermission ( UUID  user,
ILandObject  parcel,
ulong  groupPowers 
)
inlineprotected

Definition at line 876 of file PermissionsModule.cs.

Here is the call graph for this function:

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.GenericParcelPermission ( UUID  user,
Vector3  pos,
ulong  groupPowers 
)
inlineprotected

Definition at line 935 of file PermissionsModule.cs.

PermissionClass OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.GetPermissionClass ( UUID  user,
SceneObjectPart  obj 
)
inline

Returns the type of permissions that the user has over an object.

Parameters
userThe user
objThe object
Returns
The type of permissions the user has over the object

Implements OpenSim.Region.Framework.Interfaces.IPermissionsModule.

Definition at line 696 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.HandleBypassPermissions ( string  module,
string[]  args 
)
inline

Definition at line 365 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.HandleDebugPermissions ( string  module,
string[]  args 
)
inline

Definition at line 415 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.HandleForcePermissions ( string  module,
string[]  args 
)
inline

Definition at line 388 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.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
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 159 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.IsAdministrator ( UUID  user)
inlineprotected

Is the user regarded as an administrator?

Parameters
user
Returns

Definition at line 515 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.IsEstateManager ( UUID  user)
inlineprotected

Definition at line 571 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.IsFriendWithPerms ( UUID  user,
UUID  objectOwner 
)
inlineprotected

Definition at line 559 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.IsGridGod ( UUID  user,
Scene  scene 
)
inlineprotected

Is the given user a God throughout the grid (not just in the current scene)?

Parameters
userThe user
sceneUnused, can be null
Returns

Definition at line 538 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.IsGroupMember ( UUID  groupID,
UUID  userID,
ulong  powers 
)
inlineprotected

Checks if the given group is active and if the user is a group member with the powers requested (powers = 0 for no powers check)

Parameters
groupID
userID
powers
Returns

Definition at line 458 of file PermissionsModule.cs.

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.PropagatePermissions ( )
inline

Definition at line 580 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 335 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 339 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.SendPermissionError ( UUID  user,
string  reason 
)
inlineprotected

Definition at line 439 of file PermissionsModule.cs.

void OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.SetBypassPermissions ( bool  value)
inline

Definition at line 593 of file PermissionsModule.cs.

Member Data Documentation

bool OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.m_Enabled
protected

Definition at line 52 of file PermissionsModule.cs.

Scene OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.m_scene
protected

Definition at line 51 of file PermissionsModule.cs.

Property Documentation

InventoryFolderImpl OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.LibraryRootFolder
getprotected

Definition at line 56 of file PermissionsModule.cs.

string OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.Name
get

Definition at line 352 of file PermissionsModule.cs.

Type OpenSim.Region.CoreModules.World.Permissions.DefaultPermissionsModule.ReplaceableInterface
get

Definition at line 357 of file PermissionsModule.cs.


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