build_sub.php

<?php
/**
 *   @file       build_sub.php
 *   @brief      Background function run in iframe from `build.php`
 *   @details    Create/open database, reindex, add/remove
 *   
 *   @copyright  http://www.gnu.org/licenses/lgpl.txt LGPL version 3
 *   @author     Erik Bachmann <ErikBachmann@ClicketyClick.dk>
 *   @since      2024-11-30T23:18:16 / ErBa
 *   @version    @include version.txt
 */

include_once( 'lib/debug.php' );
include_once( 'lib/_header_config.php' );
include_once( 'lib/push.php' );
include_once( 'lib/reindexwordclouds.php' );

/** @brief Init global variables */
$files		= [];

/** @brief Normalising dates */
$cfg_normalise    = [
    '/\.jpg$/i' => '',  // Extention
    '/^(19|20)\d\d-\d\d-\d\d[T,_,\.,\s]\d\d-\d\d-\d\d[_,\.,\s]/' => '', // Full ISO
    '/^(19|20)\d\d-\d\d-\d\d[T,_,\.,\s]/' => ''    // Date only
];


echo <<<EOL
<style>body{ color: yellow;};</style>

<script>
    function progress_bar( id, max, value, note ) {
        if (undefined === note) { note = '?'; }
        
        var elem    = parent.document.getElementById( id );
        var status  = parent.document.getElementById( id +"_status");
        pct     = value * 100 / max;

        elem.value          = pct;
        status.innerHTML    = Math.trunc( pct ) +'% '+note;
    }   // progress_bar()

    function setStatus( str )
    {
        parent.document.getElementById( 'status' ).innerHTML += str;
    }   // setStatus()

    parent.document.getElementById( 'status' ).innerHTML = '';
    setStatus( '[{$_REQUEST['action']}]: [{$_REQUEST['source_dir']}] &rarr; [{$_REQUEST['database_name']}]<br>' );
</script>

EOL;

timer_set('init_db', 'Open - or create database');
// Open - or create database
initDatabase( $db, $_REQUEST['database_name'] );
timer_set('init_db');

switch( $_REQUEST['action'] ?? '?' )
{
    case 'create_database':
        create_database();
        rebuild_update();
        post_proccessing();

        reindex_all();
        
        /*
        //** @brief temp var
        $r  = $db->exec( $GLOBALS['database']['sql']['replace_into_dirs'] );
        
        //** @brief temp var
        $r  = querySqlSingleValue( $db, "SELECT count(path) FROM dirs;");

        pstatus( "- replace_into_dirs: {$r}" );

        $r  = $db->exec( $GLOBALS['database']['sql']['update_dirs'] );
        */
        //$r  = querySqlSingleValue( $db, "SELECT count(thumb) FROM dirs;");

        $r  = querySqlSingleValue( $db, $GLOBALS['database']['sql']['select_count_thumb'] );
        pstatus( "- ".___('update_dirs').": {$r}" );
    break;

    case 'update_images':
        $files  = update_images();
        rebuild_update($files);
        post_proccessing();
        reindex_all();
    break;

    case 'delete_images':
        delete_images();
    break;

    case 'reindex':
        reindex_all();
        reindex_wordclouds();
    break;

    default:
        //echo "Sorry: Don't know how to: [{$_REQUEST['action']}]";
        echo ___('unable_to').": [{$_REQUEST['action']}]";
}

pstatus( ___('runtime'). " " . microtime2human( microtime( TRUE ) - $_SERVER["REQUEST_TIME_FLOAT"] ) );


pstatus( ___('done') );


//----------------------------------------------------------------------

/**
 *   @fn        delete_action()
 *   @brief      Reporting the deletion
 *   
 *   @since      2024-12-04T18:22:46
 */
function delete_action()
{
    pstatus( 'delete action' );
    echo "- <pre>[".var_export($_REQUEST, TRUE)."</pre>";
}   // delete_action()

//----------------------------------------------------------------------

/**
 *   @fn        delete_images()
 *   @brief      Select image directories for deletion
 *   
 *   
 *   @details    $(More details)
 *   
 *   @since      2024-12-04T18:24:02
 */
