MODX Revolution: плагин для отслеживания ошибки 404

Очень распространённая ситуация — пользователь приходит на ваш сайт с другого сайта, но вместо желаемого видит сообщение о том, что страница не найдена. Такое случается, когда на вашем сайте изменилась структура URL или был перемещён какой-то файл. Скорее всего, пользователь просто уйдёт с вашего сайта в расстроенных чувствах, не попытавшись найти нужную информацию. Поэтому стоит постоянно отслеживать такие случаи, чтобы затем исправить ошибку — настроить перенаправление или разместить по нужному адресу то, что там должно быть.

Страница не найдена
Страница не найдена

Даже если у вас всего один сайт, отследить все ошибки бывает сложно, ведь никогда не знаешь наверняка, откуда придут пользователи. Поэтому я решил автоматизировать это дело, написав плагин для MODX Revolution. Если вы тоже загорелись желанием автоматизировать отслеживание ошибки 404, то проделайте несколько телодвижений. Создайте плагин с любым названием (я назвал его «quasiNotFound») и включите его для события «OnPageNotFound». Далее нужно всего лишь указать адрес электронной почты (переменная $email), на которую будут приходить уведомления о ненайденных ресурсах.

Исходный код

Исходный код плагина (и даже пакет) есть на GitHub: https://github.com/mishantrop/quasinotfound. Там всегда находится свежая версия плагина.

<?php
/**
 * @author <https://quasi-art.ru>
 * @version 1.3
 * 19.06.2015 - 11.12.2016
 */

/**
 * Настройки
 */
// Режим отладки
$debug = false;
// Записывать ли сообщения в журнал ошибок
$log = false;
// Отправлять ли почту
$sendEmail = true;
// На какой адрес прислать письмо
$email = [email protected]';
$emailFrom = [email protected]';
$emailFromName = 'quasiNotFound';
// Массив исключений
// Например, '/favicon.ico'
$excludeUri = [
	'/favicon.ico',
];

// Запись отладочной информации
if (!function_exists('quasiNotFoundWriteDebug')) {
	function quasiNotFoundWriteDebug($text) {
		global $debug;
		global $modx;
		if ($debug) {
			$modx->log(xPDO::LOG_LEVEL_ERROR, $text);
		}
	}
}

// Запись информации в журнал
if (!function_exists('quasiNotFoundWriteLog')) {
	function quasiNotFoundWriteLog($text) {
		global $log;
		global $modx;
		if ($log) {
			$modx->log(xPDO::LOG_LEVEL_ERROR, $text);
		}
	}
}

// Плагин не нужен в админке, наверное
if ($modx->context->key == 'mgr') {
	return;
}

// Время запроса
$date = date('H:i:s d.m.Y');
// Адрес страницы
$uri = $modx->getOption('REQUEST_URI', $_SERVER, '/');
// Адрес сайта
$host = $modx->getOption('HTTP_HOST', $_SERVER, '');
// Откуда посетитель пришёл
$referer = $modx->getOption('HTTP_REFERER', $_SERVER, '');
// Браузер
$ua = $modx->getOption('HTTP_USER_AGENT', $_SERVER, '');
// IP
$ip = $modx->getOption('REMOTE_ADDR', $_SERVER, '');
// Полный адрес запрашиваемой страницы
$url = $host.$uri;
// Тема письма
$subject = 'Error 404 on '.$host;

// Если запрос в списке исключений, то не нужно ничего записывать и отправлять
if (in_array($uri, $excludeUri)) {
	quasiNotFoundWriteDebug('Uri "'.$uri.'" in black list');
	return;
}

// Сообщение для письма
$message = 'Resource: '.$url.' not found; <br/>';
$message .= 'Date: '.$date.'<br/>';
$message .= (!empty($referer)) ? 'Referer: '.$referer.'<br/>' : '';
$message .= 'User-agent: '.$ua.'<br/>';
$message .= 'IP: '.$ip.'<br>';
$message = '<html><body>'.$message.'</body></html>';

if ($log) {
	// Сообщение для журнала
	$messageLog = 'quasiNotFound; ';
	$messageLog .= 'Page not found: '.$url.'; ';
	$messageLog .= 'Date: '.$date.'; ';
	$messageLog .= (!empty($referer)) ? 'Referer: '.$referer.'; ': '';
	$messageLog .= 'User-agent: '.$ua.'; ';
	$messageLog .= 'IP: '.$ip.'; ';
	quasiNotFoundWriteLog($messageLog);
}

// Если нужно отправить письмо
if ($sendEmail && !empty($email)) {
    $modx->getService('mail', 'mail.modPHPMailer');
    $modx->mail->setHTML(true);
    $modx->mail->set(modMail::MAIL_BODY, $message);
    $modx->mail->set(modMail::MAIL_FROM, $emailFrom);
    $modx->mail->set(modMail::MAIL_FROM_NAME, $emailFromName);
    $modx->mail->set(modMail::MAIL_SUBJECT, $subject);
    $modx->mail->address('to', $email);
    $modx->mail->address('reply-to', $emailFrom);
    if ($modx->mail->send()) {
		quasiNotFoundWriteDebug('Email was sent successfully');
	} else {
		quasiNotFoundWriteDebug('Error on send email');
	}
} elseif ($sendEmail && empty($email)) {
	quasiNotFoundWriteDebug('Email address is empty');
}

Кстати, если у вас уже есть другой плагин, привязанный к этому же событию, то будет происходить конфликт приоритетов, так как несколько плагинов привязаны к одному событию. Поэтому нужно понизить приоритет моего плагина, изменив приоритет с «0» на «1» (чем меньше число, тем выше приоритет).

Настройки запуска плагина
Настройки запуска плагина

Письмо будет выглядеть следующим образом. Оно содержит запрашиваемый ресурс, время запроса, а также IP и User-Agent посетителя.

Письмо о ненайденном ресурсе
Письмо о ненайденном ресурсе

Комментарии