ServiceProxy.php
4.81 KB
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
<?php
/**
* OAuth1 ServiceProxy class file.
*
* @author Maxim Zemskov <nodge@yandex.ru>
* @link http://github.com/Nodge/yii2-eauth/
* @license http://www.opensource.org/licenses/bsd-license.php
*/
namespace nodge\eauth\oauth1;
use OAuth\Common\Consumer\CredentialsInterface;
use OAuth\Common\Http\Client\ClientInterface;
use OAuth\Common\Http\Exception\TokenResponseException;
use OAuth\Common\Http\Uri\Uri;
use OAuth\Common\Http\Uri\UriInterface;
use OAuth\Common\Storage\TokenStorageInterface;
use OAuth\Common\Token\TokenInterface;
use OAuth\OAuth1\Service\AbstractService;
use OAuth\OAuth1\Signature\SignatureInterface;
use OAuth\OAuth1\Token\StdOAuth1Token;
class ServiceProxy extends AbstractService
{
/**
* @var Service the currently used service class
*/
protected $service;
/**
* {@inheritDoc}
*/
public function __construct(
CredentialsInterface $credentials,
ClientInterface $httpClient,
TokenStorageInterface $storage,
SignatureInterface $signature,
UriInterface $baseApiUri = null,
Service $service
)
{
$this->service = $service;
parent::__construct($credentials, $httpClient, $storage, $signature, $baseApiUri);
}
/**
* @return string
*/
public function service()
{
return $this->service->getServiceName();
}
/**
* @return StdOAuth1Token
*/
public function retrieveAccessToken()
{
return $this->storage->retrieveAccessToken($this->service());
}
/**
*
*/
public function hasValidAccessToken()
{
$serviceName = $this->service();
if (!$this->storage->hasAccessToken($serviceName)) {
return false;
}
/** @var $token StdOAuth1Token */
$token = $this->storage->retrieveAccessToken($serviceName);
$params = $token->getExtraParams();
if (isset($params['is_request_token'])) {
return false;
}
return $this->checkTokenLifetime($token);
}
/**
* @param TokenInterface $token
* @return bool
*/
protected function checkTokenLifetime($token)
{
// assume that we have at least a minute to execute a queries.
return $token->getEndOfLife() - 60 > time()
|| $token->getEndOfLife() === TokenInterface::EOL_NEVER_EXPIRES
|| $token->getEndOfLife() === TokenInterface::EOL_UNKNOWN;
}
/**
* @return null|TokenInterface
*/
public function getAccessToken()
{
if (!$this->hasValidAccessToken()) {
return null;
}
$serviceName = $this->service();
return $this->storage->retrieveAccessToken($serviceName);
}
/**
* @return UriInterface
*/
public function getRequestTokenEndpoint()
{
return new Uri($this->service->getRequestTokenEndpoint());
}
/**
* @return UriInterface
*/
public function getAuthorizationEndpoint()
{
return new Uri($this->service->getAuthorizationEndpoint());
}
/**
* @return UriInterface
*/
public function getAccessTokenEndpoint()
{
return new Uri($this->service->getAccessTokenEndpoint());
}
/**
* We need a separate request token parser only to verify the `oauth_callback_confirmed` parameter. For the actual
* parsing we can just use the default access token parser.
*
* @param string $responseBody
* @return StdOAuth1Token
* @throws TokenResponseException
*/
protected function parseRequestTokenResponse($responseBody)
{
parse_str($responseBody, $data);
if (!isset($data) || !is_array($data)) {
throw new TokenResponseException('Unable to parse response.');
} else if (!isset($data['oauth_callback_confirmed']) || $data['oauth_callback_confirmed'] != 'true') {
throw new TokenResponseException('Error in retrieving token.');
}
$data['is_request_token'] = true;
return $this->parseAccessTokenResponse($data);
}
/**
* @param string|array $responseBody
* @return StdOAuth1Token
* @throws TokenResponseException
*/
protected function parseAccessTokenResponse($responseBody)
{
if (!is_array($responseBody)) {
parse_str($responseBody, $data);
if (!isset($data) || !is_array($data)) {
throw new TokenResponseException('Unable to parse response.');
}
} else {
$data = $responseBody;
}
$error = $this->service->getAccessTokenResponseError($data);
if (isset($error)) {
throw new TokenResponseException('Error in retrieving token: "' . $error . '"');
}
$token = new StdOAuth1Token();
$names = $this->service->getAccessTokenArgumentNames();
$token->setRequestToken($data[$names['oauth_token']]);
$token->setRequestTokenSecret($data[$names['oauth_token_secret']]);
$token->setAccessToken($data[$names['oauth_token']]);
$token->setAccessTokenSecret($data[$names['oauth_token_secret']]);
unset($data[$names['oauth_token']], $data[$names['oauth_token_secret']]);
if (isset($data[$names['oauth_expires_in']])) {
$token->setLifeTime($data[$names['oauth_expires_in']]);
unset($data[$names['oauth_expires_in']]);
} else {
$token->setLifetime($this->service->getTokenDefaultLifetime());
}
$token->setExtraParams($data);
return $token;
}
}