-
Notifications
You must be signed in to change notification settings - Fork 15
/
PhpFlickr.php
521 lines (450 loc) · 14.3 KB
/
PhpFlickr.php
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
<?php
/* phpFlickr
* Written by Dan Coulter (dan@dancoulter.com).
* Forked by Sam Wilson, 2017.
* Project Home Page: https://github.com/samwilson/phpflickr
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace Samwilson\PhpFlickr;
use DateInterval;
use DateTime;
use Exception;
use OAuth\Common\Consumer\Credentials;
use OAuth\Common\Http\Client\CurlClient;
use OAuth\Common\Http\Exception\TokenResponseException;
use OAuth\Common\Http\Uri\Uri;
use OAuth\Common\Storage\Memory;
use OAuth\Common\Storage\TokenStorageInterface;
use OAuth\OAuth1\Service\Flickr;
use OAuth\OAuth1\Token\StdOAuth1Token;
use OAuth\OAuth2\Token\TokenInterface;
use OAuth\ServiceFactory;
use Psr\Cache\CacheItemPoolInterface;
use Samwilson\PhpFlickr\Oauth\PhpFlickrService;
class PhpFlickr
{
/** @param string */
protected $api_key;
/** @param string|null */
protected $secret;
/** @var string The base URL of a Flickr API proxy service. */
protected $proxyBaseUrl;
protected $response;
/** @var string[]|bool */
protected $parsed_response;
/** @var CacheItemPoolInterface|null */
protected $cachePool;
/** @var int|DateInterval */
protected $cacheDefaultExpiry = 600;
protected $token;
/** @var string The Flickr-API service to connect to; must be either 'flickr' or '23'. */
protected $service;
/** @var PhpFlickrService */
protected $oauthService;
/** @var TokenInterface */
protected $oauthRequestToken;
/** @var TokenStorageInterface */
protected $oauthTokenStorage;
/**
* @param string $apiKey
* @param string|null $secret
*/
public function __construct(string $apiKey, string $secret = null)
{
$this->api_key = $apiKey;
$this->secret = $secret;
}
/**
* Set the cache pool (and in doing so, enable caching).
* @param CacheItemPoolInterface $pool
*/
public function setCache(CacheItemPoolInterface $pool)
{
$this->cachePool = $pool;
}
/**
* Set the cache time-to-live. This value is used for all cache items. Defaults to 10 minutes.
* @param int|DateInterval|null $time
*/
public function setCacheDefaultExpiry($time)
{
$this->cacheDefaultExpiry = $time;
}
/**
* Get a cached request.
* @param string[] $request Array of request parameters ('api_sig' will be discarded).
* @return string[]
*/
public function getCached($request)
{
//Checks for a cached result to the request.
//If there is no cache result, it returns a value of false. If it finds one,
//it returns the unparsed XML.
unset($request['api_sig']);
foreach ($request as $key => $value) {
if (empty($value)) {
unset($request[$key]);
} else {
$request[$key] = (string) $request[$key];
}
}
$cacheKey = md5(serialize($request));
if ($this->cachePool instanceof CacheItemPoolInterface) {
$item = $this->cachePool->getItem($cacheKey);
if ($item->isHit()) {
return $item->get();
} else {
return false;
}
}
return false;
}
/**
* Cache a request's response.
* @param string[] $request API request parameters.
* @param mixed $response The value to cache.
* @return bool Whether the cache was saved or not.
*/
protected function cache($request, $response)
{
//Caches the unparsed response of a request.
unset($request['api_sig']);
foreach ($request as $key => $value) {
if (empty($value)) {
unset($request[$key]);
} else {
$request[$key] = (string) $request[$key];
}
}
$cacheKey = md5(serialize($request));
if ($this->cachePool instanceof CacheItemPoolInterface) {
$item = $this->cachePool->getItem($cacheKey);
$item->set($response);
$item->expiresAfter($this->cacheDefaultExpiry);
return $this->cachePool->save($item);
}
return false;
}
/**
* Send a POST request to the Flickr API.
* @param string $command The API endpoint to call.
* @param string[] $args The API request arguments.
* @param bool $nocache Whether to cache the response or not.
* @return bool|mixed[]
* @throws FlickrException If the request fails.
*/
public function request($command, $args = array(), $nocache = false)
{
// Make sure the API method begins with 'flickr.'.
if (substr($command, 0, 7) !== "flickr.") {
$command = "flickr." . $command;
}
// See if there's a cached response.
$request = array_merge([$command], $args);
$this->response = $this->getCached($request);
if (!($this->response) || $nocache) {
$args = array_filter($args);
$oauthService = $this->getOauthService();
$this->response = $oauthService->requestJson($command, 'POST', $args);
if (!$nocache) {
$this->cache($request, $this->response);
}
}
$jsonResponse = json_decode($this->response, true);
if (null === $jsonResponse) {
throw new FlickrException("Unable to decode Flickr response to $command request: " . $this->response);
}
$this->parsed_response = $this->cleanTextNodes($jsonResponse);
if ($this->parsed_response['stat'] === 'fail') {
throw new FlickrException($this->parsed_response['message'], $this->parsed_response['code']);
}
return $this->parsed_response;
}
/**
* Normalize text nodes in API results.
* @param mixed $arr The node to normalize.
* @return mixed
*/
protected function cleanTextNodes($arr)
{
if (!is_array($arr)) {
return $arr;
} elseif (count($arr) == 0) {
return $arr;
} elseif (count($arr) == 1 && array_key_exists('_content', $arr)) {
return $arr['_content'];
} else {
foreach ($arr as $key => $element) {
$arr[$key] = $this->cleanTextNodes($element);
}
return($arr);
}
}
/**
* Set a proxy server through which all requests will be made.
* @param string $baseUrl The base URL.
*/
public function setProxyBaseUrl($baseUrl)
{
$this->proxyBaseUrl = rtrim($baseUrl, '/');
}
/**
* Get an uploader with which to upload photos to (or replace photos on) Flickr.
* @return Uploader
*/
public function uploader()
{
return new Uploader($this);
}
/**
* @param string $callbackUrl The URL to return to when authenticating with Flickr. Only
* required if you're going to be retrieving an access token.
* @return PhpFlickrService
*/
public function getOauthService($callbackUrl = 'oob')
{
if ($this->oauthService instanceof Flickr) {
return $this->oauthService;
}
$credentials = new Credentials($this->api_key, $this->secret, $callbackUrl);
$factory = new ServiceFactory();
// Replace the Flickr service with our own (of the same name), using the proxy URL if it's set.
if ($this->proxyBaseUrl) {
PhpFlickrService::setBaseUrl($this->proxyBaseUrl);
}
$factory->registerService('Flickr', PhpFlickrService::class);
$factory->setHttpClient(new CurlClient());
$storage = $this->getOauthTokenStorage();
/** @var PhpFlickrService $flickrService */
$this->oauthService = $factory->createService('Flickr', $credentials, $storage);
return $this->oauthService;
}
/**
* Get the initial authorization URL to which to redirect users.
*
* This method submits a request to Flickr, so only use it at the request of the user
* so as to not slow things down or perform unexpected actions.
*
* @param string $perm One of 'read', 'write', or 'delete'.
* @param string $callbackUrl Defaults to 'oob' ('out-of-band') for when no callback is
* required, for example for console usage.
* @return Uri
*/
public function getAuthUrl($perm = 'read', $callbackUrl = 'oob')
{
$service = $this->getOauthService($callbackUrl);
$this->oauthRequestToken = $service->requestRequestToken();
$url = $service->getAuthorizationUri([
'oauth_token' => $this->oauthRequestToken->getAccessToken(),
'perms' => $perm,
]);
return $url;
}
/**
* Get an access token for the current user, that you can store in order to authenticate as
* for this user in the future.
*
* @param string $verifier The verification code.
* @param string $requestToken The request token. Can be left out if this is being called on
* the same object that started the authentication (i.e. it already has access to the request
* token).
* @return \OAuth\Common\Token\TokenInterface|\OAuth\OAuth1\Token\TokenInterface|string
*/
public function retrieveAccessToken($verifier, $requestToken = null)
{
$service = $this->getOauthService('oob');
$storage = $this->getOauthTokenStorage();
/** @var \OAuth\OAuth1\Token\TokenInterface $token */
$token = $storage->retrieveAccessToken('Flickr');
// If no request token is provided, try to get it from this object.
if (is_null($requestToken) && $this->oauthRequestToken instanceof TokenInterface) {
$requestToken = $this->oauthRequestToken->getAccessToken();
}
$secret = $token->getAccessTokenSecret();
$accessToken = $service->requestAccessToken($requestToken, $verifier, $secret);
$storage->storeAccessToken('Flickr', $accessToken);
return $accessToken;
}
/**
* @param TokenStorageInterface $tokenStorage The storage object to use.
*/
public function setOauthStorage(TokenStorageInterface $tokenStorage)
{
$this->oauthTokenStorage = $tokenStorage;
}
/**
* @return TokenStorageInterface
* @throws FlickrException If the token storage has not been set yet.
*/
public function getOauthTokenStorage()
{
if (!$this->oauthTokenStorage instanceof TokenStorageInterface) {
// If no storage has yet been set, create an in-memory one with an empty token.
// This will be suitable for un-authenticated API calls.
$this->oauthTokenStorage = new Memory();
$this->oauthTokenStorage->storeAccessToken('Flickr', new StdOAuth1Token());
}
return $this->oauthTokenStorage;
}
public function blogs()
{
return new BlogsApi($this);
}
public function cameras()
{
return new CamerasApi($this);
}
public function collections()
{
return new CollectionsApi($this);
}
public function commons()
{
return new CommonsApi($this);
}
public function contacts()
{
return new ContactsApi($this);
}
public function favorites()
{
return new FavoritesApi($this);
}
public function galleries()
{
return new GalleriesApi($this);
}
public function groups()
{
return new GroupsApi($this);
}
public function groupsDiscussReplies()
{
return new GroupsDiscussRepliesApi($this);
}
public function groupsDiscussTopics()
{
return new GroupsDiscussTopicsApi($this);
}
public function groupsMembers()
{
return new GroupsMembersApi($this);
}
public function groupsPools()
{
return new GroupsPoolsApi($this);
}
public function interestingness()
{
return new InterestingnessApi($this);
}
public function machinetags()
{
return new MachinetagsApi($this);
}
public function panda()
{
return new PandaApi($this);
}
public function people()
{
return new PeopleApi($this);
}
public function photos()
{
return new PhotosApi($this);
}
public function photosComments()
{
return new PhotosCommentsApi($this);
}
public function photosets()
{
return new PhotosetsApi($this);
}
public function photosetsComments()
{
return new PhotosetsCommentsApi($this);
}
public function photosGeo()
{
return new PhotosGeoApi($this);
}
public function photosLicenses()
{
return new PhotosLicensesApi($this);
}
public function photosNotes()
{
return new PhotosNotesApi($this);
}
public function photosPeople()
{
return new PhotosPeopleApi($this);
}
public function photosSuggestions()
{
return new PhotosSuggestionsApi($this);
}
public function photosTransform()
{
return new PhotosTransformApi($this);
}
public function photosUpload()
{
return new PhotosUploadApi($this);
}
public function places()
{
return new PlacesApi($this);
}
public function prefs()
{
return new PrefsApi($this);
}
public function profile()
{
return new ProfileApi($this);
}
public function push()
{
return new PushApi($this);
}
public function reflection()
{
return new ReflectionApi($this);
}
public function stats()
{
return new StatsApi($this);
}
public function tags()
{
return new TagsApi($this);
}
public function test()
{
return new TestApi($this);
}
public function testimonials()
{
return new TestimonialsApi($this);
}
public function urls()
{
return new UrlsApi($this);
}
}