signage_heartbeat.osl

Go to the documentation of this file.

 
 string VERSION_STRING = "0.0.1";
 
 float MINIMUM_HEARTBEAT_PERIOD = 0.1;
 
 
string CONFIG_NOTECARD_NAME = "brigadoon_signage.config";

string COMMENT_PREAMBLE = "//";

integer COMMENT_PREAMBLE_LENGTH = 2;

string DATABASE_INTERFACE = "DATABASE_INTERFACE";

string HEARTBEAT_PERIOD = "HEARTBEAT_PERIOD";
 

float TIMER_OFF = 0.0;

float MINIMUM_HEARTBEAT_INTERVAL = 600;

float MINIMUM_OFFSET = 0.5;

key heartbeat_key;

string database_interface;

float heartbeat_period;

integer version_number;

rdProcessFailureMessage(string FailureMessage)
{
    string failure_message;
    
    list status = llParseString2List(FailureMessage, [":"], ["\n"]);  
    string failure_type = llList2String(status, 0);
    
    // Explain why the Teleporter could not be automatically processed
    if (failure_type == "BANNED")
    {
        failure_message  = "Teleporters owned by user " + llList2String(status, 1) + " are not permitted to";
        failure_message += " add teleporters to the database, update teleporter information or update teleporter destinations.";
    }
       
    // Tell the person what to do if there was an error.
    failure_message += "\n If you wish to report this as an error please send this message to River Drifter with details of what happened and when.\n";
    llSay(0, failure_message); 
}

integer rdGetVersionNumber(string VersionString)
{
    integer version;
    
    list versions = llParseString2List(VersionString, ["."], []);
    version = (integer)llList2String(versions,2) + ((integer)llList2String(versions,1) * 100) + ((integer)llList2String(versions,0) * 10000);
    
    return version;
}

rdSaveNewTeleportNotecard(list teleport_list)
{
    // Add the Preamble Text before the List of Destinations
    teleport_list = destination_preamble + teleport_list;
       
    // Delete the Existing Teleporter Destination Notecard, if it exists
    integer count = llGetInventoryNumber(INVENTORY_NOTECARD);
    integer index = 0;
    for (; index < count; ++index)
    {
        if (llGetInventoryName(INVENTORY_NOTECARD, index) == CONFIG_DESTINATIONS_NAME)
        {
            llRemoveInventory(CONFIG_DESTINATIONS_NAME);
            index = count;  // Ext Loop
        }
    }
    
    // Write the Teleport List to a New Notecard
    osMakeNotecard(CONFIG_DESTINATIONS_NAME, teleport_list);
}

rdSendHeartbeatMessage()
{
    // Do a cursory Check that the configuration has been set up
    if (database_interface != "")
    {       
        key messageboard_key = llGetKey();
        list details = llGetObjectDetails(teleporter_key, [OBJECT_OWNER, OBJECT_GROUP]);
        
        string heartbeat_message = database_interface + "?command=heartbeat"
                                + "&key="          + messageboard_key
                                + "&owner="        + llList2String(details, 0)
                                + "&group="        + llList2String(details, 1)
        heartbeat_key = llHTTPRequest(heartbeat_message, [HTTP_BODY_MAXLENGTH,16384], [""]);      
    }
    else
    {
        llSay(DEBUG_CHANNEL, "The database_interface are undefined! Teleporter " + location_name + " has been disabled");
        llSetScriptState(llGetScriptName(), FALSE); 
    }
} 
 
default
{
    state_entry()
    { 
        // Read the Configuration File into a List of Lines
        string config = osGetNotecard(CONFIG_NOTECARD_NAME);
        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 == HEARTBEAT_PERIOD)   heartbeat_period = (float)value_object * 3600.0; // Convert hours to seconds
            }
            
            // Check that the Heartbeat Period is equal to or greater than the Minimum
            if (heartbeat_period < MINIMUM_HEARTBEAT_INTERVAL) heartbeat_period = MINIMUM_HEARTBEAT_INTERVAL;
        } 
 
        // Send out an Initial Heartbeat Message
        rdSendHeartbeatMessage();
        
        // Start the Heatbeat Timer, but first check that the heartbeat period would no result in flooding of the database.
        if (heartbeat_period < MINIMUM_HEARTBEAT_PERIOD) heartbeat_period = MINIMUM_HEARTBEAT_PERIOD;
        llSetTimerEvent(heartbeat_period);    
    }

    http_response(key RequestId, integer Status, list Metadata, string Body)
    {
        list teleport_list;
 
        // Only respond to the Heartbeat Request
        if (RequestId == heartbeat_key)
        {
            // Check to see if the Reuest was a Success
            if (Status != 200)
            {
                llSay(DEBUG_CHANNEL, "Heartbeat Request Failed with error " + (string)Status);
            }
            else
            {
                // Split into a list for easier processing
                list input_list = llParseString2List(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);
                    
                    // Split the Line into its components
                    list line_list = llString2List(llParseString2List(Body, ["="], []);
                    string key_string = llList2String(line_list, 0);
                    string value_string = llList2String(line_list, 1);
                    
                    // Process the Key-Value Pairs
                    if (key_string == "")
                    {
                    }
                    else if (key_string == "")
                    {
                    }
                    else if (key_string == "")
                    {
                    }
                    else if (key_string == "")
                    {
                    }
                }
                while ( ++index < list_count);
            }
        } 
    }
    
    timer()
    {
        rdSendHeartbeatMessage();
    }
}