QuickPick Class Reference

Public Member Functions
	__construct ()
	checkDownloadId ()
	checkQuickpickJson ()
	fetchAndUnzipModule (string $moduleUrl, string $module)
	getErrorModal (string $errorMessage)
	getModuleDestinationPath (string $moduleType, string $moduleName)
	getModules ()
	getModuleUrl (string $module, string $version)
	getQuickpickJson ()
	getQuickpickMenu (array $modules, array $versions, string $imagesPath)
	getVersions ()
	installModule (string $module, string $version)
	loadQuickpick (string $imagesPath)
	normalizeModuleName (string $moduleName)
	rebuildQuickpickJson ()

Data Fields
	$modules

Private Member Functions
	formatVersionLabel ($version, $isPrerelease=false)
	getLocalFileCreationTime ()
	isValidHeaderResponse ($headers)
	logHeaders (array $headers)
	regenerateMenuSafe ()
	updateModuleConfig (string $module, string $version)

Private Attributes
	$jsonFilePath
	$versions = []

Detailed Description

Class QuickPick

The QuickPick class provides functionalities for managing and installing various modules within the Bearsampp application. It includes methods for retrieving available modules, fetching module versions, parsing release properties, and validating license keys.

Definition at line 18 of file class.action.quickPick.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructor to initialize the jsonFilePath.

Definition at line 69 of file class.action.quickPick.php.

    {
        global $bearsamppCore;
        $this->jsonFilePath = $bearsamppCore->getResourcesPath() . '/quickpick-releases.json';
    }

References $bearsamppCore.

Member Function Documentation

checkDownloadId()

checkDownloadId

(

)

Validates the format of a given username key by checking it against an external API.

This method performs several checks to ensure the validity of the username key:

1. Logs the method call.
2. Ensures the global configuration is available.
3. Retrieves the username key from the global configuration.
4. Ensures the username key is not empty.
5. Constructs the API URL using the username key.
6. Fetches the API response.
7. Decodes the JSON response.
8. Validates the response data.

Returns

bool True if the username key is valid, false otherwise.

Definition at line 372 of file class.action.quickPick.php.

                                     : bool
    {
        global $bearsamppConfig;
 
        Util::logDebug( 'checkDownloadId method called.' );
 
        // Ensure the global config is available
        if ( !isset( $bearsamppConfig ) ) {
            Util::logError( 'Global configuration is not set.' );
 
            return false;
        }
 
        $DownloadId = $bearsamppConfig->getDownloadId();
        Util::logDebug( 'DownloadId is: ' . $DownloadId );
 
        // Ensure the license key is not empty
        if ( empty( $DownloadId ) ) {
            Util::logError( 'License key is empty.' );
 
            return false;
        }
 
        $url = QUICKPICK_API_URL . QUICKPICK_API_KEY . '&download_id=' . $DownloadId;
        Util::logDebug( 'API URL: ' . $url );
 
        // Attempt to fetch the API response
        // Note: If this fails, PHP will generate a warning which will be logged by the error handler
        // This is expected behavior when the API server is unavailable
        $response = file_get_contents( $url );
 
        // Check if the response is false
        if ( $response === false ) {
            Util::logError( 'Failed to validate QuickPick license - API server unavailable' );
            return false;
        }
 
        Util::logDebug( 'API response: ' . $response );
 
        $data = json_decode( $response, true );
 
        // Check if the JSON decoding was successful
        if ( json_last_error() !== JSON_ERROR_NONE ) {
            Util::logError( 'Error decoding JSON response: ' . json_last_error_msg() );
 
            return false;
        }
 
        // Validate the response data
        if ( isset( $data['success'] ) && $data['success'] === true && isset( $data['data'] ) && is_array( $data['data'] ) && count( $data['data'] ) > 0 ) {
            Util::logDebug( 'License key valid: ' . $DownloadId );
 
            return true;
        }
 
        Util::logError( 'Invalid license key: ' . $DownloadId );
 
        return false;
    }

References $bearsamppConfig, $response, Util\logDebug(), Util\logError(), QUICKPICK_API_KEY, and QUICKPICK_API_URL.

Referenced by getQuickpickMenu().

checkQuickpickJson()