function delete_images()
{
    global $db;
    echo "- [{$_REQUEST['action']}]";
	verbose( 'Delete images' );

    // Select directories for deletion
    // Get files from db
    $sql    = sprintf( $GLOBALS['database']['sql']['select_distinct_source'], $_REQUEST['source_dir'] );
    $files_db    = array_flatten( querySql( $db, $sql ) );
    
    $output =  '<form id="delete_form" action="build-dev.php"  method="post">'
    .   '<input type="hidden" id="action" name="action" size=50 value="delete_action">'
    .   '<input type="hidden" id="title" name="title" size=50 value="do_what">'
    ;
    $loop=0;
    foreach ( $files_db as $dir )
    {
        $sql    = "SELECT count(*) FROM images WHERE source = '{$dir}';";
        $count  = querySqlSingleValue( $db, $sql );
        $loop++;
        $output .= sprintf("<input type=\"checkbox\" id=\'%s\' name=\'files[]\' value=\'%s\'>"
        , $loop
        , $dir 
        );

        $output .= sprintf("<label for=\'%s\'>%10.10s: %s</label><br>"
        ,   $loop
        ,   $count
        ,   $dir 
        );
        
        verbose($dir);
        logging( $dir );
    }

    pstate( "$output<input type=\'submit\' value=\'Submit\'>" 
    .   "</form>");

    $_REQUEST['action'] = '';
}   // delete_images()

//----------------------------------------------------------------------

/**
 *   @fn        create_database()
 *   @brief      Create new database
 *   
 *   
 *   @details    $(More details)
 *   
 *   @code
 *   @endcode
@verbatim
@endverbatim
 *   
 *   @since      2024-12-04T18:24:41
 */
function create_database()
{
    echo "- [{$_REQUEST['action']}]";
	verbose( 'Process all' );
	verbose( 'Clear tables' );
    clear_tables();
    
	$GLOBALS['timers']['get_images_recursive']	= microtime(TRUE);
	verbose( '// Find all image files recursive' );

	// Find all image files recursive
	getImagesRecursive( $_REQUEST['source_dir'], $GLOBALS['config']['data']['image_ext'], $files, ['jpg'] );
	logging( progress_log( count( $files ), 1, $GLOBALS['timers']['get_images_recursive'], 1 ) );
	debug( $files );

	status( ___('processing_files'), count( $files ));
	$GLOBALS['timers']['put_files_to_database']	= microtime(TRUE);
	
	// Put all files to database: images
	putFilesToDatabase( $files );
	logging( progress_log( count( $files ), 1, $GLOBALS['timers']['put_files_to_database'], 1 ) );
}   // create_database()

//----------------------------------------------------------------------

/**
 *   @brief      load images (Dummy)
 */
function load_images()
{
    echo "- [{$_REQUEST['action']}]";
}   // load_images()

//----------------------------------------------------------------------

/**
 *   @fn        update_images()
 *   @brief      Update database with new images
 *   
 *   
 *   @details    $(More details)
 *   
 *   @todo       
 *   @bug        
 *   @warning    
 *   
 *   @see        https://
 *   @since      2024-12-04T18:26:33
 */
function update_images()
{
    global $db;
    $files  =[];
    echo "- [{$_REQUEST['action']}]";
    // Get files from dir
    getImagesRecursive( $_REQUEST['source_dir'], $GLOBALS['config']['data']['image_ext'], $files, ['jpg'] );
    //logging( var_export( $files, TRUE ) );
    
    // Get files from db
    $sql = sprintf( "SELECT source||'/'||file FROM images WHERE source glob '%s*';", $_REQUEST['source_dir'] );
    $files_db    = array_flatten( querySql( $db, $sql ) );
    logging( var_export( $files_db, TRUE ) );
    
    // Compare
    $new_files  = array_diff( $files, $files_db);
    logging( var_export( $new_files, TRUE ) );
    
    putFilesToDatabase( $new_files );
    
    //trigger_error( "<pre>img from dir: ".var_export(array_diff( $files, $files_db), TRUE), E_USER_ERROR);
    
    
    return( $new_files );
}   // update_images()

//----------------------------------------------------------------------


/** @brief Dummy */
function grouping_images()
{
    echo "- [{$_REQUEST['action']}]";
}   // grouping_images()

//----------------------------------------------------------------------

/** @brief Dummy */
function update_index()
{
    echo "- [{$_REQUEST['action']}]";
}   // update_index()


//----------------------------------------------------------------------


