Symlinks Class Reference

Public Member Functions
	__construct ($root)

Static Public Member Functions
static	createModuleSymlink ($module)
static	deleteCurrentSymlinks ()
static	initializePaths ()
static	isSkippingSymlinkCreation ()
static	safeRemoveSymlink ($path)
static	setSkipSymlinkCreation (bool $skip)

Data Fields
const	APACHE_SYMLINK = 'apache'
const	BRUNO_SYMLINK = 'bruno'
const	COMPOSER_SYMLINK = 'composer'
const	GHOSTSCRIPT_SYMLINK = 'ghostscript'
const	GIT_SYMLINK = 'git'
const	MAILPIT_SYMLINK = 'mailpit'
const	MARIADB_SYMLINK = 'mariadb'
const	MEMCACHED_SYMLINK = 'memcached'
const	MYSQL_SYMLINK = 'mysql'
const	NGROK_SYMLINK = 'ngrok'
const	NODEJS_SYMLINK = 'nodejs'
const	PERL_SYMLINK = 'perl'
const	PHP_SYMLINK = 'php'
const	PHPMYADMIN_SYMLINK = 'phpmyadmin'
const	PHPPGADMIN_SYMLINK = 'phppgadmin'
const	POSTGRESQL_SYMLINK = 'postgresql'
const	POWERSHELL_SYMLINK = 'powershell'
const	PYTHON_SYMLINK = 'python'
const	RUBY_SYMLINK = 'ruby'
const	XLIGHT_SYMLINK = 'xlight'

Static Private Member Functions
static	isPathWithinAllowedBase ($path)
static	isSymlink ($path)

Static Private Attributes
static	$root
static	$skipSymlinkCreation = false

Detailed Description

Manages the creation and deletion of symbolic links for various components within the Bearsampp environment.

Definition at line 14 of file class.symlinks.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$root

)

Constructs a Symlinks object and initializes paths to current directories.

Parameters

Root

$root

The root object associated with the Bearsampp environment.

Definition at line 52 of file class.symlinks.php.

    {
        self::$root = $root;
        self::initializePaths();
    }

References $root, and initializePaths().

Here is the call graph for this function:

Member Function Documentation

createModuleSymlink()

createModuleSymlink ( $module )

static

Creates a symbolic link from the current path to the symlink path for a module. If the symlink already exists and points to the correct target, no action is taken.

Parameters

Module

$module

The module instance.

Definition at line 97 of file class.symlinks.php.

    {
        $src  = Path::formatWindowsPath($module->currentPath);
        $dest = Path::formatWindowsPath($module->symlinkPath);
 
        if (is_link($dest)) {
            if (readlink($dest) === $src) {
                return;
            }
            Batch::removeSymlink($dest);
        } elseif (file_exists($dest)) {
            if (is_dir($dest)) {
                Log::error('Cannot create symlink: a real directory exists at the destination: ' . $dest);
 
                return;
            }
            Log::warning('Removing file at symlink location: ' . $dest);
            if (!@unlink($dest)) {
                Log::error('Failed to remove file at symlink location: ' . $dest);
 
                return;
            }
        }
 
        Batch::createSymlink($src, $dest);
    }

References Batch\createSymlink(), Log\error(), Path\formatWindowsPath(), Batch\removeSymlink(), and Log\warning().

Referenced by Module\reload().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteCurrentSymlinks()

deleteCurrentSymlinks ( )

static

Deletes all symbolic links listed in the arrayOfCurrents. Logs each operation's success or failure.

This method iterates over a predefined list of symbolic link paths and attempts to delete each one. Uses strict safety checks to prevent accidental deletion of user data:

• Only deletes symlinks or empty directories
• Validates all paths are within Bearsampp managed directories
• Refuses to perform recursive deletion
• Does not follow or delete junction points with content

@global Root $bearsamppRoot The root object providing access to system paths. @global Core $bearsamppCore The core object providing core functionalities.

