class.action.debugBase.php

Go to the documentation of this file.

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

abstract class ActionDebugBase
{
    abstract protected function getServiceLangConstant();

    abstract protected function getBinInstance($bearsamppBins);

    abstract protected function getCommandMapping();

    protected function hasContentKey()
    {
        return true;
    }

    public function __construct($args)
    {
        global $bearsamppLang, $bearsamppBins, $bearsamppTools, $bearsamppWinbinder;
 
        if (isset($args[0]) && !empty($args[0])) {
            $editor      = false;
            $msgBoxError = false;
 
            // Build base caption
            $serviceLangConstant = $this->getServiceLangConstant();
            $caption             = $bearsamppLang->getValue(Lang::DEBUG) . ' ' .
                $bearsamppLang->getValue(constant('Lang::' . $serviceLangConstant)) . ' - ';
 
            // Get command mapping and determine caption suffix and editor flag
            $commandMapping = $this->getCommandMapping();
            $command        = $args[0];
 
            if (isset($commandMapping[$command])) {
                $config  = $commandMapping[$command];
                $caption .= $bearsamppLang->getValue($config['lang']);
                if (isset($config['editor']) && $config['editor']) {
                    $editor = true;
                }
            }
            $caption .= ' (' . $command . ')';
 
            // Execute the command and get output
            $bin         = $this->getBinInstance($bearsamppBins);
            $debugOutput = $bin->getCmdLineOutput($command);
 
            // Handle syntax check results (if applicable)
            if ($this->isSyntaxCheckCommand($command)) {
                if ($this->hasContentKey()) {
                    $msgBoxError            = !$debugOutput['syntaxOk'];
                    $debugOutput['content'] = $debugOutput['syntaxOk'] ? 'Syntax OK !' : $debugOutput['content'];
                }
            }
 
            // Extract content based on service type
            $content = $this->hasContentKey() && is_array($debugOutput) ? $debugOutput['content'] : $debugOutput;
 
            // Display the output
            if ($editor) {
                Util::openFileContent($caption, $content);
            } else {
                if ($msgBoxError) {
                    $bearsamppWinbinder->messageBoxError($content, $caption);
                } else {
                    $bearsamppWinbinder->messageBoxInfo($content, $caption);
                }
            }
        }
    }

    protected function isSyntaxCheckCommand($command)
    {
        $commandMapping = $this->getCommandMapping();
        if (isset($commandMapping[$command])) {
            return isset($commandMapping[$command]['syntaxCheck']) && $commandMapping[$command]['syntaxCheck'];
        }
 
        return false;
    }
}