Home > Mobile >  Remove comments from some generated HTML which can be invalid with nested comments
Remove comments from some generated HTML which can be invalid with nested comments

Time:01-31

I would like to remove HTML comments from some generated content. If I use the regex /<!--(.*?)-->/ (ungreedy with the ?) then it works for most cases such as this example:

<!-- <h1> test </h1> --> not remove <!-- <h1> test 2 </h1> -->

It gets rid of the <h1> tags and leaves the "not remove" as desired.

But if the comments are nested, then it will not handle it properly as it will leave the last comment closing tag '-->'. The workaround would be to use a greedy pattern, but in this case it will not work for the first case, with multiple comments.

Example of nested comments (I know it's not valid HTML, but it's the backend which is generating it):

text <!-- something <!-- <p> test </p> --> need remove -->

I've tried to find a solution, but I don't know how to solve this. Has anyone an idea how to handle it?

CodePudding user response:

As you mentioned, it's frustrating because with the ungreedy rule you solve one case and with the greedy rule you solve the other, but you cannot solve both at the time. Well, you are lucky because PHP's PCRE engine accepts recursion :-) !

So the problem can be solved with the magic of (?R) which acts a bit like a "Copy and paste the full pattern here", as I've understood it.

The pattern will be: /<!--(?:(?!<!--|-->).|(?R))*-->/gs

You can test it here: https://regex101.com/r/fZK8VP/1

Explained:

  • <!-- matches the string "<!--".

  • (?: | )* is a non-capturing group which can be repeated several times and with two options:

    A) First option:

    • (?!<!--|-->) is a negative lookahead with two options to say don't match if it's followed by "<!--" or by "-->".

    • . matches any char.

    B) Second option: (?R) which is the entire pattern (recursion).

  • --> matches the string "-->".

I've used the s pattern modifier as the . should also match new lines in case you have some comments on several lines.

  • Related