function reindex_all()
{
    global $db;

    echo "- [{$_REQUEST['action']}]";
    
	$GLOBALS['timers']['reindex_all']	= microtime(TRUE);


    $sql	= $GLOBALS['database']['sql']['select_source_meta'];
    debug( $sql, 'SQL:' );
    
    $files 	= querySql( $db, $sql );
    $total	= count( $files );
    debug( $files, 'Files');

	logging( progress_log( $total, 1, $GLOBALS['timers']['reindex_all'], 1 ) );

    $loadfile	= fopen( 'loadfile.txt', 'w');
    $GLOBALS['tmp']['keycount']    = 0;
    $GLOBALS['tmp']['imagecount']  = 0;
    
    foreach($files as $no => $data)
    {
        $GLOBALS['tmp']['imagecount']++;
        $file           = $data['file'];
        // Parse metadata
        $data['iptc']	= json_decode( $data['iptc'], TRUE) ?? [];
        //$data['exif']	= json_decode( $data['exif'], TRUE);

        $iptc   = [];
        array2breadcrumblist($data['iptc'], $iptc );
        
        pstatus( "IPTC: ".var_export( $iptc, TRUE) );
        logging( "IPTC: ".var_export( $iptc, TRUE) );
        trigger_error( var_export( $iptc, TRUE), E_USER_WARNING );
        //array2breadcrumblist($data['exif'], $exif );
        
        process_search( $iptc, $data['rowid'], $file );
        //process_search( $exif, $no, $file );

        echo progressbar($GLOBALS['tmp']['imagecount'], $total, $GLOBALS['config']['process']['progressbar_size'], $file );
        logging( progress_log( count( $files ), $no, $GLOBALS['timers']['reindex_all'], 1 ) );
    }
    
    // Delete doublets from search
    $r  = $db->exec( $GLOBALS['database']['sql']['delete_doublets_from_search'] );
    
    $no++;
    pstatus( "Reindexing : {$no}/{$total}" );
}   // reindex_all()


//----------------------------------------------------------------------


/**
 *   @brief      remove old entries and add new entries
 *   
 *   @param [in]	$iptc   Data array
 *   @param [in]	$file	File key (source + file)
 *   @return     $(Return description)
 *   
 *   @details    $(More details)
 *   
 *   @since      2024-11-19T22:33:07
 */
function process_search( $iptc, $no, $file )
{
    global $db;

    // Remove old entries!
    $sql	= sprintf( 
                    $GLOBALS['database']['sql']['delete_search']
                ,	$file
            );
    $r  = $db->exec( $sql );
    logging( "Delete search: $sql");

    // Insert new
    foreach( $iptc as $key => $value )
    {
        foreach( $GLOBALS['database']["search"]["iptc"] as $iKey => $iValue )
        {
            if ( str_starts_with( $key, $iKey ) )
            {
                $sql	= sprintf( 
                    $GLOBALS['database']['sql']['insert_search']
                ,	$file
                ,	$no
                ,	"$iValue$value"
                ,	strtolower("$iValue$value")
                );
                logging( "Insert search: $sql" );
                $r  = $db->exec( $sql );
                $GLOBALS['tmp']['keycount']++;
            }
        }
    }
}   // process_iptc_search()

//----------------------------------------------------------------------



/**
 *   @fn        clear_tables()
 *   @brief      Clear tables in existing database (Irreversible)
 *   
 *   @param [in]		$(description)
 *   
 *   @warning    Irreversible
 *   
 *   @since      2024-12-04T18:27:34
 */
function clear_tables()
{
    global $db;
    $r  = $db->exec( $GLOBALS['database']['sql']['delete_all_search'] );
    $r  = $db->exec( $GLOBALS['database']['sql']['delete_all_images'] );
}   //clear_tables()

//----------------------------------------------------------------------

/**
 *   @fn        getImagesRecursive( $root, $image_ext, &$files, $allowed = [] )
 *   @brief      Get a list of images recursive from root
 *   
 *   @param [in]	$root		Start of search
 *   @param [in]	$image_ext	File extentions
 *   @param [in]	&$files		Array of files
 *   @param [in]	$allowed=[]	$(description)
 *   @return     TRUE if files found | FALSE
 *   
 *   @details    Recursive loop from root
 *   
 *   @since      2024-11-13T13:44:58
 */
