class.winbinder.php

Go to the documentation of this file.

<?php
/*
 *
 *  * Copyright (c) 2022-2025 Bearsampp
 *  * License: GNU General Public License version 3 or later; see LICENSE.txt
 *  * Website: https://bearsampp.com
 *  * Github: https://github.com/Bearsampp
 *
 */

class WinBinder
{
    // Constants for control IDs and objects
    const CTRL_ID = 0;
    const CTRL_OBJ = 1;
 
    // Constants for progress bar increment and new line
    const INCR_PROGRESS_BAR = '++';
    const NEW_LINE = '@nl@';
 
    // Constants for message box types
    const BOX_INFO = WBC_INFO;
    const BOX_OK = WBC_OK;
    const BOX_OKCANCEL = WBC_OKCANCEL;
    const BOX_QUESTION = WBC_QUESTION;
    const BOX_ERROR = WBC_STOP;
    const BOX_WARNING = WBC_WARNING;
    const BOX_YESNO = WBC_YESNO;
    const BOX_YESNOCANCEL = WBC_YESNOCANCEL;
 
    // Constants for cursor types
    const CURSOR_ARROW = 'arrow';
    const CURSOR_CROSS = 'cross';
    const CURSOR_FINGER = 'finger';
    const CURSOR_FORBIDDEN = 'forbidden';
    const CURSOR_HELP = 'help';
    const CURSOR_IBEAM = 'ibeam';
    const CURSOR_NONE = null;
    const CURSOR_SIZEALL = 'sizeall';
    const CURSOR_SIZENESW = 'sizenesw';
    const CURSOR_SIZENS = 'sizens';
    const CURSOR_SIZENWSE = 'sizenwse';
    const CURSOR_SIZEWE = 'sizewe';
    const CURSOR_UPARROW = 'uparrow';
    const CURSOR_WAIT = 'wait';
    const CURSOR_WAITARROW = 'waitarrow';
 
    // Constants for system information types
    const SYSINFO_SCREENAREA = 'screenarea';
    const SYSINFO_WORKAREA = 'workarea';
    public $callback;
    public $gauge;
    private $defaultTitle;
    private $countCtrls;

    public function __construct()
    {
        global $bearsamppCore;
        Log::initClass($this);
 
        $this->defaultTitle = APP_TITLE . ' ' . $bearsamppCore->getAppVersion();
        $this->reset();
    }

    public function reset(): void
    {
        $this->countCtrls = 1000;
        $this->callback   = array();
    }

    public function createAppWindow($caption, $width, $height, $style = null, $params = null): mixed
    {
        return $this->createWindow(null, AppWindow, $caption, WBC_CENTER, WBC_CENTER, $width, $height, $style, $params);
    }

    public function createWindow($parent, $wclass, $caption, $xPos, $yPos, $width, $height, $style = null, $params = null): mixed
    {
        global $bearsamppCore;
 
        // Fix for PHP 8.4: Convert null to 0 for parent parameter
        $parent = $parent === null ? 0 : $parent;
 
        // Fix for PHP 8.4: Ensure style and params are proper types
        $style  = $style === null ? 0 : $style;
        $params = $params === null ? 0 : $params;
 
        // Log window creation attempt for debugging
        $this->writeLog(
            'Creating window: class=' . $wclass . ', caption=' . $caption . ', pos=(' . $xPos . ',' . $yPos . '), size=(' . $width . 'x' . $height . '), style=' . $style . ', params=' . $params
        );
 
        $caption = empty($caption) ? $this->defaultTitle : $this->defaultTitle . ' - ' . $caption;
        $window  = $this->callWinBinder('wb_create_window', array($parent, $wclass, $caption, $xPos, $yPos, $width, $height, $style, $params));
 
        if ($window === false || $window === null) {
            $this->writeLog('ERROR: Failed to create window - wb_create_window returned: ' . var_export($window, true));
            // Check if WinBinder extension is loaded
            if (!extension_loaded('winbinder')) {
                $this->writeLog('ERROR: WinBinder extension is not loaded!');
            }
            // Check if the function exists
            if (!function_exists('wb_create_window')) {
                $this->writeLog('ERROR: wb_create_window function does not exist!');
            }
        } else {
            $this->writeLog('Window created successfully: handle=' . $window);
            // Set tiny window icon
            // Use bmp for window icon to ensure orange icon is used everywhere as requested
            $this->setImage($window, Path::getImagesPath() . '/bearsampp.bmp');
        }
 
        return $window;
    }