checkQuickpickJson

(

)

Checks if the local quickpick-releases.json file is up-to-date with the remote version.

Compares the creation time of the local JSON file with the remote file's last modified time. If the remote file is newer or the local file does not exist, it fetches the latest JSON data by calling the rebuildQuickpickJson method.

Returns

array|false Returns the JSON data if the remote file is newer or the local file does not exist, otherwise returns false.

Exceptions

Exception

Definition at line 164 of file class.action.quickPick.php.

    {
        global $bearsamppConfig;
 
        // Determine local file creation time or rebuild if missing
        $localFileCreationTime = $this->getLocalFileCreationTime();
 
        // Attempt to retrieve remote file headers
        $headers = get_headers(QUICKPICK_JSON_URL, 1);
        if (!$this->isValidHeaderResponse($headers)) {
            // If headers or Date are invalid, assume no update needed
            return false;
        }
 
        // Optionally log headers for verbose output
        $this->logHeaders($headers);
 
        // Compare the creation times (remote vs. local)
        $remoteFileCreationTime = strtotime(isset($headers['Date']) ? $headers['Date'] : '');
        if ($remoteFileCreationTime > $localFileCreationTime) { return $this->rebuildQuickpickJson(); }
 
        // Return false if local file is already up-to-date
        return false;
    }

References $bearsamppConfig, getLocalFileCreationTime(), isValidHeaderResponse(), logHeaders(), QUICKPICK_JSON_URL, and rebuildQuickpickJson().

Referenced by loadQuickpick().

fetchAndUnzipModule()

fetchAndUnzipModule	(	string	$moduleUrl,
		string	$module )

Fetches the module URL and stores it in /tmp, then unzips the file based on its extension.

Parameters

string	$moduleUrl	The URL of the module to fetch.
string	$module	The name of the module.

Returns

array An array containing the status and message.

Definition at line 526 of file class.action.quickPick.php.

                                                                          : array
{
    Util::logDebug("$module is: " . $module);
 
    global $bearsamppRoot, $bearsamppCore;
    $tmpDir = $bearsamppRoot->getTmpPath();
    Util::logDebug('Temporary Directory: ' . $tmpDir);
 
    $fileName = basename($moduleUrl);
    Util::logDebug('File Name: ' . $fileName);
 
    $tmpFilePath = $tmpDir . '/' . $fileName;
    Util::logDebug('File Path: ' . $tmpFilePath);
 
    $moduleName = str_replace('module-', '', $module);
    Util::logDebug('Module Name: ' . $moduleName);
 
    // Find the correct module key by searching through the modules array
    // This handles proper capitalization for all module types
    $moduleKey = null;
    foreach ($this->modules as $key => $moduleInfo) {
        if (strtolower($key) === strtolower($moduleName)) {
            $moduleKey = $key;
            break;
        }
    }
    
    if (!$moduleKey) {
        Util::logError("Module not found in modules array: $moduleName");
        return ['error' => 'Module configuration not found'];
    }
    
    $moduleType = $this->modules[$moduleKey]['type'];
    Util::logDebug('Module Type: ' . $moduleType);
 
    // Get module type
    $destination = $this->getModuleDestinationPath($moduleType, $moduleName);
    Util::logDebug('Destination: ' . $destination);
 
    // Retrieve the file path from the URL using the bearsamppCore module,
    // passing the module URL and temporary file path, with the use Progress Bar parameter set to true.
    $result = $bearsamppCore->getFileFromUrl($moduleUrl, $tmpFilePath, true);
 
    // Check if $result is false
    if ($result === false) {
        Util::logError('Failed to retrieve file from URL: ' . $moduleUrl);
        return ['error' => 'Failed to retrieve file from URL'];
    }
 
    // Determine the file extension and call the appropriate unzipping function
    $fileExtension = pathinfo($tmpFilePath, PATHINFO_EXTENSION);
    Util::logDebug('File extension: ' . $fileExtension);
 
    if ($fileExtension === '7z' || $fileExtension === 'zip') {
        // Send phase indicator for extraction
        echo json_encode(['phase' => 'extracting']);
        if (ob_get_length()) {
            ob_flush();
        }
        flush();
 
        $unzipResult = $bearsamppCore->unzipFile($tmpFilePath, $destination, function ($currentPercentage) {
            echo json_encode(['progress' => "$currentPercentage%"]);
            if (ob_get_length()) {
                ob_flush();
            }
            flush();
        });
 
        if ($unzipResult === false) {
            return ['error' => 'Failed to unzip file. File: ' . $tmpFilePath . ' could not be unzipped', 'Destination: ' . $destination];
        }
    } else {
        Util::logError('Unsupported file extension: ' . $fileExtension);
        return ['error' => 'Unsupported file extension'];
    }
 
    return ['success' => 'Module installed successfully'];
}