function getImagesRecursive( $root, $image_ext, &$files, $allowed = [] )
{
	$it = new RecursiveDirectoryIterator( $root, RecursiveDirectoryIterator::SKIP_DOTS );
	$display = Array ( 'jpeg', 'jpg' );

	$count	= 0;
	$GLOBALS['tmp']['files_total']	= 0;

	foreach(new RecursiveIteratorIterator($it) as $file)
		$GLOBALS['tmp']['files_total']++;
	
	//foreach( $it3 as $file)
	foreach(new RecursiveIteratorIterator($it) as $file)
	{
		if ( ! empty( $allowed ) )
		{	// extention after last . to lowercast
			if( in_array( strtolower( pathinfo( $file, PATHINFO_EXTENSION ) ), $allowed ) ) {
				$files[]	= str_replace( "\\", '/', "$file");
			}
		}
		else
			$files[]	= str_replace( "\\", '/', "$file");
		
        $max    = $GLOBALS['tmp']['files_total'];
        $count++;
        if ('cli' === PHP_SAPI ) 
        {
            echo progressbar(
                $count
            ,   $max
            ,   $GLOBALS['config']['process']['progressbar_size']
            ,   $file, $GLOBALS['config']['process']['progressbar_lenght'] 
            );
        }
        else 
        {
            pbar( 'progress', $max, $count, "Rebuild: {$count}/{$max}" );
        }
	}
    echo PHP_EOL;

    pstatus( "Got images: {$count}/{$GLOBALS['tmp']['files_total']} &#x1F5BC;" );
	return( ! empty($files) );
}	// getImagesRecursive()

//----------------------------------------------------------------------

/**
 *   @fn        putFilesToDatabase( $files )
 *   @brief      Write all file names to table.
 *   
 *   @param [in]	$files	List of file
 *   @return     VOID
 *   
 *   @details    Write all files to database in one transaction
 *   
 *   @since      2024-11-14T11:09:35
 */
function putFilesToDatabase( $files )
{
	global $db;
	verbose( '// Write all file names to table' );
	$r  = $db->exec( "BEGIN TRANSACTION;" );
    $max    = count($files);
    $count  = 0;
	foreach ( $files as $path )
	{
		['basename' => $basename, 'dirname' => $dirname] = pathinfo( $path );

		$sql	= sprintf( $GLOBALS['database']['sql']['insert_files'], 'images', $dirname, 
            str_replace( 
                [$GLOBALS['config']['data']['data_root']] //, trim($GLOBALS['config']['data']['data_root'], '/')
            ,   $GLOBALS['config']['data']['virtual_root']
            ,   $dirname
            )
        ,   $basename
        ,   normalise_name( $GLOBALS['cfg_normalise'], $basename ) 
        );
		debug( $sql );
		$r  = $db->exec( $sql );
        $count++;

        pbar( 'progress', $max, $count, "Put image to database: {$count}/{$max}" );
	}
	$r  = $db->exec( "COMMIT;" );

    pstatus( "Images written to database: {$count}/{$max} &#x1F5BC;" );

}	// putFilesToDatabase()

//----------------------------------------------------------------------

/**
 *   @fn        rebuild_update( $files = FALSE)
 *   @brief      Write meta data, thumb and view for each file
 *   
 *   @param [in]	$files=FALSE	Files to update
 *   
 *   @details    
 *   
 *   @code
 *   @endcode
@verbatim
@endverbatim
 *   
 *   @todo       
 *   @bug        
 *   @warning    
 *   
 *   @see        https://
 *   @since      2024-12-04T18:28:51
 */
