gggeek / phpxmlrpc

debugger/controller.php

<?php
/**
 * @author Gaetano Giunta
 * @copyright (C) 2005-2025 G. Giunta
 * @license code licensed under the BSD License: see file license.txt
 *
 * @todo add links to documentation from every option caption
 * @todo switch params for http compression from 0,1,2 to values to be used directly
 * @todo add a little bit more CSS formatting: we broke IE box model getting a width > 100%...
 * @todo add support for more options, such as ntlm auth to proxy, or request charset encoding
 * @todo parse content of payload textarea to be fed to visual editor
 * @todo add http no-cache headers
 * @todo if jsonrpc php classes are not available, gray out or hide altogether the JSONRPC option & title
 * @todo if js libs are not available, do not try to load them
 **/

// Make sure we set the correct charset type for output, so that we can display all characters
header('Content-Type: text/html; charset=utf-8');

global $inputcharset, $debug, $protocol, $run, $hasjsonrpcclient, $hasjsonrpc2, $wstype, $id, $host, $port, $path, $action,
    $method, $methodsig, $payload, $alt_payload, $username, $password, $authtype, $verifyhost, $verifypeer, $cainfo, $proxy,
    $proxyuser, $proxypwd, $timeout, $requestcompression, $responsecompression, $clientcookies;

include __DIR__ . '/common.php';

if ($action == '') {
    $action = 'list';
}

$haseditor = false;
$editorurlpath = null;
// @const JSXMLRPC_BASEURL Url to the visual xml-rpc editing dialog's containing folder. We allow to easily configure this
if (defined('JSXMLRPC_BASEURL')) {
    $editorurlpath = JSXMLRPC_BASEURL;

The constant JSXMLRPC_BASEURL was not found. Maybe you did not declare it correctly or list all dependencies?

    $haseditor = true;
} else {
    /// @deprecated
    /// @const JSXMLRPC_PATH Path to the visual xml-rpc editing dialog's containing folder. Can be absolute, or
    ///         relative to this debugger's folder.
    if (defined('JSXMLRPC_PATH')) {
        $editorpaths = array(JSXMLRPC_PATH[0] === '/' ? JSXMLRPC_PATH : (__DIR__ . '/' . JSXMLRPC_PATH));

The constant JSXMLRPC_PATH was not found. Maybe you did not declare it correctly or list all dependencies?

    } else {
        $editorpaths = array(
            __DIR__ . '/jsxmlrpc/debugger/', // this package is top-level, jsxmlrpc installed via taskfile
            __DIR__ . '/vendor/phpxmlrpc/jsxmlrpc/debugger/', // this package is top-level, jsxmlrpc installed via composer inside the debugger
            __DIR__ . '/node_modules/@jsxmlrpc/jsxmlrpc/debugger/', // this package is top-level, jsxmlrpc installed via npm inside the debugger
            __DIR__ . '/../vendor/phpxmlrpc/jsxmlrpc/debugger/', // this package is top-level, jsxmlrpc installed via composer
            __DIR__ . '/../node_modules/@jsxmlrpc/jsxmlrpc/debugger/', // this package is top-level, jsxmlrpc installed via npm
            __DIR__ . '/../../jsxmlrpc/debugger/', // this package is a composer dependency, jsxmlrpc too
            __DIR__ . '/../../../../debugger/jsxmlrpc/debugger/', // this package is a composer dependency, jsxmlrpc installed in the top-level via taskfile (ie. jsonrpc)
            __DIR__ . '/../../../../debugger/vendor/phpxmlrpc/jsxmlrpc/debugger/', // this package is a composer dependency, jsxmlrpc installed in the top-level debugger via composer
            __DIR__ . '/../../../../debugger/node_modules/@jsxmlrpc/jsxmlrpc/debugger/', // this package is a composer dependency, jsxmlrpc installed in the top-level debugger via npm
            __DIR__ . '/../../../../node_modules/@jsxmlrpc/jsxmlrpc/debugger/', // this package is a composer dependency, jsxmlrpc installed via npm in the top-level project
        );
    }
    foreach($editorpaths as $editorpath) {
        if (is_file(realpath($editorpath . 'visualeditor.html'))) {
            $haseditor = true;
            break;
        }
    }
    if ($haseditor) {
        $controllerRootUrl = str_replace('/controller.php', '', parse_url($_SERVER['REQUEST_URI'],  PHP_URL_PATH));
        $editorurlpath = $controllerRootUrl . '/' . preg_replace('|^' . preg_quote(__DIR__, '|') .'|', '', $editorpath);
        /// @todo for cases above 4 and up, look at $controllerRootUrl and check if the web root is not pointing directly
        ///       at this folder, as in that case the link to the visualeditor will not
        ///       work, as it will be in the form http(s)://domain/../../jsxmlrpc/debugger/visualeditor.html
    }
}
?><!DOCTYPE html>
<html lang="en">
<head>
    <link rel="icon" type="image/vnd.microsoft.icon" href="favicon.ico">
    <title><?php if (defined('DEFAULT_WSTYPE') && (DEFAULT_WSTYPE == 1 || DEFAULT_WSTYPE == 2)) echo 'JSON-RPC'; else echo 'XML-RPC'; ?> Debugger</title>

