Load a Table with Region Information from Open Simulator Config File Regions.ini. More...

Functions
	rdOpenDatabase ($Database, $Host, $Username, $Password)
	Open the Support Database for Use.
	rdSaveRegion ($Parameters, $Pdo)
	Save a region to the Region Table.

Variables
	$pdo = rdOpenDatabase($db, $host, $db_username, $db_password)
	$region_data = []
	$source_file = "/opt/ls_opensim/bin/Regions/Regions.ini"
	$lines = file($source_file, FILE_IGNORE_NEW_LINES)
	$array_size = count($lines)

Detailed Description

Load a Table with Region Information from Open Simulator Config File Regions.ini.

Author: River Drifter river.nosp@m.-dri.nosp@m.fter@.nosp@m.auss.nosp@m.iebro.nosp@m.adba.nosp@m.nd.co.nosp@m.m.au

Copyright: Software: GNU General Public License v3.0 or later https://spdx.org/licenses/GPL-3.0-or-later.html; Documentation: Creative Commons Attribution Share Alike 4.0 International https://spdx.org/licenses/CC-BY-SA-4.0.html

Version: 1.0.0

Date: 06-January-2026

The creation of this table is an interim step until access to this data becaomes available by a more supported method. Besides providing the data in the Regions.ini file, it also calculates the boundaries of the regions in global coordinates. This allows a simple method of determining which regon any position using global coordinates is in, by just using four comparisons in an SQL query. As in

select lor_name from ls_os_region where x_pos >= lor_edge_left and x_pos <= lor_edge_right and y_pos >= lor_edge_bottom and y_pos <= lor_edge_top;

This script is used to parse an Open Simulator "Regiion.ini" file into a database table. This is a very elemertary script as it assumes that is scanning a standard Regions.ini file where each region in the file is in the standard format below:

[RegionName]
RegionUUID = 2d69924a-8c19-12f0-72e4-345d605b1025
Location = 104,374
SizeX = 512
SizeY = 512
SizeZ = 4000
InternalAddress = 0.0.0.0
InternalPort = 5027
ResolveAddress = False
ExternalHostName = www.internet.address.com
MaptileStaticUUID = 00000000-0000-0000-0000-000000000000
 
; * Default region landing point used when no teleport coords are specified
DefaultLanding = <128,128,24>

Definition in file load_region_table.php.

Function Documentation

◆ rdOpenDatabase()

rdOpenDatabase	(	$Database,
		$Host,
		$Username,
		$Password )

Open the Support Database for Use.

Parameters

$Database	The Name of the Database to Open
$Host	The name of the computer use to conenct to the Database
$Username	The username to access the Database
$Password	The password to access the database.

If this routine fails, it will case the program to abort and the heartbeat will neither identify itself as being on-line and it will not update the list of destinations.

Definition at line 61 of file load_region_table.php.

    {
        // Data Source Name (DSN) string
        $dsn = "mysql:host=$Host;dbname=$Database;charset=utf8mb4";
 
        // Set PDO options for better error handling and security
        $options = [
                PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION, // Throw exceptions on errors
                PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,       // Set default fetch mode to associative array
                PDO::ATTR_EMULATE_PREPARES   => true,                  // Disable emulated prepares for better security
               ];
 
        try
        {
            // Create a new PDO connection instance
            $pdo = new PDO($dsn, $Username, $Password, $options);    
        }
        catch (PDOException $e)
        {
            // Catch the exception and display a user-friendly error message
            // In a production environment, you might log the specific error
            
            die("FAILURE=DATABASE:Connection failed " . $e->getMessage());
        }
        
        return $pdo;
    }

References $pdo.

◆ rdSaveRegion()

rdSaveRegion	(		$Parameters,
			$Pdo )

Save a region to the Region Table.

Parameters

$Parameters	The Region Information
$Pdo	The Database Driver Instance

Definition at line 96 of file load_region_table.php.

{
    $sql_query  = "INSERT INTO ls_os_support.ls_os_region (";
 
    $sql_query .= " lor_name, lor_location_x, lor_location_y, lor_size_x, lor_size_y, lor_size_z,";
    $sql_query .= " lor_uuid, lor_map_uuid, lor_edge_upper, lor_edge_lower, lor_edge_left, lor_edge_right";
 
    $sql_query .= ")VALUES(";
 
    $sql_query .= " :lor_name, :lor_location_x, :lor_location_y, :lor_size_x, :lor_size_y, :lor_size_z,";
    $sql_query .= " :lor_uuid, :lor_map_uuid, :lor_edge_upper, :lor_edge_lower, :lor_edge_left, :lor_edge_right";
    
    $sql_query .= ");";
    
    try
    {
        $stmt = $Pdo->prepare($sql_query);
        $stmt->execute($Parameters);
    }
    catch (Exception $e)
    {
        echo("FAILURE=EXTRACT:".$e->getMessage()."\n");
    }
 
}
 
 
/***************************************************************************************************
 *              PROGRAM ENTRY
 ***************************************************************************************************/
 