function rebuild_update( $files = FALSE)
{	// Process all
    global $db;
	verbose( 'Update' );
    verbose( '// Write meta data, thumb and view for each file' );
    $GLOBALS['timers']['rebuild_full']  = microtime(TRUE);

    $GLOBALS['timers']['add_meta']      = microtime(TRUE);

    // If no files given update ALL files!
    if ( empty( $files ) )
        $files  = array_flatten( querySql( $db, $GLOBALS['database']['sql']['select_all_files'] ) );
    
    $GLOBALS['tmp']['images_total']    = count($files);
    $count      = 0;

    foreach ( $files as $file )
    {
        $r  = $db->exec( "BEGIN TRANSACTION;" );
        $currenttime	= microtime( TRUE );
        ++$count;

        ['basename' => $basename, 'dirname' => $dirname] = pathinfo( $file );
        $note	= "";
        debug( $file );

        // Get image dimentions
        list($width, $height, $type, $attr) = getimagesize($file);

    //>> Get EXIF - in quiet mode
        $exif 	= @exif_read_data( $file, 0, true);
        if ( empty( $exif ) )
        {
            logging( "$file error in image EXIF" );
            $exifjson 	= '';
        }
        else
        {
            $exifjson 	= json_encode_db( $exif );
        }
        debug($exifjson, 'EXIF_json');
    //<< Get EXIF - in quiet mode

    //>> Get IPTC
        $iptc		= parseIPTC( $file );
        if ( empty( $iptc ) )
        {
            logging( "$file error in image IPTC" );
            $iptcjson 	= '';
        }
        else
            $iptcjson 	= json_encode_db( $iptc );

        debug($iptcjson, 'IPTC_json');
    //<< Get IPTC

        // Get thumbnail - in quiet mode
        $thumb 		= @exif_thumbnail( $file );
        if ( empty( $thumb) )
        {
            $note			.= "Thumb build";
            $thumb_width	= $GLOBALS['config']['display']['thumb_max_width'];
            $thumb_height	= $GLOBALS['config']['display']['thumb_max_height'];
            $dst			= "FALSE";
            $thumb			= image_resize( 
                    $file
                ,	$dst
                ,	$GLOBALS['config']['images']['thumb_max_width']
                ,	$GLOBALS['config']['images']['thumb_max_height']
                ,	$exif['IFD0']['Orientation'] ?? 0
                ,	$GLOBALS['config']['images']['image_resize_type']
                ,	$GLOBALS['config']['images']['crop']
                );
            logging( "Thumb rebuild");
        }
        else
        {
            if ( $exif['IFD0']['Orientation'] ?? 0 )
            {
                $gdThumb	= imagecreatefromstring( $thumb );
                //if ( $degrees )
                $gdThumb	= gdReorientateByOrientation( $gdThumb, $exif['IFD0']['Orientation'], $file );
                $thumb		= stringcreatefromimage( $gdThumb, 'jpg');
            }
            logging( "Thumb extracted");
        }
        
        if ( empty( $thumb ) )
        {
            //$r  = $db->exec( "COMMIT;" );
            logging( "Skipping thumb $file" );
            $thumb	= '';
            //continue;
        }

        //>> Rotate EXIF
        $thumb 		= base64_encode( $thumb );

        $dst		= "FALSE";
        $view 		= image_resize( 
                        $file
                    ,	$dst
                    ,	$GLOBALS['config']['images']['display_max_width']
                    ,	$GLOBALS['config']['images']['display_max_height']
                    ,	$exif['IFD0']['Orientation'] ?? 0
                    ,	$GLOBALS['config']['images']['image_resize_type']
                    ,	$crop=0
                    );
        if ( empty($view) )
        {
            //$view = file_get_contents($file);
            //$r  = $db->exec( "COMMIT;" );
            logging( "Skipping view $file" );
            //continue;
            $view	= '';
        }
        //debug(microtime( TRUE ) - $currenttime, 'view resize');
        $view 		= base64_encode( $view );
        //<< Rotate EXIF

    //>> Update thumb and view in database
        $sql	= sprintf( 
            $GLOBALS['database']['sql']['replace_into_images']
        ,	$dirname
        ,	$basename
        ,	$thumb
        ,	$view
        ,	$dirname
        );
        $sql	= sprintf( 
            $GLOBALS['database']['sql']['replace_into_images']
        ,	$thumb
        ,	$view
        ,	$dirname
        ,	$basename
        );
        debug( $sql );
        $r  = $db->exec( $sql );
    //>> Update thumb and view in database
    
    
    //>> Update meta
        $sql	= sprintf($GLOBALS['database']['sql']['replace_into_meta'], $exifjson, $iptcjson, $dirname, $basename );
        debug( $sql  );
        //verbose( $sql  );
        $r  = $db->exec( $sql );

        logging( sprintf( "%s/%s [%-35.35s] [%s] %sx%s %s %s %s"
            ,	$count
            ,	$GLOBALS['tmp']['images_total']
            ,	$exif['FILE']['FileName']
            ,	date( 'c', $exif['FILE']['FileDateTime'] )
            ,	$exif['COMPUTED']['Width']
            ,	$exif['COMPUTED']['Height']
            ,	$exif['FILE']['MimeType']
            ,   $count . ':'. ( $exif['IFD0']['Orientation'] ?? '?')
            ,   number_format( microtime( TRUE ) - $currenttime, 2) . 'sec. '.$note
        )
        ,	"Image: "
        );
        $r  = $db->exec( "COMMIT;" );
    //<< Update meta
    
//>> Logging
        logging( progress_log( $GLOBALS['tmp']['images_total'], $count, $GLOBALS['timers']['add_meta'], 1 ) );

        $max    = $GLOBALS['tmp']['images_total'];
        //update_progressbar( $id, $max, $count, $note, $size=30, $length=50);
        /**/
        if ('cli' === PHP_SAPI ) 
        {
            echo progressbar(
                $count
            ,   $max
            ,   $GLOBALS['config']['process']['progressbar_size']
            ,   $file
            ,   $GLOBALS['config']['process']['progressbar_lenght'] 
            );
        }
        else 
        {
            pbar( 'progress', $max, $count, "Rebuild: {$count}/{$max}" );
        }
        /**/
    }
    logging( progress_log( $GLOBALS['tmp']['images_total'], $count, $GLOBALS['timers']['add_meta'], 1 ) );

	logging( progress_log( count( $files ), 1, $GLOBALS['timers']['rebuild_full'], 1 ) );
    pstatus( "Metadata added: {$count}/{$GLOBALS['tmp']['images_total']} &#x1F5BA;" );
//<< Logging
    
}   // rebuild_update()