    private function callWinBinder($function, $params = array(), $removeErrorHandler = false): mixed
    {
        $result = false;
        if (function_exists($function)) {
            if ($removeErrorHandler) {
                // Suppress all errors for this call
                $oldErrorLevel = error_reporting(0);
                $result        = @call_user_func_array($function, $params);
                error_reporting($oldErrorLevel);
            } else {
                $result = call_user_func_array($function, $params);
            }
        }
 
        return $result;
    }

    public function setImage($wbobject, $path): mixed
    {
        if ($wbobject === null) {
            error_log('Error: $wbobject is null.');
 
            return false;
        }
 
        if (!file_exists($path)) {
            error_log('Error: Image file does not exist at path: ' . $path);
 
            return false;
        }
 
        return $this->callWinBinder('wb_set_image', array($wbobject, $path));
    }

    public function createNakedWindow($caption, $width, $height, $style = null, $params = null): mixed
    {
        $window = $this->createWindow(null, NakedWindow, $caption, WBC_CENTER, WBC_CENTER, $width, $height, $style, $params);
        $this->setArea($window, $width, $height);
 
        return $window;
    }

    public function setArea($wbobject, $width, $height): mixed
    {
        return $this->callWinBinder('wb_set_area', array($wbobject, WBC_TITLE, 0, 0, $width, $height));
    }

    public function destroyWindow($window): bool
    {
        // Check if window exists and is valid
        if (!$window || !$this->windowIsValid($window)) {
            return true; // Already closed or invalid window
        }
 
        // Get window title before destruction for fallback
        $windowTitle = $this->getText($window);
        $currentPid  = Win32Ps::getCurrentPid();
 
        // Attempt standard destruction
        $this->callWinBinder('wb_destroy_window', array($window));
 
        // Verify closure with retries
        $maxAttempts = 3;
        $attempt     = 0;
        $destroyed   = false;
 
        while ($attempt < $maxAttempts && !$destroyed) {
            $this->processMessages();
            usleep(100000); // 100ms delay
            $destroyed = !$this->windowIsValid($window);
            $attempt++;
        }
 
        // Fallback to process termination if window still exists
        if (!$destroyed) {
            // 1. Try to close using window title
            $this->exec('taskkill', '/FI "WINDOWTITLE eq ' . $windowTitle . '" /F', true);
 
            // 2. Try to kill process directly using Winbinder's PID method
            $currentPid = Win32Ps::getCurrentPid();
            if (!empty($currentPid)) {
                $this->exec('taskkill', '/PID ' . $currentPid . ' /T /F', true);
                $this->writeLog('Force-killed PID: ' . $currentPid . ' for window: ' . $window);
            }
 
            // 3. Final sanity check
            if ($this->windowIsValid($window)) {
                $this->callWinBinder('wb_destroy_window', array($window), true); // Force native call
            }
 
            // 4. Reset internal state to prevent memory leaks
            $this->reset();
        }
 
        // Final verification
        return !$this->windowIsValid($window);
    }

    public function getText($wbobject): mixed
    {
        return $this->callWinBinder('wb_get_text', array($wbobject));
    }

    private function windowIsValid($window): bool
    {
        if (!$window) {
            return false;
        }
 
        // Try to get window text - if window is invalid, this will fail
        $text = $this->callWinBinder('wb_get_text', array($window), true);
 
        return ($text !== false);
    }

    private function processMessages(): void
    {
        $this->callWinBinder('wb_wait', array(null, 1), true);
    }

