bool XDebugServer::breakpoint(const Variant& filename,
const Variant& exception,
const Variant& message,
int line) {
log("Hit breakpoint at %s:%d", filename.toString().data(), line);
setStatus(Status::Break, Reason::Ok);
// Initialize the response node
auto response = xdebug_xml_node_init("response");
addXmlns(*response);
addStatus(*response);
if (m_lastCommand != nullptr) {
addCommand(*response, *m_lastCommand);
}
// Grab the c strings
auto to_c_str = [] (const Variant& var) {
return !var.isString() ? nullptr : var.toString().data();
};
auto filename_str = to_c_str(filename);
auto exception_str = to_c_str(exception);
auto message_str = to_c_str(message);
auto line_str = xdebug_sprintf("%d", line);
// Create the message node
auto msg = xdebug_xml_node_init("xdebug:message");
xdebug_xml_add_attribute_ex(msg, "lineno", line_str, 0, 1);
if (filename_str != nullptr) {
filename_str = XDebugUtils::pathToUrl(filename_str); // output file format
xdebug_xml_add_attribute_ex(
msg,
"filename",
filename_str,
0 /* freeAttr */,
1 /* freeVal */
);
}
if (exception_str != nullptr) {
xdebug_xml_add_attribute(msg, "exception", exception_str);
}
if (message_str != nullptr) {
xdebug_xml_add_text(msg, message_str, 0);
}
// Add the message node then send the response
xdebug_xml_add_child(response, msg);
sendMessage(*response);
xdebug_xml_node_dtor(response);
// Wait for a resonse from the user
return doCommandLoop();
}
void XDebugServer::deinitDbgp() {
setStatus(Status::STOPPING, Reason::OK);
// Send the xml shutdown response
xdebug_xml_node* response = xdebug_xml_node_init("response");
addXmnls(*response);
addCmdAndTrans(*response);
sendMessage(*response);
xdebug_xml_node_dtor(response);
// Wait for a response from the client
doCommandLoop();
// Free the input buffer
smart_free(m_buffer);
}
void XDebugServer::deinitDbgp() {
// Unless we've already stopped, send the shutdown message
if (m_status != Status::Stopped) {
setStatus(Status::Stopping, Reason::Ok);
// Send the xml shutdown response
auto response = xdebug_xml_node_init("response");
addXmlns(*response);
addStatus(*response);
if (m_lastCommand != nullptr) {
addCommand(*response, *m_lastCommand);
}
sendMessage(*response);
xdebug_xml_node_dtor(response);
// Wait for a response from the client. Regardless of the command loop
// result, we exit.
doCommandLoop();
}
// Free the input buffer & the last command
req::free(m_buffer);
delete m_lastCommand;
}
bool XDebugServer::initDbgp() {
// Initialize the status and reason
switch (m_mode) {
case Mode::REQ:
setStatus(Status::Starting, Reason::Ok);
break;
case Mode::JIT:
setStatus(Status::Break, Reason::Error);
break;
}
// Create the response
auto response = xdebug_xml_node_init("init");
addXmlns(*response);
// Add the engine info
auto child = xdebug_xml_node_init("engine");
xdebug_xml_add_attribute(child, "version", XDEBUG_VERSION);
xdebug_xml_add_text(child, XDEBUG_NAME, 0);
xdebug_xml_add_child(response, child);
// Add the author
child = xdebug_xml_node_init("author");
xdebug_xml_add_text(child, XDEBUG_AUTHOR, 0);
xdebug_xml_add_child(response, child);
// Add the url
child = xdebug_xml_node_init("url");
xdebug_xml_add_text(child, XDEBUG_URL, 0);
xdebug_xml_add_child(response, child);
// Add the copyright
child = xdebug_xml_node_init("copyright");
xdebug_xml_add_text(child, XDEBUG_COPYRIGHT, 0);
xdebug_xml_add_child(response, child);
// Grab the absolute path of the script filename
auto globals = get_global_variables()->asArrayData();
Variant scriptname_var = globals->get(s_SERVER).toArray()[s_SCRIPT_FILENAME];
assert(scriptname_var.isString());
auto scriptname = scriptname_var.toString().get()->mutableData();
auto fileuri = XDebugUtils::pathToUrl(scriptname);
// Add attributes to the root init node
xdebug_xml_add_attribute_ex(response, "fileuri", fileuri, 0, 1);
xdebug_xml_add_attribute(response, "language", "PHP");
xdebug_xml_add_attribute(response, "protocol_version", DBGP_VERSION);
xdebug_xml_add_attribute(response, "appid", getpid());
// Add the DBGP_COOKIE environment variable
const String dbgp_cookie = g_context->getenv(s_DBGP_COOKIE);
if (!dbgp_cookie.empty()) {
xdebug_xml_add_attribute(response, "session", dbgp_cookie.data());
}
// Add the idekey
if (XDEBUG_GLOBAL(IdeKey).size() > 0) {
xdebug_xml_add_attribute(response, "idekey", XDEBUG_GLOBAL(IdeKey).c_str());
}
// Sent the response
sendMessage(*response);
xdebug_xml_node_dtor(response);
// Wait for a response from the client
return doCommandLoop();
}
void XDebugServer::initDbgp() {
// Initialize the status and reason
switch (m_mode) {
case Mode::REQ:
setStatus(Status::STARTING, Reason::OK);
break;
case Mode::JIT:
setStatus(Status::BREAK, Reason::ERROR);
break;
}
// Create the response
xdebug_xml_node* response = xdebug_xml_node_init("init");
addXmnls(*response);
// Add the engine info
xdebug_xml_node* child = xdebug_xml_node_init("engine");
xdebug_xml_add_attribute(child, "version", XDEBUG_VERSION);
xdebug_xml_add_text(child, XDEBUG_NAME, 0);
xdebug_xml_add_child(response, child);
// Add the author
child = xdebug_xml_node_init("author");
xdebug_xml_add_text(child, XDEBUG_AUTHOR, 0);
xdebug_xml_add_child(response, child);
// Add the url
child = xdebug_xml_node_init("url");
xdebug_xml_add_text(child, XDEBUG_URL, 0);
xdebug_xml_add_child(response, child);
// Add the copyright
child = xdebug_xml_node_init("copyright");
xdebug_xml_add_text(child, XDEBUG_COPYRIGHT, 0);
xdebug_xml_add_child(response, child);
// Grab the absolute path of the script filename
const ArrayData* globals = get_global_variables()->asArrayData();
Variant scriptname_var = globals->get(s_SERVER).toArray()[s_SCRIPT_FILENAME];
assert(scriptname_var.isString());
char* scriptname = scriptname_var.toString().get()->mutableData();
char* fileuri = XDebugUtils::pathToUrl(scriptname);
// Grab the app id (pid)
// TODO(#4489053) Specification mentions the parent app id as well, xdebug
// doesn't include it.
char* appid = xdebug_sprintf("%d", getpid());
// Add attributes to the root init node
xdebug_xml_add_attribute_ex(response, "fileuri", fileuri, 0, 1);
xdebug_xml_add_attribute_ex(response, "language", "PHP", 0, 0);
xdebug_xml_add_attribute_ex(response, "protocol_version", DBGP_VERSION, 0, 0);
xdebug_xml_add_attribute_ex(response, "appid", appid, 0, 1);
// Add the DBGP_COOKIE environment variable
char* dbgp_cookie = getenv("DBGP_COOKIE");
if (dbgp_cookie != nullptr) {
xdebug_xml_add_attribute_ex(response, "session", dbgp_cookie, 0, 0);
}
// Add the idekey
if (XDEBUG_GLOBAL(IdeKey).size() > 0) {
// TODO(#4489053) Change this when xml api is changed
char* idekey = const_cast<char*>(XDEBUG_GLOBAL(IdeKey).c_str());
xdebug_xml_add_attribute_ex(response, "idekey", idekey, 0, 0);
}
// Sent the response
sendMessage(*response);
xdebug_xml_node_dtor(response);
// Wait for a response from the client
doCommandLoop();
}
