From SLIS Second Life Wiki

(parent)

This Linker Script allows in-world selector objects to fetch a list of available objects for distribution from the Moodle database (query mode), and to request that a specific object be distributed to an avatar (sendobject mode).

Contents 1 Dependencies 2 Parameters 3 Response 4 Algorithm

[edit] Dependencies

Sloodle files:

• config.php
• sl_debug.php
• lib/sl_lsllib.php

[edit] Parameters

The following HTTP parameters are always required when requesting this script:

• sloodlepwd = the site's Prim Password
• sloodlecmd = the name of the mode requested (either 'query' or 'sendobject')

When in 'sendobject' mode, the following additional parameters are also required:

• sloodleuuid = UUID of the avatar to whom an object should be sent (NOTE: this is optional if 'sloodleavname' is specified and the avatar is in the Moodle database)
• sloodleavname = name of the avatar to whom an object should be sent (NOTE: this is ignored if 'sloodleuuid' is specified)
• sloodleobject = name of the object to send to the avatar

[edit] Response

If the mode specified by parameter 'sloodlecmd' is not recognised, then the script returns the -811 status code.

In 'query' mode, if successful, the script will return status code 1, and each data line will contain the name of an object available for distribution. Otherwise, various standard error codes might be returned in the event of a problem.

Note: the status code may be 1 even if there are no objects. Please check the number of data lines before attempting to process them.

In 'sendobject' mode, the returned status code will be 1 if successful, and the name of the distributed object will be specified in the first data line. (Note: the UUID of the avatar to whom the object was sent will be specified in the status line, in accordance with the Sloodle communications specification).

Various error codes may be returned if something goes wrong in 'sendobject' mode:

• -812 if requested object is not found in database
• -103 if the distribution channel is not known
• -105 if the XML-RPC fails

[edit] Algorithm

1. Construct SloodleLSLHandler object
2. Process basic request data
3. Authenticate request
4. Fetch additional parameters
5. Make sure script mode is recognised (terminate if not)
6. Fetch the XMLRPC channel from the database (terminate if it cannot be found)
7. Fetch the list of available distribution objects from the database (terminate if none can be found)
8. Is script in query mode? If yes then:
   1. Output list of objects available for distribution
9. Else if script is in sendobject mode then:
   1. Is avatar UUID available? If not:
      1. Look-up name in database to fetch stored UUID (terminate on failure)
   2. Make sure the requested object is specified in the database (terminate on failure)
   3. Construct and send XMLRPC message
   4. Output success or error message
10. Render response
11. Terminate script

This page is part of the Sloodle documentation
SloodleDocs Home | User Documentation | Administrator Documentation | Developer Documentation | Sloodle Wiki Home