References $bearsamppCore, $bearsamppRoot, $result, getModuleDestinationPath(), Util\logDebug(), and Util\logError().

Referenced by installModule().

formatVersionLabel()

formatVersionLabel ( $version, $isPrerelease = false )

private

Format version label with PR indicator if it's a prerelease

Parameters

string	$version	The version to format
bool	$isPrerelease	Whether this version is a prerelease

Returns

string Formatted version string

Definition at line 82 of file class.action.quickPick.php.

                                                                       {
        global $bearsamppConfig;
        $includePr = $bearsamppConfig->getIncludePr();
 
        if ($isPrerelease && $includePr == 1) {
            return '<span class="text-danger">' . htmlspecialchars($version) . ' PR</span>';
        }
 
        return htmlspecialchars($version);
    }

References $bearsamppConfig.

getErrorModal()

getErrorModal

(

string

$errorMessage

)

Generates an error modal for configuration validation failures.

Parameters

string

$errorMessage

The error message to display.

Returns

string The HTML content of the error modal.

Definition at line 733 of file class.action.quickPick.php.

                                                       : string
    {
        ob_start();
        ?>
        <div id="configErrorContainer" class="text-center mt-3 pe-3">
            <div class="alert alert-danger d-inline-block" role="alert" style="max-width: 500px;">
                <h4 class="alert-heading">
                    <i class="fas fa-exclamation-circle"></i> Configuration Error
                </h4>
                <hr>
                <p class="mb-0">
                    <?php echo htmlspecialchars($errorMessage); ?>
                </p>
                <hr>
                <small class="text-muted">
                    Please add the missing parameter to the <code>bearsampp.conf</code> file in the Bearsampp root directory.
                </small>
            </div>
        </div>
        <?php
        return ob_get_clean();
    }

Referenced by loadQuickpick().

getLocalFileCreationTime()

getLocalFileCreationTime ( )

private

Returns the local file's creation time, or triggers and returns 0 if file does not exist.

Returns

int Local file's creation time or 0 if the file doesn't exist.

Definition at line 194 of file class.action.quickPick.php.

    {
        if (!file_exists($this->jsonFilePath)) {
            // If local file is missing, rebuild it immediately
            $this->rebuildQuickpickJson();
            return 0;
        }
        return filectime($this->jsonFilePath);
    }

References rebuildQuickpickJson().

Referenced by checkQuickpickJson().

getModuleDestinationPath()

getModuleDestinationPath	(	string	$moduleType,
		string	$moduleName )

Get the destination path for a given module type and name.

This method constructs the destination path based on the type of module (application, binary, or tools) and the module name. It utilizes the bearsamppRoot global object to retrieve the base paths for each module type.

Parameters

string	$moduleType	The type of the module ('application', 'binary', or 'tools').
string	$moduleName	The name of the module.

Returns

string The constructed destination path for the module.

Definition at line 618 of file class.action.quickPick.php.

    {
        global $bearsamppRoot;
        if ( $moduleType === 'application' ) {
            $destination = $bearsamppRoot->getAppsPath() . '/' . strtolower( $moduleName ) . '/';
        }
        elseif ( $moduleType === 'binary' ) {
            $destination = $bearsamppRoot->getBinPath() . '/' . strtolower( $moduleName ) . '/';
        }
        elseif ( $moduleType === 'tools' ) {
            $destination = $bearsamppRoot->getToolsPath() . '/' . strtolower( $moduleName ) . '/';
        }
        else {
            $destination = '';
        }
 
        return $destination;
    }

References $bearsamppRoot.

