Metatag has media browser token in meta description

Problem/Motivation

On the site I work on, we ran into an issue where, if a page has an image inserted using media browser at the very start of the body, part of the media browser token as the meta description.

An easy workaround is to just manually enter the desired description instead of using the [node:summary] token, but we would prefer to not need to hunt down any pages that have this problem.

Proposed resolution

The quick solution I can see is to run the node body that is stored in $options['token data'] through the tidyValue function before passing it into the token_replace function. This gives media browser a chance to process its tokens and gives tidyValue a chance to strip out any html and whitespace it needs to before token_replace truncates the body text.

Remaining tasks

1. Review needed

User interface changes

API changes

Data model changes

Release notes snippet

Original report by tristangraves

On the site I work on, we ran into an issue where, if a page has an image, inserted using media browser, at the very start of the body, the Metatag module was outputting part of the media browser token as the meta description. This seems to be caused by the way token_replace handles creating the [node:summary] from a node body when there is no summary and the character limit of the teaser display.

The Metatag module defaults to using [node:summary] for the meta description. When Metatag processes this to create the description, it will run it through token_replace to deal with any tokens. The token_replace function would see that we had no text in the summary of this node (or are not using a summary field at all) and would use the node body as a fallback. It would automatically use teaser as the display for the body as it converts the token, which on our site is the default limit of 600 characters. This is where the problem comes in. Media browser tokens tend to be extremely long (at least on this site) and in my case the media browser token was longer than 600 characters causing it to be cut off.

The processed token with the broken media browser token would then return to the Metatag module to be further parsed eventually making it to tidyValue which checks for media browser tokens and processes them. Since we have cut off a chunk of the token, the conversion fails, but Metatag continues on and uses the left over token bits for the meta description.

The solution I came up with is to run the node body that is stored in $options['token data'] through the tidyValue function before passing it into the token_replace function. This gives media browser a chance to process its tokens and gives tidyValue a chance to strip out any html and whitespace it needs to before token_replace truncates the body text.