// Connect to the Support Database
$pdo = rdOpenDatabase($db, $host, $db_username, $db_password);
 
$region_data = [];
 
// Set the Source File for the Conversion and Check it exists. Die if it doesn't exist
$source_file = "/opt/ls_opensim/bin/Regions/Regions.ini";
 
// Read the Source File into an Array
$lines = file($source_file, FILE_IGNORE_NEW_LINES);
$array_size = count($lines);
 
// Step through the Array Line by Line
for ($index = 0; $index < $array_size; $index++)
{
    //Only Process Lines that aren't blank or a comment
    $line = $lines[$index];
    if (!(($line == "") || ($line[0] == ";")))
    {
        //NOTE: The key names in the array match the names used for character substituitions in
        // the SQL insertion command.
         
        // Process a new Region. If a line starts with a '[' character, it is a new region
        if ($line[0] == "[")
        {
            // Clear out the Region Buffer Array
            $region_data = [];
            
            // Extract the Region name
            $region_data['lor_name'] = substr($line, 1, -1);
        }
        
        // If it isn't Region Start, add Infor into the Buffer Array
        else
        {
            // Split the String by the = character
            $key_value_array = explode("=", $line);
            $key = trim($key_value_array[0]); $value = trim($key_value_array[1]);
            
            // Extract the Relevant Items
            switch($key)
            {
                // Extract the UUID of the Array. This UUID can be used to link the Region Name
                // to data in the OpenSim tables 
                case "RegionUUID":
                    $region_data['lor_uuid'] = $value;
                break;
                
                // Get the Bottom Left Corner of the Region.
                case "Location":
                    $location_array = explode(",", $value);
                    $region_data['lor_location_x'] = $location_array[0];
                    $region_data['lor_location_y'] = $location_array[1];
                break;
 
                // Get the X size of the Region in Metres
                case "SizeX":
                    $region_data['lor_size_x'] = $value;
                break;
                
                // get the Y Size of the Region in Metres
                case "SizeY":
                    $region_data['lor_size_y'] = $value;
                break;
                
                // Get the Z Sizeo f the Region
                case "SizeZ":
                    $region_data['lor_size_z'] = $value;
                break;
                
                // Get the UUID of a Static Map Tile
                case "MaptileStaticUUID":
                    $region_data['lor_map_uuid'] = $value;
                break;
                
                // The Default landing Position is not store in the Region Table, but it does indicate that this
                // is the end of the Entry for the Region. Once the end is reached, the boundaries of the Region in
                // global units are calculated. This allows for easy testing to determine which Region in which a
                // global position is located. It also makes conversion between global and local positions easier.
                case "DefaultLanding":
                    $region_data['lor_edge_lower'] = (float)$region_data['lor_location_y'] * 256.0;
                    $region_data['lor_edge_upper'] = (float)$region_data['lor_edge_lower'] + (float)$region_data['lor_size_y'];
                    $region_data['lor_edge_left']  = (float)$region_data['lor_location_x'] * 256.0;
                    $region_data['lor_edge_right'] = (float)$region_data['lor_edge_left']  + (float)$region_data['lor_size_x'];
 
                    // Save the Region to the Table
                    rdSaveRegion($region_data, $pdo);
                break;
            }
        }
    }       
}

Variable Documentation

◆ $array_size

$array_size = count($lines)

Definition at line 137 of file load_region_table.php.

◆ $lines

$lines = file($source_file, FILE_IGNORE_NEW_LINES)

Definition at line 136 of file load_region_table.php.

◆ $pdo

$pdo = rdOpenDatabase($db, $host, $db_username, $db_password)

Definition at line 128 of file load_region_table.php.

Referenced by OS_GLOBAL_CALCS\__construct(), OS_GLOBAL_CALCS\GlobalToLocal(), OS_GLOBAL_CALCS\LocalToGlobal(), rdOpenDatabase(), and OS_GLOBAL_CALCS\RegionBoundsGlobal().

◆ $region_data

$region_data = []

Definition at line 130 of file load_region_table.php.

◆ $source_file

$source_file = "/opt/ls_opensim/bin/Regions/Regions.ini"

Definition at line 133 of file load_region_table.php.

Functions

Variables