//----------------------------------------------------------------------

/**
 *   @fn        post_proccessing()
 *   @brief      Running post processing SQL after data load
 *   
 *   @details    Executing each group under $GLOBALS['database']['post']
 *   
 *   @since      2024-12-04T18:17:05
 */
function post_proccessing()
{
    global $db;

    verbose( "Post-processing", "\n- ");
    logging( "Post-processing:");
    // Count all post action - names
    $GLOBALS['tmp']['post_total']  = count( $GLOBALS['database']['post'], COUNT_RECURSIVE ) - count( $GLOBALS['database']['post'] );
    $count	= 0;

    $GLOBALS['timers']['post']	= microtime(TRUE);
    foreach( $GLOBALS['database']['post'] as $group => $actions )
    {
        $GLOBALS['timers']["post_{$group}"]	= microtime(TRUE);
        $action_no	= 0;
        foreach( $actions as $sql )
        {
            $action_no++;
            $GLOBALS['timers']["post_{$group}_{$action_no}"]	= microtime(TRUE);
            if ( str_starts_with( $sql, '--') )
            {
                debug( $sql, 'skip:' );
                logging( "Skip: {$sql};");
                //$group	= '';
            }
            else
            {
                debug($sql);
                logging( "Exec: {$sql};");
                $r  = $db->exec( $sql );
            }
            $count++;

            logging( progress_log( $GLOBALS['tmp']['post_total'], $count, $GLOBALS['timers']["post_{$group}_{$action_no}"], 1 ) );
            echo progressbar($count, $GLOBALS['tmp']['post_total'], $GLOBALS['config']['process']['progressbar_size'], "{$group}: {$sql}", $GLOBALS['config']['process']['progressbar_lenght'] );
        }
        logging( progress_log( $GLOBALS['tmp']['post_total']   , $count, $GLOBALS['timers']["post_{$group}"], 1 ) );
    }
    logging( progress_log( $GLOBALS['tmp']['post_total'], $count, $GLOBALS['timers']["post"], 1 ) );

    pstatus( "Post processing: {$count}/{$GLOBALS['tmp']['post_total']}" );
}   // post_proccessing() 

//----------------------------------------------------------------------

/**
 *   @fn        normalise_name( &$cfg, $name )
 *   @brief      Name normalisation according to rules
 *   
 *   @param [in]	&$cfg	Rules
 *   @param [in]	$name	Name
 *   @return     String w. normalised name
 *   
 *   @details    $GLOBALS['cfg_normalise']
 *   
 *   @code
 *   @endcode
@verbatim
@endverbatim
 *   
 *   @todo       
 *   @bug        
 *   @warning    
 *   
 *   @see        https://
 *   @since      2024-12-04T18:19:44
 */
function normalise_name( &$cfg, $name )
{
    $r  = $name;
    foreach ( $cfg as $pattern => $replacement)
    {
        $r  = preg_replace( $pattern, $replacement, $r);
    }
    return $r;
}   // normalise_name

//----------------------------------------------------------------------

/**
 *   @brief      Function for execution on shutdown
 *   
 *   @since      2024-12-04T18:20:01
 */
function shutdown()
{
    echo "done";
}   // shutdown()

//----------------------------------------------------------------------

?>