Referenced by fetchAndUnzipModule().

getModules()

getModules

(

)

Retrieves the list of available modules.

Returns

array An array of module names.

Definition at line 121 of file class.action.quickPick.php.

                                : array
    {
        return array_keys( $this->modules );
    }

Referenced by loadQuickpick().

getModuleUrl()

getModuleUrl	(	string	$module,
		string	$version )

Fetches the URL of a specified module version from the local quickpick-releases.json file.

This method reads the quickpick-releases.json file to find the URL associated with the given module and version. It logs the process and returns the URL if found, or an error message if not.

Parameters

string	$module	The name of the module.
string	$version	The version of the module.

Returns

string|array The URL of the specified module version or an error message if the version is not found.

Definition at line 340 of file class.action.quickPick.php.

    {
        $this->getVersions();
        Util::logDebug( 'getModuleUrl called for module: ' . $module . ' version: ' . $version );
        $url = trim( $this->versions['module-' . strtolower( $module )][$version]['url'] );
        if ( $url <> '' ) {
            Util::logDebug( 'Found URL for version: ' . $version . ' URL: ' . $url );
 
            return $url;
        }
        else {
            Util::logError( 'Version not found: ' . $version );
 
            return ['error' => 'Version not found'];
        }
    }

References getVersions(), Util\logDebug(), and Util\logError().

Referenced by installModule().

getQuickpickJson()

getQuickpickJson

(

)

Retrieves the QuickPick JSON data from the local file.

Returns

array The decoded JSON data, or an error message if the file cannot be fetched or decoded.

Definition at line 238 of file class.action.quickPick.php.

                                      : array
    {
        $content = @file_get_contents( $this->jsonFilePath );
        if ( $content === false ) {
            Util::logError( 'Error fetching content from JSON file: ' . $this->jsonFilePath );
 
            return ['error' => 'Error fetching JSON file'];
        }
 
        $data = json_decode( $content, true );
        if ( json_last_error() !== JSON_ERROR_NONE ) {
            Util::logError( 'Error decoding JSON content: ' . json_last_error_msg() );
 
            return ['error' => 'Error decoding JSON content'];
        }
 
        return $data;
    }

References Util\logError().

Referenced by getVersions().

getQuickpickMenu()

getQuickpickMenu	(	array	$modules,
		array	$versions,
		string	$imagesPath )

Generates the HTML content for the QuickPick menu.

This method creates the HTML structure for the QuickPick interface, including a dropdown for selecting modules and their respective versions. It checks if the license key is valid before displaying the modules. If the license key is invalid, it displays a subscription prompt. If there is no internet connection, it displays a message indicating the lack of internet.

Parameters

array	$modules	An array of available modules.
array	$versions	An associative array where the key is the module name and the value is an array containing the module versions.
string	$imagesPath	The path to the images directory.

Returns

string The HTML content of the QuickPick menu.

