OpenSimulator - User contributions [en]

IRegionModule

2011-09-18T11:34:01Z

Randomhuman: /* The Base Interfaces */

__NOTOC__
{{Quicklinks}}
 

== Introduction ==

Region modules are .net/mono DLLs. During initialization of the simulator, the OpenSim bin directory (bin/) and the scriptengines (bin/ScriptEngines) directory are scanned for DLLs, in an attempt to load region modules stored there.

Region modules execute within the heart of the simulator and have access to all its facilties. Typically, region modules register for a number of events, e.g. chat messages, user logins, texture transfers, and take what ever steps are appropriate for the purposes of the module.

There are two types of region module.

* Non-shared modules where a separate module is created for each region/scene
* Shared region modules, where a single module is shared between all regions/scenes running on the same simulator.

Region Modules require a few basic things:
* The Base Interface
* Some callbacks for OpenSim events

This page now addresses the new region module mechanism, which has been in place since at least 0.6.9. But for an older version of this page that references the older IRegionModule mechanisms, please see http://opensimulator.org/index.php?title=IRegionModule&oldid=13166

== Example ==

Let's start off with the most basic region module possible. Below is a region module that does nothing more than log the events that it receives. Technically, it could be made a little simple by printing messages directly to the console rather than OpenSim's logging infrastructure but it's better to have it nicely integrated.

You can also find this example in OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs in OpenSim's source distribution from 0.7.1 onwards (not yet released). There's also a bare bones shared module example there.