Definition at line 264 of file class.symlinks.php.

    {
        global $bearsamppRoot, $bearsamppCore;
 
        // Check to see if purging is necessary
        $appsPath  = Path::getAppsPath();
        $binPath   = Path::getBinPath();
        $toolsPath = Path::getToolsPath();
 
        $array = [
            self::APACHE_SYMLINK      => $binPath . '/apache/current',
            self::BRUNO_SYMLINK       => $toolsPath . '/bruno/current',
            self::COMPOSER_SYMLINK    => $toolsPath . '/composer/current',
            self::GHOSTSCRIPT_SYMLINK => $toolsPath . '/ghostscript/current',
            self::GIT_SYMLINK         => $toolsPath . '/git/current',
            self::MAILPIT_SYMLINK     => $binPath . '/mailpit/current',
            self::MARIADB_SYMLINK     => $binPath . '/mariadb/current',
            self::MEMCACHED_SYMLINK   => $binPath . '/memcached/current',
            self::MYSQL_SYMLINK       => $binPath . '/mysql/current',
            self::NGROK_SYMLINK       => $toolsPath . '/ngrok/current',
            self::NODEJS_SYMLINK      => $binPath . '/nodejs/current',
            self::PERL_SYMLINK        => $toolsPath . '/perl/current',
            self::PHP_SYMLINK         => $binPath . '/php/current',
            self::PHPMYADMIN_SYMLINK  => $appsPath . '/phpmyadmin/current',
            self::PHPPGADMIN_SYMLINK  => $appsPath . '/phppgadmin/current',
            self::POSTGRESQL_SYMLINK  => $binPath . '/postgresql/current',
            self::POWERSHELL_SYMLINK  => $toolsPath . '/powershell/current',
            self::PYTHON_SYMLINK      => $toolsPath . '/python/current',
            self::RUBY_SYMLINK        => $toolsPath . '/ruby/current',
            self::XLIGHT_SYMLINK      => $binPath . '/xlight/current',
        ];
 
        // Fix for PHP 8.2: Add null checks before accessing array elements
        if (!is_array($array) || empty($array)) {
            Log::error('Current symlinks array is not initialized or empty.');
 
            return;
        }
 
        // Purge "current" symlinks with safety checks
        foreach ($array as $name => $path) {
            // Skip if path is null
            if (empty($path)) {
                continue;
            }
 
            if (!file_exists($path) && !is_link($path)) {
                // Log that the symlink was already missing
                Log::trace('Symlink already deleted or missing: ' . $path);
                continue;
            }
 
            // Use safe removal method with path validation and non-recursive guarantees
            self::safeRemoveSymlink($path);
        }
    }

References $bearsamppCore, $bearsamppRoot, Log\error(), Path\getAppsPath(), Path\getBinPath(), Path\getToolsPath(), safeRemoveSymlink(), and Log\trace().

Referenced by ActionQuit\processWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

initializePaths()

initializePaths ( )

static

Initializes paths for symlinks. This is called by the constructor or can be called manually.

Definition at line 62 of file class.symlinks.php.

    {
        // Path initialization logic can be added here if needed
        // For now, it's a placeholder as requested by the issue to restore it.
    }

Referenced by __construct().

Here is the caller graph for this function:

isPathWithinAllowedBase()

isPathWithinAllowedBase ( $path )

staticprivate

Validates that a path is within allowed symlink directories. Prevents deletion of paths outside the Bearsampp managed directories.

Parameters

string

$path

The path to validate

Returns

bool True if path is within allowed directories, false otherwise

Definition at line 132 of file class.symlinks.php.

    {
        global $bearsamppRoot;
 
        // Normalize paths for comparison
        $normalizedPath = realpath($path);
        if ($normalizedPath === false) {
            Log::error('Failed to resolve path: ' . $path);
 
            return false;
        }
 
        $allowedBases = [
            realpath(Path::getAppsPath()),
            realpath(Path::getBinPath()),
            realpath(Path::getToolsPath())
        ];
 
        foreach ($allowedBases as $base) {
            if ($base === false) {
                continue;
            }
 
            // Ensure path starts with allowed base (with directory separator to prevent substring matches)
            if (strpos($normalizedPath, $base . DIRECTORY_SEPARATOR) === 0 ||
                $normalizedPath === $base) {
                return true;
            }
        }
 
        Log::error('Path is outside allowed symlink directories: ' . $path);
 
        return false;
    }

References $bearsamppRoot, Log\error(), Path\getAppsPath(), Path\getBinPath(), and Path\getToolsPath().

Here is the call graph for this function:

isSkippingSymlinkCreation()

isSkippingSymlinkCreation ( )

static

Check if symlink creation is being skipped

Returns

bool True if symlink creation is skipped

Definition at line 86 of file class.symlinks.php.

                                                      : bool
    {
        return self::$skipSymlinkCreation;
    }

Referenced by Module\reload().

Here is the caller graph for this function:

isSymlink()

isSymlink ( $path )

staticprivate

Checks if a path is a symlink (not following the link). Uses lstat to avoid following symlinks.

Parameters

string

$path

The path to check

Returns

bool True if path is a symlink, false otherwise

Definition at line 175 of file class.symlinks.php.

    {
        return is_link($path);
    }

safeRemoveSymlink()

safeRemoveSymlink ( $path )

static

Safely removes a symlink or directory. CRITICAL: Use with caution as it may perform recursive deletion if the path is a directory.

Parameters

string

$path

The path to remove

Returns

bool True on success, false on failure