Definition at line 770 of file class.action.quickPick.php.

                                                                                         : string
    {
        global $bearsamppConfig;
        $includePr = $bearsamppConfig->getIncludePr();
        $enhancedMode = $bearsamppConfig->getEnhancedQuickPick();
 
        ob_start();
        if ( Util::checkInternetState() ) {
 
            // Check if the license key is valid
            if ( $this->checkDownloadId() ): ?>
                <div id = 'quickPickContainer'>
                    <div class = 'quickpick'>
 
                        <div class = "custom-select">
                            <button class = "select-button" role = "combobox"
                                    aria-label = "select button"
                                    aria-haspopup = "listbox"
                                    aria-expanded = "false"
                                    aria-controls = "select-dropdown">
                                <span class = "selected-value">Select a module and version</span>
                                <span class = "arrow"></span>
                            </button>
                            <ul class = "select-dropdown" role = "listbox" id = "select-dropdown">
 
                                <?php
                                foreach ( $modules as $module ): ?>
                                    <?php if ( is_string( $module ) ): ?>
                                        <li role = "option" class = "moduleheader">
                                            <?php echo htmlspecialchars( $module ); ?>
                                        </li>
 
                                        <?php
                                        foreach ( $versions['module-' . strtolower( $module )] as $version_array ):
                                            // Skip prerelease versions if includePr is not enabled
                                            if (isset($version_array['prerelease']) && $version_array['prerelease'] === true && $includePr != 1) {
                                                continue;
                                            }
                                        ?>
                                            <li role = "option" class = "moduleoption"
                                                id = "<?php echo htmlspecialchars( $module ); ?>-version-<?php echo htmlspecialchars( $version_array['version'] ); ?>-li">
                                                <input type = "radio"
                                                       id = "<?php echo htmlspecialchars( $module ); ?>-version-<?php echo htmlspecialchars( $version_array['version'] ); ?>"
                                                       name = "module" data-module = "<?php echo htmlspecialchars( $module ); ?>"
                                                       data-value = "<?php echo htmlspecialchars( $version_array['version'] ); ?>">
                                                <label
                                                    for = "<?php echo htmlspecialchars( $module ); ?>-version-<?php echo htmlspecialchars( $version_array['version'] ); ?>"><?php echo $this->formatVersionLabel( $version_array['version'], isset($version_array['prerelease']) && $version_array['prerelease'] === true ); ?></label>
                                            </li>
                                        <?php endforeach; ?>
                                    <?php endif; ?>
                                <?php endforeach; ?>
                            </ul>
                        </div>
                    </div>
                    <div class = "progress " id = "progress" tabindex = "-1" style = "width:260px;display:none"
                         aria-labelledby = "progressbar" aria-hidden = "true">
                        <div class = "progress-bar progress-bar-striped progress-bar-animated" id = "progress-bar" role = "progressbar" aria-valuenow = "0" aria-valuemin = "0"
                             aria-valuemax = "100" data-module = "Module"
                             data-version = "0.0.0">0%
                        </div>
                        <div id = "download-module" style = "display: none">ModuleName</div>
                        <div id = "download-version" style = "display: none">Version</div>
                    </div>
                </div>
            <?php else: ?>
                <div id = "subscribeContainer" class = "text-center mt-3 pe-3">
                    <a href = "<?php echo Util::getWebsiteUrl( 'subscribe' ); ?>" class = "btn btn-dark d-inline-flex align-items-center">
                        <img src = "<?php echo $imagesPath . 'subscribe.svg'; ?>" alt = "Subscribe Icon" class = "me-2">
                        Subscribe to QuickPick now
                    </a>
                </div>
            <?php endif;
        }
        else {
            ?>
            <div id = "InternetState" class = "text-center mt-3 pe-3">
                <img src = "<?php echo $imagesPath . 'no-wifi-icon.svg'; ?>" alt = "No Wifi Icon" class = "me-2">
                <span>No internet present</span>
            </div>
            <?php
        }
 
        return ob_get_clean();
    }

References $bearsamppConfig, $enhancedMode, $imagesPath, $modules, $versions, checkDownloadId(), Util\checkInternetState(), and Util\getWebsiteUrl().

Referenced by loadQuickpick().

getVersions()

getVersions

(

)

Retrieves the list of available versions for all modules.

This method fetches the QuickPick JSON data and returns an array of versions or If no versions are found, an error message is logged and returned.

Returns

array An array of version strings for the specified module, or an error message if no versions are found.

Definition at line 295 of file class.action.quickPick.php.

                                 : array
    {
        Util::logDebug( 'Versions called' );
 
        $versions = [];
 
        $jsonData = $this->getQuickpickJson();
 
        foreach ( $jsonData as $entry ) {
            if ( is_array( $entry ) ) {
                if ( isset( $entry['module'] ) && is_string( $entry['module'] ) ) {
                    if ( isset( $entry['versions'] ) && is_array( $entry['versions'] ) ) {
                        $versions[$entry['module']] = array_column( $entry['versions'], null, 'version' );
                    }
                }
            }
            else {
                Util::logError( 'Invalid entry format in JSON data' );
            }
        }
 
        if ( empty( $versions ) ) {
            Util::logError( 'No versions found' );
 
            return ['error' => 'No versions found'];
        }
 
        Util::logDebug( 'Found versions' );
 
        $this->versions = $versions;
 
        return $versions;
    }

References $versions, getQuickpickJson(), Util\logDebug(), and Util\logError().

