teleport_destination_monitor.osl

Go to the documentation of this file.

 string VERSION_STRING = "1.0.0";

string CONFIG_NOTECARD_NAME = "teleport_destination_monitor.conf";

string STATUS_NOTECARD_NAME = "teleport_monitor.txt";
 
string DATABASE_INTERFACE = "DATABASE_INTERFACE";

string MONITOR_INTERVAL = "MONITOR_INTERVAL";

string LIFE_TIME = "LIFE_TIME";

string SCAN_ONLY = "SCAN_ONLY";

string IN_WORLD_ONLY = "IN_WORLD_ONLY";

string COMMENT_PREAMBLE = "//";

integer COMMENT_PREAMBLE_LENGTH = 2;

float SECONDS_PER_HOUR = 3600.0;

 float MINIMUM_INTERVAL = 1800.0; //seconds
 
 float MINIMUM_LIFETIME = 0.5; //hours
 
vector WHITE_COLOUR = <1.0, 1.0, 1.0>;

float SOLID_ALPHA = 1.0;

float monitor_interval = 7200; // Seconds

float lifetime = 24; // hours

string location_world;

integer in_world_scan_only = FALSE;
 
string database_interface;

key scan_key;
 
/* \var scan list
 * \brief The list of responses from the php script
 *
 * The entries in the list are divided into status lines that start with a comment string "//"
 * and teleporter identifications that do not.
 *
 */
list scan_list;

integer scan_only = TRUE;

rdWriteStatusNotercard()
{
    string header_string;
    list ScanList;
    
    // Check to see if there already is a Status Notecard
    integer result = llGetInventoryType(STATUS_NOTECARD_NAME);
    
    // If there is no Notecard, Start a new one with this Header
    if (result == INVENTORY_NONE)
    {
        header_string  = "//###################################################################\n";
        header_string += "//###################################################################\n";
        header_string += "//## File: Teleport_Monitor.txt\n";
        header_string += "//## Author: River Drifter (river_drifter@aussiebroadband.com.au\n";
        header_string += "//## Contact: river_drifter@aussiebroadband.com.au\n";
        header_string += "//###################################################################\n";
        header_string += "//## This notecard contains a list of Teleporters that have\n";
        header_string += "//## exceeded their LIFE_TIME which indicates that the Teleporter\n";
        header_string += "//## may have failed and has been removed from the Teleport table.\n";
        header_string += "//## It the teleporter was restarted, the teleporter will be\n";
        header_string += "//## restored to the table.\n";
        header_string += "//## Monitor Version:" + VERSION_STRING + "\n";
        header_string += "//## Started: " + llGetTimestamp() + "\n";
        header_string += "//###################################################################\n";
        header_string += "//###################################################################\n";
    }
    
    // Otherwise Read the existing Status Notecard and prepend it to the new list
    else
    {
        // Read the Existing Status Notecard into the Header String
        header_string = osGetNotecard(STATUS_NOTECARD_NAME);
        
        // Delete the Existing Notecard 
        llRemoveInventory(STATUS_NOTECARD_NAME);
        llSleep(0.1);
    }
    
    // Prepend the Header to the List of Teleporters
    ScanList = [header_string] + scan_list;
            
    // Write the Teleport List to a New Notecard
    osMakeNotecard(STATUS_NOTECARD_NAME, ScanList);
}

integer rdConvertTrueFalse(string TrueFalseString)
{
    string temp = llToUpper(llStringTrim(TrueFalseString, STRING_TRIM));
    if (temp == "TRUE") return TRUE; else return FALSE;
}

integer rdCalcCommsChannel()
{
    integer random_value = 0x80000000 | (integer)llFrand(65536) | ((integer)llFrand(65536) << 16);
    return(random_value);
}

rdReadConfigNotecard(string NotecardName)
{
    // Read the Configuration File into a List of Lines
    string config = osGetNotecard(NotecardName);
    list config_data = llParseString2List(config, ["\n"], []);
    
    // Process each line in the Configuration Data
    integer index = 0;
    integer list_length = llGetListLength(config_data);
    for (; index < list_length; ++index)
    {
        // Trim line of  Leading and Trailing Spaces
        string trimmed_line = llStringTrim(llList2String(config_data, index), STRING_TRIM);
        
        // Only Process lines that are not a comment line or blank
        if ( (llGetSubString(trimmed_line, 0, COMMENT_PREAMBLE_LENGTH - 1) != COMMENT_PREAMBLE) && (trimmed_line != "") )
        {
            // Parse Line for a Configuration Field.
            list key_value = llParseString2List(trimmed_line, ["="], []);
             
            // Fold the Trimmed Key into upper case, to eliminate errors where the case is wrong in the config file.
            string key_object = llToUpper(llStringTrim(llList2String(key_value, 0), STRING_TRIM));
       
            // Trim the Value to remove leading and training spaces
            string value_object = llStringTrim(llList2String(key_value, 1), STRING_TRIM);
             
            // Process the Key-Value Pairs to Set Configuration
            if (key_object == DATABASE_INTERFACE)    database_interface = value_object;
            else if (key_object == MONITOR_INTERVAL) monitor_interval = (float)value_object * SECONDS_PER_HOUR; // Convert hours to seconds
            else if (key_object == LIFE_TIME)        lifetime = (float)value_object; // Time in Hours
            else if (key_object == SCAN_ONLY)        scan_only = rdConvertTrueFalse(value_object);
            else if (key_object == IN_WORLD_ONLY)   in_world_only = rdConvertTrueFalse(value_object);
        }
    }
    
    // Make sure the time is at least 30 minutes
    if (monitor_interval < MINIMUM_INTERVAL) monitor_interval = MINIMUM_INTERVAL;
    if (lifetime < MINIMUM_LIFETIME) lifetime = MINIMUM_LIFETIME;
}
 
