forked from zendframework/ZendService_Flickr
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Flickr.php
506 lines (423 loc) · 17.5 KB
/
Flickr.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
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Service
*/
namespace Zend\Service\Flickr;
use DOMDocument;
use DOMXPath;
use Zend\I18n\Validator\Int as IntValidator;
use Zend\Http\Client as HttpClient;
use Zend\Http\Request as HttpRequest;
use Zend\Validator\Between as BetweenValidator;
/**
* @category Zend
* @package Zend_Service
* @subpackage Flickr
*/
class Flickr
{
/**
* Base URI for the REST client
*/
const URI_BASE = 'http://www.flickr.com';
/**
* Your Flickr API key
*
* @var string
*/
public $apiKey;
/**
* @var HttpClient
*/
protected $httpClient = null;
/**
* Performs object initializations
*
* # Sets up character encoding
* # Saves the API key
*
* @param string $apiKey Your Flickr API key
*/
public function __construct($apiKey, HttpClient $httpClient = null)
{
$this->apiKey = (string) $apiKey;
$this->setHttpClient($httpClient ?: new HttpClient);
}
/**
* @param HttpClient $httpClient
* @return Flickr
*/
public function setHttpClient(HttpClient $httpClient)
{
$this->httpClient = $httpClient;
return $this;
}
/**
* @return HttpClient
*/
public function getHttpClient()
{
return $this->httpClient;
}
/**
* Find Flickr photos by tag.
*
* Query options include:
*
* # per_page: how many results to return per query
* # page: the starting page offset. first result will be (page - 1) * per_page + 1
* # tag_mode: Either 'any' for an OR combination of tags,
* or 'all' for an AND combination. Default is 'any'.
* # min_upload_date: Minimum upload date to search on. Date should be a unix timestamp.
* # max_upload_date: Maximum upload date to search on. Date should be a unix timestamp.
* # min_taken_date: Minimum upload date to search on. Date should be a MySQL datetime.
* # max_taken_date: Maximum upload date to search on. Date should be a MySQL datetime.
*
* @param string|array $query A single tag or an array of tags.
* @param array $options Additional parameters to refine your query.
* @return ResultSet
* @throws Exception\RuntimeException
*/
public function tagSearch($query, array $options = array())
{
static $method = 'flickr.photos.search';
static $defaultOptions = array('per_page' => 10,
'page' => 1,
'tag_mode' => 'or',
'extras' => 'license, date_upload, date_taken, owner_name, icon_server');
$options['tags'] = is_array($query) ? implode(',', $query) : $query;
$options = $this->prepareOptions($method, $options, $defaultOptions);
$this->validateTagSearch($options);
// now search for photos
$request = new HttpRequest;
$request->setUri('/services/rest/');
$request->getQuery()->fromArray($options);
$response = $this->httpClient->send($request);
if ($response->isServerError() || $response->isClientError()) {
throw new Exception\RuntimeException('An error occurred sending request. Status code: '
. $response->getStatusCode());
}
$dom = new DOMDocument();
$dom->loadXML($response->getBody());
self::checkErrors($dom);
return new ResultSet($dom, $this);
}
/**
* Finds photos by a user's username or email.
*
* Additional query options include:
*
* # per_page: how many results to return per query
* # page: the starting page offset. first result will be (page - 1) * per_page + 1
* # min_upload_date: Minimum upload date to search on. Date should be a unix timestamp.
* # max_upload_date: Maximum upload date to search on. Date should be a unix timestamp.
* # min_taken_date: Minimum upload date to search on. Date should be a MySQL datetime.
* # max_taken_date: Maximum upload date to search on. Date should be a MySQL datetime.
*
* @param string $query username or email
* @param array $options Additional parameters to refine your query.
* @return ResultSet
* @throws Exception\RuntimeException
*/
public function userSearch($query, array $options = null)
{
static $method = 'flickr.people.getPublicPhotos';
static $defaultOptions = array('per_page' => 10,
'page' => 1,
'extras' => 'license, date_upload, date_taken, owner_name, icon_server');
// can't access by username, must get ID first
if (strchr($query, '@')) {
// optimistically hope this is an email
$options['user_id'] = $this->getIdByEmail($query);
} else {
// we can safely ignore this exception here
$options['user_id'] = $this->getIdByUsername($query);
}
$options = $this->prepareOptions($method, $options, $defaultOptions);
$this->validateUserSearch($options);
// now search for photos
$request = new HttpRequest;
$request->setUri('/services/rest/');
$request->getQuery()->fromArray($options);
$response = $this->httpClient->send($request);
if ($response->isServerError() || $response->isClientError()) {
throw new Exception\RuntimeException('An error occurred sending request. Status code: '
. $response->getStatusCode());
}
$dom = new DOMDocument();
$dom->loadXML($response->getBody());
self::checkErrors($dom);
return new ResultSet($dom, $this);
}
/**
* Finds photos in a group's pool.
*
* @param string $query group id
* @param array $options Additional parameters to refine your query.
* @return ResultSet
* @throws Exception\InvalidArgumentException
* @throws Exception\RuntimeException
*/
public function groupPoolGetPhotos($query, array $options = array())
{
static $method = 'flickr.groups.pools.getPhotos';
static $defaultOptions = array('per_page' => 10,
'page' => 1,
'extras' => 'license, date_upload, date_taken, owner_name, icon_server');
if (empty($query) || !is_string($query)) {
throw new Exception\InvalidArgumentException('You must supply a group id');
}
$options['group_id'] = $query;
$options = $this->prepareOptions($method, $options, $defaultOptions);
$this->validateGroupPoolGetPhotos($options);
// now search for photos
$request = new HttpRequest;
$request->setUri('/services/rest/');
$request->getQuery()->fromArray($options);
$response = $this->httpClient->send($request);
if ($response->isServerError() || $response->isClientError()) {
throw new Exception\RuntimeException('An error occurred sending request. Status code: '
. $response->getStatusCode());
}
$dom = new DOMDocument();
$dom->loadXML($response->getBody());
self::checkErrors($dom);
return new ResultSet($dom, $this);
}
/**
* Utility function to find Flickr User IDs for usernames.
*
* (You can only find a user's photo with their NSID.)
*
* @param string $username the username
* @return string the NSID (userid)
* @throws Exception\InvalidArgumentException
* @throws Exception\RuntimeException
*/
public function getIdByUsername($username)
{
static $method = 'flickr.people.findByUsername';
$options = array('api_key' => $this->apiKey, 'method' => $method, 'username' => (string)$username);
if (empty($username)) {
throw new Exception\InvalidArgumentException('You must supply a username');
}
$request = new HttpRequest;
$request->setUri('/services/rest/');
$request->getQuery()->fromArray($options);
$response = $this->httpClient->send($request);
if ($response->isServerError() || $response->isClientError()) {
throw new Exception\RuntimeException('An error occurred sending request. Status code: '
. $response->getStatusCode());
}
$dom = new DOMDocument();
$dom->loadXML($response->getBody());
self::checkErrors($dom);
$xpath = new DOMXPath($dom);
return (string)$xpath->query('//user')->item(0)->getAttribute('id');
}
/**
* Utility function to find Flickr User IDs for emails.
*
* (You can only find a user's photo with their NSID.)
*
* @param string $email the email
* @return string the NSID (userid)
* @throws Exception\InvalidArgumentException
* @throws Exception\RuntimeException
*/
public function getIdByEmail($email)
{
static $method = 'flickr.people.findByEmail';
if (empty($email)) {
throw new Exception\InvalidArgumentException('You must supply an e-mail address');
}
$options = array('api_key' => $this->apiKey, 'method' => $method, 'find_email' => (string)$email);
$request = new HttpRequest;
$request->setUri('/services/rest/');
$request->getQuery()->fromArray($options);
$response = $this->httpClient->send($request);
if ($response->isServerError() || $response->isClientError()) {
throw new Exception\RuntimeException('An error occurred sending request. Status code: '
. $response->getStatusCode());
}
$dom = new DOMDocument();
$dom->loadXML($response->getBody());
self::checkErrors($dom);
$xpath = new DOMXPath($dom);
return (string)$xpath->query('//user')->item(0)->getAttribute('id');
}
/**
* Returns Flickr photo details by for the given photo ID
*
* @param string $id the NSID
* @return array of Image, details for the specified image
* @throws Exception\InvalidArgumentException
*/
public function getImageDetails($id)
{
static $method = 'flickr.photos.getSizes';
if (empty($id)) {
throw new Exception\InvalidArgumentException('You must supply a photo ID');
}
$options = array('api_key' => $this->apiKey, 'method' => $method, 'photo_id' => $id);
$request = new HttpRequest;
$request->setUri('/services/rest/');
$request->getQuery()->fromArray($options);
$response = $this->httpClient->send($request);
$dom = new DOMDocument();
$dom->loadXML($response->getBody());
$xpath = new DOMXPath($dom);
self::checkErrors($dom);
$retval = array();
foreach ($xpath->query('//size') as $size) {
$label = (string)$size->getAttribute('label');
$retval[$label] = new Image($size);
}
return $retval;
}
/**
* Validate User Search Options
*
* @param array $options
* @return void
* @throws Exception\DomainException
*/
protected function validateUserSearch(array $options)
{
$validOptions = array('api_key', 'method', 'user_id', 'per_page', 'page', 'extras', 'min_upload_date',
'min_taken_date', 'max_upload_date', 'max_taken_date', 'safe_search');
$this->compareOptions($options, $validOptions);
if ($options['per_page'] < 1 || $options['per_page'] > 500) {
throw new Exception\DomainException($options['per_page'] . ' is not valid for the "per_page" option');
}
if (!is_int($options['page'])) {
throw new Exception\DomainException($options['page'] . ' is not valid for the "page" option');
}
// validate extras, which are delivered in csv format
if (isset($options['extras'])) {
$extras = explode(',', $options['extras']);
$validExtras = array('license', 'date_upload', 'date_taken', 'owner_name', 'icon_server');
foreach ($extras as $extra) {
/**
* @todo The following does not do anything [yet], so it is commented out.
*/
//in_array(trim($extra), $validExtras);
}
}
}
/**
* Validate Tag Search Options
*
* @param array $options
* @return void
* @throws Exception\DomainException
*/
protected function validateTagSearch(array $options)
{
$validOptions = array('method', 'api_key', 'user_id', 'tags', 'tag_mode', 'text', 'min_upload_date',
'max_upload_date', 'min_taken_date', 'max_taken_date', 'license', 'sort',
'privacy_filter', 'bbox', 'accuracy', 'safe_search', 'content_type', 'machine_tags',
'machine_tag_mode', 'group_id', 'contacts', 'woe_id', 'place_id', 'media', 'has_geo',
'geo_context', 'lat', 'lon', 'radius', 'radius_units', 'is_commons', 'is_gallery',
'extras', 'per_page', 'page');
$this->compareOptions($options, $validOptions);
if ($options['per_page'] < 1 || $options['per_page'] > 500) {
throw new Exception\DomainException($options['per_page'] . ' is not valid for the "per_page" option');
}
if (!is_int($options['page'])) {
throw new Exception\DomainException($options['page'] . ' is not valid for the "page" option');
}
// validate extras, which are delivered in csv format
if (isset($options['extras'])) {
$extras = explode(',', $options['extras']);
$validExtras = array('license', 'date_upload', 'date_taken', 'owner_name', 'icon_server');
foreach ($extras as $extra) {
/**
* @todo The following does not do anything [yet], so it is commented out.
*/
//in_array(trim($extra), $validExtras);
}
}
}
/**
* Validate Group Search Options
*
* @param array $options
* @throws Exception\DomainException
* @return void
*/
protected function validateGroupPoolGetPhotos(array $options)
{
$validOptions = array('api_key', 'tags', 'method', 'group_id', 'per_page', 'page', 'extras', 'user_id');
$this->compareOptions($options, $validOptions);
if ($options['per_page'] < 1 || $options['per_page'] > 500) {
throw new Exception\DomainException($options['per_page'] . ' is not valid for the "per_page" option');
}
if (!is_int($options['page'])) {
throw new Exception\DomainException($options['page'] . ' is not valid for the "page" option');
}
// validate extras, which are delivered in csv format
if (isset($options['extras'])) {
$extras = explode(',', $options['extras']);
$validExtras = array('license', 'date_upload', 'date_taken', 'owner_name', 'icon_server');
foreach ($extras as $extra) {
/**
* @todo The following does not do anything [yet], so it is commented out.
*/
//in_array(trim($extra), $validExtras);
}
}
}
/**
* Throws an exception if and only if the response status indicates a failure
*
* @param DOMDocument $dom
* @return void
* @throws Exception\RuntimeException
*/
protected static function checkErrors(DOMDocument $dom)
{
if ($dom->documentElement->getAttribute('stat') === 'fail') {
$xpath = new DOMXPath($dom);
$err = $xpath->query('//err')->item(0);
throw new Exception\RuntimeException('Search failed due to error: ' . $err->getAttribute('msg')
. ' (error #' . $err->getAttribute('code') . ')');
}
}
/**
* Prepare options for the request
*
* @param string $method Flickr Method to call
* @param array $options User Options
* @param array $defaultOptions Default Options
* @return array Merged array of user and default/required options
*/
protected function prepareOptions($method, array $options, array $defaultOptions)
{
$options['method'] = (string)$method;
$options['api_key'] = $this->apiKey;
return array_merge($defaultOptions, $options);
}
/**
* Throws an exception if and only if any user options are invalid
*
* @param array $options User options
* @param array $validOptions Valid options
* @return void
* @throws Exception\InvalidArgumentException
*/
protected function compareOptions(array $options, array $validOptions)
{
$difference = array_diff(array_keys($options), $validOptions);
if ($difference) {
throw new Exception\InvalidArgumentException(
'The following parameters are invalid: ' . implode(',', $difference)
);
}
}
}