Referenced by getModuleUrl(), and loadQuickpick().

installModule()

installModule	(	string	$module,
		string	$version )

Installs a specified module by fetching its URL and unzipping its contents.

This method retrieves the URL of the specified module and version from the QuickPick JSON data. If the URL is found, it fetches and unzips the module. If the URL is not found, it logs an error and returns an error message.

Parameters

string	$module	The name of the module to install.
string	$version	The version of the module to install.

Returns

array An array containing the status and message of the installation process. If successful, it returns the response from the fetchAndUnzipModule method. If unsuccessful, it returns an error message indicating the issue.

Definition at line 446 of file class.action.quickPick.php.

                                                                  : array
    {
        // Find the module URL and module name from the data
        $moduleUrl = $this->getModuleUrl( $module, $version );
 
        if ( is_array( $moduleUrl ) && isset( $moduleUrl['error'] ) ) {
            Util::logError( 'Module URL not found for module: ' . $module . ' version: ' . $version );
 
            return ['error' => 'Module URL not found'];
        }
 
        if ( empty( $moduleUrl ) ) {
            Util::logError( 'Module URL not found for module: ' . $module . ' version: ' . $version );
 
            return ['error' => 'Module URL not found'];
        }
 
        $state = Util::checkInternetState();
        if ( $state ) {
            $response = $this->fetchAndUnzipModule( $moduleUrl, $module );
            Util::logDebug( 'Response is: ' . print_r( $response, true ) );
 
            // Check if enhanced mode is enabled
            global $bearsamppConfig;
            $enhancedMode = $bearsamppConfig->getEnhancedQuickPick();
            
            Util::logDebug('Enhanced mode: ' . ($enhancedMode ? 'enabled' : 'disabled'));
            
            // If installation was successful and enhanced mode is enabled, update config
            if (isset($response['success']) && $enhancedMode == 1) {
                // Step 1: Update config FIRST (so reload can pick up the new version)
                Util::logDebug('Enhanced mode enabled - Updating config for module: ' . $module . ' version: ' . $version);
                $configUpdated = $this->updateModuleConfig($module, $version);
                
                if ($configUpdated) {
                    // Step 2: Trigger reload AFTER config update (reload will apply the new version)
                    Util::logDebug('Config updated successfully, triggering reload to apply changes...');
                    
                    // Send progress update to user - temporarily stop output buffering
                    $obLevel = ob_get_level();
                    while (ob_get_level() > 0) {
                        ob_end_flush();
                    }
                    
                    echo json_encode(['phase' => 'updating', 'message' => 'Updating system configuration...']);
                    flush();
                    
                    // Restart output buffering
                    for ($i = 0; $i < $obLevel; $i++) {
                        ob_start();
                    }
                    
                    // Note: User must manually reload from tray menu to activate the new version
                    Util::logDebug('Installation complete - user must manually reload from tray menu');
                    $response['reload_required'] = true;
                } else {
                    Util::logError('Config update failed for module: ' . $module);
                    $response['reload_triggered'] = false;
                }
            } else if (isset($response['success']) && $enhancedMode == 0) {
                Util::logDebug('Enhanced mode disabled - skipping config update');
            }
 
            return $response;
        }
        else {
            Util::logError( 'No internet connection available.' );
 
            return ['error' => 'No internet connection'];
        }
    }

References $bearsamppConfig, $enhancedMode, $response, Util\checkInternetState(), fetchAndUnzipModule(), getModuleUrl(), Util\logDebug(), Util\logError(), and updateModuleConfig().

isValidHeaderResponse()

isValidHeaderResponse ( $headers )

private

Determines whether the header response is valid and includes a 'Date' key.

Parameters

mixed

$headers

Headers retrieved from get_headers().

Returns

bool True if headers are valid and contain 'Date', false otherwise.

Definition at line 210 of file class.action.quickPick.php.

                                                    : bool
    {
        // If headers retrieval failed or Date is not set, return false
        if ($headers === false || !isset($headers['Date'])) {
            return false;
        }
        return true;
    }

Referenced by checkQuickpickJson().

loadQuickpick()

loadQuickpick

(

string

$imagesPath

)

Loads the QuickPick interface with the available modules and their versions.