    public function exec($cmd, $params = null, $silent = false, $wait = true, $showWindow = false): mixed
    {
        // Handle array of arguments by quoting each one individually
        if (is_array($params)) {
            $quotedParams = [];
            foreach ($params as $arg) {
                $quotedParams[] = $this->quoteWindowsArg((string)$arg);
            }
            $params = implode(' ', $quotedParams);
        }
 
        if ($silent) {
            // Use WScript.Shell via COM for true silent execution (zero window flashing)
            // This is more reliable than powershell.exe -WindowStyle Hidden which can still flash
            try {
                $wsh     = new COM('WScript.Shell');
                $fullCmd = '"' . $cmd . '"' . (empty($params) ? '' : ' ' . $params);
                // 0 = Hidden, $wait = wait for process to exit
                $exitCode = $wsh->Run($fullCmd, 0, $wait);
                $this->writeLog('exec (silent via COM): ' . $fullCmd . ' [ExitCode: ' . $exitCode . ']');
 
                return $exitCode === 0;
            } catch (Throwable $e) {
                $this->writeLog('exec (silent via COM) failed: ' . $e->getMessage() . '. Falling back to PowerShell.');
                // Fall back to PowerShell method if COM fails
                $psCmd = 'Start-Process -FilePath \'' . str_replace("'", "''", $cmd) . '\'';
                if (!empty($params)) {
                    $psCmd .= ' -ArgumentList \'' . str_replace("'", "''", $params) . '\'';
                }
                $psCmd .= ' -WindowStyle Hidden';
                if ($wait) {
                    $psCmd .= ' -Wait';
                }
                $encodedCmd = base64_encode(mb_convert_encoding($psCmd, 'UTF-16LE', 'UTF-8'));
                $cmd        = 'powershell.exe';
                $params     = '-WindowStyle Hidden -ExecutionPolicy Bypass -EncodedCommand ' . $encodedCmd;
            }
        }
 
        $this->writeLog('exec: ' . $cmd . ' ' . $params);
 
        if ($showWindow) {
            return $this->callWinBinder('wb_exec', array($cmd, $params, true));
        }
 
        return $this->callWinBinder('wb_exec', array($cmd, $params));
    }

    private function quoteWindowsArg(string $arg): string
    {
        // If argument is empty, return empty quotes
        if ($arg === '') {
            return '""';
        }
 
        // If argument contains spaces, quotes, or special shell characters, it needs quoting
        if (preg_match('/[\s"&|<>^()]/', $arg)) {
            // Escape any internal quotes by doubling them (Windows convention for cmd.exe/WScript.Shell)
            $escaped = str_replace('"', '""', $arg);
 
            return '"' . $escaped . '"';
        }
 
        return $arg;
    }

    private static function writeLog($log): void
    {
        global $bearsamppRoot;
        Log::debug($log, Path::getWinbinderLogFilePath());
    }

    public function mainLoop(): mixed
    {
        return $this->callWinBinder('wb_main_loop');
    }

    public function refresh($wbobject): mixed
    {
        return $this->callWinBinder('wb_refresh', array($wbobject, true));
    }

    public function getSystemInfo($info): mixed
    {
        return $this->callWinBinder('wb_get_system_info', array($info));
    }

    public function drawImage($wbobject, $path, $xPos = 0, $yPos = 0, $width = 0, $height = 0): mixed
    {
        $image = $this->callWinBinder('wb_load_image', array($path));
        if ($image === null) {
            return false;
        }
 
        return $this->callWinBinder('wb_draw_image', array($wbobject, $image, $xPos, $yPos, $width, $height));
    }

    public function drawText($parent, $caption, $xPos, $yPos, $width = null, $height = null, $font = null)
    {
        // Fix for PHP 8+: Convert null to empty string before str_replace
        $caption = $caption === null ? '' : $caption;
        $caption = str_replace(self::NEW_LINE, PHP_EOL, $caption);
        $width   = $width == null ? 120 : $width;
        $height  = $height == null ? 25 : $height;
 
        return $this->callWinBinder('wb_draw_text', array($parent, $caption, $xPos, $yPos, $width, $height, $font));
    }