Definition at line 188 of file class.symlinks.php.

    {
        // Validate path is within allowed directories
        if (!self::isPathWithinAllowedBase($path)) {
            Log::error('Symlink removal blocked - path not in allowed directories: ' . $path);
 
            return false;
        }
 
        // Check if path exists
        if (!file_exists($path) && !self::isSymlink($path)) {
            Log::trace('Symlink or directory already deleted or missing: ' . $path);
 
            return false;
        }
 
        // If it's a directory (including junctions/directory-symlinks), use rmdir
        if (is_dir($path)) {
            // Attempt to remove as a symlink/junction first (non-recursive)
            if (@rmdir($path)) {
                Log::debug('Safely removed directory symlink/junction: ' . $path);
 
                return true;
            }
 
            // If it failed and it's NOT a link, it's a real directory with content.
            // We MUST NOT recursively delete it to avoid data loss.
            if (!self::isSymlink($path)) {
                Log::error('Symlink removal blocked - path is a real directory with content: ' . $path);
 
                return false;
            } else {
                // If it's a link but rmdir failed, try unlink (e.g. file symlink)
                if (@unlink($path)) {
                    Log::debug('Safely removed symlink via unlink: ' . $path);
 
                    return true;
                }
            }
        }
 
        // If it's a symlink but not a directory (e.g. file symlink), or if rmdir failed
        if (self::isSymlink($path)) {
            if (@unlink($path) || @rmdir($path)) {
                Log::debug('Safely removed symlink: ' . $path);
 
                return true;
            }
        }
 
        if (self::isSymlink($path)) {
            Log::error('Failed to remove symlink: ' . $path);
 
            return false;
        }
 
        // Regular files should not be deleted here
        Log::warning('Path is a regular file, not a symlink - refusing deletion: ' . $path);
 
        return false;
    }

References Log\debug(), Log\error(), Log\trace(), and Log\warning().

Referenced by deleteCurrentSymlinks(), and ActionQuit\verifySymlinksRemoved().

Here is the call graph for this function:

Here is the caller graph for this function:

setSkipSymlinkCreation()

setSkipSymlinkCreation ( bool $skip )

static

Skip symlink creation during module reload Useful for performance optimization during service checking phase

Parameters

bool

$skip

True to skip symlink creation

Returns

void

Definition at line 76 of file class.symlinks.php.

                                                             : void
    {
        self::$skipSymlinkCreation = $skip;
    }

Referenced by ActionStartup\installServicesSequential().

Here is the caller graph for this function:

Field Documentation

$root

$root

staticprivate

Definition at line 45 of file class.symlinks.php.

Referenced by __construct().

$skipSymlinkCreation

$skipSymlinkCreation = false

staticprivate

Definition at line 40 of file class.symlinks.php.

APACHE_SYMLINK

const APACHE_SYMLINK = 'apache'

Definition at line 16 of file class.symlinks.php.

BRUNO_SYMLINK

const BRUNO_SYMLINK = 'bruno'

Definition at line 17 of file class.symlinks.php.

COMPOSER_SYMLINK

const COMPOSER_SYMLINK = 'composer'

Definition at line 18 of file class.symlinks.php.

GHOSTSCRIPT_SYMLINK

const GHOSTSCRIPT_SYMLINK = 'ghostscript'

Definition at line 19 of file class.symlinks.php.

GIT_SYMLINK

const GIT_SYMLINK = 'git'

Definition at line 20 of file class.symlinks.php.

MAILPIT_SYMLINK

const MAILPIT_SYMLINK = 'mailpit'

Definition at line 21 of file class.symlinks.php.

MARIADB_SYMLINK

const MARIADB_SYMLINK = 'mariadb'

Definition at line 22 of file class.symlinks.php.

MEMCACHED_SYMLINK

const MEMCACHED_SYMLINK = 'memcached'

Definition at line 23 of file class.symlinks.php.

MYSQL_SYMLINK

const MYSQL_SYMLINK = 'mysql'

Definition at line 24 of file class.symlinks.php.

NGROK_SYMLINK

const NGROK_SYMLINK = 'ngrok'

Definition at line 25 of file class.symlinks.php.

NODEJS_SYMLINK

const NODEJS_SYMLINK = 'nodejs'

Definition at line 26 of file class.symlinks.php.

PERL_SYMLINK

const PERL_SYMLINK = 'perl'

Definition at line 27 of file class.symlinks.php.

PHP_SYMLINK

const PHP_SYMLINK = 'php'

Definition at line 28 of file class.symlinks.php.

PHPMYADMIN_SYMLINK

const PHPMYADMIN_SYMLINK = 'phpmyadmin'

Definition at line 29 of file class.symlinks.php.

PHPPGADMIN_SYMLINK

const PHPPGADMIN_SYMLINK = 'phppgadmin'

Definition at line 30 of file class.symlinks.php.

POSTGRESQL_SYMLINK

const POSTGRESQL_SYMLINK = 'postgresql'

Definition at line 31 of file class.symlinks.php.

POWERSHELL_SYMLINK

const POWERSHELL_SYMLINK = 'powershell'

Definition at line 32 of file class.symlinks.php.

PYTHON_SYMLINK

const PYTHON_SYMLINK = 'python'

Definition at line 33 of file class.symlinks.php.

RUBY_SYMLINK

const RUBY_SYMLINK = 'ruby'

Definition at line 34 of file class.symlinks.php.

XLIGHT_SYMLINK

const XLIGHT_SYMLINK = 'xlight'

Definition at line 35 of file class.symlinks.php.

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/classes/class.symlinks.php