In the source tree, the [Extension... attribute line is commented. You can uncomment this, rebuild OpenSim and start it to see the module in action.

<source lang="csharp">
using System;
using System.Reflection;
using log4net;
using Mono.Addins;
using Nini.Config;
using OpenSim.Region.Framework.Interfaces;
using OpenSim.Region.Framework.Scenes;

[assembly: Addin("BareBonesNonSharedModule", "0.1")]
[assembly: AddinDependency("OpenSim", "0.5")]

namespace OpenSim.Region.OptionalModules.Example.BareBonesNonShared
{
/// <summary>
/// Simplest possible example of a non-shared region module.
/// </summary>
/// <remarks>
/// This module is the simplest possible example of a non-shared region module (a module where each scene/region
/// in the simulator has its own copy).
///
/// When the module is enabled it will print messages when it receives certain events to the screen and the log
/// file.
/// </remarks>
[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BareBonesNonSharedModule")]
public class BareBonesNonSharedModule : INonSharedRegionModule
{
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

public string Name { get { return "Bare Bones Non Shared Module"; } }

public Type ReplaceableInterface { get { return null; } }

public void Initialise(IConfigSource source)
{
m_log.DebugFormat("[BARE BONES]: INITIALIZED MODULE");
}

public void Close()
{
m_log.DebugFormat("[BARE BONES]: CLOSED MODULE");
}

public void AddRegion(Scene scene)
{
m_log.DebugFormat("[BARE BONES]: REGION {0} ADDED", scene.RegionInfo.RegionName);
}

public void RemoveRegion(Scene scene)
{
m_log.DebugFormat("[BARE BONES]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
}

public void RegionLoaded(Scene scene)
{
m_log.DebugFormat("[BARE BONES]: REGION {0} LOADED", scene.RegionInfo.RegionName);
}
}
}
</source>

== The Base Interfaces ==
Now let's discussion the components of the example above. Region modules must implement INonSharedRegionModule or ISharedRegionModule as appropriate - the example above implements INonSharedRegionModule. However, both these interfaces extend IRegionModuleBase, defined as follows.

<source lang="csharp">
public interface IRegionModuleBase
{
string Name { get; }
Type ReplaceableInterface { get; }
void Initialise(IConfigSource source);
void AddRegion(Scene scene);
void RemoveRegion(Scene scene);
void RegionLoaded(Scene scene);
void Close();
}
</source>

<table cellpadding='5' border='1'>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
<tr>
<td>Name</td>
<td>This name is shown when the console command "show modules" is run. For example, "Sim Chat Module" or "The Best Region Module Ever".</td>
</tr>
<tr>
<td>ReplaceableInterface</td>
<td>If this is not null, then the module is not loaded if any other module implements the given interface. One use for this is to provide 'stub' functionality implementations that are only active if no other module is present</td>
</tr>
<tr>
<td>Initialise</td>
<td>This method is called immediately after the region module has been loaded into the runtime, before it has been added to a scene or scenes. IConfigSource is a [http://nini.sourceforge.net/ Nini] class that contains the concatentation of config parameters from OpenSim.ini, OpenSimDefaults.ini and the appropriate ini files in bin/config-include</td>
</tr>
<tr>
<td>AddRegion</td>
<td>This method is called when a region is added to the module. For shared modules this will happen multiple times (one for each module). For non-shared modules this will happen only once. The module can store the scene reference and use it later to reach and invoke OpenSim internals and interfaces.</td>
</tr>
<tr>
<td>RemoveRegion</td>
<td>Called when a region is removed from a module. For shared modules this can happen multiple times. For non-shared region modules this will happen only once and should shortly be followed by a Close(). On simulator shutdown, this method will be called before Close(). RemoveRegion() can also be called if a region/scene is manually removed while the simulator is running.</td>
</tr>
<tr>
<td>RegionLoaded</td>
<td>Called when all modules have been added for a particular scene/region. Since all other modules are now loaded, this gives the module an opportunity to obtain interfaces or subscribe to events on other modules. Called once for a non-shared region module and multiple times for shared region modules.</td>
<tr>
<td>Close</td>
<td>This method will be invoked when the sim is closing down.</td>
</tr>
</table>

INonSharedRegionModule itself contains no methods, being defined simply as

<source lang="csharp">
public interface INonSharedRegionModule : IRegionModuleBase
{
}
</source>

ISharedRegionModule has one additional method.

<source lang="csharp">
public interface ISharedRegionModule : IRegionModuleBase
{
void PostInitialise();
}
</source>

<table cellpadding='5' border='1'>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
<tr>
<td>PostInitialise</td>
<td>Called after Initialise() but before modules are added. This may be a bug - it might be that this should really be called after all the regions have been added.</td>
</tr>
</table>

== Enabling the module ==

Creating the module code itself isn't quite enough to enable it. To do that, we need to make it visible to OpenSim's module mechanism (which is currently [http://www.mono-project.com/Mono.Addins Mono.Addins]).

This is done by adding an Extension attribute to the class, for example.

<source lang="csharp">
[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BareBonesNonSharedModule")]
</source>

The important part here is the "Path" section "/OpenSim/RegionModules" - this is how OpenSim retrieves modules from Mono.Addins. The Id can be anything meaningful to the module.

Newer Mono versions also need this kind of section before the namespace declaration:

<source lang="csharp">
[assembly: Addin("BareBonesNonSharedModule", "0.1")]
[assembly: AddinDependency("OpenSim", "0.5")]
</source>

At the beginning of your module source code file you need to add this line:

<source lang="csharp">
using Mono.Addins;
</source>

And prebuild.xml needs to include such a line for newer Mono versions:

<source lang="csharp">
<Reference name="Mono.Addins.dll"/>
</source>

== Integrating with OpenSim ==

NOTE: This section is now very out of date - NEEDS WORK!

=== Accessible Objects ===

'''Note:''' these are internal interfaces, and will change in the future, probably for the better. We expect these to stabilize over time, but for now this point in time snapshot is probably helpful.

In the '''AddRegion''' routine you get access to the scene object for the region, from here you can spider down into the scene and get access to many other objects of interest.

* scene.GetEntities() - returns a list of all the Entities in the environment. This will be a combined list of SceneObjectGroups (prim sets) and ScenePresences (avatars).
* scene.GetAvatars() - get only the avatars in the scene (very handy for sending messages to clients)
* scene.EventManager - this is the object from which you can register callbacks for scene events. Some examples provided in a little bit
* scene.RegionInfo - properties about the region

=== Registering for Events ===

Taking the [http://opensimulator.org/cgi-bin/viewcvs.cgi/trunk/OpenSim/Region/Environment/Modules/World/Sun/SunModule.cs?view=markup SunModule] as an example we can see the following code:

In Initialise():
<source lang="csharp">
...
m_scene.EventManager.OnFrame += SunUpdate;
...
</source>
Pretty simple, we just got the EventManager and registered the SunUpdate method as a callback for the OnFrame event. OnFrame is triggered every time there is a render frame in opensim, which is about 20 times per second. If you are firing on the OnFrame event you need to do something small, or punt most of the time, as you'll negatively impact the performance of the system otherwise.

Now, for that function...

<source lang="csharp">
public void SunUpdate()
{
// this code just means only do this on every 1000th frame, and don't do it if the sun is in a fixed possition
if (((m_frame++%m_frame_mod) != 0) || !ready || sunFixed)
{
return;
}

GenSunPos(); // Generate shared values once

List<ScenePresence> avatars = m_scene.GetAvatars();
foreach (ScenePresence avatar in avatars)
{
if (!avatar.IsChildAgent)
avatar.ControllingClient.SendSunPos(Position, Velocity, CurrentTime, SecondsPerSunCycle, SecondsPerYear, OrbitalPosition);
}

// set estate settings for region access to sun position
m_scene.RegionInfo.RegionSettings.SunVector = Position;
}
</source>

SunUpdate() takes no parameter (some events may require them). It only fires every 1000th frame by default (m_frame_mod = 1000 in this module), so it doesn't take too many cycles.

In order for the sun position to change for the clients, they need to be told that it changes. This is done by getting a list of all the Avatars from the scene, then sending the Sun Position to each of them in turn. It is important to check to see if the avatar is a ChildAgent, otherwise you will generate zombies in opensim world.

== Where to go from here ==

* [[Getting Started with Region Modules]] -- the Hello World of OpenSim application development. Rather old by now but still worth a look.
* http://bluewallvirtual.com/node/14 - More shared region module example code by Bluewall.
* [[New_Region_Modules|Development discussion of the current region module mechanism]]
* Read the source for existing opensim core modules. These are in the OpenSim.Region.CoreModules and OpenSim.Region.OptionalModules projects. Looking through this code is an extremely good way to find out what region modules can do and how they can do it.
* Read the source code for the EventManager class in the OpenSim.Region.Framework.Scenes project. These list the many events that exist. Some modules may also export their own events (e.g. OnInventoryArchiveSaved in the InventoryArchiverModule at OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/).
* Help write some examples here. OpenSim grows with your contributions.

[[Category:Development]]

Development Team

2011-09-17T18:10:10Z

Randomhuman: /* Added myself to Additional Developers/Testers/Contributors */

__NOTOC__ {{Quicklinks}}

== Active Core Developers ==

Developers who have commit access to our central server, are [http://www.ohloh.net/projects/4753/contributors regular contributors] to the codebase, and have voting rights over development and process issues of the OpenSimulator project. See [[Organization]].

*'''Only voted in developers are listed here, please do not list yourself'''

{| cellspacing="0" cellpadding="2" border="1" class="sortable"
|-
! IRC Nick
! Name
! SL Avatar
! Other Grid
! Time Zone (UTC)
! Org
! Areas of Interest
|-
| [[User:Adam Frisby|Adam Frisby]]
| Adam Frisby
| Adam Zaius
|
| +8
| DeepThink Pty Ltd
| Terrain, Performance
|-
| [[User:Chi11ken|chi11ken]]
| Jeff Ames
| Chillken Proto
| 
| +9
| [http://www.genkii.com Genkii]
| 
|-
| [[User:Justincc|justincc]]
| Justin Clark-Casey
| Lulworth Beaumont
| Justin Clark-Casey (all other grids)
| 0
| OSVW Consulting [http://justincc.org/blog justincc's OpenSim blog]
| Grid, performance & reliability, inventory (avatar and object), assets, scenes, OARs, etc. Generally speaking, my main interest is to create infrastructure that other people can build on top of.
|-
| [[User:Dahlia|dahlia]]
| T. Hoff
| Dahlia Trimble
|
| -8 / -7
| Independent
| Collision geometry, various math and physics issues, occasional bug fixes and random enhancements
|-
| [[User:Melanie T|Melanie_T]]
| Melanie
| Melanie Milland
| 
| +1
| Independent
| Scripting, Prims/Scene, Life, The Universe, and Everything
|-
| [[User:Diva|Diva]]
| Crista Lopes
| Diva Canto
| Crista Lopes / Diva Canto
| -8
| University of California, Irvine
| Everything, except databases
|-
| [[User:Dslake|dslake]]
| Dan Lake
| Dan Lake
| ScienceSim
| -8 / -7
| Intel
| Scalability, Performance, Network stack
|-
| [[User:Marck|Marck00]]
| M. Kirsch
| Marck Kjeller
|
| +1
| Independent
| Everything that catches my attention and that I can get my head around.
|
|-
| cmickeyb
| Mic Bowman
| Mic Bowman
| ScienceSim
| -8 / -7
| Intel
|
|-
| [[User:BlueWall|BlueWall]]
| James Hughes
| BlueWall Slade
| BlueWall Slade
| -5
| BlueWall Information Technologies, LLC
| Various parts
|-
| [[User:Nebadon|Nebadon]]
| Michael Emory Cerquoni
| Nebadon Izumi
| Nebadon Izumi
| -7 Arizona
| Oni Kenkon Creations
| Building, Scripting, Testing
|-
| [[User:Snoopy2|Snoopy2]]
| Snoopy Pfeffer
| Snoopy Pfeffer
| Snoopy Pfeffer
|
| [http://www.3dmetaverse.com/ http://www.3dmetaverse.com/]
| Region Hosting, Open Metaverse, 3D Web, server and viewers, service management
|}

 

== Core Developers Following the White Rabbit ==

Core developers who have temporarily (we hope) gone chasing the white rabbit. They are in all similar to the active core developers, except that they haven't been that active lately, so their voting rights are awaiting their come back.

*'''Only voted in developers are listed here, please do not list yourself'''

{| cellspacing="0" cellpadding="2" border="1" class="sortable"
|-
! IRC Nick
! Name
! SL Avatar
! Other Grid
! Time Zone (UTC)
! Org
! Areas of Interest
|-
| [[User:Lbsa71|lbsa71]]
| Stefan Andersson
| Tribal Skytower
| OSG:Stefan Andersson TN:Stefan Andersson
| +1
| [http://tribalmedia.se/ Tribal Media AB]
| Web Integration
|-
| [[User:MW|MW]]
| Darren
| Wright Juran
|
| 0
|
| Everything
|-
| ckrinke
| Charles Krinke
| Charlesk Bing
|
| -8
|  
| Reliability/Grid servers/ll-functions
|-
| [[User:Mikem|mikem]]
| Mike Mazur
| 
| 
| +9
| Independent
| Patches, scripting improvements, LSL compiler
|-
| [[User:HomerHorwitz|homerh]]
| Homer Horwitz
| Homer Horwitz
| 
| +2
| Independent
| Rev. engineering, "now, that's funny" problems, but still interested in all parts of it
|-
| [[User:Nlin|nlin]]
| N Lin
| Standard Drucker
| 
| +9
| [http://www.3di.jp/en/ 3Di Inc, Japan] http://www.3di.jp/en/
| Physics, scripting, more to come
|-
| [[User:Arthursv|arthursv]]
| Arthur Valadares
|
| NONE
| -8
| University of California, Irvine
| Unit testing, database plugins, bug fixes, general
|-
| [[User:DrScofield|drscofld]]
| Dirk Husemann
| Dr Scofield
|
| +1
| [http://xyzzyxyzzy.net/ xyzzyxyzzy.net]
| Reliability, networking protocols, inventory, assets, remote control, voice, and pretty much everything else :-)
|
|-
| [[User:Teravus|Teravus]]
| Daniel Olivares
| Teravus Ousley
|
| -5
| W3z
| Physics & Admin tools, A working sim.
|}

== Retired Core Developers ==

Core developers who have transcended our mortal plane, i.e. they are no longer directly engaged with the project. Thank you forever for your contributions!

*'''Only formerly voted in developers are listed here, please do not list yourself'''

{| cellspacing="0" cellpadding="2" border="1" class="sortable"
|-
! IRC Nick
! Name
! SL Avatar
! Other Grid
! Time Zone (UTC)
! Org
! Areas of Interest
|-
| [[User:Babblefrog|babblefrog]]
| Brian McBee
| Dogen Coldstream
| Babblefrog Ballistic (osgrid)
| -8
| Disorganized
|  
|-
| [[User:Danx0r|danx0r]]
| Dan Miller
| Albert Pascal
|
| -8
| squiggle.com
| PHEEZIKS; everything
|-
| Tleiades
|  
| Tleiades Hax
|
| +1
|  
| Grid servers/Database
|-
| [[User:Darok|Darok]]
|  
| Darok Kaminski
|
| +1
|  
| Physics engines (especially BulletX)
|-
| Gareth / Gwen
| Gareth Nelson
| Gareth Ellison
| Gareth Nelson (on everywhere but SL)
| BST (UTC+1)
| Litesim Ltd
| Grid servers, sim border crossing, avatar animations
|-
| [[User:Dalien|dalien]]
| Dalien Talbot
| Dalien Talbot
|
| +1
| Mostly TCP-based
| Small fixes; rev.eng./prototyping; nightlies; git-keeper
|-
| [[Alondria]]
|
| Alondria LeFay
| Alondria LeFay (OSGrid)
| -8
| Independent
| Implementation of LSL functions and other scripting tidbits.
|-
| [[User:SeanDague|sdague]]
| Sean Dague
| Neas Bade
|
| -5
| IBM
| Database, Linux, Testing, Misc
|-
| [[User:MingChen|MingChen]]
| Mike/Michael Ortman
| Ming Chen
|
| -6 (-5 in Summer)
| DeepThink Pty Ltd
| Estate/Parcel Support/Modules/Keeping things all neat and tidy.
|-
| [[User:Tedd|Tedd]]
| Tedd Hansen
| Tedd Maa
|
| +1
| Tedd Hansen
| Programming/Scripting/Architecture
|-
| [[User:Adjohn|adjohn]]
| Adam Johnson
| Zeuz Zenovka
| 
| +9
| [http://www.genkii.com Genkii]
| 
|-
| [[User:Joha1|joha1]]
| Johan Berntsson
| Joppi Brandenburg
| 
| +9
|  
| Performance, packet handling/libSL
|-
| jhurliman
| John Hurliman
| John Hurliman
|
|
|
|}

== Wiki Sysops ==

Along with the core developers, these people help manage the OpenSimulator wiki as well as make other contributions (see Areas of Interest).

{| cellspacing="0" cellpadding="2" border="1" class="sortable"
|-
! IRC Nick
! Name
! SL Avatar
! Other Grid
! Time Zone (UTC)
! Org
! Areas of Interest
|-
| [[User:Makopoppo|Makopoppo]]
| Makiko Nomura
| Mako Nozaki
| Everywhere
| +9 Tokyo, Japan
| As an individual developer
| Everything for improving usability and connectability - wiki/issue management, documentation, localization(Japanese), modifying the interface mainly of core modules
|-
| [[User:Fritigern|Fritigern]]
| S-E-C-R-E-T
| Fritigern Gothly
| SecondLife, OSGrid
| +1 GMT
|
| My interests are many, and extremely varied. One thing that i am very interested in, is seeing OpenSim grow, mature, and develop into something that really does rival SL/LL.
|}

== Additional Developers/Testers/Contributors ==

These people have contributed and/or are contributing bug reports, patches, testing, and all sorts of other goodies to the project. '''Newcomers please add yourself to bottom of the list!''' 

{| cellspacing="0" cellpadding="2" border="1" class="sortable"
|-
! IRC Nick
! Name
! SL Avatar
! Other Grid
! Time Zone (UTC)
! Org
! Areas of Interest
|-
| [[User:Jtclark48|jclark4]]
| Jay Clark
| Jay Clarke
|
| -5
| IBM
| Physics, Grid Host, AI, Scripting, Testing
|-
| [[User:AdamStevenson|BigFootAg]]
| Adam Stevenson
| Adamus Petrov
|
| -6
| Texas A&M University
| AI, Skynet, Evolving Systems, Biology
|-
| [[User:Jeff1564|Jeff1564]]
| Jeff
| Potter Taurog
| Potter Taurog
| -8
| http://myopengrid.com
| Building, Scripting, Testing
|-
| Rock_Vacirca
| Colin Withers
| Rock Vacirca
|  
| +1
| http://rock-vacirca.blogspot.com
| Testing, building, scripting, maintaining an opensim blog.
|-
| simsim
| caocao
|  
|  
| +9
|  
| Testing whole functions of OpenSim system,working with OpenSim-Engine,reporting on OpenSim
|-
| [[User:Vicero Lambert|Vicero Lambert]]
|  
|  
|
|  
|  
|  
|-
| [[User:Magi|Magi]]
| Andy Agnew
| Magi Merlin
|
| +10
| Spun Pty Ltd
| 3D Web Integration, Database stuff and playing with the odds and ends box.
|-
| [[User:ClarkZone|ClarkZone]]
| Troy Admin(@ClarkZone)
| Troy Childs
| Troy Admin (ClarkZone)
| -5
| Http://clarkzone.dyndns.org
| Tester and Grid Host
|-
| [[User:Aiaustin|aiaustin]]
| Ai Austin
| Ai Austin
| Ai Austin
| +0
| AIAI, Virtual University of Edinburgh http://www.aiai.ed.ac.uk/~ai/ http://vue.ed.ac.uk/openvue/
| Windows tests Content testing Use of multiple VWs
|-
| Marc Manders
| Marc Manders
|  
|  
| +6
| marcmanders@gmail.com
| Creative features
|-
| [[User:Balthazar|balthazar]]
| Trevor Brooks
| Balthazar Sin
|
| -5
| None
| Terrains, testing and some small coding tasks
|-
| [[User:Jimbo2120|jimbo2120]]
| Michael Osias
| Illuminous Beltran
|
| -5
| IBM
| Grid, AI, Skynet, coding and testing
|-
| ZeroPoint
|  
| Guilderoy Dench
|
| -5
|  
| Programming/Database
|-
| [[User:DerekTang|DerekTang]]
| Derek Tang
| Derek Timeless
| Derek Tang (ChineseGrid)
| +8
| http://ChineseGrid.net
| Running a public WINDOWS sim for testing, Docs, Helping Chinese users to enjoy OpenSim; building Chinese OpenSim communities. In construction...
|-
| [[User:TayB|TayB]]
| Earl Balai
| Taylor Dae
|
| -10
| WhynGrid
| Grid Host,Networking,Contributions & Testing.
|-
| [[User:JamieDav|JamieDav]]
| Jamie David
| Jamie David
|
| +7
| Forum
| Grid, Sim, Avitar, Functionality
|-
| [[User:Krtaylor|Krtaylor]]
| Kurt Taylor
| Kurt Stringer
|
| -6
| IBM
| Grid, Networking, Monitoring, Scripting, Inventory, Testing
|-
| [[User:Nink|Nink]]
| Peter Finn
| Nink Noonan
|
| -5
| IBM
| Disruptive Influence.
|-
| [[User:Bruce|Bruce]]
| Bruce Meerson
| Bruce Meerson
|
| +8
| HiPiHi
| Watching.
|-
| [[User:Darb|DarbD]]
| Brian B. Quinn
| Darb Dabney
| regions near Marin
| PST/SLT (-7 or -8)
| County of Marin, California http://blog.3dmap.me
| LiDAR-based sculpties, real-world terrain, pursuit of civic paraverses, virtual Emergency Operations Centers
|-
| [[User:Charlie Omega|CharlieO]]
| Dan
| Charlie Omega
|
|  
|  
| Mild coding/tweaking/simple feature adds, Stress testing/break stuff, Testing limits of existing code. Making sure [[LSL Status]] is up to date
|-
| oobscure
|  
| Opensource Obscure
|
| +1
| http://www.opensim.it
| Running a public Linux sim for testing, Docs, Helping italian users, Building opensim communities, Watching
|-
| pitman
| Mike Pitman
| Rez Tone
|
|  
| IBM
| Scientific visualization schemes, virt world product design, persistant workspaces, virt world based big biz
|-
| Shenlei
| Shenlei Winkler
| Shenlei Flasheart, Shenlei Winkler
|
|  
| Fashion Research Institute
| Product Design and Development, Apparel industry, and o yes, I wrote the book ;)
|-
| cmu
| Christopher Mumme
| Snook Destiny
|
| +1
| http://www.cmu-develop.de/ and research group "Collaboration Systems and CSCW" at Clausthal University of Technology
| Testing OpenSim, working with OpenSim-Engine, reporting on OpenSim
|-
| [[Silpol]]
| Andriy Tymchenko
| Andy Tir
|
| EET (+2/3)
| http://silpol.blogspot.com/ (also visible at Nokia)
| Highly uncoordinated mess with elements of palace games, under-table diplomacy, rebellion, coup d'état and mutiny. optionally pirate
|-
| [[User:Grumly|Grumly]]
|
| Forest Klaar
| Grumly TheBear
| GMT+1
| .NET MCAD Dev/Arch/Trainer http://www.devoteam.com
| Trying to get into OpenSim code for now. Particularly interrested in data persistence. blog (Hello, Avatar!): http://lslblog.free.fr
|-
| [[User:DaTwitch|DaTwitch]]
| James G. Stallings II
| Lazarus Longstaff
| Hiro Protagonist (OSGrid)
| -5
| House Husband
| OSGrid Region owner, OSGrid Operator, Forum Admin, sometime wiki editor
|-
| gryc
| Gryc Ueusp
| Gryc Uriza
| Gryc Uriza(OSGrid)
| -6
|
| PHP scripting, web interfaces, interconnectivity, cross-platformedness
|-
| [[User:Phrearch|Phrearch]]
| Jeroen van Veen
| Phrearch Miles
| Phrearch Miles(OSGrid)
| Amsterdam/Paris
|
| HWIOS, WiXTD, Wikidoc, Moo, User interfaces
|-
| [[User:Burnman|Burnman]]
| Allen
| Burnman Bedlam
|
| Boston, USA
|
| Testing, testing, and more testing! Getting familiar with the source, interested in all aspects of the project.
|-
| [[User:Krisbfunk|krisbfunk]]
| Kris Bulman
| Krisbfunk Vought
| Krisbfunk Nocturnal(OSGrid)
| PE, Canada (-4)
| Edactive Technologies NocturnalEye Productions UPEI
| Currently: Testing, bug reports, wiki updating, building on OSGrid
|-
| [[User:HashBox|HashBox]]
|  
| Sibariel Darkstone
| Sibariel Darkstone (OSGrid)
| New Zealand (+12)
|
| Testing, bug reports, and updating the wiki.
|-
| [[User:Kinoc|Kinoc]]
| Kino Coursey
| Daxxon Jaxxon
| Daxxon Kinoc (OSgrid)
| -6
| Daxtron Laboratories http://www.daxtron.com University of North Texas
| AI, Semantic web, Ontologies, Natural Laanguage Processing, Cyc, Bots, NPC
|-
| [[User:Trapuh|trapuh]]
| Pedro Ribeiro
| Vaiten Forder
|
| GMT
| University Student, Escola Superior de Educação de Viseu, Portugal
| Testing, eventual bug reports and wiki. Music, web/digital arts and php+sql.
|-
| [[User:SonicViz|SonicViz]]
| Paul Cohen
| Komuso Tokugawa
|
| +9
| Http://sonicviz.com
| Audio/Music, Interactive Music, Control Protocols, Interfaces, VisualFX, Procedural animation/Generative systems + testing and general dev
|-
| [[User:Mokele|mokele]]
| Scott Norman
| Mokelembembe Mokeev
|
| -8 (Southern California)
| Web Developer (PHP and MySQL)
| Interested in seeing running on PowerPC Macs which it is. So, when I can, I'll compile and test on PowerPC Mac (PowerBook G4) and submit reports and then update the wiki if need on installing on Mac. Also have a Ubuntu 7.10 server that I can do testing on too.
|-
| [[User:Devalnor|devalnor]]
| Devalnor
| M. Watkin
|
| +1 (Belgium)
|
| Small Patch code, bug reports, and updating the wiki.
|-
| [[User:Ezekiel|Ezekiel]]
| Ezekiel
| Ezekiel Zabelin
|
| +1
| http://www.yosims.com
| Concepts, business aspects of virtual worlds - web developer (PHP, MySQL, Javascript, LSL)
|-
| [[User:Buggmaster|Buggmaster]]
| Mike D
| Bug Master
| None
| -8
| http://www.adultmetaverse.com
| Grid, Data/Web PHP/PERL/MySQL
|-
| [[User:Nixnerd|nixnerd]]
|
| Dangerously Moody
| None
| GMT
| http://www.integratedtechnologies.eu
| Cross Platform Testing, Feedback, Bug Reporting
|-
| [[User:MoHax|mohax]]
| Mo Hax
| Mo Hax
|
| -5 Eastern
| IBM
| Testing, Feedback, Content Contributions, Bug Reporting, Documenting, Development
|-
| [[User:Webmage|webmage]]
| webmage
| Leyla Masala
| Web Mage
| +1
| IBM
| Testing, terrain
|-
| [[User:NLStitch|NLStitch]]
| Marijn Oosterveld
| Stitch Seale
| NYA
| GMT +1 Amsterdam
| Twingate Systems (http://www.twingate.nl) HanzeHogeschool Groningen, Netherlands
| Programming, Photography, AI
|-
| [[User:Ideia Boa|Ideia Boa]]
| Joao Lopes
| Ideia Boa
| Ideia Boa or Boa Ideia in some grids
| GTM+1 Stockholm/Sweden
| WorldSimTERRA - Virtual World that speaks Portuguese too http://www.worldsimterra.com
| Testing and more testing! Updating the original wiki and translating the OpenSim Wiki into Portuguese and reporting on OpenSim
|-
| [[User:Lulurun|lulurun]]
| liu
| 
| 
| +9
| 3Di Inc, Japan http://www.3di.jp
| Patches, openid, server performance, UGAI
|-
| [[User:Carlosroundel|Carlosrounde]]
| Carlosroundel
| Carlos Roundel
| 
| +1
| Cyberlandia Italy http://www.cyberlandia.net
| Grid, programmer, database, tester
|-
| [[User:Mikebert|Mikebert]]
| Michael Strunck
| Mikebert Miles
| Mikebert M34
| +1
| OpenSIM Wiki, Germany http://www.opensim.de
| German Wiki, Translater, Server Performance (Linux/Windows), Tester, Feedback, Bug Reporting, Server-Hosting
|-
| Taoki
| Mircea Kitsune / Taoki Vixen
| Mircea Kitsune (OSGrid) / Mircea Lobo (LL grid)
| 
| GMT +2
| 
| Usually testing and bug reporting but I also make smaller patches where I know what to do.
|-
| [[User:Patnad|Patnad]]
| Patrick
| Patnad Babii
| Patnad Babii (OSGrid)
| GMT -5
| RezzMe Technologies http://www.rezzme.com
| Bug testing and reporting, I code C# and have submitted a few patches
|-
| [[User:^DarkMan|^DarkMan]]
| Brian Adair
| Patrick Ouachita
| Brian Adair | Patrick Meta
| -6 CST
| RealMetaLife | B&H Networking
| Building, Scripting, Testing, etc.
|-
| [[User:Tlaukkan|Tommi Laukkanen]]
| Tommi Laukkanen
|  
| Tommi Laukkanen
| +2 GMT
| http://www.bubblecloud.org
| Protocols ([http://www.bubblecloud.org MXP]), NHibernate, Scrip API, Map Generation, Bug Fixes, Grid Hosting
|-
| [[User:Mystical|Mystical]]
| Kevin Tweedy
| Mystical Demina
| Mystical Demina
| -5
| Extreme Reality Grid http://www.XRGrid.com
| Windows Communication Framework, Windows Workflow,Entity Framework, MSSQL Enhancements,Commerce, Content,DotNetNuke based portal, development services
|-
| [[User:Godfrey|Godfrey]]
| Jeff Lee
| Warin Cascabel
|
| -5 (EST5EDT)
|
| Testing, minor bugfixes. Scripting, building, animating
|-
| Jamenai
| Christopher Händler
| Jamenai Luik
| Jamenai Luik
| +1
| Playneko Grid | XIMDEX Jamenai http://www.playneko.de http://www.ximdex.de
| Performance,Bug Reporting, Hosting, Grid-Owner,(PHP, MySQL, Perl, JavaScript, LSL)
|-
| [[User:Bikcmp|bikcmp]]
| Jason
| Jake1500 Allen
| Jason Helios (The Helios Grid)
| EST
| Blue Software
| Search, groups, land, and currency
|-
| [[User:Mark.malewski|Slipaway]]
| Mark Malewski
| Chris Rock
|
| -6 (-5 during summer - CDT)
| NexTECH / Joopla
| Web development & systems integration, terrain, WIKI documentation, tutorials, testing, bug reporting and feedback.
|-
| barakademi
| Steve Topp
| barakademi Barzane
| same avi on baragrid OSgrid Grid4us sciencesim
| utc+1 (CET) paris
| http://xbot-sl.barakademi.org http://vps.barakademi.org/oswi http://vps.barakademi.org/oswi/loginscreen.php
| Music LiveMusic MetaverseMusic Opensim Libomv Mono-2.4 Linux (suse,debian,ubuntu) Admin Scripting Automating Development Intergration php mysql bash nant +++
|-
| [[User:Robert d|robert_d]]
| Robert Dzikowski
|
| OSGrid: robert_d 13
| UTC+1
| [http://blog.rd-it.net http://blog.rd-it.net]
| Region Modules, Tutorials
|-
| john_
| John Moyer
| VAJohn GeekSquad or Matthew Kendal
|
| -5
| Best Buy/Geek Squad
| Tester
|-
| [[User:W!cKeD|_WicKeD]]
| Maik
| Maik Galaxy
| El Diablo
| +1 Germany
| Creatio Inc. / [http://www.OpenSimGerman.us/ OpenSimGerman.us]
| German Support, Translator, Building, Scripting, Testing, Hosting
|-
| [[User:Stevie Wakowski|Stevie Wakowksi]]
| Steve Roberts
| Stevie Wakowski
|
| +10 Australia
| IBM
| OpenSim builds, Linux, Modrex, bug reporting, evangalist for OpenSim in business applications.
|-
| Revolution
| Matthew
| Revolution Smythe
| Revolution Smythe
| -6 Central USA
| None
| Script engine, physics engine, general odd bugs, interesting and odd things
|-
| [[User:ClemsonGS|clemsonGS]]
| Brian Cass
| BC Sands
| Brian Cass (VWC Grid)
| -5
| http://www.cvwconline.org/
| Developing virtual worlds for use in higher education
|-
|
| AlexRa
|
|
|
| Independent
|
|-
|
|
| Robert Adams
|
|
| Looking Glass Viewer
|
|-
|
|
| Mikko Pallari
|
|
| Realxtend
|
|-
|
| StrawberryFride
| Chris Hart
|
|
| ReactionGrid
|
|-
| [[User:RemedyTomm|RemedyTomm]]
| Tom Grimshaw
| Tomm Remedy
| KGrid: Casper Warden OSGrid: Tomm Remedy
| UTC+0 (BST)
| Remedy Communications
| Texture pipeline, Groups, ObjectUpdates
|-
|
|
| Rob Smart
|
|
| IBM
|
|-
| MicheilMerlin
| Micheil Merlin
| Micheil Merlin
| Micheil Merlin
| -6
| Independent [http://www.iliveisl.com/ http://www.iliveisl.com/]
| Scripting, patches, and testcases
|-
| Pato Donald
| Pato Donald
| Morgam Biedermann
| Pato Donald
| -3
| Independent [http://www.matheusmk3.co.cc/ http://www.matheusmk3.co.cc/
| Groups, Scripts, Physics, Communication, Integration
|-
|
| Sera Marx
| Darkfire Soulstar
|
| +12
| Radiance promotions
| Grid Host, Commissioner. ~ Anyone looking for work related to the development of Opensimulator or Viewers please contact me. Any work undertaken for me will be returned to Opensimulator unless made strictly for my Grid
|-
|
| Doug Osborn
|
| Doug Osborn @ScienceSim
| PST/SLT (-7 or -8)
| CTO, F.R.I.
| Performance testing, scripting, high prim count builds, bots, and running in-world conferences.
|-
| [[User:Hallow Palmer|Hallow Palmer]]
| Markus
| Hallow Palmer
| 
| +1
| Grid4Us http://www.grid4us.net
| Server Performance (Windows), Tester, Feedback, Business concepts,Bug Reporting, Server-Hosting
|-
| [[User:LenaVanilli|LenaVanilli]]
| Lena Vanilli
| Lena Vanilli
| Lena Vanilli
| +1 Germany
| [http://www.hypergrid.org http://www.hypergrid.org]
| Grid-Management, Testing Testing Testing, Region Hosting
|-
| [[User:Aduffy70|aduffy70]]
| Aaron Duffy
| Aeran Stipe
| Aaron Duffy @ScienceSim
| -7
| USU
| Scientific visualization & education, Region modules, Heavily scripted regions
|-
|
| Erich Bremer
| Erich Bremer
|
Erich Bremer@OSGrid

| -5
| http://www.ebremer.com
| Semantic Web, Data Visualization
|-
| [[User:MarkIdcas|MarkIdcas]]
| Mark Bannon
| Mark IDCAS
| 3D Grid Association, AtMeeting and IDCAS.
| GMT
| [http://www.atmeeting.com http://www.atmeeting.com]
| Grid Management & systems integration. Scripting. WIKI documentation, tutorials, bug reporting and feedback.
|-
| [[User:Allquixotic|allquixotic]]
| Sean McNamara
| Tiyuk Quellmalz
| OSG: Tiyuk Quellmalz
| -5
| None
| Bugfixing; networking; performance; data integrity; LSL; auto-backup; null DB (eventual consistency).
|-
| [[User:Orenh|orenh]]
| Oren Hurvitz
|
| Oren Hurvitz (Kitely)
| +2
| Kitely
|
|-
| [[User:Randomhuman|randomhuman]]
| Kevin Houlihan
| random Radikal
| random human (OSGrid)
| WET/IST
| CrimsonCookie
| RemoteAdmin module; On-demand grids; web integration.
|}

== Retired Additional Developers ==

Additional developers who are no longer working on the OpenSim project. Thank you forever for your contributions!

{| cellspacing="0" cellpadding="2" border="1" class="sortable"
|-
! IRC Nick
! Name
! SL Avatar
! Other Grid
! Time Zone (UTC)
! Org
! Areas of Interest
|-
| [[User:Fly-man-|Fly-Man-]]
| Laurence
|
| OSGrid: Fly Man
| GMT +1
| Private Company
| Testing, OpenSimSearch, OpenSimProfile
|-
|}

[[Category:Development]] [[Category:Tech_Reference]] [[Category:Help]]

Automated Testing

2011-09-17T13:13:44Z

Randomhuman: /* Executing Tests */

__NOTOC__
{{Quicklinks}}

As OpenSim matures, we are extremely interested in adding more automated verification into the OpenSim source tree. Testing exists not only to prevent bugs from creeping in, but also to provide fair warning that the behavior of the system has changed, and tests may need updating.

In OpenSim today we use NUnit tests. Our conventions are:
# Tests should '''not''' exist inside runtime assemblies, as this makes nunit a production requirement
# Tests should be in .Tests.dll assemblies. For instance, the tests for OpenSim.Data.SQLite.dll should be in the OpenSim.Data.SQLite.Tests.dll assembly. This allows for easy removal of test assemblies in products.
# Tests should be as close to the code as possible, but not intermingled. So the tests for OpenSim/Data/SQLite should be in OpenSim/Data/SQLite/Tests/. Through the use of the '''Exclude''' keyword in prebuild.xml you can ensure that directory is part of OpenSim.Data.SQLite.Tests.dll and not OpenSim.Data.SQLite.dll. See exclude clarification in writing unit tests section.
# Tests testing a class should be grouped into a test class file called xxxTest.cs, where xxx is the name of the class that is being tested.
# Tests should be able to run safely in a production environment. That means that care must be taken not to damage data on the machine that it is being run.
# Tests should be deterministic in other words repeatable. Avoid randomness in tests. See good and bad testing practices below.

== Core Functionality Missing Unit Tests ==

This is a list of functionality which is not covered by unit tests and is identified as highly desireable test target:

# Database Modules (These are mysql tables)
## region ban
## land
## landaccesslist

== Good / Bad Test practices ==
Creating good tests is an art, not a science. Tests are useful by how many bugs they find or how many bugs they avoid. Things you should think about in creating good tests is:
* Throwing edge cases, like 0, "", or Null at parameters. This ensures that people functions are hardened against incomplete data. Many of our crashes come from the lack of this hardening showing up at just the wrong time.
* Use stateful testing to build up complex scenarios. This is more useful than just cursory get / set calls.
* Random tests are not a good idea. We need test results to be deterministic. In other words tests need to be repeatable. If you want to test for a range it is good idea to make separate tests for min and max values. Random values in fields can fail randomly. When something goes wrong for example in database schema the developer will not necessarily notice if the stored values are random. On the other hand its hard to troubleshoot randomly failing tests as you dont know which specific value caused the failure.
* Tests should be independent and should not rely on another test being run, passing or failing. An excerpt from [http://xunitpatterns.com/Principles%20of%20Test%20Automation.html#Independent%20Test xUnit Patterns]:
<blockquote>If tests are interdependent and (even worse) order dependent, we will be depriving ourselves of the useful feedback test failures provide. Interacting Tests [...] tend to fail in a group. The failure of a test that moved the [subject under test] into the state required by the dependent test will lead to the failure of the dependent test too. With both tests failing, how can we tell if it is because of a problem in code that both rely on in some way or is it a problem in code that only the first relies on. With both tests failing we can't tell. We are only talking about two tests here. Imagine how much worse this is with tens or hundreds of tests.</blockquote>
* Only one function of the subject under test should be tested in one test. When testing a database access object, for example, write separate tests for creating DB entries, updating them and removing them.
* Do not use the subject under test to set up the state for the test or to verify the result. Use a different method. When testing a database access object, for example, use raw SQL to insert the initial data into the DB, then run the method being tested. To verify if the operation was successful, use raw SQL again to verify the DB changed as expected.
* Use descriptive asserts whenever you can. All you have to do is add an extra , to the Assert() method and write a string that will show when that test fails. For example:
Assert.That(i,Is.EqualTo(5),"i is not equal to 5! in Example.Test1()");
* When a test fails due to a uncaught exception, such as NullReference, nUnit does not report where it happened, leaving debuggers clueless. A good practive is to write something on the start of every test in your test file. This way if an exception is raised, someone could read the last lines written and see at least in what test it failed. Luckily, this routine is already implemented in OpenSim.Tests.Common.TestHelper InMethod().

== Writing Tests ==

See [http://www.nunit.org/index.php?p=quickStart&r=2.4 NUnit Quick Start] for an introduction to unit testing with NUnit.

Writing a new unit test is pretty easy, and very helpful in increasing the stability of opensim by nailing down bugs. I'm going to present an example here of SQLite Asset testing to show how simple such a test case is to write. The actual in tree SQLite Asset tests are a little different because the code was factored out so that it was easily applied to any database driver, so don't be concerned with the fact that what you see here isn't in the tree.

Exclude clarification: Make sure your master project (not the test project) has an entry for files like the following so that the test code is not included in the master project dll:

<pre>
<Files>
<Match pattern="*.cs" recurse="true">
<Exclude name="Tests" pattern="Tests" />
</Match>
</Files>
</pre>

=== NUnit Conventions ===
An NUnit test suite:
* is a class with a default constructor (takes no arguments)
* has public methods that are tests
* uses annotations to determine what are tests
* runs it's tests in '''alphabetical order by method name'''

An NUnit test method:
* must be public
* must return void
* must take no arguments
* is successful if no exception or assert is thrown while running it

'''Once the tests are moved to NUnit 2.5+:'''

* a test class can be generic and can have one or more constructors with parameters. in this case, one or more [TestFixture(...)] attributes must be used to provide the types for the generic arguments and values for the constructors. This means it is possible to create a single test class which would, for example, provide tests for different database engines.
* each test method may have parameters supplied by attributes such as [TestCase(...)] or [Values]. The test will run automatically for various combinations of these attributes.
* NUnit no longer guarantees that the tests will be performed in any particular order.

The run order is important if you want to have early tests that setup some complicated state (like creating objects), and have later tests remove or update that state. For that reason I find it very helpful to name all test methods '''Txxx_somename''' where '''xxx''' is a number between 000 and 999. That guarantees no surprises in run order.

=== Fixture Setup / Teardown ===

See [[Example Test SQLite Assets]] for this code snipped in context.

<source lang="csharp">
[TestFixtureSetUp]
public void Init()
{
uuid1 = UUID.Random();
uuid2 = UUID.Random();
uuid3 = UUID.Random();
name1 = "asset one";
name2 = "asset two";
name3 = "asset three";

asset1 = new byte[100];
asset1.Initialize();
file = Path.GetTempFileName() + ".db";
connect = "URI=file:" + file + ",version=3";
db = new SQLiteAssetData();
db.Initialise(connect);
}

[TestFixtureTearDown]
public void Cleanup()
{
db.Dispose();
System.IO.File.Delete(file);
}
</source>

In the case of testing something like the database layer, we have to actually attempt to store / retrieve things from a database. Following from rule #4 of good tests, we want to make sure not to touch the production databases to run our tests, so during startup we generate a temporary file name which is guaranteed not to be an existing file on the system, and use that as our database file name. By running db.Initialize() the OpenSim migration code will correctly populate that database with the latest schema.

Once we are done with the tests we want to make sure we aren't leaving garbage temp files on the user's system. So we remove that file we created.

During setup we also create a set of state variables, such as 3 uuids, 3 strings, and a data block. You could have always just stuck these inline, but variables are there for a reason, so use them.

=== Test Setup / Teardown ===

What's missing in [[Example Test SQLite Assets]] are individual test Setup and Teardown methods. These methods allow each test to be completely self sufficient without the code duplication needed to set up the test environment at the start of each test.

Let's assume the <code>SQLiteAssetData</code> class provided a <code>FetchAsset()</code> method and a <code>UpdateAsset()</code> method. Since every test should be independent of any other test, and <code>FetchAsset()</code> and <code>UpdateAsset()</code> should be tested in separate tests, that means each test would need to create its own entries in the asset table in order to succeed. You may have something like this (see [[Example Test SQLite Assets#This Test is Flawed|Example Test SQLite Assets]] for an explanation of <code>sqldb.executeSQL()</code>):

<source lang="csharp">[Test]
public void T101_TestFetchAsset()
{
AssetBase a1 = new AssetBase(...);
sqldb.executeSQL("INSERT INTO assets VALUES({0}, ...)", a1.uuid, ...);

AssetBase a1_actual = db.FetchAsset(a1.uuid);

Assert.Equal(a1_actual.uuid, a1.uuid);
Assert.Equal(a1_actual.Name, a1.Name);
// etc
}

[Test]
public void T103_TestUpdateAsset()
{
AssetBase a1 = new AssetBase(...);
sqldb.executeSQL("INSERT INTO assets VALUES({0}, ...)", a1.uuid, ...);

a1.Name = "new name";

db.UpdateAsset(a1.uuid, a1);

AssetBase a1_actual = sqldb.executeSQL("SELECT * FROM assets WHERE uuid = {0}", a1.uuid);

Assert.Equal(a1_actual.uuid, a1.uuid);
Assert.Equal(a1_actual.Name, a1.Name);
// etc
}
</source>

You will note that both tests have the same code at the top in which they create an entry in the assets table. This duplicate code can be factored out into a Setup method, which is called before every test is executed (assume <code>a1</code> is a class attribute):

<source lang="csharp">
[SetUp]
public void SetUp()
{
a1 = new AssetBase(...);
sqldb.executeSQL("INSERT INTO assets VALUES({0}, ...)", a1.uuid, ...);
}

[TearDown]
public void TearDown()
{
// clean up after ourselves so the next test has a clean DB to start with
sqldb.executeSQL("DELETE FROM assets");
}

[Test]
public void T101_TestFetchAsset()
{
AssetBase a1_actual = db.FetchAsset(a1.uuid);

Assert.Equal(a1_actual.uuid, a1.uuid);
Assert.Equal(a1_actual.Name, a1.Name);
// etc
}

[Test]
public void T103_TestUpdateAsset()
{
a1.Name = "new name";

db.UpdateAsset(a1.uuid, a1);

AssetBase a1_actual = sqldb.executeSQL("SELECT * FROM assets WHERE uuid = {0}", a1.uuid);

Assert.Equal(a1_actual.uuid, a1.uuid);
Assert.Equal(a1_actual.Name, a1.Name);
// etc
}
</source>

Also note the <code>TearDown()</code> method; it is called after each test has run, regardless whether the test passed or failed. It deletes all the entries in the <code>assets</code> table so that there is no leftover data in the database to interfere with the next test.

==== Multiple Setup Methods ====

Not all setup and teardown must happen in methods declared [SetUp] and [TearDown]. It may be useful to provide methods which perform part of the setup and to call them from whichever test may need it:

<source lang="csharp">
private AssetBase InsertAssetWithRandomData(UUID assetUuid)
{
AssetBase asset = new AssetBase(assetUuid);
asset.Name = somethingRandom();
asset.Data = somethingRandom();

sqldb.executeSQL("INSERT INTO assets VALUES({0}, ...)", asset.uuid, ...);

return asset;
}

[Test]
public void T201_TestNeedsTwoAssets()
{
AssetBase a1 = InsertAssetWithRandomData(uuid1);
AssetBase a2 = InsertAssetWithRandomData(uuid2);
// etc
}

[Test]
public void T203_TestNeedsFiveAssets()
{
AssetBase a1 = InsertAssetWithRandomData(uuid1);
AssetBase a2 = InsertAssetWithRandomData(uuid2);
AssetBase a3 = InsertAssetWithRandomData(uuid3);
AssetBase a4 = InsertAssetWithRandomData(uuid4);
AssetBase a5 = InsertAssetWithRandomData(uuid5);
// etc
}
</source>

Notice that <code>InsertAssetWithRandomData</code> is <code>private</code> as it's only called from within the class.

=== Asserts ===
You will see scattered through the code '''Assert.That(...)'''. These will throw an exception if the condition is not valid. This format of assertions is called the [http://www.nunit.org/index.php?p=constraintModel&r=2.4 Constraint Model] in NUnit, and provides a large number of tests with the flavor of:
* Assert.That(foo, Is.Null)
* Assert.That(foo, Is.Not.Null)
* Assert.That(foo, Is.True)
* Assert.That(foo, Is.EqualTo(bar))
* Assert.That(foo, Text.Matches( "*bar*" ))

Of note, Is.EqualTo uses the Equals function of foo, so this can only be used on objects that are IComparable. Most of the OpenSim base objects are not, so you'll have to compare fields manually in tests.

For the complete set of conditions you can use see [http://www.nunit.org/index.php?p=constraintModel&r=2.4 the Constraint Model NUnit documentation]. While there is another syntax for tests, the Constraint Model is preferred as it is far more human readable.

=== Simple Negative Tests ===

See [[Example Test SQLite Assets]] for this code snipped in context.

<source lang="csharp">[Test]
public void T001_LoadEmpty()
{
Assert.That(db.ExistsAsset(uuid1), Is.False);
Assert.That(db.ExistsAsset(uuid2), Is.False);
Assert.That(db.ExistsAsset(uuid3), Is.False);
}
</source>

Test T001 is an example of a simple negative test. We assume a new database will not have any of those assets in them. While the value of this test may look low, it does provide a baseline in ensuring that the database connection is there, that these return false correctly, and that no other exception is thrown. Negative tests are a good way to force bounds conditions and ensure that not only does it ''return what you expect'' it also ''doesn't return what you don't expect''. Thought of another way, it ensures your code is somewhat defensive in nature, not coughing on bad or unexpected data.

=== Simple Positive Tests ===

See [[Example Test SQLite Assets]] for this code snipped in context.

<source lang="csharp">
[Test]
public void T010_StoreSimpleAsset()
{
AssetBase a1 = new AssetBase(uuid1, name1);
AssetBase a2 = new AssetBase(uuid2, name2);
AssetBase a3 = new AssetBase(uuid3, name3);
a1.Data = asset1;
a2.Data = asset1;
a3.Data = asset1;

db.CreateAsset(a1);
db.CreateAsset(a2);
db.CreateAsset(a3);

AssetBase a1a = db.FetchAsset(uuid1);
Assert.That(a1a.ID, Is.EqualTo(uuid1));
Assert.That(a1a.Name, Is.EqualTo(name1));

AssetBase a2a = db.FetchAsset(uuid2);
Assert.That(a2a.ID, Is.EqualTo(uuid2));
Assert.That(a2a.Name, Is.EqualTo(name2));

AssetBase a3a = db.FetchAsset(uuid3);
Assert.That(a3a.ID, Is.EqualTo(uuid3));
Assert.That(a3a.Name, Is.EqualTo(name3));
}
</source>
T010 is an example of a simple positive test. In it we create and store 3 assets (ensuring no exceptions), then load those 3 assets back from the database and ensure the fields are correct. Because AssetBase is not IComparible we just check the ID and Name fields with equals tests. If any of the Asserts fail, the whole test fails.

=== Stateful Tests ===

See [[Example Test SQLite Assets]] for this code snipped in context.

<source lang="csharp">
[Test]
public void T011_ExistsSimpleAsset()
{
Assert.That(db.ExistsAsset(uuid1), Is.True);
Assert.That(db.ExistsAsset(uuid2), Is.True);
Assert.That(db.ExistsAsset(uuid3), Is.True);
}
</source>

T011 is an example of a stateful test, because it requires the state created by T010 (i.e. the creation of those 3 objects). In order to test any kind of complicated scenario you will find that you need to use stateful tests to build up various amounts of state (testing along the way), then manipulating and possibly tearing it down. Without doing this you can't do truly deep testing of function in any complex environment. This example isn't very stateful (I tried to pick an easy example), but it should give you some ideas.

=== Speculative Tests ===
Speculative tests are tests that might or might not apply in a given situation. MySQL testing in the OpenSim tree is done by speculative testing, the tests will only run if there is a properly configured database, otherwise they will not be run. If you execute '''Assert.Ignore()''' in a '''Test''' the test will end and be ignored. If you run '''Assert.Ignore()''' in the '''TestFixtureSetup''' all tests in the test fixture will be skipped and ignored.

Speculative testing lets you create tests that require certain preconditions to be met which you can't guarantee on all platforms/configuration, and are an important part of deep testing.

== Adding Tests to the Tree ==
As we said previously all tests for assembly OpenSim.Foo (in directory OpenSim/Foo) should:
* be in assembly OpenSim.Foo.Tests.dll
* not be in the OpenSim.Foo.dll assembly
* be in OpenSim/Foo/Tests directory

Also, if you have created a new test assembly you must add references
to it in ''.nant/local.include'', both to the
* ''test'' target, and the
* ''test-xml'' target
to ensure that the assembly is added to the automated panda runs as
well as the nant ''test'' target.

== Executing Tests ==

=== Database Layer Tests ===
The connection strings for the database dependent unit tests can be configured in the file OpenSim/Data/Tests/Resources/TestDataConnections.ini. This file is an embedded resource, so the project must be recompiled before changes to it will take effect. If the connection strings are not configured then the relevant tests will just be ignored.

=== Panda ===
On every commit to opensim all the tests are run on the [http://panda.opensimulator.org/ panda build server on opensimulator.org]. The process takes about 5 minutes to build, test, and report the results back out on #opensim-dev via the osmantis bot.

=== Nant ===
You can manually run all the tests for OpenSim on your system by running '''nant test''' as a nant target. This will run all the tests that are in the tree, though some speculative tests might be ignored if your platform does not have the right features or configuration to run these tests.

=== NUnit Console ===
If you only want to run tests for one assembly you can do that using the NUnit Console. On Linux just run '''nunit-console2 OpenSim.Foo.Tests.dll''' and it will run only the tests for OpenSim.Foo.Tests.dll. If you are only making changes to 1 dll and just want a quick sanity check, this is the fastest way to do that.

=== Debugging Tests ===
There is a special page dedicated to this. See [[Debugging Unit Tests]].

== Learning More ==
You should definitely read the documentation at the [http://www.nunit.org/index.php?p=documentation NUnit homepage] if you want to know more about testing. It's a very good reference for all the APIs in NUnit that you can use for creating tests.

== Code Coverage ==

A prototype has been included using monocov, which has a profile built-in in mono. Instructions for using monocov can be found on the Mono homepage, in [http://www.mono-project.com/Code_Coverage Code Coverage] section. Unfortunately nunit2 and nant do not support code coverage with monocov (only some other proprietary code coverages), so there is no <monocov> tag. The solution was to implement it using many nunit-console and on <exec> tags.

ATTENTION: Code coverage only works with mono 1.2.x , any other version will most likely not work. Code coverage development is being put on hold for now until it supports newer mono versions.

=== Running ===

Download [http://primates.ximian.com/~lupus/monocov-0.2.tar.gz monocov] and [http://prdownloads.sourceforge.net/nunit/NUnit-2.4.8-net-2.0.zip?download nunit-console] if your nunit-console does not work. To test if it works (my Ubuntu's Hardy version did not), just run one of the tests with nunit-console.

Install monocov (./configure, ./make install, there could be some minor conflicts, I had to add to the compiling line -I/usr/include/mono-1.0/) and make sure the working nunit-console.exe is in /usr/lib/nunit/nunit-console.exe. Now just run nant test-cov and it will generate .cov files and HTML directories in the cov directory. The .cov files can be seen by running monocov on them, and have the same information as the HTML directories.

== Testing Todo ==

=== Coverage ===

A prototype has been done and documented. Now we must keep a look if monocov will evolve to support newer mono versions.

[[Category:Development]]
[[Category:Testing]]

== Links to More Information on Unit Testing ==

* [http://www.nunit.org/index.php?p=quickStart&r=2.4 NUnit Quick Start]
* [http://xunitpatterns.com/ xUnit Patterns book homepage], with lots of information on good practices, patterns, code smells, etc.
* There is a lot of information on unit testing at the [http://c2.com/cgi/wiki?search=unittest Cunningham & Cunningham, Inc wiki at c2.com]

RemoteAdmin

2010-08-14T19:00:09Z

Randomhuman: /* RemoteAdmin Commands */

__NOTOC__
{{Template:Quicklinks}}
 

<div style="background-color:#ffa0a0; padding:15px">
Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.
</div>

== How to Setup the Remote Admin ==

=== Setup OpenSim ===

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file
Port should be set to a nonzero value to have the remote admin on a different port

[RemoteAdmin]
enabled = true
access_password = secret
port = 0

=== Example in C# .NET ===

This example needs the Nwc.XmlRpc library, located in your OpenSim bin folder.

<pre>
public void CreateUser(Uri url, string adminPassword, string firstName, string lastName, string password, string email, int regionX, int regionY)
{
var address = Dns.GetHostEntry(url.DnsSafeHost).AddressList[0];
var ht = new Hashtable();
ht["password"] = adminPassword;
ht["user_firstname"] = firstName;
ht["user_lastname"] = lastName;
ht["user_password"] = password;
ht["user_email"] = email;
ht["start_region_x"] = regionX;
ht["start_region_y"] = regionY;
var parameters = new List<Hashtable> { ht };
var rpc = new XmlRpcRequest("admin_create_user", parameters);
rpc.Invoke(url.ToString());
}

[Test]
public void NativeUserRegistrationTest()
{
CreateUser(new Uri("http://yourgrid.com:9000/"), "secret", "Test2", "user2", "apassword", "email@address.com", 0, 0);
}
</pre>

=== Another Example in C# .NET ===

//Author Ottalese complements of yoursimspot.com

//This example needs the CookComputing.XmlRpc library, this can be downloaded from http://www.xml-rpc.net/.

//Recently updated code I originally posted, this can be secured using SSL.

using System; using System.Data; using System.Configuration; using System.Collections; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using System.Web.UI.HtmlControls; using CookComputing.XmlRpc; [XmlRpcUrl("http://ServerIpAddress:9000/")] public interface RemoteOpensim : IXmlRpcProxy { //Create new user [XmlRpcMethod("admin_create_user")] XmlRpcStruct admin_create_user(XmlRpcStruct Parameters); } public partial class _Default : System.Web.UI.Page { protected void Page_Load(object sender, EventArgs e) { } protected void SubmitButton_Click(object sender, EventArgs e) { XmlRpcStruct NewUser = new XmlRpcStruct(); //Will contain return results. 

XmlRpcStruct Parameters = new XmlRpcStruct();//Parameters passed. 

try { RemoteOpensim Admin = XmlRpcProxyGen.Create<RemoteOpensim>(); Parameters.Add("password", "RemotePassword"); //Password you set in the .ini file for the RemoteAdmin Parameters.Add("user_firstname", SomeStringWithFirstName); Parameters.Add("user_lastname", SomeStringWithLastName); Parameters.Add("user_password", SomePassword); Parameters.Add("start_region_x", 0); Parameters.Add("start_region_y", 0); 

 NewUser = Admin.admin_create_user(Parameters); 

foreach (DictionaryEntry ReturnResults in NewUser) { Response.Write(ReturnResults.Key.ToString() + " : " + d.Value.ToString());//Returns if the user was added or not } 

} catch (Exception ex) { Response.Write(ex.Message); } } } 

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# instantiate server object
gridServer = xmlrpclib.Server(gridServerURL)

# invoke admin_alert: requires password and message
gridServer.admin_broadcast({’password’: ’secret’, ‘message’: ‘the answer is 42′})

=== RemoteAdmin executable for Windows ===

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);
?>
</source>

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
class RemotePC {

function __construct() {
$this->serveruri = "http://myhost";
$this->serverport ="9000";
$this->password ="foobar";
}

function call($command,$parameters) {
$parameters['password'] = $this->password;
$request = xmlrpc_encode_request($command, $parameters);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);
$result = curl_exec($ch);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

=== Example in Perl ===

Because the OpenSim internal web server just accepts HTTP/1.0 requests, it's worth to give a perl example. It's not a daily thing to do HTTP/1.0 within the LWP environment. You can get the '''[[Users:Thomax:perl-xmlrpc | Perl example here]]'''.

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_id (optional), estate_owner_first (optional),
estate_owner_last (optional), estate_owner_uuid (optional), listen_ip, listen_port (integer), external_address, region_x (integer), region_y (integer), persist (optional), estate_name (an estate owner must be specified if the estate does not already exist)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_close_region | admin_close_region]]</td>
<td></td>
<td>Close a region without deleting it.</td>
<td>region_name, region_id (optional)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_modify_region | admin_modify_region]]</td>
<td></td>
<td>Modify a region</td>
<td>region_name, region_id (optional), public, enable_voice</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>shutdown (optional, expects 'delayed'), milliseconds</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user_email| admin_create_user_email]]</td>
<td></td>
<td>Create a new user (alias for admin_create_user)</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname, user_lastname, user_password, start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_oar| admin_save_oar]]</td>
<td></td>
<td>Saved an OAR file of a regions contents</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_list| admin_acl_list]]</td>
<td></td>
<td>Retrieve a list of users who can access the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_clear| admin_acl_clear]]</td>
<td></td>
<td>Clear the access list for the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_add| admin_acl_add]]</td>
<td></td>
<td>Add a list of users to the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_remove| admin_acl_remove]]</td>
<td></td>
<td>Remove a list of users from the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2010-07-29T17:20:39Z

Randomhuman: /* RemoteAdmin Commands */

__NOTOC__
{{Template:Quicklinks}}
 

<div style="background-color:#ffa0a0; padding:15px">
Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.
</div>

== How to Setup the Remote Admin ==

=== Setup OpenSim ===

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file
Port should be set to a nonzero value to have the remote admin on a different port

[RemoteAdmin]
enabled = true
access_password = secret
port = 0

=== Example in C# .NET ===

This example needs the Nwc.XmlRpc library, located in your OpenSim bin folder.

<pre>
public void CreateUser(Uri url, string adminPassword, string firstName, string lastName, string password, string email, int regionX, int regionY)
{
var address = Dns.GetHostEntry(url.DnsSafeHost).AddressList[0];
var ht = new Hashtable();
ht["password"] = adminPassword;
ht["user_firstname"] = firstName;
ht["user_lastname"] = lastName;
ht["user_password"] = password;
ht["user_email"] = email;
ht["start_region_x"] = regionX;
ht["start_region_y"] = regionY;
var parameters = new List<Hashtable> { ht };
var rpc = new XmlRpcRequest("admin_create_user", parameters);
rpc.Invoke(url.ToString());
}

[Test]
public void NativeUserRegistrationTest()
{
CreateUser(new Uri("http://yourgrid.com:9000/"), "secret", "Test2", "user2", "apassword", "email@address.com", 0, 0);
}
</pre>

=== Another Example in C# .NET ===

//Author Ottalese complements of yoursimspot.com

//This example needs the CookComputing.XmlRpc library, this can be downloaded from http://www.xml-rpc.net/.

//Recently updated code I originally posted, this can be secured using SSL.

using System; using System.Data; using System.Configuration; using System.Collections; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using System.Web.UI.HtmlControls; using CookComputing.XmlRpc; [XmlRpcUrl("http://ServerIpAddress:9000/")] public interface RemoteOpensim : IXmlRpcProxy { //Create new user [XmlRpcMethod("admin_create_user")] XmlRpcStruct admin_create_user(XmlRpcStruct Parameters); } public partial class _Default : System.Web.UI.Page { protected void Page_Load(object sender, EventArgs e) { } protected void SubmitButton_Click(object sender, EventArgs e) { XmlRpcStruct NewUser = new XmlRpcStruct(); //Will contain return results. 

XmlRpcStruct Parameters = new XmlRpcStruct();//Parameters passed. 

try { RemoteOpensim Admin = XmlRpcProxyGen.Create<RemoteOpensim>(); Parameters.Add("password", "RemotePassword"); //Password you set in the .ini file for the RemoteAdmin Parameters.Add("user_firstname", SomeStringWithFirstName); Parameters.Add("user_lastname", SomeStringWithLastName); Parameters.Add("user_password", SomePassword); Parameters.Add("start_region_x", 0); Parameters.Add("start_region_y", 0); 

 NewUser = Admin.admin_create_user(Parameters); 

foreach (DictionaryEntry ReturnResults in NewUser) { Response.Write(ReturnResults.Key.ToString() + " : " + d.Value.ToString());//Returns if the user was added or not } 

} catch (Exception ex) { Response.Write(ex.Message); } } } 

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# instantiate server object
gridServer = xmlrpclib.Server(gridServerURL)

# invoke admin_alert: requires password and message
gridServer.admin_broadcast({’password’: ’secret’, ‘message’: ‘the answer is 42′})

=== RemoteAdmin executable for Windows ===

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);
?>
</source>

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
class RemotePC {

function __construct() {
$this->serveruri = "http://myhost";
$this->serverport ="9000";
$this->password ="foobar";
}

function call($command,$parameters) {
$parameters['password'] = $this->password;
$request = xmlrpc_encode_request($command, $parameters);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);
$result = curl_exec($ch);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

=== Example in Perl ===

Because the OpenSim internal web server just accepts HTTP/1.0 requests, it's worth to give a perl example. It's not a daily thing to do HTTP/1.0 within the LWP environment. You can get the '''[[Users:Thomax:perl-xmlrpc | Perl example here]]'''.

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_id (optional), region_master_first,
region_master_last, region_master_uuid (optional), region_master_password, listen_ip, listen_port (integer), external_address, region_x (integer), region_y (integer), persist (optional)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_close_region | admin_close_region]]</td>
<td></td>
<td>Close a region without deleting it.</td>
<td>region_name, region_id (optional)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_modify_region | admin_modify_region]]</td>
<td></td>
<td>Modify a region</td>
<td>region_name, region_id (optional), public, enable_voice</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>shutdown (optional, expects 'delayed'), milliseconds</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user_email| admin_create_user_email]]</td>
<td></td>
<td>Create a new user (alias for admin_create_user)</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname, user_lastname, user_password, start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_oar| admin_save_oar]]</td>
<td></td>
<td>Saved an OAR file of a regions contents</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_list| admin_acl_list]]</td>
<td></td>
<td>Retrieve a list of users who can access the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_clear| admin_acl_clear]]</td>
<td></td>
<td>Clear the access list for the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_add| admin_acl_add]]</td>
<td></td>
<td>Add a list of users to the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_remove| admin_acl_remove]]</td>
<td></td>
<td>Remove a list of users from the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2009-07-07T01:21:01Z

Randomhuman: /* RemoteAdmin Commands */

__NOTOC__
{{Template:Quicklinks}}
 

<div style="background-color:#ffa0a0; padding:15px">
Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.
</div>

== How to Setup the Remote Admin ==

=== Setup OpenSim ===

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# instantiate server object
gridServer = xmlrpclib.Server(gridServerURL)

# invoke admin_alert: requires password and message
gridServer.admin_broadcast({’password’: ’secret’, ‘message’: ‘the answer is 42′})

=== RemoteAdmin executable for Windows ===

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);
?>
</source>

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
class RemotePC {

function __construct() {
$this->serveruri = "http://myhost";
$this->serverport ="9000";
$this->password ="foobar";
}

function call($command,$parameters) {
$parameters['password'] = $this->password;
$request = xmlrpc_encode_request($command, $parameters);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);
$result = curl_exec($ch);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

=== Example in Perl ===

Because the OpenSim internal web server just accepts HTTP/1.0 requests, it's worth to give a perl example. It's not a daily thing to do HTTP/1.0 within the LWP environment. You can get the '''[[Users:Thomax:perl-xmlrpc | Perl example here]]'''.

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_id (optional), region_master_first,
region_master_last, region_master_uuid (optional), region_master_password, listen_ip, listen_port (integer), external_address, region_x (integer), region_y (integer), persist (optional)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_modify_region | admin_modify_region]]</td>
<td></td>
<td>Modify a region</td>
<td>region_name, region_id (optional), public, enable_voice</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>shutdown (optional, expects 'delayed'), milliseconds</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user_email| admin_create_user_email]]</td>
<td></td>
<td>Create a new user (alias for admin_create_user)</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname, user_lastname, user_password, start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_oar| admin_save_oar]]</td>
<td></td>
<td>Saved an OAR file of a regions contents</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_list| admin_acl_list]]</td>
<td></td>
<td>Retrieve a list of users who can access the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_clear| admin_acl_clear]]</td>
<td></td>
<td>Clear the access list for the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_add| admin_acl_add]]</td>
<td></td>
<td>Add a list of users to the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_remove| admin_acl_remove]]</td>
<td></td>
<td>Remove a list of users from the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2009-07-07T00:04:28Z

Randomhuman: /* RemoteAdmin Commands */

__NOTOC__
{{Template:Quicklinks}}
 

<div style="background-color:#ffa0a0; padding:15px">
Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.
</div>

== How to Setup the Remote Admin ==

=== Setup OpenSim ===

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# instantiate server object
gridServer = xmlrpclib.Server(gridServerURL)

# invoke admin_alert: requires password and message
gridServer.admin_broadcast({’password’: ’secret’, ‘message’: ‘the answer is 42′})

=== RemoteAdmin executable for Windows ===

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);
?>
</source>

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
class RemotePC {

function __construct() {
$this->serveruri = "http://myhost";
$this->serverport ="9000";
$this->password ="foobar";
}

function call($command,$parameters) {
$parameters['password'] = $this->password;
$request = xmlrpc_encode_request($command, $parameters);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);
$result = curl_exec($ch);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

=== Example in Perl ===

Because the OpenSim internal web server just accepts HTTP/1.0 requests, it's worth to give a perl example. It's not a daily thing to do HTTP/1.0 within the LWP environment. You can get the '''[[Users:Thomax:perl-xmlrpc | Perl example here]]'''.

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_id (optional), region_master_first,
region_master_last, region_master_uuid (optional), region_master_password, listen_ip, listen_port (integer), external_address, region_x (integer), region_y (integer), persist (optional)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_modify_region | admin_modify_region]]</td>
<td></td>
<td>Modify a region</td>
<td>region_name, region_id (optional), public, enable_voice</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown| admin_shutdown]]</td>
<td></td>
<td>Shutdown server</td>
<td>shutdown (optional, expects 'delayed'), milliseconds</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user_email| admin_create_user_email]]</td>
<td></td>
<td>Create a new user (alias for admin_create_user)</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname, user_lastname, user_password, start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_oar| admin_save_oar]]</td>
<td></td>
<td>Saved an OAR file of a regions contents</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_list| admin_acl_list]]</td>
<td></td>
<td>Retrieve a list of users who can access the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_clear| admin_acl_clear]]</td>
<td></td>
<td>Clear the access list for the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_add| admin_acl_add]]</td>
<td></td>
<td>Add a list of users to the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_remove| admin_acl_remove]]</td>
<td></td>
<td>Remove a list of users from the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2009-07-06T23:38:31Z

Randomhuman: /* RemoteAdmin Commands */

__NOTOC__
{{Template:Quicklinks}}
 

<div style="background-color:#ffa0a0; padding:15px">
Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.
</div>

== How to Setup the Remote Admin ==

=== Setup OpenSim ===

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# instantiate server object
gridServer = xmlrpclib.Server(gridServerURL)

# invoke admin_alert: requires password and message
gridServer.admin_broadcast({’password’: ’secret’, ‘message’: ‘the answer is 42′})

=== RemoteAdmin executable for Windows ===

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);
?>
</source>

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
class RemotePC {

function __construct() {
$this->serveruri = "http://myhost";
$this->serverport ="9000";
$this->password ="foobar";
}

function call($command,$parameters) {
$parameters['password'] = $this->password;
$request = xmlrpc_encode_request($command, $parameters);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);
$result = curl_exec($ch);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

=== Example in Perl ===

Because the OpenSim internal web server just accepts HTTP/1.0 requests, it's worth to give a perl example. It's not a daily thing to do HTTP/1.0 within the LWP environment. You can get the '''[[Users:Thomax:perl-xmlrpc | Perl example here]]'''.

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_master_first,
region_master_last, region_master_password, listen_ip, listen_port (integer), external_address, region_x (integer), region_y (integer)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_modify_region | admin_modify_region]]</td>
<td></td>
<td>Modify a region</td>
<td>region_name, region_id (optional), public, enable_voice</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown| admin_shutdown]]</td>
<td></td>
<td>Shutdown server</td>
<td>shutdown (optional, expects 'delayed'), milliseconds</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user_email| admin_create_user_email]]</td>
<td></td>
<td>Create a new user (alias for admin_create_user)</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname, user_lastname, user_password, start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_oar| admin_save_oar]]</td>
<td></td>
<td>Saved an OAR file of a regions contents</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_list| admin_acl_list]]</td>
<td></td>
<td>Retrieve a list of users who can access the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_clear| admin_acl_clear]]</td>
<td></td>
<td>Clear the access list for the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_add| admin_acl_add]]</td>
<td></td>
<td>Add a list of users to the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_remove| admin_acl_remove]]</td>
<td></td>
<td>Remove a list of users from the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2009-07-06T22:33:17Z

Randomhuman: /* RemoteAdmin Commands */

__NOTOC__
{{Template:Quicklinks}}
 

<div style="background-color:#ffa0a0; padding:15px">
Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.
</div>

== How to Setup the Remote Admin ==

=== Setup OpenSim ===

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# instantiate server object
gridServer = xmlrpclib.Server(gridServerURL)

# invoke admin_alert: requires password and message
gridServer.admin_broadcast({’password’: ’secret’, ‘message’: ‘the answer is 42′})

=== RemoteAdmin executable for Windows ===

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);
?>
</source>

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
class RemotePC {

function __construct() {
$this->serveruri = "http://myhost";
$this->serverport ="9000";
$this->password ="foobar";
}

function call($command,$parameters) {
$parameters['password'] = $this->password;
$request = xmlrpc_encode_request($command, $parameters);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);
$result = curl_exec($ch);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

=== Example in Perl ===

Because the OpenSim internal web server just accepts HTTP/1.0 requests, it's worth to give a perl example. It's not a daily thing to do HTTP/1.0 within the LWP environment. You can get the '''[[Users:Thomax:perl-xmlrpc | Perl example here]]'''.

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_master_first,
region_master_last, region_master_password, listen_ip, external_address</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_modify_region | admin_modify_region]]</td>
<td></td>
<td>Modify a region</td>
<td>region_name, region_id (optional), public, enable_voice</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown| admin_shutdown]]</td>
<td></td>
<td>Shutdown server</td>
<td>shutdown (optional, expects 'delayed'), milliseconds</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user_email| admin_create_user_email]]</td>
<td></td>
<td>Create a new user (alias for admin_create_user)</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname, user_lastname, user_password, start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_oar| admin_save_oar]]</td>
<td></td>
<td>Saved an OAR file of a regions contents</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_list| admin_acl_list]]</td>
<td></td>
<td>Retrieve a list of users who can access the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_clear| admin_acl_clear]]</td>
<td></td>
<td>Clear the access list for the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_add| admin_acl_add]]</td>
<td></td>
<td>Add a list of users to the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_remove| admin_acl_remove]]</td>
<td></td>
<td>Remove a list of users from the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2009-07-06T22:32:57Z

Randomhuman: /* RemoteAdmin Commands */

__NOTOC__
{{Template:Quicklinks}}
 

<div style="background-color:#ffa0a0; padding:15px">
Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.
</div>

== How to Setup the Remote Admin ==

=== Setup OpenSim ===

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# instantiate server object
gridServer = xmlrpclib.Server(gridServerURL)

# invoke admin_alert: requires password and message
gridServer.admin_broadcast({’password’: ’secret’, ‘message’: ‘the answer is 42′})

=== RemoteAdmin executable for Windows ===

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);
?>
</source>

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
class RemotePC {

function __construct() {
$this->serveruri = "http://myhost";
$this->serverport ="9000";
$this->password ="foobar";
}

function call($command,$parameters) {
$parameters['password'] = $this->password;
$request = xmlrpc_encode_request($command, $parameters);
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);
$result = curl_exec($ch);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

=== Example in Perl ===

Because the OpenSim internal web server just accepts HTTP/1.0 requests, it's worth to give a perl example. It's not a daily thing to do HTTP/1.0 within the LWP environment. You can get the '''[[Users:Thomax:perl-xmlrpc | Perl example here]]'''.

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_master_first,
region_master_last, region_master_password, listen_ip, external_address</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_modify_region | admin_modify_region]]</td>
<td></td>
<td>Modify a region</td>
<td>region_name, region_id (optional), public, enable_voice</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown| admin_shutdown]]</td>
<td></td>
<td>Shutdown server</td>
<td>shutdown (optional, expects 'delayed'), milliseconds</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user_email| admin_create_user_email]]</td>
<td></td>
<td>Create a new user (alias for admin_create_user)</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname, user_lastname, user_password, start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename, region_uuid (or region_name), xml_version</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_oar| admin_save_oar]]</td>
<td></td>
<td>Saved an OAR file of a regions contents</td>
<td>filename, region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_list| admin_acl_list]]</td>
<td></td>
<td>Retrieve a list of users who can access the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_clear| admin_acl_clear]]</td>
<td></td>
<td>Clear the access list for the region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_add| admin_acl_add]]</td>
<td></td>
<td>Add a list of users to the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
<tr>
<td>[[remoteadmin:admin_acl_add| admin_acl_add]]</td>
<td></td>
<td>Remove a list of users from the access control list</td>
<td>region_uuid or region_name, users</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2009-07-06T22:25:24Z

Randomhuman: /* RemoteAdmin Commands */