The constant DEFAULT_WSTYPE was not found. Maybe you did not declare it correctly or list all dependencies?

    <meta name="robots" content="index,nofollow"/>
    <script type="text/javascript" language="Javascript">
        if (window.name != 'frmcontroller')
            top.location.replace('index.php?run=' + escape(self.location));
    </script>
    <!-- xml-rpc/json-rpc base library -->
    <script type="module">
        import {base64_decode} from 'https://cdn.jsdelivr.net/npm/@jsxmlrpc/jsxmlrpc@0.6/lib/index.js';
        window.base64_decode = base64_decode;
    </script>
    <style>
        <!--
        html {
            overflow: -moz-scrollbars-vertical;
        }
        body {
            padding: 0.5em;
            background-color: #EEEEEE;
            font-family: Verdana, Arial, Helvetica, sans-serif;
            font-size: 8pt;
        }
        h1 {
            font-size: 12pt;
            margin: 0.5em;
            display: inline-block;
        }
        h2 {
            font-size: 10pt;
            display: inline;
            vertical-align: top;
        }
        h3 {
            display: inline;
        }
        table {
            border: 1px solid gray;
            margin-bottom: 0.5em;
            padding: 0.25em;
            width: 100%;
        }
        #methodpayload {
            display: inline;
        }
        #idcell {
            visibility: hidden;
        }
        td {
            vertical-align: top;
            font-family: Verdana, Arial, Helvetica, sans-serif;
            font-size: 8pt;
        }
        .labelcell {
            text-align: right;
        }
        -->
    </style>
    <script type="text/javascript">
        function verifyserver() {
            if (document.frmaction.host.value == '') {
                alert('Please insert a server name or address');
                return false;
            }
            if (document.frmaction.path.value == '')
                document.frmaction.path.value = '/';
            var action = '';
            for (counter = 0; counter < document.frmaction.action.length; counter++)
                if (document.frmaction.action[counter].checked) {
                    action = document.frmaction.action[counter].value;
                }
            if (document.frmaction.method.value == '' && (action == 'execute' || action == 'wrap' || action == 'describe')) {
                alert('Please insert a method name');
                return false;
            }
            if (document.frmaction.authtype.value != '1' && document.frmaction.username.value == '') {
                alert('No username for authenticating to server: authentication disabled');
            }

            return true;
        }

        function switchaction() {
            // reset html layout depending on action to be taken
            var action = '';
            for (counter = 0; counter < document.frmaction.action.length; counter++)
                if (document.frmaction.action[counter].checked) {
                    action = document.frmaction.action[counter].value;
                }
            if (action == 'execute') {
                document.frmaction.methodpayload.disabled = false;
                displaydialogeditorbtn(true);//if (document.getElementById('methodpayloadbtn') != undefined) document.getElementById('methodpayloadbtn').disabled = false;
                document.frmaction.method.disabled = false;
                document.frmaction.methodpayload.rows = 10;
                document.frmaction.id.disabled = false;
                if (document.frmaction.id.value == '') {
                    document.frmaction.id.value = '1';
                }
            }
            else if (action == 'notification') {
                document.frmaction.methodpayload.disabled = false;
                displaydialogeditorbtn(true);//if (document.getElementById('methodpayloadbtn') != undefined) document.getElementById('methodpayloadbtn').disabled = false;
                document.frmaction.method.disabled = false;
                document.frmaction.methodpayload.rows = 10;
                document.frmaction.id.disabled = true;
                if (document.frmaction.id.value != '') {
                    document.frmaction.id.value = '';
                }
            }
            else {
                document.frmaction.methodpayload.rows = 1;
                if (action == 'describe' || action == 'wrap') {
                    document.frmaction.methodpayload.disabled = true;
                    displaydialogeditorbtn(false); //if (document.getElementById('methodpayloadbtn') != undefined) document.getElementById('methodpayloadbtn').disabled = true;
                    document.frmaction.method.disabled = false;
                    document.frmaction.id.disabled = false;
                    if (document.frmaction.id.value == '') {
                        document.frmaction.id.value = '1';
                    }
                }
                else // list
                {
                    document.frmaction.methodpayload.disabled = true;
                    displaydialogeditorbtn(false); //if (document.getElementById('methodpayloadbtn') != undefined) document.getElementById('methodpayloadbtn').disabled = false;
                    document.frmaction.method.disabled = true;
                    document.frmaction.id.disabled = false;
                    if (document.frmaction.id.value == '') {
                        document.frmaction.id.value = '1';
                    }
                }
            }
        }

        function switchssl() {
            if (document.frmaction.protocol.value != '2' && document.frmaction.protocol.value != '3') {
                document.frmaction.verifypeer.disabled = true;
                document.frmaction.verifyhost.disabled = true;
                document.frmaction.cainfo.disabled = true;
            }
            else {
                document.frmaction.verifypeer.disabled = false;
                document.frmaction.verifyhost.disabled = false;
                document.frmaction.cainfo.disabled = false;
            }
        }

        function switchauth() {
            if (document.frmaction.protocol.value != '0') {
                document.frmaction.authtype.disabled = false;
            }
            else {
                document.frmaction.authtype.disabled = true;
                document.frmaction.authtype.value = 1;
            }
        }

        function swicthcainfo() {
            if (document.frmaction.verifypeer.checked == true) {
                document.frmaction.cainfo.disabled = false;
            }
            else {
                document.frmaction.cainfo.disabled = true;
            }
        }

        function switchtransport(is_json) {
            if (is_json == 2) {
                document.getElementById("idcell").style.visibility = 'visible';
                document.getElementById("notificationcell").style.visibility = 'visible';
                document.frmjsonrpc2.yes.checked = true;
                document.frmjsonrpc1.yes.checked = false;
                document.frmxmlrpc.yes.checked = false;
                document.frmaction.wstype.value = "2";
            } else if (is_json == 1) {
                document.getElementById("idcell").style.visibility = 'visible';
                document.getElementById("notificationcell").style.visibility = 'visible';
                document.frmjsonrpc2.yes.checked = false;
                document.frmjsonrpc1.yes.checked = true;
                document.frmxmlrpc.yes.checked = false;
                document.frmaction.wstype.value = "1";
            }
            else {
                document.getElementById("idcell").style.visibility = 'hidden';
                document.getElementById("notificationcell").style.visibility = 'hidden';
                if (document.getElementById("actionnotification").checked) {
                    document.getElementById("actionnotification").checked = false;
                    document.getElementById("actionexecute").checked = true;
                }
                document.frmjsonrpc2.yes.checked = false;
                document.frmjsonrpc1.yes.checked = false;
                document.frmxmlrpc.yes.checked = true;
                document.frmaction.wstype.value = "0";
            }
        }

        function displaydialogeditorbtn(show) {
            if (show && <?php echo $haseditor ? 'true' : 'false'; ?>) {
                document.getElementById('methodpayloadbtn').innerHTML = '[<a href="#" onclick="activateeditor(); return false;">Edit</a>]';
            }
            else {
                document.getElementById('methodpayloadbtn').innerHTML = '';
            }
        }

        function activateeditor() {
            var url = '<?php echo $editorurlpath; ?>visualeditor.html?params=<?php echo str_replace(array("\\", "'"), array( "\\\\", "\\'"), $alt_payload); ?>';
            if (document.frmaction.wstype.value == "1" || document.frmaction.wstype.value == "2")
                url += '&type=jsonrpc';
            var wnd = window.open(url, '_blank', 'width=750, height=400, location=0, resizable=1, menubar=0, scrollbars=1');
        }

        // if javascript version of the lib is found, allow it to send us params
        function buildparams(base64data) {
            if (typeof base64_decode == 'function') {
                if (base64data == '0') // workaround for bug in base64_encode...
                    document.getElementById('methodpayload').value = '';
                else
                    document.getElementById('methodpayload').value = base64_decode(base64data);
            }
        }

        // use GET for ease of refresh, switch to POST when payload is too big to fit in url (in IE: 2048 bytes! see http://support.microsoft.com/kb/q208427/)
        function switchFormMethod() {
            /// @todo use a more precise calculation, adding the rest of the fields to the actual generated url length -
            ///       retrieve first max url length for current browsers and webservers
            if (document.frmaction.methodpayload.value.length > 1536) {
                document.frmaction.action = 'action.php?usepost=true';
                document.frmaction.method = 'post';
            }
            /*let form = document.forms[0];
            let formData = new FormData(form);
            let search = new URLSearchParams(formData);
            let queryString = search.toString();
            alert(queryString);alert(queryString.length);*/
        }
    </script>
