|
Так для чего же все-таки нужна отладка программ? Каждому человеку свойственно делать ошибки. Ошибки в программе приводят к ее неправильному выполнению (или не выполнению вообще). PHP скрипты – это программа, которая является основой вашего сайта.
Какие способы используют программисты для отладки? Обычно, это вывод отладочной информации. Например, если во время написания php скрипта нам понадобится посмотреть значение переменной, то обычно мы это делаем так:
<?php
$myvariable = "Hello, PHP world!";
echo $myvariable;
?>
Однако, это очень неудобно. Постоянно нужно модифицировать скрипт. Тем более, если нам нужно будет проверять значения переменных во многих местах.
Давайте сделаем простой отладчик. Пусть у него будет всего несколько функций, но они вам помогут отладить практически любой скрипт. Он позволяет остановить выполнение скрипта в любом месте и просмореть или изменить переменные.
Основной идеей является модификация скрипта таким образом, что скрипт сам приостановит свою работу в нужном месте и передаст отладчику всю необходимую отладочную информацию. Под отладчиком я подразумеваю внешнюю аппликацию с неким интерфейсом, которая управляет работой скрипта: задает точки останова, выводит отладочную информацию, значения переменных. Для взаимодействия (общения) отладчика с php скриптом я решил использовать сокеты, потому что php поддерживает сокеты, а также это позволяет поместить отладчик на удаленной машине.
Итак начнем. Основной задачей является остановка скрипта в определенной точке. Для того, чтобы понять как он работает давайте возьмем простой скрипт:
<?php
$browser = $HTTP_USER_AGENT;
?>
и модифицируем его таким образом, чтобы он приостановил свое выполнение в 3-й строчке и сообщил об этом отладчику:
<?php
$browser = $HTTP_USER_AGENT;
//А вот тут, прямо перед 3-й строчкой мы вставим наш код :)
$debug_socket = socket_create (AF_INET, SOCK_STREAM, 0);
//создаем сокет для общения с отладчиком
socket_connect ($debug_socket, "127.0.0.1", "3451");
//соединямся с отладчиком
$debug_message = "Hello, debugger. I stopped in line 3";
//формируем сообщение для отладчика
socket_write ($debug_socket, $debug_message, strlen ($debug_message));
//ну и соответственно посылаем его
$todo = socket_read ($debug_socket, 65535);
//ждем от отладчика команды для продолжения работы
socket_close ($debug_socket);
//закрываем сокет и продолжаем выполнение скрипта
?>
Теперь подробнее, что же происходит по шагам:
1) Мы написали скрипт и хотим его отладить :) Наш скрипт должен находиться в documentroot
2) Говорим отладчику в каком скрипте (файле) и в какой строчке остановить выполнение
3) Отладчик модифицирует исходный файл, ну и сохраняет оригинальный, на всякий случай ;)
4) Мы запускам броузер и вводим адрес скрипта, для того, чтобы он выполнился
5) Броузер соединяется с веб сервером, веб сервер запускает наш модифицированый скрипт
6) Скрипт выполняется и в месте, где мы его модифицировали, соединяется с отладчиком и «говорит», что так и так - приехали
7) Отладчик, в свою очередь, сообщает пользователю, что скрипт «доехал» то точки останова
8) Пользователь что-то там делает и дает команду продолжать
9) Отладчик посылает скрипту команду продолжать
10) Скрипт принимает эту команду и продолжает делать свои грязные дела :)
Просто, не правда ли? :) Но это только половина задачи. А вот как нам теперь узнать и изменить значения переменных? Да точно также. Скрипт это сам сделает. Отладчик ему только должен дать команду. В этом нам поможет одна из замечательнейших возможностей PHP - команда eval ().
Реализуем это так:
<?php
$browser = $HTTP_USER_AGENT;
// Тут пойдет наш код
$debug_socket = socket_create (AF_INET, SOCK_STREAM, 0);
socket_connect ($debug_socket, "127.0.0.1", "3451");
$debug_message = "Hello, debugger. I stopped in line 3";
socket_write ($debug_socket, $debug_message, strlen ($debug_message));
$todo = socket_read ($debug_socket, 65535);
eval ($todo);
socket_close ($debug_socket);
?>
Всё также, как и в предыдущем примере, только теперь наша задача получить значение переменной $browser. Схема действий таже: скрипт выполняется, доходит до точки останова, говорит отладчику, что «приехали»... Отладчик же, в свою очередь, посылает скрипту PHP код, который выполнится в скрипте командой eval (). А вот, что отладчик пошлет туда:
<?php
socket_write ($debug_socket, $browser, strlen ($browser));
?>
В итоге скрипт выполнит эту строчку и вернет отладчику значение переменной $browser.
Благодаря команде eval () отладчик может выполнить в точке останова любые прихоти пользователя, вплоть до модификации скрипта на лету, то есть во время отладки.
Идем дальше. Все не так просто, как кажется. До сих пор мы умеем отлаживать простые скрипты. На самом деле в PHP есть функции, классы, возможность подключения других скриптов (команды require, require_once, include). Это делает нам целую кучу проблем. Начнем с проблемы, когда один скрипт включает в себя другие или сам себя.
Пусть мы для идентификации файла будем использовать сокет. То есть перед началом выполнения скрипта мы создадим одно соединие до конца выполнения.
<?php
//создаем сокет, по которому данный файл скрипта будет общаться с отладчиком.
//Переменная сокета будет глобальной, так чтобы ее было видно из всех функций
$debug_socket0 = socket_create (AF_INET, SOCK_STREAM, 0);
//соединяемся с отладчиком
socket_connect ($debug_socket0, "127.0.0.1", "3450");
if (!function_exists ("DebugBreak_0")) {
//определяем функцию для посылки отладчику информации о точке останова
function DebugBreak_0 ($debug_line)
{
//используем переменную глобально
global $debug_socket0;
$DEBUGBREAK = sprintf ("%d", $debug_line);
//посылаем отладчику номер строки где остановились
socket_write ($debug_socket0, $DEBUGBREAK, strlen ($DEBUGBREAK));
}
}
if (!function_exists ("DebugBreak2_0")) {
//определяем функцию получения команды от отладчика
function DebugBreak2_0 ()
{
//используем переменную глобально
global $debug_socket0;
//получаем команду
$rd = socket_read ($debug_socket0, 65535);
//если ничего не приехало
if ($rd == "") {
//убиваем скрипт
printf ("Script aborted!");
exit();
}
return $rd;
}
}
//посылаем отладчику имя файла скрипта
socket_write ($debug_socket0, "/index.php", strlen ("/index.php"));
//получаем от отладчика разрешение на продолжение выполнения
$this_php_file = socket_read ($debug_socket0, 2048);
?>
Обратите внимание на то, что имя переменной сокета содержит номер в конце. Это важно! Так как мы используем эту вставку в начале каждого файла, то для каждого файла должен быть свой сокет. Аналогично с именем функций DebugBreak_x. Для функций мы также делаем проверку, не были ли они продекларированы ранее.
С помощью функций мы создаем код, который будем помещать в каждом месте где хотим сделать остановку:
<?php
$browser = $HTTP_USER_AGENT; //оригинальный код
//используем переменную глобально
global $debug_socket0;
//Посылаем отладчику в какой строке (до модификации) остановились
DebugBreak_0 (2);
//цикл выполнения команд от отладчика
while (true) {
//принимаем команду
$dbdata = DebugBreak2_0();
if ($dbdata != "continue") {
//определяем $debug_socket для того, чтобы использовать его в eval();
$debug_socket = $debug_socket0;
//выполняем команду отладчика
eval ($dbdata);
}
else break;
}
?>
На этом с PHP мы закончим. Надеюсь вы поняли принцип. В следущей части мы приступим к самому отладчику. :) |
| 
