- Главная
- Документация
- Ошибки и отладка
Ошибки и отладка
На рабочем сайте посетители видят короткую страницу ошибки, а подробности отправляются в журнал ошибок PHP. Режим отладки показывает разработчику всё сразу.
Режим отладки
Единственный переключатель — site.debug в конфигурации сайта: 1 — включён, 0 — выключен. Установщик прописывает 0. Включайте его только на копии для разработки: при включённом режиме отладки на страницах ошибок отображаются серверные пути и цепочка вызовов, и любой может открыть XML любой страницы. Пока он включён, php index.php setup check завершается с ошибкой.
При включённом режиме отладки:
- PHP отображает ошибки;
?debugпосле адреса страницы возвращает XML-документ страницы: её свойства, XML каждого компонента, строки интерфейса, скрипты и запросы к базе данных с их количеством;?structвозвращает дерево макета и содержимого страницы с классами её компонентов;- страницы ошибок показывают сообщение, файл, строку и цепочку вызовов;
- изображение, которое не может найти ресайзер, отображается серым плейсхолдером.
Без режима отладки ?debug и ?struct игнорируются, и отдаётся обычный HTML страницы.
Что видят посетители
| Ответ | Когда |
|---|---|
| 404 | неизвестный адрес; страница, отключённая на этом языке; подготавливаемый язык (для всех, кроме редактора); страница, на просмотр которой у посетителя нет прав |
| 403 | окно или действие в панели управления, требующее прав, которых нет у пользователя |
| 422 | форма без токена или с другого сайта; изменение (удаление, перемещение, включение), запрошенное без POST |
| 500 | непредвиденная ошибка в коде |
Страницы 404 и 403 сохраняют макет сайта: собственный site/modules/main/templates/layout/error.layout.xml сайта, если он есть, иначе макет ядра, со строками интерфейса TXT_ERROR_404, TXT_ERROR_403 и TXT_ERROR_HINT. Страница 500 выводится вне макета: текст ошибки, ссылка на главную страницу и noindex. Без режима отладки её текст — «Ошибка на сервере. Попробуйте ещё раз позже.», а подробности отправляются в журнал. Запросы панели управления получают ошибку в виде JSON: {"result": false, "errors": [{"message": …}]}.
Отклонённая форма возвращает ответ 422 вместо 403, поскольку панели хостинга часто подставляют собственную страницу вместо 403. Если панель вашего хостинга отдаёт свои страницы ошибок, отключите это для сайта, иначе посетители будут видеть страницы панели вместо страниц сайта.
Предупреждения PHP останавливают страницу
Все ошибки PHP регистрируются. Предупреждение (warning) или уведомление (notice) не игнорируется: оно останавливает страницу как ошибка, посетитель видит страницу ошибки, а в журнал записывается сообщение с указанием файла и строки. Только уведомления об устаревшем коде (deprecation notices) заносятся в журнал и позволяют продолжить генерацию страницы, чтобы более новая версия PHP не ломала сайт.
Журнал
У Simple нет собственных файлов журналов: он пишет в журнал ошибок PHP сайта, без уровней и ротации. Его строки начинаются с:
| Строка | Что означает |
|---|---|
Energine: <class>: <message> @ <file>:<line> |
ошибка, подробностей которой посетитель не увидел |
PHP error <N> thrown as SystemException: … |
предупреждение или уведомление PHP, остановившее страницу |
PHP Deprecated: … |
уведомление об устаревшем коде |
Mail: <reason> |
неотправленное письмо |
Register: …, UserProfile: … |
неудачная регистрация или сохранение профиля |
В базе данных хранятся журналы действий, а не ошибок:
- «Журнал действий» по адресу
/admin/action-log/: сохранения и удаления в панели управления, а также сохранённые тексты — кто, что и когда; - история каждого текста: последние 20 версий на каждом языке;
- неудачные попытки входа за последние 15 минут — для ограничения попыток входа.
Проверки
php index.php setup check— перед сдачей сайта; см. Первый сайт.php index.php setup checklinks— битые ссылки в текстах; завершается с кодом 1, если найдена хотя бы одна.
Собственные тесты репозитория находятся в tests/ и описаны в tests/README.md. Они считывают конфигурацию сайта и tests/local.php — e-mail и пароль администратора, локальный почтовый ящик и путь к журналу ошибок PHP; создайте его из tests/local.php.example, доступным для чтения только его владельцу. Они вызывают php8.5, клиент mysql и curl; запускайте их из репозитория от имени пользователя сайта.
bash tests/smoke-final.shзапрашивает каждую страницу гостем и администратором и сообщает о новых строках в журнале PHP. Он ничего не меняет и безопасен на рабочем сайте.bash tests/regression.shзапускает все наборы тестов на базе данных сайта: создаёт и удаляет тестовые записи, а его тест авторизации временно блокирует адрес этой машины. Запускайте его на тестовой копии —tests/tools/stand.shзапускает таковую с собственной MariaDB и встроенным сервером PHP.