    public function drawRect($parent, $xPos, $yPos, $width, $height, $color = 15790320, $filled = true)
    {
        return $this->callWinBinder('wb_draw_rect', array($parent, $xPos, $yPos, $width, $height, $color, $filled));
    }

    public function drawLine($wbobject, $xStartPos, $yStartPos, $xEndPos, $yEndPos, $color, $height = 1)
    {
        return $this->callWinBinder('wb_draw_line', array($wbobject, $xStartPos, $yStartPos, $xEndPos, $yEndPos, $color, $height));
    }

    public function createFont($fontName, $size = null, $color = null, $style = null)
    {
        return $this->callWinBinder('wb_create_font', array($fontName, $size, $color, $style));
    }

    public function wait($wbobject = null)
    {
        return $this->callWinBinder('wb_wait', array($wbobject), true);
    }

    public function destroyTimer($wbobject, $timerobject)
    {
        return $this->callWinBinder('wb_destroy_timer', array($wbobject, $timerobject));
    }

    public function findFile($filename)
    {
        $result = $this->callWinBinder('wb_find_file', array($filename));
        $this->writeLog('findFile ' . $filename . ': ' . $result);
 
        return $result != $filename ? $result : false;
    }

    public function setHandler($wbobject, $classCallback, $methodCallback, $launchTimer = null)
    {
        if ($launchTimer != null) {
            $launchTimer = $this->createTimer($wbobject, $launchTimer);
        }
 
        $this->callback[$wbobject] = array($classCallback, $methodCallback, $launchTimer);
 
        return $this->callWinBinder('wb_set_handler', array($wbobject, '__winbinderEventHandler'));
    }

    public function createTimer($wbobject, $wait = 1000)
    {
        $this->countCtrls++;
 
        return array(
            self::CTRL_ID  => $this->countCtrls,
            self::CTRL_OBJ => $this->callWinBinder('wb_create_timer', array($wbobject, $this->countCtrls, $wait))
        );
    }

    public function setText($wbobject, $content)
    {
        // Fix for PHP 8+: Convert null to empty string before str_replace
        $content = $content === null ? '' : $content;
        $content = str_replace(self::NEW_LINE, PHP_EOL, $content);
 
        return $this->callWinBinder('wb_set_text', array($wbobject, $content));
    }

    public function getFocus()
    {
        return $this->callWinBinder('wb_get_focus');
    }

    public function setFocus($wbobject)
    {
        return $this->callWinBinder('wb_set_focus', array($wbobject));
    }

    public function isEnabled($wbobject)
    {
        return $this->callWinBinder('wb_get_enabled', array($wbobject));
    }

    public function setDisabled($wbobject)
    {
        return $this->setEnabled($wbobject, false);
    }

    public function setEnabled($wbobject, $enabled = true)
    {
        return $this->callWinBinder('wb_set_enabled', array($wbobject, $enabled));
    }

    public function setStyle($wbobject, $style)
    {
        return $this->callWinBinder('wb_set_style', array($wbobject, $style));
    }

    public function sysDlgPath($parent, $title, $path = null)
    {
        return $this->callWinBinder('wb_sys_dlg_path', array($parent, $title, $path));
    }

    public function sysDlgOpen($parent, $title, $filter = null, $path = null)
    {
        return $this->callWinBinder('wb_sys_dlg_open', array($parent, $title, $filter, $path));
    }

    public function createLabel($parent, $caption, $xPos, $yPos, $width = null, $height = null, $style = null, $params = null)
    {
        $caption = str_replace(self::NEW_LINE, PHP_EOL, $caption);
        $width   = $width == null ? 120 : $width;
        $height  = $height == null ? 25 : $height;
 
        return $this->createControl($parent, Label, $caption, $xPos, $yPos, $width, $height, $style, $params);
    }

