Skip to content

Handle wildcard "+" segments #92

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

Merged
willdurand merged 1 commit into from
May 4, 2017
Merged

Handle wildcard "+" segments #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 46 additions & 7 deletions src/Negotiation/Negotiator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,62 @@ protected function match(AcceptHeader $accept, AcceptHeader $priority, $index)
return null;
}

$ab = $accept->getBasePart();
$pb = $priority->getBasePart();
$acceptBase = $accept->getBasePart();
$priorityBase = $priority->getBasePart();
Copy link
Contributor Author

@weierophinney weierophinney May 3, 2017

Choose a reason for hiding this comment

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

I changed these variable names as I was confused by the two-character names when attempting to make my changes. I can revert these if desired, but I think they make the intent far clearer.

Copy link
Owner

@willdurand willdurand May 4, 2017

Choose a reason for hiding this comment

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

yep, perfect


$as = $accept->getSubPart();
$ps = $priority->getSubPart();
$acceptSub = $accept->getSubPart();
$prioritySub = $priority->getSubPart();

$intersection = array_intersect_assoc($accept->getParameters(), $priority->getParameters());

$baseEqual = !strcasecmp($ab, $pb);
$subEqual = !strcasecmp($as, $ps);
$baseEqual = !strcasecmp($acceptBase, $priorityBase);
$subEqual = !strcasecmp($acceptSub, $prioritySub);

if (($ab === '*' || $baseEqual) && ($as === '*' || $subEqual) && count($intersection) === count($accept->getParameters())) {
if (($acceptBase === '*' || $baseEqual)
&& ($acceptSub === '*' || $subEqual)
&& count($intersection) === count($accept->getParameters())
) {
Copy link
Contributor Author

@weierophinney weierophinney May 3, 2017

Choose a reason for hiding this comment

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

I split this condition across multiple lines to better understand the precedence of operations.

Copy link
Owner

@willdurand willdurand May 4, 2017

Choose a reason for hiding this comment

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

👌

$score = 100 * $baseEqual + 10 * $subEqual + count($intersection);

return new Match($accept->getQuality() * $priority->getQuality(), $score, $index);
}

if (!strstr($acceptSub, '+') || !strstr($prioritySub, '+')) {
return null;
}
Copy link
Contributor Author

@weierophinney weierophinney May 3, 2017

Choose a reason for hiding this comment

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

If either the accept header or the priority do not have + segments, we can return immediately without further checks, retaining the previous workflow.

Copy link
Owner

@willdurand willdurand May 4, 2017

Choose a reason for hiding this comment

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

👌


// Handle "+" segment wildcards
list($acceptSub, $acceptPlus) = $this->splitSubPart($acceptSub);
list($prioritySub, $priorityPlus) = $this->splitSubPart($prioritySub);

$subEqual = !strcasecmp($acceptSub, $prioritySub);
$plusEqual = !strcasecmp($acceptPlus, $priorityPlus);

if (($acceptBase === '*' || $baseEqual)
&& ($acceptSub === '*' || $subEqual || $acceptPlus === '*' || $plusEqual)
&& count($intersection) === count($accept->getParameters())
) {
$score = 100 * $baseEqual + 10 * $subEqual + $plusEqual + count($intersection);

return new Match($accept->getQuality() * $priority->getQuality(), $score, $index);
}

return null;
}

/**
* Split a subpart into the subpart and "plus" part.
*
* For media-types of the form "application/vnd.example+json", matching
* should allow wildcards for either the portion before the "+" or
* after. This method splits the subpart to allow such matching.
*/
protected function splitSubPart($subPart)
{
if (!strstr($subPart, '+')) {
return [$subPart, ''];
}

return explode('+', $subPart, 2);
}
}
3 changes: 3 additions & 0 deletions tests/Negotiation/Tests/NegotiatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ public static function dataProviderForTestGetBest()
array('image/jpeg, application/x-ms-application, image/gif, application/xaml+xml, image/pjpeg, application/x-ms-xbap, */*', array( 'text/html', 'application/xhtml+xml'), array('text/html', array())),
# Quality of source factors
array($rfcHeader, array('text/html;q=0.4', 'text/plain'), array('text/plain', array())),
# Wildcard "plus" parts (e.g., application/vnd.api+json)
array('application/vnd.api+json', array('application/json', 'application/*+json'), array('application/*+json', array())),
array($pearAcceptHeader, array('application/*+xml'), array('application/*+xml', array())),
);
}

Expand Down