Skip to content

Add check to Message::getText() to avoid unnecessary argument processing #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 7.x-1.x
Choose a base branch
from
Open

Add check to Message::getText() to avoid unnecessary argument processing #230

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
393823e
Add check to Message::getText() to avoid unnecessary argument processing
nikanderson Jul 10, 2018
3d01cb1
Refactor key check for diff compactness and early return per amitaibu
nikanderson Jul 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 27 additions & 24 deletions includes/message.message.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,32 +172,35 @@ class Message extends Entity {
if (!empty($arguments)) {
$args = array();
foreach ($arguments as $key => $value) {
if (is_array($value) && !empty($value['callback']) && function_exists($value['callback'])) {
// A replacement via callback function.
$value += array('pass message' => FALSE);
if ($value['pass message']) {
// Pass the message object as-well.
$value['callback arguments'][] = $this;
// Don't bother processing for keys not present in the output
if (strpos($output, $key) !== FALSE) {
Copy link
Member

@amitaibu amitaibu Jul 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this is the change, right? It's smart!

To keep the diff smaller - and I tend to prefer return early you can

if (strpos($output, $key) === FALSE) {
  // The replacement key is not in the output, so save computation.
  continue;
}

I wonder if there are cases where we would still want to computation. We can add a force_computation (or another better name), in the $options.

(This will require a simpleTest)

Copy link
Author

@nikanderson nikanderson Jul 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback; yes, the change is just a one-line check and comment wrapping the business inside the foreach. I like your approach, I'll incorporate that.

I also share your concern that argument callbacks might be (mis)used in a way that creates needed side effects. Adding an option to force callbacks to be executed anyway would allow any such misuers to update to force legacy behavior.

if (is_array($value) && !empty($value['callback']) && function_exists($value['callback'])) {
// A replacement via callback function.
$value += array('pass message' => FALSE);
if ($value['pass message']) {
// Pass the message object as-well.
$value['callback arguments'][] = $this;
}

$value = call_user_func_array($value['callback'], $value['callback arguments']);
}

$value = call_user_func_array($value['callback'], $value['callback arguments']);
}

switch ($key[0]) {
case '@':
// Escaped only.
$args[$key] = check_plain($value);
break;

case '%':
default:
// Escaped and placeholder.
$args[$key] = drupal_placeholder($value);
break;

case '!':
// Pass-through.
$args[$key] = $value;
switch ($key[0]) {
case '@':
// Escaped only.
$args[$key] = check_plain($value);
break;

case '%':
default:
// Escaped and placeholder.
$args[$key] = drupal_placeholder($value);
break;

case '!':
// Pass-through.
$args[$key] = $value;
}
}
}
$output = strtr($output, $args);
Expand Down