    public function createControl($parent, $ctlClass, $caption, $xPos, $yPos, $width, $height, $style = null, $params = null)
    {
        $this->countCtrls++;
 
        // Fix for PHP 8.4: Ensure style and params are proper types
        $style  = $style === null ? 0 : $style;
        $params = $params === null ? 0 : $params;
 
        return array(
            self::CTRL_ID  => $this->countCtrls,
            self::CTRL_OBJ => $this->callWinBinder('wb_create_control', array(
                $parent,
                $ctlClass,
                $caption,
                $xPos,
                $yPos,
                $width,
                $height,
                $this->countCtrls,
                $style,
                $params
            )),
        );
    }

    public function createInputText($parent, $value, $xPos, $yPos, $width = null, $height = null, $maxLength = null, $style = null, $params = null)
    {
        // Fix for PHP 8+: Convert null to empty string before str_replace
        $value     = $value === null ? '' : $value;
        $value     = str_replace(self::NEW_LINE, PHP_EOL, $value);
        $width     = $width == null ? 120 : $width;
        $height    = $height == null ? 25 : $height;
        $inputText = $this->createControl($parent, EditBox, (string)$value, $xPos, $yPos, $width, $height, $style, $params);
        if (is_numeric($maxLength) && $maxLength > 0) {
            $this->setMaxLength($inputText[self::CTRL_OBJ], $maxLength);
        }
 
        return $inputText;
    }

    public function setMaxLength($wbobject, $length)
    {
        // Use error suppression for wb_send_message as it may be disabled in some PHP configurations
        // This is a non-critical operation - if it fails, the input will just not have a max length
        return $this->callWinBinder('wb_send_message', array($wbobject, 0x00c5, $length, 0), true);
    }

    public function createEditBox($parent, $value, $xPos, $yPos, $width = null, $height = null, $style = null, $params = null)
    {
        $value   = str_replace(self::NEW_LINE, PHP_EOL, $value);
        $width   = $width == null ? 540 : $width;
        $height  = $height == null ? 340 : $height;
        $editBox = $this->createControl($parent, RTFEditBox, (string)$value, $xPos, $yPos, $width, $height, $style, $params);
 
        return $editBox;
    }

    public function createHyperLink($parent, $caption, $xPos, $yPos, $width = null, $height = null, $style = null, $params = null)
    {
        $caption   = str_replace(self::NEW_LINE, PHP_EOL, $caption);
        $width     = $width == null ? 120 : $width;
        $height    = $height == null ? 15 : $height;
        $hyperLink = $this->createControl($parent, HyperLink, (string)$caption, $xPos, $yPos, $width, $height, $style, $params);
        $this->setCursor($hyperLink[self::CTRL_OBJ], self::CURSOR_FINGER);
 
        return $hyperLink;
    }

    public function setCursor($wbobject, $type = self::CURSOR_ARROW)
    {
        return $this->callWinBinder('wb_set_cursor', array($wbobject, $type));
    }

    public function createRadioButton($parent, $caption, $checked, $xPos, $yPos, $width = null, $height = null, $startGroup = false)
    {
        $caption = str_replace(self::NEW_LINE, PHP_EOL, $caption);
        $width   = $width == null ? 120 : $width;
        $height  = $height == null ? 25 : $height;
 
        return $this->createControl($parent, RadioButton, (string)$caption, $xPos, $yPos, $width, $height, $startGroup ? WBC_GROUP : null, $checked ? 1 : 0);
    }

    public function createButton($parent, $caption, $xPos, $yPos, $width = null, $height = null, $style = null, $params = null)
    {
        $width  = $width == null ? 80 : $width;
        $height = $height == null ? 25 : $height;
 
        return $this->createControl($parent, PushButton, $caption, $xPos, $yPos, $width, $height, $style, $params);
    }

    public function createProgressBar($parent, $max, $xPos, $yPos, $width = null, $height = null, $style = null, $params = null)
    {
        global $bearsamppLang;
 
        $width       = $width == null ? 200 : $width;
        $height      = $height == null ? 15 : $height;
        $progressBar = $this->createControl($parent, Gauge, $bearsamppLang->getValue(Lang::LOADING), $xPos, $yPos, $width, $height, $style, $params);
 
        $this->setRange($progressBar[self::CTRL_OBJ], 0, $max);
        $this->gauge[$progressBar[self::CTRL_OBJ]] = 0;
 
        return $progressBar;
    }