</head>
<body
    onload="<?php if ($hasjsonrpcclient) echo "switchtransport($wstype); " ?>switchaction(); switchssl(); switchauth(); swicthcainfo();<?php if ($run) {
        echo ' document.frmaction.submit();';
    } ?>">
<h1>XML-RPC
<?php if ($hasjsonrpcclient) {
    echo '<form name="frmxmlrpc" style="display: inline;" action="."><input name="yes" type="radio" onclick="switchtransport(0);"' .
        // q: does this check make sense at all?
        (!class_exists('\PhpXmlRpc\Client') ? ' disabled="disabled"' : '') . ' /></form>';
    if ($hasjsonrpc2) {
        echo ' / <form name="frmjsonrpc2" style="display: inline;" action="."><input name="yes" type="radio" onclick="switchtransport(2);"/></form>JSON-RPC 2.0 ';
    }
    echo ' / <form name="frmjsonrpc1" style="display: inline;" action="."><input name="yes" type="radio" onclick="switchtransport(1);"/></form>JSON-RPC 1.0 ';
} ?>
Debugger</h1><h3>(based on <a href="https://gggeek.github.io/phpxmlrpc/">PHPXMLRPC</a>, ver. <?php echo htmlspecialchars(\PhpXmlRpc\PhpXmlRpc::$xmlrpcVersion)?>
<?php if (class_exists('\PhpXmlRpc\JsonRpc\PhpJsonRpc')) echo ' and <a href="https://gggeek.github.io/phpxmlrpc-jsonrpc/">PHPJOSNRPC</a>, ver. ' . htmlspecialchars(\PhpXmlRpc\JsonRpc\PhpJsonRpc::$jsonrpcVersion); ?>)</h3>

