1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
<?php
namespace Aws\Sqs;
use Aws\AwsClient;
use Aws\CommandInterface;
use Aws\Sqs\Exception\SqsException;
use GuzzleHttp\Psr7\Uri;
use GuzzleHttp\Psr7\UriResolver;
use Psr\Http\Message\RequestInterface;
/**
* Client used to interact Amazon Simple Queue Service (Amazon SQS)
*
* @method \Aws\Result addPermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise addPermissionAsync(array $args = [])
* @method \Aws\Result cancelMessageMoveTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelMessageMoveTaskAsync(array $args = [])
* @method \Aws\Result changeMessageVisibility(array $args = [])
* @method \GuzzleHttp\Promise\Promise changeMessageVisibilityAsync(array $args = [])
* @method \Aws\Result changeMessageVisibilityBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise changeMessageVisibilityBatchAsync(array $args = [])
* @method \Aws\Result createQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise createQueueAsync(array $args = [])
* @method \Aws\Result deleteMessage(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMessageAsync(array $args = [])
* @method \Aws\Result deleteMessageBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMessageBatchAsync(array $args = [])
* @method \Aws\Result deleteQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteQueueAsync(array $args = [])
* @method \Aws\Result getQueueAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQueueAttributesAsync(array $args = [])
* @method \Aws\Result getQueueUrl(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQueueUrlAsync(array $args = [])
* @method \Aws\Result listDeadLetterSourceQueues(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeadLetterSourceQueuesAsync(array $args = [])
* @method \Aws\Result listMessageMoveTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMessageMoveTasksAsync(array $args = [])
* @method \Aws\Result listQueueTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQueueTagsAsync(array $args = [])
* @method \Aws\Result listQueues(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQueuesAsync(array $args = [])
* @method \Aws\Result purgeQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise purgeQueueAsync(array $args = [])
* @method \Aws\Result receiveMessage(array $args = [])
* @method \GuzzleHttp\Promise\Promise receiveMessageAsync(array $args = [])
* @method \Aws\Result removePermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise removePermissionAsync(array $args = [])
* @method \Aws\Result sendMessage(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendMessageAsync(array $args = [])
* @method \Aws\Result sendMessageBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendMessageBatchAsync(array $args = [])
* @method \Aws\Result setQueueAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise setQueueAttributesAsync(array $args = [])
* @method \Aws\Result startMessageMoveTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise startMessageMoveTaskAsync(array $args = [])
* @method \Aws\Result tagQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagQueueAsync(array $args = [])
* @method \Aws\Result untagQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagQueueAsync(array $args = [])
*/
class SqsClient extends AwsClient
{
public function __construct(array $config)
{
parent::__construct($config);
$list = $this->getHandlerList();
$list->appendBuild($this->queueUrl(), 'sqs.queue_url');
$list->appendSign($this->validateMd5(), 'sqs.md5');
}
/**
* Converts a queue URL into a queue ARN.
*
* @param string $queueUrl The queue URL to perform the action on.
* Retrieved when the queue is first created.
*
* @return string An ARN representation of the queue URL.
*/
public function getQueueArn($queueUrl)
{
$queueArn = strtr($queueUrl, [
'http://' => 'arn:aws:',
'https://' => 'arn:aws:',
'.amazonaws.com' => '',
'/' => ':',
'.' => ':',
]);
// Cope with SQS' .fifo / :fifo arn inconsistency
if (substr($queueArn, -5) === ':fifo') {
$queueArn = substr_replace($queueArn, '.fifo', -5);
}
return $queueArn;
}
/**
* Moves the URI of the queue to the URI in the input parameter.
*
* @return callable
*/
private function queueUrl()
{
return static function (callable $handler) {
return function (
CommandInterface $c,
RequestInterface $r = null
) use ($handler) {
if ($c->hasParam('QueueUrl')) {
$r = $r->withUri(UriResolver::resolve(
$r->getUri(),
new Uri($c['QueueUrl'])
));
}
return $handler($c, $r);
};
};
}
/**
* Calculates the expected md5 hash of message attributes according to the encoding
* scheme detailed in SQS documentation.
*
* @param array $message Message containing attributes for validation.
* Retrieved when using MessageAttributeNames on
* ReceiveMessage.
*
* @return string|null The md5 hash of the message attributes according to
* the encoding scheme. Returns null when there are no
* attributes.
* @link http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
*/
private static function calculateMessageAttributesMd5($message)
{
if (empty($message['MessageAttributes'])
|| !is_array($message['MessageAttributes'])
) {
return null;
}
ksort($message['MessageAttributes']);
$attributeValues = "";
foreach ($message['MessageAttributes'] as $name => $details) {
$attributeValues .= self::getEncodedStringPiece($name);
$attributeValues .= self::getEncodedStringPiece($details['DataType']);
if (substr($details['DataType'], 0, 6) === 'Binary') {
$attributeValues .= pack('c', 0x02);
$attributeValues .= self::getEncodedBinaryPiece(
$details['BinaryValue']
);
} else {
$attributeValues .= pack('c', 0x01);
$attributeValues .= self::getEncodedStringPiece(
$details['StringValue']
);
}
}
return md5($attributeValues);
}
private static function calculateBodyMd5($message)
{
return md5($message['Body']);
}
private static function getEncodedStringPiece($piece)
{
$utf8Piece = iconv(
mb_detect_encoding($piece, mb_detect_order(), true),
"UTF-8",
$piece
);
return self::getFourBytePieceLength($utf8Piece) . $utf8Piece;
}
private static function getEncodedBinaryPiece($piece)
{
return self::getFourBytePieceLength($piece) . $piece;
}
private static function getFourBytePieceLength($piece)
{
return pack('N', (int)strlen($piece));
}
/**
* Validates ReceiveMessage body and message attribute MD5s.
*
* @return callable
*/
private function validateMd5()
{
return static function (callable $handler) {
return function (
CommandInterface $c,
RequestInterface $r = null
) use ($handler) {
if ($c->getName() !== 'ReceiveMessage') {
return $handler($c, $r);
}
return $handler($c, $r)
->then(
function ($result) use ($c, $r) {
foreach ((array) $result['Messages'] as $msg) {
$bodyMd5 = self::calculateBodyMd5($msg);
if (isset($msg['MD5OfBody'])
&& $bodyMd5 !== $msg['MD5OfBody']
) {
throw new SqsException(
sprintf(
'MD5 mismatch. Expected %s, found %s',
$msg['MD5OfBody'],
$bodyMd5
),
$c,
[
'code' => 'ClientChecksumMismatch',
'request' => $r
]
);
}
if (isset($msg['MD5OfMessageAttributes'])) {
$messageAttributesMd5 = self::calculateMessageAttributesMd5($msg);
if ($messageAttributesMd5 !== $msg['MD5OfMessageAttributes']) {
throw new SqsException(
sprintf(
'Attribute MD5 mismatch. Expected %s, found %s',
$msg['MD5OfMessageAttributes'],
$messageAttributesMd5
? $messageAttributesMd5
: 'No Attributes'
),
$c,
[
'code' => 'ClientChecksumMismatch',
'request' => $r
]
);
}
} else if (isset($msg['MessageAttributes'])) {
throw new SqsException(
sprintf(
'No Attribute MD5 found. Expected %s',
self::calculateMessageAttributesMd5($msg)
),
$c,
[
'code' => 'ClientChecksumMismatch',
'request' => $r
]
);
}
}
return $result;
}
);
};
};
}
}
|