    public function getValue($wbobject)
    {
        return $this->callWinBinder('wb_get_value', array($wbobject));
    }

    public function setRange($wbobject, $min, $max)
    {
        return $this->callWinBinder('wb_set_range', array($wbobject, $min, $max));
    }

    public function incrProgressBar($progressBar)
    {
        $this->setProgressBarValue($progressBar, self::INCR_PROGRESS_BAR);
    }

    public function setProgressBarValue($progressBar, $value)
    {
        if ($progressBar != null && isset($progressBar[self::CTRL_OBJ]) && isset($this->gauge[$progressBar[self::CTRL_OBJ]])) {
            if (strval($value) == self::INCR_PROGRESS_BAR) {
                $value = $this->gauge[$progressBar[self::CTRL_OBJ]] + 1;
            }
            if (is_numeric($value)) {
                $this->gauge[$progressBar[self::CTRL_OBJ]] = $value;
 
                // Check if the control is still valid before setting the value
                // This prevents errors when the parent window has been destroyed
                $this->callWinBinder('wb_set_value', array($progressBar[self::CTRL_OBJ], $value), true);
            }
        }
    }

    public function setValue($wbobject, $content)
    {
        return $this->callWinBinder('wb_set_value', array($wbobject, $content));
    }

    public function resetProgressBar($progressBar)
    {
        $this->setProgressBarValue($progressBar, 0);
    }

    public function setProgressBarMax($progressBar, $max)
    {
        $this->setRange($progressBar[self::CTRL_OBJ], 0, $max);
    }

    public function messageBoxInfo($message, $title = null)
    {
        return $this->messageBox($message, self::BOX_INFO, $title);
    }

    public function messageBox($message, $type, $title = null)
    {
        global $bearsamppCore;
 
        $message    = str_replace(self::NEW_LINE, PHP_EOL, $message);
        $messageBox = $this->callWinBinder('wb_message_box', array(
            0, // Use 0 instead of null for the window handle parameter
            strlen($message) < 64 ? str_pad($message, 64) : $message, // Pad message to display entire title
            $title == null ? $this->defaultTitle : $this->defaultTitle . ' - ' . $title,
            $type
        ));
 
        return $messageBox;
    }

    public function messageBoxOk($message, $title = null)
    {
        return $this->messageBox($message, self::BOX_OK, $title);
    }

    public function messageBoxOkCancel($message, $title = null)
    {
        return $this->messageBox($message, self::BOX_OKCANCEL, $title);
    }

    public function messageBoxQuestion($message, $title = null)
    {
        return $this->messageBox($message, self::BOX_QUESTION, $title);
    }

    public function messageBoxError($message, $title = null)
    {
        return $this->messageBox($message, self::BOX_ERROR, $title);
    }

    public function messageBoxWarning($message, $title = null)
    {
        return $this->messageBox($message, self::BOX_WARNING, $title);
    }

    public function messageBoxYesNo($message, $title = null)
    {
        return $this->messageBox($message, self::BOX_YESNO, $title);
    }

    public function messageBoxYesNoCancel($message, $title = null)
    {
        return $this->messageBox($message, self::BOX_YESNOCANCEL, $title);
    }
 
}

function __winbinderEventHandler($window, $id, $ctrl, $param1, $param2)
{
    global $bearsamppWinbinder;
 
    if ($bearsamppWinbinder->callback[$window][2] != null) {
        $bearsamppWinbinder->destroyTimer($window, $bearsamppWinbinder->callback[$window][2][0]);
    }
 
    call_user_func_array(
        array($bearsamppWinbinder->callback[$window][0], $bearsamppWinbinder->callback[$window][1]),
        array($window, $id, $ctrl, $param1, $param2)
    );
}