Parameters

string

$imagesPath

The path to the images directory.

Returns

string The HTML content of the QuickPick interface.

Exceptions

Exception

Definition at line 135 of file class.action.quickPick.php.

                                                     : string
    {
        global $bearsamppConfig;
 
        // Validate EnhancedQuickPick parameter
        $validation = $bearsamppConfig->validateEnhancedQuickPick();
        if (!$validation['valid']) {
            return $this->getErrorModal($validation['error']);
        }
 
        $this->checkQuickpickJson();
 
        $modules  = $this->getModules();
        $versions = $this->getVersions();
 
        return $this->getQuickpickMenu( $modules, $versions, $imagesPath );
    }

References $bearsamppConfig, $imagesPath, $modules, $versions, checkQuickpickJson(), getErrorModal(), getModules(), getQuickpickMenu(), and getVersions().

logHeaders()

logHeaders ( array $headers )

private

Logs the headers in debug mode if logsVerbose is set to 2.

Parameters

array

$headers

The headers returned by get_headers().

Definition at line 224 of file class.action.quickPick.php.

                                               : void
    {
        global $bearsamppConfig;
 
        if ($bearsamppConfig->getLogsVerbose() === 2) {
            Util::logDebug('Headers: ' . print_r($headers, true));
        }
    }

References $bearsamppConfig, and Util\logDebug().

Referenced by checkQuickpickJson().

normalizeModuleName()

normalizeModuleName

(

string

$moduleName

)

Normalizes a module name to find the correct module key from the modules array. Handles case-insensitive matching for all module types.

Parameters

string

$moduleName

The module name to normalize (may include 'module-' prefix)

Returns

string|null The correctly capitalized module key, or null if not found

Definition at line 100 of file class.action.quickPick.php.

                                                           : ?string
    {
        // Remove 'module-' prefix if present
        $moduleName = str_replace('module-', '', $moduleName);
        
        // Find the correct module key by searching through the modules array
        // This handles proper capitalization for all module types
        foreach ($this->modules as $key => $moduleInfo) {
            if (strtolower($key) === strtolower($moduleName)) {
                return $key;
            }
        }
        
        return null;
    }

rebuildQuickpickJson()

rebuildQuickpickJson

(

)

Rebuilds the local quickpick-releases.json file by fetching the latest data from the remote URL.

Returns

array An array containing the status and message of the rebuild process.

Exceptions

Exception

If the JSON content cannot be fetched or saved.

Definition at line 263 of file class.action.quickPick.php.

                                          : array
    {
        Util::logDebug( 'Fetching JSON file: ' . $this->jsonFilePath );
 
        // Fetch the JSON content from the URL
        $jsonContent = file_get_contents( QUICKPICK_JSON_URL );
 
        if ( $jsonContent === false ) {
            // Handle error if the file could not be fetched
            throw new Exception( 'Failed to fetch JSON content from the URL.' );
        }
 
        // Save the JSON content to the specified path
        $result = file_put_contents( $this->jsonFilePath, $jsonContent );
 
        if ( $result === false ) {
            // Handle error if the file could not be saved
            throw new Exception( 'Failed to save JSON content to the specified path.' );
        }
 
        // Return success message
        return ['success' => 'JSON content fetched and saved successfully'];
    }

References $result, Util\logDebug(), and QUICKPICK_JSON_URL.

Referenced by checkQuickpickJson(), and getLocalFileCreationTime().

regenerateMenuSafe()

regenerateMenuSafe ( )

private

Regenerates the bearsampp.ini menu file without VBS checks (AJAX-safe version). This is a simplified version of TplApp\process() that avoids VBS errors in web context.

Returns

string The generated INI content

Definition at line 643 of file class.action.quickPick.php.

                                         : string
    {
        Util::logDebug('Regenerating menu (AJAX-safe mode)...');
        
        // Suppress errors temporarily during menu generation
        $oldErrorReporting = error_reporting();
        error_reporting($oldErrorReporting & ~E_WARNING);
        
        try {
            // Generate the menu content
            $menuContent = TplApp::process();
            
            // Restore error reporting
            error_reporting($oldErrorReporting);
            
            Util::logDebug('Menu regenerated successfully');
            return $menuContent;
            
        } catch (Exception $e) {
            // Restore error reporting
            error_reporting($oldErrorReporting);
            
            Util::logWarning('Error during menu regeneration: ' . $e->getMessage());
            throw $e;
        }
    }