The type PhpXmlRpc\JsonRpc\PhpJsonRpc was not found. Maybe you did not declare it correctly or list all dependencies?

<form name="frmaction" method="get" action="action.php" target="frmaction" onSubmit="switchFormMethod();">

    <table id="serverblock">
        <tr>
            <td><h2>Target server</h2></td>
            <td class="labelcell">Protocol:</td>
            <td><select name="protocol" onchange="switchssl(); switchauth(); swicthcainfo();">
                <option value="0"<?php if ($protocol == 0) { echo ' selected="selected"'; } ?>>HTTP 1.0</option>
                <option value="1"<?php if ($protocol == 1) { echo ' selected="selected"'; } ?>>HTTP 1.1</option>
                <option value="2"<?php if ($protocol == 2) { echo ' selected="selected"'; } ?>>HTTPS</option>
                <option value="3"<?php if ($protocol == 3) { echo ' selected="selected"'; } ?>>HTTP2</option>
                <option value="4"<?php if ($protocol == 3) { echo ' selected="selected"'; } ?>>HTTP2 no TLS</option>
            </select></td>
            <td class="labelcell">Address:</td>
            <td><input type="text" name="host" value="<?php echo htmlspecialchars($host, ENT_COMPAT, $inputcharset); ?>"/></td>
            <td class="labelcell">Port:</td>
            <td><input type="text" name="port" value="<?php echo htmlspecialchars($port, ENT_COMPAT, $inputcharset); ?>" size="5" maxlength="5"/>
            </td>
            <td class="labelcell">Path:</td>
            <td><input type="text" name="path" value="<?php echo htmlspecialchars($path, ENT_COMPAT, $inputcharset); ?>"/></td>
        </tr>
    </table>

    <table id="actionblock">
        <tr>
            <td><h2>Action</h2></td>
            <td>List available methods<input type="radio" name="action" value="list"<?php if ($action == 'list') { echo ' checked="checked"'; } ?> onclick="switchaction();"/></td>
            <td>Describe method<input type="radio" name="action" value="describe"<?php if ($action == 'describe') { echo ' checked="checked"'; } ?> onclick="switchaction();"/></td>
            <td>Execute method<input type="radio" name="action" id="actionexecute" value="execute"<?php if ($action == 'execute') { echo ' checked="checked"'; } ?> onclick="switchaction();"/></td>
            <?php if ($hasjsonrpcclient) { ?><td id="notificationcell">Send notification <input type="radio" name="action" id="actionnotification" value="notification"<?php if ($action == 'notification') { echo ' checked="checked"'; } ?> onclick="switchaction();"/></td><?php } ?>
            <td>Generate stub for method call<input type="radio" name="action" value="wrap"<?php if ($action == 'wrap') { echo ' checked="checked"'; } ?> onclick="switchaction();"/></td>
        </tr>
    </table>
    <input type="hidden" name="methodsig" value="<?php echo htmlspecialchars($methodsig, ENT_COMPAT, $inputcharset); ?>"/>

    <table id="methodblock">
        <tr>
            <td><h2>Method</h2></td>
            <td class="labelcell">Name:</td>
            <td><input type="text" name="method" value="<?php echo htmlspecialchars($method, ENT_COMPAT, $inputcharset); ?>"/></td>
            <td class="labelcell">Payload:<br/>
                <div id="methodpayloadbtn"></div>
            </td>
            <td><textarea id="methodpayload" name="methodpayload" rows="1" cols="40"><?php echo htmlspecialchars($payload, ENT_COMPAT, $inputcharset); ?></textarea></td>
            <td class="labelcell" id="idcell">Req id: <input type="text" name="id" size="3" value="<?php echo htmlspecialchars($id, ENT_COMPAT, $inputcharset); ?>"/></td>
            <td><input type="hidden" name="wstype" value="<?php echo $wstype; ?>"/>
                <input type="submit" value="Execute" onclick="return verifyserver();"/></td>
        </tr>
    </table>

    <table id="optionsblock">
        <tr>
            <td><h2>Client options</h2></td>
            <td class="labelcell">Show debug info:</td>
            <td><select name="debug">
                    <option value="0"<?php if ($debug == 0) { echo ' selected="selected"'; } ?>>No</option>
                    <option value="1"<?php if ($debug == 1) { echo ' selected="selected"'; } ?>>Yes</option>
                    <option value="2"<?php if ($debug == 2) { echo ' selected="selected"'; } ?>>More</option>
                </select>
            </td>
            <td class="labelcell">Timeout:</td>
            <td><input type="text" name="timeout" size="3" value="<?php if ($timeout > 0) { echo $timeout; } ?>"/></td>
            <td></td>
            <td></td>
        </tr>
        <tr>
            <td class="labelcell">AUTH:</td>
            <td class="labelcell">Username:</td>
            <td><input type="text" name="username" value="<?php echo htmlspecialchars($username, ENT_COMPAT, $inputcharset); ?>"/></td>
            <td class="labelcell">Pwd:</td>
            <td><input type="password" name="password" value="<?php echo htmlspecialchars($password, ENT_COMPAT, $inputcharset); ?>"/></td>
            <td class="labelcell">Type</td>
            <td><select name="authtype">
                    <option value="1"<?php if ($authtype == 1) { echo ' selected="selected"'; } ?>>Basic</option>
                    <option value="2"<?php if ($authtype == 2) { echo ' selected="selected"'; } ?>>Digest</option>
                    <option value="8"<?php if ($authtype == 8) { echo ' selected="selected"'; } ?>>NTLM</option>
                </select></td>
            <td></td>
        </tr>
        <tr>
            <td class="labelcell">SSL:</td>
            <td class="labelcell">Verify Host's CN:</td>
            <td><select name="verifyhost">
                    <option value="0"<?php if ($verifyhost == 0) { echo ' selected="selected"'; } ?>>No</option>
                    <option value="1"<?php if ($verifyhost == 1) { echo ' selected="selected"'; } ?>>Check CN existence</option>
                    <option value="2"<?php if ($verifyhost == 2) { echo ' selected="selected"'; } ?>>Check CN match</option>
                </select></td>
            <td class="labelcell">Verify Cert:</td>
            <td><input type="checkbox" value="1" name="verifypeer" onclick="swicthcainfo();"<?php if ($verifypeer) { echo ' checked="checked"'; } ?> /></td>
            <td class="labelcell">CA Cert file:</td>
            <td><input type="text" name="cainfo" value="<?php echo htmlspecialchars($cainfo, ENT_COMPAT, $inputcharset); ?>"/></td>
        </tr>
        <tr>
            <td class="labelcell">PROXY:</td>
            <td class="labelcell">Server:</td>
            <td><input type="text" name="proxy" value="<?php echo htmlspecialchars($proxy, ENT_COMPAT, $inputcharset); ?>"/></td>
            <td class="labelcell">Proxy user:</td>
            <td><input type="text" name="proxyuser" value="<?php echo htmlspecialchars($proxyuser, ENT_COMPAT, $inputcharset); ?>"/></td>
            <td class="labelcell">Proxy pwd:</td>
            <td><input type="password" name="proxypwd" value="<?php echo htmlspecialchars($proxypwd, ENT_COMPAT, $inputcharset); ?>"/></td>
        </tr>
        <tr>
            <td class="labelcell">COMPRESSION:</td>
            <td class="labelcell">Request:</td>
            <td><select name="requestcompression">
                    <option value="0"<?php if ($requestcompression == 0) { echo ' selected="selected"'; } ?>>None </option>
                    <option value="1"<?php if ($requestcompression == 1) { echo ' selected="selected"'; } ?>>Gzip</option>
                    <option value="2"<?php if ($requestcompression == 2) { echo ' selected="selected"'; } ?>>Deflate</option>
                </select></td>
            <td class="labelcell">Response:</td>
            <td><select name="responsecompression">
                    <option value="0"<?php if ($responsecompression == 0) { echo ' selected="selected"'; } ?>>None</option>
                    <option value="1"<?php if ($responsecompression == 1) { echo ' selected="selected"'; } ?>>Gzip</option>
                    <option value="2"<?php if ($responsecompression == 2) { echo ' selected="selected"'; } ?>>Deflate</option>
                    <option value="3"<?php if ($responsecompression == 3) { echo ' selected="selected"'; } ?>>Any</option>
                </select></td>
            <td></td>
        </tr>
        <tr>
            <td class="labelcell">COOKIES:</td>
            <td colspan="4" class="labelcell"><input type="text" name="clientcookies" size="80" value="<?php echo htmlspecialchars($clientcookies, ENT_COMPAT, $inputcharset); ?>"/></td>
            <td colspan="2">Format: 'cookie1=value1, cookie2=value2'</td>
        </tr>
    </table>

</form>
</body>
</html>