rdsScanDestinationDatabase()
{
        // If only the world in which this script is located is to be scanned, include the world,
        // otherwise, show a false world to indicate all teleporters should be included.
        if (in_world_only == TRUE) world_state = location_world; else world_state = "###";
         
        // Find out the information about the object requesting a scan from the php script
        key controller_key = llGetKey();
        list details = llGetObjectDetails(controller_key, [OBJECT_OWNER, OBJECT_GROUP]);
 
        // Create the Heartbeat message that this object sends out
        string heartbeat_message = database_interface + "?command=scan"
                                + "&key="        + controller_key
                                + "&owner="      + llList2String(details, 0)
                                + "&group="      + llList2String(details, 1)
                                + "&onlyscan="   + (string)scan_only
                                + "&lifetime="   + (string)lifetime
                                + "&version="    + VERSION_STRING
                                + "&world="      + world_state;
                                
        // Send the heartbeat message to the php routine on the web server
        scan_key = llHTTPRequest(heartbeat_message, [], [""]);
}

rdStateEntry()
{
    // Get the Name of the World
    location_world = llGetSubString(osGetGridHomeURI(), 7, -1);
 
    // Load the Configuration Notecard
    rdReadConfigNotecard(CONFIG_NOTECARD_NAME);
 
    // Trigger a Scan & Purge of the Destinations Database
    rdsScanDestinationDatabase();
 
    // Set the Timer Event to Trigger a check of the Database for expired Teleporters.
    llSetTimerEvent(monitor_interval); 
}

class teleport_destination_monitor_default()
//default
{
    state_entry()
    {
        rdStateEntry();     
    }
    
    http_response(key RequestId, integer Status, list Metadata, string Body)
    {
        // Only respond to the Scan Request
        if (RequestId == scan_key)
        {
            // Check to see if the Reuest was a Success
            if (Status != 200)
            {
                llSay(0, "Scan Request Failed with error " + (string)Status);
            }
            else
            { 
                // Split into a list for easier processing
                list input_list = llParseString2List(llUnescapeURL(Body), ["\n"], []);
                
                // Step thought the list a line at a time
                integer index = 0;
                integer input_list_started = FALSE;
                integer list_count = llGetListLength(input_list);
                string line;
                do
                {
                    // Extract the Line
                    line = llList2String(input_list, index);
                       
                    // Start the Teleport Notecard             
                    if (line == "SCAN_LIST=START") input_list_started = TRUE;
                    
                    // End if you find the END FLAG by setting index to the end
                    else if (line == "SCAN_LIST=END")
                    {
                        index = list_count;
                        input_list_started = FALSE;
                    }
 
                    // Extract the Data Line & Process
                    else if (input_list_started == TRUE)
                    {
                        scan_list += line + "\n";
                    }
                    
                // Add each deleted entry to the Scan List
                }
                while ( ++index < list_count);
                
                // Save the List of deleted Teleporters & display prompt
                integer scan_list_length = llGetListLength(scan_list);
                string message_string;
                if (scan_list_length != 0)
                {
                    // Write the List of Returned Teleporters to the Status Notecard
                    rdWriteStatusNotercard();
                    scan_list = [];
                       
                    message_string = "Examine Status Notecard for retired Teleporters\nBefore touching the Desk\nbecause this will reset the notecard.\n";
                }
                else message_string = "";
                
                llSetText( message_string, WHITE_COLOUR, SOLID_ALPHA);   
            }
        }
    }
    
    /* \fn timer()
     * \brief Trigger a scan when the timer fires
     *
     */
    timer()
    {
        rdsScanDestinationDatabase();
    }
    
    touch(integer TouchCount)
    {
        // Remove the Test Prompt, if it is Visible)
         llSetText( "", WHITE_COLOUR, SOLID_ALPHA);
         llRemoveInventory(STATUS_NOTECARD_NAME);
    }
 
}