References Util\logDebug(), Util\logWarning(), and TplApp\process().

updateModuleConfig()

updateModuleConfig ( string $module, string $version )

private

Updates the bearsampp.conf configuration file with the new module version. This method handles all module types: binaries, apps, and tools.

Parameters

string	$module	The name of the module (e.g., 'Apache', 'PhpMyAdmin', 'Git').
string	$version	The version to set in the configuration.

Returns

bool True if the configuration was updated successfully, false otherwise.

Definition at line 679 of file class.action.quickPick.php.

                                                                        : bool
    {
        try {
            $bearsamppConfig = new Config();
            
            // Remove 'module-' prefix if present and normalize the module name
            $moduleName = str_replace('module-', '', $module);
            
            // Find the correct module key by searching through the modules array
            // This handles proper capitalization for all module types
            $moduleKey = null;
            foreach ($this->modules as $key => $moduleInfo) {
                if (strtolower($key) === strtolower($moduleName)) {
                    $moduleKey = $key;
                    break;
                }
            }
            
            if (!$moduleKey) {
                Util::logError("Module not found in modules array: $moduleName");
                return false;
            }
            
            $moduleType = $this->modules[$moduleKey]['type'];
            
            // Map module names to their config section names
            // For all types, use the lowercase name for the config key
            $configSection = strtolower($moduleKey);
            
            Util::logDebug("Updating config for module: $module (key: $moduleKey, type: $moduleType) to version: $version");
            Util::logDebug("Config section: $configSection");
            
            // Update the configuration file
            // The Config class expects a flat key like "nodejsVersion" not a section
            $configKey = $configSection . 'Version';
            $bearsamppConfig->replace($configKey, $version);
            
            Util::logInfo("Successfully updated $configSection version to $version in bearsampp.conf");
            
            return true;
            
        } catch (Exception $e) {
            Util::logError("Failed to update module config: " . $e->getMessage());
            return false;
        }
    }

References $bearsamppConfig, Util\logDebug(), Util\logError(), and Util\logInfo().

Referenced by installModule().

Field Documentation

$jsonFilePath

$jsonFilePath

private

The file path to the local quickpick-releases.json file.

Definition at line 64 of file class.action.quickPick.php.

$modules

$modules

Initial value:

                = [
    'Apache'      => ['type' => 'binary'],
    'Bruno'       => ['type' => 'tools'],
    'Composer'    => ['type' => 'tools'],
    'Ghostscript' => ['type' => 'tools'],
    'Git'         => ['type' => 'tools'],
    'Mailpit'     => ['type' => 'binary'],
    'MariaDB'     => ['type' => 'binary'],
    'Memcached'   => ['type' => 'binary'],
    'MySQL'       => ['type' => 'binary'],
    'Ngrok'       => ['type' => 'tools'],
    'NodeJS'      => ['type' => 'binary'],
    'Perl'        => ['type' => 'tools'],
    'PHP'         => ['type' => 'binary'],
    'PhpMyAdmin'  => ['type' => 'application'],
    'PhpPgAdmin'  => ['type' => 'application'],
    'PostgreSQL'  => ['type' => 'binary'],
    'PowerShell'  => ['type' => 'tools'],
    'Python'      => ['type' => 'tools'],
    'Ruby'        => ['type' => 'tools'],
    'Xlight'      => ['type' => 'binary']
]

An associative array where the key is the module name and the value is an array containing the module type. The module type can be one of the following:

• 'application'
• 'binary'
• 'tool'

Definition at line 29 of file class.action.quickPick.php.

Referenced by getQuickpickMenu(), and loadQuickpick().

$versions

$versions = []

private

An associative array where the key is the module name and the value is an array containing the module versions.

Definition at line 57 of file class.action.quickPick.php.

Referenced by getQuickpickMenu(), getVersions(), and loadQuickpick().

---

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

• E:/Bearsampp-development/sandbox/core/classes/actions/class.action.quickPick.php