Радость регулярных выражений [2]

Подшаблоны — это способ группировки частей шаблона. Они имеют ряд применений (подробнее о них я расскажу в другой раз), но для целей нашей операции поиска и замены они позволяют пометить часть шаблона как «особенно интересную» — мы не Мы хотим, чтобы этот пробел находился по обе стороны от поискового запроса, предоставленного пользователем — мы просто хотим захватить само слово и заменить его Чтобы увидеть, как это работает, вам нужно взглянуть на следующий аргумент preg_replace() ;

$text = preg_replace( "/b($q)b/i", '<span class="hilite">$1</span>', $text );
$text = preg_replace( "/b($q)b/i", '<span class="hilite">$1</span>', $text ); 

… '<span class="hilite">$1</span>' . Это то, что мы хотим заменить поисковым термином. Вы можете увидеть тег span там, ожидая с ожиданием, но как же в него внедряется соответствующее слово? Через $1 — обратная ссылка на подшаблон . Вам придется прочитать документацию для полного описания синтаксиса обратных ссылок, но, вкратце, они являются «указателями», чтобы вы соответствовали вашему шаблону. Обратная ссылка $0 всегда будет доступна и соответствует полному совпадению. Дополнительные обратные ссылки, такие как $1 будут существовать, если вы будете использовать подшаблоны (чем больше подшаблонов, тем больше будет нумерованных обратных ссылок).

Итак, подытоживая все это, если я preg_replace() слово «лиса», preg_replace() найдет его здесь в $text : brown fox jumped и заменил его brown <span class="hilite">fox</span> jumped .

Есть небольшая проблема, которую вы, возможно, уже заметили. В то время как я мудро использовал preg_quote() чтобы избежать любого ввода, которое похоже на синтаксис регулярных выражений, что, если поисковый термин содержит HTML / Javascript? Прямо сейчас это потенциально открыто для межсайтового скриптинга . Вместо того, чтобы просто заменить, мне нужно сначала выполнить поиск по шаблону через htmlspecialchars () . Но как?

Небольшое сканирование модификаторов шаблона и вы найдете модификатор / e;

Если этот модификатор установлен, preg_replace () выполняет обычную замену обратных ссылок в строке замены, оценивает ее как код PHP и использует результат для замены строки поиска. Одинарные и двойные кавычки экранируются обратной косой чертой в замещенных обратных ссылках.

Хорошо — проблема решена …

Предупреждение: это также потенциально небезопасно и имеет более серьезные последствия!

$text = preg_replace( "/b($q)b/ie", '"<span class="hilite">".htmlspecialchars("$1")."</span>"', $text );
$text = preg_replace( "/b($q)b/ie", '"<span class="hilite">".htmlspecialchars("$1")."</span>"', $text ); 

С модификатором / e, прикрепленным к шаблону, замещающая строка перестает быть строкой и становится PHP-кодом, готовым для eval () . В тот момент, когда вы услышите eval() слово «зло» должно появиться на кончике вашего языка. Вот рассказ о том, что может случиться .

Простое правило: не используйте модификатор / e . Помимо последствий для безопасности, заменяющий код становится чем-то, что необходимо анализировать, интерпретировать и выполнять при каждой замене (если вам нужен настоящий страх и отвращение, скажите «плохая производительность»). И, эй, написание кода для PHP eval — это умопомрачительное упражнение в кавычках.

Так какая альтернатива?

function highlight_search($matches) { return sprintf( '<span class="hilite">%s</span>', htmlspecialchars($matches[1]) ); } $text = preg_replace_callback( "/b($q)b/i", 'highlight_search', $text );
function highlight_search($matches) { return sprintf( '<span class="hilite">%s</span>', htmlspecialchars($matches[1]) ); } $text = preg_replace_callback( "/b($q)b/i", 'highlight_search', $text ); 

Второй аргумент preg_replace_callback() — это имя моей функции обратного вызова highlight_search() , которая будет вызываться каждый раз при замене совпадения.

Функция обратного вызова должна обрабатывать один параметр: $matches , который всегда будет индексированным массивом. И во многом так же, как и в обратных preg_replace() , первый элемент в массиве всегда будет существовать и соответствовать полному совпадению — то есть $matches[0] match $matches[0] . Суб-шаблонам присваиваются более высокие индексы в массиве — в этом случае мой суб-шаблон имеет значение $matches[1] match $matches[1] поэтому все, что мне нужно сделать, это запустить его через htmlspecialchars () , внедрить его в тег span с помощью sprintf () , верни его и я закончу. Возвращаемое значение используется в качестве замены.

Помните, что использованный мною подход, заключающийся в простом размещении входящего поискового термина непосредственно в шаблоне (после экранирования), вероятно, не идеален с точки зрения удобства использования. Необходимо подумать о таких вещах, как пунктуация в поисковом запросе, и, возможно, было бы разумнее разбить поисковый запрос на куски и сначала немного его проанализировать. Таким образом, этот пример является неоптимальным решением, но я думаю, что ему удастся проиллюстрировать поиск регулярных выражений и заменить его достаточно хорошо.

Хорошо — это обертка для этой части. Еще как-нибудь в другой раз (и мне нужно отдохнуть от регулярных выражений на время).

¹ И это действительно означает, что любая длина — включая ничего — .jpg будет правильным именем файла, использующим это регулярное выражение — вероятно, разумнее использовать + квантификатор и требовать хотя бы один символ, но мне нужно оправдание, чтобы проиллюстрировать * .

² На самом деле мне не нужен подшаблон для этого примера, потому что b является утверждением — он на самом деле не становится частью соответствия, но это хорошая возможность проиллюстрировать подшаблоны, которые часто используются при поиске и замене. операции.